r8667: Further simply the provision script, by removing the 'name' attribute.
[kai/samba.git] / source / lib / ldb / modules / rdn_name.c
1 /* 
2    ldb database library
3
4    Copyright (C) Simo Sorce  2004
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 2 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, write to the Free Software
22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23 */
24
25 /*
26  *  Name: ldb
27  *
28  *  Component: ldb objectguid module
29  *
30  *  Description: add a unique objectGUID onto every new record
31  *
32  *  Author: Simo Sorce
33  */
34
35 #include "includes.h"
36 #include "ldb/include/ldb.h"
37 #include "ldb/include/ldb_private.h"
38 #include <time.h>
39
40 struct private_data {
41         const char *error_string;
42 };
43
44 static int rdn_name_search(struct ldb_module *module, const char *base,
45                                   enum ldb_scope scope, const char *expression,
46                                   const char * const *attrs, struct ldb_message ***res)
47 {
48         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_search\n");
49         return ldb_next_search(module, base, scope, expression, attrs, res);
50 }
51
52 static int rdn_name_search_bytree(struct ldb_module *module, const char *base,
53                                     enum ldb_scope scope, struct ldb_parse_tree *tree,
54                                     const char * const *attrs, struct ldb_message ***res)
55 {
56         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_search\n");
57         return ldb_next_search_bytree(module, base, scope, tree, attrs, res);
58 }
59
60 static struct ldb_message_element *rdn_name_find_attribute(const struct ldb_message *msg, const char *name)
61 {
62         int i;
63
64         for (i = 0; i < msg->num_elements; i++) {
65                 if (ldb_attr_cmp(name, msg->elements[i].name) == 0) {
66                         return &msg->elements[i];
67                 }
68         }
69
70         return NULL;
71 }
72
73 static struct ldb_dn_component *get_rdn(void *mem_ctx, const char *dn)
74 {
75         struct ldb_dn *dn_exploded = ldb_dn_explode(mem_ctx, dn);
76
77         if (!dn_exploded) {
78                 return NULL;
79         }
80         
81         if (dn_exploded->comp_num < 1) {
82                 return NULL;
83         }
84         
85         return  &dn_exploded->components[0];
86 }
87
88 /* add_record: add crateTimestamp/modifyTimestamp attributes */
89 static int rdn_name_add_record(struct ldb_module *module, const struct ldb_message *msg)
90 {
91         struct ldb_message *msg2;
92         struct ldb_message_element *attribute;
93         struct ldb_dn_component *rdn;
94         int ret, i;
95
96         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_add_record\n");
97
98         if (msg->dn[0] == '@') { /* do not manipulate our control entries */
99                 return ldb_next_add_record(module, msg);
100         }
101
102         /* Perhaps someone above us knows better */
103         if ((attribute = rdn_name_find_attribute(msg, "name")) != NULL ) {
104                 return ldb_next_add_record(module, msg);
105         }
106
107         msg2 = talloc(module, struct ldb_message);
108         if (!msg2) {
109                 return -1;
110         }
111
112         msg2->dn = msg->dn;
113         msg2->num_elements = msg->num_elements;
114         msg2->private_data = msg->private_data;
115         msg2->elements = talloc_array(msg2, struct ldb_message_element, msg2->num_elements);
116         for (i = 0; i < msg2->num_elements; i++) {
117                 msg2->elements[i] = msg->elements[i];
118         }
119
120         rdn = get_rdn(msg2, msg2->dn);
121         if (!rdn) {
122                 return -1;
123         }
124         
125         if (ldb_msg_add_value(module->ldb, msg2, "name", &rdn->value) != 0) {
126                 return -1;
127         }
128
129         ret = ldb_next_add_record(module, msg2);
130         talloc_free(msg2);
131
132         return ret;
133 }
134
135 /* modify_record: change modifyTimestamp as well */
136 static int rdn_name_modify_record(struct ldb_module *module, const struct ldb_message *msg)
137 {
138         struct ldb_message *msg2;
139         struct ldb_message_element *attribute;
140         struct ldb_dn_component *rdn;
141         int ret, i;
142
143         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_modify_record\n");
144
145         /* Perhaps someone above us knows better */
146         if ((attribute = rdn_name_find_attribute(msg, "name")) != NULL ) {
147                 return ldb_next_add_record(module, msg);
148         }
149
150         msg2 = talloc(module, struct ldb_message);
151         if (!msg2) {
152                 return -1;
153         }
154
155         msg2->dn = msg->dn;
156         msg2->num_elements = msg->num_elements;
157         msg2->private_data = msg->private_data;
158         msg2->elements = talloc_array(msg2, struct ldb_message_element, msg2->num_elements);
159         for (i = 0; i < msg2->num_elements; i++) {
160                 msg2->elements[i] = msg->elements[i];
161         }
162         
163         rdn = get_rdn(msg2, msg2->dn);
164         if (!rdn) {
165                 return -1;
166         }
167         
168         if (ldb_msg_add_value(module->ldb, msg2, "name", &rdn->value) != 0) {
169                 return -1;
170         }
171
172         attribute = rdn_name_find_attribute(msg2, "name");
173         if (!attribute) {
174                 return -1;
175         }
176
177         attribute->flags = LDB_FLAG_MOD_REPLACE;
178
179         ret = ldb_next_modify_record(module, msg2);
180         talloc_free(msg2);
181
182         return ret;
183 }
184
185 static int rdn_name_delete_record(struct ldb_module *module, const char *dn)
186 {
187         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_delete_record\n");
188         return ldb_next_delete_record(module, dn);
189 }
190
191 static int rdn_name_rename_record(struct ldb_module *module, const char *olddn, const char *newdn)
192 {
193         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_rename_record\n");
194         return ldb_next_rename_record(module, olddn, newdn);
195 }
196
197 static int rdn_name_lock(struct ldb_module *module, const char *lockname)
198 {
199         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_lock\n");
200         return ldb_next_named_lock(module, lockname);
201 }
202
203 static int rdn_name_unlock(struct ldb_module *module, const char *lockname)
204 {
205         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_unlock\n");
206         return ldb_next_named_unlock(module, lockname);
207 }
208
209 /* return extended error information */
210 static const char *rdn_name_errstring(struct ldb_module *module)
211 {
212         struct private_data *data = (struct private_data *)module->private_data;
213
214         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_errstring\n");
215         if (data->error_string) {
216                 const char *error;
217
218                 error = data->error_string;
219                 data->error_string = NULL;
220                 return error;
221         }
222
223         return ldb_next_errstring(module);
224 }
225
226 static int rdn_name_destructor(void *module_ctx)
227 {
228         /* struct ldb_module *ctx = module_ctx; */
229         /* put your clean-up functions here */
230         return 0;
231 }
232
233 static const struct ldb_module_ops rdn_name_ops = {
234         .name          = "rdn_name",
235         .search        = rdn_name_search,
236         .search_bytree = rdn_name_search_bytree,
237         .add_record    = rdn_name_add_record,
238         .modify_record = rdn_name_modify_record,
239         .delete_record = rdn_name_delete_record,
240         .rename_record = rdn_name_rename_record,
241         .named_lock    = rdn_name_lock,
242         .named_unlock  = rdn_name_unlock,
243         .errstring     = rdn_name_errstring
244 };
245
246
247 /* the init function */
248 #ifdef HAVE_DLOPEN_DISABLED
249  struct ldb_module *init_module(struct ldb_context *ldb, const char *options[])
250 #else
251 struct ldb_module *rdn_name_module_init(struct ldb_context *ldb, const char *options[])
252 #endif
253 {
254         struct ldb_module *ctx;
255         struct private_data *data;
256
257         ctx = talloc(ldb, struct ldb_module);
258         if (!ctx)
259                 return NULL;
260
261         data = talloc(ctx, struct private_data);
262         if (!data) {
263                 talloc_free(ctx);
264                 return NULL;
265         }
266
267         data->error_string = NULL;
268         ctx->private_data = data;
269         ctx->ldb = ldb;
270         ctx->prev = ctx->next = NULL;
271         ctx->ops = &rdn_name_ops;
272
273         talloc_set_destructor (ctx, rdn_name_destructor);
274
275         return ctx;
276 }