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