?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
winbindd: as DC we should try to get the target_domain from @SOMETHING part of the...
[Samba.git] / lib / ldb / tools / cmdline.c
bloba2fe97ee6b2841effef9cd86215c997f6823b011
1 /*
2 ldb database library - command line handling for ldb tools
3
4 Copyright (C) Andrew Tridgell 2005
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 #include "replace.h"
25 #include "system/filesys.h"
26 #include "system/time.h"
27 #include "ldb.h"
28 #include "ldb_module.h"
29 #include "tools/cmdline.h"
30
31 static struct ldb_cmdline options; /* needs to be static for older compilers */
32
33 enum ldb_cmdline_options { CMDLINE_RELAX=1 };
34
35 static struct poptOption builtin_popt_options[] = {
36 POPT_AUTOHELP
37 { "url", 'H', POPT_ARG_STRING, &options.url, 0, "database URL", "URL" },
38 { "basedn", 'b', POPT_ARG_STRING, &options.basedn, 0, "base DN", "DN" },
39 { "editor", 'e', POPT_ARG_STRING, &options.editor, 0, "external editor", "PROGRAM" },
40 { "scope", 's', POPT_ARG_STRING, NULL, 's', "search scope", "SCOPE" },
41 { "verbose", 'v', POPT_ARG_NONE, NULL, 'v', "increase verbosity", NULL },
42 { "trace", 0, POPT_ARG_NONE, &options.tracing, 0, "enable tracing", NULL },
43 { "interactive", 'i', POPT_ARG_NONE, &options.interactive, 0, "input from stdin", NULL },
44 { "recursive", 'r', POPT_ARG_NONE, &options.recursive, 0, "recursive delete", NULL },
45 { "modules-path", 0, POPT_ARG_STRING, &options.modules_path, 0, "modules path", "PATH" },
46 { "num-searches", 0, POPT_ARG_INT, &options.num_searches, 0, "number of test searches", NULL },
47 { "num-records", 0, POPT_ARG_INT, &options.num_records, 0, "number of test records", NULL },
48 { "all", 'a', POPT_ARG_NONE, &options.all_records, 0, "(|(objectClass=*)(distinguishedName=*))", NULL },
49 { "nosync", 0, POPT_ARG_NONE, &options.nosync, 0, "non-synchronous transactions", NULL },
50 { "sorted", 'S', POPT_ARG_NONE, &options.sorted, 0, "sort attributes", NULL },
51 { NULL, 'o', POPT_ARG_STRING, NULL, 'o', "ldb_connect option", "OPTION" },
52 { "controls", 0, POPT_ARG_STRING, NULL, 'c', "controls", NULL },
53 { "show-binary", 0, POPT_ARG_NONE, &options.show_binary, 0, "display binary LDIF", NULL },
54 { "paged", 0, POPT_ARG_NONE, NULL, 'P', "use a paged search", NULL },
55 { "show-deleted", 0, POPT_ARG_NONE, NULL, 'D', "show deleted objects", NULL },
56 { "show-recycled", 0, POPT_ARG_NONE, NULL, 'R', "show recycled objects", NULL },
57 { "show-deactivated-link", 0, POPT_ARG_NONE, NULL, 'd', "show deactivated links", NULL },
58 { "reveal", 0, POPT_ARG_NONE, NULL, 'r', "reveal ldb internals", NULL },
59 { "relax", 0, POPT_ARG_NONE, NULL, CMDLINE_RELAX, "pass relax control", NULL },
60 { "cross-ncs", 0, POPT_ARG_NONE, NULL, 'N', "search across NC boundaries", NULL },
61 { "extended-dn", 0, POPT_ARG_NONE, NULL, 'E', "show extended DNs", NULL },
62 { NULL }
63 };
64
65 void ldb_cmdline_help(struct ldb_context *ldb, const char *cmdname, FILE *f)
66 {
67 poptContext pc;
68 struct poptOption **popt_options = ldb_module_popt_options(ldb);
69 pc = poptGetContext(cmdname, 0, NULL, *popt_options,
70 POPT_CONTEXT_KEEP_FIRST);
71 poptPrintHelp(pc, f, 0);
72 }
73
74 /*
75 add a control to the options structure
76 */
77 static bool add_control(TALLOC_CTX *mem_ctx, const char *control)
78 {
79 unsigned int i;
80
81 /* count how many controls we already have */
82 for (i=0; options.controls && options.controls[i]; i++) ;
83
84 options.controls = talloc_realloc(mem_ctx, options.controls, const char *, i + 2);
85 if (options.controls == NULL) {
86 return false;
87 }
88 options.controls[i] = control;
89 options.controls[i+1] = NULL;
90 return true;
91 }
92
93 /**
94 process command line options
95 */
96 static struct ldb_cmdline *ldb_cmdline_process_internal(struct ldb_context *ldb,
97 int argc, const char **argv,
98 void (*usage)(struct ldb_context *),
99 bool search)
100 {
101 struct ldb_cmdline *ret=NULL;
102 poptContext pc;
103 int num_options = 0;
104 int opt;
105 unsigned int flags = 0;
106 int rc;
107 struct poptOption **popt_options;
108
109 /* make the ldb utilities line buffered */
110 setlinebuf(stdout);
111
112 ret = talloc_zero(ldb, struct ldb_cmdline);
113 if (ret == NULL) {
114 fprintf(stderr, "Out of memory!\n");
115 goto failed;
116 }
117
118 options = *ret;
119
120 /* pull in URL */
121 options.url = getenv("LDB_URL");
122
123 /* and editor (used by ldbedit) */
124 options.editor = getenv("VISUAL");
125 if (!options.editor) {
126 options.editor = getenv("EDITOR");
127 }
128 if (!options.editor) {
129 options.editor = "vi";
130 }
131
132 options.scope = LDB_SCOPE_DEFAULT;
133
134 popt_options = ldb_module_popt_options(ldb);
135 (*popt_options) = builtin_popt_options;
136
137 rc = ldb_modules_hook(ldb, LDB_MODULE_HOOK_CMDLINE_OPTIONS);
138 if (rc != LDB_SUCCESS) {
139 fprintf(stderr, "ldb: failed to run command line hooks : %s\n", ldb_strerror(rc));
140 goto failed;
141 }
142
143 pc = poptGetContext(argv[0], argc, argv, *popt_options,
144 POPT_CONTEXT_KEEP_FIRST);
145
146 while((opt = poptGetNextOpt(pc)) != -1) {
147 switch (opt) {
148 case 's': {
149 const char *arg = poptGetOptArg(pc);
150 if (strcmp(arg, "base") == 0) {
151 options.scope = LDB_SCOPE_BASE;
152 } else if (strcmp(arg, "sub") == 0) {
153 options.scope = LDB_SCOPE_SUBTREE;
154 } else if (strcmp(arg, "one") == 0) {
155 options.scope = LDB_SCOPE_ONELEVEL;
156 } else {
157 fprintf(stderr, "Invalid scope '%s'\n", arg);
158 goto failed;
159 }
160 break;
161 }
162
163 case 'v':
164 options.verbose++;
165 break;
166
167 case 'o':
168 options.options = talloc_realloc(ret, options.options,
169 const char *, num_options+3);
170 if (options.options == NULL) {
171 fprintf(stderr, "Out of memory!\n");
172 goto failed;
173 }
174 options.options[num_options] = poptGetOptArg(pc);
175 options.options[num_options+1] = NULL;
176 num_options++;
177 break;
178
179 case 'c': {
180 const char *cs = poptGetOptArg(pc);
181 const char *p;
182
183 for (p = cs; p != NULL; ) {
184 const char *t, *c;
185
186 t = strchr(p, ',');
187 if (t == NULL) {
188 c = talloc_strdup(options.controls, p);
189 p = NULL;
190 } else {
191 c = talloc_strndup(options.controls, p, t-p);
192 p = t + 1;
193 }
194 if (c == NULL || !add_control(ret, c)) {
195 fprintf(stderr, __location__ ": out of memory\n");
196 goto failed;
197 }
198 }
199
200 break;
201 }
202 case 'P':
203 if (!add_control(ret, "paged_results:1:1024")) {
204 fprintf(stderr, __location__ ": out of memory\n");
205 goto failed;
206 }
207 break;
208 case 'D':
209 if (!add_control(ret, "show_deleted:1")) {
210 fprintf(stderr, __location__ ": out of memory\n");
211 goto failed;
212 }
213 break;
214 case 'R':
215 if (!add_control(ret, "show_recycled:0")) {
216 fprintf(stderr, __location__ ": out of memory\n");
217 goto failed;
218 }
219 break;
220 case 'd':
221 if (!add_control(ret, "show_deactivated_link:0")) {
222 fprintf(stderr, __location__ ": out of memory\n");
223 goto failed;
224 }
225 break;
226 case 'r':
227 if (!add_control(ret, "reveal_internals:0")) {
228 fprintf(stderr, __location__ ": out of memory\n");
229 goto failed;
230 }
231 break;
232 case CMDLINE_RELAX:
233 if (!add_control(ret, "relax:0")) {
234 fprintf(stderr, __location__ ": out of memory\n");
235 goto failed;
236 }
237 break;
238 case 'N':
239 if (!add_control(ret, "search_options:1:2")) {
240 fprintf(stderr, __location__ ": out of memory\n");
241 goto failed;
242 }
243 break;
244 case 'E':
245 if (!add_control(ret, "extended_dn:1:1")) {
246 fprintf(stderr, __location__ ": out of memory\n");
247 goto failed;
248 }
249 break;
250 default:
251 fprintf(stderr, "Invalid option %s: %s\n",
252 poptBadOption(pc, 0), poptStrerror(opt));
253 if (usage) usage(ldb);
254 goto failed;
255 }
256 }
257
258 /* setup the remaining options for the main program to use */
259 options.argv = poptGetArgs(pc);
260 if (options.argv) {
261 options.argv++;
262 while (options.argv[options.argc]) options.argc++;
263 }
264
265 *ret = options;
266
267 /* all utils need some option */
268 if (ret->url == NULL) {
269 fprintf(stderr, "You must supply a url with -H or with $LDB_URL\n");
270 if (usage) usage(ldb);
271 goto failed;
272 }
273
274 if (strcmp(ret->url, "NONE") == 0) {
275 return ret;
276 }
277
278 if (options.nosync) {
279 flags |= LDB_FLG_NOSYNC;
280 }
281
282 if (search) {
283 flags |= LDB_FLG_DONT_CREATE_DB;
284
285 if (options.show_binary) {
286 flags |= LDB_FLG_SHOW_BINARY;
287 }
288 }
289
290 if (options.tracing) {
291 flags |= LDB_FLG_ENABLE_TRACING;
292 }
293
294 if (options.modules_path != NULL) {
295 ldb_set_modules_dir(ldb, options.modules_path);
296 }
297
298 rc = ldb_modules_hook(ldb, LDB_MODULE_HOOK_CMDLINE_PRECONNECT);
299 if (rc != LDB_SUCCESS) {
300 fprintf(stderr, "ldb: failed to run preconnect hooks : %s\n", ldb_strerror(rc));
301 goto failed;
302 }
303
304 /* now connect to the ldb */
305 if (ldb_connect(ldb, ret->url, flags, ret->options) != LDB_SUCCESS) {
306 fprintf(stderr, "Failed to connect to %s - %s\n",
307 ret->url, ldb_errstring(ldb));
308 goto failed;
309 }
310
311 rc = ldb_modules_hook(ldb, LDB_MODULE_HOOK_CMDLINE_POSTCONNECT);
312 if (rc != LDB_SUCCESS) {
313 fprintf(stderr, "ldb: failed to run post connect hooks : %s\n", ldb_strerror(rc));
314 goto failed;
315 }
316
317 return ret;
318
319 failed:
320 talloc_free(ret);
321 exit(LDB_ERR_OPERATIONS_ERROR);
322 return NULL;
323 }
324
325 struct ldb_cmdline *ldb_cmdline_process_search(struct ldb_context *ldb,
326 int argc, const char **argv,
327 void (*usage)(struct ldb_context *))
328 {
329 return ldb_cmdline_process_internal(ldb, argc, argv, usage, true);
330 }
331
332 struct ldb_cmdline *ldb_cmdline_process(struct ldb_context *ldb,
333 int argc, const char **argv,
334 void (*usage)(struct ldb_context *))
335 {
336 return ldb_cmdline_process_internal(ldb, argc, argv, usage, false);
337 }
338
339 /* this function check controls reply and determines if more
340 * processing is needed setting up the request controls correctly
341 *
342 * returns:
343 * -1 error
344 * 0 all ok
345 * 1 all ok, more processing required
346 */
347 int handle_controls_reply(struct ldb_control **reply, struct ldb_control **request)
348 {
349 unsigned int i, j;
350 int ret = 0;
351
352 if (reply == NULL || request == NULL) return -1;
353
354 for (i = 0; reply[i]; i++) {
355 if (strcmp(LDB_CONTROL_VLV_RESP_OID, reply[i]->oid) == 0) {
356 struct ldb_vlv_resp_control *rep_control;
357
358 rep_control = talloc_get_type(reply[i]->data, struct ldb_vlv_resp_control);
359
360 /* check we have a matching control in the request */
361 for (j = 0; request[j]; j++) {
362 if (strcmp(LDB_CONTROL_VLV_REQ_OID, request[j]->oid) == 0)
363 break;
364 }
365 if (! request[j]) {
366 fprintf(stderr, "Warning VLV reply received but no request have been made\n");
367 continue;
368 }
369
370 /* check the result */
371 if (rep_control->vlv_result != 0) {
372 fprintf(stderr, "Warning: VLV not performed with error: %d\n", rep_control->vlv_result);
373 } else {
374 fprintf(stderr, "VLV Info: target position = %d, content count = %d\n", rep_control->targetPosition, rep_control->contentCount);
375 }
376
377 continue;
378 }
379
380 if (strcmp(LDB_CONTROL_ASQ_OID, reply[i]->oid) == 0) {
381 struct ldb_asq_control *rep_control;
382
383 rep_control = talloc_get_type(reply[i]->data, struct ldb_asq_control);
384
385 /* check the result */
386 if (rep_control->result != 0) {
387 fprintf(stderr, "Warning: ASQ not performed with error: %d\n", rep_control->result);
388 }
389
390 continue;
391 }
392
393 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, reply[i]->oid) == 0) {
394 struct ldb_paged_control *rep_control, *req_control;
395
396 rep_control = talloc_get_type(reply[i]->data, struct ldb_paged_control);
397 if (rep_control->cookie_len == 0) /* we are done */
398 break;
399
400 /* more processing required */
401 /* let's fill in the request control with the new cookie */
402
403 for (j = 0; request[j]; j++) {
404 if (strcmp(LDB_CONTROL_PAGED_RESULTS_OID, request[j]->oid) == 0)
405 break;
406 }
407 /* if there's a reply control we must find a request
408 * control matching it */
409 if (! request[j]) return -1;
410
411 req_control = talloc_get_type(request[j]->data, struct ldb_paged_control);
412
413 if (req_control->cookie)
414 talloc_free(req_control->cookie);
415 req_control->cookie = (char *)talloc_memdup(
416 req_control, rep_control->cookie,
417 rep_control->cookie_len);
418 req_control->cookie_len = rep_control->cookie_len;
419
420 ret = 1;
421
422 continue;
423 }
424
425 if (strcmp(LDB_CONTROL_SORT_RESP_OID, reply[i]->oid) == 0) {
426 struct ldb_sort_resp_control *rep_control;
427
428 rep_control = talloc_get_type(reply[i]->data, struct ldb_sort_resp_control);
429
430 /* check we have a matching control in the request */
431 for (j = 0; request[j]; j++) {
432 if (strcmp(LDB_CONTROL_SERVER_SORT_OID, request[j]->oid) == 0)
433 break;
434 }
435 if (! request[j]) {
436 fprintf(stderr, "Warning Server Sort reply received but no request found\n");
437 continue;
438 }
439
440 /* check the result */
441 if (rep_control->result != 0) {
442 fprintf(stderr, "Warning: Sorting not performed with error: %d\n", rep_control->result);
443 }
444
445 continue;
446 }
447
448 if (strcmp(LDB_CONTROL_DIRSYNC_OID, reply[i]->oid) == 0) {
449 struct ldb_dirsync_control *rep_control, *req_control;
450 char *cookie;
451
452 rep_control = talloc_get_type(reply[i]->data, struct ldb_dirsync_control);
453 if (rep_control->cookie_len == 0) /* we are done */
454 break;
455
456 /* more processing required */
457 /* let's fill in the request control with the new cookie */
458
459 for (j = 0; request[j]; j++) {
460 if (strcmp(LDB_CONTROL_DIRSYNC_OID, request[j]->oid) == 0)
461 break;
462 }
463 /* if there's a reply control we must find a request
464 * control matching it */
465 if (! request[j]) return -1;
466
467 req_control = talloc_get_type(request[j]->data, struct ldb_dirsync_control);
468
469 if (req_control->cookie)
470 talloc_free(req_control->cookie);
471 req_control->cookie = (char *)talloc_memdup(
472 req_control, rep_control->cookie,
473 rep_control->cookie_len);
474 req_control->cookie_len = rep_control->cookie_len;
475
476 cookie = ldb_base64_encode(req_control, rep_control->cookie, rep_control->cookie_len);
477 printf("# DIRSYNC cookie returned was:\n# %s\n", cookie);
478
479 continue;
480 }
481 if (strcmp(LDB_CONTROL_DIRSYNC_EX_OID, reply[i]->oid) == 0) {
482 struct ldb_dirsync_control *rep_control, *req_control;
483 char *cookie;
484
485 rep_control = talloc_get_type(reply[i]->data, struct ldb_dirsync_control);
486 if (rep_control->cookie_len == 0) /* we are done */
487 break;
488
489 /* more processing required */
490 /* let's fill in the request control with the new cookie */
491
492 for (j = 0; request[j]; j++) {
493 if (strcmp(LDB_CONTROL_DIRSYNC_EX_OID, request[j]->oid) == 0)
494 break;
495 }
496 /* if there's a reply control we must find a request
497 * control matching it */
498 if (! request[j]) return -1;
499
500 req_control = talloc_get_type(request[j]->data, struct ldb_dirsync_control);
501
502 if (req_control->cookie)
503 talloc_free(req_control->cookie);
504 req_control->cookie = (char *)talloc_memdup(
505 req_control, rep_control->cookie,
506 rep_control->cookie_len);
507 req_control->cookie_len = rep_control->cookie_len;
508
509 cookie = ldb_base64_encode(req_control, rep_control->cookie, rep_control->cookie_len);
510 printf("# DIRSYNC_EX cookie returned was:\n# %s\n", cookie);
511
512 continue;
513 }
514
515 /* no controls matched, throw a warning */
516 fprintf(stderr, "Unknown reply control oid: %s\n", reply[i]->oid);
517 }
518
519 return ret;
520 }
521
Samba GIT mirror