36d054e563954df0fe03b2be01742e608056f519
[samba.git] / source4 / lib / ldb / tools / ldbedit.c
1 /*
2    ldb database library
3
4    Copyright (C) Andrew Tridgell  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 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: ldbedit
28  *
29  *  Description: utility for ldb database editing
30  *
31  *  Author: Andrew Tridgell
32  */
33
34 #include "replace.h"
35 #include "system/filesys.h"
36 #include "system/time.h"
37 #include "system/filesys.h"
38 #include "ldb.h"
39 #include "tools/cmdline.h"
40 #include "tools/ldbutil.h"
41
42 static struct ldb_cmdline *options;
43
44 /*
45   debug routine
46 */
47 static void ldif_write_msg(struct ldb_context *ldb,
48                            FILE *f,
49                            enum ldb_changetype changetype,
50                            struct ldb_message *msg)
51 {
52         struct ldb_ldif ldif;
53         ldif.changetype = changetype;
54         ldif.msg = msg;
55         ldb_ldif_write_file(ldb, f, &ldif);
56 }
57
58 /*
59   modify a database record so msg1 becomes msg2
60   returns the number of modified elements
61 */
62 static int modify_record(struct ldb_context *ldb,
63                          struct ldb_message *msg1,
64                          struct ldb_message *msg2,
65                          struct ldb_control **req_ctrls)
66 {
67         int ret;
68         struct ldb_message *mod;
69
70         if (ldb_msg_difference(ldb, ldb, msg1, msg2, &mod) != LDB_SUCCESS) {
71                 fprintf(stderr, "Failed to calculate message differences\n");
72                 return -1;
73         }
74
75         ret = mod->num_elements;
76         if (ret == 0) {
77                 goto done;
78         }
79
80         if (options->verbose > 0) {
81                 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_MODIFY, mod);
82         }
83
84         if (ldb_modify_ctrl(ldb, mod, req_ctrls) != LDB_SUCCESS) {
85                 fprintf(stderr, "failed to modify %s - %s\n",
86                         ldb_dn_get_linearized(msg1->dn), ldb_errstring(ldb));
87                 ret = -1;
88                 goto done;
89         }
90
91 done:
92         talloc_free(mod);
93         return ret;
94 }
95
96 /*
97   find dn in msgs[]
98 */
99 static struct ldb_message *msg_find(struct ldb_context *ldb,
100                                     struct ldb_message **msgs,
101                                     unsigned int count,
102                                     struct ldb_dn *dn)
103 {
104         unsigned int i;
105         for (i=0;i<count;i++) {
106                 if (ldb_dn_compare(dn, msgs[i]->dn) == 0) {
107                         return msgs[i];
108                 }
109         }
110         return NULL;
111 }
112
113 /*
114   merge the changes in msgs2 into the messages from msgs1
115 */
116 static int merge_edits(struct ldb_context *ldb,
117                        struct ldb_message **msgs1, unsigned int count1,
118                        struct ldb_message **msgs2, unsigned int count2)
119 {
120         unsigned int i;
121         struct ldb_message *msg;
122         int ret;
123         unsigned int adds=0, modifies=0, deletes=0;
124         struct ldb_control **req_ctrls = ldb_parse_control_strings(ldb, ldb, (const char **)options->controls);
125         if (options->controls != NULL && req_ctrls == NULL) {
126                 fprintf(stderr, "parsing controls failed: %s\n", ldb_errstring(ldb));
127                 return -1;
128         }
129
130         if (ldb_transaction_start(ldb) != LDB_SUCCESS) {
131                 fprintf(stderr, "Failed to start transaction: %s\n", ldb_errstring(ldb));
132                 return -1;
133         }
134
135         /* do the adds and modifies */
136         for (i=0;i<count2;i++) {
137                 msg = msg_find(ldb, msgs1, count1, msgs2[i]->dn);
138                 if (!msg) {
139                         if (options->verbose > 0) {
140                                 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_ADD, msgs2[i]);
141                         }
142                         if (ldb_add_ctrl(ldb, msgs2[i], req_ctrls) != LDB_SUCCESS) {
143                                 fprintf(stderr, "failed to add %s - %s\n",
144                                         ldb_dn_get_linearized(msgs2[i]->dn),
145                                         ldb_errstring(ldb));
146                                 ldb_transaction_cancel(ldb);
147                                 return -1;
148                         }
149                         adds++;
150                 } else {
151                         ret = modify_record(ldb, msg, msgs2[i], req_ctrls);
152                         if (ret != -1) {
153                                 modifies += (unsigned int) ret;
154                         } else {
155                                 return -1;
156                         }
157                 }
158         }
159
160         /* do the deletes */
161         for (i=0;i<count1;i++) {
162                 msg = msg_find(ldb, msgs2, count2, msgs1[i]->dn);
163                 if (!msg) {
164                         if (options->verbose > 0) {
165                                 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_DELETE, msgs1[i]);
166                         }
167                         if (ldb_delete_ctrl(ldb, msgs1[i]->dn, req_ctrls) != LDB_SUCCESS) {
168                                 fprintf(stderr, "failed to delete %s - %s\n",
169                                         ldb_dn_get_linearized(msgs1[i]->dn),
170                                         ldb_errstring(ldb));
171                                 ldb_transaction_cancel(ldb);
172                                 return -1;
173                         }
174                         deletes++;
175                 }
176         }
177
178         if (ldb_transaction_commit(ldb) != LDB_SUCCESS) {
179                 fprintf(stderr, "Failed to commit transaction: %s\n", ldb_errstring(ldb));
180                 return -1;
181         }
182
183         printf("# %u adds  %u modifies  %u deletes\n", adds, modifies, deletes);
184
185         return 0;
186 }
187
188 /*
189   save a set of messages as ldif to a file
190 */
191 static int save_ldif(struct ldb_context *ldb,
192                      FILE *f, struct ldb_message **msgs, unsigned int count)
193 {
194         unsigned int i;
195
196         fprintf(f, "# editing %u records\n", count);
197
198         for (i=0;i<count;i++) {
199                 struct ldb_ldif ldif;
200                 fprintf(f, "# record %u\n", i+1);
201
202                 ldif.changetype = LDB_CHANGETYPE_NONE;
203                 ldif.msg = msgs[i];
204
205                 ldb_ldif_write_file(ldb, f, &ldif);
206         }
207
208         return 0;
209 }
210
211
212 /*
213   edit the ldb search results in msgs using the user selected editor
214 */
215 static int do_edit(struct ldb_context *ldb, struct ldb_message **msgs1,
216                    unsigned int count1, const char *editor)
217 {
218         int fd, ret;
219         FILE *f;
220         char file_template[] = "/tmp/ldbedit.XXXXXX";
221         char *cmd;
222         struct ldb_ldif *ldif;
223         struct ldb_message **msgs2 = NULL;
224         unsigned int count2 = 0;
225
226         /* write out the original set of messages to a temporary
227            file */
228         fd = mkstemp(file_template);
229
230         if (fd == -1) {
231                 perror(file_template);
232                 return -1;
233         }
234
235         f = fdopen(fd, "r+");
236
237         if (!f) {
238                 perror("fopen");
239                 close(fd);
240                 unlink(file_template);
241                 return -1;
242         }
243
244         if (save_ldif(ldb, f, msgs1, count1) != 0) {
245                 return -1;
246         }
247
248         fclose(f);
249
250         cmd = talloc_asprintf(ldb, "%s %s", editor, file_template);
251
252         if (!cmd) {
253                 unlink(file_template);
254                 fprintf(stderr, "out of memory\n");
255                 return -1;
256         }
257
258         /* run the editor */
259         ret = system(cmd);
260         talloc_free(cmd);
261
262         if (ret != 0) {
263                 unlink(file_template);
264                 fprintf(stderr, "edit with %s failed\n", editor);
265                 return -1;
266         }
267
268         /* read the resulting ldif into msgs2 */
269         f = fopen(file_template, "r");
270         if (!f) {
271                 perror(file_template);
272                 return -1;
273         }
274
275         while ((ldif = ldb_ldif_read_file(ldb, f))) {
276                 msgs2 = talloc_realloc(ldb, msgs2, struct ldb_message *, count2+1);
277                 if (!msgs2) {
278                         fprintf(stderr, "out of memory");
279                         return -1;
280                 }
281                 msgs2[count2++] = ldif->msg;
282         }
283
284         fclose(f);
285         unlink(file_template);
286
287         return merge_edits(ldb, msgs1, count1, msgs2, count2);
288 }
289
290 static void usage(struct ldb_context *ldb)
291 {
292         printf("Usage: ldbedit <options> <expression> <attributes ...>\n");
293         ldb_cmdline_help(ldb, "ldbedit", stdout);
294         exit(LDB_ERR_OPERATIONS_ERROR);
295 }
296
297 int main(int argc, const char **argv)
298 {
299         struct ldb_context *ldb;
300         struct ldb_result *result = NULL;
301         struct ldb_dn *basedn = NULL;
302         int ret;
303         const char *expression = "(|(objectClass=*)(distinguishedName=*))";
304         const char * const * attrs = NULL;
305         TALLOC_CTX *mem_ctx = talloc_new(NULL);
306         struct ldb_control **req_ctrls;
307
308         ldb = ldb_init(mem_ctx, NULL);
309         if (ldb == NULL) {
310                 return LDB_ERR_OPERATIONS_ERROR;
311         }
312
313         options = ldb_cmdline_process(ldb, argc, argv, usage);
314
315         /* the check for '=' is for compatibility with ldapsearch */
316         if (options->argc > 0 &&
317             strchr(options->argv[0], '=')) {
318                 expression = options->argv[0];
319                 options->argv++;
320                 options->argc--;
321         }
322
323         if (options->argc > 0) {
324                 attrs = (const char * const *)(options->argv);
325         }
326
327         if (options->basedn != NULL) {
328                 basedn = ldb_dn_new(ldb, ldb, options->basedn);
329                 if (basedn == NULL) {
330                         return LDB_ERR_OPERATIONS_ERROR;
331                 }
332         }
333
334         req_ctrls = ldb_parse_control_strings(ldb, ldb, (const char **)options->controls);
335         if (options->controls != NULL &&  req_ctrls== NULL) {
336                 printf("parsing controls failed: %s\n", ldb_errstring(ldb));
337                 return LDB_ERR_OPERATIONS_ERROR;
338         }
339
340         ret = ldb_search_ctrl(ldb, ldb, &result, basedn, options->scope, attrs, req_ctrls, "%s", expression);
341         if (ret != LDB_SUCCESS) {
342                 printf("search failed - %s\n", ldb_errstring(ldb));
343                 return ret;
344         }
345
346         if (result->count == 0) {
347                 printf("no matching records - cannot edit\n");
348                 talloc_free(mem_ctx);
349                 return LDB_SUCCESS;
350         }
351
352         ret = do_edit(ldb, result->msgs, result->count, options->editor);
353
354         talloc_free(mem_ctx);
355
356         return ret == 0 ? LDB_SUCCESS : LDB_ERR_OPERATIONS_ERROR;
357 }