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