4 Copyright (C) Andrew Tridgell 2004
6 ** NOTE! The following LGPL license applies to the ldb
7 ** library. This does NOT imply that all of Samba is released
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.
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.
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/>.
29 * Description: utility for ldb database editing
31 * Author: Andrew Tridgell
33 #include "ldb_includes.h"
35 #include "tools/cmdline.h"
37 static struct ldb_cmdline *options;
42 static void ldif_write_msg(struct ldb_context *ldb,
44 enum ldb_changetype changetype,
45 struct ldb_message *msg)
48 ldif.changetype = changetype;
50 ldb_ldif_write_file(ldb, f, &ldif);
54 modify a database record so msg1 becomes msg2
55 returns the number of modified elements
57 static int modify_record(struct ldb_context *ldb,
58 struct ldb_message *msg1,
59 struct ldb_message *msg2)
61 struct ldb_message *mod;
63 mod = ldb_msg_diff(ldb, msg1, msg2);
65 fprintf(stderr, "Failed to calculate message differences\n");
69 if (mod->num_elements == 0) {
73 if (options->verbose > 0) {
74 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_MODIFY, mod);
77 if (ldb_modify(ldb, mod) != 0) {
78 fprintf(stderr, "failed to modify %s - %s\n",
79 ldb_dn_get_linearized(msg1->dn), ldb_errstring(ldb));
83 return mod->num_elements;
89 static struct ldb_message *msg_find(struct ldb_context *ldb,
90 struct ldb_message **msgs,
95 for (i=0;i<count;i++) {
96 if (ldb_dn_compare(dn, msgs[i]->dn) == 0) {
104 merge the changes in msgs2 into the messages from msgs1
106 static int merge_edits(struct ldb_context *ldb,
107 struct ldb_message **msgs1, int count1,
108 struct ldb_message **msgs2, int count2)
111 struct ldb_message *msg;
113 int adds=0, modifies=0, deletes=0;
115 if (ldb_transaction_start(ldb) != 0) {
116 fprintf(stderr, "Failed to start transaction: %s\n", ldb_errstring(ldb));
120 /* do the adds and modifies */
121 for (i=0;i<count2;i++) {
122 msg = msg_find(ldb, msgs1, count1, msgs2[i]->dn);
124 if (options->verbose > 0) {
125 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_ADD, msgs2[i]);
127 if (ldb_add(ldb, msgs2[i]) != 0) {
128 fprintf(stderr, "failed to add %s - %s\n",
129 ldb_dn_get_linearized(msgs2[i]->dn),
131 ldb_transaction_cancel(ldb);
136 if (modify_record(ldb, msg, msgs2[i]) > 0) {
143 for (i=0;i<count1;i++) {
144 msg = msg_find(ldb, msgs2, count2, msgs1[i]->dn);
146 if (options->verbose > 0) {
147 ldif_write_msg(ldb, stdout, LDB_CHANGETYPE_DELETE, msgs1[i]);
149 if (ldb_delete(ldb, msgs1[i]->dn) != 0) {
150 fprintf(stderr, "failed to delete %s - %s\n",
151 ldb_dn_get_linearized(msgs1[i]->dn),
153 ldb_transaction_cancel(ldb);
160 if (ldb_transaction_commit(ldb) != 0) {
161 fprintf(stderr, "Failed to commit transaction: %s\n", ldb_errstring(ldb));
165 printf("# %d adds %d modifies %d deletes\n", adds, modifies, deletes);
171 save a set of messages as ldif to a file
173 static int save_ldif(struct ldb_context *ldb,
174 FILE *f, struct ldb_message **msgs, int count)
178 fprintf(f, "# editing %d records\n", count);
180 for (i=0;i<count;i++) {
181 struct ldb_ldif ldif;
182 fprintf(f, "# record %d\n", i+1);
184 ldif.changetype = LDB_CHANGETYPE_NONE;
187 ldb_ldif_write_file(ldb, f, &ldif);
195 edit the ldb search results in msgs using the user selected editor
197 static int do_edit(struct ldb_context *ldb, struct ldb_message **msgs1, int count1,
202 char file_template[] = "/tmp/ldbedit.XXXXXX";
204 struct ldb_ldif *ldif;
205 struct ldb_message **msgs2 = NULL;
208 /* write out the original set of messages to a temporary
210 fd = mkstemp(file_template);
213 perror(file_template);
217 f = fdopen(fd, "r+");
222 unlink(file_template);
226 if (save_ldif(ldb, f, msgs1, count1) != 0) {
232 cmd = talloc_asprintf(ldb, "%s %s", editor, file_template);
235 unlink(file_template);
236 fprintf(stderr, "out of memory\n");
245 unlink(file_template);
246 fprintf(stderr, "edit with %s failed\n", editor);
250 /* read the resulting ldif into msgs2 */
251 f = fopen(file_template, "r");
253 perror(file_template);
257 while ((ldif = ldb_ldif_read_file(ldb, f))) {
258 msgs2 = talloc_realloc(ldb, msgs2, struct ldb_message *, count2+1);
260 fprintf(stderr, "out of memory");
263 msgs2[count2++] = ldif->msg;
267 unlink(file_template);
269 return merge_edits(ldb, msgs1, count1, msgs2, count2);
272 static void usage(void)
274 printf("Usage: ldbedit <options> <expression> <attributes ...>\n");
275 ldb_cmdline_help("ldbedit", stdout);
279 int main(int argc, const char **argv)
281 struct ldb_context *ldb;
282 struct ldb_result *result = NULL;
283 struct ldb_dn *basedn = NULL;
285 const char *expression = "(|(objectClass=*)(distinguishedName=*))";
286 const char * const * attrs = NULL;
288 ldb = ldb_init(NULL, NULL);
290 options = ldb_cmdline_process(ldb, argc, argv, usage);
292 /* the check for '=' is for compatibility with ldapsearch */
293 if (options->argc > 0 &&
294 strchr(options->argv[0], '=')) {
295 expression = options->argv[0];
300 if (options->argc > 0) {
301 attrs = (const char * const *)(options->argv);
304 if (options->basedn != NULL) {
305 basedn = ldb_dn_new(ldb, ldb, options->basedn);
306 if ( ! ldb_dn_validate(basedn)) {
307 printf("Invalid Base DN format\n");
312 ret = ldb_search(ldb, ldb, &result, basedn, options->scope, attrs, "%s", expression);
313 if (ret != LDB_SUCCESS) {
314 printf("search failed - %s\n", ldb_errstring(ldb));
318 if (result->count == 0) {
319 printf("no matching records - cannot edit\n");
323 do_edit(ldb, result->msgs, result->count, options->editor);
326 ret = talloc_free(result);
328 fprintf(stderr, "talloc_free failed\n");