source4/lib/ldb/common/ldb_modules.c

   1
   2 /*
   3    ldb database library
   4
   5    Copyright (C) Simo Sorce  2004
   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 2 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, write to the Free Software
  23    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb modules core
  30  *
  31  *  Description: core modules routines
  32  *
  33  *  Author: Simo Sorce
  34  */
  35
  36 #include "includes.h"
  37 #include "ldb/include/includes.h"
  38
  39 #ifdef _SAMBA_BUILD_
  40 #include "build.h"
  41 #include "dynconfig.h"
  42 #endif
  43
  44 #define LDB_MODULE_PREFIX       "modules:"
  45 #define LDB_MODULE_PREFIX_LEN   8
  46
  47 static char *talloc_strdup_no_spaces(struct ldb_context *ldb, const char *string)
  48 {
  49         int i, len;
  50         char *trimmed;
  51
  52         trimmed = talloc_strdup(ldb, string);
  53         if (!trimmed) {
  54                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in talloc_strdup_trim_spaces()\n");
  55                 return NULL;
  56         }
  57
  58         len = strlen(trimmed);
  59         for (i = 0; trimmed[i] != '\0'; i++) {
  60                 switch (trimmed[i]) {
  61                 case ' ':
  62                 case '\t':
  63                 case '\n':
  64                         memmove(&trimmed[i], &trimmed[i + 1], len -i -1);
  65                         break;
  66                 }
  67         }
  68
  69         return trimmed;
  70 }
  71
  72
  73 /* modules are called in inverse order on the stack.
  74    Lets place them as an admin would think the right order is.
  75    Modules order is important */
  76 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string)
  77 {
  78         char **modules = NULL;
  79         const char **m;
  80         char *modstr, *p;
  81         int i;
  82
  83         /* spaces not admitted */
  84         modstr = talloc_strdup_no_spaces(mem_ctx, string);
  85         if ( ! modstr) {
  86                 return NULL;
  87         }
  88
  89         modules = talloc_realloc(mem_ctx, modules, char *, 2);
  90         if ( ! modules ) {
  91                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
  92                 talloc_free(modstr);
  93                 return NULL;
  94         }
  95         talloc_steal(modules, modstr);
  96
  97         i = 0;
  98         /* The str*r*chr walks backwards:  This is how we get the inverse order mentioned above */
  99         while ((p = strrchr(modstr, ',')) != NULL) {
 100                 *p = '\0';
 101                 p++;
 102                 modules[i] = p;
 103
 104                 i++;
 105                 modules = talloc_realloc(mem_ctx, modules, char *, i + 2);
 106                 if ( ! modules ) {
 107                         ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
 108                         return NULL;
 109                 }
 110
 111         }
 112         modules[i] = modstr;
 113
 114         modules[i + 1] = NULL;
 115
 116         m = (const char **)modules;
 117
 118         return m;
 119 }
 120
 121 static struct ops_list_entry {
 122         const struct ldb_module_ops *ops;
 123         struct ops_list_entry *next;
 124 } *registered_modules = NULL;
 125
 126 static const struct ldb_module_ops *ldb_find_module_ops(const char *name)
 127 {
 128         struct ops_list_entry *e;
 129
 130         for (e = registered_modules; e; e = e->next) {
 131                 if (strcmp(e->ops->name, name) == 0)
 132                         return e->ops;
 133         }
 134
 135         return NULL;
 136 }
 137
 138 #ifndef STATIC_ldb_MODULES
 139
 140 #ifdef HAVE_LDAP
 141 #define LDAP_INIT ldb_ldap_init,
 142 #else
 143 #define LDAP_INIT
 144 #endif
 145
 146 #ifdef HAVE_SQLITE3
 147 #define SQLITE3_INIT ldb_sqlite3_init,
 148 #else
 149 #define SQLITE3_INIT
 150 #endif
 151
 152 #define STATIC_ldb_MODULES \
 153         {       \
 154                 LDAP_INIT \
 155                 SQLITE3_INIT \
 156                 ldb_tdb_init,   \
 157                 ldb_schema_init,        \
 158                 ldb_operational_init,   \
 159                 ldb_rdn_name_init,      \
 160                 ldb_objectclass_init,   \
 161                 ldb_paged_results_init, \
 162                 ldb_sort_init,          \
 163                 NULL                    \
 164         }
 165 #endif
 166
 167 int ldb_global_init(void)
 168 {
 169         static int (*static_init_fns[])(void) = STATIC_ldb_MODULES;
 170
 171         static int initialized = 0;
 172         int ret = 0, i;
 173
 174         if (initialized)
 175                 return 0;
 176
 177         initialized = 1;
 178
 179         for (i = 0; static_init_fns[i]; i++) {
 180                 if (static_init_fns[i]() == -1)
 181                         ret = -1;
 182         }
 183
 184         return ret;
 185 }
 186
 187 int ldb_register_module(const struct ldb_module_ops *ops)
 188 {
 189         struct ops_list_entry *entry = talloc(talloc_autofree_context(), struct ops_list_entry);
 190
 191         if (ldb_find_module_ops(ops->name) != NULL)
 192                 return -1;
 193
 194         if (entry == NULL)
 195                 return -1;
 196
 197         entry->ops = ops;
 198         entry->next = registered_modules;
 199         registered_modules = entry;
 200
 201         return 0;
 202 }
 203
 204 int ldb_try_load_dso(struct ldb_context *ldb, const char *name)
 205 {
 206         char *path;
 207         void *handle;
 208         int (*init_fn) (void);
 209
 210 #ifdef HAVE_DLOPEN
 211 #ifdef _SAMBA_BUILD_
 212         path = talloc_asprintf(ldb, "%s/ldb/%s.%s", dyn_MODULESDIR, name, dyn_SHLIBEXT);
 213 #else
 214         path = talloc_asprintf(ldb, "%s/%s.%s", MODULESDIR, name, SHLIBEXT);
 215 #endif
 216
 217         ldb_debug(ldb, LDB_DEBUG_TRACE, "trying to load %s from %s\n", name, path);
 218
 219         handle = dlopen(path, 0);
 220         if (handle == NULL) {
 221                 ldb_debug(ldb, LDB_DEBUG_WARNING, "unable to load %s from %s: %s\n", name, path, dlerror());
 222                 return -1;
 223         }
 224
 225         init_fn = (int (*)(void))dlsym(handle, "init_module");
 226
 227         if (init_fn == NULL) {
 228                 ldb_debug(ldb, LDB_DEBUG_ERROR, "no symbol `init_module' found in %s: %s\n", path, dlerror());
 229                 return -1;
 230         }
 231
 232         talloc_free(path);
 233
 234         return init_fn();
 235 #else
 236         ldb_debug(ldb, LDB_DEBUG_TRACE, "no dlopen() - not trying to load %s module\n", name);
 237         return -1;
 238 #endif
 239 }
 240
 241 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out)
 242 {
 243         struct ldb_module *module;
 244         int i;
 245
 246         module = backend;
 247
 248         for (i = 0; module_list[i] != NULL; i++) {
 249                 struct ldb_module *current;
 250                 const struct ldb_module_ops *ops;
 251
 252                 ops = ldb_find_module_ops(module_list[i]);
 253                 if (ops == NULL) {
 254                         if (ldb_try_load_dso(ldb, module_list[i]) == 0) {
 255                                 ops = ldb_find_module_ops(module_list[i]);
 256                         }
 257                 }
 258
 259                 if (ops == NULL) {
 260                         ldb_debug(ldb, LDB_DEBUG_WARNING, "WARNING: Module [%s] not found\n",
 261                                   module_list[i]);
 262                         continue;
 263                 }
 264
 265                 current = talloc_zero(ldb, struct ldb_module);
 266                 if (current == NULL) {
 267                         return LDB_ERR_OPERATIONS_ERROR;
 268                 }
 269
 270                 current->ldb = ldb;
 271                 current->ops = ops;
 272
 273                 DLIST_ADD(module, current);
 274         }
 275         *out = module;
 276         return LDB_SUCCESS;
 277 }
 278
 279 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module)
 280 {
 281         while (module && module->ops->init_context == NULL)
 282                 module = module->next;
 283
 284         if (module && module->ops->init_context &&
 285                 module->ops->init_context(module) != LDB_SUCCESS) {
 286                 ldb_debug(ldb, LDB_DEBUG_FATAL, "module initialization failed\n");
 287                 return LDB_ERR_OPERATIONS_ERROR;
 288         }
 289
 290         return LDB_SUCCESS;
 291 }
 292
 293 int ldb_load_modules(struct ldb_context *ldb, const char *options[])
 294 {
 295         const char **modules = NULL;
 296         int i;
 297         int ret;
 298         TALLOC_CTX *mem_ctx = talloc_new(ldb);
 299         if (!mem_ctx) {
 300                 return LDB_ERR_OPERATIONS_ERROR;
 301         }
 302
 303         /* find out which modules we are requested to activate */
 304
 305         /* check if we have a custom module list passd as ldb option */
 306         if (options) {
 307                 for (i = 0; options[i] != NULL; i++) {
 308                         if (strncmp(options[i], LDB_MODULE_PREFIX, LDB_MODULE_PREFIX_LEN) == 0) {
 309                                 modules = ldb_modules_list_from_string(ldb, mem_ctx, &options[i][LDB_MODULE_PREFIX_LEN]);
 310                         }
 311                 }
 312         }
 313
 314         /* if not overloaded by options and the backend is not ldap try to load the modules list from ldb */
 315         if ((modules == NULL) && (strcmp("ldap", ldb->modules->ops->name) != 0)) {
 316                 const char * const attrs[] = { "@LIST" , NULL};
 317                 struct ldb_result *res = NULL;
 318                 struct ldb_dn *mods_dn;
 319
 320                 mods_dn = ldb_dn_explode(mem_ctx, "@MODULES");
 321                 if (mods_dn == NULL) {
 322                         talloc_free(mem_ctx);
 323                         return -1;
 324                 }
 325
 326                 ret = ldb_search(ldb, mods_dn, LDB_SCOPE_BASE, "", attrs, &res);
 327                 if (res) talloc_steal(mods_dn, res);
 328                 if (ret == LDB_SUCCESS && (res->count == 0 || res->msgs[0]->num_elements == 0)) {
 329                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db\n");
 330                 } else {
 331                         if (ret != LDB_SUCCESS) {
 332                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldb error (%s) occurred searching for modules, bailing out\n", ldb_errstring(ldb));
 333                                 talloc_free(mem_ctx);
 334                                 return -1;
 335                         }
 336                         if (res->count > 1) {
 337                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Too many records found (%d), bailing out\n", res->count);
 338                                 talloc_free(mem_ctx);
 339                                 return -1;
 340                         }
 341
 342                         modules = ldb_modules_list_from_string(ldb, mem_ctx,
 343                                                                (const char *)res->msgs[0]->elements[0].values[0].data);
 344
 345                 }
 346
 347                 talloc_free(mods_dn);
 348         }
 349
 350         if (modules != NULL) {
 351                 ret = ldb_load_modules_list(ldb, modules, ldb->modules, &ldb->modules);
 352                 talloc_free(modules);
 353                 if (ret != LDB_SUCCESS) {
 354                         return ret;
 355                 }
 356         } else {
 357                 ldb_debug(ldb, LDB_DEBUG_TRACE, "No modules specified for this database\n");
 358         }
 359
 360         return ldb_init_module_chain(ldb, ldb->modules);
 361 }
 362
 363 /*
 364   by using this we allow ldb modules to only implement the functions they care about,
 365   which makes writing a module simpler, and makes it more likely to keep working
 366   when ldb is extended
 367 */
 368 #define FIND_OP(module, op) do { \
 369         struct ldb_context *ldb = module->ldb; \
 370         module = module->next; \
 371         while (module && module->ops->op == NULL) module = module->next; \
 372         if (module == NULL) { \
 373                 ldb_asprintf_errstring(ldb, "Unable to find backend operation for " #op ); \
 374                 return LDB_ERR_OPERATIONS_ERROR;        \
 375         }                                               \
 376 } while (0)
 377
 378
 379 /*
 380    helper functions to call the next module in chain
 381 */
 382
 383 int ldb_next_request(struct ldb_module *module, struct ldb_request *request)
 384 {
 385         switch (request->operation) {
 386         case LDB_SEARCH:
 387                 FIND_OP(module, search);
 388                 return module->ops->search(module, request);
 389         case LDB_ADD:
 390                 FIND_OP(module, add);
 391                 return module->ops->add(module, request);
 392         case LDB_MODIFY:
 393                 FIND_OP(module, modify);
 394                 return module->ops->modify(module, request);
 395         case LDB_DELETE:
 396                 FIND_OP(module, del);
 397                 return module->ops->del(module, request);
 398         case LDB_RENAME:
 399                 FIND_OP(module, rename);
 400                 return module->ops->rename(module, request);
 401         case LDB_SEQUENCE_NUMBER:
 402                 FIND_OP(module, sequence_number);
 403                 return module->ops->sequence_number(module, request);
 404         default:
 405                 FIND_OP(module, request);
 406                 return module->ops->request(module, request);
 407         }
 408 }
 409
 410 int ldb_next_init(struct ldb_module *module)
 411 {
 412         /* init is different in that it is not an error if modules
 413          * do not require initialization */
 414
 415         module = module->next;
 416
 417         while (module && module->ops->init_context == NULL)
 418                 module = module->next;
 419
 420         if (module == NULL)
 421                 return LDB_SUCCESS;
 422
 423         return module->ops->init_context(module);
 424 }
 425
 426 int ldb_next_start_trans(struct ldb_module *module)
 427 {
 428         FIND_OP(module, start_transaction);
 429         return module->ops->start_transaction(module);
 430 }
 431
 432 int ldb_next_end_trans(struct ldb_module *module)
 433 {
 434         FIND_OP(module, end_transaction);
 435         return module->ops->end_transaction(module);
 436 }
 437
 438 int ldb_next_del_trans(struct ldb_module *module)
 439 {
 440         FIND_OP(module, del_transaction);
 441         return module->ops->del_transaction(module);
 442 }