git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/search.c

   1 /* search.c - search operation */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #include "portable.h"
   9
  10 #include <stdio.h>
  11 #include <ac/string.h>
  12
  13 #include "back-bdb.h"
  14 #include "idl.h"
  15 #include "external.h"
  16
  17 static int base_candidate(
  18         BackendDB       *be,
  19         Entry   *e,
  20         ID              *ids );
  21 static int search_candidates(
  22         BackendDB *be,
  23         Entry *e,
  24         Filter *filter,
  25         int scope,
  26         int deref,
  27         int manageDSAit,
  28         ID      *ids );
  29
  30 int
  31 bdb_search(
  32         BackendDB       *be,
  33         Connection      *conn,
  34         Operation       *op,
  35         struct berval   *base,
  36         struct berval   *nbase,
  37         int             scope,
  38         int             deref,
  39         int             slimit,
  40         int             tlimit,
  41         Filter  *filter,
  42         struct berval   *filterstr,
  43         AttributeName   *attrs,
  44         int             attrsonly )
  45 {
  46         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
  47         int              abandon;
  48         int             rc;
  49         const char *text = NULL;
  50         time_t          stoptime;
  51         ID              id, cursor;
  52         ID              candidates[BDB_IDL_UM_SIZE];
  53         Entry           *e = NULL;
  54         BVarray v2refs = NULL;
  55         Entry   *matched = NULL;
  56         struct berval   realbase = { 0, NULL };
  57         int             nentries = 0;
  58         int             manageDSAit;
  59
  60         struct slap_limits_set *limit = NULL;
  61         int isroot = 0;
  62
  63         Debug( LDAP_DEBUG_TRACE, "=> bdb_back_search\n",
  64                 0, 0, 0);
  65
  66         manageDSAit = get_manageDSAit( op );
  67
  68         if ( nbase->bv_len == 0 ) {
  69                 /* DIT root special case */
  70                 e = (Entry *) &slap_entry_root;
  71                 rc = 0;
  72         } else
  73 #ifdef BDB_ALIASES
  74         /* get entry with reader lock */
  75         if ( deref & LDAP_DEREF_FINDING ) {
  76                 e = deref_dn_r( be, nbase-, &err, &matched, &text );
  77
  78         } else
  79 #endif
  80         {
  81                 rc = bdb_dn2entry( be, NULL, nbase, &e, &matched, 0 );
  82         }
  83
  84         switch(rc) {
  85         case DB_NOTFOUND:
  86         case 0:
  87                 break;
  88         default:
  89                 send_ldap_result( conn, op, rc=LDAP_OTHER,
  90                         NULL, "internal error", NULL, NULL );
  91                 return rc;
  92         }
  93
  94         if ( e == NULL ) {
  95                 struct berval matched_dn = { 0, NULL };
  96                 BVarray refs = NULL;
  97
  98                 if ( matched != NULL ) {
  99                         BVarray erefs;
 100
 101                         ber_dupbv( &matched_dn, &matched->e_name );
 102
 103                         erefs = is_entry_referral( matched )
 104                                 ? get_entry_referrals( be, conn, op, matched )
 105                                 : NULL;
 106
 107                         bdb_entry_return( be, matched );
 108                         matched = NULL;
 109
 110                         if( erefs ) {
 111                                 refs = referral_rewrite( erefs, &matched_dn,
 112                                         base, scope );
 113                                 bvarray_free( erefs );
 114                         }
 115
 116                 } else {
 117                         refs = referral_rewrite( default_referral,
 118                                 NULL, base, scope );
 119                 }
 120
 121                 send_ldap_result( conn, op,     rc=LDAP_REFERRAL ,
 122                         matched_dn.bv_val, text, refs, NULL );
 123
 124                 if ( refs ) bvarray_free( refs );
 125                 if ( matched_dn.bv_val ) ber_memfree( matched_dn.bv_val );
 126                 return rc;
 127         }
 128
 129         if (!manageDSAit && e != &slap_entry_root && is_entry_referral( e ) ) {
 130                 /* entry is a referral, don't allow add */
 131                 struct berval matched_dn;
 132                 BVarray erefs, refs;
 133
 134                 ber_dupbv( &matched_dn, &e->e_name );
 135                 erefs = get_entry_referrals( be, conn, op, e );
 136                 refs = NULL;
 137
 138                 bdb_entry_return( be, e );
 139                 e = NULL;
 140
 141                 if( erefs ) {
 142                         refs = referral_rewrite( erefs, &matched_dn,
 143                                 base, scope );
 144                         bvarray_free( erefs );
 145                 }
 146
 147                 Debug( LDAP_DEBUG_TRACE, "bdb_search: entry is referral\n",
 148                         0, 0, 0 );
 149
 150                 send_ldap_result( conn, op, LDAP_REFERRAL,
 151                         matched_dn.bv_val,
 152                         refs ? NULL : "bad referral object",
 153                         refs, NULL );
 154
 155                 bvarray_free( refs );
 156                 ber_memfree( matched_dn.bv_val );
 157                 return 1;
 158         }
 159
 160         /* if not root, get appropriate limits */
 161         if ( be_isroot( be, &op->o_ndn ) ) {
 162                 isroot = 1;
 163         } else {
 164                 ( void ) get_limits( be, &op->o_ndn, &limit );
 165         }
 166
 167         /* The time/size limits come first because they require very little
 168          * effort, so there's no chance the candidates are selected and then
 169          * the request is not honored only because of time/size constraints */
 170
 171         /* if no time limit requested, use soft limit (unless root!) */
 172         if ( isroot ) {
 173                 if ( tlimit == 0 ) {
 174                         tlimit = -1;    /* allow root to set no limit */
 175                 }
 176
 177                 if ( slimit == 0 ) {
 178                         slimit = -1;
 179                 }
 180
 181         } else {
 182                 /* if no limit is required, use soft limit */
 183                 if ( tlimit <= 0 ) {
 184                         tlimit = limit->lms_t_soft;
 185
 186                 /* if requested limit higher than hard limit, abort */
 187                 } else if ( tlimit > limit->lms_t_hard ) {
 188                         /* no hard limit means use soft instead */
 189                         if ( limit->lms_t_hard == 0 ) {
 190                                 tlimit = limit->lms_t_soft;
 191
 192                         /* positive hard limit means abort */
 193                         } else if ( limit->lms_t_hard > 0 ) {
 194                                 send_search_result( conn, op,
 195                                                 LDAP_UNWILLING_TO_PERFORM,
 196                                                 NULL, NULL, NULL, NULL, 0 );
 197                                 rc = 0;
 198                                 goto done;
 199                         }
 200
 201                         /* negative hard limit means no limit */
 202                 }
 203
 204                 /* if no limit is required, use soft limit */
 205                 if ( slimit <= 0 ) {
 206                         slimit = limit->lms_s_soft;
 207
 208                 /* if requested limit higher than hard limit, abort */
 209                 } else if ( slimit > limit->lms_s_hard ) {
 210                         /* no hard limit means use soft instead */
 211                         if ( limit->lms_s_hard == 0 ) {
 212                                 slimit = limit->lms_s_soft;
 213
 214                         /* positive hard limit means abort */
 215                         } else if ( limit->lms_s_hard > 0 ) {
 216                                 send_search_result( conn, op,
 217                                                 LDAP_UNWILLING_TO_PERFORM,
 218                                                 NULL, NULL, NULL, NULL, 0 );
 219                                 rc = 0;
 220                                 goto done;
 221                         }
 222
 223                         /* negative hard limit means no limit */
 224                 }
 225         }
 226
 227         /* compute it anyway; root does not use it */
 228         stoptime = op->o_time + tlimit;
 229
 230         /* select candidates */
 231         if ( scope == LDAP_SCOPE_BASE ) {
 232                 rc = base_candidate( be, e, candidates );
 233
 234         } else {
 235                 BDB_IDL_ALL( bdb, candidates );
 236                 rc = search_candidates( be, e, filter,
 237                         scope, deref, manageDSAit, candidates );
 238         }
 239
 240         /* need normalized dn below */
 241         ber_dupbv( &realbase, &e->e_nname );
 242
 243         /* start cursor at base entry's id
 244          * FIXME: hack to make "" base work */
 245         cursor = e->e_id == NOID ? 1 : e->e_id;
 246
 247         if ( e != &slap_entry_root ) {
 248                 bdb_entry_return( be, e );
 249         }
 250         e = NULL;
 251
 252         if ( candidates[0] == 0 ) {
 253                 Debug( LDAP_DEBUG_TRACE, "bdb_search: no candidates\n",
 254                         0, 0, 0 );
 255
 256                 send_search_result( conn, op,
 257                         LDAP_SUCCESS,
 258                         NULL, NULL, NULL, NULL, 0 );
 259
 260                 rc = 1;
 261                 goto done;
 262         }
 263
 264         /* if not root and candidates exceed to-be-checked entries, abort */
 265         if ( !isroot && limit->lms_s_unchecked != -1 ) {
 266                 if ( BDB_IDL_N(candidates) > (unsigned) limit->lms_s_unchecked ) {
 267                         send_search_result( conn, op,
 268                                         LDAP_UNWILLING_TO_PERFORM,
 269                                         NULL, NULL, NULL, NULL, 0 );
 270                         rc = 1;
 271                         goto done;
 272                 }
 273         }
 274
 275         for ( id = bdb_idl_first( candidates, &cursor );
 276                 id != NOID;
 277                 id = bdb_idl_next( candidates, &cursor ) )
 278         {
 279                 int             scopeok = 0;
 280
 281                 /* check for abandon */
 282                 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
 283                 abandon = op->o_abandon;
 284                 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 285
 286                 if ( abandon ) {
 287                         rc = 0;
 288                         goto done;
 289                 }
 290
 291                 /* check time limit */
 292                 if ( tlimit != -1 && slap_get_time() > stoptime ) {
 293                         send_search_result( conn, op, rc = LDAP_TIMELIMIT_EXCEEDED,
 294                                 NULL, NULL, v2refs, NULL, nentries );
 295                         goto done;
 296                 }
 297
 298                 /* get the entry with reader lock */
 299                 rc = bdb_id2entry( be, NULL, id, &e );
 300
 301                 if ( e == NULL ) {
 302                         if( !BDB_IDL_IS_RANGE(candidates) ) {
 303                                 /* only complain for non-range IDLs */
 304                                 Debug( LDAP_DEBUG_TRACE,
 305                                         "bdb_search: candidate %ld not found\n",
 306                                         (long) id, 0, 0 );
 307                         }
 308
 309                         goto loop_continue;
 310                 }
 311
 312 #ifdef BDB_ALIASES
 313                 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
 314                         Entry *matched;
 315                         int err;
 316                         const char *text;
 317
 318                         e = deref_entry_r( be, e, &err, &matched, &text );
 319
 320                         if( e == NULL ) {
 321                                 e = matched;
 322                                 goto loop_continue;
 323                         }
 324
 325                         if( e->e_id == id ) {
 326                                 /* circular loop */
 327                                 goto loop_continue;
 328                         }
 329
 330                         /* need to skip alias which deref into scope */
 331                         if( scope & LDAP_SCOPE_ONELEVEL ) {
 332                                 char *pdn = dn_parent( NULL, e->e_ndn );
 333                                 if ( pdn != NULL ) {
 334                                         if( strcmp( pdn, realbase.bv_val ) ) {
 335                                                 goto loop_continue;
 336                                         }
 337                                 }
 338
 339                         } else if ( dnIsSuffix( &e->e_nname, &realbase ) ) {
 340                                 /* alias is within scope */
 341                                 Debug( LDAP_DEBUG_TRACE,
 342                                         "bdb_search: \"%s\" in subtree\n",
 343                                         e->e_dn, 0, 0 );
 344                                 goto loop_continue;
 345                         }
 346
 347                         scopeok = 1;
 348                 }
 349 #endif
 350
 351                 /*
 352                  * if it's a referral, add it to the list of referrals. only do
 353                  * this for non-base searches, and don't check the filter
 354                  * explicitly here since it's only a candidate anyway.
 355                  */
 356                 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
 357                         is_entry_referral( e ) )
 358                 {
 359                         BVarray erefs = get_entry_referrals(
 360                                 be, conn, op, e );
 361                         BVarray refs = referral_rewrite( erefs,
 362                                 &e->e_name, NULL,
 363                                 scope == LDAP_SCOPE_SUBTREE
 364                                         ? LDAP_SCOPE_SUBTREE
 365                                         : LDAP_SCOPE_BASE );
 366
 367                         send_search_reference( be, conn, op,
 368                                 e, refs, NULL, &v2refs );
 369
 370                         bvarray_free( refs );
 371
 372                         goto loop_continue;
 373                 }
 374
 375                 /* if it matches the filter and scope, send it */
 376                 rc = test_filter( be, conn, op, e, filter );
 377                 if ( rc == LDAP_COMPARE_TRUE ) {
 378                         char    *dn;
 379
 380                         /* check scope */
 381                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 382                                 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
 383                                         scopeok = (dn == realbase.bv_val)
 384                                                 ? 1
 385                                                 : (strcmp( dn, realbase.bv_val ) ? 0 : 1 );
 386                                 } else {
 387                                         scopeok = (realbase.bv_len == 0);
 388                                 }
 389
 390                         } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
 391                                 scopeok = dnIsSuffix( &e->e_nname, &realbase );
 392
 393                         } else {
 394                                 scopeok = 1;
 395                         }
 396
 397                         if ( scopeok ) {
 398                                 /* check size limit */
 399                                 if ( --slimit == -1 ) {
 400                                         bdb_entry_return( be, e );
 401                                         e = NULL;
 402                                         send_search_result( conn, op,
 403                                                 rc = LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
 404                                                 v2refs, NULL, nentries );
 405                                         goto done;
 406                                 }
 407
 408                                 if (e) {
 409                                         int result = send_search_entry( be, conn, op,
 410                                                 e, attrs, attrsonly, NULL);
 411
 412                                         switch (result) {
 413                                         case 0:         /* entry sent ok */
 414                                                 nentries++;
 415                                                 break;
 416                                         case 1:         /* entry not sent */
 417                                                 break;
 418                                         case -1:        /* connection closed */
 419                                                 bdb_entry_return( be, e );
 420                                                 e = NULL;
 421                                                 rc = LDAP_OTHER;
 422                                                 goto done;
 423                                         }
 424                                 }
 425                         } else {
 426                                 Debug( LDAP_DEBUG_TRACE,
 427                                         "bdb_search: %ld scope not okay\n",
 428                                         (long) id, 0, 0 );
 429                         }
 430                 } else {
 431                         Debug( LDAP_DEBUG_TRACE,
 432                                 "bdb_search: %ld does match filter\n",
 433                                 (long) id, 0, 0 );
 434                 }
 435
 436 loop_continue:
 437                 if( e != NULL ) {
 438                         /* free reader lock */
 439                         bdb_entry_return( be, e );
 440                 }
 441
 442                 ldap_pvt_thread_yield();
 443         }
 444         send_search_result( conn, op,
 445                 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
 446                 NULL, NULL, v2refs, NULL, nentries );
 447
 448         rc = 0;
 449
 450 done:
 451         if( v2refs ) bvarray_free( v2refs );
 452         if( realbase.bv_val ) ch_free( realbase.bv_val );
 453
 454         return rc;
 455 }
 456
 457
 458 static int base_candidate(
 459         BackendDB       *be,
 460         Entry   *e,
 461         ID              *ids )
 462 {
 463         Debug(LDAP_DEBUG_ARGS, "base_candidates: base: \"%s\" (0x%08lx)\n",
 464                 e->e_dn, (long) e->e_id, 0);
 465
 466         ids[0] = 1;
 467         ids[1] = e->e_id;
 468         return 0;
 469 }
 470
 471 /* Is "objectClass=xx" mentioned anywhere in this filter? Presence
 472  * doesn't count, we're looking for explicit values.
 473  */
 474 static int oc_filter(
 475         Filter *f
 476 )
 477 {
 478         int rc = 0;
 479
 480         switch(f->f_choice) {
 481         case LDAP_FILTER_EQUALITY:
 482         case LDAP_FILTER_APPROX:
 483                 if (f->f_av_desc == slap_schema.si_ad_objectClass)
 484                         rc = 1;
 485                 break;
 486
 487         case LDAP_FILTER_SUBSTRINGS:
 488                 if (f->f_sub_desc == slap_schema.si_ad_objectClass)
 489                         rc = 1;
 490                 break;
 491
 492         case LDAP_FILTER_AND:
 493         case LDAP_FILTER_OR:
 494                 for (f=f->f_and; f; f=f->f_next)
 495                         if ((rc = oc_filter(f)))
 496                                 break;
 497                 break;
 498         default:
 499                 break;
 500         }
 501         return rc;
 502 }
 503
 504 static int search_candidates(
 505         BackendDB *be,
 506         Entry *e,
 507         Filter *filter,
 508         int scope,
 509         int deref,
 510         int manageDSAit,
 511         ID      *ids )
 512 {
 513         int rc;
 514         Filter          f, fand, rf, xf;
 515         ID              tmp[BDB_IDL_UM_SIZE];
 516         AttributeAssertion aa_ref;
 517         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
 518 #ifdef BDB_ALIASES
 519         Filter  af;
 520         AttributeAssertion aa_alias;
 521 #endif
 522
 523         Debug(LDAP_DEBUG_TRACE,
 524                 "search_candidates: base=\"%s\" (0x%08lx) scope=%d\n",
 525                 e->e_dn, (long) e->e_id, scope );
 526
 527         xf.f_or = filter;
 528         xf.f_choice = LDAP_FILTER_OR;
 529         xf.f_next = NULL;
 530
 531         /* If the user's filter doesn't mention objectClass, or if
 532          * it just uses objectClass=*, these clauses are redundant.
 533          */
 534         if (oc_filter(filter)) {
 535                 if( !manageDSAit ) { /* match referrals */
 536                         struct berval bv_ref = { sizeof("REFERRAL")-1, "REFERRAL" };
 537                         rf.f_choice = LDAP_FILTER_EQUALITY;
 538                         rf.f_ava = &aa_ref;
 539                         rf.f_av_desc = slap_schema.si_ad_objectClass;
 540                         rf.f_av_value = bv_ref;
 541                         rf.f_next = xf.f_or;
 542                         xf.f_or = &rf;
 543                 }
 544
 545 #ifdef BDB_ALIASES
 546                 if( deref & LDAP_DEREF_SEARCHING ) { /* match aliases */
 547                         struct berval bv_alias = { sizeof("ALIAS")-1, "ALIAS" };
 548                         af.f_choice = LDAP_FILTER_EQUALITY;
 549                         af.f_ava = &aa_alias;
 550                         af.f_av_desc = slap_schema.si_ad_objectClass;
 551                         af.f_av_value = bv_alias;
 552                         af.f_next = xf.f_or;
 553                         xf.f_or = &af;
 554                 }
 555 #endif
 556         }
 557
 558         f.f_next = NULL;
 559         f.f_choice = LDAP_FILTER_AND;
 560         f.f_and = &fand;
 561         fand.f_choice = scope == LDAP_SCOPE_SUBTREE
 562                 ? SLAPD_FILTER_DN_SUBTREE
 563                 : SLAPD_FILTER_DN_ONE;
 564         fand.f_dn = &e->e_nname;
 565         fand.f_next = xf.f_or == filter ? filter : &xf ;
 566
 567
 568 #ifdef BDB_FILTER_INDICES
 569         rc = bdb_filter_candidates( be, &f, ids, tmp );
 570 #else
 571         /* FIXME: Original code:
 572         BDB_IDL_ID( bdb, ids, e->e_id );
 573         * this is a hack to make "" base work; when bdb_filter_candidates
 574         * is used this should not be needed any more */
 575         BDB_IDL_ID( bdb, ids, (e->e_id == NOID ? 1 : e->e_id) );
 576         rc = 0;
 577 #endif
 578
 579         Debug(LDAP_DEBUG_TRACE,
 580                 "bdb_search_candidates: id=%ld first=%ld last=%ld\n",
 581                 (long) ids[0],
 582                 (long) BDB_IDL_FIRST(ids),
 583                 (long) BDB_IDL_LAST(ids) );
 584
 585         return rc;
 586 }