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         Operation *op,
  24         Entry *e,
  25         Filter *filter,
  26         int scope,
  27         int deref,
  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         BerVarray 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_r( be, NULL, nbase, &e, &matched, 0 );
  82         }
  83
  84         switch(rc) {
  85         case DB_NOTFOUND:
  86         case 0:
  87                 break;
  88         default:
  89                 if (e != NULL) {
  90                         bdb_cache_return_entry_w(&bdb->bi_cache, e);
  91                 }
  92                 if (matched != NULL) {
  93                         bdb_cache_return_entry_r(&bdb->bi_cache, matched);
  94                 }
  95                 send_ldap_result( conn, op, rc=LDAP_OTHER,
  96                         NULL, "internal error", NULL, NULL );
  97                 return rc;
  98         }
  99
 100         if ( e == NULL ) {
 101                 struct berval matched_dn = { 0, NULL };
 102                 BerVarray refs = NULL;
 103
 104                 if ( matched != NULL ) {
 105                         BerVarray erefs;
 106
 107                         ber_dupbv( &matched_dn, &matched->e_name );
 108
 109                         erefs = is_entry_referral( matched )
 110                                 ? get_entry_referrals( be, conn, op, matched )
 111                                 : NULL;
 112
 113                         bdb_cache_return_entry_r (&bdb->bi_cache, matched);
 114                         matched = NULL;
 115
 116                         if( erefs ) {
 117                                 refs = referral_rewrite( erefs, &matched_dn,
 118                                         base, scope );
 119                                 ber_bvarray_free( erefs );
 120                         }
 121
 122                 } else {
 123                         refs = referral_rewrite( default_referral,
 124                                 NULL, base, scope );
 125                 }
 126
 127                 send_ldap_result( conn, op,     rc=LDAP_REFERRAL ,
 128                         matched_dn.bv_val, text, refs, NULL );
 129
 130                 if ( refs ) ber_bvarray_free( refs );
 131                 if ( matched_dn.bv_val ) ber_memfree( matched_dn.bv_val );
 132                 return rc;
 133         }
 134
 135         if (!manageDSAit && e != &slap_entry_root && is_entry_referral( e ) ) {
 136                 /* entry is a referral, don't allow add */
 137                 struct berval matched_dn;
 138                 BerVarray erefs, refs;
 139
 140                 ber_dupbv( &matched_dn, &e->e_name );
 141                 erefs = get_entry_referrals( be, conn, op, e );
 142                 refs = NULL;
 143
 144                 bdb_cache_return_entry_r( &bdb->bi_cache, e );
 145                 e = NULL;
 146
 147                 if( erefs ) {
 148                         refs = referral_rewrite( erefs, &matched_dn,
 149                                 base, scope );
 150                         ber_bvarray_free( erefs );
 151                 }
 152
 153                 Debug( LDAP_DEBUG_TRACE, "bdb_search: entry is referral\n",
 154                         0, 0, 0 );
 155
 156                 send_ldap_result( conn, op, LDAP_REFERRAL,
 157                         matched_dn.bv_val,
 158                         refs ? NULL : "bad referral object",
 159                         refs, NULL );
 160
 161                 ber_bvarray_free( refs );
 162                 ber_memfree( matched_dn.bv_val );
 163                 return 1;
 164         }
 165
 166         /* if not root, get appropriate limits */
 167         if ( be_isroot( be, &op->o_ndn ) ) {
 168                 isroot = 1;
 169         } else {
 170                 ( void ) get_limits( be, &op->o_ndn, &limit );
 171         }
 172
 173         /* The time/size limits come first because they require very little
 174          * effort, so there's no chance the candidates are selected and then
 175          * the request is not honored only because of time/size constraints */
 176
 177         /* if no time limit requested, use soft limit (unless root!) */
 178         if ( isroot ) {
 179                 if ( tlimit == 0 ) {
 180                         tlimit = -1;    /* allow root to set no limit */
 181                 }
 182
 183                 if ( slimit == 0 ) {
 184                         slimit = -1;
 185                 }
 186
 187         } else {
 188                 /* if no limit is required, use soft limit */
 189                 if ( tlimit <= 0 ) {
 190                         tlimit = limit->lms_t_soft;
 191
 192                 /* if requested limit higher than hard limit, abort */
 193                 } else if ( tlimit > limit->lms_t_hard ) {
 194                         /* no hard limit means use soft instead */
 195                         if ( limit->lms_t_hard == 0 ) {
 196                                 tlimit = limit->lms_t_soft;
 197
 198                         /* positive hard limit means abort */
 199                         } else if ( limit->lms_t_hard > 0 ) {
 200                                 send_search_result( conn, op,
 201                                                 LDAP_UNWILLING_TO_PERFORM,
 202                                                 NULL, NULL, NULL, NULL, 0 );
 203                                 rc = 0;
 204                                 goto done;
 205                         }
 206
 207                         /* negative hard limit means no limit */
 208                 }
 209
 210                 /* if no limit is required, use soft limit */
 211                 if ( slimit <= 0 ) {
 212                         slimit = limit->lms_s_soft;
 213
 214                 /* if requested limit higher than hard limit, abort */
 215                 } else if ( slimit > limit->lms_s_hard ) {
 216                         /* no hard limit means use soft instead */
 217                         if ( limit->lms_s_hard == 0 ) {
 218                                 slimit = limit->lms_s_soft;
 219
 220                         /* positive hard limit means abort */
 221                         } else if ( limit->lms_s_hard > 0 ) {
 222                                 send_search_result( conn, op,
 223                                                 LDAP_UNWILLING_TO_PERFORM,
 224                                                 NULL, NULL, NULL, NULL, 0 );
 225                                 rc = 0;
 226                                 goto done;
 227                         }
 228
 229                         /* negative hard limit means no limit */
 230                 }
 231         }
 232
 233         /* compute it anyway; root does not use it */
 234         stoptime = op->o_time + tlimit;
 235
 236         /* select candidates */
 237         if ( scope == LDAP_SCOPE_BASE ) {
 238                 rc = base_candidate( be, e, candidates );
 239
 240         } else {
 241                 BDB_IDL_ALL( bdb, candidates );
 242                 rc = search_candidates( be, op, e, filter,
 243                         scope, deref, candidates );
 244         }
 245
 246         /* need normalized dn below */
 247         ber_dupbv( &realbase, &e->e_nname );
 248
 249         /* start cursor at base entry's id
 250          * FIXME: hack to make "" base work */
 251         cursor = e->e_id == NOID ? 1 : e->e_id;
 252
 253         if ( e != &slap_entry_root ) {
 254                 bdb_cache_return_entry_r(&bdb->bi_cache, e);
 255         }
 256         e = NULL;
 257
 258         if ( candidates[0] == 0 ) {
 259                 Debug( LDAP_DEBUG_TRACE, "bdb_search: no candidates\n",
 260                         0, 0, 0 );
 261
 262                 send_search_result( conn, op,
 263                         LDAP_SUCCESS,
 264                         NULL, NULL, NULL, NULL, 0 );
 265
 266                 rc = 1;
 267                 goto done;
 268         }
 269
 270         /* if not root and candidates exceed to-be-checked entries, abort */
 271         if ( !isroot && limit->lms_s_unchecked != -1 ) {
 272                 if ( BDB_IDL_N(candidates) > (unsigned) limit->lms_s_unchecked ) {
 273                         send_search_result( conn, op,
 274                                         LDAP_UNWILLING_TO_PERFORM,
 275                                         NULL, NULL, NULL, NULL, 0 );
 276                         rc = 1;
 277                         goto done;
 278                 }
 279         }
 280
 281         for ( id = bdb_idl_first( candidates, &cursor );
 282                 id != NOID;
 283                 id = bdb_idl_next( candidates, &cursor ) )
 284         {
 285                 int             scopeok = 0;
 286
 287                 /* check for abandon */
 288                 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
 289                 abandon = op->o_abandon;
 290                 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 291
 292                 if ( abandon ) {
 293                         rc = 0;
 294                         goto done;
 295                 }
 296
 297                 /* check time limit */
 298                 if ( tlimit != -1 && slap_get_time() > stoptime ) {
 299                         send_search_result( conn, op, rc = LDAP_TIMELIMIT_EXCEEDED,
 300                                 NULL, NULL, v2refs, NULL, nentries );
 301                         goto done;
 302                 }
 303
 304                 /* get the entry with reader lock */
 305                 rc = bdb_id2entry_r( be, NULL, id, &e );
 306
 307                 if ( e == NULL ) {
 308                         if( !BDB_IDL_IS_RANGE(candidates) ) {
 309                                 /* only complain for non-range IDLs */
 310                                 Debug( LDAP_DEBUG_TRACE,
 311                                         "bdb_search: candidate %ld not found\n",
 312                                         (long) id, 0, 0 );
 313                         }
 314
 315                         goto loop_continue;
 316                 }
 317
 318 #ifdef BDB_SUBENTRIES
 319                 if ( is_entry_subentry( e ) ) {
 320                         if( scope != LDAP_SCOPE_BASE ) {
 321                                 if(!get_subentries_visibility( op )) {
 322                                         /* only subentries are visible */
 323                                         goto loop_continue;
 324                                 }
 325
 326                         } else if ( get_subentries( op ) &&
 327                                 !get_subentries_visibility( op ))
 328                         {
 329                                 /* only subentries are visible */
 330                                 goto loop_continue;
 331                         }
 332
 333                 } else if ( get_subentries_visibility( op )) {
 334                         /* only subentries are visible */
 335                         goto loop_continue;
 336                 }
 337 #endif
 338
 339 #ifdef BDB_ALIASES
 340                 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
 341                         Entry *matched;
 342                         int err;
 343                         const char *text;
 344
 345                         e = deref_entry_r( be, e, &err, &matched, &text );
 346
 347                         if( e == NULL ) {
 348                                 e = matched;
 349                                 goto loop_continue;
 350                         }
 351
 352                         if( e->e_id == id ) {
 353                                 /* circular loop */
 354                                 goto loop_continue;
 355                         }
 356
 357                         /* need to skip alias which deref into scope */
 358                         if( scope & LDAP_SCOPE_ONELEVEL ) {
 359                                 struct berval   pdn;
 360
 361                                 dnParent( &e->e_nname, &pdn ):
 362                                 if ( ber_bvcmp( pdn, &realbase ) ) {
 363                                         goto loop_continue;
 364                                 }
 365
 366                         } else if ( dnIsSuffix( &e->e_nname, &realbase ) ) {
 367                                 /* alias is within scope */
 368                                 Debug( LDAP_DEBUG_TRACE,
 369                                         "bdb_search: \"%s\" in subtree\n",
 370                                         e->e_dn, 0, 0 );
 371                                 goto loop_continue;
 372                         }
 373
 374                         scopeok = 1;
 375                 }
 376 #endif
 377
 378                 /*
 379                  * if it's a referral, add it to the list of referrals. only do
 380                  * this for non-base searches, and don't check the filter
 381                  * explicitly here since it's only a candidate anyway.
 382                  */
 383                 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
 384                         is_entry_referral( e ) )
 385                 {
 386                         BerVarray erefs = get_entry_referrals(
 387                                 be, conn, op, e );
 388                         BerVarray refs = referral_rewrite( erefs,
 389                                 &e->e_name, NULL,
 390                                 scope == LDAP_SCOPE_SUBTREE
 391                                         ? LDAP_SCOPE_SUBTREE
 392                                         : LDAP_SCOPE_BASE );
 393
 394                         send_search_reference( be, conn, op,
 395                                 e, refs, NULL, &v2refs );
 396
 397                         ber_bvarray_free( refs );
 398
 399                         goto loop_continue;
 400                 }
 401
 402                 /* if it matches the filter and scope, send it */
 403                 rc = test_filter( be, conn, op, e, filter );
 404                 if ( rc == LDAP_COMPARE_TRUE ) {
 405                         struct berval   dn;
 406
 407                         /* check scope */
 408                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 409                                 if ( be_issuffix( be, &e->e_nname ) ) {
 410                                         scopeok = (realbase.bv_len == 0);
 411                                 } else {
 412                                         dnParent( &e->e_nname, &dn );
 413                                         scopeok = dn_match( &dn, &realbase );
 414                                 }
 415
 416                         } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
 417                                 scopeok = dnIsSuffix( &e->e_nname, &realbase );
 418
 419                         } else {
 420                                 scopeok = 1;
 421                         }
 422
 423                         if ( scopeok ) {
 424                                 /* check size limit */
 425                                 if ( --slimit == -1 ) {
 426                                         bdb_cache_return_entry_r (&bdb->bi_cache, e);
 427                                         e = NULL;
 428                                         send_search_result( conn, op,
 429                                                 rc = LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
 430                                                 v2refs, NULL, nentries );
 431                                         goto done;
 432                                 }
 433
 434                                 if (e) {
 435                                         int result;
 436
 437                                         if( op->o_noop ) {
 438                                                 result = 0;
 439                                         } else {
 440                                                 result = send_search_entry( be, conn, op,
 441                                                         e, attrs, attrsonly, NULL);
 442                                         }
 443
 444                                         switch (result) {
 445                                         case 0:         /* entry sent ok */
 446                                                 nentries++;
 447                                                 break;
 448                                         case 1:         /* entry not sent */
 449                                                 break;
 450                                         case -1:        /* connection closed */
 451                                                 bdb_cache_return_entry_r(&bdb->bi_cache, e);
 452                                                 e = NULL;
 453                                                 rc = LDAP_OTHER;
 454                                                 goto done;
 455                                         }
 456                                 }
 457                         } else {
 458                                 Debug( LDAP_DEBUG_TRACE,
 459                                         "bdb_search: %ld scope not okay\n",
 460                                         (long) id, 0, 0 );
 461                         }
 462                 } else {
 463                         Debug( LDAP_DEBUG_TRACE,
 464                                 "bdb_search: %ld does match filter\n",
 465                                 (long) id, 0, 0 );
 466                 }
 467
 468 loop_continue:
 469                 if( e != NULL ) {
 470                         /* free reader lock */
 471                         bdb_cache_return_entry_r ( &bdb->bi_cache, e );
 472                         e = NULL;
 473                 }
 474
 475                 ldap_pvt_thread_yield();
 476         }
 477         send_search_result( conn, op,
 478                 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
 479                 NULL, NULL, v2refs, NULL, nentries );
 480
 481         rc = 0;
 482
 483 done:
 484         if( e != NULL ) {
 485                 /* free reader lock */
 486                 bdb_cache_return_entry_r ( &bdb->bi_cache, e );
 487         }
 488
 489         if( v2refs ) ber_bvarray_free( v2refs );
 490         if( realbase.bv_val ) ch_free( realbase.bv_val );
 491
 492         return rc;
 493 }
 494
 495
 496 static int base_candidate(
 497         BackendDB       *be,
 498         Entry   *e,
 499         ID              *ids )
 500 {
 501         Debug(LDAP_DEBUG_ARGS, "base_candidates: base: \"%s\" (0x%08lx)\n",
 502                 e->e_dn, (long) e->e_id, 0);
 503
 504         ids[0] = 1;
 505         ids[1] = e->e_id;
 506         return 0;
 507 }
 508
 509 /* Is "objectClass=xx" mentioned anywhere in this filter? Presence
 510  * doesn't count, we're looking for explicit values.
 511  */
 512 static int oc_filter(
 513         Filter *f
 514 )
 515 {
 516         int rc = 0;
 517
 518         switch(f->f_choice) {
 519         case LDAP_FILTER_EQUALITY:
 520         case LDAP_FILTER_APPROX:
 521                 if (f->f_av_desc == slap_schema.si_ad_objectClass)
 522                         rc = 1;
 523                 break;
 524
 525         case LDAP_FILTER_SUBSTRINGS:
 526                 if (f->f_sub_desc == slap_schema.si_ad_objectClass)
 527                         rc = 1;
 528                 break;
 529
 530         case LDAP_FILTER_AND:
 531         case LDAP_FILTER_OR:
 532                 for (f=f->f_and; f; f=f->f_next)
 533                         if ((rc = oc_filter(f)))
 534                                 break;
 535                 break;
 536         default:
 537                 break;
 538         }
 539         return rc;
 540 }
 541
 542 static int search_candidates(
 543         BackendDB *be,
 544         Operation *op,
 545         Entry *e,
 546         Filter *filter,
 547         int scope,
 548         int deref,
 549         ID      *ids )
 550 {
 551         int rc;
 552         Filter          f, scopef, rf, xf;
 553         ID              tmp[BDB_IDL_UM_SIZE];
 554         AttributeAssertion aa_ref;
 555 #ifdef BDB_SUBENTRIES
 556         Filter  sf;
 557         AttributeAssertion aa_subentry;
 558 #endif
 559 #ifdef BDB_ALIASES
 560         Filter  af;
 561         AttributeAssertion aa_alias;
 562 #endif
 563         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
 564
 565         /*
 566          * This routine takes as input a filter (user-filter)
 567          * and rewrites it as follows:
 568          *      (&(scope=DN)[(objectClass=subentry)]
 569          *              (|[(objectClass=referral)(objectClass=alias)](user-filter))
 570          */
 571
 572         Debug(LDAP_DEBUG_TRACE,
 573                 "search_candidates: base=\"%s\" (0x%08lx) scope=%d\n",
 574                 e->e_dn, (long) e->e_id, scope );
 575
 576         xf.f_or = filter;
 577         xf.f_choice = LDAP_FILTER_OR;
 578         xf.f_next = NULL;
 579
 580         /* If the user's filter doesn't mention objectClass, or if
 581          * it just uses objectClass=*, these clauses are redundant.
 582          */
 583         if (oc_filter(filter) && !get_subentries_visibility(op) ) {
 584                 if( !get_manageDSAit(op) ) { /* match referrals */
 585                         struct berval bv_ref = { sizeof("REFERRAL")-1, "REFERRAL" };
 586                         rf.f_choice = LDAP_FILTER_EQUALITY;
 587                         rf.f_ava = &aa_ref;
 588                         rf.f_av_desc = slap_schema.si_ad_objectClass;
 589                         rf.f_av_value = bv_ref;
 590                         rf.f_next = xf.f_or;
 591                         xf.f_or = &rf;
 592                 }
 593
 594 #ifdef BDB_ALIASES
 595                 if( deref & LDAP_DEREF_SEARCHING ) { /* match aliases */
 596                         struct berval bv_alias = { sizeof("ALIAS")-1, "ALIAS" };
 597                         af.f_choice = LDAP_FILTER_EQUALITY;
 598                         af.f_ava = &aa_alias;
 599                         af.f_av_desc = slap_schema.si_ad_objectClass;
 600                         af.f_av_value = bv_alias;
 601                         af.f_next = xf.f_or;
 602                         xf.f_or = &af;
 603                 }
 604 #endif
 605         }
 606
 607         f.f_next = NULL;
 608         f.f_choice = LDAP_FILTER_AND;
 609         f.f_and = &scopef;
 610         scopef.f_choice = scope == LDAP_SCOPE_SUBTREE
 611                 ? SLAPD_FILTER_DN_SUBTREE
 612                 : SLAPD_FILTER_DN_ONE;
 613         scopef.f_dn = &e->e_nname;
 614         scopef.f_next = xf.f_or == filter ? filter : &xf ;
 615
 616 #ifdef BDB_SUBENTRIES
 617         if( get_subentries_visibility( op ) ) {
 618                 struct berval bv_subentry = { sizeof("SUBENTRY")-1, "SUBENTRY" };
 619                 sf.f_choice = LDAP_FILTER_EQUALITY;
 620                 sf.f_ava = &aa_subentry;
 621                 sf.f_av_desc = slap_schema.si_ad_objectClass;
 622                 sf.f_av_value = bv_subentry;
 623                 sf.f_next = scopef.f_next;
 624                 scopef.f_next = &sf;
 625         }
 626 #endif
 627
 628         rc = bdb_filter_candidates( be, &f, ids, tmp );
 629
 630         Debug(LDAP_DEBUG_TRACE,
 631                 "bdb_search_candidates: id=%ld first=%ld last=%ld\n",
 632                 (long) ids[0],
 633                 (long) BDB_IDL_FIRST(ids),
 634                 (long) BDB_IDL_LAST(ids) );
 635
 636         return rc;
 637 }