1 /* slapcommon.c - common routine for the slap tools */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 The OpenLDAP Foundation.
6 * Portions Copyright 1998-2003 Kurt D. Zeilenga.
7 * Portions Copyright 2003 IBM Corporation.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
14 * A copy of this license is available in file LICENSE in the
15 * top-level directory of the distribution or, alternatively, at
16 * <http://www.OpenLDAP.org/license.html>.
19 * This work was initially developed by Kurt Zeilenga for inclusion
20 * in OpenLDAP Software. Additional signficant contributors include
22 * Hallvard B. Furuseth
31 #include <ac/stdlib.h>
33 #include <ac/string.h>
34 #include <ac/socket.h>
35 #include <ac/unistd.h>
37 #include "slapcommon.h"
40 tool_vars tool_globals;
43 static char *leakfilename;
44 static FILE *leakfile;
48 usage( int tool, const char *progname )
52 "usage: %s [-v] [-c] [-d debuglevel] [-f configfile]\n",
57 options = "\t[-n databasenumber | -b suffix]\n"
58 "\t[-l ldiffile] [-u] [-p [-w] | -r [-i syncreplidlist] [-w]]\n";
62 options = "\t[-n databasenumber | -b suffix]"
63 " [-l ldiffile] [-a filter] [-m] [-k]\n";
67 options = "\tDN [...]\n";
71 options = "\t[-n databasenumber | -b suffix]\n";
75 options = "\t[-U authcID] [-X authzID] [-R realm] [-M mech] ID [...]\n";
79 options = "\t[-U authcID | -D authcDN]"
80 " -b DN [attr[/access][:value]] [...]\n";
84 if ( options != NULL ) {
85 fputs( options, stderr );
92 * slap_tool_init - initialize slap utility, handle program options.
96 * argc, argv command line arguments
101 const char* progname,
103 int argc, char **argv )
106 char *conffile = SLAPD_DEFAULT_CONFIGFILE;
107 struct berval base = BER_BVNULL;
108 char *filterstr = NULL;
109 char *subtree = NULL;
110 char *ldiffile = NULL;
112 int mode = SLAP_TOOL_MODE;
113 int truncatemode = 0;
116 leakfilename = malloc( strlen( progname ) + STRLEOF( ".leak" ) - 1 );
117 sprintf( leakfilename, "%s.leak", progname );
118 if( ( leakfile = fopen( leakfilename, "w" )) == NULL ) {
121 free( leakfilename );
126 options = "b:cd:f:i:l:n:prtuvWw";
130 options = "a:b:cd:f:kl:mn:s:v";
131 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
137 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
141 options = "d:f:M:R:U:vX:";
142 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
146 options = "b:cd:f:n:v";
147 mode |= SLAP_TOOL_READMAIN;
151 options = "b:D:d:f:U:v";
152 mode |= SLAP_TOOL_READMAIN | SLAP_TOOL_READONLY;
156 fprintf( stderr, "%s: unknown tool mode (%d)\n", progname, tool );
157 exit( EXIT_FAILURE );
161 while ( (i = getopt( argc, argv, options )) != EOF ) {
164 filterstr = strdup( optarg );
168 ber_str2bv( optarg, 0, 1, &base );
171 case 'c': /* enable continue mode */
175 case 'd': /* turn on debugging */
176 ldap_debug += atoi( optarg );
180 ber_str2bv( optarg, 0, 1, &authcDN );
183 case 'f': /* specify a conf file */
184 conffile = strdup( optarg );
187 case 'i': /* specify syncrepl id list */
188 replica_id_string = strdup( optarg );
189 if ( !isdigit( (unsigned char) *replica_id_string )) {
190 usage( tool, progname );
191 exit( EXIT_FAILURE );
193 slap_str2clist( &replica_id_strlist, replica_id_string, "," );
194 for ( i = 0; replica_id_strlist && replica_id_strlist[i]; i++ ) ;
195 replica_id_list = ch_calloc( i + 1, sizeof( int ) );
196 for ( i = 0; replica_id_strlist && replica_id_strlist[i]; i++ ) {
197 replica_id_list[i] = atoi( replica_id_strlist[i] );
198 if ( replica_id_list[i] >= 1000 ) {
200 "%s: syncrepl id %d is out of range [0..999]\n",
201 progname, replica_id_list[i] );
202 exit( EXIT_FAILURE );
205 replica_id_list[i] = -1;
208 case 'k': /* Retrieve sync cookie entry */
209 retrieve_synccookie = 1;
212 case 'l': /* LDIF file */
213 ldiffile = strdup( optarg );
216 case 'm': /* Retrieve ldapsync entry */
221 ber_str2bv( optarg, 0, 0, &mech );
224 case 'n': /* which config file db to index */
225 dbnum = atoi( optarg ) - 1;
228 case 'p': /* replica promotion */
229 replica_promotion = 1;
232 case 'r': /* replica demotion */
233 replica_demotion = 1;
240 case 's': /* dump subtree */
241 subtree = strdup( optarg );
244 case 't': /* turn on truncate */
246 mode |= SLAP_TRUNCATE_MODE;
250 ber_str2bv( optarg, 0, 0, &authcID );
253 case 'u': /* dry run */
257 case 'v': /* turn on verbose */
261 case 'W': /* write context csn on every entry add */
262 update_ctxcsn = SLAP_TOOL_CTXCSN_BATCH;
263 /* FIXME : update_ctxcsn = SLAP_TOOL_CTXCSN_ENTRY; */
266 case 'w': /* write context csn on at the end */
267 update_ctxcsn = SLAP_TOOL_CTXCSN_BATCH;
271 ber_str2bv( optarg, 0, 0, &authzID );
275 usage( tool, progname );
284 if ( ( argc != optind ) || (dbnum >= 0 && base.bv_val != NULL ) ) {
285 usage( tool, progname );
288 if ( replica_promotion && replica_demotion ) {
289 usage( tool, progname );
291 } else if ( !replica_promotion && !replica_demotion ) {
292 if ( update_ctxcsn != SLAP_TOOL_CTXCSN_KEEP ) {
293 usage( tool, progname );
299 if ( argc == optind ) {
300 usage( tool, progname );
305 if ( argc == optind && BER_BVISNULL( &authcID ) ) {
306 usage( tool, progname );
311 if ( argc != optind ) {
312 usage( tool, progname );
317 if ( !BER_BVISNULL( &authcDN ) && !BER_BVISNULL( &authcID ) ) {
318 usage( tool, progname );
320 if ( BER_BVISNULL( &base ) ) {
321 usage( tool, progname );
323 ber_dupbv( &baseDN, &base );
330 if ( ldiffile == NULL ) {
331 ldiffp = tool == SLAPCAT ? stdout : stdin;
333 } else if ((ldiffp = fopen( ldiffile, tool == SLAPCAT ? "w" : "r" ))
337 exit( EXIT_FAILURE );
341 * initialize stuff and figure out which backend we're dealing with
345 if ( module_init() != 0 ) {
346 fprintf( stderr, "%s: module_init failed!\n", progname );
347 exit( EXIT_FAILURE );
351 rc = slap_init( mode, progname );
354 fprintf( stderr, "%s: slap_init failed!\n", progname );
355 exit( EXIT_FAILURE );
358 rc = slap_schema_init();
361 fprintf( stderr, "%s: slap_schema_init failed!\n", progname );
362 exit( EXIT_FAILURE );
365 if ( frontend_init() ) {
366 fprintf( stderr, "%s: frontend_init failed!\n", progname );
367 exit( EXIT_FAILURE );
370 if ( overlay_init() ) {
371 fprintf( stderr, "%s: overlay_init failed!\n", progname );
372 exit( EXIT_FAILURE );
375 rc = read_config( conffile, 0 );
378 fprintf( stderr, "%s: bad configuration file!\n", progname );
379 exit( EXIT_FAILURE );
389 fprintf( stderr, "No databases found "
390 "in config file\n" );
391 exit( EXIT_FAILURE );
399 rc = slap_schema_check();
402 fprintf( stderr, "%s: slap_schema_prep failed!\n", progname );
403 exit( EXIT_FAILURE );
418 filter = str2filter( filterstr );
420 if( filter == NULL ) {
421 fprintf( stderr, "Invalid filter '%s'\n", filterstr );
422 exit( EXIT_FAILURE );
428 ber_str2bv( subtree, 0, 0, &val );
429 rc = dnNormalize( 0, NULL, NULL, &val, &sub_ndn, NULL );
430 if( rc != LDAP_SUCCESS ) {
431 fprintf( stderr, "Invalid subtree DN '%s'\n", subtree );
432 exit( EXIT_FAILURE );
435 if ( BER_BVISNULL( &base ) && dbnum == -1 ) {
442 if( base.bv_val != NULL ) {
445 rc = dnNormalize( 0, NULL, NULL, &base, &nbase, NULL );
446 if( rc != LDAP_SUCCESS ) {
447 fprintf( stderr, "%s: slap_init invalid suffix (\"%s\")\n",
448 progname, base.bv_val );
449 exit( EXIT_FAILURE );
452 be = select_backend( &nbase, 0, 0 );
453 ber_memfree( nbase.bv_val );
464 fprintf( stderr, "%s: slap_init no backend for \"%s\"\n",
465 progname, base.bv_val );
466 exit( EXIT_FAILURE );
468 /* If the named base is a glue master, operate on the
471 if (SLAP_GLUE_INSTANCE(be)) {
475 } else if ( dbnum == -1 ) {
476 if ( nbackends <= 0 ) {
477 fprintf( stderr, "No available databases\n" );
478 exit( EXIT_FAILURE );
481 be = &backends[dbnum=0];
482 /* If just doing the first by default and it is a
483 * glue subordinate, find the master.
485 while (SLAP_GLUE_SUBORDINATE(be) || SLAP_MONITOR(be)) {
486 if (SLAP_GLUE_SUBORDINATE(be)) {
494 if ( dbnum >= nbackends ) {
495 fprintf( stderr, "Available database(s) "
496 "do not allow %s\n", progname );
497 exit( EXIT_FAILURE );
500 if ( nosubordinates == 0 && dbnum > 0 ) {
501 Debug( LDAP_DEBUG_ANY,
502 "The first database does not allow %s;"
503 " using the first available one (%d)\n",
504 progname, dbnum + 1, 0 );
507 } else if ( dbnum < 0 || dbnum > (nbackends-1) ) {
509 "Database number selected via -n is out of range\n"
510 "Must be in the range 1 to %d"
511 " (number of databases in the config file)\n",
513 exit( EXIT_FAILURE );
516 be = &backends[dbnum];
525 if ( !dryrun && slap_startup( be ) ) {
526 fprintf( stderr, "slap_startup failed\n" );
527 exit( EXIT_FAILURE );
531 void slap_tool_destroy( void )
533 if ( !dryrun && be != NULL ) {
538 if ( slapMode == SLAP_SERVER_MODE ) {
539 /* always false. just pulls in necessary symbol references. */
540 lutil_uuidstr(NULL, 0);
546 ldap_pvt_tls_destroy();
551 mal_dumpleaktrace( leakfile );
554 if ( !BER_BVISNULL( &authcDN ) ) {
555 ch_free( authcDN.bv_val );