s4-ldb: added ldb_transaction_cancel_noerr()
[ira/wip.git] / source4 / 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
38 static int ldb_context_destructor(void *ptr)
39 {
40         struct ldb_context *ldb = talloc_get_type(ptr, struct ldb_context);
41
42         if (ldb->transaction_active) {
43                 ldb_debug(ldb, LDB_DEBUG_FATAL,
44                           "A transaction is still active in ldb context [%p] on %s",
45                           ldb, (const char *)ldb_get_opaque(ldb, "ldb_url"));
46         }
47
48         return 0;
49 }
50
51 /*
52   this is used to catch debug messages from events
53 */
54 static void ldb_tevent_debug(void *context, enum tevent_debug_level level,
55                              const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
56
57 static void ldb_tevent_debug(void *context, enum tevent_debug_level level,
58                              const char *fmt, va_list ap)
59 {
60         struct ldb_context *ldb = talloc_get_type(context, struct ldb_context);
61         enum ldb_debug_level ldb_level = LDB_DEBUG_FATAL;
62         char *s = NULL;
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         vasprintf(&s, fmt, ap);
80         if (!s) return;
81         ldb_debug(ldb, ldb_level, "tevent: %s", s);
82         free(s);
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
95         ldb = talloc_zero(mem_ctx, struct ldb_context);
96         /* FIXME: Hack a new event context so that CMD line utilities work
97          * until we have them all converted */
98         if (ev_ctx == NULL) {
99                 ev_ctx = tevent_context_init(talloc_autofree_context());
100                 tevent_set_debug(ev_ctx, ldb_tevent_debug, ldb);
101                 tevent_loop_allow_nesting(ev_ctx);
102         }
103
104         ret = ldb_setup_wellknown_attributes(ldb);
105         if (ret != 0) {
106                 talloc_free(ldb);
107                 return NULL;
108         }
109
110         ldb_set_utf8_default(ldb);
111         ldb_set_create_perms(ldb, 0666);
112         ldb_set_modules_dir(ldb, LDB_MODULESDIR);
113         ldb_set_event_context(ldb, ev_ctx);
114
115         /* TODO: get timeout from options if available there */
116         ldb->default_timeout = 300; /* set default to 5 minutes */
117
118         talloc_set_destructor((TALLOC_CTX *)ldb, ldb_context_destructor);
119
120         return ldb;
121 }
122
123 /*
124   try to autodetect a basedn if none specified. This fixes one of my
125   pet hates about ldapsearch, which is that you have to get a long,
126   complex basedn right to make any use of it.
127 */
128 void ldb_set_default_dns(struct ldb_context *ldb)
129 {
130         TALLOC_CTX *tmp_ctx;
131         int ret;
132         struct ldb_result *res;
133         struct ldb_dn *tmp_dn=NULL;
134         static const char *attrs[] = {
135                 "rootDomainNamingContext",
136                 "configurationNamingContext",
137                 "schemaNamingContext",
138                 "defaultNamingContext",
139                 NULL
140         };
141
142         tmp_ctx = talloc_new(ldb);
143         ret = ldb_search(ldb, tmp_ctx, &res, ldb_dn_new(tmp_ctx, ldb, NULL),
144                          LDB_SCOPE_BASE, attrs, "(objectClass=*)");
145         if (ret != LDB_SUCCESS) {
146                 talloc_free(tmp_ctx);
147                 return;
148         }
149
150         if (res->count != 1) {
151                 talloc_free(tmp_ctx);
152                 return;
153         }
154
155         if (!ldb_get_opaque(ldb, "rootDomainNamingContext")) {
156                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
157                                                  "rootDomainNamingContext");
158                 ldb_set_opaque(ldb, "rootDomainNamingContext", tmp_dn);
159         }
160
161         if (!ldb_get_opaque(ldb, "configurationNamingContext")) {
162                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
163                                                  "configurationNamingContext");
164                 ldb_set_opaque(ldb, "configurationNamingContext", tmp_dn);
165         }
166
167         if (!ldb_get_opaque(ldb, "schemaNamingContext")) {
168                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
169                                                  "schemaNamingContext");
170                 ldb_set_opaque(ldb, "schemaNamingContext", tmp_dn);
171         }
172
173         if (!ldb_get_opaque(ldb, "defaultNamingContext")) {
174                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0],
175                                                  "defaultNamingContext");
176                 ldb_set_opaque(ldb, "defaultNamingContext", tmp_dn);
177         }
178
179         talloc_free(tmp_ctx);
180 }
181
182 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb)
183 {
184         void *opaque = ldb_get_opaque(ldb, "rootDomainNamingContext");
185         return talloc_get_type(opaque, struct ldb_dn);
186 }
187
188 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb)
189 {
190         void *opaque = ldb_get_opaque(ldb, "configurationNamingContext");
191         return talloc_get_type(opaque, struct ldb_dn);
192 }
193
194 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb)
195 {
196         void *opaque = ldb_get_opaque(ldb, "schemaNamingContext");
197         return talloc_get_type(opaque, struct ldb_dn);
198 }
199
200 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
201 {
202         void *opaque = ldb_get_opaque(ldb, "defaultNamingContext");
203         return talloc_get_type(opaque, struct ldb_dn);
204 }
205
206 /*
207    connect to a database. The URL can either be one of the following forms
208    ldb://path
209    ldapi://path
210
211    flags is made up of LDB_FLG_*
212
213    the options are passed uninterpreted to the backend, and are
214    backend specific
215 */
216 int ldb_connect(struct ldb_context *ldb, const char *url,
217                 unsigned int flags, const char *options[])
218 {
219         int ret;
220         const char *url2;
221         /* We seem to need to do this here, or else some utilities don't
222          * get ldb backends */
223
224         ldb->flags = flags;
225
226         url2 = talloc_strdup(ldb, url);
227         if (!url2) {
228                 ldb_oom(ldb);
229                 return LDB_ERR_OPERATIONS_ERROR;
230         }
231         ret = ldb_set_opaque(ldb, "ldb_url", talloc_strdup(ldb, url2));
232         if (ret != LDB_SUCCESS) {
233                 return ret;
234         }
235
236         ret = ldb_connect_backend(ldb, url, options, &ldb->modules);
237         if (ret != LDB_SUCCESS) {
238                 return ret;
239         }
240
241         if (ldb_load_modules(ldb, options) != LDB_SUCCESS) {
242                 ldb_debug(ldb, LDB_DEBUG_FATAL,
243                           "Unable to load modules for %s: %s",
244                           url, ldb_errstring(ldb));
245                 return LDB_ERR_OTHER;
246         }
247
248         /* set the default base dn */
249         ldb_set_default_dns(ldb);
250
251         return LDB_SUCCESS;
252 }
253
254 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string)
255 {
256         if (ldb->err_string) {
257                 talloc_free(ldb->err_string);
258         }
259         ldb->err_string = talloc_strdup(ldb, err_string);
260         if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
261                 ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_set_errstring: %s", ldb->err_string);
262         }
263 }
264
265 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...)
266 {
267         va_list ap;
268         char *old_string = NULL;
269
270         if (ldb->err_string) {
271                 old_string = ldb->err_string;
272         }
273
274         va_start(ap, format);
275         ldb->err_string = talloc_vasprintf(ldb, format, ap);
276         va_end(ap);
277         talloc_free(old_string);
278 }
279
280 void ldb_reset_err_string(struct ldb_context *ldb)
281 {
282         if (ldb->err_string) {
283                 talloc_free(ldb->err_string);
284                 ldb->err_string = NULL;
285         }
286 }
287
288 #define FIRST_OP_NOERR(ldb, op) do { \
289         module = ldb->modules;                                  \
290         while (module && module->ops->op == NULL) module = module->next; \
291 } while (0)
292
293 #define FIRST_OP(ldb, op) do { \
294         FIRST_OP_NOERR(ldb, op); \
295         if (module == NULL) {                                   \
296                 ldb_asprintf_errstring(ldb, "unable to find module or backend to handle operation: " #op); \
297                 return LDB_ERR_OPERATIONS_ERROR;                        \
298         } \
299 } while (0)
300
301
302 /*
303   start a transaction
304 */
305 int ldb_transaction_start(struct ldb_context *ldb)
306 {
307         struct ldb_module *module;
308         int status;
309
310         ldb_debug(ldb, LDB_DEBUG_TRACE,
311                   "start ldb transaction (nesting: %d)",
312                   ldb->transaction_active);
313
314         /* explicit transaction active, count nested requests */
315         if (ldb->transaction_active) {
316                 ldb->transaction_active++;
317                 return LDB_SUCCESS;
318         }
319
320         /* start a new transaction */
321         ldb->transaction_active++;
322         ldb->prepare_commit_done = false;
323
324         FIRST_OP(ldb, start_transaction);
325
326         ldb_reset_err_string(ldb);
327
328         status = module->ops->start_transaction(module);
329         if (status != LDB_SUCCESS) {
330                 if (ldb->err_string == NULL) {
331                         /* no error string was setup by the backend */
332                         ldb_asprintf_errstring(ldb,
333                                 "ldb transaction start: %s (%d)",
334                                 ldb_strerror(status),
335                                 status);
336                 }
337         }
338         return status;
339 }
340
341 /*
342   prepare for transaction commit (first phase of two phase commit)
343 */
344 int ldb_transaction_prepare_commit(struct ldb_context *ldb)
345 {
346         struct ldb_module *module;
347         int status;
348
349         if (ldb->prepare_commit_done) {
350                 return LDB_SUCCESS;
351         }
352
353         /* commit only when all nested transactions are complete */
354         if (ldb->transaction_active > 1) {
355                 return LDB_SUCCESS;
356         }
357
358         ldb->prepare_commit_done = true;
359
360         if (ldb->transaction_active < 0) {
361                 ldb_debug(ldb, LDB_DEBUG_FATAL,
362                           "prepare commit called but no ldb transactions are active!");
363                 ldb->transaction_active = 0;
364                 return LDB_ERR_OPERATIONS_ERROR;
365         }
366
367         /* call prepare transaction if available */
368         FIRST_OP_NOERR(ldb, prepare_commit);
369         if (module == NULL) {
370                 return LDB_SUCCESS;
371         }
372
373         status = module->ops->prepare_commit(module);
374         if (status != LDB_SUCCESS) {
375                 /* if a module fails the prepare then we need
376                    to call the end transaction for everyone */
377                 FIRST_OP(ldb, end_transaction);
378                 module->ops->end_transaction(module);
379                 if (ldb->err_string == NULL) {
380                         /* no error string was setup by the backend */
381                         ldb_asprintf_errstring(ldb,
382                                                "ldb transaction prepare commit: %s (%d)",
383                                                ldb_strerror(status),
384                                                status);
385                 }
386         }
387
388         return status;
389 }
390
391
392 /*
393   commit a transaction
394 */
395 int ldb_transaction_commit(struct ldb_context *ldb)
396 {
397         struct ldb_module *module;
398         int status;
399
400         status = ldb_transaction_prepare_commit(ldb);
401         if (status != LDB_SUCCESS) {
402                 return status;
403         }
404
405         ldb->transaction_active--;
406
407         ldb_debug(ldb, LDB_DEBUG_TRACE,
408                   "commit ldb transaction (nesting: %d)",
409                   ldb->transaction_active);
410
411         /* commit only when all nested transactions are complete */
412         if (ldb->transaction_active > 0) {
413                 return LDB_SUCCESS;
414         }
415
416         if (ldb->transaction_active < 0) {
417                 ldb_debug(ldb, LDB_DEBUG_FATAL,
418                           "commit called but no ldb transactions are active!");
419                 ldb->transaction_active = 0;
420                 return LDB_ERR_OPERATIONS_ERROR;
421         }
422
423         ldb_reset_err_string(ldb);
424
425         FIRST_OP(ldb, end_transaction);
426         status = module->ops->end_transaction(module);
427         if (status != LDB_SUCCESS) {
428                 if (ldb->err_string == NULL) {
429                         /* no error string was setup by the backend */
430                         ldb_asprintf_errstring(ldb,
431                                 "ldb transaction commit: %s (%d)",
432                                 ldb_strerror(status),
433                                 status);
434                 }
435                 /* cancel the transaction */
436                 FIRST_OP(ldb, del_transaction);
437                 module->ops->del_transaction(module);
438         }
439         return status;
440 }
441
442
443 /*
444   cancel a transaction
445 */
446 int ldb_transaction_cancel(struct ldb_context *ldb)
447 {
448         struct ldb_module *module;
449         int status;
450
451         ldb->transaction_active--;
452
453         ldb_debug(ldb, LDB_DEBUG_TRACE,
454                   "cancel ldb transaction (nesting: %d)",
455                   ldb->transaction_active);
456
457         /* really cancel only if all nested transactions are complete */
458         if (ldb->transaction_active > 0) {
459                 return LDB_SUCCESS;
460         }
461
462         if (ldb->transaction_active < 0) {
463                 ldb_debug(ldb, LDB_DEBUG_FATAL,
464                           "cancel called but no ldb transactions are active!");
465                 ldb->transaction_active = 0;
466                 return LDB_ERR_OPERATIONS_ERROR;
467         }
468
469         FIRST_OP(ldb, del_transaction);
470
471         status = module->ops->del_transaction(module);
472         if (status != LDB_SUCCESS) {
473                 if (ldb->err_string == NULL) {
474                         /* no error string was setup by the backend */
475                         ldb_asprintf_errstring(ldb,
476                                 "ldb transaction cancel: %s (%d)",
477                                 ldb_strerror(status),
478                                 status);
479                 }
480         }
481         return status;
482 }
483
484 /*
485   cancel a transaction with no error if no transaction is pending
486   used when we fork() to clear any parent transactions
487 */
488 int ldb_transaction_cancel_noerr(struct ldb_context *ldb)
489 {
490         if (ldb->transaction_active > 0) {
491                 return ldb_transaction_cancel(ldb);
492         }
493         return LDB_SUCCESS;
494 }
495
496
497 /* autostarts a transacion if none active */
498 static int ldb_autotransaction_request(struct ldb_context *ldb,
499                                        struct ldb_request *req)
500 {
501         int ret;
502
503         ret = ldb_transaction_start(ldb);
504         if (ret != LDB_SUCCESS) {
505                 return ret;
506         }
507
508         ret = ldb_request(ldb, req);
509         if (ret == LDB_SUCCESS) {
510                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
511         }
512
513         if (ret == LDB_SUCCESS) {
514                 return ldb_transaction_commit(ldb);
515         }
516         ldb_transaction_cancel(ldb);
517
518         if (ldb->err_string == NULL) {
519                 /* no error string was setup by the backend */
520                 ldb_asprintf_errstring(ldb, "%s (%d)", ldb_strerror(ret), ret);
521         }
522
523         return ret;
524 }
525
526 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
527 {
528         struct tevent_context *ev;
529         int ret;
530
531         if (!handle) {
532                 return LDB_ERR_UNAVAILABLE;
533         }
534
535         if (handle->state == LDB_ASYNC_DONE) {
536                 return handle->status;
537         }
538
539         ev = ldb_get_event_context(handle->ldb);
540         if (NULL == ev) {
541                 return LDB_ERR_OPERATIONS_ERROR;
542         }
543
544         switch (type) {
545         case LDB_WAIT_NONE:
546                 ret = tevent_loop_once(ev);
547                 if (ret != 0) {
548                         return LDB_ERR_OPERATIONS_ERROR;
549                 }
550                 if (handle->state == LDB_ASYNC_DONE ||
551                     handle->status != LDB_SUCCESS) {
552                         return handle->status;
553                 }
554                 break;
555
556         case LDB_WAIT_ALL:
557                 while (handle->state != LDB_ASYNC_DONE) {
558                         ret = tevent_loop_once(ev);
559                         if (ret != 0) {
560                                 return LDB_ERR_OPERATIONS_ERROR;
561                         }
562                         if (handle->status != LDB_SUCCESS) {
563                                 return handle->status;
564                         }
565                 }
566                 return handle->status;
567         }
568
569         return LDB_SUCCESS;
570 }
571
572 /* set the specified timeout or, if timeout is 0 set the default timeout */
573 int ldb_set_timeout(struct ldb_context *ldb,
574                     struct ldb_request *req,
575                     int timeout)
576 {
577         if (req == NULL) return LDB_ERR_OPERATIONS_ERROR;
578
579         if (timeout != 0) {
580                 req->timeout = timeout;
581         } else {
582                 req->timeout = ldb->default_timeout;
583         }
584         req->starttime = time(NULL);
585
586         return LDB_SUCCESS;
587 }
588
589 /* calculates the new timeout based on the previous starttime and timeout */
590 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb,
591                                   struct ldb_request *oldreq,
592                                   struct ldb_request *newreq)
593 {
594         if (newreq == NULL) return LDB_ERR_OPERATIONS_ERROR;
595
596         if (oldreq == NULL) {
597                 return ldb_set_timeout(ldb, newreq, 0);
598         }
599
600         newreq->starttime = oldreq->starttime;
601         newreq->timeout = oldreq->timeout;
602
603         return LDB_SUCCESS;
604 }
605
606
607 /*
608    set the permissions for new files to be passed to open() in
609    backends that use local files
610  */
611 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms)
612 {
613         ldb->create_perms = perms;
614 }
615
616 unsigned int ldb_get_create_perms(struct ldb_context *ldb)
617 {
618         return ldb->create_perms;
619 }
620
621 void ldb_set_event_context(struct ldb_context *ldb, struct tevent_context *ev)
622 {
623         ldb->ev_ctx = ev;
624 }
625
626 struct tevent_context * ldb_get_event_context(struct ldb_context *ldb)
627 {
628         return ldb->ev_ctx;
629 }
630
631 void ldb_request_set_state(struct ldb_request *req, int state)
632 {
633         req->handle->state = state;
634 }
635
636 int ldb_request_get_status(struct ldb_request *req)
637 {
638         return req->handle->status;
639 }
640
641
642 /*
643   trace a ldb request
644 */
645 static void ldb_trace_request(struct ldb_context *ldb, struct ldb_request *req)
646 {
647         TALLOC_CTX *tmp_ctx = talloc_new(req);
648         int i;
649
650         switch (req->operation) {
651         case LDB_SEARCH:
652                 ldb_debug_add(ldb, "ldb_trace_request: SEARCH\n");
653                 ldb_debug_add(ldb, " dn: %s\n",
654                               ldb_dn_is_null(req->op.search.base)?"<rootDSE>":
655                               ldb_dn_get_linearized(req->op.search.base));
656                 ldb_debug_add(ldb, " scope: %s\n", 
657                           req->op.search.scope==LDB_SCOPE_BASE?"base":
658                           req->op.search.scope==LDB_SCOPE_ONELEVEL?"one":
659                           req->op.search.scope==LDB_SCOPE_SUBTREE?"sub":"UNKNOWN");
660                 ldb_debug_add(ldb, " expr: %s\n", 
661                           ldb_filter_from_tree(tmp_ctx, req->op.search.tree));
662                 if (req->op.search.attrs == NULL) {
663                         ldb_debug_add(ldb, " attr: <ALL>\n");
664                 } else {
665                         for (i=0; req->op.search.attrs[i]; i++) {
666                                 ldb_debug_add(ldb, " attr: %s\n", req->op.search.attrs[i]);
667                         }
668                 }
669                 break;
670         case LDB_DELETE:
671                 ldb_debug_add(ldb, "ldb_trace_request: DELETE\n");
672                 ldb_debug_add(ldb, " dn: %s\n", 
673                               ldb_dn_get_linearized(req->op.del.dn));
674                 break;
675         case LDB_RENAME:
676                 ldb_debug_add(ldb, "ldb_trace_request: RENAME\n");
677                 ldb_debug_add(ldb, " olddn: %s\n", 
678                               ldb_dn_get_linearized(req->op.rename.olddn));
679                 ldb_debug_add(ldb, " newdn: %s\n", 
680                               ldb_dn_get_linearized(req->op.rename.newdn));
681                 break;
682         case LDB_EXTENDED:
683                 ldb_debug_add(ldb, "ldb_trace_request: EXTENDED\n");
684                 ldb_debug_add(ldb, " oid: %s\n", req->op.extended.oid);
685                 ldb_debug_add(ldb, " data: %s\n", req->op.extended.data?"yes":"no");
686                 break;
687         case LDB_ADD:
688                 ldb_debug_add(ldb, "ldb_trace_request: ADD\n");
689                 ldb_debug_add(req->handle->ldb, "%s\n", 
690                               ldb_ldif_message_string(req->handle->ldb, tmp_ctx, 
691                                                       LDB_CHANGETYPE_ADD, 
692                                                       req->op.add.message));
693                 break;
694         case LDB_MODIFY:
695                 ldb_debug_add(ldb, "ldb_trace_request: MODIFY\n");
696                 ldb_debug_add(req->handle->ldb, "%s\n", 
697                               ldb_ldif_message_string(req->handle->ldb, tmp_ctx, 
698                                                       LDB_CHANGETYPE_ADD, 
699                                                       req->op.mod.message));
700                 break;
701         case LDB_REQ_REGISTER_CONTROL:
702                 ldb_debug_add(ldb, "ldb_trace_request: REGISTER_CONTROL\n");
703                 ldb_debug_add(req->handle->ldb, "%s\n", 
704                               req->op.reg_control.oid);
705                 break;
706         case LDB_REQ_REGISTER_PARTITION:
707                 ldb_debug_add(ldb, "ldb_trace_request: REGISTER_PARTITION\n");
708                 ldb_debug_add(req->handle->ldb, "%s\n", 
709                               ldb_dn_get_linearized(req->op.reg_partition.dn));
710                 break;
711         default:
712                 ldb_debug_add(ldb, "ldb_trace_request: UNKNOWN(%u)\n", 
713                               req->operation);
714                 break;
715         }
716
717         if (req->controls == NULL) {
718                 ldb_debug_add(ldb, " control: <NONE>\n");
719         } else {
720                 for (i=0; req->controls && req->controls[i]; i++) {
721                         ldb_debug_add(ldb, " control: %s  crit:%u  data:%s\n", 
722                                       req->controls[i]->oid, 
723                                       req->controls[i]->critical, 
724                                       req->controls[i]->data?"yes":"no");
725                 }
726         }
727         
728         ldb_debug_end(ldb, LDB_DEBUG_TRACE);
729
730         talloc_free(tmp_ctx);
731 }
732
733
734 /*
735   start an ldb request
736   NOTE: the request must be a talloc context.
737   returns LDB_ERR_* on errors.
738 */
739 int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
740 {
741         struct ldb_module *module;
742         int ret;
743
744         if (req->callback == NULL) {
745                 ldb_set_errstring(ldb, "Requests MUST define callbacks");
746                 return LDB_ERR_UNWILLING_TO_PERFORM;
747         }
748
749         ldb_reset_err_string(ldb);
750
751         if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
752                 ldb_trace_request(ldb, req);
753         }
754
755         /* call the first module in the chain */
756         switch (req->operation) {
757         case LDB_SEARCH:
758                 FIRST_OP(ldb, search);
759                 ret = module->ops->search(module, req);
760                 break;
761         case LDB_ADD:
762                 FIRST_OP(ldb, add);
763                 ret = module->ops->add(module, req);
764                 break;
765         case LDB_MODIFY:
766                 FIRST_OP(ldb, modify);
767                 ret = module->ops->modify(module, req);
768                 break;
769         case LDB_DELETE:
770                 FIRST_OP(ldb, del);
771                 ret = module->ops->del(module, req);
772                 break;
773         case LDB_RENAME:
774                 FIRST_OP(ldb, rename);
775                 ret = module->ops->rename(module, req);
776                 break;
777         case LDB_EXTENDED:
778                 FIRST_OP(ldb, extended);
779                 ret = module->ops->extended(module, req);
780                 break;
781         default:
782                 FIRST_OP(ldb, request);
783                 ret = module->ops->request(module, req);
784                 break;
785         }
786
787         return ret;
788 }
789
790 int ldb_request_done(struct ldb_request *req, int status)
791 {
792         req->handle->state = LDB_ASYNC_DONE;
793         req->handle->status = status;
794         return status;
795 }
796
797 /*
798   search the database given a LDAP-like search expression
799
800   returns an LDB error code
801
802   Use talloc_free to free the ldb_message returned in 'res', if successful
803
804 */
805 int ldb_search_default_callback(struct ldb_request *req,
806                                 struct ldb_reply *ares)
807 {
808         struct ldb_result *res;
809         int n;
810
811         res = talloc_get_type(req->context, struct ldb_result);
812
813         if (!ares) {
814                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
815         }
816         if (ares->error != LDB_SUCCESS) {
817                 return ldb_request_done(req, ares->error);
818         }
819
820         switch (ares->type) {
821         case LDB_REPLY_ENTRY:
822                 res->msgs = talloc_realloc(res, res->msgs,
823                                         struct ldb_message *, res->count + 2);
824                 if (! res->msgs) {
825                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
826                 }
827
828                 res->msgs[res->count + 1] = NULL;
829
830                 res->msgs[res->count] = talloc_move(res->msgs, &ares->message);
831                 res->count++;
832                 break;
833
834         case LDB_REPLY_REFERRAL:
835                 if (res->refs) {
836                         for (n = 0; res->refs[n]; n++) /*noop*/ ;
837                 } else {
838                         n = 0;
839                 }
840
841                 res->refs = talloc_realloc(res, res->refs, char *, n + 2);
842                 if (! res->refs) {
843                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
844                 }
845
846                 res->refs[n] = talloc_move(res->refs, &ares->referral);
847                 res->refs[n + 1] = NULL;
848                 break;
849
850         case LDB_REPLY_DONE:
851                 /* TODO: we should really support controls on entries
852                  * and referrals too! */
853                 res->controls = talloc_move(res, &ares->controls);
854
855                 /* this is the last message, and means the request is done */
856                 /* we have to signal and eventual ldb_wait() waiting that the
857                  * async request operation was completed */
858                 talloc_free(ares);
859                 return ldb_request_done(req, LDB_SUCCESS);
860         }
861
862         talloc_free(ares);
863
864         return LDB_SUCCESS;
865 }
866
867 int ldb_op_default_callback(struct ldb_request *req, struct ldb_reply *ares)
868 {
869         int ret;
870
871         if (!ares) {
872                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
873         }
874
875         if (ares->error != LDB_SUCCESS) {
876                 ret = ares->error;
877                 talloc_free(ares);
878                 return ldb_request_done(req, ret);
879         }
880
881         if (ares->type != LDB_REPLY_DONE) {
882                 talloc_free(ares);
883                 ldb_set_errstring(req->handle->ldb, "Invalid reply type!");
884                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
885         }
886
887         talloc_free(ares);
888         return ldb_request_done(req, LDB_SUCCESS);
889 }
890
891 int ldb_build_search_req_ex(struct ldb_request **ret_req,
892                         struct ldb_context *ldb,
893                         void *mem_ctx,
894                         struct ldb_dn *base,
895                         enum ldb_scope scope,
896                         struct ldb_parse_tree *tree,
897                         const char * const *attrs,
898                         struct ldb_control **controls,
899                         void *context,
900                         ldb_request_callback_t callback,
901                         struct ldb_request *parent)
902 {
903         struct ldb_request *req;
904
905         *ret_req = NULL;
906
907         req = talloc(mem_ctx, struct ldb_request);
908         if (req == NULL) {
909                 ldb_oom(ldb);
910                 return LDB_ERR_OPERATIONS_ERROR;
911         }
912
913         req->operation = LDB_SEARCH;
914         if (base == NULL) {
915                 req->op.search.base = ldb_dn_new(req, ldb, NULL);
916         } else {
917                 req->op.search.base = base;
918         }
919         req->op.search.scope = scope;
920
921         req->op.search.tree = tree;
922         if (req->op.search.tree == NULL) {
923                 ldb_set_errstring(ldb, "'tree' can't be NULL");
924                 talloc_free(req);
925                 return LDB_ERR_OPERATIONS_ERROR;
926         }
927
928         req->op.search.attrs = attrs;
929         req->controls = controls;
930         req->context = context;
931         req->callback = callback;
932
933         ldb_set_timeout_from_prev_req(ldb, parent, req);
934
935         req->handle = ldb_handle_new(req, ldb);
936         if (req->handle == NULL) {
937                 ldb_oom(ldb);
938                 return LDB_ERR_OPERATIONS_ERROR;
939         }
940
941         if (parent) {
942                 req->handle->nesting++;
943         }
944
945         *ret_req = req;
946         return LDB_SUCCESS;
947 }
948
949 int ldb_build_search_req(struct ldb_request **ret_req,
950                         struct ldb_context *ldb,
951                         void *mem_ctx,
952                         struct ldb_dn *base,
953                         enum ldb_scope scope,
954                         const char *expression,
955                         const char * const *attrs,
956                         struct ldb_control **controls,
957                         void *context,
958                         ldb_request_callback_t callback,
959                         struct ldb_request *parent)
960 {
961         struct ldb_parse_tree *tree;
962         int ret;
963
964         tree = ldb_parse_tree(mem_ctx, expression);
965         if (tree == NULL) {
966                 ldb_set_errstring(ldb, "Unable to parse search expression");
967                 return LDB_ERR_OPERATIONS_ERROR;
968         }
969
970         ret = ldb_build_search_req_ex(ret_req, ldb, mem_ctx, base,
971                                       scope, tree, attrs, controls,
972                                       context, callback, parent);
973         if (ret == LDB_SUCCESS) {
974                 talloc_steal(*ret_req, tree);
975         }
976         return ret;
977 }
978
979 int ldb_build_add_req(struct ldb_request **ret_req,
980                         struct ldb_context *ldb,
981                         void *mem_ctx,
982                         const struct ldb_message *message,
983                         struct ldb_control **controls,
984                         void *context,
985                         ldb_request_callback_t callback,
986                         struct ldb_request *parent)
987 {
988         struct ldb_request *req;
989
990         *ret_req = NULL;
991
992         req = talloc(mem_ctx, struct ldb_request);
993         if (req == NULL) {
994                 ldb_set_errstring(ldb, "Out of Memory");
995                 return LDB_ERR_OPERATIONS_ERROR;
996         }
997
998         req->operation = LDB_ADD;
999         req->op.add.message = message;
1000         req->controls = controls;
1001         req->context = context;
1002         req->callback = callback;
1003
1004         ldb_set_timeout_from_prev_req(ldb, parent, req);
1005
1006         req->handle = ldb_handle_new(req, ldb);
1007         if (req->handle == NULL) {
1008                 ldb_oom(ldb);
1009                 return LDB_ERR_OPERATIONS_ERROR;
1010         }
1011
1012         if (parent) {
1013                 req->handle->nesting++;
1014         }
1015
1016         *ret_req = req;
1017
1018         return LDB_SUCCESS;
1019 }
1020
1021 int ldb_build_mod_req(struct ldb_request **ret_req,
1022                         struct ldb_context *ldb,
1023                         void *mem_ctx,
1024                         const struct ldb_message *message,
1025                         struct ldb_control **controls,
1026                         void *context,
1027                         ldb_request_callback_t callback,
1028                         struct ldb_request *parent)
1029 {
1030         struct ldb_request *req;
1031
1032         *ret_req = NULL;
1033
1034         req = talloc(mem_ctx, struct ldb_request);
1035         if (req == NULL) {
1036                 ldb_set_errstring(ldb, "Out of Memory");
1037                 return LDB_ERR_OPERATIONS_ERROR;
1038         }
1039
1040         req->operation = LDB_MODIFY;
1041         req->op.mod.message = message;
1042         req->controls = controls;
1043         req->context = context;
1044         req->callback = callback;
1045
1046         ldb_set_timeout_from_prev_req(ldb, parent, req);
1047
1048         req->handle = ldb_handle_new(req, ldb);
1049         if (req->handle == NULL) {
1050                 ldb_oom(ldb);
1051                 return LDB_ERR_OPERATIONS_ERROR;
1052         }
1053
1054         if (parent) {
1055                 req->handle->nesting++;
1056         }
1057
1058         *ret_req = req;
1059
1060         return LDB_SUCCESS;
1061 }
1062
1063 int ldb_build_del_req(struct ldb_request **ret_req,
1064                         struct ldb_context *ldb,
1065                         void *mem_ctx,
1066                         struct ldb_dn *dn,
1067                         struct ldb_control **controls,
1068                         void *context,
1069                         ldb_request_callback_t callback,
1070                         struct ldb_request *parent)
1071 {
1072         struct ldb_request *req;
1073
1074         *ret_req = NULL;
1075
1076         req = talloc(mem_ctx, struct ldb_request);
1077         if (req == NULL) {
1078                 ldb_set_errstring(ldb, "Out of Memory");
1079                 return LDB_ERR_OPERATIONS_ERROR;
1080         }
1081
1082         req->operation = LDB_DELETE;
1083         req->op.del.dn = dn;
1084         req->controls = controls;
1085         req->context = context;
1086         req->callback = callback;
1087
1088         ldb_set_timeout_from_prev_req(ldb, parent, req);
1089
1090         req->handle = ldb_handle_new(req, ldb);
1091         if (req->handle == NULL) {
1092                 ldb_oom(ldb);
1093                 return LDB_ERR_OPERATIONS_ERROR;
1094         }
1095
1096         if (parent) {
1097                 req->handle->nesting++;
1098         }
1099
1100         *ret_req = req;
1101
1102         return LDB_SUCCESS;
1103 }
1104
1105 int ldb_build_rename_req(struct ldb_request **ret_req,
1106                         struct ldb_context *ldb,
1107                         void *mem_ctx,
1108                         struct ldb_dn *olddn,
1109                         struct ldb_dn *newdn,
1110                         struct ldb_control **controls,
1111                         void *context,
1112                         ldb_request_callback_t callback,
1113                         struct ldb_request *parent)
1114 {
1115         struct ldb_request *req;
1116
1117         *ret_req = NULL;
1118
1119         req = talloc(mem_ctx, struct ldb_request);
1120         if (req == NULL) {
1121                 ldb_set_errstring(ldb, "Out of Memory");
1122                 return LDB_ERR_OPERATIONS_ERROR;
1123         }
1124
1125         req->operation = LDB_RENAME;
1126         req->op.rename.olddn = olddn;
1127         req->op.rename.newdn = newdn;
1128         req->controls = controls;
1129         req->context = context;
1130         req->callback = callback;
1131
1132         ldb_set_timeout_from_prev_req(ldb, parent, req);
1133
1134         req->handle = ldb_handle_new(req, ldb);
1135         if (req->handle == NULL) {
1136                 ldb_oom(ldb);
1137                 return LDB_ERR_OPERATIONS_ERROR;
1138         }
1139
1140         if (parent) {
1141                 req->handle->nesting++;
1142         }
1143
1144         *ret_req = req;
1145
1146         return LDB_SUCCESS;
1147 }
1148
1149 int ldb_extended_default_callback(struct ldb_request *req,
1150                                   struct ldb_reply *ares)
1151 {
1152         struct ldb_result *res;
1153
1154         res = talloc_get_type(req->context, struct ldb_result);
1155
1156         if (!ares) {
1157                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1158         }
1159         if (ares->error != LDB_SUCCESS) {
1160                 return ldb_request_done(req, ares->error);
1161         }
1162
1163         if (ares->type == LDB_REPLY_DONE) {
1164
1165                 /* TODO: we should really support controls on entries and referrals too! */
1166                 res->extended = talloc_move(res, &ares->response);
1167                 res->controls = talloc_move(res, &ares->controls);
1168
1169                 talloc_free(ares);
1170                 return ldb_request_done(req, LDB_SUCCESS);
1171         }
1172
1173         talloc_free(ares);
1174         ldb_set_errstring(req->handle->ldb, "Invalid reply type!");
1175         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
1176 }
1177
1178 int ldb_build_extended_req(struct ldb_request **ret_req,
1179                            struct ldb_context *ldb,
1180                            void *mem_ctx,
1181                            const char *oid,
1182                            void *data,
1183                            struct ldb_control **controls,
1184                            void *context,
1185                            ldb_request_callback_t callback,
1186                            struct ldb_request *parent)
1187 {
1188         struct ldb_request *req;
1189
1190         *ret_req = NULL;
1191
1192         req = talloc(mem_ctx, struct ldb_request);
1193         if (req == NULL) {
1194                 ldb_set_errstring(ldb, "Out of Memory");
1195                 return LDB_ERR_OPERATIONS_ERROR;
1196         }
1197
1198         req->operation = LDB_EXTENDED;
1199         req->op.extended.oid = oid;
1200         req->op.extended.data = data;
1201         req->controls = controls;
1202         req->context = context;
1203         req->callback = callback;
1204
1205         ldb_set_timeout_from_prev_req(ldb, parent, req);
1206
1207         req->handle = ldb_handle_new(req, ldb);
1208         if (req->handle == NULL) {
1209                 ldb_oom(ldb);
1210                 return LDB_ERR_OPERATIONS_ERROR;
1211         }
1212
1213         if (parent) {
1214                 req->handle->nesting++;
1215         }
1216
1217         *ret_req = req;
1218
1219         return LDB_SUCCESS;
1220 }
1221
1222 int ldb_extended(struct ldb_context *ldb,
1223                  const char *oid,
1224                  void *data,
1225                  struct ldb_result **_res)
1226 {
1227         struct ldb_request *req;
1228         int ret;
1229         struct ldb_result *res;
1230
1231         *_res = NULL;
1232
1233         res = talloc_zero(ldb, struct ldb_result);
1234         if (!res) {
1235                 return LDB_ERR_OPERATIONS_ERROR;
1236         }
1237
1238         ret = ldb_build_extended_req(&req, ldb, ldb,
1239                                      oid, data, NULL,
1240                                      res, ldb_extended_default_callback,
1241                                      NULL);
1242         if (ret != LDB_SUCCESS) goto done;
1243
1244         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1245
1246         ret = ldb_request(ldb, req);
1247
1248         if (ret == LDB_SUCCESS) {
1249                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1250         }
1251
1252         talloc_free(req);
1253
1254 done:
1255         if (ret != LDB_SUCCESS) {
1256                 talloc_free(res);
1257         }
1258
1259         *_res = res;
1260         return ret;
1261 }
1262
1263 /*
1264   note that ldb_search() will automatically replace a NULL 'base' value
1265   with the defaultNamingContext from the rootDSE if available.
1266 */
1267 int ldb_search(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
1268                 struct ldb_result **result, struct ldb_dn *base,
1269                 enum ldb_scope scope, const char * const *attrs,
1270                 const char *exp_fmt, ...)
1271 {
1272         struct ldb_request *req;
1273         struct ldb_result *res;
1274         char *expression;
1275         va_list ap;
1276         int ret;
1277
1278         expression = NULL;
1279         *result = NULL;
1280         req = NULL;
1281
1282         res = talloc_zero(mem_ctx, struct ldb_result);
1283         if (!res) {
1284                 return LDB_ERR_OPERATIONS_ERROR;
1285         }
1286
1287         if (exp_fmt) {
1288                 va_start(ap, exp_fmt);
1289                 expression = talloc_vasprintf(mem_ctx, exp_fmt, ap);
1290                 va_end(ap);
1291
1292                 if (!expression) {
1293                         talloc_free(res);
1294                         return LDB_ERR_OPERATIONS_ERROR;
1295                 }
1296         }
1297
1298         ret = ldb_build_search_req(&req, ldb, mem_ctx,
1299                                         base?base:ldb_get_default_basedn(ldb),
1300                                         scope,
1301                                         expression,
1302                                         attrs,
1303                                         NULL,
1304                                         res,
1305                                         ldb_search_default_callback,
1306                                         NULL);
1307
1308         if (ret != LDB_SUCCESS) goto done;
1309
1310         ret = ldb_request(ldb, req);
1311
1312         if (ret == LDB_SUCCESS) {
1313                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1314         }
1315
1316 done:
1317         if (ret != LDB_SUCCESS) {
1318                 talloc_free(res);
1319                 res = NULL;
1320         }
1321
1322         talloc_free(expression);
1323         talloc_free(req);
1324
1325         *result = res;
1326         return ret;
1327 }
1328
1329 /*
1330   add a record to the database. Will fail if a record with the given class
1331   and key already exists
1332 */
1333 int ldb_add(struct ldb_context *ldb,
1334             const struct ldb_message *message)
1335 {
1336         struct ldb_request *req;
1337         int ret;
1338
1339         ret = ldb_msg_sanity_check(ldb, message);
1340         if (ret != LDB_SUCCESS) {
1341                 return ret;
1342         }
1343
1344         ret = ldb_build_add_req(&req, ldb, ldb,
1345                                         message,
1346                                         NULL,
1347                                         NULL,
1348                                         ldb_op_default_callback,
1349                                         NULL);
1350
1351         if (ret != LDB_SUCCESS) return ret;
1352
1353         /* do request and autostart a transaction */
1354         ret = ldb_autotransaction_request(ldb, req);
1355
1356         talloc_free(req);
1357         return ret;
1358 }
1359
1360 /*
1361   modify the specified attributes of a record
1362 */
1363 int ldb_modify(struct ldb_context *ldb,
1364                const struct ldb_message *message)
1365 {
1366         struct ldb_request *req;
1367         int ret;
1368
1369         ret = ldb_msg_sanity_check(ldb, message);
1370         if (ret != LDB_SUCCESS) {
1371                 return ret;
1372         }
1373
1374         ret = ldb_build_mod_req(&req, ldb, ldb,
1375                                         message,
1376                                         NULL,
1377                                         NULL,
1378                                         ldb_op_default_callback,
1379                                         NULL);
1380
1381         if (ret != LDB_SUCCESS) return ret;
1382
1383         /* do request and autostart a transaction */
1384         ret = ldb_autotransaction_request(ldb, req);
1385
1386         talloc_free(req);
1387         return ret;
1388 }
1389
1390
1391 /*
1392   delete a record from the database
1393 */
1394 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn)
1395 {
1396         struct ldb_request *req;
1397         int ret;
1398
1399         ret = ldb_build_del_req(&req, ldb, ldb,
1400                                         dn,
1401                                         NULL,
1402                                         NULL,
1403                                         ldb_op_default_callback,
1404                                         NULL);
1405
1406         if (ret != LDB_SUCCESS) return ret;
1407
1408         /* do request and autostart a transaction */
1409         ret = ldb_autotransaction_request(ldb, req);
1410
1411         talloc_free(req);
1412         return ret;
1413 }
1414
1415 /*
1416   rename a record in the database
1417 */
1418 int ldb_rename(struct ldb_context *ldb,
1419                 struct ldb_dn *olddn, struct ldb_dn *newdn)
1420 {
1421         struct ldb_request *req;
1422         int ret;
1423
1424         ret = ldb_build_rename_req(&req, ldb, ldb,
1425                                         olddn,
1426                                         newdn,
1427                                         NULL,
1428                                         NULL,
1429                                         ldb_op_default_callback,
1430                                         NULL);
1431
1432         if (ret != LDB_SUCCESS) return ret;
1433
1434         /* do request and autostart a transaction */
1435         ret = ldb_autotransaction_request(ldb, req);
1436
1437         talloc_free(req);
1438         return ret;
1439 }
1440
1441
1442 /*
1443   return the global sequence number
1444 */
1445 int ldb_sequence_number(struct ldb_context *ldb,
1446                         enum ldb_sequence_type type, uint64_t *seq_num)
1447 {
1448         struct ldb_seqnum_request *seq;
1449         struct ldb_seqnum_result *seqr;
1450         struct ldb_result *res;
1451         TALLOC_CTX *tmp_ctx;
1452         int ret;
1453
1454         *seq_num = 0;
1455
1456         tmp_ctx = talloc_zero(ldb, struct ldb_request);
1457         if (tmp_ctx == NULL) {
1458                 ldb_set_errstring(ldb, "Out of Memory");
1459                 return LDB_ERR_OPERATIONS_ERROR;
1460         }
1461         seq = talloc_zero(tmp_ctx, struct ldb_seqnum_request);
1462         if (seq == NULL) {
1463                 ldb_set_errstring(ldb, "Out of Memory");
1464                 ret = LDB_ERR_OPERATIONS_ERROR;
1465                 goto done;
1466         }
1467         seq->type = type;
1468
1469         ret = ldb_extended(ldb, LDB_EXTENDED_SEQUENCE_NUMBER, seq, &res);
1470         if (ret != LDB_SUCCESS) {
1471                 goto done;
1472         }
1473         talloc_steal(tmp_ctx, res);
1474
1475         if (strcmp(LDB_EXTENDED_SEQUENCE_NUMBER, res->extended->oid) != 0) {
1476                 ldb_set_errstring(ldb, "Invalid OID in reply");
1477                 ret = LDB_ERR_OPERATIONS_ERROR;
1478                 goto done;
1479         }
1480         seqr = talloc_get_type(res->extended->data,
1481                                 struct ldb_seqnum_result);
1482         *seq_num = seqr->seq_num;
1483
1484 done:
1485         talloc_free(tmp_ctx);
1486         return ret;
1487 }
1488
1489 /*
1490   return extended error information
1491 */
1492 const char *ldb_errstring(struct ldb_context *ldb)
1493 {
1494         if (ldb->err_string) {
1495                 return ldb->err_string;
1496         }
1497
1498         return NULL;
1499 }
1500
1501 /*
1502   return a string explaining what a ldb error constant meancs
1503 */
1504 const char *ldb_strerror(int ldb_err)
1505 {
1506         switch (ldb_err) {
1507         case LDB_SUCCESS:
1508                 return "Success";
1509         case LDB_ERR_OPERATIONS_ERROR:
1510                 return "Operations error";
1511         case LDB_ERR_PROTOCOL_ERROR:
1512                 return "Protocol error";
1513         case LDB_ERR_TIME_LIMIT_EXCEEDED:
1514                 return "Time limit exceeded";
1515         case LDB_ERR_SIZE_LIMIT_EXCEEDED:
1516                 return "Size limit exceeded";
1517         case LDB_ERR_COMPARE_FALSE:
1518                 return "Compare false";
1519         case LDB_ERR_COMPARE_TRUE:
1520                 return "Compare true";
1521         case LDB_ERR_AUTH_METHOD_NOT_SUPPORTED:
1522                 return "Auth method not supported";
1523         case LDB_ERR_STRONG_AUTH_REQUIRED:
1524                 return "Strong auth required";
1525 /* 9 RESERVED */
1526         case LDB_ERR_REFERRAL:
1527                 return "Referral error";
1528         case LDB_ERR_ADMIN_LIMIT_EXCEEDED:
1529                 return "Admin limit exceeded";
1530         case LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION:
1531                 return "Unsupported critical extension";
1532         case LDB_ERR_CONFIDENTIALITY_REQUIRED:
1533                 return "Confidentiality required";
1534         case LDB_ERR_SASL_BIND_IN_PROGRESS:
1535                 return "SASL bind in progress";
1536         case LDB_ERR_NO_SUCH_ATTRIBUTE:
1537                 return "No such attribute";
1538         case LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE:
1539                 return "Undefined attribute type";
1540         case LDB_ERR_INAPPROPRIATE_MATCHING:
1541                 return "Inappropriate matching";
1542         case LDB_ERR_CONSTRAINT_VIOLATION:
1543                 return "Constraint violation";
1544         case LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS:
1545                 return "Attribute or value exists";
1546         case LDB_ERR_INVALID_ATTRIBUTE_SYNTAX:
1547                 return "Invalid attribute syntax";
1548 /* 22-31 unused */
1549         case LDB_ERR_NO_SUCH_OBJECT:
1550                 return "No such object";
1551         case LDB_ERR_ALIAS_PROBLEM:
1552                 return "Alias problem";
1553         case LDB_ERR_INVALID_DN_SYNTAX:
1554                 return "Invalid DN syntax";
1555 /* 35 RESERVED */
1556         case LDB_ERR_ALIAS_DEREFERENCING_PROBLEM:
1557                 return "Alias dereferencing problem";
1558 /* 37-47 unused */
1559         case LDB_ERR_INAPPROPRIATE_AUTHENTICATION:
1560                 return "Inappropriate authentication";
1561         case LDB_ERR_INVALID_CREDENTIALS:
1562                 return "Invalid credentials";
1563         case LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS:
1564                 return "insufficient access rights";
1565         case LDB_ERR_BUSY:
1566                 return "Busy";
1567         case LDB_ERR_UNAVAILABLE:
1568                 return "Unavailable";
1569         case LDB_ERR_UNWILLING_TO_PERFORM:
1570                 return "Unwilling to perform";
1571         case LDB_ERR_LOOP_DETECT:
1572                 return "Loop detect";
1573 /* 55-63 unused */
1574         case LDB_ERR_NAMING_VIOLATION:
1575                 return "Naming violation";
1576         case LDB_ERR_OBJECT_CLASS_VIOLATION:
1577                 return "Object class violation";
1578         case LDB_ERR_NOT_ALLOWED_ON_NON_LEAF:
1579                 return "Not allowed on non-leaf";
1580         case LDB_ERR_NOT_ALLOWED_ON_RDN:
1581                 return "Not allowed on RDN";
1582         case LDB_ERR_ENTRY_ALREADY_EXISTS:
1583                 return "Entry already exists";
1584         case LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED:
1585                 return "Object class mods prohibited";
1586 /* 70 RESERVED FOR CLDAP */
1587         case LDB_ERR_AFFECTS_MULTIPLE_DSAS:
1588                 return "Affects multiple DSAs";
1589 /* 72-79 unused */
1590         case LDB_ERR_OTHER:
1591                 return "Other";
1592         }
1593
1594         return "Unknown error";
1595 }
1596
1597 /*
1598   set backend specific opaque parameters
1599 */
1600 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value)
1601 {
1602         struct ldb_opaque *o;
1603
1604         /* allow updating an existing value */
1605         for (o=ldb->opaque;o;o=o->next) {
1606                 if (strcmp(o->name, name) == 0) {
1607                         o->value = value;
1608                         return LDB_SUCCESS;
1609                 }
1610         }
1611
1612         o = talloc(ldb, struct ldb_opaque);
1613         if (o == NULL) {
1614                 ldb_oom(ldb);
1615                 return LDB_ERR_OTHER;
1616         }
1617         o->next = ldb->opaque;
1618         o->name = name;
1619         o->value = value;
1620         ldb->opaque = o;
1621         return LDB_SUCCESS;
1622 }
1623
1624 /*
1625   get a previously set opaque value
1626 */
1627 void *ldb_get_opaque(struct ldb_context *ldb, const char *name)
1628 {
1629         struct ldb_opaque *o;
1630         for (o=ldb->opaque;o;o=o->next) {
1631                 if (strcmp(o->name, name) == 0) {
1632                         return o->value;
1633                 }
1634         }
1635         return NULL;
1636 }
1637
1638 int ldb_global_init(void)
1639 {
1640         /* Provided for compatibility with some older versions of ldb */
1641         return 0;
1642 }
1643
1644 /* return the ldb flags */
1645 unsigned int ldb_get_flags(struct ldb_context *ldb)
1646 {
1647         return ldb->flags;
1648 }
1649
1650 /* set the ldb flags */
1651 void ldb_set_flags(struct ldb_context *ldb, unsigned flags)
1652 {
1653         ldb->flags = flags;
1654 }