5f2e5e3ffc7a0cb9439b995271a4fa35495ba7b4
[kai/samba.git] / source / lib / ldb / common / ldb.c
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  2004
5    Copyright (C) Simo Sorce  2005-2006
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 #include "ldb_includes.h"
36
37 /* 
38    initialise a ldb context
39    The mem_ctx is optional
40 */
41 struct ldb_context *ldb_init(void *mem_ctx)
42 {
43         struct ldb_context *ldb = talloc_zero(mem_ctx, struct ldb_context);
44         int ret;
45
46         ret = ldb_setup_wellknown_attributes(ldb);
47         if (ret != 0) {
48                 talloc_free(ldb);
49                 return NULL;
50         }
51
52         ldb_set_utf8_default(ldb);
53         ldb_set_create_perms(ldb, 0666);
54         ldb_set_modules_dir(ldb, LDB_MODULESDIR);
55
56         return ldb;
57 }
58
59 static struct backends_list_entry {
60         struct ldb_backend_ops *ops;
61         struct backends_list_entry *prev, *next;
62 } *ldb_backends = NULL;
63
64 #ifndef STATIC_LIBLDB_BACKENDS 
65
66 #ifdef HAVE_LDB_LDAP
67 #define LDAP_INIT &ldb_ldap_backend_ops, \
68                                   &ldb_ildap_backend_ops, \
69                                   &ldb_ldaps_backend_ops,
70 #else
71 #define LDAP_INIT
72 #endif
73
74 #ifdef HAVE_LDB_SQLITE3
75 #define SQLITE3_INIT &ldb_sqlite3_backend_ops,
76 #else
77 #define SQLITE3_INIT
78 #endif
79
80 #define STATIC_LIBLDB_BACKENDS \
81         LDAP_INIT \
82         SQLITE3_INIT \
83         &ldb_tdb_backend_ops,   \
84         NULL
85 #endif
86
87 const static struct ldb_backend_ops *builtin_backends[] = {
88         STATIC_LIBLDB_BACKENDS
89 };
90
91 static ldb_connect_fn ldb_find_backend(const char *url)
92 {
93         struct backends_list_entry *backend;
94         int i;
95
96         for (i = 0; builtin_backends[i]; i++) {
97                 if (strncmp(builtin_backends[i]->name, url, strlen(builtin_backends[i]->name)) == 0)
98                         return builtin_backends[i]->connect_fn;
99         }
100
101         for (backend = ldb_backends; backend; backend = backend->next) {
102                 if (strncmp(backend->ops->name, url, strlen(backend->ops->name)) == 0) {
103                         return backend->ops->connect_fn;
104                 }
105         }
106
107         return NULL;
108 }
109
110 /*
111  register a new ldb backend
112 */
113 int ldb_register_backend(const char *url_prefix, ldb_connect_fn connectfn)
114 {
115         struct ldb_backend_ops *backend = talloc(talloc_autofree_context(), struct ldb_backend_ops);
116         struct backends_list_entry *entry = talloc(talloc_autofree_context(), struct backends_list_entry);
117
118         if (ldb_find_backend(url_prefix)) {
119                 return LDB_SUCCESS;
120         }
121
122         /* Maybe check for duplicity here later on? */
123
124         backend->name = talloc_strdup(backend, url_prefix);
125         backend->connect_fn = connectfn;
126         entry->ops = backend;
127         DLIST_ADD(ldb_backends, entry);
128
129         return LDB_SUCCESS;
130 }
131
132 /* 
133    Return the ldb module form of a database. The URL can either be one of the following forms
134    ldb://path
135    ldapi://path
136
137    flags is made up of LDB_FLG_*
138
139    the options are passed uninterpreted to the backend, and are
140    backend specific.
141
142   This allows modules to get at only the backend module, for example where a module 
143   may wish to direct certain requests at a particular backend.
144 */
145 int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
146                         struct ldb_module **backend_module)
147 {
148         int ret;
149         char *backend;
150         ldb_connect_fn fn;
151
152         if (strchr(url, ':') != NULL) {
153                 backend = talloc_strndup(ldb, url, strchr(url, ':')-url);
154         } else {
155                 /* Default to tdb */
156                 backend = talloc_strdup(ldb, "tdb");
157         }
158
159         fn = ldb_find_backend(backend);
160
161         if (fn == NULL) {
162                 int (*init_fn) (void);
163
164                 init_fn = ldb_dso_load_symbol(ldb, backend,
165                                               "init_module");
166                 if (init_fn != NULL && init_fn() == 0) {
167                         fn = ldb_find_backend(backend);
168                 }
169         }
170
171         if (fn == NULL) {
172                 struct ldb_backend_ops *ops;
173                 char *symbol_name = talloc_asprintf(ldb, "ldb_%s_backend_ops", backend);
174                 if (symbol_name == NULL) {
175                         return LDB_ERR_OPERATIONS_ERROR;
176                 }
177                 ops = ldb_dso_load_symbol(ldb, backend, symbol_name);
178                 if (ops != NULL) {
179                         fn = ops->connect_fn;
180                 }
181                 talloc_free(symbol_name);
182         }
183
184         talloc_free(backend);
185
186         if (fn == NULL) {
187                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to find backend for '%s'\n", url);
188                 return LDB_ERR_OTHER;
189         }
190
191         ret = fn(ldb, url, ldb->flags, options, backend_module);
192
193         if (ret != LDB_SUCCESS) {
194                 ldb_debug(ldb, LDB_DEBUG_ERROR, "Failed to connect to '%s'\n", url);
195                 return ret;
196         }
197         return ret;
198 }
199
200 /*
201   try to autodetect a basedn if none specified. This fixes one of my
202   pet hates about ldapsearch, which is that you have to get a long,
203   complex basedn right to make any use of it.
204 */
205 void ldb_set_default_dns(struct ldb_context *ldb)
206 {
207         TALLOC_CTX *tmp_ctx;
208         int ret;
209         struct ldb_result *res;
210         struct ldb_dn *tmp_dn=NULL;
211         static const char *attrs[] = {
212                 "rootDomainNamingContext",
213                 "configurationNamingContext",
214                 "schemaNamingContext",
215                 "defaultNamingContext",
216                 NULL
217         };
218
219         tmp_ctx = talloc_new(ldb);
220         ret = ldb_search(ldb, ldb_dn_new(tmp_ctx, ldb, NULL), LDB_SCOPE_BASE, 
221                          "(objectClass=*)", attrs, &res);
222         if (ret == LDB_SUCCESS) {
223                 if (res->count == 1) {
224                         if (!ldb_get_opaque(ldb, "rootDomainNamingContext")) {
225                                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "rootDomainNamingContext");
226                                 ldb_set_opaque(ldb, "rootDomainNamingContext", tmp_dn);
227                         }
228
229                         if (!ldb_get_opaque(ldb, "configurationNamingContext")) {
230                                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "configurationNamingContext");
231                                 ldb_set_opaque(ldb, "configurationNamingContext", tmp_dn);
232                         }
233
234                         if (!ldb_get_opaque(ldb, "schemaNamingContext")) {
235                                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "schemaNamingContext");
236                                 ldb_set_opaque(ldb, "schemaNamingContext", tmp_dn);
237                         }
238
239                         if (!ldb_get_opaque(ldb, "defaultNamingContext")) {
240                                 tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "defaultNamingContext");
241                                 ldb_set_opaque(ldb, "defaultNamingContext", tmp_dn);
242                         }
243                 }
244                 talloc_free(res);
245         }
246
247         talloc_free(tmp_ctx);
248 }
249
250 struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb)
251 {
252         return talloc_get_type(ldb_get_opaque(ldb, "rootDomainNamingContext"), struct ldb_dn);
253 }
254
255 struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb)
256 {
257         return talloc_get_type(ldb_get_opaque(ldb, "configurationNamingContext"), struct ldb_dn);
258 }
259
260 struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb)
261 {
262         return talloc_get_type(ldb_get_opaque(ldb, "schemaNamingContext"), struct ldb_dn);
263 }
264
265 struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
266 {
267         return talloc_get_type(ldb_get_opaque(ldb, "defaultNamingContext"), struct ldb_dn);
268 }
269
270 /* 
271  connect to a database. The URL can either be one of the following forms
272    ldb://path
273    ldapi://path
274
275    flags is made up of LDB_FLG_*
276
277    the options are passed uninterpreted to the backend, and are
278    backend specific
279 */
280 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[])
281 {
282         int ret;
283         const char *url2;
284         /* We seem to need to do this here, or else some utilities don't get ldb backends */
285
286         ldb->flags = flags;
287
288         url2 = talloc_strdup(ldb, url);
289         if (!url2) {
290                 ldb_oom(ldb);
291                 return LDB_ERR_OPERATIONS_ERROR;
292         }
293         ret = ldb_set_opaque(ldb, "ldb_url", talloc_strdup(ldb, url2));
294         if (ret != LDB_SUCCESS) {
295                 return ret;
296         }
297
298         ret = ldb_connect_backend(ldb, url, options, &ldb->modules);
299         if (ret != LDB_SUCCESS) {
300                 return ret;
301         }
302
303         if (ldb_load_modules(ldb, options) != LDB_SUCCESS) {
304                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for %s: %s\n",
305                           url, ldb_errstring(ldb));
306                 return LDB_ERR_OTHER;
307         }
308
309         /* TODO: get timeout from options if available there */
310         ldb->default_timeout = 300; /* set default to 5 minutes */
311
312         /* set the default base dn */
313         ldb_set_default_dns(ldb);
314
315         return LDB_SUCCESS;
316 }
317
318 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string)
319 {
320         if (ldb->err_string) {
321                 talloc_free(ldb->err_string);
322         }
323         ldb->err_string = talloc_strdup(ldb, err_string);
324 }
325
326 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...)
327 {
328         va_list ap;
329         char *old_string = NULL;
330
331         if (ldb->err_string) {
332                 old_string = ldb->err_string;
333         }
334
335         va_start(ap, format);
336         ldb->err_string = talloc_vasprintf(ldb, format, ap);
337         va_end(ap);
338         talloc_free(old_string);
339 }
340
341 void ldb_reset_err_string(struct ldb_context *ldb)
342 {
343         if (ldb->err_string) {
344                 talloc_free(ldb->err_string);
345                 ldb->err_string = NULL;
346         }
347 }
348
349 #define FIRST_OP(ldb, op) do { \
350         module = ldb->modules;                                  \
351         while (module && module->ops->op == NULL) module = module->next; \
352         if (module == NULL) {                                           \
353                 ldb_asprintf_errstring(ldb, "unable to find module or backend to handle operation: " #op); \
354                 return LDB_ERR_OPERATIONS_ERROR;                        \
355         } \
356 } while (0)
357
358 /*
359   start a transaction
360 */
361 static int ldb_transaction_start_internal(struct ldb_context *ldb)
362 {
363         struct ldb_module *module;
364         int status;
365         FIRST_OP(ldb, start_transaction);
366
367         ldb_reset_err_string(ldb);
368
369         status = module->ops->start_transaction(module);
370         if (status != LDB_SUCCESS) {
371                 if (ldb->err_string == NULL) {
372                         /* no error string was setup by the backend */
373                         ldb_asprintf_errstring(ldb,
374                                                 "ldb transaction start: %s (%d)", 
375                                                 ldb_strerror(status), 
376                                                 status);
377                 }
378         }
379         return status;
380 }
381
382 /*
383   commit a transaction
384 */
385 static int ldb_transaction_commit_internal(struct ldb_context *ldb)
386 {
387         struct ldb_module *module;
388         int status;
389         FIRST_OP(ldb, end_transaction);
390
391         ldb_reset_err_string(ldb);
392
393         status = module->ops->end_transaction(module);
394         if (status != LDB_SUCCESS) {
395                 if (ldb->err_string == NULL) {
396                         /* no error string was setup by the backend */
397                         ldb_asprintf_errstring(ldb, 
398                                                 "ldb transaction commit: %s (%d)", 
399                                                 ldb_strerror(status), 
400                                                 status);
401                 }
402         }
403         return status;
404 }
405
406 /*
407   cancel a transaction
408 */
409 static int ldb_transaction_cancel_internal(struct ldb_context *ldb)
410 {
411         struct ldb_module *module;
412         int status;
413         FIRST_OP(ldb, del_transaction);
414
415         status = module->ops->del_transaction(module);
416         if (status != LDB_SUCCESS) {
417                 if (ldb->err_string == NULL) {
418                         /* no error string was setup by the backend */
419                         ldb_asprintf_errstring(ldb, 
420                                                 "ldb transaction cancel: %s (%d)", 
421                                                 ldb_strerror(status), 
422                                                 status);
423                 }
424         }
425         return status;
426 }
427
428 int ldb_transaction_start(struct ldb_context *ldb)
429 {
430         /* disable autotransactions */
431         ldb->transaction_active++;
432
433         return ldb_transaction_start_internal(ldb);
434 }
435
436 int ldb_transaction_commit(struct ldb_context *ldb)
437 {
438         /* renable autotransactions (when we reach 0) */
439         if (ldb->transaction_active > 0)
440                 ldb->transaction_active--;
441
442         return ldb_transaction_commit_internal(ldb);
443 }
444
445 int ldb_transaction_cancel(struct ldb_context *ldb)
446 {
447         /* renable autotransactions (when we reach 0) */
448         if (ldb->transaction_active > 0)
449                 ldb->transaction_active--;
450
451         return ldb_transaction_cancel_internal(ldb);
452 }
453
454 static int ldb_autotransaction_start(struct ldb_context *ldb)
455 {
456         /* explicit transaction active, ignore autotransaction request */
457         if (ldb->transaction_active)
458                 return LDB_SUCCESS;
459
460         return ldb_transaction_start_internal(ldb);
461 }
462
463 static int ldb_autotransaction_commit(struct ldb_context *ldb)
464 {
465         /* explicit transaction active, ignore autotransaction request */
466         if (ldb->transaction_active)
467                 return LDB_SUCCESS;
468
469         return ldb_transaction_commit_internal(ldb);
470 }
471
472 static int ldb_autotransaction_cancel(struct ldb_context *ldb)
473 {
474         /* explicit transaction active, ignore autotransaction request */
475         if (ldb->transaction_active)
476                 return LDB_SUCCESS;
477
478         return ldb_transaction_cancel_internal(ldb);
479 }
480
481 /* autostarts a transacion if none active */
482 static int ldb_autotransaction_request(struct ldb_context *ldb, struct ldb_request *req)
483 {
484         int ret;
485
486         ret = ldb_autotransaction_start(ldb);
487         if (ret != LDB_SUCCESS) {
488                 return ret;
489         }
490
491         ret = ldb_request(ldb, req);
492         if (ret == LDB_SUCCESS) {
493                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
494         }
495
496         if (ret == LDB_SUCCESS) {
497                 return ldb_autotransaction_commit(ldb);
498         }
499         ldb_autotransaction_cancel(ldb);
500
501         if (ldb->err_string == NULL) {
502                 /* no error string was setup by the backend */
503                 ldb_asprintf_errstring(ldb, "%s (%d)", ldb_strerror(ret), ret);
504         }
505
506         return ret;
507 }
508
509 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
510 {
511         if (!handle) {
512                 return LDB_SUCCESS;
513         }
514
515         return handle->module->ops->wait(handle, type);
516 }
517
518 /* set the specified timeout or, if timeout is 0 set the default timeout */
519 /* timeout == -1 means no timeout */
520 int ldb_set_timeout(struct ldb_context *ldb, struct ldb_request *req, int timeout)
521 {
522         if (req == NULL) return LDB_ERR_OPERATIONS_ERROR;
523         
524         if (timeout != 0) {
525                 req->timeout = timeout;
526         } else {
527                 req->timeout = ldb->default_timeout;
528         }
529         req->starttime = time(NULL);
530
531         return LDB_SUCCESS;
532 }
533
534 /* calculates the new timeout based on the previous starttime and timeout */
535 int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq)
536 {
537         time_t now;
538
539         if (newreq == NULL) return LDB_ERR_OPERATIONS_ERROR;
540
541         now = time(NULL);
542
543         if (oldreq == NULL)
544                 return ldb_set_timeout(ldb, newreq, 0);
545
546         if ((now - oldreq->starttime) > oldreq->timeout) {
547                 return LDB_ERR_TIME_LIMIT_EXCEEDED;
548         }
549         newreq->starttime = oldreq->starttime;
550         newreq->timeout = oldreq->timeout - (now - oldreq->starttime);
551
552         return LDB_SUCCESS;
553 }
554
555
556 /* 
557    set the permissions for new files to be passed to open() in
558    backends that use local files
559  */
560 void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms)
561 {
562         ldb->create_perms = perms;
563 }
564
565 /*
566   start an ldb request
567   NOTE: the request must be a talloc context.
568   returns LDB_ERR_* on errors.
569 */
570 int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
571 {
572         struct ldb_module *module;
573         int ret;
574
575         ldb_reset_err_string(ldb);
576
577         /* call the first module in the chain */
578         switch (req->operation) {
579         case LDB_SEARCH:
580                 FIRST_OP(ldb, search);
581                 ret = module->ops->search(module, req);
582                 break;
583         case LDB_ADD:
584                 FIRST_OP(ldb, add);
585                 ret = module->ops->add(module, req);
586                 break;
587         case LDB_MODIFY:
588                 FIRST_OP(ldb, modify);
589                 ret = module->ops->modify(module, req);
590                 break;
591         case LDB_DELETE:
592                 FIRST_OP(ldb, del);
593                 ret = module->ops->del(module, req);
594                 break;
595         case LDB_RENAME:
596                 FIRST_OP(ldb, rename);
597                 ret = module->ops->rename(module, req);
598                 break;
599         case LDB_EXTENDED:
600                 FIRST_OP(ldb, extended);
601                 ret = module->ops->extended(module, req);
602                 break;
603         case LDB_SEQUENCE_NUMBER:
604                 FIRST_OP(ldb, sequence_number);
605                 ret = module->ops->sequence_number(module, req);
606                 break;
607         default:
608                 FIRST_OP(ldb, request);
609                 ret = module->ops->request(module, req);
610                 break;
611         }
612
613         return ret;
614 }
615
616 /*
617   search the database given a LDAP-like search expression
618
619   returns an LDB error code
620
621   Use talloc_free to free the ldb_message returned in 'res', if successful
622
623 */
624 int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
625 {
626         struct ldb_result *res;
627         int n;
628         
629         if (!context) {
630                 ldb_set_errstring(ldb, "NULL Context in callback");
631                 return LDB_ERR_OPERATIONS_ERROR;
632         }       
633
634         res = talloc_get_type(context, struct ldb_result);
635
636         if (!res || !ares) {
637                 ldb_set_errstring(ldb, "NULL res or ares in callback");
638                 goto error;
639         }
640
641         switch (ares->type) {
642         case LDB_REPLY_ENTRY:
643                 res->msgs = talloc_realloc(res, res->msgs, struct ldb_message *, res->count + 2);
644                 if (! res->msgs) {
645                         goto error;
646                 }
647
648                 res->msgs[res->count + 1] = NULL;
649
650                 res->msgs[res->count] = talloc_move(res->msgs, &ares->message);
651                 res->count++;
652                 break;
653         case LDB_REPLY_REFERRAL:
654                 if (res->refs) {
655                         for (n = 0; res->refs[n]; n++) /*noop*/ ;
656                 } else {
657                         n = 0;
658                 }
659
660                 res->refs = talloc_realloc(res, res->refs, char *, n + 2);
661                 if (! res->refs) {
662                         goto error;
663                 }
664
665                 res->refs[n] = talloc_move(res->refs, &ares->referral);
666                 res->refs[n + 1] = NULL;
667                 break;
668         case LDB_REPLY_EXTENDED:
669         case LDB_REPLY_DONE:
670                 /* TODO: we should really support controls on entries and referrals too! */
671                 res->controls = talloc_move(res, &ares->controls);
672                 break;          
673         }
674         talloc_free(ares);
675         return LDB_SUCCESS;
676
677 error:
678         talloc_free(ares);
679         return LDB_ERR_OPERATIONS_ERROR;
680 }
681
682 int ldb_build_search_req(struct ldb_request **ret_req,
683                         struct ldb_context *ldb,
684                         void *mem_ctx,
685                         struct ldb_dn *base,
686                         enum ldb_scope scope,
687                         const char *expression,
688                         const char * const *attrs,
689                         struct ldb_control **controls,
690                         void *context,
691                         ldb_request_callback_t callback)
692 {
693         struct ldb_request *req;
694
695         *ret_req = NULL;
696
697         req = talloc(mem_ctx, struct ldb_request);
698         if (req == NULL) {
699                 ldb_set_errstring(ldb, "Out of Memory");
700                 return LDB_ERR_OPERATIONS_ERROR;
701         }
702
703         req->operation = LDB_SEARCH;
704         if (base == NULL) {
705                 req->op.search.base = ldb_dn_new(req, ldb, NULL);
706         } else {
707                 req->op.search.base = base;
708         }
709         req->op.search.scope = scope;
710
711         req->op.search.tree = ldb_parse_tree(req, expression);
712         if (req->op.search.tree == NULL) {
713                 ldb_set_errstring(ldb, "Unable to parse search expression");
714                 talloc_free(req);
715                 return LDB_ERR_OPERATIONS_ERROR;
716         }
717
718         req->op.search.attrs = attrs;
719         req->controls = controls;
720         req->context = context;
721         req->callback = callback;
722
723         *ret_req = req;
724         return LDB_SUCCESS;
725 }
726
727 int ldb_build_add_req(struct ldb_request **ret_req,
728                         struct ldb_context *ldb,
729                         void *mem_ctx,
730                         const struct ldb_message *message,
731                         struct ldb_control **controls,
732                         void *context,
733                         ldb_request_callback_t callback)
734 {
735         struct ldb_request *req;
736
737         *ret_req = NULL;
738
739         req = talloc(mem_ctx, struct ldb_request);
740         if (req == NULL) {
741                 ldb_set_errstring(ldb, "Out of Memory");
742                 return LDB_ERR_OPERATIONS_ERROR;
743         }
744
745         req->operation = LDB_ADD;
746         req->op.add.message = message;
747         req->controls = controls;
748         req->context = context;
749         req->callback = callback;
750
751         *ret_req = req;
752
753         return LDB_SUCCESS;
754 }
755
756 int ldb_build_mod_req(struct ldb_request **ret_req,
757                         struct ldb_context *ldb,
758                         void *mem_ctx,
759                         const struct ldb_message *message,
760                         struct ldb_control **controls,
761                         void *context,
762                         ldb_request_callback_t callback)
763 {
764         struct ldb_request *req;
765
766         *ret_req = NULL;
767
768         req = talloc(mem_ctx, struct ldb_request);
769         if (req == NULL) {
770                 ldb_set_errstring(ldb, "Out of Memory");
771                 return LDB_ERR_OPERATIONS_ERROR;
772         }
773
774         req->operation = LDB_MODIFY;
775         req->op.mod.message = message;
776         req->controls = controls;
777         req->context = context;
778         req->callback = callback;
779
780         *ret_req = req;
781
782         return LDB_SUCCESS;
783 }
784
785 int ldb_build_del_req(struct ldb_request **ret_req,
786                         struct ldb_context *ldb,
787                         void *mem_ctx,
788                         struct ldb_dn *dn,
789                         struct ldb_control **controls,
790                         void *context,
791                         ldb_request_callback_t callback)
792 {
793         struct ldb_request *req;
794
795         *ret_req = NULL;
796
797         req = talloc(mem_ctx, struct ldb_request);
798         if (req == NULL) {
799                 ldb_set_errstring(ldb, "Out of Memory");
800                 return LDB_ERR_OPERATIONS_ERROR;
801         }
802
803         req->operation = LDB_DELETE;
804         req->op.del.dn = dn;
805         req->controls = controls;
806         req->context = context;
807         req->callback = callback;
808
809         *ret_req = req;
810
811         return LDB_SUCCESS;
812 }
813
814 int ldb_build_rename_req(struct ldb_request **ret_req,
815                         struct ldb_context *ldb,
816                         void *mem_ctx,
817                         struct ldb_dn *olddn,
818                         struct ldb_dn *newdn,
819                         struct ldb_control **controls,
820                         void *context,
821                         ldb_request_callback_t callback)
822 {
823         struct ldb_request *req;
824
825         *ret_req = NULL;
826
827         req = talloc(mem_ctx, struct ldb_request);
828         if (req == NULL) {
829                 ldb_set_errstring(ldb, "Out of Memory");
830                 return LDB_ERR_OPERATIONS_ERROR;
831         }
832
833         req->operation = LDB_RENAME;
834         req->op.rename.olddn = olddn;
835         req->op.rename.newdn = newdn;
836         req->controls = controls;
837         req->context = context;
838         req->callback = callback;
839
840         *ret_req = req;
841
842         return LDB_SUCCESS;
843 }
844
845 int ldb_extended_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
846 {
847         struct ldb_result *res;
848         
849         if (!context) {
850                 ldb_set_errstring(ldb, "NULL Context in callback");
851                 return LDB_ERR_OPERATIONS_ERROR;
852         }
853
854         res = talloc_get_type(context, struct ldb_result);
855         if (!res || !ares) {
856                 ldb_set_errstring(ldb, "NULL res or ares in callback");
857                 goto error;
858         }
859
860         switch (ares->type) {
861         case LDB_REPLY_ENTRY:
862         case LDB_REPLY_REFERRAL:
863         case LDB_REPLY_DONE:
864                 ldb_set_errstring(ldb, "invalid ares type in callback");
865                 goto error;
866         case LDB_REPLY_EXTENDED:
867                 /* TODO: we should really support controls on entries and referrals too! */
868                 res->extended = talloc_move(res, &ares->response);
869                 res->controls = talloc_move(res, &ares->controls);
870                 break;          
871         }
872         talloc_free(ares);
873         return LDB_SUCCESS;
874
875 error:
876         talloc_free(ares);
877         return LDB_ERR_OPERATIONS_ERROR;
878 }
879
880 int ldb_build_extended_req(struct ldb_request **ret_req,
881                            struct ldb_context *ldb,
882                            void *mem_ctx,
883                            const char *oid,
884                            void *data,
885                            struct ldb_control **controls,
886                            void *context,
887                            ldb_request_callback_t callback)
888 {
889         struct ldb_request *req;
890
891         *ret_req = NULL;
892
893         req = talloc(mem_ctx, struct ldb_request);
894         if (req == NULL) {
895                 ldb_set_errstring(ldb, "Out of Memory");
896                 return LDB_ERR_OPERATIONS_ERROR;
897         }
898
899         req->operation = LDB_EXTENDED;
900         req->op.extended.oid = oid;
901         req->op.extended.data = data;
902         req->controls = controls;
903         req->context = context;
904         req->callback = callback;
905
906         *ret_req = req;
907
908         return LDB_SUCCESS;
909 }
910
911 int ldb_extended(struct ldb_context *ldb, 
912                  const char *oid,
913                  void *data,
914                  struct ldb_result **_res)
915 {
916         struct ldb_request *req;
917         int ret;
918         struct ldb_result *res;
919
920         *_res = NULL;
921
922         res = talloc_zero(ldb, struct ldb_result);
923         if (!res) {
924                 return LDB_ERR_OPERATIONS_ERROR;
925         }
926
927         ret = ldb_build_extended_req(&req, ldb, ldb,
928                                      oid, data, NULL,
929                                      res, ldb_extended_default_callback);
930         if (ret != LDB_SUCCESS) goto done;
931
932         ldb_set_timeout(ldb, req, 0); /* use default timeout */
933
934         ret = ldb_request(ldb, req);
935         
936         if (ret == LDB_SUCCESS) {
937                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
938         }
939
940         talloc_free(req);
941
942 done:
943         if (ret != LDB_SUCCESS) {
944                 talloc_free(res);
945         }
946
947         *_res = res;
948         return ret;
949 }
950
951 /*
952   note that ldb_search() will automatically replace a NULL 'base' value with the 
953   defaultNamingContext from the rootDSE if available.
954 */
955 int ldb_search(struct ldb_context *ldb, 
956                struct ldb_dn *base,
957                enum ldb_scope scope,
958                const char *expression,
959                const char * const *attrs, 
960                struct ldb_result **_res)
961 {
962         struct ldb_request *req;
963         int ret;
964         struct ldb_result *res;
965
966         *_res = NULL;
967
968         res = talloc_zero(ldb, struct ldb_result);
969         if (!res) {
970                 return LDB_ERR_OPERATIONS_ERROR;
971         }
972
973         ret = ldb_build_search_req(&req, ldb, ldb,
974                                         base?base:ldb_get_default_basedn(ldb),
975                                         scope,
976                                         expression,
977                                         attrs,
978                                         NULL,
979                                         res,
980                                         ldb_search_default_callback);
981
982         if (ret != LDB_SUCCESS) goto done;
983
984         ldb_set_timeout(ldb, req, 0); /* use default timeout */
985
986         ret = ldb_request(ldb, req);
987         
988         if (ret == LDB_SUCCESS) {
989                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
990         }
991
992         talloc_free(req);
993
994 done:
995         if (ret != LDB_SUCCESS) {
996                 talloc_free(res);
997         }
998
999         *_res = res;
1000         return ret;
1001 }
1002
1003 /*
1004  a useful search function where you can easily define the expression and that
1005  takes a memory context where results are allocated
1006 */
1007
1008 int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_result **result,
1009                         struct ldb_dn *base, enum ldb_scope scope, const char * const *attrs,
1010                         const char *exp_fmt, ...)
1011 {
1012         struct ldb_result *res;
1013         char *expression;
1014         va_list ap;
1015         int ret;
1016
1017         res = NULL;
1018         *result = NULL;
1019
1020         va_start(ap, exp_fmt);
1021         expression = talloc_vasprintf(mem_ctx, exp_fmt, ap);
1022         va_end(ap);
1023
1024         if ( ! expression) {
1025                 return LDB_ERR_OPERATIONS_ERROR;
1026         }
1027
1028         ret = ldb_search(ldb, base, scope, expression, attrs, &res);
1029
1030         if (ret == LDB_SUCCESS) {
1031                 talloc_steal(mem_ctx, res);
1032                 *result = res;
1033         }
1034
1035         talloc_free(expression);
1036
1037         return ret;
1038 }
1039
1040 /*
1041   add a record to the database. Will fail if a record with the given class and key
1042   already exists
1043 */
1044 int ldb_add(struct ldb_context *ldb, 
1045             const struct ldb_message *message)
1046 {
1047         struct ldb_request *req;
1048         int ret;
1049
1050         ret = ldb_msg_sanity_check(ldb, message);
1051         if (ret != LDB_SUCCESS) {
1052                 return ret;
1053         }
1054
1055         ret = ldb_build_add_req(&req, ldb, ldb,
1056                                         message,
1057                                         NULL,
1058                                         NULL,
1059                                         NULL);
1060
1061         if (ret != LDB_SUCCESS) return ret;
1062
1063         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1064
1065         /* do request and autostart a transaction */
1066         ret = ldb_autotransaction_request(ldb, req);
1067
1068         talloc_free(req);
1069         return ret;
1070 }
1071
1072 /*
1073   modify the specified attributes of a record
1074 */
1075 int ldb_modify(struct ldb_context *ldb, 
1076                const struct ldb_message *message)
1077 {
1078         struct ldb_request *req;
1079         int ret;
1080
1081         ret = ldb_msg_sanity_check(ldb, message);
1082         if (ret != LDB_SUCCESS) {
1083                 return ret;
1084         }
1085
1086         ret = ldb_build_mod_req(&req, ldb, ldb,
1087                                         message,
1088                                         NULL,
1089                                         NULL,
1090                                         NULL);
1091
1092         if (ret != LDB_SUCCESS) return ret;
1093
1094         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1095
1096         /* do request and autostart a transaction */
1097         ret = ldb_autotransaction_request(ldb, req);
1098
1099         talloc_free(req);
1100         return ret;
1101 }
1102
1103
1104 /*
1105   delete a record from the database
1106 */
1107 int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn)
1108 {
1109         struct ldb_request *req;
1110         int ret;
1111
1112         ret = ldb_build_del_req(&req, ldb, ldb,
1113                                         dn,
1114                                         NULL,
1115                                         NULL,
1116                                         NULL);
1117
1118         if (ret != LDB_SUCCESS) return ret;
1119
1120         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1121
1122         /* do request and autostart a transaction */
1123         ret = ldb_autotransaction_request(ldb, req);
1124
1125         talloc_free(req);
1126         return ret;
1127 }
1128
1129 /*
1130   rename a record in the database
1131 */
1132 int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn)
1133 {
1134         struct ldb_request *req;
1135         int ret;
1136
1137         ret = ldb_build_rename_req(&req, ldb, ldb,
1138                                         olddn,
1139                                         newdn,
1140                                         NULL,
1141                                         NULL,
1142                                         NULL);
1143
1144         if (ret != LDB_SUCCESS) return ret;
1145
1146         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1147
1148         /* do request and autostart a transaction */
1149         ret = ldb_autotransaction_request(ldb, req);
1150
1151         talloc_free(req);
1152         return ret;
1153 }
1154
1155
1156 /*
1157   return the global sequence number
1158 */
1159 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num)
1160 {
1161         struct ldb_request *req;
1162         int ret;
1163
1164         req = talloc(ldb, struct ldb_request);
1165         if (req == NULL) {
1166                 ldb_set_errstring(ldb, "Out of Memory");
1167                 return LDB_ERR_OPERATIONS_ERROR;
1168         }
1169
1170         req->operation = LDB_SEQUENCE_NUMBER;
1171         req->controls = NULL;
1172         req->context = NULL;
1173         req->callback = NULL;
1174         ldb_set_timeout(ldb, req, 0); /* use default timeout */
1175
1176         req->op.seq_num.type = type;
1177         /* do request and autostart a transaction */
1178         ret = ldb_request(ldb, req);
1179         
1180         if (ret == LDB_SUCCESS) {
1181                 *seq_num = req->op.seq_num.seq_num;
1182         }
1183
1184         talloc_free(req);
1185         return ret;
1186 }
1187
1188
1189
1190 /*
1191   return extended error information 
1192 */
1193 const char *ldb_errstring(struct ldb_context *ldb)
1194 {
1195         if (ldb->err_string) {
1196                 return ldb->err_string;
1197         }
1198
1199         return NULL;
1200 }
1201
1202 /*
1203   return a string explaining what a ldb error constant meancs
1204 */
1205 const char *ldb_strerror(int ldb_err)
1206 {
1207         switch (ldb_err) {
1208         case LDB_SUCCESS:
1209                 return "Success";
1210         case LDB_ERR_OPERATIONS_ERROR:
1211                 return "Operations error";
1212         case LDB_ERR_PROTOCOL_ERROR:
1213                 return "Protocol error";
1214         case LDB_ERR_TIME_LIMIT_EXCEEDED:
1215                 return "Time limit exceeded";
1216         case LDB_ERR_SIZE_LIMIT_EXCEEDED:
1217                 return "Size limit exceeded";
1218         case LDB_ERR_COMPARE_FALSE:
1219                 return "Compare false";
1220         case LDB_ERR_COMPARE_TRUE:
1221                 return "Compare true";
1222         case LDB_ERR_AUTH_METHOD_NOT_SUPPORTED:
1223                 return "Auth method not supported";
1224         case LDB_ERR_STRONG_AUTH_REQUIRED:
1225                 return "Strong auth required";
1226 /* 9 RESERVED */
1227         case LDB_ERR_REFERRAL:
1228                 return "Referral error";
1229         case LDB_ERR_ADMIN_LIMIT_EXCEEDED:
1230                 return "Admin limit exceeded";
1231         case LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION:
1232                 return "Unsupported critical extension";
1233         case LDB_ERR_CONFIDENTIALITY_REQUIRED:
1234                 return "Confidentiality required";
1235         case LDB_ERR_SASL_BIND_IN_PROGRESS:
1236                 return "SASL bind in progress";
1237         case LDB_ERR_NO_SUCH_ATTRIBUTE:
1238                 return "No such attribute";
1239         case LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE:
1240                 return "Undefined attribute type";
1241         case LDB_ERR_INAPPROPRIATE_MATCHING:
1242                 return "Inappropriate matching";
1243         case LDB_ERR_CONSTRAINT_VIOLATION:
1244                 return "Constraint violation";
1245         case LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS:
1246                 return "Attribute or value exists";
1247         case LDB_ERR_INVALID_ATTRIBUTE_SYNTAX:
1248                 return "Invalid attribute syntax";
1249 /* 22-31 unused */
1250         case LDB_ERR_NO_SUCH_OBJECT:
1251                 return "No such object";
1252         case LDB_ERR_ALIAS_PROBLEM:
1253                 return "Alias problem";
1254         case LDB_ERR_INVALID_DN_SYNTAX:
1255                 return "Invalid DN syntax";
1256 /* 35 RESERVED */
1257         case LDB_ERR_ALIAS_DEREFERENCING_PROBLEM:
1258                 return "Alias dereferencing problem";
1259 /* 37-47 unused */
1260         case LDB_ERR_INAPPROPRIATE_AUTHENTICATION:
1261                 return "Inappropriate authentication";
1262         case LDB_ERR_INVALID_CREDENTIALS:
1263                 return "Invalid credentials";
1264         case LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS:
1265                 return "insufficient access rights";
1266         case LDB_ERR_BUSY:
1267                 return "Busy";
1268         case LDB_ERR_UNAVAILABLE:
1269                 return "Unavailable";
1270         case LDB_ERR_UNWILLING_TO_PERFORM:
1271                 return "Unwilling to perform";
1272         case LDB_ERR_LOOP_DETECT:
1273                 return "Loop detect";
1274 /* 55-63 unused */
1275         case LDB_ERR_NAMING_VIOLATION:
1276                 return "Naming violation";
1277         case LDB_ERR_OBJECT_CLASS_VIOLATION:
1278                 return "Object class violation";
1279         case LDB_ERR_NOT_ALLOWED_ON_NON_LEAF:
1280                 return "Not allowed on non-leaf";
1281         case LDB_ERR_NOT_ALLOWED_ON_RDN:
1282                 return "Not allowed on RDN";
1283         case LDB_ERR_ENTRY_ALREADY_EXISTS:
1284                 return "Entry already exists";
1285         case LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED:
1286                 return "Object class mods prohibited";
1287 /* 70 RESERVED FOR CLDAP */
1288         case LDB_ERR_AFFECTS_MULTIPLE_DSAS:
1289                 return "Affects multiple DSAs";
1290 /* 72-79 unused */
1291         case LDB_ERR_OTHER:
1292                 return "Other";
1293         }
1294
1295         return "Unknown error";
1296 }
1297
1298 /*
1299   set backend specific opaque parameters
1300 */
1301 int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value)
1302 {
1303         struct ldb_opaque *o;
1304
1305         /* allow updating an existing value */
1306         for (o=ldb->opaque;o;o=o->next) {
1307                 if (strcmp(o->name, name) == 0) {
1308                         o->value = value;
1309                         return LDB_SUCCESS;
1310                 }
1311         }
1312
1313         o = talloc(ldb, struct ldb_opaque);
1314         if (o == NULL) {
1315                 ldb_oom(ldb);
1316                 return LDB_ERR_OTHER;
1317         }
1318         o->next = ldb->opaque;
1319         o->name = name;
1320         o->value = value;
1321         ldb->opaque = o;
1322         return LDB_SUCCESS;
1323 }
1324
1325 /*
1326   get a previously set opaque value
1327 */
1328 void *ldb_get_opaque(struct ldb_context *ldb, const char *name)
1329 {
1330         struct ldb_opaque *o;
1331         for (o=ldb->opaque;o;o=o->next) {
1332                 if (strcmp(o->name, name) == 0) {
1333                         return o->value;
1334                 }
1335         }
1336         return NULL;
1337 }