ldb: Rename module -> next_module for clarity
[nivanova/samba-autobuild/.git] / lib / ldb / common / ldb.c
1 /*
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  2004
5    Copyright (C) Simo Sorce  2005-2008
6
7      ** NOTE! The following LGPL license applies to the ldb
8      ** library. This does NOT imply that all of Samba is released
9      ** under the LGPL
10
11    This library is free software; you can redistribute it and/or
12    modify it under the terms of the GNU Lesser General Public
13    License as published by the Free Software Foundation; either
14    version 3 of the License, or (at your option) any later version.
15
16    This library is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    Lesser General Public License for more details.
20
21    You should have received a copy of the GNU Lesser General Public
22    License along with this library; if not, see <http://www.gnu.org/licenses/>.
23 */
24
25 /*
26  *  Name: ldb
27  *
28  *  Component: ldb core API
29  *
30  *  Description: core API routines interfacing to ldb backends
31  *
32  *  Author: Andrew Tridgell
33  */
34
35 #define TEVENT_DEPRECATED 1
36 #include "ldb_private.h"
37 #include "ldb.h"
38
39 static int ldb_context_destructor(void *ptr)
40 {
41         struct ldb_context *ldb = talloc_get_type(ptr, struct ldb_context);
42
43         if (ldb->transaction_active) {
44                 ldb_debug(ldb, LDB_DEBUG_FATAL,
45                           "A transaction is still active in ldb context [%p] on %s",
46                           ldb, (const char *)ldb_get_opaque(ldb, "ldb_url"));
47         }
48
49         return 0;
50 }
51
52 /*
53   this is used to catch debug messages from events
54 */
55 static void ldb_tevent_debug(void *context, enum tevent_debug_level level,
56                              const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
57
58 static void ldb_tevent_debug(void *context, enum tevent_debug_level level,
59                              const char *fmt, va_list ap)
60 {
61         struct ldb_context *ldb = talloc_get_type(context, struct ldb_context);
62         enum ldb_debug_level ldb_level = LDB_DEBUG_FATAL;
63
64         switch (level) {
65         case TEVENT_DEBUG_FATAL:
66                 ldb_level = LDB_DEBUG_FATAL;
67                 break;
68         case TEVENT_DEBUG_ERROR:
69                 ldb_level = LDB_DEBUG_ERROR;
70                 break;
71         case TEVENT_DEBUG_WARNING:
72                 ldb_level = LDB_DEBUG_WARNING;
73                 break;
74         case TEVENT_DEBUG_TRACE:
75                 ldb_level = LDB_DEBUG_TRACE;
76                 break;
77         };
78
79         /* There isn't a tevent: prefix here because to add it means
80          * actually printing the string, and most of the time we don't
81          * want to show it */
82         ldb_vdebug(ldb, ldb_level, fmt, ap);
83 }
84
85 /*
86    initialise a ldb context
87    The mem_ctx is required
88    The event_ctx is required
89 */
90 struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx)
91 {
92         struct ldb_context *ldb;
93         int ret;
94         const char *modules_path = getenv("LDB_MODULES_PATH");
95
96         if (modules_path == NULL) {
97                 modules_path = LDB_MODULESDIR;
98         }
99
100         ret = ldb_modules_load(modules_path, LDB_VERSION);
101         if (ret != LDB_SUCCESS) {
102                 return NULL;
103         }
104
105         ldb = talloc_zero(mem_ctx, struct ldb_context);
106         if (ldb == NULL) {
107                 return NULL;
108         }
109
110         /* A new event context so that callers who don't want ldb
111          * operating on thier global event context can work without
112          * having to provide their own private one explicitly */
113         if (ev_ctx == NULL) {
114                 ev_ctx = tevent_context_init(ldb);
115                 if (ev_ctx == NULL) {
116                         talloc_free(ldb);
117                         return NULL;
118                 }
119                 tevent_set_debug(ev_ctx, ldb_tevent_debug, ldb);
120                 tevent_loop_allow_nesting(ev_ctx);
121         }
122
123         ret = ldb_setup_wellknown_attributes(ldb);
124         if (ret != LDB_SUCCESS) {
125                 talloc_free(ldb);
126                 return NULL;
127         }
128
129         ldb_set_utf8_default(ldb);
130         ldb_set_create_perms(ldb, 0666);
131         ldb_set_modules_dir(ldb, LDB_MODULESDIR);
132         ldb_set_event_context(ldb, ev_ctx);
133         ret = ldb_register_extended_match_rules(ldb);
134         if (ret != LDB_SUCCESS) {
135                 talloc_free(ldb);
136                 return NULL;
137         }
138
139         /* TODO: get timeout from options if available there */
140         ldb->default_timeout = 300; /* set default to 5 minutes */
141
142         talloc_set_destructor((TALLOC_CTX *)ldb, ldb_context_destructor);
143
144         return ldb;
145 }
146
147 /*
148   try to autodetect a basedn if none specified. This fixes one of my
149   pet hates about ldapsearch, which is that you have to get a long,
150   complex basedn right to make any use of it.
151 */
152 void ldb_set_default_dns(struct ldb_context *ldb)
153 {
154         TALLOC_CTX *tmp_ctx;
155         int ret;
156         struct ldb_result *res;
157         struct ldb_dn *tmp_dn=NULL;
158         static const char *attrs[] = {
159                 "rootDomainNamingContext",
160                 "configurationNamingContext",
161                 "schemaNamingContext",
162                 "defaultNamingContext",
163                 NULL
164         };
165
166         tmp_ctx = talloc_new(ldb);
167         ret = ldb_search(ldb, tmp_ctx, &res, ldb_dn_new(tmp_ctx, ldb, NULL),
168                          LDB_SCOPE_BASE, attrs, "(objectClass=*)");
169         if (ret != LDB_SUCCESS) {
170                 talloc_free(tmp_ctx);
171                 return;
172         }
173
174         if (res->count != 1) {
175                 talloc_free(tmp_ctx);
176                 return;
177         }
178
179         if (!ldb_get_opaque(ldb, "rootDomainNamingContext")) {
180                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
181                                                  "rootDomainNamingContext");
182                 ldb_set_opaque(ldb, "rootDomainNamingContext", tmp_dn);
183         }
184
185         if (!ldb_get_opaque(ldb, "configurationNamingContext")) {
186                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
187                                                  "configurationNamingContext");
188                 ldb_set_opaque(ldb, "configurationNamingContext", tmp_dn);
189         }
190
191         if (!ldb_get_opaque(ldb, "schemaNamingContext")) {
192                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
193                                                  "schemaNamingContext");
194                 ldb_set_opaque(ldb, "schemaNamingContext", tmp_dn);
195         }
196
197         if (!ldb_get_opaque(ldb, "defaultNamingContext")) {
198                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
199                                                  "defaultNamingContext");
200                 ldb_set_opaque(ldb, "defaultNamingContext", tmp_dn);
201         }
202
203         talloc_free(tmp_ctx);
204 }
205
206 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb)
207 {
208         void *opaque = ldb_get_opaque(ldb, "rootDomainNamingContext");
209         return talloc_get_type(opaque, struct ldb_dn);
210 }
211
212 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb)
213 {
214         void *opaque = ldb_get_opaque(ldb, "configurationNamingContext");
215         return talloc_get_type(opaque, struct ldb_dn);
216 }
217
218 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb)
219 {
220         void *opaque = ldb_get_opaque(ldb, "schemaNamingContext");
221         return talloc_get_type(opaque, struct ldb_dn);
222 }
223
224 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
225 {
226         void *opaque = ldb_get_opaque(ldb, "defaultNamingContext");
227         return talloc_get_type(opaque, struct ldb_dn);
228 }
229
230 /*
231    connect to a database. The URL can either be one of the following forms
232    ldb://path
233    ldapi://path
234
235    flags is made up of LDB_FLG_*
236
237    the options are passed uninterpreted to the backend, and are
238    backend specific
239 */
240 int ldb_connect(struct ldb_context *ldb, const char *url,
241                 unsigned int flags, const char *options[])
242 {
243         int ret;
244         char *url2;
245         /* We seem to need to do this here, or else some utilities don't
246          * get ldb backends */
247
248         ldb->flags = flags;
249
250         url2 = talloc_strdup(ldb, url);
251         if (!url2) {
252                 ldb_oom(ldb);
253                 return LDB_ERR_OPERATIONS_ERROR;
254         }
255         ret = ldb_set_opaque(ldb, "ldb_url", url2);
256         if (ret != LDB_SUCCESS) {
257                 return ret;
258         }
259
260         ret = ldb_module_connect_backend(ldb, url, options, &ldb->modules);
261         if (ret != LDB_SUCCESS) {
262                 return ret;
263         }
264
265         ret = ldb_load_modules(ldb, options);
266         if (ret != LDB_SUCCESS) {
267                 ldb_debug(ldb, LDB_DEBUG_FATAL,
268                           "Unable to load modules for %s: %s",
269                           url, ldb_errstring(ldb));
270                 return ret;
271         }
272
273         /* set the default base dn */
274         ldb_set_default_dns(ldb);
275
276         return LDB_SUCCESS;
277 }
278
279 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string)
280 {
281         ldb_asprintf_errstring(ldb, "%s", err_string);
282 }
283
284 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...)
285 {
286         va_list ap;
287         char *old_err_string = NULL;
288         if (ldb->err_string) {
289                 old_err_string = ldb->err_string;
290         }
291
292         va_start(ap, format);
293         ldb->err_string = talloc_vasprintf(ldb, format, ap);
294         va_end(ap);
295
296         TALLOC_FREE(old_err_string);
297         
298         if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
299                 ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_asprintf/set_errstring: %s",
300                           ldb->err_string);
301         }
302 }
303
304 void ldb_reset_err_string(struct ldb_context *ldb)
305 {
306         if (ldb->err_string) {
307                 talloc_free(ldb->err_string);
308                 ldb->err_string = NULL;
309         }
310 }
311
312
313
314 /*
315   set an ldb error based on file:line
316 */
317 int ldb_error_at(struct ldb_context *ldb, int ecode,
318                  const char *reason, const char *file, int line)
319 {
320         if (reason == NULL) {
321                 reason = ldb_strerror(ecode);
322         }
323         ldb_asprintf_errstring(ldb, "%s at %s:%d", reason, file, line);
324         return ecode;
325 }
326
327
328 #define FIRST_OP_NOERR(ldb, op) do { \
329         next_module = ldb->modules;                                     \
330         while (next_module && next_module->ops->op == NULL) {           \
331                 next_module = next_module->next;                            \
332         };                                                          \
333         if ((ldb->flags & LDB_FLG_ENABLE_TRACING) && next_module) { \
334                 ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: (%s)->" #op, \
335                           next_module->ops->name);                              \
336         }                                                               \
337 } while (0)
338
339 #define FIRST_OP(ldb, op) do { \
340         FIRST_OP_NOERR(ldb, op); \
341         if (next_module == NULL) {                                      \
342                 ldb_asprintf_errstring(ldb, "unable to find module or backend to handle operation: " #op); \
343                 return LDB_ERR_OPERATIONS_ERROR;                        \
344         } \
345 } while (0)
346
347
348 /*
349   start a transaction
350 */
351 int ldb_transaction_start(struct ldb_context *ldb)
352 {
353         struct ldb_module *next_module;
354         int status;
355
356         ldb_debug(ldb, LDB_DEBUG_TRACE,
357                   "start ldb transaction (nesting: %d)",
358                   ldb->transaction_active);
359
360         /* explicit transaction active, count nested requests */
361         if (ldb->transaction_active) {
362                 ldb->transaction_active++;
363                 return LDB_SUCCESS;
364         }
365
366         /* start a new transaction */
367         ldb->transaction_active++;
368         ldb->prepare_commit_done = false;
369
370         FIRST_OP(ldb, start_transaction);
371
372         ldb_reset_err_string(ldb);
373
374         status = next_module->ops->start_transaction(next_module);
375         if (status != LDB_SUCCESS) {
376                 if (ldb->err_string == NULL) {
377                         /* no error string was setup by the backend */
378                         ldb_asprintf_errstring(ldb,
379                                 "ldb transaction start: %s (%d)",
380                                 ldb_strerror(status),
381                                 status);
382                 }
383                 if ((next_module && next_module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
384                         ldb_debug(next_module->ldb, LDB_DEBUG_TRACE, "start ldb transaction error: %s",
385                                   ldb_errstring(next_module->ldb));
386                 }
387         } else {
388                 if ((next_module && next_module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
389                         ldb_debug(next_module->ldb, LDB_DEBUG_TRACE, "start ldb transaction success");
390                 }
391         }
392         return status;
393 }
394
395 /*
396   prepare for transaction commit (first phase of two phase commit)
397 */
398 int ldb_transaction_prepare_commit(struct ldb_context *ldb)
399 {
400         struct ldb_module *next_module;
401         int status;
402
403         if (ldb->prepare_commit_done) {
404                 return LDB_SUCCESS;
405         }
406
407         /* commit only when all nested transactions are complete */
408         if (ldb->transaction_active > 1) {
409                 return LDB_SUCCESS;
410         }
411
412         ldb->prepare_commit_done = true;
413
414         if (ldb->transaction_active < 0) {
415                 ldb_debug(ldb, LDB_DEBUG_FATAL,
416                           "prepare commit called but no ldb transactions are active!");
417                 ldb->transaction_active = 0;
418                 return LDB_ERR_OPERATIONS_ERROR;
419         }
420
421         /* call prepare transaction if available */
422         FIRST_OP_NOERR(ldb, prepare_commit);
423         if (next_module == NULL) {
424                 return LDB_SUCCESS;
425         }
426
427         status = next_module->ops->prepare_commit(next_module);
428         if (status != LDB_SUCCESS) {
429                 ldb->transaction_active--;
430                 /* if a next_module fails the prepare then we need
431                    to call the end transaction for everyone */
432                 FIRST_OP(ldb, del_transaction);
433                 next_module->ops->del_transaction(next_module);
434                 if (ldb->err_string == NULL) {
435                         /* no error string was setup by the backend */
436                         ldb_asprintf_errstring(ldb,
437                                                "ldb transaction prepare commit: %s (%d)",
438                                                ldb_strerror(status),
439                                                status);
440                 }
441                 if ((next_module && next_module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
442                         ldb_debug(next_module->ldb, LDB_DEBUG_TRACE, "prepare commit transaction error: %s",
443                                   ldb_errstring(next_module->ldb));
444                 }
445         }
446
447         return status;
448 }
449
450
451 /*
452   commit a transaction
453 */
454 int ldb_transaction_commit(struct ldb_context *ldb)
455 {
456         struct ldb_module *next_module;
457         int status;
458
459         status = ldb_transaction_prepare_commit(ldb);
460         if (status != LDB_SUCCESS) {
461                 return status;
462         }
463
464         ldb->transaction_active--;
465
466         ldb_debug(ldb, LDB_DEBUG_TRACE,
467                   "commit ldb transaction (nesting: %d)",
468                   ldb->transaction_active);
469
470         /* commit only when all nested transactions are complete */
471         if (ldb->transaction_active > 0) {
472                 return LDB_SUCCESS;
473         }
474
475         if (ldb->transaction_active < 0) {
476                 ldb_debug(ldb, LDB_DEBUG_FATAL,
477                           "commit called but no ldb transactions are active!");
478                 ldb->transaction_active = 0;
479                 return LDB_ERR_OPERATIONS_ERROR;
480         }
481
482         ldb_reset_err_string(ldb);
483
484         FIRST_OP(ldb, end_transaction);
485         status = next_module->ops->end_transaction(next_module);
486         if (status != LDB_SUCCESS) {
487                 if (ldb->err_string == NULL) {
488                         /* no error string was setup by the backend */
489                         ldb_asprintf_errstring(ldb,
490                                 "ldb transaction commit: %s (%d)",
491                                 ldb_strerror(status),
492                                 status);
493                 }
494                 if ((next_module && next_module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
495                         ldb_debug(next_module->ldb, LDB_DEBUG_TRACE, "commit ldb transaction error: %s",
496                                   ldb_errstring(next_module->ldb));
497                 }
498                 /* cancel the transaction */
499                 FIRST_OP(ldb, del_transaction);
500                 next_module->ops->del_transaction(next_module);
501         }
502         return status;
503 }
504
505
506 /*
507   cancel a transaction
508 */
509 int ldb_transaction_cancel(struct ldb_context *ldb)
510 {
511         struct ldb_module *next_module;
512         int status;
513
514         ldb->transaction_active--;
515
516         ldb_debug(ldb, LDB_DEBUG_TRACE,
517                   "cancel ldb transaction (nesting: %d)",
518                   ldb->transaction_active);
519
520         /* really cancel only if all nested transactions are complete */
521         if (ldb->transaction_active > 0) {
522                 return LDB_SUCCESS;
523         }
524
525         if (ldb->transaction_active < 0) {
526                 ldb_debug(ldb, LDB_DEBUG_FATAL,
527                           "cancel called but no ldb transactions are active!");
528                 ldb->transaction_active = 0;
529                 return LDB_ERR_OPERATIONS_ERROR;
530         }
531
532         FIRST_OP(ldb, del_transaction);
533
534         status = next_module->ops->del_transaction(next_module);
535         if (status != LDB_SUCCESS) {
536                 if (ldb->err_string == NULL) {
537                         /* no error string was setup by the backend */
538                         ldb_asprintf_errstring(ldb,
539                                 "ldb transaction cancel: %s (%d)",
540                                 ldb_strerror(status),
541                                 status);
542                 }
543                 if ((next_module && next_module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
544                         ldb_debug(next_module->ldb, LDB_DEBUG_TRACE, "cancel ldb transaction error: %s",
545                                   ldb_errstring(next_module->ldb));
546                 }
547         }
548         return status;
549 }
550
551 /*
552   cancel a transaction with no error if no transaction is pending
553   used when we fork() to clear any parent transactions
554 */
555 int ldb_transaction_cancel_noerr(struct ldb_context *ldb)
556 {
557         if (ldb->transaction_active > 0) {
558                 return ldb_transaction_cancel(ldb);
559         }
560         return LDB_SUCCESS;
561 }
562
563
564 /* autostarts a transaction if none active */
565 static int ldb_autotransaction_request(struct ldb_context *ldb,
566                                        struct ldb_request *req)
567 {
568         int ret;
569
570         ret = ldb_transaction_start(ldb);
571         if (ret != LDB_SUCCESS) {
572                 return ret;
573         }
574
575         ret = ldb_request(ldb, req);
576         if (ret == LDB_SUCCESS) {
577                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
578         }
579
580         if (ret == LDB_SUCCESS) {
581                 return ldb_transaction_commit(ldb);
582         }
583         ldb_transaction_cancel(ldb);
584
585         return ret;
586 }
587
588 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
589 {
590         struct tevent_context *ev;
591         int ret;
592
593         if (handle == NULL) {
594                 return LDB_ERR_UNAVAILABLE;
595         }
596
597         if (handle->state == LDB_ASYNC_DONE) {
598                 if ((handle->status != LDB_SUCCESS) &&
599                     (handle->ldb->err_string == NULL)) {
600                         /* if no error string was setup by the backend */
601                         ldb_asprintf_errstring(handle->ldb,
602                                                "ldb_wait from %s with LDB_ASYNC_DONE: %s (%d)",
603                                                handle->location,
604                                                ldb_strerror(handle->status),
605                                                handle->status);
606                 }
607                 return handle->status;
608         }
609
610         ev = ldb_handle_get_event_context(handle);
611         if (NULL == ev) {
612                 return ldb_oom(handle->ldb);
613         }
614
615         switch (type) {
616         case LDB_WAIT_NONE:
617                 ret = tevent_loop_once(ev);
618                 if (ret != 0) {
619                         return ldb_operr(handle->ldb);
620                 }
621                 if (handle->status == LDB_SUCCESS) {
622                         return LDB_SUCCESS;
623                 }
624                 if (handle->ldb->err_string != NULL) {
625                         return handle->status;
626                 }
627                 /*
628                  * if no error string was setup by the backend
629                  */
630                 ldb_asprintf_errstring(handle->ldb,
631                                        "ldb_wait from %s with LDB_WAIT_NONE: %s (%d)",
632                                        handle->location,
633                                        ldb_strerror(handle->status),
634                                        handle->status);
635                 return handle->status;
636
637         case LDB_WAIT_ALL:
638                 while (handle->state != LDB_ASYNC_DONE) {
639                         ret = tevent_loop_once(ev);
640                         if (ret != 0) {
641                                 return ldb_operr(handle->ldb);
642                         }
643                         if (handle->status != LDB_SUCCESS) {
644                                 if (handle->ldb->err_string != NULL) {
645                                         return handle->status;
646                                 }
647                                 /*
648                                  * if no error string was setup by the
649                                  * backend
650                                  */
651                                 ldb_asprintf_errstring(handle->ldb,
652                                                        "ldb_wait from %s with "
653                                                        "LDB_WAIT_ALL: %s (%d)",
654                                                        handle->location,
655                                                        ldb_strerror(handle->status),
656                                                        handle->status);
657                                 return handle->status;
658                         }
659                 }
660                 if (handle->status == LDB_SUCCESS) {
661                         return LDB_SUCCESS;
662                 }
663                 if (handle->ldb->err_string != NULL) {
664                         return handle->status;
665                 }
666                 /*
667                  * if no error string was setup by the backend
668                  */
669                 ldb_asprintf_errstring(handle->ldb,
670                                        "ldb_wait from %s with LDB_WAIT_ALL,"
671                                        " LDB_ASYNC_DONE: %s (%d)",
672                                        handle->location,
673                                        ldb_strerror(handle->status),
674                                        handle->status);
675                 return handle->status;
676         }
677
678         return LDB_SUCCESS;
679 }
680
681 /* set the specified timeout or, if timeout is 0 set the default timeout */
682 int ldb_set_timeout(struct ldb_context *ldb,
683                     struct ldb_request *req,
684                     int timeout)
685 {
686         if (req == NULL) return LDB_ERR_OPERATIONS_ERROR;
687
688         if (timeout != 0) {
689                 req->timeout = timeout;
690         } else {
691                 req->timeout = ldb->default_timeout;
692         }
693         req->starttime = time(NULL);
694
695         return LDB_SUCCESS;
696 }
697
698 /* calculates the new timeout based on the previous starttime and timeout */
699 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb,
700                                   struct ldb_request *oldreq,
701                                   struct ldb_request *newreq)
702 {
703         if (newreq == NULL) return LDB_ERR_OPERATIONS_ERROR;
704
705         if (oldreq == NULL) {
706                 return ldb_set_timeout(ldb, newreq, 0);
707         }
708
709         newreq->starttime = oldreq->starttime;
710         newreq->timeout = oldreq->timeout;
711
712         return LDB_SUCCESS;
713 }
714
715
716 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb)
717 {
718         struct ldb_handle *h;
719
720         h = talloc_zero(mem_ctx, struct ldb_handle);
721         if (h == NULL) {
722                 ldb_set_errstring(ldb, "Out of Memory");
723                 return NULL;
724         }
725
726         h->status = LDB_SUCCESS;
727         h->state = LDB_ASYNC_INIT;
728         h->ldb = ldb;
729         h->flags = 0;
730         h->location = NULL;
731         h->parent = NULL;
732
733         if (h->ldb->require_private_event_context == true) {
734                 h->event_context = tevent_context_init(h);
735                 if (h->event_context == NULL) {
736                         ldb_set_errstring(ldb,
737                                           "Out of Memory allocating "
738                                           "event context for new handle");
739                         return NULL;
740                 }
741                 tevent_set_debug(h->event_context, ldb_tevent_debug, ldb);
742                 tevent_loop_allow_nesting(h->event_context);
743         }
744
745         return h;
746 }
747
748 static struct ldb_handle *ldb_handle_new_child(TALLOC_CTX *mem_ctx,
749                                                struct ldb_request *parent_req)
750 {
751         struct ldb_handle *h;
752
753         h = talloc_zero(mem_ctx, struct ldb_handle);
754         if (h == NULL) {
755                 ldb_set_errstring(parent_req->handle->ldb,
756                                   "Out of Memory");
757                 return NULL;
758         }
759
760         h->status = LDB_SUCCESS;
761         h->state = LDB_ASYNC_INIT;
762         h->ldb = parent_req->handle->ldb;
763         h->parent = parent_req;
764         h->nesting = parent_req->handle->nesting + 1;
765         h->flags = parent_req->handle->flags;
766         h->custom_flags = parent_req->handle->custom_flags;
767         h->event_context = parent_req->handle->event_context;
768
769         return h;
770 }
771
772 /*
773    set the permissions for new files to be passed to open() in
774    backends that use local files
775  */
776 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms)
777 {
778         ldb->create_perms = perms;
779 }
780
781 unsigned int ldb_get_create_perms(struct ldb_context *ldb)
782 {
783         return ldb->create_perms;
784 }
785
786 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev)
787 {
788         ldb->ev_ctx = ev;
789 }
790
791 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb)
792 {
793         return ldb->ev_ctx;
794 }
795
796 void ldb_request_set_state(struct ldb_request *req, int state)
797 {
798         req->handle->state = state;
799 }
800
801 int ldb_request_get_status(struct ldb_request *req)
802 {
803         return req->handle->status;
804 }
805
806 /*
807  * This function obtains the private event context for the handle,
808  * which may have been created to avoid nested event loops during
809  * ldb_tdb with the locks held
810  */
811 struct tevent_context *ldb_handle_get_event_context(struct ldb_handle *handle)
812 {
813         if (handle->event_context != NULL) {
814                 return handle->event_context;
815         }
816         return ldb_get_event_context(handle->ldb);
817 }
818
819 /*
820  * This function forces a specific ldb handle to use the global event
821  * context.  This allows a nested event loop to operate, so any open
822  * transaction also needs to be aborted.
823  *
824  * Any events on this event context will be lost
825  *
826  * This is used in Samba when sending an IRPC to another part of the
827  * same process instead of making a local DB modification.
828  */
829 void ldb_handle_use_global_event_context(struct ldb_handle *handle)
830 {
831         TALLOC_FREE(handle->event_context);
832 }
833
834 void ldb_set_require_private_event_context(struct ldb_context *ldb)
835 {
836         ldb->require_private_event_context = true;
837 }
838
839 /*
840   trace a ldb request
841 */
842 static void ldb_trace_request(struct ldb_context *ldb, struct ldb_request *req)
843 {
844         TALLOC_CTX *tmp_ctx = talloc_new(req);
845         unsigned int i;
846         struct ldb_ldif ldif;
847
848         switch (req->operation) {
849         case LDB_SEARCH:
850                 ldb_debug_add(ldb, "ldb_trace_request: SEARCH\n");
851                 ldb_debug_add(ldb, " dn: %s\n",
852                               ldb_dn_is_null(req->op.search.base)?"<rootDSE>":
853                               ldb_dn_get_linearized(req->op.search.base));
854                 ldb_debug_add(ldb, " scope: %s\n", 
855                           req->op.search.scope==LDB_SCOPE_BASE?"base":
856                           req->op.search.scope==LDB_SCOPE_ONELEVEL?"one":
857                           req->op.search.scope==LDB_SCOPE_SUBTREE?"sub":"UNKNOWN");
858                 ldb_debug_add(ldb, " expr: %s\n", 
859                           ldb_filter_from_tree(tmp_ctx, req->op.search.tree));
860                 if (req->op.search.attrs == NULL) {
861                         ldb_debug_add(ldb, " attr: <ALL>\n");
862                 } else {
863                         for (i=0; req->op.search.attrs[i]; i++) {
864                                 ldb_debug_add(ldb, " attr: %s\n", req->op.search.attrs[i]);
865                         }
866                 }
867                 break;
868         case LDB_DELETE:
869                 ldb_debug_add(ldb, "ldb_trace_request: DELETE\n");
870                 ldb_debug_add(ldb, " dn: %s\n", 
871                               ldb_dn_get_linearized(req->op.del.dn));
872                 break;
873         case LDB_RENAME:
874                 ldb_debug_add(ldb, "ldb_trace_request: RENAME\n");
875                 ldb_debug_add(ldb, " olddn: %s\n", 
876                               ldb_dn_get_linearized(req->op.rename.olddn));
877                 ldb_debug_add(ldb, " newdn: %s\n", 
878                               ldb_dn_get_linearized(req->op.rename.newdn));
879                 break;
880         case LDB_EXTENDED:
881                 ldb_debug_add(ldb, "ldb_trace_request: EXTENDED\n");
882                 ldb_debug_add(ldb, " oid: %s\n", req->op.extended.oid);
883                 ldb_debug_add(ldb, " data: %s\n", req->op.extended.data?"yes":"no");
884                 break;
885         case LDB_ADD:
886                 ldif.changetype = LDB_CHANGETYPE_ADD;
887                 ldif.msg = discard_const_p(struct ldb_message, req->op.add.message);
888
889                 ldb_debug_add(ldb, "ldb_trace_request: ADD\n");
890
891                 /* 
892                  * The choice to call
893                  * ldb_ldif_write_redacted_trace_string() is CRITICAL
894                  * for security.  It ensures that we do not output
895                  * passwords into debug logs 
896                  */
897
898                 ldb_debug_add(req->handle->ldb, "%s\n", 
899                               ldb_ldif_write_redacted_trace_string(req->handle->ldb, tmp_ctx, &ldif));
900                 break;
901         case LDB_MODIFY:
902                 ldif.changetype = LDB_CHANGETYPE_MODIFY;
903                 ldif.msg = discard_const_p(struct ldb_message, req->op.mod.message);
904
905                 ldb_debug_add(ldb, "ldb_trace_request: MODIFY\n");
906
907                 /* 
908                  * The choice to call
909                  * ldb_ldif_write_redacted_trace_string() is CRITICAL
910                  * for security.  It ensures that we do not output
911                  * passwords into debug logs 
912                  */
913
914                 ldb_debug_add(req->handle->ldb, "%s\n", 
915                               ldb_ldif_write_redacted_trace_string(req->handle->ldb, tmp_ctx, &ldif));
916                 break;
917         case LDB_REQ_REGISTER_CONTROL:
918                 ldb_debug_add(ldb, "ldb_trace_request: REGISTER_CONTROL\n");
919                 ldb_debug_add(req->handle->ldb, "%s\n", 
920                               req->op.reg_control.oid);
921                 break;
922         case LDB_REQ_REGISTER_PARTITION:
923                 ldb_debug_add(ldb, "ldb_trace_request: REGISTER_PARTITION\n");
924                 ldb_debug_add(req->handle->ldb, "%s\n", 
925                               ldb_dn_get_linearized(req->op.reg_partition.dn));
926                 break;
927         default:
928                 ldb_debug_add(ldb, "ldb_trace_request: UNKNOWN(%u)\n", 
929                               req->operation);
930                 break;
931         }
932
933         if (req->controls == NULL) {
934                 ldb_debug_add(ldb, " control: <NONE>\n");
935         } else {
936                 for (i=0; req->controls && req->controls[i]; i++) {
937                         if (req->controls[i]->oid) {
938                                 ldb_debug_add(ldb, " control: %s  crit:%u  data:%s\n",
939                                               req->controls[i]->oid,
940                                               req->controls[i]->critical,
941                                               req->controls[i]->data?"yes":"no");
942                         }
943                 }
944         }
945         
946         ldb_debug_end(ldb, LDB_DEBUG_TRACE);
947
948         talloc_free(tmp_ctx);
949 }
950
951 /*
952   check that the element flags don't have any internal bits set
953  */
954 static int ldb_msg_check_element_flags(struct ldb_context *ldb,
955                                        const struct ldb_message *message)
956 {
957         unsigned i;
958         for (i=0; i<message->num_elements; i++) {
959                 if (message->elements[i].flags & LDB_FLAG_INTERNAL_MASK) {
960                         ldb_asprintf_errstring(ldb, "Invalid element flags 0x%08x on element %s in %s\n",
961                                                message->elements[i].flags, message->elements[i].name,
962                                                ldb_dn_get_linearized(message->dn));
963                         return LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION;
964                 }
965         }
966         return LDB_SUCCESS;
967 }
968
969
970 /*
971   start an ldb request
972   NOTE: the request must be a talloc context.
973   returns LDB_ERR_* on errors.
974 */
975 int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
976 {
977         struct ldb_module *next_module;
978         int ret;
979
980         if (req->callback == NULL) {
981                 ldb_set_errstring(ldb, "Requests MUST define callbacks");
982                 return LDB_ERR_UNWILLING_TO_PERFORM;
983         }
984
985         ldb_reset_err_string(ldb);
986
987         if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
988                 ldb_trace_request(ldb, req);
989         }
990
991         /* call the first module in the chain */
992         switch (req->operation) {
993         case LDB_SEARCH:
994                 /* due to "ldb_build_search_req" base DN always != NULL */
995                 if (!ldb_dn_validate(req->op.search.base)) {
996                         ldb_asprintf_errstring(ldb, "ldb_search: invalid basedn '%s'",
997                                                ldb_dn_get_linearized(req->op.search.base));
998                         return LDB_ERR_INVALID_DN_SYNTAX;
999                 }
1000                 FIRST_OP(ldb, search);
1001                 ret = next_module->ops->search(next_module, req);
1002                 break;
1003         case LDB_ADD:
1004                 if (!ldb_dn_validate(req->op.add.message->dn)) {
1005                         ldb_asprintf_errstring(ldb, "ldb_add: invalid dn '%s'",
1006                                                ldb_dn_get_linearized(req->op.add.message->dn));
1007                         return LDB_ERR_INVALID_DN_SYNTAX;
1008                 }
1009                 /*
1010                  * we have to normalize here, as so many places
1011                  * in modules and backends assume we don't have two
1012                  * elements with the same name
1013                  */
1014                 ret = ldb_msg_normalize(ldb, req, req->op.add.message,
1015                                         discard_const(&req->op.add.message));
1016                 if (ret != LDB_SUCCESS) {
1017                         ldb_oom(ldb);
1018                         return ret;
1019                 }
1020                 FIRST_OP(ldb, add);
1021                 ret = ldb_msg_check_element_flags(ldb, req->op.add.message);
1022                 if (ret != LDB_SUCCESS) {
1023                         /*
1024                          * "ldb_msg_check_element_flags" generates an error
1025                          * string
1026                          */
1027                         return ret;
1028                 }
1029                 ret = next_module->ops->add(next_module, req);
1030                 break;
1031         case LDB_MODIFY:
1032                 if (!ldb_dn_validate(req->op.mod.message->dn)) {
1033                         ldb_asprintf_errstring(ldb, "ldb_modify: invalid dn '%s'",
1034                                                ldb_dn_get_linearized(req->op.mod.message->dn));
1035                         return LDB_ERR_INVALID_DN_SYNTAX;
1036                 }
1037                 FIRST_OP(ldb, modify);
1038                 ret = ldb_msg_check_element_flags(ldb, req->op.mod.message);
1039                 if (ret != LDB_SUCCESS) {
1040                         /*
1041                          * "ldb_msg_check_element_flags" generates an error
1042                          * string
1043                          */
1044                         return ret;
1045                 }
1046                 ret = next_module->ops->modify(next_module, req);
1047                 break;
1048         case LDB_DELETE:
1049                 if (!ldb_dn_validate(req->op.del.dn)) {
1050                         ldb_asprintf_errstring(ldb, "ldb_delete: invalid dn '%s'",
1051                                                ldb_dn_get_linearized(req->op.del.dn));
1052                         return LDB_ERR_INVALID_DN_SYNTAX;
1053                 }
1054                 FIRST_OP(ldb, del);
1055                 ret = next_module->ops->del(next_module, req);
1056                 break;
1057         case LDB_RENAME:
1058                 if (!ldb_dn_validate(req->op.rename.olddn)) {
1059                         ldb_asprintf_errstring(ldb, "ldb_rename: invalid olddn '%s'",
1060                                                ldb_dn_get_linearized(req->op.rename.olddn));
1061                         return LDB_ERR_INVALID_DN_SYNTAX;
1062                 }
1063                 if (!ldb_dn_validate(req->op.rename.newdn)) {
1064                         ldb_asprintf_errstring(ldb, "ldb_rename: invalid newdn '%s'",
1065                                                ldb_dn_get_linearized(req->op.rename.newdn));
1066                         return LDB_ERR_INVALID_DN_SYNTAX;
1067                 }
1068                 FIRST_OP(ldb, rename);
1069                 ret = next_module->ops->rename(next_module, req);
1070                 break;
1071         case LDB_EXTENDED:
1072                 FIRST_OP(ldb, extended);
1073                 ret = next_module->ops->extended(next_module, req);
1074                 break;
1075         default:
1076                 FIRST_OP(ldb, request);
1077                 ret = next_module->ops->request(next_module, req);
1078                 break;
1079         }
1080
1081         if ((ret != LDB_SUCCESS) && (ldb->err_string == NULL)) {
1082                 /* if no error string was setup by the backend */
1083                 ldb_asprintf_errstring(ldb, "ldb_request: %s (%d)",
1084                                        ldb_strerror(ret), ret);
1085         }
1086
1087         return ret;
1088 }
1089
1090 int ldb_request_done(struct ldb_request *req, int status)
1091 {
1092         req->handle->state = LDB_ASYNC_DONE;
1093         req->handle->status = status;
1094         return status;
1095 }
1096
1097 /*
1098   search the database given a LDAP-like search expression
1099
1100   returns an LDB error code
1101
1102   Use talloc_free to free the ldb_message returned in 'res', if successful
1103
1104 */
1105 int ldb_search_default_callback(struct ldb_request *req,
1106                                 struct ldb_reply *ares)
1107 {
1108         struct ldb_result *res;
1109         unsigned int n;
1110
1111         res = talloc_get_type(req->context, struct ldb_result);
1112
1113         if (!ares) {
1114                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1115         }
1116         if (ares->error != LDB_SUCCESS) {
1117                 return ldb_request_done(req, ares->error);
1118         }
1119
1120         switch (ares->type) {
1121         case LDB_REPLY_ENTRY:
1122                 res->msgs = talloc_realloc(res, res->msgs,
1123                                         struct ldb_message *, res->count + 2);
1124                 if (! res->msgs) {
1125                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1126                 }
1127
1128                 res->msgs[res->count + 1] = NULL;
1129
1130                 res->msgs[res->count] = talloc_move(res->msgs, &ares->message);
1131                 res->count++;
1132                 break;
1133
1134         case LDB_REPLY_REFERRAL:
1135                 if (res->refs) {
1136                         for (n = 0; res->refs[n]; n++) /*noop*/ ;
1137                 } else {
1138                         n = 0;
1139                 }
1140
1141                 res->refs = talloc_realloc(res, res->refs, char *, n + 2);
1142                 if (! res->refs) {
1143                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1144                 }
1145
1146                 res->refs[n] = talloc_move(res->refs, &ares->referral);
1147                 res->refs[n + 1] = NULL;
1148                 break;
1149
1150         case LDB_REPLY_DONE:
1151                 /* TODO: we should really support controls on entries
1152                  * and referrals too! */
1153                 res->controls = talloc_move(res, &ares->controls);
1154
1155                 /* this is the last message, and means the request is done */
1156                 /* we have to signal and eventual ldb_wait() waiting that the
1157                  * async request operation was completed */
1158                 talloc_free(ares);
1159                 return ldb_request_done(req, LDB_SUCCESS);
1160         }
1161
1162         talloc_free(ares);
1163
1164         return LDB_SUCCESS;
1165 }
1166
1167 int ldb_modify_default_callback(struct ldb_request *req, struct ldb_reply *ares)
1168 {
1169         struct ldb_result *res;
1170         unsigned int n;
1171         int ret;
1172
1173         res = talloc_get_type(req->context, struct ldb_result);
1174
1175         if (!ares) {
1176                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1177         }
1178
1179         if (ares->error != LDB_SUCCESS) {
1180                 ret = ares->error;
1181                 talloc_free(ares);
1182                 return ldb_request_done(req, ret);
1183         }
1184
1185         switch (ares->type) {
1186         case LDB_REPLY_REFERRAL:
1187                 if (res->refs) {
1188                         for (n = 0; res->refs[n]; n++) /*noop*/ ;
1189                 } else {
1190                         n = 0;
1191                 }
1192
1193                 res->refs = talloc_realloc(res, res->refs, char *, n + 2);
1194                 if (! res->refs) {
1195                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1196                 }
1197
1198                 res->refs[n] = talloc_move(res->refs, &ares->referral);
1199                 res->refs[n + 1] = NULL;
1200                 break;
1201
1202         case LDB_REPLY_DONE:
1203                 talloc_free(ares);
1204                 return ldb_request_done(req, LDB_SUCCESS);
1205         default:
1206                 talloc_free(ares);
1207                 ldb_asprintf_errstring(req->handle->ldb, "Invalid LDB reply type %d", ares->type);
1208                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1209         }
1210
1211         talloc_free(ares);
1212         return ldb_request_done(req, LDB_SUCCESS);
1213 }
1214
1215 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares)
1216 {
1217         int ret;
1218
1219         if (!ares) {
1220                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1221         }
1222
1223         if (ares->error != LDB_SUCCESS) {
1224                 ret = ares->error;
1225                 talloc_free(ares);
1226                 return ldb_request_done(req, ret);
1227         }
1228
1229         if (ares->type != LDB_REPLY_DONE) {
1230                 talloc_free(ares);
1231                 ldb_asprintf_errstring(req->handle->ldb, "Invalid LDB reply type %d", ares->type);
1232                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1233         }
1234
1235         talloc_free(ares);
1236         return ldb_request_done(req, LDB_SUCCESS);
1237 }
1238
1239 static struct ldb_request *ldb_build_req_common(TALLOC_CTX *mem_ctx,
1240                                 struct ldb_context *ldb,
1241                                 struct ldb_control **controls,
1242                                 void *context,
1243                                 ldb_request_callback_t callback,
1244                                 struct ldb_request *parent)
1245 {
1246         struct ldb_request *req = NULL;
1247
1248         req = talloc_zero(mem_ctx, struct ldb_request);
1249         if (req == NULL) {
1250                 return NULL;
1251         }
1252         req->controls = controls;
1253         req->context = context;
1254         req->callback = callback;
1255
1256         ldb_set_timeout_from_prev_req(ldb, parent, req);
1257
1258         if (parent != NULL) {
1259                 req->handle = ldb_handle_new_child(req, parent);
1260                 if (req->handle == NULL) {
1261                         TALLOC_FREE(req);
1262                         return NULL;
1263                 }
1264         } else {
1265                 req->handle = ldb_handle_new(req, ldb);
1266                 if (req->handle == NULL) {
1267                         TALLOC_FREE(req);
1268                         return NULL;
1269                 }
1270         }
1271
1272         return req;
1273 }
1274
1275 int ldb_build_search_req_ex(struct ldb_request **ret_req,
1276                         struct ldb_context *ldb,
1277                         TALLOC_CTX *mem_ctx,
1278                         struct ldb_dn *base,
1279                         enum ldb_scope scope,
1280                         struct ldb_parse_tree *tree,
1281                         const char * const *attrs,
1282                         struct ldb_control **controls,
1283                         void *context,
1284                         ldb_request_callback_t callback,
1285                         struct ldb_request *parent)
1286 {
1287         struct ldb_request *req;
1288
1289         *ret_req = NULL;
1290
1291         req = ldb_build_req_common(mem_ctx, ldb, controls,
1292                                    context, callback, parent);
1293         if (req == NULL) {
1294                 ldb_oom(ldb);
1295                 return LDB_ERR_OPERATIONS_ERROR;
1296         }
1297
1298         req->operation = LDB_SEARCH;
1299         if (base == NULL) {
1300                 req->op.search.base = ldb_dn_new(req, ldb, NULL);
1301         } else {
1302                 req->op.search.base = base;
1303         }
1304         req->op.search.scope = scope;
1305
1306         req->op.search.tree = tree;
1307         if (req->op.search.tree == NULL) {
1308                 ldb_set_errstring(ldb, "'tree' can't be NULL");
1309                 talloc_free(req);
1310                 return LDB_ERR_OPERATIONS_ERROR;
1311         }
1312
1313         req->op.search.attrs = attrs;
1314         *ret_req = req;
1315         return LDB_SUCCESS;
1316 }
1317
1318 int ldb_build_search_req(struct ldb_request **ret_req,
1319                         struct ldb_context *ldb,
1320                         TALLOC_CTX *mem_ctx,
1321                         struct ldb_dn *base,
1322                         enum ldb_scope scope,
1323                         const char *expression,
1324                         const char * const *attrs,
1325                         struct ldb_control **controls,
1326                         void *context,
1327                         ldb_request_callback_t callback,
1328                         struct ldb_request *parent)
1329 {
1330         struct ldb_parse_tree *tree;
1331         int ret;
1332
1333         tree = ldb_parse_tree(mem_ctx, expression);
1334         if (tree == NULL) {
1335                 ldb_set_errstring(ldb, "Unable to parse search expression");
1336                 return LDB_ERR_OPERATIONS_ERROR;
1337         }
1338
1339         ret = ldb_build_search_req_ex(ret_req, ldb, mem_ctx, base,
1340                                       scope, tree, attrs, controls,
1341                                       context, callback, parent);
1342         if (ret == LDB_SUCCESS) {
1343                 talloc_steal(*ret_req, tree);
1344         }
1345         return ret;
1346 }
1347
1348 int ldb_build_add_req(struct ldb_request **ret_req,
1349                         struct ldb_context *ldb,
1350                         TALLOC_CTX *mem_ctx,
1351                         const struct ldb_message *message,
1352                         struct ldb_control **controls,
1353                         void *context,
1354                         ldb_request_callback_t callback,
1355                         struct ldb_request *parent)
1356 {
1357         struct ldb_request *req;
1358
1359         *ret_req = NULL;
1360
1361         req = ldb_build_req_common(mem_ctx, ldb, controls,
1362                                    context, callback, parent);
1363         if (req == NULL) {
1364                 ldb_set_errstring(ldb, "Out of Memory");
1365                 return LDB_ERR_OPERATIONS_ERROR;
1366         }
1367
1368         req->operation = LDB_ADD;
1369         req->op.add.message = message;
1370         *ret_req = req;
1371         return LDB_SUCCESS;
1372 }
1373
1374 int ldb_build_mod_req(struct ldb_request **ret_req,
1375                         struct ldb_context *ldb,
1376                         TALLOC_CTX *mem_ctx,
1377                         const struct ldb_message *message,
1378                         struct ldb_control **controls,
1379                         void *context,
1380                         ldb_request_callback_t callback,
1381                         struct ldb_request *parent)
1382 {
1383         struct ldb_request *req;
1384
1385         *ret_req = NULL;
1386
1387         req = ldb_build_req_common(mem_ctx, ldb, controls,
1388                                    context, callback, parent);
1389         if (req == NULL) {
1390                 ldb_set_errstring(ldb, "Out of Memory");
1391                 return LDB_ERR_OPERATIONS_ERROR;
1392         }
1393
1394         req->operation = LDB_MODIFY;
1395         req->op.mod.message = message;
1396
1397         *ret_req = req;
1398         return LDB_SUCCESS;
1399 }
1400
1401 int ldb_build_del_req(struct ldb_request **ret_req,
1402                         struct ldb_context *ldb,
1403                         TALLOC_CTX *mem_ctx,
1404                         struct ldb_dn *dn,
1405                         struct ldb_control **controls,
1406                         void *context,
1407                         ldb_request_callback_t callback,
1408                         struct ldb_request *parent)
1409 {
1410         struct ldb_request *req;
1411
1412         *ret_req = NULL;
1413
1414         req = ldb_build_req_common(mem_ctx, ldb, controls,
1415                                    context, callback, parent);
1416         if (req == NULL) {
1417                 ldb_set_errstring(ldb, "Out of Memory");
1418                 return LDB_ERR_OPERATIONS_ERROR;
1419         }
1420
1421         req->operation = LDB_DELETE;
1422         req->op.del.dn = dn;
1423         *ret_req = req;
1424         return LDB_SUCCESS;
1425 }
1426
1427 int ldb_build_rename_req(struct ldb_request **ret_req,
1428                         struct ldb_context *ldb,
1429                         TALLOC_CTX *mem_ctx,
1430                         struct ldb_dn *olddn,
1431                         struct ldb_dn *newdn,
1432                         struct ldb_control **controls,
1433                         void *context,
1434                         ldb_request_callback_t callback,
1435                         struct ldb_request *parent)
1436 {
1437         struct ldb_request *req;
1438
1439         *ret_req = NULL;
1440
1441         req = ldb_build_req_common(mem_ctx, ldb, controls,
1442                                    context, callback, parent);
1443         if (req == NULL) {
1444                 ldb_set_errstring(ldb, "Out of Memory");
1445                 return LDB_ERR_OPERATIONS_ERROR;
1446         }
1447
1448         req->operation = LDB_RENAME;
1449         req->op.rename.olddn = olddn;
1450         req->op.rename.newdn = newdn;
1451         *ret_req = req;
1452         return LDB_SUCCESS;
1453 }
1454
1455 int ldb_extended_default_callback(struct ldb_request *req,
1456                                   struct ldb_reply *ares)
1457 {
1458         struct ldb_result *res;
1459
1460         res = talloc_get_type(req->context, struct ldb_result);
1461
1462         if (!ares) {
1463                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1464         }
1465         if (ares->error != LDB_SUCCESS) {
1466                 return ldb_request_done(req, ares->error);
1467         }
1468
1469         if (ares->type == LDB_REPLY_DONE) {
1470
1471                 /* TODO: we should really support controls on entries and referrals too! */
1472                 res->extended = talloc_move(res, &ares->response);
1473                 res->controls = talloc_move(res, &ares->controls);
1474
1475                 talloc_free(ares);
1476                 return ldb_request_done(req, LDB_SUCCESS);
1477         }
1478
1479         talloc_free(ares);
1480         ldb_asprintf_errstring(req->handle->ldb, "Invalid LDB reply type %d", ares->type);
1481         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1482 }
1483
1484 int ldb_build_extended_req(struct ldb_request **ret_req,
1485                            struct ldb_context *ldb,
1486                            TALLOC_CTX *mem_ctx,
1487                            const char *oid,
1488                            void *data,
1489                            struct ldb_control **controls,
1490                            void *context,
1491                            ldb_request_callback_t callback,
1492                            struct ldb_request *parent)
1493 {
1494         struct ldb_request *req;
1495
1496         *ret_req = NULL;
1497
1498         req = ldb_build_req_common(mem_ctx, ldb, controls,
1499                                    context, callback, parent);
1500         if (req == NULL) {
1501                 ldb_set_errstring(ldb, "Out of Memory");
1502                 return LDB_ERR_OPERATIONS_ERROR;
1503         }
1504
1505         req->operation = LDB_EXTENDED;
1506         req->op.extended.oid = oid;
1507         req->op.extended.data = data;
1508         *ret_req = req;
1509         return LDB_SUCCESS;
1510 }
1511
1512 int ldb_extended(struct ldb_context *ldb,
1513                  const char *oid,
1514                  void *data,
1515                  struct ldb_result **_res)
1516 {
1517         struct ldb_request *req;
1518         int ret;
1519         struct ldb_result *res;
1520
1521         *_res = NULL;
1522         req = NULL;
1523
1524         res = talloc_zero(ldb, struct ldb_result);
1525         if (!res) {
1526                 return LDB_ERR_OPERATIONS_ERROR;
1527         }
1528
1529         ret = ldb_build_extended_req(&req, ldb, ldb,
1530                                      oid, data, NULL,
1531                                      res, ldb_extended_default_callback,
1532                                      NULL);
1533         ldb_req_set_location(req, "ldb_extended");
1534
1535         if (ret != LDB_SUCCESS) goto done;
1536
1537         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1538
1539         ret = ldb_request(ldb, req);
1540
1541         if (ret == LDB_SUCCESS) {
1542                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1543         }
1544
1545 done:
1546         if (ret != LDB_SUCCESS) {
1547                 talloc_free(res);
1548                 res = NULL;
1549         }
1550
1551         talloc_free(req);
1552
1553         *_res = res;
1554         return ret;
1555 }
1556
1557 /*
1558   note that ldb_search() will automatically replace a NULL 'base' value
1559   with the defaultNamingContext from the rootDSE if available.
1560 */
1561 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1562                 struct ldb_result **result, struct ldb_dn *base,
1563                 enum ldb_scope scope, const char * const *attrs,
1564                 const char *exp_fmt, ...)
1565 {
1566         struct ldb_request *req;
1567         struct ldb_result *res;
1568         char *expression;
1569         va_list ap;
1570         int ret;
1571
1572         expression = NULL;
1573         *result = NULL;
1574         req = NULL;
1575
1576         res = talloc_zero(mem_ctx, struct ldb_result);
1577         if (!res) {
1578                 return LDB_ERR_OPERATIONS_ERROR;
1579         }
1580
1581         if (exp_fmt) {
1582                 va_start(ap, exp_fmt);
1583                 expression = talloc_vasprintf(mem_ctx, exp_fmt, ap);
1584                 va_end(ap);
1585
1586                 if (!expression) {
1587                         talloc_free(res);
1588                         return LDB_ERR_OPERATIONS_ERROR;
1589                 }
1590         }
1591
1592         ret = ldb_build_search_req(&req, ldb, mem_ctx,
1593                                         base?base:ldb_get_default_basedn(ldb),
1594                                         scope,
1595                                         expression,
1596                                         attrs,
1597                                         NULL,
1598                                         res,
1599                                         ldb_search_default_callback,
1600                                         NULL);
1601         ldb_req_set_location(req, "ldb_search");
1602
1603         if (ret != LDB_SUCCESS) goto done;
1604
1605         ret = ldb_request(ldb, req);
1606
1607         if (ret == LDB_SUCCESS) {
1608                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1609         }
1610
1611 done:
1612         if (ret != LDB_SUCCESS) {
1613                 talloc_free(res);
1614                 res = NULL;
1615         }
1616
1617         talloc_free(expression);
1618         talloc_free(req);
1619
1620         *result = res;
1621         return ret;
1622 }
1623
1624 /*
1625   add a record to the database. Will fail if a record with the given class
1626   and key already exists
1627 */
1628 int ldb_add(struct ldb_context *ldb,
1629             const struct ldb_message *message)
1630 {
1631         struct ldb_request *req;
1632         int ret;
1633
1634         ret = ldb_msg_sanity_check(ldb, message);
1635         if (ret != LDB_SUCCESS) {
1636                 return ret;
1637         }
1638
1639         ret = ldb_build_add_req(&req, ldb, ldb,
1640                                         message,
1641                                         NULL,
1642                                         NULL,
1643                                         ldb_op_default_callback,
1644                                         NULL);
1645         ldb_req_set_location(req, "ldb_add");
1646
1647         if (ret != LDB_SUCCESS) return ret;
1648
1649         /* do request and autostart a transaction */
1650         ret = ldb_autotransaction_request(ldb, req);
1651
1652         talloc_free(req);
1653         return ret;
1654 }
1655
1656 /*
1657   modify the specified attributes of a record
1658 */
1659 int ldb_modify(struct ldb_context *ldb,
1660                const struct ldb_message *message)
1661 {
1662         struct ldb_request *req;
1663         int ret;
1664
1665         ret = ldb_msg_sanity_check(ldb, message);
1666         if (ret != LDB_SUCCESS) {
1667                 return ret;
1668         }
1669
1670         ret = ldb_build_mod_req(&req, ldb, ldb,
1671                                         message,
1672                                         NULL,
1673                                         NULL,
1674                                         ldb_op_default_callback,
1675                                         NULL);
1676         ldb_req_set_location(req, "ldb_modify");
1677
1678         if (ret != LDB_SUCCESS) return ret;
1679
1680         /* do request and autostart a transaction */
1681         ret = ldb_autotransaction_request(ldb, req);
1682
1683         talloc_free(req);
1684         return ret;
1685 }
1686
1687
1688 /*
1689   delete a record from the database
1690 */
1691 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn)
1692 {
1693         struct ldb_request *req;
1694         int ret;
1695
1696         ret = ldb_build_del_req(&req, ldb, ldb,
1697                                         dn,
1698                                         NULL,
1699                                         NULL,
1700                                         ldb_op_default_callback,
1701                                         NULL);
1702         ldb_req_set_location(req, "ldb_delete");
1703
1704         if (ret != LDB_SUCCESS) return ret;
1705
1706         /* do request and autostart a transaction */
1707         ret = ldb_autotransaction_request(ldb, req);
1708
1709         talloc_free(req);
1710         return ret;
1711 }
1712
1713 /*
1714   rename a record in the database
1715 */
1716 int ldb_rename(struct ldb_context *ldb,
1717                 struct ldb_dn *olddn, struct ldb_dn *newdn)
1718 {
1719         struct ldb_request *req;
1720         int ret;
1721
1722         ret = ldb_build_rename_req(&req, ldb, ldb,
1723                                         olddn,
1724                                         newdn,
1725                                         NULL,
1726                                         NULL,
1727                                         ldb_op_default_callback,
1728                                         NULL);
1729         ldb_req_set_location(req, "ldb_rename");
1730
1731         if (ret != LDB_SUCCESS) return ret;
1732
1733         /* do request and autostart a transaction */
1734         ret = ldb_autotransaction_request(ldb, req);
1735
1736         talloc_free(req);
1737         return ret;
1738 }
1739
1740
1741 /*
1742   return the global sequence number
1743 */
1744 int ldb_sequence_number(struct ldb_context *ldb,
1745                         enum ldb_sequence_type type, uint64_t *seq_num)
1746 {
1747         struct ldb_seqnum_request *seq;
1748         struct ldb_seqnum_result *seqr;
1749         struct ldb_result *res;
1750         TALLOC_CTX *tmp_ctx;
1751         int ret;
1752
1753         *seq_num = 0;
1754
1755         tmp_ctx = talloc_zero(ldb, struct ldb_request);
1756         if (tmp_ctx == NULL) {
1757                 ldb_set_errstring(ldb, "Out of Memory");
1758                 return LDB_ERR_OPERATIONS_ERROR;
1759         }
1760         seq = talloc_zero(tmp_ctx, struct ldb_seqnum_request);
1761         if (seq == NULL) {
1762                 ldb_set_errstring(ldb, "Out of Memory");
1763                 ret = LDB_ERR_OPERATIONS_ERROR;
1764                 goto done;
1765         }
1766         seq->type = type;
1767
1768         ret = ldb_extended(ldb, LDB_EXTENDED_SEQUENCE_NUMBER, seq, &res);
1769         if (ret != LDB_SUCCESS) {
1770                 goto done;
1771         }
1772         talloc_steal(tmp_ctx, res);
1773
1774         if (strcmp(LDB_EXTENDED_SEQUENCE_NUMBER, res->extended->oid) != 0) {
1775                 ldb_set_errstring(ldb, "Invalid OID in reply");
1776                 ret = LDB_ERR_OPERATIONS_ERROR;
1777                 goto done;
1778         }
1779         seqr = talloc_get_type(res->extended->data,
1780                                 struct ldb_seqnum_result);
1781         *seq_num = seqr->seq_num;
1782
1783 done:
1784         talloc_free(tmp_ctx);
1785         return ret;
1786 }
1787
1788 /*
1789   return extended error information
1790 */
1791 const char *ldb_errstring(struct ldb_context *ldb)
1792 {
1793         if (ldb->err_string) {
1794                 return ldb->err_string;
1795         }
1796
1797         return NULL;
1798 }
1799
1800 /*
1801   return a string explaining what a ldb error constant meancs
1802 */
1803 const char *ldb_strerror(int ldb_err)
1804 {
1805         switch (ldb_err) {
1806         case LDB_SUCCESS:
1807                 return "Success";
1808         case LDB_ERR_OPERATIONS_ERROR:
1809                 return "Operations error";
1810         case LDB_ERR_PROTOCOL_ERROR:
1811                 return "Protocol error";
1812         case LDB_ERR_TIME_LIMIT_EXCEEDED:
1813                 return "Time limit exceeded";
1814         case LDB_ERR_SIZE_LIMIT_EXCEEDED:
1815                 return "Size limit exceeded";
1816         case LDB_ERR_COMPARE_FALSE:
1817                 return "Compare false";
1818         case LDB_ERR_COMPARE_TRUE:
1819                 return "Compare true";
1820         case LDB_ERR_AUTH_METHOD_NOT_SUPPORTED:
1821                 return "Auth method not supported";
1822         case LDB_ERR_STRONG_AUTH_REQUIRED:
1823                 return "Strong auth required";
1824 /* 9 RESERVED */
1825         case LDB_ERR_REFERRAL:
1826                 return "Referral error";
1827         case LDB_ERR_ADMIN_LIMIT_EXCEEDED:
1828                 return "Admin limit exceeded";
1829         case LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION:
1830                 return "Unsupported critical extension";
1831         case LDB_ERR_CONFIDENTIALITY_REQUIRED:
1832                 return "Confidentiality required";
1833         case LDB_ERR_SASL_BIND_IN_PROGRESS:
1834                 return "SASL bind in progress";
1835         case LDB_ERR_NO_SUCH_ATTRIBUTE:
1836                 return "No such attribute";
1837         case LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE:
1838                 return "Undefined attribute type";
1839         case LDB_ERR_INAPPROPRIATE_MATCHING:
1840                 return "Inappropriate matching";
1841         case LDB_ERR_CONSTRAINT_VIOLATION:
1842                 return "Constraint violation";
1843         case LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS:
1844                 return "Attribute or value exists";
1845         case LDB_ERR_INVALID_ATTRIBUTE_SYNTAX:
1846                 return "Invalid attribute syntax";
1847 /* 22-31 unused */
1848         case LDB_ERR_NO_SUCH_OBJECT:
1849                 return "No such object";
1850         case LDB_ERR_ALIAS_PROBLEM:
1851                 return "Alias problem";
1852         case LDB_ERR_INVALID_DN_SYNTAX:
1853                 return "Invalid DN syntax";
1854 /* 35 RESERVED */
1855         case LDB_ERR_ALIAS_DEREFERENCING_PROBLEM:
1856                 return "Alias dereferencing problem";
1857 /* 37-47 unused */
1858         case LDB_ERR_INAPPROPRIATE_AUTHENTICATION:
1859                 return "Inappropriate authentication";
1860         case LDB_ERR_INVALID_CREDENTIALS:
1861                 return "Invalid credentials";
1862         case LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS:
1863                 return "insufficient access rights";
1864         case LDB_ERR_BUSY:
1865                 return "Busy";
1866         case LDB_ERR_UNAVAILABLE:
1867                 return "Unavailable";
1868         case LDB_ERR_UNWILLING_TO_PERFORM:
1869                 return "Unwilling to perform";
1870         case LDB_ERR_LOOP_DETECT:
1871                 return "Loop detect";
1872 /* 55-63 unused */
1873         case LDB_ERR_NAMING_VIOLATION:
1874                 return "Naming violation";
1875         case LDB_ERR_OBJECT_CLASS_VIOLATION:
1876                 return "Object class violation";
1877         case LDB_ERR_NOT_ALLOWED_ON_NON_LEAF:
1878                 return "Not allowed on non-leaf";
1879         case LDB_ERR_NOT_ALLOWED_ON_RDN:
1880                 return "Not allowed on RDN";
1881         case LDB_ERR_ENTRY_ALREADY_EXISTS:
1882                 return "Entry already exists";
1883         case LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED:
1884                 return "Object class mods prohibited";
1885 /* 70 RESERVED FOR CLDAP */
1886         case LDB_ERR_AFFECTS_MULTIPLE_DSAS:
1887                 return "Affects multiple DSAs";
1888 /* 72-79 unused */
1889         case LDB_ERR_OTHER:
1890                 return "Other";
1891         }
1892
1893         return "Unknown error";
1894 }
1895
1896 /*
1897   set backend specific opaque parameters
1898 */
1899 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value)
1900 {
1901         struct ldb_opaque *o;
1902
1903         /* allow updating an existing value */
1904         for (o=ldb->opaque;o;o=o->next) {
1905                 if (strcmp(o->name, name) == 0) {
1906                         o->value = value;
1907                         return LDB_SUCCESS;
1908                 }
1909         }
1910
1911         o = talloc(ldb, struct ldb_opaque);
1912         if (o == NULL) {
1913                 ldb_oom(ldb);
1914                 return LDB_ERR_OTHER;
1915         }
1916         o->next = ldb->opaque;
1917         o->name = name;
1918         o->value = value;
1919         ldb->opaque = o;
1920         return LDB_SUCCESS;
1921 }
1922
1923 /*
1924   get a previously set opaque value
1925 */
1926 void *ldb_get_opaque(struct ldb_context *ldb, const char *name)
1927 {
1928         struct ldb_opaque *o;
1929         for (o=ldb->opaque;o;o=o->next) {
1930                 if (strcmp(o->name, name) == 0) {
1931                         return o->value;
1932                 }
1933         }
1934         return NULL;
1935 }
1936
1937 int ldb_global_init(void)
1938 {
1939         /* Provided for compatibility with some older versions of ldb */
1940         return 0;
1941 }
1942
1943 /* return the ldb flags */
1944 unsigned int ldb_get_flags(struct ldb_context *ldb)
1945 {
1946         return ldb->flags;
1947 }
1948
1949 /* set the ldb flags */
1950 void ldb_set_flags(struct ldb_context *ldb, unsigned flags)
1951 {
1952         ldb->flags = flags;
1953 }
1954
1955
1956 /*
1957   set the location in a ldb request. Used for debugging
1958  */
1959 void ldb_req_set_location(struct ldb_request *req, const char *location)
1960 {
1961         if (req && req->handle) {
1962                 req->handle->location = location;
1963         }
1964 }
1965
1966 /*
1967   return the location set with dsdb_req_set_location
1968  */
1969 const char *ldb_req_location(struct ldb_request *req)
1970 {
1971         return req->handle->location;
1972 }
1973
1974 /**
1975   mark a request as untrusted. This tells the rootdse module to remove
1976   unregistered controls
1977  */
1978 void ldb_req_mark_untrusted(struct ldb_request *req)
1979 {
1980         req->handle->flags |= LDB_HANDLE_FLAG_UNTRUSTED;
1981 }
1982
1983 /**
1984   mark a request as trusted.
1985  */
1986 void ldb_req_mark_trusted(struct ldb_request *req)
1987 {
1988         req->handle->flags &= ~LDB_HANDLE_FLAG_UNTRUSTED;
1989 }
1990
1991 /**
1992   set custom flags. Those flags are set by applications using ldb,
1993   they are application dependent and the same bit can have different
1994   meaning in different application.
1995  */
1996 void ldb_req_set_custom_flags(struct ldb_request *req, uint32_t flags)
1997 {
1998         if (req != NULL && req->handle != NULL) {
1999                 req->handle->custom_flags = flags;
2000         }
2001 }
2002
2003
2004 /**
2005   get custom flags. Those flags are set by applications using ldb,
2006   they are application dependent and the same bit can have different
2007   meaning in different application.
2008  */
2009 uint32_t ldb_req_get_custom_flags(struct ldb_request *req)
2010 {
2011         if (req != NULL && req->handle != NULL) {
2012                 return req->handle->custom_flags;
2013         }
2014
2015         /*
2016          * 0 is not something any better or worse than
2017          * anything else as req or the handle is NULL
2018          */
2019         return 0;
2020 }
2021
2022
2023 /**
2024  * return true if a request is untrusted
2025  */
2026 bool ldb_req_is_untrusted(struct ldb_request *req)
2027 {
2028         return (req->handle->flags & LDB_HANDLE_FLAG_UNTRUSTED) != 0;
2029 }