r8669: The objectguid module belongs in Samba's ldb module collection, not in
[sfrench/samba-autobuild/.git] / source4 / dsdb / samdb / ldb_modules / objectguid.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 objectguid_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, "objectguid_search\n");
49         return ldb_next_search(module, base, scope, expression, attrs, res);
50 }
51
52 static int objectguid_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, "objectguid_search\n");
57         return ldb_next_search_bytree(module, base, scope, tree, attrs, res);
58 }
59
60 static struct ldb_message_element *objectguid_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 /* add_record: add crateTimestamp/modifyTimestamp attributes */
74 static int objectguid_add_record(struct ldb_module *module, const struct ldb_message *msg)
75 {
76         struct ldb_val v;
77         struct ldb_message *msg2;
78         struct ldb_message_element *attribute;
79         struct GUID guid;
80         NTSTATUS nt_status;
81         int ret, i;
82
83         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_add_record\n");
84
85         if (msg->dn[0] == '@') { /* do not manipulate our control entries */
86                 return ldb_next_add_record(module, msg);
87         }
88
89         if ((attribute = objectguid_find_attribute(msg, "objectGUID")) != NULL ) {
90                 return ldb_next_add_record(module, msg);
91         }
92
93         msg2 = talloc(module, struct ldb_message);
94         if (!msg2) {
95                 return -1;
96         }
97
98         msg2->dn = msg->dn;
99         msg2->num_elements = msg->num_elements;
100         msg2->private_data = msg->private_data;
101         msg2->elements = talloc_array(msg2, struct ldb_message_element, msg2->num_elements);
102         for (i = 0; i < msg2->num_elements; i++) {
103                 msg2->elements[i] = msg->elements[i];
104         }
105
106         /* a new GUID */
107         guid = GUID_random();
108
109         nt_status = ndr_push_struct_blob(&v, msg2, &guid, 
110                                          (ndr_push_flags_fn_t)ndr_push_GUID);
111         if (!NT_STATUS_IS_OK(nt_status)) {
112                 return -1;
113         }
114
115         ret = ldb_msg_add_value(module->ldb, msg2, "objectGUID", &v);
116         if (ret) {
117                 return ret;
118         }
119
120         ret = ldb_next_add_record(module, msg2);
121         talloc_free(msg2);
122
123         return ret;
124 }
125
126 /* modify_record: change modifyTimestamp as well */
127 static int objectguid_modify_record(struct ldb_module *module, const struct ldb_message *msg)
128 {
129         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_modify_record\n");
130         return ldb_next_modify_record(module, msg);
131 }
132
133 static int objectguid_delete_record(struct ldb_module *module, const char *dn)
134 {
135         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_delete_record\n");
136         return ldb_next_delete_record(module, dn);
137 }
138
139 static int objectguid_rename_record(struct ldb_module *module, const char *olddn, const char *newdn)
140 {
141         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_rename_record\n");
142         return ldb_next_rename_record(module, olddn, newdn);
143 }
144
145 static int objectguid_lock(struct ldb_module *module, const char *lockname)
146 {
147         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_lock\n");
148         return ldb_next_named_lock(module, lockname);
149 }
150
151 static int objectguid_unlock(struct ldb_module *module, const char *lockname)
152 {
153         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_unlock\n");
154         return ldb_next_named_unlock(module, lockname);
155 }
156
157 /* return extended error information */
158 static const char *objectguid_errstring(struct ldb_module *module)
159 {
160         struct private_data *data = (struct private_data *)module->private_data;
161
162         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_errstring\n");
163         if (data->error_string) {
164                 const char *error;
165
166                 error = data->error_string;
167                 data->error_string = NULL;
168                 return error;
169         }
170
171         return ldb_next_errstring(module);
172 }
173
174 static int objectguid_destructor(void *module_ctx)
175 {
176         /* struct ldb_module *ctx = module_ctx; */
177         /* put your clean-up functions here */
178         return 0;
179 }
180
181 static const struct ldb_module_ops objectguid_ops = {
182         .name          = "objectguid",
183         .search        = objectguid_search,
184         .search_bytree = objectguid_search_bytree,
185         .add_record    = objectguid_add_record,
186         .modify_record = objectguid_modify_record,
187         .delete_record = objectguid_delete_record,
188         .rename_record = objectguid_rename_record,
189         .named_lock    = objectguid_lock,
190         .named_unlock  = objectguid_unlock,
191         .errstring     = objectguid_errstring
192 };
193
194
195 /* the init function */
196 #ifdef HAVE_DLOPEN_DISABLED
197  struct ldb_module *init_module(struct ldb_context *ldb, const char *options[])
198 #else
199 struct ldb_module *objectguid_module_init(struct ldb_context *ldb, const char *options[])
200 #endif
201 {
202         struct ldb_module *ctx;
203         struct private_data *data;
204
205         ctx = talloc(ldb, struct ldb_module);
206         if (!ctx)
207                 return NULL;
208
209         data = talloc(ctx, struct private_data);
210         if (!data) {
211                 talloc_free(ctx);
212                 return NULL;
213         }
214
215         data->error_string = NULL;
216         ctx->private_data = data;
217         ctx->ldb = ldb;
218         ctx->prev = ctx->next = NULL;
219         ctx->ops = &objectguid_ops;
220
221         talloc_set_destructor (ctx, objectguid_destructor);
222
223         return ctx;
224 }