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

   1 /* search.c - search operation */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2000 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         const char      *filterstr,
  43         struct berval   **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         struct berval **v2refs = NULL;
  55         Entry   *matched = NULL;
  56         char    *realbase = 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->bv_val, &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 = NULL;
  96                 struct berval **refs = NULL;
  97
  98                 if ( matched != NULL ) {
  99                         struct berval **erefs;
 100                         matched_dn = ber_bvdup( &matched->e_name );
 101
 102                         erefs = is_entry_referral( matched )
 103                                 ? get_entry_referrals( be, conn, op, matched )
 104                                 : NULL;
 105
 106                         bdb_entry_return( be, matched );
 107                         matched = NULL;
 108
 109                         if( erefs ) {
 110                                 refs = referral_rewrite( erefs, matched_dn,
 111                                         base, scope );
 112                                 ber_bvecfree( erefs );
 113                         }
 114
 115                 } else {
 116                         refs = referral_rewrite( default_referral,
 117                                 NULL, base, scope );
 118                 }
 119
 120                 send_ldap_result( conn, op,     rc=LDAP_REFERRAL ,
 121                         matched_dn->bv_val, text, refs, NULL );
 122
 123                 ber_bvecfree( refs );
 124                 ber_bvfree( matched_dn );
 125                 return rc;
 126         }
 127
 128         if (!manageDSAit && e != &slap_entry_root && is_entry_referral( e ) ) {
 129                 /* entry is a referral, don't allow add */
 130                 struct berval *matched_dn = ber_bvdup( &e->e_name );
 131                 struct berval **erefs = get_entry_referrals( be,
 132                         conn, op, e );
 133                 struct berval **refs = NULL;
 134
 135                 bdb_entry_return( be, e );
 136                 e = NULL;
 137
 138                 if( erefs ) {
 139                         refs = referral_rewrite( erefs, matched_dn,
 140                                 base, scope );
 141                         ber_bvecfree( erefs );
 142                 }
 143
 144                 Debug( LDAP_DEBUG_TRACE, "bdb_search: entry is referral\n",
 145                         0, 0, 0 );
 146
 147                 send_ldap_result( conn, op, LDAP_REFERRAL,
 148                         matched_dn->bv_val,
 149                         refs ? NULL : "bad referral object",
 150                         refs, NULL );
 151
 152                 ber_bvecfree( refs );
 153                 ber_bvfree( matched_dn );
 154                 return 1;
 155         }
 156
 157         /* if not root, get appropriate limits */
 158         if ( be_isroot( be, &op->o_ndn ) ) {
 159                 isroot = 1;
 160         } else {
 161                 ( void ) get_limits( be, &op->o_ndn, &limit );
 162         }
 163
 164         /* The time/size limits come first because they require very little
 165          * effort, so there's no chance the candidates are selected and then
 166          * the request is not honored only because of time/size constraints */
 167
 168         /* if no time limit requested, use soft limit (unless root!) */
 169         if ( isroot ) {
 170                 if ( tlimit == 0 ) {
 171                         tlimit = -1;    /* allow root to set no limit */
 172                 }
 173
 174                 if ( slimit == 0 ) {
 175                         slimit = -1;
 176                 }
 177
 178         } else {
 179                 /* if no limit is required, use soft limit */
 180                 if ( tlimit <= 0 ) {
 181                         tlimit = limit->lms_t_soft;
 182
 183                 /* if requested limit higher than hard limit, abort */
 184                 } else if ( tlimit > limit->lms_t_hard ) {
 185                         /* no hard limit means use soft instead */
 186                         if ( limit->lms_t_hard == 0 ) {
 187                                 tlimit = limit->lms_t_soft;
 188
 189                         /* positive hard limit means abort */
 190                         } else if ( limit->lms_t_hard > 0 ) {
 191                                 send_search_result( conn, op,
 192                                                 LDAP_UNWILLING_TO_PERFORM,
 193                                                 NULL, NULL, NULL, NULL, 0 );
 194                                 rc = 0;
 195                                 goto done;
 196                         }
 197
 198                         /* negative hard limit means no limit */
 199                 }
 200
 201                 /* if no limit is required, use soft limit */
 202                 if ( slimit <= 0 ) {
 203                         slimit = limit->lms_s_soft;
 204
 205                 /* if requested limit higher than hard limit, abort */
 206                 } else if ( slimit > limit->lms_s_hard ) {
 207                         /* no hard limit means use soft instead */
 208                         if ( limit->lms_s_hard == 0 ) {
 209                                 slimit = limit->lms_s_soft;
 210
 211                         /* positive hard limit means abort */
 212                         } else if ( limit->lms_s_hard > 0 ) {
 213                                 send_search_result( conn, op,
 214                                                 LDAP_UNWILLING_TO_PERFORM,
 215                                                 NULL, NULL, NULL, NULL, 0 );
 216                                 rc = 0;
 217                                 goto done;
 218                         }
 219
 220                         /* negative hard limit means no limit */
 221                 }
 222         }
 223
 224         /* compute it anyway; root does not use it */
 225         stoptime = op->o_time + tlimit;
 226
 227         /* select candidates */
 228         if ( scope == LDAP_SCOPE_BASE ) {
 229                 rc = base_candidate( be, e, candidates );
 230
 231         } else {
 232                 BDB_IDL_ALL( bdb, candidates );
 233                 rc = search_candidates( be, e, filter,
 234                         scope, deref, manageDSAit, candidates );
 235         }
 236
 237         /* need normalized dn below */
 238         realbase = ch_strdup( e->e_ndn );
 239
 240         /* start cursor at base entry's id
 241          * FIXME: hack to make "" base work */
 242         cursor = e->e_id == NOID ? 1 : e->e_id;
 243
 244         if ( e != &slap_entry_root ) {
 245                 bdb_entry_return( be, e );
 246         }
 247         e = NULL;
 248
 249         if ( candidates[0] == 0 ) {
 250                 Debug( LDAP_DEBUG_TRACE, "bdb_search: no candidates\n",
 251                         0, 0, 0 );
 252
 253                 send_search_result( conn, op,
 254                         LDAP_SUCCESS,
 255                         NULL, NULL, NULL, NULL, 0 );
 256
 257                 rc = 1;
 258                 goto done;
 259         }
 260
 261         /* if not root and candidates exceed to-be-checked entries, abort */
 262         if ( !isroot && limit->lms_s_unchecked != -1 ) {
 263                 if ( BDB_IDL_N(candidates) > (unsigned) limit->lms_s_unchecked ) {
 264                         send_search_result( conn, op,
 265                                         LDAP_UNWILLING_TO_PERFORM,
 266                                         NULL, NULL, NULL, NULL, 0 );
 267                         rc = 1;
 268                         goto done;
 269                 }
 270         }
 271
 272         for ( id = bdb_idl_first( candidates, &cursor );
 273                 id != NOID;
 274                 id = bdb_idl_next( candidates, &cursor ) )
 275         {
 276                 int             scopeok = 0;
 277
 278                 /* check for abandon */
 279                 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
 280                 abandon = op->o_abandon;
 281                 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 282
 283                 if ( abandon ) {
 284                         rc = 0;
 285                         goto done;
 286                 }
 287
 288                 /* check time limit */
 289                 if ( tlimit != -1 && slap_get_time() > stoptime ) {
 290                         send_search_result( conn, op, rc = LDAP_TIMELIMIT_EXCEEDED,
 291                                 NULL, NULL, v2refs, NULL, nentries );
 292                         goto done;
 293                 }
 294
 295                 /* get the entry with reader lock */
 296                 rc = bdb_id2entry( be, NULL, id, &e );
 297
 298                 if ( e == NULL ) {
 299                         if( !BDB_IDL_IS_RANGE(candidates) ) {
 300                                 /* only complain for non-range IDLs */
 301                                 Debug( LDAP_DEBUG_TRACE,
 302                                         "bdb_search: candidate %ld not found\n",
 303                                         (long) id, 0, 0 );
 304                         }
 305
 306                         goto loop_continue;
 307                 }
 308
 309 #ifdef BDB_ALIASES
 310                 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
 311                         Entry *matched;
 312                         int err;
 313                         const char *text;
 314
 315                         e = deref_entry_r( be, e, &err, &matched, &text );
 316
 317                         if( e == NULL ) {
 318                                 e = matched;
 319                                 goto loop_continue;
 320                         }
 321
 322                         if( e->e_id == id ) {
 323                                 /* circular loop */
 324                                 goto loop_continue;
 325                         }
 326
 327                         /* need to skip alias which deref into scope */
 328                         if( scope & LDAP_SCOPE_ONELEVEL ) {
 329                                 char *pdn = dn_parent( NULL, e->e_ndn );
 330                                 if ( pdn != NULL ) {
 331                                         if( strcmp( pdn, realbase ) ) {
 332                                                 goto loop_continue;
 333                                         }
 334                                 }
 335
 336                         } else if ( dn_issuffix( e->e_ndn, realbase ) ) {
 337                                 /* alias is within scope */
 338                                 Debug( LDAP_DEBUG_TRACE,
 339                                         "bdb_search: \"%s\" in subtree\n",
 340                                         e->e_dn, 0, 0 );
 341                                 goto loop_continue;
 342                         }
 343
 344                         scopeok = 1;
 345                 }
 346 #endif
 347
 348                 /*
 349                  * if it's a referral, add it to the list of referrals. only do
 350                  * this for non-base searches, and don't check the filter
 351                  * explicitly here since it's only a candidate anyway.
 352                  */
 353                 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
 354                         is_entry_referral( e ) )
 355                 {
 356                         struct berval **erefs = get_entry_referrals(
 357                                 be, conn, op, e );
 358                         struct berval **refs = referral_rewrite( erefs,
 359                                 &e->e_name, NULL,
 360                                 scope == LDAP_SCOPE_SUBTREE
 361                                         ? LDAP_SCOPE_SUBTREE
 362                                         : LDAP_SCOPE_BASE );
 363
 364                         send_search_reference( be, conn, op,
 365                                 e, refs, NULL, &v2refs );
 366
 367                         ber_bvecfree( refs );
 368
 369                         goto loop_continue;
 370                 }
 371
 372                 /* if it matches the filter and scope, send it */
 373                 rc = test_filter( be, conn, op, e, filter );
 374                 if ( rc == LDAP_COMPARE_TRUE ) {
 375                         char    *dn;
 376
 377                         /* check scope */
 378                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 379                                 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
 380                                         scopeok = (dn == realbase)
 381                                                 ? 1
 382                                                 : (strcmp( dn, realbase ) ? 0 : 1 );
 383                                 } else {
 384                                         scopeok = (realbase == NULL || *realbase == '\0');
 385                                 }
 386
 387                         } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
 388                                 dn = ch_strdup( e->e_ndn );
 389                                 scopeok = dn_issuffix( dn, realbase );
 390                                 free( dn );
 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         ber_bvecfree( v2refs );
 451         if( realbase ) ch_free( realbase );
 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                         static 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                         static 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 }