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