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/ldb.h"
37 #include "ldb/include/ldb_private.h"
40 create a new ldb_message in a given memory context (NULL for top level)
42 struct ldb_message *ldb_msg_new(void *mem_ctx)
44 return talloc_zero(mem_ctx, struct ldb_message);
48 find an element in a message by attribute name
50 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg,
51 const char *attr_name)
54 for (i=0;i<msg->num_elements;i++) {
55 if (ldb_attr_cmp(msg->elements[i].name, attr_name) == 0) {
56 return &msg->elements[i];
63 see if two ldb_val structures contain exactly the same data
64 return 1 for a match, 0 for a mis-match
66 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2)
68 if (v1->length != v2->length) return 0;
70 if (v1->length == 0) return 1;
72 if (memcmp(v1->data, v2->data, v1->length) == 0) {
80 find a value in an element
81 assumes case sensitive comparison
83 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el,
87 for (i=0;i<el->num_values;i++) {
88 if (ldb_val_equal_exact(val, &el->values[i])) {
89 return &el->values[i];
96 duplicate a ldb_val structure
98 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v)
101 v2.length = v->length;
102 if (v->length == 0) {
107 /* the +1 is to cope with buggy C library routines like strndup
108 that look one byte beyond */
109 v2.data = talloc_array(mem_ctx, char, v->length+1);
115 memcpy(v2.data, v->data, v->length);
116 ((char *)v2.data)[v->length] = 0;
121 add an empty element to a message
123 int ldb_msg_add_empty(struct ldb_context *ldb,
124 struct ldb_message *msg, const char *attr_name, int flags)
126 struct ldb_message_element *els;
128 els = talloc_realloc(msg, msg->elements,
129 struct ldb_message_element, msg->num_elements+1);
135 els[msg->num_elements].values = NULL;
136 els[msg->num_elements].num_values = 0;
137 els[msg->num_elements].flags = flags;
138 els[msg->num_elements].name = talloc_strdup(els, attr_name);
139 if (!els[msg->num_elements].name) {
150 add an empty element to a message
152 int ldb_msg_add(struct ldb_context *ldb,
153 struct ldb_message *msg,
154 const struct ldb_message_element *el,
157 if (ldb_msg_add_empty(ldb, msg, el->name, flags) != 0) {
161 msg->elements[msg->num_elements-1] = *el;
162 msg->elements[msg->num_elements-1].flags = flags;
168 add a value to a message
170 int ldb_msg_add_value(struct ldb_context *ldb,
171 struct ldb_message *msg,
172 const char *attr_name,
173 const struct ldb_val *val)
175 struct ldb_message_element *el;
176 struct ldb_val *vals;
178 el = ldb_msg_find_element(msg, attr_name);
180 ldb_msg_add_empty(ldb, msg, attr_name, 0);
181 el = ldb_msg_find_element(msg, attr_name);
187 vals = talloc_realloc(msg, el->values, struct ldb_val, el->num_values+1);
193 el->values[el->num_values] = *val;
201 add a string element to a message
203 int ldb_msg_add_string(struct ldb_context *ldb, struct ldb_message *msg,
204 const char *attr_name, const char *str)
208 val.data = discard_const_p(char, str);
209 val.length = strlen(str);
211 return ldb_msg_add_value(ldb, msg, attr_name, &val);
215 add a printf formatted element to a message
217 int ldb_msg_add_fmt(struct ldb_context *ldb, struct ldb_message *msg,
218 const char *attr_name, const char *fmt, ...)
225 str = talloc_vasprintf(msg, fmt, ap);
228 if (str == NULL) return -1;
231 val.length = strlen(str);
233 return ldb_msg_add_value(ldb, msg, attr_name, &val);
237 compare two ldb_message_element structures
238 assumes case senistive comparison
240 int ldb_msg_element_compare(struct ldb_message_element *el1,
241 struct ldb_message_element *el2)
245 if (el1->num_values != el2->num_values) {
246 return el1->num_values - el2->num_values;
249 for (i=0;i<el1->num_values;i++) {
250 if (!ldb_msg_find_val(el2, &el1->values[i])) {
259 compare two ldb_message_element structures
260 comparing by element name
262 int ldb_msg_element_compare_name(struct ldb_message_element *el1,
263 struct ldb_message_element *el2)
265 return ldb_attr_cmp(el1->name, el2->name);
269 convenience functions to return common types from a message
270 these return the first value if the attribute is multi-valued
272 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name)
274 struct ldb_message_element *el = ldb_msg_find_element(msg, attr_name);
275 if (!el || el->num_values == 0) {
278 return &el->values[0];
281 int ldb_msg_find_int(const struct ldb_message *msg,
282 const char *attr_name,
285 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
286 if (!v || !v->data) {
287 return default_value;
289 return strtol(v->data, NULL, 0);
292 unsigned int ldb_msg_find_uint(const struct ldb_message *msg,
293 const char *attr_name,
294 unsigned int default_value)
296 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
297 if (!v || !v->data) {
298 return default_value;
300 return strtoul(v->data, NULL, 0);
303 int64_t ldb_msg_find_int64(const struct ldb_message *msg,
304 const char *attr_name,
305 int64_t default_value)
307 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
308 if (!v || !v->data) {
309 return default_value;
311 return strtoll(v->data, NULL, 0);
314 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg,
315 const char *attr_name,
316 uint64_t default_value)
318 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
319 if (!v || !v->data) {
320 return default_value;
322 return strtoull(v->data, NULL, 0);
325 double ldb_msg_find_double(const struct ldb_message *msg,
326 const char *attr_name,
327 double default_value)
329 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
330 if (!v || !v->data) {
331 return default_value;
333 return strtod(v->data, NULL);
336 const char *ldb_msg_find_string(const struct ldb_message *msg,
337 const char *attr_name,
338 const char *default_value)
340 const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
341 if (!v || !v->data) {
342 return default_value;
349 sort the elements of a message by name
351 void ldb_msg_sort_elements(struct ldb_message *msg)
353 qsort(msg->elements, msg->num_elements, sizeof(struct ldb_message_element),
354 (comparison_fn_t)ldb_msg_element_compare_name);
359 free a message created using ldb_msg_copy
361 void ldb_msg_free(struct ldb_context *ldb, struct ldb_message *msg)
367 copy a message, allocating new memory for all parts
369 struct ldb_message *ldb_msg_copy(struct ldb_context *ldb,
370 const struct ldb_message *msg)
372 struct ldb_message *msg2;
375 msg2 = talloc(ldb, struct ldb_message);
376 if (msg2 == NULL) return NULL;
378 msg2->elements = NULL;
379 msg2->num_elements = 0;
380 msg2->private_data = NULL;
382 msg2->dn = talloc_strdup(msg2, msg->dn);
383 if (msg2->dn == NULL) goto failed;
385 msg2->elements = talloc_array(msg2, struct ldb_message_element, msg->num_elements);
386 if (msg2->elements == NULL) goto failed;
388 for (i=0;i<msg->num_elements;i++) {
389 struct ldb_message_element *el1 = &msg->elements[i];
390 struct ldb_message_element *el2 = &msg2->elements[i];
392 el2->flags = el1->flags;
395 el2->name = talloc_strdup(msg2->elements, el1->name);
396 if (el2->name == NULL) goto failed;
397 el2->values = talloc_array(msg2->elements, struct ldb_val, el1->num_values);
398 for (j=0;j<el1->num_values;j++) {
399 el2->values[j] = ldb_val_dup(ldb, &el1->values[j]);
400 if (el2->values[j].data == NULL &&
401 el1->values[j].length != 0) {
404 el2->values[j].data = talloc_steal(el2->values, el2->values[j].data);
408 msg2->num_elements++;
420 canonicalise a message, merging elements of the same name
422 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb,
423 const struct ldb_message *msg)
426 struct ldb_message *msg2;
428 msg2 = ldb_msg_copy(ldb, msg);
429 if (msg2 == NULL) return NULL;
431 ldb_msg_sort_elements(msg2);
433 for (i=1;i<msg2->num_elements;i++) {
434 struct ldb_message_element *el1 = &msg2->elements[i-1];
435 struct ldb_message_element *el2 = &msg2->elements[i];
436 if (ldb_msg_element_compare_name(el1, el2) == 0) {
437 el1->values = talloc_realloc(msg2->elements, el1->values, struct ldb_val,
438 el1->num_values + el2->num_values);
439 if (el1->values == NULL) {
442 memcpy(el1->values + el1->num_values,
444 sizeof(struct ldb_val) * el2->num_values);
445 el1->num_values += el2->num_values;
446 talloc_free(discard_const_p(char, el2->name));
447 if (i+1<msg2->num_elements) {
448 memmove(el2, el2+1, sizeof(struct ldb_message_element) *
449 (msg2->num_elements - (i+1)));
451 msg2->num_elements--;
461 return a ldb_message representing the differences between msg1 and msg2. If you
462 then use this in a ldb_modify() call it can be used to save edits to a message
464 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb,
465 struct ldb_message *msg1,
466 struct ldb_message *msg2)
468 struct ldb_message *mod;
469 struct ldb_message_element *el;
472 mod = ldb_msg_new(ldb);
475 mod->num_elements = 0;
476 mod->elements = NULL;
478 msg2 = ldb_msg_canonicalize(ldb, msg2);
483 /* look in msg2 to find elements that need to be added
485 for (i=0;i<msg2->num_elements;i++) {
486 el = ldb_msg_find_element(msg1, msg2->elements[i].name);
488 if (el && ldb_msg_element_compare(el, &msg2->elements[i]) == 0) {
492 if (ldb_msg_add(ldb, mod,
494 el?LDB_FLAG_MOD_REPLACE:LDB_FLAG_MOD_ADD) != 0) {
499 /* look in msg1 to find elements that need to be deleted */
500 for (i=0;i<msg1->num_elements;i++) {
501 el = ldb_msg_find_element(msg2, msg1->elements[i].name);
503 if (ldb_msg_add_empty(ldb, mod,
504 msg1->elements[i].name,
505 LDB_FLAG_MOD_DELETE) != 0) {