r17301: Add a new function to copy a list of attributes, while adding one to
[kamenim/samba.git] / source4 / lib / ldb / common / ldb_msg.c
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  2004
5
6      ** NOTE! The following LGPL license applies to the ldb
7      ** library. This does NOT imply that all of Samba is released
8      ** under the LGPL
9    
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.
14
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.
19
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
23 */
24
25 /*
26  *  Name: ldb
27  *
28  *  Component: ldb message component utility functions
29  *
30  *  Description: functions for manipulating ldb_message structures
31  *
32  *  Author: Andrew Tridgell
33  */
34
35 #include "includes.h"
36 #include "ldb/include/includes.h"
37
38 /*
39   create a new ldb_message in a given memory context (NULL for top level)
40 */
41 struct ldb_message *ldb_msg_new(void *mem_ctx)
42 {
43         return talloc_zero(mem_ctx, struct ldb_message);
44 }
45
46 /*
47   find an element in a message by attribute name
48 */
49 struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg, 
50                                                  const char *attr_name)
51 {
52         unsigned int i;
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];
56                 }
57         }
58         return NULL;
59 }
60
61 /*
62   see if two ldb_val structures contain exactly the same data
63   return 1 for a match, 0 for a mis-match
64 */
65 int ldb_val_equal_exact(const struct ldb_val *v1, const struct ldb_val *v2)
66 {
67         if (v1->length != v2->length) return 0;
68
69         if (v1->length == 0) return 1;
70
71         if (memcmp(v1->data, v2->data, v1->length) == 0) {
72                 return 1;
73         }
74
75         return 0;
76 }
77
78 /*
79   find a value in an element
80   assumes case sensitive comparison
81 */
82 struct ldb_val *ldb_msg_find_val(const struct ldb_message_element *el, 
83                                  struct ldb_val *val)
84 {
85         unsigned int i;
86         for (i=0;i<el->num_values;i++) {
87                 if (ldb_val_equal_exact(val, &el->values[i])) {
88                         return &el->values[i];
89                 }
90         }
91         return NULL;
92 }
93
94 /*
95   duplicate a ldb_val structure
96 */
97 struct ldb_val ldb_val_dup(void *mem_ctx, const struct ldb_val *v)
98 {
99         struct ldb_val v2;
100         v2.length = v->length;
101         if (v->data == NULL) {
102                 v2.data = NULL;
103                 return v2;
104         }
105
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);
109         if (!v2.data) {
110                 v2.length = 0;
111                 return v2;
112         }
113
114         memcpy(v2.data, v->data, v->length);
115         ((char *)v2.data)[v->length] = 0;
116         return v2;
117 }
118
119 /*
120   add an empty element to a message
121 */
122 int ldb_msg_add_empty(struct ldb_message *msg, const char *attr_name, int flags)
123 {
124         struct ldb_message_element *els;
125
126         if (! ldb_valid_attr_name(attr_name)) {
127                 return -1;
128         }
129
130         els = talloc_realloc(msg, msg->elements, 
131                              struct ldb_message_element, msg->num_elements+1);
132         if (!els) {
133                 errno = ENOMEM;
134                 return -1;
135         }
136
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) {
142                 errno = ENOMEM;
143                 return -1;
144         }
145
146         msg->elements = els;
147         msg->num_elements++;
148
149         return 0;
150 }
151
152 /*
153   add an empty element to a message
154 */
155 int ldb_msg_add(struct ldb_message *msg, 
156                 const struct ldb_message_element *el, 
157                 int flags)
158 {
159         if (ldb_msg_add_empty(msg, el->name, flags) != 0) {
160                 return -1;
161         }
162
163         msg->elements[msg->num_elements-1] = *el;
164         msg->elements[msg->num_elements-1].flags = flags;
165
166         return 0;
167 }
168
169 /*
170   add a value to a message
171 */
172 int ldb_msg_add_value(struct ldb_message *msg, 
173                       const char *attr_name,
174                       const struct ldb_val *val)
175 {
176         struct ldb_message_element *el;
177         struct ldb_val *vals;
178
179         el = ldb_msg_find_element(msg, attr_name);
180         if (!el) {
181                 ldb_msg_add_empty(msg, attr_name, 0);
182                 el = ldb_msg_find_element(msg, attr_name);
183         }
184         if (!el) {
185                 return -1;
186         }
187
188         vals = talloc_realloc(msg, el->values, struct ldb_val, el->num_values+1);
189         if (!vals) {
190                 errno = ENOMEM;
191                 return -1;
192         }
193         el->values = vals;
194         el->values[el->num_values] = *val;
195         el->num_values++;
196
197         return 0;
198 }
199
200
201 /*
202   add a value to a message, stealing it into the 'right' place
203 */
204 int ldb_msg_add_steal_value(struct ldb_message *msg, 
205                             const char *attr_name,
206                             struct ldb_val *val)
207 {
208         int ret;
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);
214         }
215         return ret;
216 }
217
218
219 /*
220   add a string element to a message
221 */
222 int ldb_msg_add_string(struct ldb_message *msg, 
223                        const char *attr_name, const char *str)
224 {
225         struct ldb_val val;
226
227         val.data = discard_const_p(uint8_t, str);
228         val.length = strlen(str);
229
230         return ldb_msg_add_value(msg, attr_name, &val);
231 }
232
233 /*
234   add a string element to a message, stealing it into the 'right' place
235 */
236 int ldb_msg_add_steal_string(struct ldb_message *msg, 
237                              const char *attr_name, char *str)
238 {
239         struct ldb_val val;
240
241         val.data = (uint8_t *)str;
242         val.length = strlen(str);
243
244         return ldb_msg_add_steal_value(msg, attr_name, &val);
245 }
246
247 /*
248   add a printf formatted element to a message
249 */
250 int ldb_msg_add_fmt(struct ldb_message *msg, 
251                     const char *attr_name, const char *fmt, ...)
252 {
253         struct ldb_val val;
254         va_list ap;
255         char *str;
256
257         va_start(ap, fmt);
258         str = talloc_vasprintf(msg, fmt, ap);
259         va_end(ap);
260
261         if (str == NULL) return -1;
262
263         val.data   = (uint8_t *)str;
264         val.length = strlen(str);
265
266         return ldb_msg_add_steal_value(msg, attr_name, &val);
267 }
268
269 /*
270   compare two ldb_message_element structures
271   assumes case senistive comparison
272 */
273 int ldb_msg_element_compare(struct ldb_message_element *el1, 
274                             struct ldb_message_element *el2)
275 {
276         unsigned int i;
277
278         if (el1->num_values != el2->num_values) {
279                 return el1->num_values - el2->num_values;
280         }
281
282         for (i=0;i<el1->num_values;i++) {
283                 if (!ldb_msg_find_val(el2, &el1->values[i])) {
284                         return -1;
285                 }
286         }
287
288         return 0;
289 }
290
291 /*
292   compare two ldb_message_element structures
293   comparing by element name
294 */
295 int ldb_msg_element_compare_name(struct ldb_message_element *el1, 
296                                  struct ldb_message_element *el2)
297 {
298         return ldb_attr_cmp(el1->name, el2->name);
299 }
300
301 /*
302   convenience functions to return common types from a message
303   these return the first value if the attribute is multi-valued
304 */
305 const struct ldb_val *ldb_msg_find_ldb_val(const struct ldb_message *msg, const char *attr_name)
306 {
307         struct ldb_message_element *el = ldb_msg_find_element(msg, attr_name);
308         if (!el || el->num_values == 0) {
309                 return NULL;
310         }
311         return &el->values[0];
312 }
313
314 int ldb_msg_find_int(const struct ldb_message *msg, 
315                      const char *attr_name,
316                      int default_value)
317 {
318         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
319         if (!v || !v->data) {
320                 return default_value;
321         }
322         return strtol((const char *)v->data, NULL, 0);
323 }
324
325 unsigned int ldb_msg_find_uint(const struct ldb_message *msg, 
326                                const char *attr_name,
327                                unsigned int default_value)
328 {
329         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
330         if (!v || !v->data) {
331                 return default_value;
332         }
333         return strtoul((const char *)v->data, NULL, 0);
334 }
335
336 int64_t ldb_msg_find_int64(const struct ldb_message *msg, 
337                            const char *attr_name,
338                            int64_t default_value)
339 {
340         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
341         if (!v || !v->data) {
342                 return default_value;
343         }
344         return strtoll((const char *)v->data, NULL, 0);
345 }
346
347 uint64_t ldb_msg_find_uint64(const struct ldb_message *msg, 
348                              const char *attr_name,
349                              uint64_t default_value)
350 {
351         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
352         if (!v || !v->data) {
353                 return default_value;
354         }
355         return strtoull((const char *)v->data, NULL, 0);
356 }
357
358 double ldb_msg_find_double(const struct ldb_message *msg, 
359                            const char *attr_name,
360                            double default_value)
361 {
362         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
363         if (!v || !v->data) {
364                 return default_value;
365         }
366         return strtod((const char *)v->data, NULL);
367 }
368
369 const char *ldb_msg_find_string(const struct ldb_message *msg, 
370                                 const char *attr_name,
371                                 const char *default_value)
372 {
373         const struct ldb_val *v = ldb_msg_find_ldb_val(msg, attr_name);
374         if (!v || !v->data) {
375                 return default_value;
376         }
377         return (const char *)v->data;
378 }
379
380 /*
381   sort the elements of a message by name
382 */
383 void ldb_msg_sort_elements(struct ldb_message *msg)
384 {
385         qsort(msg->elements, msg->num_elements, sizeof(struct ldb_message_element), 
386               (comparison_fn_t)ldb_msg_element_compare_name);
387 }
388
389 /*
390   shallow copy a message - copying only the elements array so that the caller
391   can safely add new elements without changing the message
392 */
393 struct ldb_message *ldb_msg_copy_shallow(TALLOC_CTX *mem_ctx, 
394                                          const struct ldb_message *msg)
395 {
396         struct ldb_message *msg2;
397         int i;
398
399         msg2 = talloc(mem_ctx, struct ldb_message);
400         if (msg2 == NULL) return NULL;
401
402         *msg2 = *msg;
403         msg2->private_data = NULL;
404
405         msg2->elements = talloc_array(msg2, struct ldb_message_element, 
406                                       msg2->num_elements);
407         if (msg2->elements == NULL) goto failed;
408
409         for (i=0;i<msg2->num_elements;i++) {
410                 msg2->elements[i] = msg->elements[i];
411         }
412
413         return msg2;
414
415 failed:
416         talloc_free(msg2);
417         return NULL;
418 }
419
420
421 /*
422   copy a message, allocating new memory for all parts
423 */
424 struct ldb_message *ldb_msg_copy(TALLOC_CTX *mem_ctx, 
425                                  const struct ldb_message *msg)
426 {
427         struct ldb_message *msg2;
428         int i, j;
429
430         msg2 = ldb_msg_copy_shallow(mem_ctx, msg);
431         if (msg2 == NULL) return NULL;
432
433         msg2->dn = ldb_dn_copy(msg2, msg2->dn);
434         if (msg2->dn == NULL) goto failed;
435
436         for (i=0;i<msg2->num_elements;i++) {
437                 struct ldb_message_element *el = &msg2->elements[i];
438                 struct ldb_val *values = el->values;
439                 el->name = talloc_strdup(msg2->elements, el->name);
440                 if (el->name == NULL) goto failed;
441                 el->values = talloc_array(msg2->elements, struct ldb_val, el->num_values);
442                 for (j=0;j<el->num_values;j++) {
443                         el->values[j] = ldb_val_dup(el->values, &values[j]);
444                         if (el->values[j].data == NULL && values[j].length != 0) {
445                                 goto failed;
446                         }
447                 }
448         }
449
450         return msg2;
451
452 failed:
453         talloc_free(msg2);
454         return NULL;
455 }
456
457
458 /*
459   canonicalise a message, merging elements of the same name
460 */
461 struct ldb_message *ldb_msg_canonicalize(struct ldb_context *ldb, 
462                                          const struct ldb_message *msg)
463 {
464         int i;
465         struct ldb_message *msg2;
466
467         msg2 = ldb_msg_copy(ldb, msg);
468         if (msg2 == NULL) return NULL;
469
470         ldb_msg_sort_elements(msg2);
471
472         for (i=1;i<msg2->num_elements;i++) {
473                 struct ldb_message_element *el1 = &msg2->elements[i-1];
474                 struct ldb_message_element *el2 = &msg2->elements[i];
475                 if (ldb_msg_element_compare_name(el1, el2) == 0) {
476                         el1->values = talloc_realloc(msg2->elements, el1->values, struct ldb_val, 
477                                                        el1->num_values + el2->num_values);
478                         if (el1->values == NULL) {
479                                 return NULL;
480                         }
481                         memcpy(el1->values + el1->num_values,
482                                el2->values,
483                                sizeof(struct ldb_val) * el2->num_values);
484                         el1->num_values += el2->num_values;
485                         talloc_free(discard_const_p(char, el2->name));
486                         if (i+1<msg2->num_elements) {
487                                 memmove(el2, el2+1, sizeof(struct ldb_message_element) * 
488                                         (msg2->num_elements - (i+1)));
489                         }
490                         msg2->num_elements--;
491                         i--;
492                 }
493         }
494
495         return msg2;
496 }
497
498
499 /*
500   return a ldb_message representing the differences between msg1 and msg2. If you
501   then use this in a ldb_modify() call it can be used to save edits to a message
502 */
503 struct ldb_message *ldb_msg_diff(struct ldb_context *ldb, 
504                                  struct ldb_message *msg1,
505                                  struct ldb_message *msg2)
506 {
507         struct ldb_message *mod;
508         struct ldb_message_element *el;
509         unsigned int i;
510
511         mod = ldb_msg_new(ldb);
512
513         mod->dn = msg1->dn;
514         mod->num_elements = 0;
515         mod->elements = NULL;
516
517         msg2 = ldb_msg_canonicalize(ldb, msg2);
518         if (msg2 == NULL) {
519                 return NULL;
520         }
521         
522         /* look in msg2 to find elements that need to be added
523            or modified */
524         for (i=0;i<msg2->num_elements;i++) {
525                 el = ldb_msg_find_element(msg1, msg2->elements[i].name);
526
527                 if (el && ldb_msg_element_compare(el, &msg2->elements[i]) == 0) {
528                         continue;
529                 }
530
531                 if (ldb_msg_add(mod, 
532                                 &msg2->elements[i],
533                                 el?LDB_FLAG_MOD_REPLACE:LDB_FLAG_MOD_ADD) != 0) {
534                         return NULL;
535                 }
536         }
537
538         /* look in msg1 to find elements that need to be deleted */
539         for (i=0;i<msg1->num_elements;i++) {
540                 el = ldb_msg_find_element(msg2, msg1->elements[i].name);
541                 if (!el) {
542                         if (ldb_msg_add_empty(mod, 
543                                               msg1->elements[i].name,
544                                               LDB_FLAG_MOD_DELETE) != 0) {
545                                 return NULL;
546                         }
547                 }
548         }
549
550         return mod;
551 }
552
553 int ldb_msg_sanity_check(struct ldb_context *ldb, 
554                          const struct ldb_message *msg)
555 {
556         int i, j;
557
558         /* basic check on DN */
559         if (msg->dn == NULL) {
560                 /* TODO: return also an error string */
561                 ldb_set_errstring(ldb, talloc_strdup(ldb, "ldb message lacks a DN!"));
562                 return LDB_ERR_INVALID_DN_SYNTAX;
563         }
564         if (msg->dn->comp_num == 0) {
565                 /* root dse has empty dn */
566                 ldb_set_errstring(ldb, talloc_strdup(ldb, "DN on new ldb message is '' (not permitted)!"));
567                 return LDB_ERR_ENTRY_ALREADY_EXISTS;
568         }
569
570         /* basic syntax checks */
571         for (i = 0; i < msg->num_elements; i++) {
572                 for (j = 0; j < msg->elements[i].num_values; j++) {
573                         if (msg->elements[i].values[j].length == 0) {
574                                 TALLOC_CTX *mem_ctx = talloc_new(ldb);
575                                 /* an attribute cannot be empty */
576                                 /* TODO: return also an error string */
577                                 ldb_set_errstring(ldb, talloc_asprintf(mem_ctx, "Element %s has empty attribute in ldb message (%s)!",
578                                                                        msg->elements[i].name, 
579                                                                        ldb_dn_linearize(mem_ctx, msg->dn)));
580                                 talloc_free(mem_ctx);
581                                 return LDB_ERR_INVALID_ATTRIBUTE_SYNTAX;
582                         }
583                 }
584         }
585
586         return LDB_SUCCESS;
587 }
588
589
590
591
592 /*
593   copy an attribute list. This only copies the array, not the elements
594   (ie. the elements are left as the same pointers)
595 */
596 const char **ldb_attr_list_copy(TALLOC_CTX *mem_ctx, const char * const *attrs)
597 {
598         const char **ret;
599         int i;
600         for (i=0;attrs[i];i++) /* noop */ ;
601         ret = talloc_array(mem_ctx, const char *, i+1);
602         if (ret == NULL) {
603                 return NULL;
604         }
605         for (i=0;attrs[i];i++) {
606                 ret[i] = attrs[i];
607         }
608         ret[i] = attrs[i];
609         return ret;
610 }
611
612
613 /*
614   copy an attribute list. This only copies the array, not the elements
615   (ie. the elements are left as the same pointers)
616 */
617 const char **ldb_attr_list_copy_add(TALLOC_CTX *mem_ctx, const char * const *attrs, const char *new_attr)
618 {
619         const char **ret;
620         int i;
621         for (i=0;attrs[i];i++) /* noop */ ;
622         ret = talloc_array(mem_ctx, const char *, i+2);
623         if (ret == NULL) {
624                 return NULL;
625         }
626         for (i=0;attrs[i];i++) {
627                 ret[i] = attrs[i];
628         }
629         ret[i] = new_attr;
630         ret[i+1] = NULL;
631         return ret;
632 }
633
634
635 /*
636   return 1 if an attribute is in a list of attributes, or 0 otherwise
637 */
638 int ldb_attr_in_list(const char * const *attrs, const char *attr)
639 {
640         int i;
641         for (i=0;attrs[i];i++) {
642                 if (ldb_attr_cmp(attrs[i], attr) == 0) {
643                         return 1;
644                 }
645         }
646         return 0;
647 }
648
649
650 /*
651   rename the specified attribute in a search result
652 */
653 int ldb_msg_rename_attr(struct ldb_message *msg, const char *attr, const char *replace)
654 {
655         struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
656         if (el == NULL) {
657                 return 0;
658         }
659         el->name = talloc_strdup(msg->elements, replace);
660         if (el->name == NULL) {
661                 return -1;
662         }
663         return 0;
664 }
665
666
667 /*
668   copy the specified attribute in a search result to a new attribute
669 */
670 int ldb_msg_copy_attr(struct ldb_message *msg, const char *attr, const char *replace)
671 {
672         struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
673         if (el == NULL) {
674                 return 0;
675         }
676         if (ldb_msg_add(msg, el, 0) != 0) {
677                 return -1;
678         }
679         return ldb_msg_rename_attr(msg, attr, replace);
680 }
681
682
683 /*
684   remove the specified attribute in a search result
685 */
686 void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr)
687 {
688         struct ldb_message_element *el = ldb_msg_find_element(msg, attr);
689         if (el) {
690                 int n = (el - msg->elements);
691                 if (n != msg->num_elements-1) {
692                         memmove(el, el+1, ((msg->num_elements-1) - n)*sizeof(*el));
693                 }
694                 msg->num_elements--;
695         }
696 }
697
698 /*
699   return a LDAP formatted time string
700 */
701 char *ldb_timestring(TALLOC_CTX *mem_ctx, time_t t)
702 {
703         struct tm *tm = gmtime(&t);
704
705         if (!tm) {
706                 return NULL;
707         }
708
709         /* formatted like: 20040408072012.0Z */
710         return talloc_asprintf(mem_ctx, 
711                                "%04u%02u%02u%02u%02u%02u.0Z",
712                                tm->tm_year+1900, tm->tm_mon+1,
713                                tm->tm_mday, tm->tm_hour, tm->tm_min,
714                                tm->tm_sec);
715 }
716
717
718 /*
719   convert a LDAP time string to a time_t. Return 0 if unable to convert
720 */
721 time_t ldb_string_to_time(const char *s)
722 {
723         struct tm tm;
724         
725         if (s == NULL) return 0;
726         
727         memset(&tm, 0, sizeof(tm));
728         if (sscanf(s, "%04u%02u%02u%02u%02u%02u", 
729                    &tm.tm_year, &tm.tm_mon, &tm.tm_mday, 
730                    &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
731                 return 0;
732         }
733         tm.tm_year -= 1900;
734         tm.tm_mon -= 1;
735         
736         return timegm(&tm);
737 }
738
739
740 /*
741   dump a set of results to a file. Useful from within gdb
742 */
743 void ldb_dump_results(struct ldb_context *ldb, struct ldb_result *result, FILE *f)
744 {
745         int i;
746
747         for (i = 0; i < result->count; i++) {
748                 struct ldb_ldif ldif;
749                 fprintf(f, "# record %d\n", i+1);
750                 ldif.changetype = LDB_CHANGETYPE_NONE;
751                 ldif.msg = result->msgs[i];
752                 ldb_ldif_write_file(ldb, f, &ldif);
753         }
754 }
755
756 int ldb_msg_check_string_attribute(const struct ldb_message *msg, const char *name, const char *value)
757 {
758         struct ldb_message_element *el;
759         struct ldb_val val;
760         
761         el = ldb_msg_find_element(msg, name);
762         if (el == NULL)
763                 return 0;
764
765         val.data = discard_const(value);
766         val.length = strlen(value);
767
768         if (ldb_msg_find_val(el, &val))
769                 return 1;
770
771         return 0;
772 }