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         size_t 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         unsigned 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         unsigned 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         unsigned 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 = dlsym(handle, symbol);
 322         if (sym == NULL) {
 323                 dlclose(handle);
 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         unsigned 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_string;
 402         const char **modules = NULL;
 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                 modules_string = ldb_options_find(ldb, options, "modules");
 414                 if (modules_string) {
 415                         modules = ldb_modules_list_from_string(ldb, mem_ctx, modules_string);
 416                 }
 417         }
 418
 419         /* if not overloaded by options and the backend is not ldap try to load the modules list from ldb */
 420         if ((modules == NULL) && (strcmp("ldap", ldb->modules->ops->name) != 0)) {
 421                 const char * const attrs[] = { "@LIST" , NULL};
 422                 struct ldb_result *res = NULL;
 423                 struct ldb_dn *mods_dn;
 424
 425                 mods_dn = ldb_dn_new(mem_ctx, ldb, "@MODULES");
 426                 if (mods_dn == NULL) {
 427                         talloc_free(mem_ctx);
 428                         return -1;
 429                 }
 430
 431                 ret = ldb_search(ldb, mods_dn, &res, mods_dn, LDB_SCOPE_BASE, attrs, "@LIST=*");
 432
 433                 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 434                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 435                 } else if (ret != LDB_SUCCESS) {
 436                         ldb_debug(ldb, LDB_DEBUG_FATAL, "ldb error (%s) occurred searching for modules, bailing out", ldb_errstring(ldb));
 437                         talloc_free(mem_ctx);
 438                         return ret;
 439                 } else {
 440                         const char *module_list;
 441                         if (res->count == 0) {
 442                                 ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 443                         } else if (res->count > 1) {
 444                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Too many records found (%d), bailing out", res->count);
 445                                 talloc_free(mem_ctx);
 446                                 return -1;
 447                         } else {
 448                                 module_list = ldb_msg_find_attr_as_string(res->msgs[0], "@LIST", NULL);
 449                                 if (!module_list) {
 450                                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db");
 451                                 }
 452                                 modules = ldb_modules_list_from_string(ldb, mem_ctx,
 453                                                                module_list);
 454                         }
 455                 }
 456
 457                 talloc_free(mods_dn);
 458         }
 459
 460         if (modules != NULL) {
 461                 ret = ldb_load_modules_list(ldb, modules, ldb->modules, &ldb->modules);
 462                 if (ret != LDB_SUCCESS) {
 463                         talloc_free(mem_ctx);
 464                         return ret;
 465                 }
 466         } else {
 467                 ldb_debug(ldb, LDB_DEBUG_TRACE, "No modules specified for this database");
 468         }
 469
 470         ret = ldb_init_module_chain(ldb, ldb->modules);
 471         talloc_free(mem_ctx);
 472         return ret;
 473 }
 474
 475 /*
 476   by using this we allow ldb modules to only implement the functions they care about,
 477   which makes writing a module simpler, and makes it more likely to keep working
 478   when ldb is extended
 479 */
 480 #define FIND_OP_NOERR(module, op) do { \
 481         module = module->next; \
 482         while (module && module->ops->op == NULL) module = module->next; \
 483         if ((module && module->ldb->flags & LDB_FLG_ENABLE_TRACING)) { \
 484                 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "ldb_trace_next_request: (%s)->" #op, \
 485                           module->ops->name);                           \
 486         }                                                               \
 487 } while (0)
 488
 489 #define FIND_OP(module, op) do { \
 490         struct ldb_context *ldb = module->ldb; \
 491         FIND_OP_NOERR(module, op); \
 492         if (module == NULL) { \
 493                 ldb_asprintf_errstring(ldb, "Unable to find backend operation for " #op ); \
 494                 return LDB_ERR_OPERATIONS_ERROR;        \
 495         }                                               \
 496 } while (0)
 497
 498
 499 struct ldb_module *ldb_module_new(TALLOC_CTX *memctx,
 500                                   struct ldb_context *ldb,
 501                                   const char *module_name,
 502                                   const struct ldb_module_ops *ops)
 503 {
 504         struct ldb_module *module;
 505
 506         module = talloc(memctx, struct ldb_module);
 507         if (!module) {
 508                 ldb_oom(ldb);
 509                 return NULL;
 510         }
 511         talloc_set_name_const(module, module_name);
 512         module->ldb = ldb;
 513         module->prev = module->next = NULL;
 514         module->ops = ops;
 515
 516         return module;
 517 }
 518
 519 const char * ldb_module_get_name(struct ldb_module *module)
 520 {
 521         return module->ops->name;
 522 }
 523
 524 struct ldb_context *ldb_module_get_ctx(struct ldb_module *module)
 525 {
 526         return module->ldb;
 527 }
 528
 529 const struct ldb_module_ops *ldb_module_get_ops(struct ldb_module *module)
 530 {
 531         return module->ops;
 532 }
 533
 534 void *ldb_module_get_private(struct ldb_module *module)
 535 {
 536         return module->private_data;
 537 }
 538
 539 void ldb_module_set_private(struct ldb_module *module, void *private_data)
 540 {
 541         module->private_data = private_data;
 542 }
 543
 544 /*
 545    helper functions to call the next module in chain
 546 */
 547
 548 int ldb_next_request(struct ldb_module *module, struct ldb_request *request)
 549 {
 550         int ret;
 551
 552         if (request->callback == NULL) {
 553                 ldb_set_errstring(module->ldb, "Requests MUST define callbacks");
 554                 return LDB_ERR_UNWILLING_TO_PERFORM;
 555         }
 556
 557         request->handle->nesting++;
 558
 559         switch (request->operation) {
 560         case LDB_SEARCH:
 561                 FIND_OP(module, search);
 562                 ret = module->ops->search(module, request);
 563                 break;
 564         case LDB_ADD:
 565                 FIND_OP(module, add);
 566                 ret = module->ops->add(module, request);
 567                 break;
 568         case LDB_MODIFY:
 569                 FIND_OP(module, modify);
 570                 ret = module->ops->modify(module, request);
 571                 break;
 572         case LDB_DELETE:
 573                 FIND_OP(module, del);
 574                 ret = module->ops->del(module, request);
 575                 break;
 576         case LDB_RENAME:
 577                 FIND_OP(module, rename);
 578                 ret = module->ops->rename(module, request);
 579                 break;
 580         case LDB_EXTENDED:
 581                 FIND_OP(module, extended);
 582                 ret = module->ops->extended(module, request);
 583                 break;
 584         default:
 585                 FIND_OP(module, request);
 586                 ret = module->ops->request(module, request);
 587                 break;
 588         }
 589
 590         request->handle->nesting--;
 591
 592         if (ret == LDB_SUCCESS) {
 593                 return ret;
 594         }
 595         if (!ldb_errstring(module->ldb)) {
 596                 /* Set a default error string, to place the blame somewhere */
 597                 ldb_asprintf_errstring(module->ldb, "error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 598         }
 599
 600         if (!(request->handle->flags & LDB_HANDLE_FLAG_DONE_CALLED)) {
 601                 /* It is _extremely_ common that a module returns a
 602                  * failure without calling ldb_module_done(), but that
 603                  * guarantees we will end up hanging in
 604                  * ldb_wait(). This fixes it without having to rewrite
 605                  * all our modules, and leaves us one less sharp
 606                  * corner for module developers to cut themselves on
 607                  */
 608                 ret = ldb_module_done(request, NULL, NULL, ret);
 609         }
 610         return ret;
 611 }
 612
 613 int ldb_next_init(struct ldb_module *module)
 614 {
 615         module = module->next;
 616
 617         return ldb_init_module_chain(module->ldb, module);
 618 }
 619
 620 int ldb_next_start_trans(struct ldb_module *module)
 621 {
 622         int ret;
 623         FIND_OP(module, start_transaction);
 624         ret = module->ops->start_transaction(module);
 625         if (ret == LDB_SUCCESS) {
 626                 return ret;
 627         }
 628         if (!ldb_errstring(module->ldb)) {
 629                 /* Set a default error string, to place the blame somewhere */
 630                 ldb_asprintf_errstring(module->ldb, "start_trans error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 631         }
 632         if ((module && module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
 633                 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "ldb_next_start_trans error: %s",
 634                           ldb_errstring(module->ldb));
 635         }
 636         return ret;
 637 }
 638
 639 int ldb_next_end_trans(struct ldb_module *module)
 640 {
 641         int ret;
 642         FIND_OP(module, end_transaction);
 643         ret = module->ops->end_transaction(module);
 644         if (ret == LDB_SUCCESS) {
 645                 return ret;
 646         }
 647         if (!ldb_errstring(module->ldb)) {
 648                 /* Set a default error string, to place the blame somewhere */
 649                 ldb_asprintf_errstring(module->ldb, "end_trans error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 650         }
 651         if ((module && module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
 652                 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "ldb_next_end_trans error: %s",
 653                           ldb_errstring(module->ldb));
 654         }
 655         return ret;
 656 }
 657
 658 int ldb_next_prepare_commit(struct ldb_module *module)
 659 {
 660         int ret;
 661         FIND_OP_NOERR(module, prepare_commit);
 662         if (module == NULL) {
 663                 /* we are allowed to have no prepare commit in
 664                    backends */
 665                 return LDB_SUCCESS;
 666         }
 667         ret = module->ops->prepare_commit(module);
 668         if (ret == LDB_SUCCESS) {
 669                 return ret;
 670         }
 671         if (!ldb_errstring(module->ldb)) {
 672                 /* Set a default error string, to place the blame somewhere */
 673                 ldb_asprintf_errstring(module->ldb, "prepare_commit error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 674         }
 675         if ((module && module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
 676                 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "ldb_next_prepare_commit error: %s",
 677                           ldb_errstring(module->ldb));
 678         }
 679         return ret;
 680 }
 681
 682 int ldb_next_del_trans(struct ldb_module *module)
 683 {
 684         int ret;
 685         FIND_OP(module, del_transaction);
 686         ret = module->ops->del_transaction(module);
 687         if (ret == LDB_SUCCESS) {
 688                 return ret;
 689         }
 690         if (!ldb_errstring(module->ldb)) {
 691                 /* Set a default error string, to place the blame somewhere */
 692                 ldb_asprintf_errstring(module->ldb, "del_trans error in module %s: %s (%d)", module->ops->name, ldb_strerror(ret), ret);
 693         }
 694         if ((module && module->ldb->flags & LDB_FLG_ENABLE_TRACING)) {
 695                 ldb_debug(module->ldb, LDB_DEBUG_TRACE, "ldb_next_del_trans error: %s",
 696                           ldb_errstring(module->ldb));
 697         }
 698         return ret;
 699 }
 700
 701 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb)
 702 {
 703         struct ldb_handle *h;
 704
 705         h = talloc_zero(mem_ctx, struct ldb_handle);
 706         if (h == NULL) {
 707                 ldb_set_errstring(ldb, "Out of Memory");
 708                 return NULL;
 709         }
 710
 711         h->status = LDB_SUCCESS;
 712         h->state = LDB_ASYNC_INIT;
 713         h->ldb = ldb;
 714         h->flags = 0;
 715         h->location = NULL;
 716         h->parent = NULL;
 717
 718         return h;
 719 }
 720
 721 /* calls the request callback to send an entry
 722  *
 723  * params:
 724  *      req: the original request passed to your module
 725  *      msg: reply message (must be a talloc pointer, and it will be stolen
 726  *           on the ldb_reply that is sent to the callback)
 727  *      ctrls: controls to send in the reply  (must be a talloc pointer, and it will be stolen
 728  *           on the ldb_reply that is sent to the callback)
 729  */
 730
 731 int ldb_module_send_entry(struct ldb_request *req,
 732                           struct ldb_message *msg,
 733                           struct ldb_control **ctrls)
 734 {
 735         struct ldb_reply *ares;
 736
 737         ares = talloc_zero(req, struct ldb_reply);
 738         if (!ares) {
 739                 ldb_oom(req->handle->ldb);
 740                 req->callback(req, NULL);
 741                 return LDB_ERR_OPERATIONS_ERROR;
 742         }
 743         ares->type = LDB_REPLY_ENTRY;
 744         ares->message = talloc_steal(ares, msg);
 745         ares->controls = talloc_steal(ares, ctrls);
 746         ares->error = LDB_SUCCESS;
 747
 748         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 749             req->handle->nesting == 0) {
 750                 char *s;
 751                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: ENTRY\n");
 752                 s = ldb_ldif_message_string(req->handle->ldb, msg, LDB_CHANGETYPE_NONE, msg);
 753                 ldb_debug_add(req->handle->ldb, "%s\n", s);
 754                 talloc_free(s);
 755                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 756         }
 757
 758         return req->callback(req, ares);
 759 }
 760
 761 /* calls the request callback to send an referrals
 762  *
 763  * params:
 764  *      req: the original request passed to your module
 765  *      ref: referral string (must be a talloc pointeri, steal)
 766  */
 767
 768 int ldb_module_send_referral(struct ldb_request *req,
 769                                            char *ref)
 770 {
 771         struct ldb_reply *ares;
 772
 773         ares = talloc_zero(req, struct ldb_reply);
 774         if (!ares) {
 775                 ldb_oom(req->handle->ldb);
 776                 req->callback(req, NULL);
 777                 return LDB_ERR_OPERATIONS_ERROR;
 778         }
 779         ares->type = LDB_REPLY_REFERRAL;
 780         ares->referral = talloc_steal(ares, ref);
 781         ares->error = LDB_SUCCESS;
 782
 783         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 784             req->handle->nesting == 0) {
 785                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: REFERRAL\n");
 786                 ldb_debug_add(req->handle->ldb, "ref: %s\n", ref);
 787                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 788         }
 789
 790         return req->callback(req, ares);
 791 }
 792
 793 /* calls the original request callback
 794  *
 795  * params:
 796  *      req:   the original request passed to your module
 797  *      ctrls: controls to send in the reply (must be a talloc pointer, steal)
 798  *      response: results for extended request (steal)
 799  *      error: LDB_SUCCESS for a successful return
 800  *             any other ldb error otherwise
 801  */
 802 int ldb_module_done(struct ldb_request *req,
 803                     struct ldb_control **ctrls,
 804                     struct ldb_extended *response,
 805                     int error)
 806 {
 807         struct ldb_reply *ares;
 808
 809         ares = talloc_zero(req, struct ldb_reply);
 810         if (!ares) {
 811                 ldb_oom(req->handle->ldb);
 812                 req->callback(req, NULL);
 813                 return LDB_ERR_OPERATIONS_ERROR;
 814         }
 815         ares->type = LDB_REPLY_DONE;
 816         ares->controls = talloc_steal(ares, ctrls);
 817         ares->response = talloc_steal(ares, response);
 818         ares->error = error;
 819
 820         req->handle->flags |= LDB_HANDLE_FLAG_DONE_CALLED;
 821
 822         if ((req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) &&
 823             req->handle->nesting == 0) {
 824                 ldb_debug_add(req->handle->ldb, "ldb_trace_response: DONE\n");
 825                 ldb_debug_add(req->handle->ldb, "error: %u\n", error);
 826                 if (ldb_errstring(req->handle->ldb)) {
 827                         ldb_debug_add(req->handle->ldb, "msg: %s\n",
 828                                   ldb_errstring(req->handle->ldb));
 829                 }
 830                 ldb_debug_end(req->handle->ldb, LDB_DEBUG_TRACE);
 831         }
 832
 833         return req->callback(req, ares);
 834 }
 835
 836 /* to be used *only* in modules init functions.
 837  * this function is synchronous and will register
 838  * the requested OID in the rootdse module if present
 839  * otherwise it will return an error */
 840 int ldb_mod_register_control(struct ldb_module *module, const char *oid)
 841 {
 842         struct ldb_request *req;
 843         int ret;
 844
 845         req = talloc_zero(module, struct ldb_request);
 846         if (req == NULL) {
 847                 return LDB_ERR_OPERATIONS_ERROR;
 848         }
 849
 850         req->operation = LDB_REQ_REGISTER_CONTROL;
 851         req->op.reg_control.oid = oid;
 852         req->callback = ldb_op_default_callback;
 853
 854         ldb_set_timeout(module->ldb, req, 0);
 855
 856         req->handle = ldb_handle_new(req, module->ldb);
 857         if (req->handle == NULL) {
 858                 return LDB_ERR_OPERATIONS_ERROR;
 859         }
 860
 861         ret = ldb_request(module->ldb, req);
 862         if (ret == LDB_SUCCESS) {
 863                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
 864         }
 865         talloc_free(req);
 866
 867         return ret;
 868 }
 869
 870 #ifdef STATIC_ldb_MODULES
 871 #define STATIC_LIBLDB_MODULES STATIC_ldb_MODULES
 872 #endif
 873
 874 #ifndef STATIC_LIBLDB_MODULES
 875
 876 #ifdef HAVE_LDB_LDAP
 877 #define LDAP_BACKEND LDB_BACKEND(ldap), LDB_BACKEND(ldapi), LDB_BACKEND(ldaps),
 878 #else
 879 #define LDAP_BACKEND
 880 #endif
 881
 882 #ifdef HAVE_LDB_SQLITE3
 883 #define SQLITE3_BACKEND LDB_BACKEND(sqlite3),
 884 #else
 885 #define SQLITE3_BACKEND
 886 #endif
 887
 888 #define STATIC_LIBLDB_MODULES \
 889         LDB_BACKEND(tdb),       \
 890         LDAP_BACKEND    \
 891         SQLITE3_BACKEND \
 892         LDB_MODULE(rdn_name),   \
 893         LDB_MODULE(paged_results),      \
 894         LDB_MODULE(server_sort),                \
 895         LDB_MODULE(asq), \
 896         NULL
 897 #endif
 898
 899 /*
 900  * this is a bit hacked, as STATIC_LIBLDB_MODULES contains ','
 901  * between the elements and we want to autogenerate the
 902  * extern struct declarations, so we do some hacks and let the
 903  * ',' appear in an unused function prototype.
 904  */
 905 #undef NULL
 906 #define NULL LDB_MODULE(NULL),
 907
 908 #define LDB_BACKEND(name) \
 909         int); \
 910         extern const struct ldb_backend_ops ldb_ ## name ## _backend_ops;\
 911         extern void ldb_noop ## name (int
 912 #define LDB_MODULE(name) \
 913         int); \
 914         extern const struct ldb_module_ops ldb_ ## name ## _module_ops;\
 915         extern void ldb_noop ## name (int
 916
 917 extern void ldb_start_noop(int,
 918 STATIC_LIBLDB_MODULES
 919 int);
 920
 921 #undef NULL
 922 #define NULL { \
 923         .backend_ops = (void *)0, \
 924         .module_ops = (void *)0 \
 925 }
 926
 927 #undef LDB_BACKEND
 928 #define LDB_BACKEND(name) { \
 929         .backend_ops = &ldb_ ## name ## _backend_ops, \
 930         .module_ops = (void *)0 \
 931 }
 932 #undef LDB_MODULE
 933 #define LDB_MODULE(name) { \
 934         .backend_ops = (void *)0, \
 935         .module_ops = &ldb_ ## name ## _module_ops \
 936 }
 937
 938 static const struct ldb_builtins builtins[] = {
 939         STATIC_LIBLDB_MODULES
 940 };