git.sur5r.net Git - openldap/blob - clients/tools/ldapdelete.c

   1 /* ldapdelete.c - simple program to delete an entry using LDAP */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2011 The OpenLDAP Foundation.
   6  * Portions Copyright 1998-2003 Kurt D. Zeilenga.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  13  * A copy of this license is available in the file LICENSE in the
  14  * top-level directory of the distribution or, alternatively, at
  15  * <http://www.OpenLDAP.org/license.html>.
  16  */
  17 /* Portions Copyright (c) 1992-1996 Regents of the University of Michigan.
  18  * All rights reserved.
  19  *
  20  * Redistribution and use in source and binary forms are permitted
  21  * provided that this notice is preserved and that due credit is given
  22  * to the University of Michigan at Ann Arbor.  The name of the
  23  * University may not be used to endorse or promote products derived
  24  * from this software without specific prior written permission.  This
  25  * software is provided ``as is'' without express or implied warranty.
  26  */
  27 /* ACKNOWLEDGEMENTS:
  28  * This work was originally developed by the University of Michigan
  29  * (as part of U-MICH LDAP).  Additional significant contributors
  30  * include:
  31  *   Kurt D. Zeilenga
  32  */
  33
  34 #include "portable.h"
  35
  36 #include <stdio.h>
  37
  38 #include <ac/stdlib.h>
  39 #include <ac/ctype.h>
  40 #include <ac/string.h>
  41 #include <ac/unistd.h>
  42 #include <ac/socket.h>
  43 #include <ac/time.h>
  44
  45 #include <ldap.h>
  46 #include "lutil.h"
  47 #include "lutil_ldap.h"
  48 #include "ldap_defaults.h"
  49
  50 #include "common.h"
  51
  52
  53 static int      prune = 0;
  54 static int sizelimit = -1;
  55
  56
  57 static int dodelete LDAP_P((
  58     LDAP *ld,
  59     const char *dn));
  60
  61 static int deletechildren LDAP_P((
  62         LDAP *ld,
  63         const char *dn,
  64         int subentries ));
  65
  66 void
  67 usage( void )
  68 {
  69         fprintf( stderr, _("Delete entries from an LDAP server\n\n"));
  70         fprintf( stderr, _("usage: %s [options] [dn]...\n"), prog);
  71         fprintf( stderr, _("    dn: list of DNs to delete. If not given, it will be readed from stdin\n"));
  72         fprintf( stderr, _("        or from the file specified with \"-f file\".\n"));
  73         fprintf( stderr, _("Delete Options:\n"));
  74         fprintf( stderr, _("  -c         continuous operation mode (do not stop on errors)\n"));
  75         fprintf( stderr, _("  -f file    read operations from `file'\n"));
  76         fprintf( stderr, _("  -M         enable Manage DSA IT control (-MM to make critical)\n"));
  77         fprintf( stderr, _("  -P version protocol version (default: 3)\n"));
  78         fprintf( stderr, _("  -r         delete recursively\n"));
  79         tool_common_usage();
  80         exit( EXIT_FAILURE );
  81 }
  82
  83
  84 const char options[] = "r"
  85         "cd:D:e:f:h:H:IMnNO:o:p:P:QR:U:vVw:WxX:y:Y:z:Z";
  86
  87 int
  88 handle_private_option( int i )
  89 {
  90         int ival;
  91         char *next;
  92         switch ( i ) {
  93 #if 0
  94                 int crit;
  95                 char *control, *cvalue;
  96         case 'E': /* delete extensions */
  97                 if( protocol == LDAP_VERSION2 ) {
  98                         fprintf( stderr, _("%s: -E incompatible with LDAPv%d\n"),
  99                                 prog, protocol );
 100                         exit( EXIT_FAILURE );
 101                 }
 102
 103                 /* should be extended to support comma separated list of
 104                  *      [!]key[=value] parameters, e.g.  -E !foo,bar=567
 105                  */
 106
 107                 crit = 0;
 108                 cvalue = NULL;
 109                 if( optarg[0] == '!' ) {
 110                         crit = 1;
 111                         optarg++;
 112                 }
 113
 114                 control = strdup( optarg );
 115                 if ( (cvalue = strchr( control, '=' )) != NULL ) {
 116                         *cvalue++ = '\0';
 117                 }
 118                 fprintf( stderr, _("Invalid delete extension name: %s\n"), control );
 119                 usage();
 120 #endif
 121
 122         case 'r':
 123                 prune = 1;
 124                 break;
 125
 126         case 'z':       /* size limit */
 127                 if ( strcasecmp( optarg, "none" ) == 0 ) {
 128                         sizelimit = 0;
 129
 130                 } else if ( strcasecmp( optarg, "max" ) == 0 ) {
 131                         sizelimit = LDAP_MAXINT;
 132
 133                 } else {
 134                         ival = strtol( optarg, &next, 10 );
 135                         if ( next == NULL || next[0] != '\0' ) {
 136                                 fprintf( stderr,
 137                                         _("Unable to parse size limit \"%s\"\n"), optarg );
 138                                 exit( EXIT_FAILURE );
 139                         }
 140                         sizelimit = ival;
 141                 }
 142                 if( sizelimit < 0 || sizelimit > LDAP_MAXINT ) {
 143                         fprintf( stderr, _("%s: invalid sizelimit (%d) specified\n"),
 144                                 prog, sizelimit );
 145                         exit( EXIT_FAILURE );
 146                 }
 147                 break;
 148
 149         default:
 150                 return 0;
 151         }
 152         return 1;
 153 }
 154
 155
 156 static void
 157 private_conn_setup( LDAP *ld )
 158 {
 159         /* this seems prudent for searches below */
 160         int deref = LDAP_DEREF_NEVER;
 161         ldap_set_option( ld, LDAP_OPT_DEREF, &deref );
 162 }
 163
 164
 165 int
 166 main( int argc, char **argv )
 167 {
 168         char            buf[ 4096 ];
 169         FILE            *fp = NULL;
 170         LDAP            *ld;
 171         int             rc, retval;
 172
 173         tool_init( TOOL_DELETE );
 174     prog = lutil_progname( "ldapdelete", argc, argv );
 175
 176         tool_args( argc, argv );
 177
 178         if ( infile != NULL ) {
 179                 if (( fp = fopen( infile, "r" )) == NULL ) {
 180                         perror( optarg );
 181                         exit( EXIT_FAILURE );
 182             }
 183         } else {
 184                 if ( optind >= argc ) {
 185                         fp = stdin;
 186                 }
 187         }
 188
 189         ld = tool_conn_setup( 0, &private_conn_setup );
 190
 191         tool_bind( ld );
 192
 193         tool_server_controls( ld, NULL, 0 );
 194
 195         retval = rc = 0;
 196
 197         if ( fp == NULL ) {
 198                 for ( ; optind < argc; ++optind ) {
 199                         rc = dodelete( ld, argv[ optind ] );
 200
 201                         /* Stop on error and no -c option */
 202                         if( rc != 0 ) {
 203                                 retval = rc;
 204                                 if( contoper == 0 ) break;
 205                         }
 206                 }
 207         } else {
 208                 while ((rc == 0 || contoper) && fgets(buf, sizeof(buf), fp) != NULL) {
 209                         buf[ strlen( buf ) - 1 ] = '\0'; /* remove trailing newline */
 210
 211                         if ( *buf != '\0' ) {
 212                                 rc = dodelete( ld, buf );
 213                                 if ( rc != 0 )
 214                                         retval = rc;
 215                         }
 216                 }
 217                 if ( fp != stdin )
 218                         fclose( fp );
 219         }
 220
 221         tool_unbind( ld );
 222         tool_destroy();
 223     return retval;
 224 }
 225
 226
 227 static int dodelete(
 228     LDAP        *ld,
 229     const char  *dn)
 230 {
 231         int id;
 232         int     rc, code;
 233         char *matcheddn = NULL, *text = NULL, **refs = NULL;
 234         LDAPControl **ctrls = NULL;
 235         LDAPMessage *res;
 236         int subentries = 0;
 237
 238         if ( verbose ) {
 239                 printf( _("%sdeleting entry \"%s\"\n"),
 240                         (dont ? "!" : ""), dn );
 241         }
 242
 243         if ( dont ) {
 244                 return LDAP_SUCCESS;
 245         }
 246
 247         /* If prune is on, remove a whole subtree.  Delete the children of the
 248          * DN recursively, then the DN requested.
 249          */
 250         if ( prune ) {
 251 retry:;
 252                 deletechildren( ld, dn, subentries );
 253         }
 254
 255         rc = ldap_delete_ext( ld, dn, NULL, NULL, &id );
 256         if ( rc != LDAP_SUCCESS ) {
 257                 fprintf( stderr, "%s: ldap_delete_ext: %s (%d)\n",
 258                         prog, ldap_err2string( rc ), rc );
 259                 return rc;
 260         }
 261
 262         for ( ; ; ) {
 263                 struct timeval tv;
 264
 265                 if ( tool_check_abandon( ld, id ) ) {
 266                         return LDAP_CANCELLED;
 267                 }
 268
 269                 tv.tv_sec = 0;
 270                 tv.tv_usec = 100000;
 271
 272                 rc = ldap_result( ld, LDAP_RES_ANY, LDAP_MSG_ALL, &tv, &res );
 273                 if ( rc < 0 ) {
 274                         tool_perror( "ldap_result", rc, NULL, NULL, NULL, NULL );
 275                         return rc;
 276                 }
 277
 278                 if ( rc != 0 ) {
 279                         break;
 280                 }
 281         }
 282
 283         rc = ldap_parse_result( ld, res, &code, &matcheddn, &text, &refs, &ctrls, 1 );
 284
 285         switch ( rc ) {
 286         case LDAP_SUCCESS:
 287                 break;
 288
 289         case LDAP_NOT_ALLOWED_ON_NONLEAF:
 290                 if ( prune && !subentries ) {
 291                         subentries = 1;
 292                         goto retry;
 293                 }
 294                 /* fallthru */
 295
 296         default:
 297                 fprintf( stderr, "%s: ldap_parse_result: %s (%d)\n",
 298                         prog, ldap_err2string( rc ), rc );
 299                 return rc;
 300         }
 301
 302         if( code != LDAP_SUCCESS ) {
 303                 tool_perror( "ldap_delete", code, NULL, matcheddn, text, refs );
 304         } else if ( verbose &&
 305                 ((matcheddn && *matcheddn) || (text && *text) || (refs && *refs) ))
 306         {
 307                 printf( _("Delete Result: %s (%d)\n"),
 308                         ldap_err2string( code ), code );
 309
 310                 if( text && *text ) {
 311                         printf( _("Additional info: %s\n"), text );
 312                 }
 313
 314                 if( matcheddn && *matcheddn ) {
 315                         printf( _("Matched DN: %s\n"), matcheddn );
 316                 }
 317
 318                 if( refs ) {
 319                         int i;
 320                         for( i=0; refs[i]; i++ ) {
 321                                 printf(_("Referral: %s\n"), refs[i] );
 322                         }
 323                 }
 324         }
 325
 326         if (ctrls) {
 327                 tool_print_ctrls( ld, ctrls );
 328                 ldap_controls_free( ctrls );
 329         }
 330
 331         ber_memfree( text );
 332         ber_memfree( matcheddn );
 333         ber_memvfree( (void **) refs );
 334
 335         return code;
 336 }
 337
 338 /*
 339  * Delete all the children of an entry recursively until leaf nodes are reached.
 340  */
 341 static int deletechildren(
 342         LDAP *ld,
 343         const char *base,
 344         int subentries )
 345 {
 346         LDAPMessage *res, *e;
 347         int entries;
 348         int rc = LDAP_SUCCESS, srch_rc;
 349         static char *attrs[] = { LDAP_NO_ATTRS, NULL };
 350         LDAPControl c, *ctrls[2], **ctrlsp = NULL;
 351         BerElement *ber = NULL;
 352
 353         if ( verbose ) printf ( _("deleting children of: %s\n"), base );
 354
 355         if ( subentries ) {
 356                 /*
 357                  * Do a one level search at base for subentry children.
 358                  */
 359
 360                 if ((ber = ber_alloc_t(LBER_USE_DER)) == NULL) {
 361                         return EXIT_FAILURE;
 362                 }
 363                 rc = ber_printf( ber, "b", 1 );
 364                 if ( rc == -1 ) {
 365                         ber_free( ber, 1 );
 366                         fprintf( stderr, _("Subentries control encoding error!\n"));
 367                         return EXIT_FAILURE;
 368                 }
 369                 if ( ber_flatten2( ber, &c.ldctl_value, 0 ) == -1 ) {
 370                         return EXIT_FAILURE;
 371                 }
 372                 c.ldctl_oid = LDAP_CONTROL_SUBENTRIES;
 373                 c.ldctl_iscritical = 1;
 374                 ctrls[0] = &c;
 375                 ctrls[1] = NULL;
 376                 ctrlsp = ctrls;
 377         }
 378
 379         /*
 380          * Do a one level search at base for children.  For each, delete its children.
 381          */
 382 more:;
 383         srch_rc = ldap_search_ext_s( ld, base, LDAP_SCOPE_ONELEVEL, NULL, attrs, 1,
 384                 ctrlsp, NULL, NULL, sizelimit, &res );
 385         switch ( srch_rc ) {
 386         case LDAP_SUCCESS:
 387         case LDAP_SIZELIMIT_EXCEEDED:
 388                 break;
 389         default:
 390                 tool_perror( "ldap_search", srch_rc, NULL, NULL, NULL, NULL );
 391                 return( srch_rc );
 392         }
 393
 394         entries = ldap_count_entries( ld, res );
 395
 396         if ( entries > 0 ) {
 397                 int i;
 398
 399                 for (e = ldap_first_entry( ld, res ), i = 0; e != NULL;
 400                         e = ldap_next_entry( ld, e ), i++ )
 401                 {
 402                         char *dn = ldap_get_dn( ld, e );
 403
 404                         if( dn == NULL ) {
 405                                 ldap_get_option( ld, LDAP_OPT_RESULT_CODE, &rc );
 406                                 tool_perror( "ldap_prune", rc, NULL, NULL, NULL, NULL );
 407                                 ber_memfree( dn );
 408                                 return rc;
 409                         }
 410
 411                         rc = deletechildren( ld, dn, 0 );
 412                         if ( rc != LDAP_SUCCESS ) {
 413                                 tool_perror( "ldap_prune", rc, NULL, NULL, NULL, NULL );
 414                                 ber_memfree( dn );
 415                                 return rc;
 416                         }
 417
 418                         if ( verbose ) {
 419                                 printf( _("\tremoving %s\n"), dn );
 420                         }
 421
 422                         rc = ldap_delete_ext_s( ld, dn, NULL, NULL );
 423                         if ( rc != LDAP_SUCCESS ) {
 424                                 tool_perror( "ldap_delete", rc, NULL, NULL, NULL, NULL );
 425                                 ber_memfree( dn );
 426                                 return rc;
 427
 428                         }
 429
 430                         if ( verbose ) {
 431                                 printf( _("\t%s removed\n"), dn );
 432                         }
 433
 434                         ber_memfree( dn );
 435                 }
 436         }
 437
 438         ldap_msgfree( res );
 439
 440         if ( srch_rc == LDAP_SIZELIMIT_EXCEEDED ) {
 441                 goto more;
 442         }
 443
 444         return rc;
 445 }