source4/lib/ldb/common/ldb_modules.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Simo Sorce  2004-2008
   5
   6      ** NOTE! The following LGPL license applies to the ldb
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  10    This library is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU Lesser General Public
  12    License as published by the Free Software Foundation; either
  13    version 3 of the License, or (at your option) any later version.
  14
  15    This library is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    Lesser General Public License for more details.
  19
  20    You should have received a copy of the GNU Lesser General Public
  21    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 /*
  25  *  Name: ldb
  26  *
  27  *  Component: ldb modules core
  28  *
  29  *  Description: core modules routines
  30  *
  31  *  Author: Simo Sorce
  32  */
  33
  34 #include "ldb_private.h"
  35 #include "dlinklist.h"
  36
  37 #define LDB_MODULE_PREFIX       "modules:"
  38 #define LDB_MODULE_PREFIX_LEN   8
  39
  40 static void *ldb_dso_load_symbol(struct ldb_context *ldb, const char *name,
  41                                  const char *symbol);
  42
  43 void ldb_set_modules_dir(struct ldb_context *ldb, const char *path)
  44 {
  45         talloc_free(ldb->modules_dir);
  46         ldb->modules_dir = talloc_strdup(ldb, path);
  47 }
  48
  49 static char *ldb_modules_strdup_no_spaces(TALLOC_CTX *mem_ctx, const char *string)
  50 {
  51         int i, len;
  52         char *trimmed;
  53
  54         trimmed = talloc_strdup(mem_ctx, string);
  55         if (!trimmed) {
  56                 return NULL;
  57         }
  58
  59         len = strlen(trimmed);
  60         for (i = 0; trimmed[i] != '\0'; i++) {
  61                 switch (trimmed[i]) {
  62                 case ' ':
  63                 case '\t':
  64                 case '\n':
  65                         memmove(&trimmed[i], &trimmed[i + 1], len -i -1);
  66                         break;
  67                 }
  68         }
  69
  70         return trimmed;
  71 }
  72
  73
  74 /* modules are called in inverse order on the stack.
  75    Lets place them as an admin would think the right order is.
  76    Modules order is important */
  77 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string)
  78 {
  79         char **modules = NULL;
  80         const char **m;
  81         char *modstr, *p;
  82         int i;
  83
  84         /* spaces not admitted */
  85         modstr = ldb_modules_strdup_no_spaces(mem_ctx, string);
  86         if ( ! modstr) {
  87                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_strdup_no_spaces()");
  88                 return NULL;
  89         }
  90
  91         modules = talloc_realloc(mem_ctx, modules, char *, 2);
  92         if ( ! modules ) {
  93                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()");
  94                 talloc_free(modstr);
  95                 return NULL;
  96         }
  97         talloc_steal(modules, modstr);
  98
  99         if (modstr[0] == '\0') {
 100                 modules[0] = NULL;
 101                 m = (const char **)modules;
 102                 return m;
 103         }
 104
 105         i = 0;
 106         /* The str*r*chr walks backwards:  This is how we get the inverse order mentioned above */
 107         while ((p = strrchr(modstr, ',')) != NULL) {
 108                 *p = '\0';
 109                 p++;
 110                 modules[i] = p;
 111
 112                 i++;
 113                 modules = talloc_realloc(mem_ctx, modules, char *, i + 2);
 114                 if ( ! modules ) {
 115                         ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()");
 116                         return NULL;
 117                 }
 118
 119         }
 120         modules[i] = modstr;
 121
 122         modules[i + 1] = NULL;
 123
 124         m = (const char **)modules;
 125
 126         return m;
 127 }
 128
 129 static struct backends_list_entry {
 130         struct ldb_backend_ops *ops;
 131         struct backends_list_entry *prev, *next;
 132 } *ldb_backends = NULL;
 133
 134 static struct ops_list_entry {
 135         const struct ldb_module_ops *ops;
 136         struct ops_list_entry *next;
 137 } *registered_modules = NULL;
 138
 139 static const struct ldb_builtins {
 140         const struct ldb_backend_ops *backend_ops;
 141         const struct ldb_module_ops *module_ops;
 142 } builtins[];
 143
 144 static ldb_connect_fn ldb_find_backend(const char *url)
 145 {
 146         struct backends_list_entry *backend;
 147         int i;
 148
 149         for (i = 0; builtins[i].backend_ops || builtins[i].module_ops; i++) {
 150                 if (builtins[i].backend_ops == NULL) continue;
 151
 152                 if (strncmp(builtins[i].backend_ops->name, url,
 153                             strlen(builtins[i].backend_ops->name)) == 0) {
 154                         return builtins[i].backend_ops->connect_fn;
 155                 }
 156         }
 157
 158         for (backend = ldb_backends; backend; backend = backend->next) {
 159                 if (strncmp(backend->ops->name, url,
 160                             strlen(backend->ops->name)) == 0) {
 161                         return backend->ops->connect_fn;
 162                 }
 163         }
 164
 165         return NULL;
 166 }
 167
 168 /*
 169  register a new ldb backend
 170 */
 171 int ldb_register_backend(const char *url_prefix, ldb_connect_fn connectfn)
 172 {
 173         struct ldb_backend_ops *backend;
 174         struct backends_list_entry *entry;
 175
 176         backend = talloc(talloc_autofree_context(), struct ldb_backend_ops);
 177         if (!backend) return LDB_ERR_OPERATIONS_ERROR;
 178
 179         entry = talloc(talloc_autofree_context(), struct backends_list_entry);
 180         if (!entry) {
 181                 talloc_free(backend);
 182                 return LDB_ERR_OPERATIONS_ERROR;
 183         }
 184
 185         if (ldb_find_backend(url_prefix)) {
 186                 return LDB_SUCCESS;
 187         }
 188
 189         /* Maybe check for duplicity here later on? */
 190
 191         backend->name = talloc_strdup(backend, url_prefix);
 192         backend->connect_fn = connectfn;
 193         entry->ops = backend;
 194         DLIST_ADD(ldb_backends, entry);
 195
 196         return LDB_SUCCESS;
 197 }
 198
 199 /*
 200    Return the ldb module form of a database.
 201    The URL can either be one of the following forms
 202    ldb://path
 203    ldapi://path
 204
 205    flags is made up of LDB_FLG_*
 206
 207    the options are passed uninterpreted to the backend, and are
 208    backend specific.
 209
 210    This allows modules to get at only the backend module, for example where a
 211    module may wish to direct certain requests at a particular backend.
 212 */
 213 int ldb_connect_backend(struct ldb_context *ldb,
 214                         const char *url,
 215                         const char *options[],
 216                         struct ldb_module **backend_module)
 217 {
 218         int ret;
 219         char *backend;
 220         ldb_connect_fn fn;
 221
 222         if (strchr(url, ':') != NULL) {
 223                 backend = talloc_strndup(ldb, url, strchr(url, ':')-url);
 224         } else {
 225                 /* Default to tdb */
 226                 backend = talloc_strdup(ldb, "tdb");
 227         }
 228
 229         fn = ldb_find_backend(backend);
 230
 231         if (fn == NULL) {
 232                 struct ldb_backend_ops *ops;
 233                 char *symbol_name = talloc_asprintf(ldb, "ldb_%s_backend_ops", backend);
 234                 if (symbol_name == NULL) {
 235                         return LDB_ERR_OPERATIONS_ERROR;
 236                 }
 237                 ops = ldb_dso_load_symbol(ldb, backend, symbol_name);
 238                 if (ops != NULL) {
 239                         fn = ops->connect_fn;
 240                 }
 241                 talloc_free(symbol_name);
 242         }
 243
 244         talloc_free(backend);
 245
 246         if (fn == NULL) {
 247                 ldb_debug(ldb, LDB_DEBUG_FATAL,
 248                           "Unable to find backend for '%s'", url);
 249                 return LDB_ERR_OTHER;
 250         }
 251
 252         ret = fn(ldb, url, ldb->flags, options, backend_module);
 253
 254         if (ret != LDB_SUCCESS) {
 255                 ldb_debug(ldb, LDB_DEBUG_ERROR,
 256                           "Failed to connect to '%s'", url);
 257                 return ret;
 258         }
 259         return ret;
 260 }
 261
 262 static const struct ldb_module_ops *ldb_find_module_ops(const char *name)
 263 {
 264         struct ops_list_entry *e;
 265         int i;
 266
 267         for (i = 0; builtins[i].backend_ops || builtins[i].module_ops; i++) {
 268                 if (builtins[i].module_ops == NULL) continue;
 269
 270                 if (strcmp(builtins[i].module_ops->name, name) == 0)
 271                         return builtins[i].module_ops;
 272         }
 273
 274         for (e = registered_modules; e; e = e->next) {
 275                 if (strcmp(e->ops->name, name) == 0)
 276                         return e->ops;
 277         }
 278
 279         return NULL;
 280 }
 281
 282
 283 int ldb_register_module(const struct ldb_module_ops *ops)
 284 {
 285         struct ops_list_entry *entry = talloc(talloc_autofree_context(), struct ops_list_entry);
 286
 287         if (ldb_find_module_ops(ops->name) != NULL)
 288                 return -1;
 289
 290         if (entry == NULL)
 291                 return -1;
 292
 293         entry->ops = ops;
 294         entry->next = registered_modules;
 295         registered_modules = entry;
 296
 297         return 0;
 298 }
 299
 300 static void *ldb_dso_load_symbol(struct ldb_context *ldb, const char *name,
 301                                  const char *symbol)
 302 {
 303         char *path;
 304         void *handle;
 305         void *sym;
 306
 307         if (ldb->modules_dir == NULL)
 308                 return NULL;
 309
 310         path = talloc_asprintf(ldb, "%s/%s.%s", ldb->modules_dir, name,
 311                                SHLIBEXT);
 312
 313         ldb_debug(ldb, LDB_DEBUG_TRACE, "trying to load %s from %s", name, path);
 314
 315         handle = dlopen(path, RTLD_NOW);
 316         if (handle == NULL) {
 317                 ldb_debug(ldb, LDB_DEBUG_WARNING, "unable to load %s from %s: %s", name, path, dlerror());
 318                 return NULL;
 319         }
 320
 321         sym = (int (*)(void))dlsym(handle, symbol);
 322
 323         if (sym == NULL) {
 324                 ldb_debug(ldb, LDB_DEBUG_ERROR, "no symbol `%s' found in %s: %s", symbol, path, dlerror());
 325                 return NULL;
 326         }
 327
 328         talloc_free(path);
 329
 330         return sym;
 331 }
 332
 333 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out)
 334 {
 335         struct ldb_module *module;
 336         int i;
 337
 338         module = backend;
 339
 340         for (i = 0; module_list && module_list[i] != NULL; i++) {
 341                 struct ldb_module *current;
 342                 const struct ldb_module_ops *ops;
 343
 344                 if (strcmp(module_list[i], "") == 0) {
 345                         continue;
 346                 }
 347
 348                 ops = ldb_find_module_ops(module_list[i]);
 349                 if (ops == NULL) {
 350                         char *symbol_name = talloc_asprintf(ldb, "ldb_%s_module_ops",
 351                                                                                                 module_list[i]);
 352                         if (symbol_name == NULL) {
 353                                 return LDB_ERR_OPERATIONS_ERROR;
 354                         }
 355                         ops = ldb_dso_load_symbol(ldb, module_list[i], symbol_name);
 356                         talloc_free(symbol_name);
 357                 }
 358
 359                 if (ops == NULL) {
 360                         ldb_debug(ldb, LDB_DEBUG_WARNING, "WARNING: Module [%s] not found",
 361                                   module_list[i]);
 362                         continue;
 363                 }
 364
 365                 current = talloc_zero(ldb, struct ldb_module);
 366                 if (current == NULL) {
 367                         return LDB_ERR_OPERATIONS_ERROR;
 368                 }
 369                 talloc_set_name(current, "ldb_module: %s", module_list[i]);
 370
 371                 current->ldb = ldb;
 372                 current->ops = ops;
 373
 374                 DLIST_ADD(module, current);
 375         }
 376         *out = module;
 377         return LDB_SUCCESS;
 378 }
 379
 380 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module)
 381 {
 382         while (module && module->ops->init_context == NULL)
 383                 module = module->next;
 384
 385         /* init is different in that it is not an error if modules
 386          * do not require initialization */
 387
 388         if (module) {
 389                 int ret = module->ops->init_context(module);
 390                 if (ret != LDB_SUCCESS) {
 391                         ldb_debug(ldb, LDB_DEBUG_FATAL, "module %s initialization failed", module->ops->name);
 392                         return ret;
 393                 }
 394         }
 395
 396         return LDB_SUCCESS;
 397 }
 398
 399 int ldb_load_modules(struct ldb_context *ldb, const char *options[])
 400 {
 401         const char **modules = NULL;
 402         int i;
 403         int ret;
 404         TALLOC_CTX *mem_ctx = talloc_new(ldb);
 405         if (!mem_ctx) {
 406                 return LDB_ERR_OPERATIONS_ERROR;
 407         }
 408
 409         /* find out which modules we are requested to activate */
 410
 411         /* check if we have a custom module list passd as ldb option */
 412         if (options) {
 413                 for (i = 0; options[i] != NULL; i++) {
 414                         if (strncmp(options[i], LDB_MODULE_PREFIX, LDB_MODULE_PREFIX_LEN) == 0) {
 415                                 modules = ldb_modules_list_from_string(ldb, mem_ctx, &options[i][LDB_MODULE_PREFIX_LEN]);
 416                         }
 417                 }
 418         }
 419
 420         /* if not overloaded by options and the backend is not ldap try to load the modules list from ldb */
 421         if ((modules == NULL) && (strcmp("ldap", ldb->modules->ops->name) != 0)) {
 422                 const char * const attrs[] = { "@LIST" , NULL};
 423                 struct ldb_result *res = NULL;
 424                 struct ldb_dn *mods_dn;
 425
 426                 mods_dn = ldb_dn_new(mem_ctx, ldb, "@MODULES");
 427                 if (mods_dn == NULL) {
 428                         talloc_free(mem_ctx);
 429                         return -1;
 430                 }
 431
 432                 ret = ldb_search(ldb, mods_dn, &res, mods_dn, LDB_SCOPE_BASE, attrs, "@LIST=*");
 433
 434                 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 435                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 436                 } else if (ret != LDB_SUCCESS) {
 437                         ldb_debug(ldb, LDB_DEBUG_FATAL, "ldb error (%s) occurred searching for modules, bailing out", ldb_errstring(ldb));
 438                         talloc_free(mem_ctx);
 439                         return ret;
 440                 } else {
 441                         const char *module_list;
 442                         if (res->count == 0) {
 443                                 ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 444                         } else if (res->count > 1) {
 445                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Too many records found (%d), bailing out", res->count);
 446                                 talloc_free(mem_ctx);
 447                                 return -1;
 448                         } else {
 449                                 module_list = ldb_msg_find_attr_as_string(res->msgs[0], "@LIST", NULL);
 450                                 if (!module_list) {
 451                                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 452                                 }
 453                                 modules = ldb_modules_list_from_string(ldb, mem_ctx,
 454                                                                module_list);
 455                         }
 456                 }
 457
 458                 talloc_free(mods_dn);
 459         }
 460
 461         if (modules != NULL) {
 462                 ret = ldb_load_modules_list(ldb, modules, ldb->modules, &ldb->modules);
 463                 if (ret != LDB_SUCCESS) {
 464                         talloc_free(mem_ctx);
 465                         return ret;
 466                 }
 467         } else {
 468                 ldb_debug(ldb, LDB_DEBUG_TRACE, "No modules specified for this database");
 469         }
 470
 471         ret = ldb_init_module_chain(ldb, ldb->modules);
 472         talloc_free(mem_ctx);
 473         return ret;
 474 }
 475
 476 /*
 477   by using this we allow ldb modules to only implement the functions they care about,
 478   which makes writing a module simpler, and makes it more likely to keep working
 479   when ldb is extended
 480 */
 481 #define FIND_OP_NOERR(module, op) do { \
 482         module = module->next; \
 483         while (module && module->ops->op == NULL) module = module->next; \
 484 } while (0)
 485
 486 #define FIND_OP(module, op) do { \
 487         struct ldb_context *ldb = module->ldb; \
 488         FIND_OP_NOERR(module, op); \
 489         if (module == NULL) { \
 490                 ldb_asprintf_errstring(ldb, "Unable to find backend operation for " #op ); \
 491                 return LDB_ERR_OPERATIONS_ERROR;        \
 492         }                                               \
 493 } while (0)
 494
 495
 496 struct ldb_module *ldb_module_new(TALLOC_CTX *memctx,
 497                                   struct ldb_context *ldb,
 498                                   const char *module_name,
 499                                   const struct ldb_module_ops *ops)
 500 {
 501         struct ldb_module *module;
 502
 503         module = talloc(memctx, struct ldb_module);
 504         if (!module) {
 505                 ldb_oom(ldb);
 506                 return NULL;
 507         }
 508         talloc_set_name_const(module, module_name);
 509         module->ldb = ldb;
 510         module->prev = module->next = NULL;
 511         module->ops = ops;
 512
 513         return module;
 514 }
 515
 516 const char * ldb_module_get_name(struct ldb_module *module)
 517 {
 518         return module->ops->name;
 519 }
 520
 521 struct ldb_context *ldb_module_get_ctx(struct ldb_module *module)
 522 {
 523         return module->ldb;
 524 }
 525
 526 void *ldb_module_get_private(struct ldb_module *module)
 527 {
 528         return module->private_data;
 529 }
 530
 531 void ldb_module_set_private(struct ldb_module *module, void *private_data)
 532 {
 533         module->private_data = private_data;
 534 }
 535
 536 /*
 537    helper functions to call the next module in chain
 538 */
 539
 540 int ldb_next_request(struct ldb_module *module, struct ldb_request *request)
 541 {
 542         int ret;
 543
 544         if (request->callback == NULL) {
 545                 ldb_set_errstring(module->ldb, "Requests MUST define callbacks");
 546                 return LDB_ERR_UNWILLING_TO_PERFORM;
 547         }
 548
 549         request->handle->nesting++;
 550
 551         switch (request->operation) {
 552         case LDB_SEARCH:
 553                 FIND_OP(module, search);
 554                 ret = module->ops->search(module, request);
 555                 break;
 556         case LDB_ADD:
 557                 FIND_OP(module, add);
 558                 ret = module->ops->add(module, request);
 559                 break;
 560         case LDB_MODIFY:
 561                 FIND_OP(module, modify);
 562                 ret = module->ops->modify(module, request);
 563                 break;
 564         case LDB_DELETE:
 565                 FIND_OP(module, del);
 566                 ret = module->ops->del(module, request);
 567                 break;
 568         case LDB_RENAME:
 569                 FIND_OP(module, rename);
 570                 ret = module->ops->rename(module, request);
 571                 break;
 572         case LDB_EXTENDED:
 573                 FIND_OP(module, extended);
 574                 ret = module->ops->extended(module, request);
 575                 break;
 576         default:
 577                 FIND_OP(module, request);
 578                 ret = module->ops->request(module, request);
 579                 break;
 580         }
 581
 582         request->handle->nesting--;
 583
 584         if (ret == LDB_SUCCESS) {
 585                 return ret;
 586         }
 587         if (!ldb_errstring(module->ldb)) {
 588                 /* Set a default error string, to place the blame somewhere */
 589                 ldb_asprintf_errstring(module->ldb, "error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 590         }
 591
 592         if (!(request->handle->flags & LDB_HANDLE_FLAG_DONE_CALLED)) {
 593                 /* It is _extremely_ common that a module returns a
 594                  * failure without calling ldb_module_done(), but that
 595                  * guarantees we will end up hanging in
 596                  * ldb_wait(). This fixes it without having to rewrite
 597                  * all our modules, and leaves us one less sharp
 598                  * corner for module developers to cut themselves on
 599                  */
 600                 ldb_module_done(request, NULL, NULL, ret);
 601         }
 602         return ret;
 603 }
 604
 605 int ldb_next_init(struct ldb_module *module)
 606 {
 607         module = module->next;
 608
 609         return ldb_init_module_chain(module->ldb, module);
 610 }
 611
 612 int ldb_next_start_trans(struct ldb_module *module)
 613 {
 614         FIND_OP(module, start_transaction);
 615         return module->ops->start_transaction(module);
 616 }
 617
 618 int ldb_next_end_trans(struct ldb_module *module)
 619 {
 620         FIND_OP(module, end_transaction);
 621         return module->ops->end_transaction(module);
 622 }
 623
 624 int ldb_next_prepare_commit(struct ldb_module *module)
 625 {
 626         FIND_OP_NOERR(module, prepare_commit);
 627         if (module == NULL) {
 628                 /* we are allowed to have no prepare commit in
 629                    backends */
 630                 return LDB_SUCCESS;
 631         }
 632         return module->ops->prepare_commit(module);
 633 }
 634
 635 int ldb_next_del_trans(struct ldb_module *module)
 636 {
 637         FIND_OP(module, del_transaction);
 638         return module->ops->del_transaction(module);
 639 }
 640
 641 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb)
 642 {
 643         struct ldb_handle *h;
 644
 645         h = talloc_zero(mem_ctx, struct ldb_handle);
 646         if (h == NULL) {
 647                 ldb_set_errstring(ldb, "Out of Memory");
 648                 return NULL;
 649         }
 650
 651         h->status = LDB_SUCCESS;
 652         h->state = LDB_ASYNC_INIT;
 653         h->ldb = ldb;
 654         h->flags = 0;
 655
 656         return h;
 657 }
 658
 659 /* calls the request callback to send an entry
 660  *
 661  * params:
 662  *      req: the original request passed to your module
 663  *      msg: reply message (must be a talloc pointer, and it will be stolen
 664  *           on the ldb_reply that is sent to the callback)
 665  *      ctrls: controls to send in the reply  (must be a talloc pointer, and it will be stolen
 666  *           on the ldb_reply that is sent to the callback)
 667  */
 668
 669 int ldb_module_send_entry(struct ldb_request *req,
 670                           struct ldb_message *msg,
 671                           struct ldb_control **ctrls)
 672 {
 673         struct ldb_reply *ares;
 674
 675         ares = talloc_zero(req, struct ldb_reply);
 676         if (!ares) {
 677                 ldb_oom(req->handle->ldb);
 678                 req->callback(req, NULL);
 679                 return LDB_ERR_OPERATIONS_ERROR;
 680         }
 681         ares->type = LDB_REPLY_ENTRY;
 682         ares->message = talloc_steal(ares, msg);
 683         ares->controls = talloc_steal(ares, ctrls);
 684         ares->error = LDB_SUCCESS;
 685
 686         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 687             req->handle->nesting == 0) {
 688                 char *s;
 689                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: ENTRY\n");
 690                 s = ldb_ldif_message_string(req->handle->ldb, msg, LDB_CHANGETYPE_NONE, msg);
 691                 ldb_debug_add(req->handle->ldb, "%s\n", s);
 692                 talloc_free(s);
 693                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 694         }
 695
 696         return req->callback(req, ares);
 697 }
 698
 699 /* calls the request callback to send an referrals
 700  *
 701  * params:
 702  *      req: the original request passed to your module
 703  *      ref: referral string (must be a talloc pointeri, steal)
 704  */
 705
 706 int ldb_module_send_referral(struct ldb_request *req,
 707                                            char *ref)
 708 {
 709         struct ldb_reply *ares;
 710
 711         ares = talloc_zero(req, struct ldb_reply);
 712         if (!ares) {
 713                 ldb_oom(req->handle->ldb);
 714                 req->callback(req, NULL);
 715                 return LDB_ERR_OPERATIONS_ERROR;
 716         }
 717         ares->type = LDB_REPLY_REFERRAL;
 718         ares->referral = talloc_steal(ares, ref);
 719         ares->error = LDB_SUCCESS;
 720
 721         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 722             req->handle->nesting == 0) {
 723                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: REFERRAL\n");
 724                 ldb_debug_add(req->handle->ldb, "ref: %s\n", ref);
 725                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 726         }
 727
 728         return req->callback(req, ares);
 729 }
 730
 731 /* calls the original request callback
 732  *
 733  * params:
 734  *      req:   the original request passed to your module
 735  *      ctrls: controls to send in the reply (must be a talloc pointer, steal)
 736  *      response: results for extended request (steal)
 737  *      error: LDB_SUCCESS for a succesful return
 738  *             any other ldb error otherwise
 739  */
 740 int ldb_module_done(struct ldb_request *req,
 741                     struct ldb_control **ctrls,
 742                     struct ldb_extended *response,
 743                     int error)
 744 {
 745         struct ldb_reply *ares;
 746
 747         ares = talloc_zero(req, struct ldb_reply);
 748         if (!ares) {
 749                 ldb_oom(req->handle->ldb);
 750                 req->callback(req, NULL);
 751                 return LDB_ERR_OPERATIONS_ERROR;
 752         }
 753         ares->type = LDB_REPLY_DONE;
 754         ares->controls = talloc_steal(ares, ctrls);
 755         ares->response = talloc_steal(ares, response);
 756         ares->error = error;
 757
 758         req->handle->flags |= LDB_HANDLE_FLAG_DONE_CALLED;
 759
 760         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 761             req->handle->nesting == 0) {
 762                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: DONE\n");
 763                 ldb_debug_add(req->handle->ldb, "error: %u\n", error);
 764                 if (ldb_errstring(req->handle->ldb)) {
 765                         ldb_debug_add(req->handle->ldb, "msg: %s\n",
 766                                   ldb_errstring(req->handle->ldb));
 767                 }
 768                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 769         }
 770
 771         req->callback(req, ares);
 772         return error;
 773 }
 774
 775 /* to be used *only* in modules init functions.
 776  * this function i synchronous and will register
 777  * the requested OID in the rootdse module if present
 778  * otherwise it will return an error */
 779 int ldb_mod_register_control(struct ldb_module *module, const char *oid)
 780 {
 781         struct ldb_request *req;
 782         int ret;
 783
 784         req = talloc_zero(module, struct ldb_request);
 785         if (req == NULL) {
 786                 return LDB_ERR_OPERATIONS_ERROR;
 787         }
 788
 789         req->operation = LDB_REQ_REGISTER_CONTROL;
 790         req->op.reg_control.oid = oid;
 791         req->callback = ldb_op_default_callback;
 792
 793         ldb_set_timeout(module->ldb, req, 0);
 794
 795         req->handle = ldb_handle_new(req, module->ldb);
 796         if (req->handle == NULL) {
 797                 return LDB_ERR_OPERATIONS_ERROR;
 798         }
 799
 800         ret = ldb_request(module->ldb, req);
 801         if (ret == LDB_SUCCESS) {
 802                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
 803         }
 804         talloc_free(req);
 805
 806         return ret;
 807 }
 808
 809 #ifndef STATIC_LIBLDB_MODULES
 810
 811 #ifdef HAVE_LDB_LDAP
 812 #define LDAP_BACKEND LDB_BACKEND(ldap), LDB_BACKEND(ldapi), LDB_BACKEND(ldaps),
 813 #else
 814 #define LDAP_BACKEND
 815 #endif
 816
 817 #ifdef HAVE_LDB_SQLITE3
 818 #define SQLITE3_BACKEND LDB_BACKEND(sqlite3),
 819 #else
 820 #define SQLITE3_BACKEND
 821 #endif
 822
 823 #define STATIC_LIBLDB_MODULES \
 824         LDB_BACKEND(tdb),       \
 825         LDAP_BACKEND    \
 826         SQLITE3_BACKEND \
 827         LDB_MODULE(rdn_name),   \
 828         LDB_MODULE(paged_results),      \
 829         LDB_MODULE(server_sort),                \
 830         LDB_MODULE(asq), \
 831         NULL
 832 #endif
 833
 834 /*
 835  * this is a bit hacked, as STATIC_LIBLDB_MODULES contains ','
 836  * between the elements and we want to autogenerate the
 837  * extern struct declarations, so we do some hacks and let the
 838  * ',' appear in an unused function prototype.
 839  */
 840 #undef NULL
 841 #define NULL LDB_MODULE(NULL),
 842
 843 #define LDB_BACKEND(name) \
 844         int); \
 845         extern const struct ldb_backend_ops ldb_ ## name ## _backend_ops;\
 846         extern void ldb_noop ## name (int
 847 #define LDB_MODULE(name) \
 848         int); \
 849         extern const struct ldb_module_ops ldb_ ## name ## _module_ops;\
 850         extern void ldb_noop ## name (int
 851
 852 extern void ldb_start_noop(int,
 853 STATIC_LIBLDB_MODULES
 854 int);
 855
 856 #undef NULL
 857 #define NULL { \
 858         .backend_ops = (void *)0, \
 859         .module_ops = (void *)0 \
 860 }
 861
 862 #undef LDB_BACKEND
 863 #define LDB_BACKEND(name) { \
 864         .backend_ops = &ldb_ ## name ## _backend_ops, \
 865         .module_ops = (void *)0 \
 866 }
 867 #undef LDB_MODULE
 868 #define LDB_MODULE(name) { \
 869         .backend_ops = (void *)0, \
 870         .module_ops = &ldb_ ## name ## _module_ops \
 871 }
 872
 873 static const struct ldb_builtins builtins[] = {
 874         STATIC_LIBLDB_MODULES
 875 };