r8669: The objectguid module belongs in Samba's ldb module collection, not in
[sfrench/samba-autobuild/.git] / 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/ldb.h"
38 #include "ldb/include/ldb_private.h"
39 #include "dlinklist.h"
40 #include <sys/types.h> 
41 #include <sys/stat.h> 
42 #include <unistd.h> 
43
44 #ifdef HAVE_DLOPEN_DISABLED
45 #include <dlfcn.h>
46 #endif
47
48 #define LDB_MODULE_PREFIX       "modules:"
49 #define LDB_MODULE_PREFIX_LEN   8
50
51 static char *talloc_strdup_no_spaces(struct ldb_context *ldb, const char *string)
52 {
53         int i, len;
54         char *trimmed;
55
56         trimmed = talloc_strdup(ldb, string);
57         if (!trimmed) {
58                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in talloc_strdup_trim_spaces()\n");
59                 return NULL;
60         }
61
62         len = strlen(trimmed);
63         for (i = 0; trimmed[i] != '\0'; i++) {
64                 switch (trimmed[i]) {
65                 case ' ':
66                 case '\t':
67                 case '\n':
68                         memmove(&trimmed[i], &trimmed[i + 1], len -i -1);
69                         break;
70                 }
71         }
72
73         return trimmed;
74 }
75
76
77 /* modules are called in inverse order on the stack.
78    Lets place them as an admin would think the right order is.
79    Modules order is imprtant */
80 static char **ldb_modules_list_from_string(struct ldb_context *ldb, const char *string)
81 {
82         char **modules = NULL;
83         char *modstr, *p;
84         int i;
85
86         /* spaces not admitted */
87         modstr = talloc_strdup_no_spaces(ldb, string);
88         if ( ! modstr) {
89                 return NULL;
90         }
91
92         modules = talloc_realloc(ldb, modules, char *, 2);
93         if ( ! modules ) {
94                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
95                 talloc_free(modstr);
96                 return NULL;
97         }
98         talloc_steal(modules, modstr);
99
100         i = 0;
101         while ((p = strrchr(modstr, ',')) != NULL) {
102                 *p = '\0';
103                 p++;
104                 modules[i] = p;
105
106                 i++;
107                 modules = talloc_realloc(ldb, modules, char *, i + 2);
108                 if ( ! modules ) {
109                         ldb_debug(ldb, LDB_DEBUG_FATAL, "Out of Memory in ldb_modules_list_from_string()\n");
110                         return NULL;
111                 }
112
113         }
114         modules[i] = modstr;
115
116         modules[i + 1] = NULL;
117
118         return modules;
119 }
120
121 int ldb_load_modules(struct ldb_context *ldb, const char *options[])
122 {
123         char **modules = NULL;
124         int i;
125
126         /* find out which modules we are requested to activate */
127
128         /* check if we have a custom module list passd as ldb option */
129         if (options) {
130                 for (i = 0; options[i] != NULL; i++) {
131                         if (strncmp(options[i], LDB_MODULE_PREFIX, LDB_MODULE_PREFIX_LEN) == 0) {
132                                 modules = ldb_modules_list_from_string(ldb, &options[i][LDB_MODULE_PREFIX_LEN]);
133                         }
134                 }
135         }
136
137         /* if not overloaded by options and the backend is not ldap try to load the modules list form ldb */
138         if ((modules == NULL) && (strcmp("ldap", ldb->modules->ops->name) != 0)) { 
139                 int ret;
140                 const char * const attrs[] = { "@LIST" , NULL};
141                 struct ldb_message **msg = NULL;
142
143                 ret = ldb_search(ldb, "@MODULES", LDB_SCOPE_BASE, "", attrs, &msg);
144                 if (ret == 0 || (ret == 1 && msg[0]->num_elements == 0)) {
145                         ldb_debug(ldb, LDB_DEBUG_TRACE, "no modules required by the db\n");
146                 } else {
147                         if (ret < 0) {
148                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "ldb error (%s) occurred searching for modules, bailing out\n", ldb_errstring(ldb));
149                                 return -1;
150                         }
151                         if (ret > 1) {
152                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "Too many records found, bailing out\n");
153                                 talloc_free(msg);
154                                 return -1;
155                         }
156
157                         modules = ldb_modules_list_from_string(ldb, msg[0]->elements[0].values[0].data);
158
159                 }
160
161                 talloc_free(msg);
162         }
163
164         if (modules == NULL) {
165                 ldb_debug(ldb, LDB_DEBUG_TRACE, "No modules specified for this database\n");
166                 return 0;
167         }
168
169         for (i = 0; modules[i] != NULL; i++) {
170                 struct ldb_module *current;
171
172                 if (strcmp(modules[i], "schema") == 0) {
173                         current = schema_module_init(ldb, options);
174                         if (!current) {
175                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "function 'init_module' in %s fails\n", modules[i]);
176                                 return -1;
177                         }
178                         DLIST_ADD(ldb->modules, current);
179                         continue;
180                 }
181
182                 if (strcmp(modules[i], "timestamps") == 0) {
183                         current = timestamps_module_init(ldb, options);
184                         if (!current) {
185                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "function 'init_module' in %s fails\n", modules[i]);
186                                 return -1;
187                         }
188                         DLIST_ADD(ldb->modules, current);
189                         continue;
190                 }
191
192                 if (strcmp(modules[i], "rdn_name") == 0) {
193                         current = rdn_name_module_init(ldb, options);
194                         if (!current) {
195                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "function 'init_module' in %s fails\n", modules[i]);
196                                 return -1;
197                         }
198                         DLIST_ADD(ldb->modules, current);
199                         continue;
200                 }
201
202 #ifdef _SAMBA_BUILD_
203                 if (strcmp(modules[i], "objectguid") == 0) {
204                         current = objectguid_module_init(ldb, options);
205                         if (!current) {
206                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "function 'init_module' in %s fails\n", modules[i]);
207                                 return -1;
208                         }
209                         DLIST_ADD(ldb->modules, current);
210                         continue;
211                 }
212
213                 if (strcmp(modules[i], "samldb") == 0) {
214                         current = samldb_module_init(ldb, options);
215                         if (!current) {
216                                 ldb_debug(ldb, LDB_DEBUG_FATAL, "function 'init_module' in %s fails\n", modules[i]);
217                                 return -1;
218                         }
219                         DLIST_ADD(ldb->modules, current);
220                         continue;
221                 }
222 #endif
223
224                 ldb_debug(ldb, LDB_DEBUG_WARNING, "WARNING: Module [%s] not found\n", modules[i]);
225         }
226
227         talloc_free(modules);
228         return 0; 
229 }
230
231 /*
232    helper functions to call the next module in chain
233 */
234
235 int ldb_next_search(struct ldb_module *module, 
236                     const char *base,
237                     enum ldb_scope scope,
238                     const char *expression,
239                     const char * const *attrs, struct ldb_message ***res)
240 {
241         if (!module->next) {
242                 return -1;
243         }
244         return module->next->ops->search(module->next, base, scope, expression, attrs, res);
245 }
246
247 int ldb_next_search_bytree(struct ldb_module *module, 
248                            const char *base,
249                            enum ldb_scope scope,
250                            struct ldb_parse_tree *tree,
251                            const char * const *attrs, struct ldb_message ***res)
252 {
253         if (!module->next) {
254                 return -1;
255         }
256         return module->next->ops->search_bytree(module->next, base, scope, tree, attrs, res);
257 }
258
259 int ldb_next_add_record(struct ldb_module *module, const struct ldb_message *message)
260 {
261         if (!module->next) {
262                 return -1;
263         }
264         return module->next->ops->add_record(module->next, message);
265 }
266
267 int ldb_next_modify_record(struct ldb_module *module, const struct ldb_message *message)
268 {
269         if (!module->next) {
270                 return -1;
271         }
272         return module->next->ops->modify_record(module->next, message);
273 }
274
275 int ldb_next_delete_record(struct ldb_module *module, const char *dn)
276 {
277         if (!module->next) {
278                 return -1;
279         }
280         return module->next->ops->delete_record(module->next, dn);
281 }
282
283 int ldb_next_rename_record(struct ldb_module *module, const char *olddn, const char *newdn)
284 {
285         if (!module->next) {
286                 return -1;
287         }
288         return module->next->ops->rename_record(module->next, olddn, newdn);
289 }
290
291 int ldb_next_named_lock(struct ldb_module *module, const char *lockname)
292 {
293         if (!module->next) {
294                 return -1;
295         }
296         return module->next->ops->named_lock(module->next, lockname);
297 }
298
299 int ldb_next_named_unlock(struct ldb_module *module, const char *lockname)
300 {
301         if (!module->next) {
302                 return -1;
303         }
304         return module->next->ops->named_unlock(module->next, lockname);
305 }
306
307 const char *ldb_next_errstring(struct ldb_module *module)
308 {
309         if (!module->next) {
310                 return NULL;
311         }
312         return module->next->ops->errstring(module->next);
313 }
314