4 Copyright (C) Andrew Tridgell 2004
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 2 of the License, or (at your option) any later version.
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public
21 License along with this library; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * Component: ldb message component utility functions
30 * Description: functions for manipulating ldb_message structures
32 * Author: Andrew Tridgell
36 #include "ldb/include/includes.h"
39 create a new ldb_message in a given memory context (NULL for top level)
41 struct ldb_message *ldb_msg_new(void *mem_ctx)
43 return talloc_zero(mem_ctx, struct ldb_message);
47 find an element in a message by attribute name
49 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
50 const char *attr_name)
53 for (i=0;i<msg->num_elements;i++) {
54 if (ldb_attr_cmp(msg->elements[i].name, attr_name) == 0) {
55 return &msg->elements[i];
62 see if two ldb_val structures contain exactly the same data
63 return 1 for a match, 0 for a mis-match
65 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2)
67 if (v1->length != v2->length) return 0;
69 if (v1->length == 0) return 1;
71 if (memcmp(v1->data, v2->data, v1->length) == 0) {
79 find a value in an element
80 assumes case sensitive comparison
82 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
86 for (i=0;i<el->num_values;i++) {
87 if (ldb_val_equal_exact(val, &el->values[i])) {
88 return &el->values[i];
95 duplicate a ldb_val structure
97 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v)
100 v2.length = v->length;
101 if (v->data == NULL) {
106 /* the +1 is to cope with buggy C library routines like strndup
107 that look one byte beyond */
108 v2.data = talloc_array(mem_ctx, uint8_t, v->length+1);
114 memcpy(v2.data, v->data, v->length);
115 ((char *)v2.data)[v->length] = 0;
120 add an empty element to a message
122 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags)
124 struct ldb_message_element *els;
126 if (! ldb_valid_attr_name(attr_name)) {
127 return LDB_ERR_OPERATIONS_ERROR;
130 els = talloc_realloc(msg, msg->elements,
131 struct ldb_message_element, msg->num_elements+1);
134 return LDB_ERR_OPERATIONS_ERROR;
137 els[msg->num_elements].values = NULL;
138 els[msg->num_elements].num_values = 0;
139 els[msg->num_elements].flags = flags;
140 els[msg->num_elements].name = talloc_strdup(els, attr_name);
141 if (!els[msg->num_elements].name) {
143 return LDB_ERR_OPERATIONS_ERROR;
153 add an empty element to a message
155 int ldb_msg_add(struct ldb_message *msg,
156 const struct ldb_message_element *el,
159 if (ldb_msg_add_empty(msg, el->name, flags) != 0) {
160 return LDB_ERR_OPERATIONS_ERROR;
163 msg->elements[msg->num_elements-1] = *el;
164 msg->elements[msg->num_elements-1].flags = flags;
170 add a value to a message
172 int ldb_msg_add_value(struct ldb_message *msg,
173 const char *attr_name,
174 const struct ldb_val *val)
176 struct ldb_message_element *el;
177 struct ldb_val *vals;
179 el = ldb_msg_find_element(msg, attr_name);
181 ldb_msg_add_empty(msg, attr_name, 0);
182 el = ldb_msg_find_element(msg, attr_name);
185 return LDB_ERR_OPERATIONS_ERROR;
188 vals = talloc_realloc(msg, el->values, struct ldb_val, el->num_values+1);
191 return LDB_ERR_OPERATIONS_ERROR;
194 el->values[el->num_values] = *val;
202 add a value to a message, stealing it into the 'right' place
204 int ldb_msg_add_steal_value(struct ldb_message *msg,
205 const char *attr_name,
209 ret = ldb_msg_add_value(msg, attr_name, val);
210 if (ret == LDB_SUCCESS) {
211 struct ldb_message_element *el;
212 el = ldb_msg_find_element(msg, attr_name);
213 talloc_steal(el->values, val->data);
220 add a string element to a message
222 int ldb_msg_add_string(struct ldb_message *msg,
223 const char *attr_name, const char *str)
227 val.data = discard_const_p(uint8_t, str);
228 val.length = strlen(str);
230 if (val.length == 0) {
231 /* allow empty strings as non-existant attributes */
235 return ldb_msg_add_value(msg, attr_name, &val);
239 add a string element to a message, stealing it into the 'right' place
241 int ldb_msg_add_steal_string(struct ldb_message *msg,
242 const char *attr_name, char *str)
246 val.data = (uint8_t *)str;
247 val.length = strlen(str);
249 return ldb_msg_add_steal_value(msg, attr_name, &val);
253 add a printf formatted element to a message
255 int ldb_msg_add_fmt(struct ldb_message *msg,
256 const char *attr_name, const char *fmt, ...)
263 str = talloc_vasprintf(msg, fmt, ap);
266 if (str == NULL) return LDB_ERR_OPERATIONS_ERROR;
268 val.data = (uint8_t *)str;
269 val.length = strlen(str);
271 return ldb_msg_add_steal_value(msg, attr_name, &val);
275 compare two ldb_message_element structures
276 assumes case senistive comparison
278 int ldb_msg_element_compare(struct ldb_message_element *el1,
279 struct ldb_message_element *el2)
283 if (el1->num_values != el2->num_values) {
284 return el1->num_values - el2->num_values;
287 for (i=0;i<el1->num_values;i++) {
288 if (!ldb_msg_find_val(el2, &el1->values[i])) {
297 compare two ldb_message_element structures
298 comparing by element name
300 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
301 struct ldb_message_element *el2)
303 return ldb_attr_cmp(el1->name, el2->name);
307 convenience functions to return common types from a message
308 these return the first value if the attribute is multi-valued
310 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name)
312 struct ldb_message_element *el = ldb_msg_find_element(msg, attr_name);
313 if (!el || el->num_values == 0) {
316 return &el->values[0];
319 int ldb_msg_find_attr_as_int(const struct ldb_message *msg,
320 const char *attr_name,
323 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
324 if (!v || !v->data) {
325 return default_value;
327 return strtol((const char *)v->data, NULL, 0);
330 unsigned int ldb_msg_find_attr_as_uint(const struct ldb_message *msg,
331 const char *attr_name,
332 unsigned int default_value)
334 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
335 if (!v || !v->data) {
336 return default_value;
338 return strtoul((const char *)v->data, NULL, 0);
341 int64_t ldb_msg_find_attr_as_int64(const struct ldb_message *msg,
342 const char *attr_name,
343 int64_t default_value)
345 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
346 if (!v || !v->data) {
347 return default_value;
349 return strtoll((const char *)v->data, NULL, 0);
352 uint64_t ldb_msg_find_attr_as_uint64(const struct ldb_message *msg,
353 const char *attr_name,
354 uint64_t default_value)
356 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
357 if (!v || !v->data) {
358 return default_value;
360 return strtoull((const char *)v->data, NULL, 0);
363 double ldb_msg_find_attr_as_double(const struct ldb_message *msg,
364 const char *attr_name,
365 double default_value)
367 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
368 if (!v || !v->data) {
369 return default_value;
371 return strtod((const char *)v->data, NULL);
374 int ldb_msg_find_attr_as_bool(const struct ldb_message *msg,
375 const char *attr_name,
378 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
379 if (!v || !v->data) {
380 return default_value;
382 if (strcasecmp((const char *)v->data, "FALSE") == 0) {
385 if (strcasecmp((const char *)v->data, "TRUE") == 0) {
388 return default_value;
391 const char *ldb_msg_find_attr_as_string(const struct ldb_message *msg,
392 const char *attr_name,
393 const char *default_value)
395 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
396 if (!v || !v->data) {
397 return default_value;
399 return (const char *)v->data;
402 struct ldb_dn *ldb_msg_find_attr_as_dn(void *mem_ctx,
403 const struct ldb_message *msg,
404 const char *attr_name)
406 const struct ldb_val *v;
408 v = ldb_msg_find_ldb_val(msg, attr_name);
409 if (!v || !v->data) {
412 return ldb_dn_explode(mem_ctx, (const char *)v->data);
416 sort the elements of a message by name
418 void ldb_msg_sort_elements(struct ldb_message *msg)
420 qsort(msg->elements, msg->num_elements, sizeof(struct ldb_message_element),
421 (comparison_fn_t)ldb_msg_element_compare_name);
425 shallow copy a message - copying only the elements array so that the caller
426 can safely add new elements without changing the message
428 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx,
429 const struct ldb_message *msg)
431 struct ldb_message *msg2;
434 msg2 = talloc(mem_ctx, struct ldb_message);
435 if (msg2 == NULL) return NULL;
438 msg2->private_data = NULL;
440 msg2->elements = talloc_array(msg2, struct ldb_message_element,
442 if (msg2->elements == NULL) goto failed;
444 for (i=0;i<msg2->num_elements;i++) {
445 msg2->elements[i] = msg->elements[i];
457 copy a message, allocating new memory for all parts
459 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx,
460 const struct ldb_message *msg)
462 struct ldb_message *msg2;
465 msg2 = ldb_msg_copy_shallow(mem_ctx, msg);
466 if (msg2 == NULL) return NULL;
468 msg2->dn = ldb_dn_copy(msg2, msg2->dn);
469 if (msg2->dn == NULL) goto failed;
471 for (i=0;i<msg2->num_elements;i++) {
472 struct ldb_message_element *el = &msg2->elements[i];
473 struct ldb_val *values = el->values;
474 el->name = talloc_strdup(msg2->elements, el->name);
475 if (el->name == NULL) goto failed;
476 el->values = talloc_array(msg2->elements, struct ldb_val, el->num_values);
477 for (j=0;j<el->num_values;j++) {
478 el->values[j] = ldb_val_dup(el->values, &values[j]);
479 if (el->values[j].data == NULL && values[j].length != 0) {
494 canonicalise a message, merging elements of the same name
496 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
497 const struct ldb_message *msg)
500 struct ldb_message *msg2;
502 msg2 = ldb_msg_copy(ldb, msg);
503 if (msg2 == NULL) return NULL;
505 ldb_msg_sort_elements(msg2);
507 for (i=1;i<msg2->num_elements;i++) {
508 struct ldb_message_element *el1 = &msg2->elements[i-1];
509 struct ldb_message_element *el2 = &msg2->elements[i];
510 if (ldb_msg_element_compare_name(el1, el2) == 0) {
511 el1->values = talloc_realloc(msg2->elements, el1->values, struct ldb_val,
512 el1->num_values + el2->num_values);
513 if (el1->values == NULL) {
516 memcpy(el1->values + el1->num_values,
518 sizeof(struct ldb_val) * el2->num_values);
519 el1->num_values += el2->num_values;
520 talloc_free(discard_const_p(char, el2->name));
521 if (i+1<msg2->num_elements) {
522 memmove(el2, el2+1, sizeof(struct ldb_message_element) *
523 (msg2->num_elements - (i+1)));
525 msg2->num_elements--;
535 return a ldb_message representing the differences between msg1 and msg2. If you
536 then use this in a ldb_modify() call it can be used to save edits to a message
538 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
539 struct ldb_message *msg1,
540 struct ldb_message *msg2)
542 struct ldb_message *mod;
543 struct ldb_message_element *el;
546 mod = ldb_msg_new(ldb);
549 mod->num_elements = 0;
550 mod->elements = NULL;
552 msg2 = ldb_msg_canonicalize(ldb, msg2);
557 /* look in msg2 to find elements that need to be added
559 for (i=0;i<msg2->num_elements;i++) {
560 el = ldb_msg_find_element(msg1, msg2->elements[i].name);
562 if (el && ldb_msg_element_compare(el, &msg2->elements[i]) == 0) {
568 el?LDB_FLAG_MOD_REPLACE:LDB_FLAG_MOD_ADD) != 0) {
573 /* look in msg1 to find elements that need to be deleted */
574 for (i=0;i<msg1->num_elements;i++) {
575 el = ldb_msg_find_element(msg2, msg1->elements[i].name);
577 if (ldb_msg_add_empty(mod,
578 msg1->elements[i].name,
579 LDB_FLAG_MOD_DELETE) != 0) {
588 int ldb_msg_sanity_check(struct ldb_context *ldb,
589 const struct ldb_message *msg)
593 /* basic check on DN */
594 if (msg->dn == NULL) {
595 /* TODO: return also an error string */
596 ldb_set_errstring(ldb, "ldb message lacks a DN!");
597 return LDB_ERR_INVALID_DN_SYNTAX;
600 /* basic syntax checks */
601 for (i = 0; i < msg->num_elements; i++) {
602 for (j = 0; j < msg->elements[i].num_values; j++) {
603 if (msg->elements[i].values[j].length == 0) {
604 TALLOC_CTX *mem_ctx = talloc_new(ldb);
605 /* an attribute cannot be empty */
606 /* TODO: return also an error string */
607 ldb_asprintf_errstring(ldb, "Element %s has empty attribute in ldb message (%s)!",
608 msg->elements[i].name,
609 ldb_dn_linearize(mem_ctx, msg->dn));
610 talloc_free(mem_ctx);
611 return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
623 copy an attribute list. This only copies the array, not the elements
624 (ie. the elements are left as the same pointers)
626 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs)
630 for (i=0;attrs[i];i++) /* noop */ ;
631 ret = talloc_array(mem_ctx, const char *, i+1);
635 for (i=0;attrs[i];i++) {
644 copy an attribute list. This only copies the array, not the elements
645 (ie. the elements are left as the same pointers)
647 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr)
651 for (i=0;attrs[i];i++) /* noop */ ;
652 ret = talloc_array(mem_ctx, const char *, i+2);
656 for (i=0;attrs[i];i++) {
666 return 1 if an attribute is in a list of attributes, or 0 otherwise
668 int ldb_attr_in_list(const char * const *attrs, const char *attr)
671 for (i=0;attrs[i];i++) {
672 if (ldb_attr_cmp(attrs[i], attr) == 0) {
681 rename the specified attribute in a search result
683 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace)
685 struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
689 el->name = talloc_strdup(msg->elements, replace);
690 if (el->name == NULL) {
691 return LDB_ERR_OPERATIONS_ERROR;
698 copy the specified attribute in a search result to a new attribute
700 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace)
702 struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
706 if (ldb_msg_add(msg, el, 0) != 0) {
707 return LDB_ERR_OPERATIONS_ERROR;
709 return ldb_msg_rename_attr(msg, attr, replace);
714 remove the specified attribute in a search result
716 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr)
718 struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
720 int n = (el - msg->elements);
721 if (n != msg->num_elements-1) {
722 memmove(el, el+1, ((msg->num_elements-1) - n)*sizeof(*el));
729 return a LDAP formatted time string
731 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t)
733 struct tm *tm = gmtime(&t);
739 /* formatted like: 20040408072012.0Z */
740 return talloc_asprintf(mem_ctx,
741 "%04u%02u%02u%02u%02u%02u.0Z",
742 tm->tm_year+1900, tm->tm_mon+1,
743 tm->tm_mday, tm->tm_hour, tm->tm_min,
749 convert a LDAP time string to a time_t. Return 0 if unable to convert
751 time_t ldb_string_to_time(const char *s)
755 if (s == NULL) return 0;
757 memset(&tm, 0, sizeof(tm));
758 if (sscanf(s, "%04u%02u%02u%02u%02u%02u",
759 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
760 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
771 dump a set of results to a file. Useful from within gdb
773 void ldb_dump_results(struct ldb_context *ldb, struct ldb_result *result, FILE *f)
777 for (i = 0; i < result->count; i++) {
778 struct ldb_ldif ldif;
779 fprintf(f, "# record %d\n", i+1);
780 ldif.changetype = LDB_CHANGETYPE_NONE;
781 ldif.msg = result->msgs[i];
782 ldb_ldif_write_file(ldb, f, &ldif);
786 int ldb_msg_check_string_attribute(const struct ldb_message *msg, const char *name, const char *value)
788 struct ldb_message_element *el;
791 el = ldb_msg_find_element(msg, name);
795 val.data = discard_const(value);
796 val.length = strlen(value);
798 if (ldb_msg_find_val(el, &val))