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

   1 /* search.c - ldbm backend search function */
   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
  12 #include <ac/string.h>
  13 #include <ac/socket.h>
  14
  15 #include "slap.h"
  16 #include "back-ldbm.h"
  17 #include "proto-back-ldbm.h"
  18
  19 static ID_BLOCK *base_candidate(
  20         Backend *be, Entry *e );
  21
  22 static ID_BLOCK *search_candidates(
  23         Backend *be, Entry *e, Filter *filter,
  24         int scope, int deref, int manageDSAit );
  25
  26
  27 int
  28 ldbm_back_search(
  29     Backend     *be,
  30     Connection  *conn,
  31     Operation   *op,
  32     const char  *base,
  33     const char  *nbase,
  34     int         scope,
  35     int         deref,
  36     int         slimit,
  37     int         tlimit,
  38     Filter      *filter,
  39     const char  *filterstr,
  40     char        **attrs,
  41     int         attrsonly )
  42 {
  43         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
  44         int             rc, err;
  45         const char *text = NULL;
  46         time_t          stoptime;
  47         ID_BLOCK                *candidates;
  48         ID              id, cursor;
  49         Entry           *e;
  50         struct berval **v2refs = NULL;
  51         Entry   *matched = NULL;
  52         char    *realbase = NULL;
  53         int             nentries = 0;
  54         int             manageDSAit = get_manageDSAit( op );
  55         int             cscope = LDAP_SCOPE_DEFAULT;
  56
  57         struct slap_limits_set *limit = NULL;
  58         int isroot = 0;
  59
  60 #ifdef NEW_LOGGING
  61         LDAP_LOG(( "backend", LDAP_LEVEL_ENTRY,
  62                    "ldbm_back_search: enter\n" ));
  63 #else
  64         Debug(LDAP_DEBUG_TRACE, "=> ldbm_back_search\n", 0, 0, 0);
  65 #endif
  66
  67
  68         if ( *nbase == '\0' ) {
  69                 /* DIT root special case */
  70                 static const Entry root = { NOID, "", "", NULL, NULL };
  71                 e = (Entry *) &root;
  72
  73                 /* need normalized dn below */
  74                 realbase = ch_strdup( e->e_ndn );
  75
  76                 candidates = search_candidates( be, e, filter,
  77                     scope, deref, manageDSAit );
  78
  79                 goto searchit;
  80
  81         } else if ( deref & LDAP_DEREF_FINDING ) {
  82                 /* deref dn and get entry with reader lock */
  83                 e = deref_dn_r( be, nbase, &err, &matched, &text );
  84
  85                 if( err == LDAP_NO_SUCH_OBJECT ) err = LDAP_REFERRAL;
  86
  87         } else {
  88                 /* get entry with reader lock */
  89                 e = dn2entry_r( be, nbase, &matched );
  90                 err = e != NULL ? LDAP_SUCCESS : LDAP_REFERRAL;
  91                 text = NULL;
  92         }
  93
  94         if ( e == NULL ) {
  95                 char *matched_dn = NULL;
  96                 struct berval **refs = NULL;
  97
  98                 if ( matched != NULL ) {
  99                         struct berval **erefs;
 100                         matched_dn = ch_strdup( matched->e_dn );
 101
 102                         erefs = is_entry_referral( matched )
 103                                 ? get_entry_referrals( be, conn, op, matched,
 104                                         base, scope )
 105                                 : NULL;
 106
 107                         cache_return_entry_r( &li->li_cache, matched );
 108
 109                         if( erefs ) {
 110                                 refs = referral_rewrite( erefs, matched_dn,
 111                                         base, scope );
 112
 113                                 ber_bvecfree( erefs );
 114                         }
 115
 116                 } else {
 117                         refs = referral_rewrite( default_referral,
 118                                 NULL, base, scope );
 119                 }
 120
 121                 send_ldap_result( conn, op, err,
 122                         matched_dn, text, refs, NULL );
 123
 124                 ber_bvecfree( refs );
 125                 free( matched_dn );
 126                 return 1;
 127         }
 128
 129         if (!manageDSAit && is_entry_referral( e ) ) {
 130                 /* entry is a referral, don't allow add */
 131                 char *matched_dn = ch_strdup( e->e_dn );
 132                 struct berval **erefs = get_entry_referrals( be,
 133                         conn, op, e, base, scope );
 134                 struct berval **refs = NULL;
 135
 136                 cache_return_entry_r( &li->li_cache, e );
 137
 138 #ifdef NEW_LOGGING
 139                 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 140                         "ldbm_search: entry (%s) is a referral.\n",
 141                         e->e_dn ));
 142 #else
 143                 Debug( LDAP_DEBUG_TRACE,
 144                         "ldbm_search: entry is referral\n",
 145                         0, 0, 0 );
 146 #endif
 147
 148                 if( erefs ) {
 149                         refs = referral_rewrite( erefs, matched_dn,
 150                                 base, scope );
 151
 152                         ber_bvecfree( erefs );
 153                 }
 154
 155                 if( refs ) {
 156                         send_ldap_result( conn, op, LDAP_REFERRAL,
 157                                 matched_dn, NULL, refs, NULL );
 158                         ber_bvecfree( refs );
 159
 160                 } else {
 161                         send_ldap_result( conn, op, LDAP_OTHER, matched_dn,
 162                                 "bad referral object", NULL, NULL );
 163                 }
 164
 165                 free( matched_dn );
 166                 return 1;
 167         }
 168
 169         if ( is_entry_alias( e ) ) {
 170                 /* don't deref */
 171                 deref = LDAP_DEREF_NEVER;
 172         }
 173
 174         if ( scope == LDAP_SCOPE_BASE ) {
 175                 cscope = LDAP_SCOPE_BASE;
 176                 candidates = base_candidate( be, e );
 177
 178         } else {
 179                 cscope = ( scope != LDAP_SCOPE_SUBTREE )
 180                         ? LDAP_SCOPE_BASE : LDAP_SCOPE_SUBTREE;
 181                 candidates = search_candidates( be, e, filter,
 182                     scope, deref, manageDSAit );
 183         }
 184
 185         /* need normalized dn below */
 186         realbase = ch_strdup( e->e_ndn );
 187
 188         cache_return_entry_r( &li->li_cache, e );
 189
 190 searchit:
 191         if ( candidates == NULL ) {
 192                 /* no candidates */
 193 #ifdef NEW_LOGGING
 194                 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 195                         "ldbm_search: no candidates\n" ));
 196 #else
 197                 Debug( LDAP_DEBUG_TRACE, "ldbm_search: no candidates\n",
 198                         0, 0, 0 );
 199 #endif
 200
 201                 send_search_result( conn, op,
 202                         LDAP_SUCCESS,
 203                         NULL, NULL, NULL, NULL, 0 );
 204
 205                 rc = 1;
 206                 goto done;
 207         }
 208
 209         /* if not root, get appropriate limits */
 210         if ( be_isroot( be, op->o_ndn ) ) {
 211                 isroot = 1;
 212         } else {
 213                 ( void ) get_limits( be, op->o_ndn, &limit );
 214         }
 215
 216         /* if candidates exceed to-be-checked entries, abort */
 217         if ( !isroot && limit->lms_s_unchecked != -1 ) {
 218                 if ( ID_BLOCK_NIDS( candidates ) > limit->lms_s_unchecked ) {
 219                         send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
 220                                         NULL, NULL, NULL, NULL, 0 );
 221                         rc = 0;
 222                         goto done;
 223                 }
 224         }
 225
 226         /* if no time limit requested, use soft limit (unless root!) */
 227         if ( tlimit <= 0 ) {
 228                 if ( isroot ) {
 229                         tlimit = -1;    /* allow root to set no limit */
 230                 } else {
 231                         tlimit = limit->lms_t_soft;
 232                 }
 233
 234         /* if requested limit higher than hard limit, abort */
 235         } else if ( tlimit > limit->lms_t_hard ) {
 236                 /* no hard limit means use soft instead */
 237                 if ( limit->lms_t_hard == 0 ) {
 238                         tlimit = limit->lms_t_soft;
 239
 240                 /* positive hard limit means abort */
 241                 } else if ( limit->lms_t_hard > 0 ) {
 242                         send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
 243                                         NULL, NULL, NULL, NULL, 0 );
 244                         rc = 0;
 245                         goto done;
 246                 }
 247
 248                 /* negative hard limit means no limit */
 249         }
 250
 251         /* compute it anyway; root does not use it */
 252         stoptime = op->o_time + tlimit;
 253
 254         /* if no size limit requested, use soft limit (unless root!) */
 255         if ( slimit == 0 ) {
 256                 if ( isroot ) {
 257                         slimit = -1;    /* allow root to set no limit */
 258                 } else {
 259                         slimit = limit->lms_s_soft;
 260                 }
 261
 262         /* if requested limit higher than hard limit, abort */
 263         } else if ( slimit > limit->lms_s_hard ) {
 264                 /* no hard limit means use soft instead */
 265                 if ( limit->lms_s_hard == 0 ) {
 266                         slimit = limit->lms_s_soft;
 267
 268                 /* positive hard limit means abort */
 269                 } else if ( limit->lms_s_hard > 0 ) {
 270                         send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
 271                                         NULL, NULL, NULL, NULL, 0 );
 272                         rc = 0;
 273                         goto done;
 274                 }
 275
 276                 /* negative hard limit means no limit */
 277         }
 278
 279         for ( id = idl_firstid( candidates, &cursor ); id != NOID;
 280             id = idl_nextid( candidates, &cursor ) )
 281         {
 282                 int scopeok = 0;
 283
 284                 /* check for abandon */
 285                 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
 286
 287                 if ( op->o_abandon ) {
 288                         ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 289                         rc = 0;
 290                         goto done;
 291                 }
 292
 293                 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 294
 295                 /* check time limit */
 296                 if ( tlimit != -1 && slap_get_time() > stoptime ) {
 297                         send_search_result( conn, op, LDAP_TIMELIMIT_EXCEEDED,
 298                                 NULL, NULL, v2refs, NULL, nentries );
 299                         rc = 0;
 300                         goto done;
 301                 }
 302
 303                 /* get the entry with reader lock */
 304                 e = id2entry_r( be, id );
 305
 306                 if ( e == NULL ) {
 307 #ifdef NEW_LOGGING
 308                         LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 309                                 "ldbm_search: candidate %ld not found.\n", id ));
 310 #else
 311                         Debug( LDAP_DEBUG_TRACE,
 312                                 "ldbm_search: candidate %ld not found\n",
 313                                 id, 0, 0 );
 314 #endif
 315
 316                         goto loop_continue;
 317                 }
 318
 319                 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
 320                         Entry *matched;
 321                         int err;
 322                         const char *text;
 323
 324                         e = deref_entry_r( be, e, &err, &matched, &text );
 325
 326                         if( e == NULL ) {
 327                                 e = matched;
 328                                 goto loop_continue;
 329                         }
 330
 331                         if( e->e_id == id ) {
 332                                 /* circular loop */
 333                                 goto loop_continue;
 334                         }
 335
 336                         /* need to skip alias which deref into scope */
 337                         if( scope & LDAP_SCOPE_ONELEVEL ) {
 338                                 char *pdn = dn_parent( NULL, e->e_ndn );
 339                                 if ( pdn != NULL ) {
 340                                         if( strcmp( pdn, realbase ) ) {
 341                                                 free( pdn );
 342                                                 goto loop_continue;
 343                                         }
 344                                         free(pdn);
 345                                 }
 346
 347                         } else if ( dn_issuffix( e->e_ndn, realbase ) ) {
 348                                 /* alias is within scope */
 349 #ifdef NEW_LOGGING
 350                                 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL1,
 351                                         "ldbm_search: alias \"%s\" in subtree\n", e->e_dn ));
 352 #else
 353                                 Debug( LDAP_DEBUG_TRACE,
 354                                         "ldbm_search: alias \"%s\" in subtree\n",
 355                                         e->e_dn, 0, 0 );
 356 #endif
 357
 358                                 goto loop_continue;
 359                         }
 360
 361                         scopeok = 1;
 362                 }
 363
 364                 /*
 365                  * if it's a referral, add it to the list of referrals. only do
 366                  * this for non-base searches, and don't check the filter
 367                  * explicitly here since it's only a candidate anyway.
 368                  */
 369                 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
 370                         is_entry_referral( e ) )
 371                 {
 372                         char    *dn;
 373
 374                         /* check scope */
 375                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 376                                 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
 377                                         (void) dn_normalize( dn );
 378                                         scopeok = (dn == realbase)
 379                                                 ? 1
 380                                                 : (strcmp( dn, realbase ) ? 0 : 1 );
 381                                         free( dn );
 382
 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                                 struct berval **erefs = get_entry_referrals(
 398                                         be, conn, op, e, NULL, cscope );
 399                                 struct berval **refs = referral_rewrite( erefs, e->e_dn,
 400                                         NULL, scope );
 401
 402                                 send_search_reference( be, conn, op,
 403                                         e, refs, NULL, &v2refs );
 404
 405                                 ber_bvecfree( refs );
 406
 407                         } else {
 408 #ifdef NEW_LOGGING
 409                                 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
 410                                         "ldbm_search: candidate referral %ld scope not okay\n",
 411                                         id ));
 412 #else
 413                                 Debug( LDAP_DEBUG_TRACE,
 414                                         "ldbm_search: candidate referral %ld scope not okay\n",
 415                                         id, 0, 0 );
 416 #endif
 417                         }
 418
 419                         goto loop_continue;
 420                 }
 421
 422                 /* if it matches the filter and scope, send it */
 423                 if ( test_filter( be, conn, op, e, filter ) == LDAP_COMPARE_TRUE ) {
 424                         char    *dn;
 425
 426                         /* check scope */
 427                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 428                                 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
 429                                         (void) dn_normalize( dn );
 430                                         scopeok = (dn == realbase)
 431                                                 ? 1
 432                                                 : (strcmp( dn, realbase ) ? 0 : 1 );
 433                                         free( dn );
 434
 435                                 } else {
 436                                         scopeok = (realbase == NULL || *realbase == '\0');
 437                                 }
 438
 439                         } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
 440                                 dn = ch_strdup( e->e_ndn );
 441                                 scopeok = dn_issuffix( dn, realbase );
 442                                 free( dn );
 443
 444                         } else {
 445                                 scopeok = 1;
 446                         }
 447
 448                         if ( scopeok ) {
 449                                 /* check size limit */
 450                                 if ( --slimit == -1 ) {
 451                                         cache_return_entry_r( &li->li_cache, e );
 452                                         send_search_result( conn, op,
 453                                                 LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
 454                                                 v2refs, NULL, nentries );
 455                                         rc = 0;
 456                                         goto done;
 457                                 }
 458
 459                                 if (e) {
 460                                         int result = send_search_entry(be, conn, op,
 461                                                 e, attrs, attrsonly, NULL);
 462
 463                                         switch (result) {
 464                                         case 0:         /* entry sent ok */
 465                                                 nentries++;
 466                                                 break;
 467                                         case 1:         /* entry not sent */
 468                                                 break;
 469                                         case -1:        /* connection closed */
 470                                                 cache_return_entry_r( &li->li_cache, e );
 471                                                 rc = 0;
 472                                                 goto done;
 473                                         }
 474                                 }
 475                         } else {
 476 #ifdef NEW_LOGGING
 477                                 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
 478                                         "ldbm_search: candidate entry %ld scope not okay\n", id ));
 479 #else
 480                                 Debug( LDAP_DEBUG_TRACE,
 481                                         "ldbm_search: candidate entry %ld scope not okay\n",
 482                                         id, 0, 0 );
 483 #endif
 484                         }
 485
 486                 } else {
 487 #ifdef NEW_LOGGING
 488                         LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
 489                                 "ldbm_search: candidate entry %ld does not match filter\n", id ));
 490 #else
 491                         Debug( LDAP_DEBUG_TRACE,
 492                                 "ldbm_search: candidate entry %ld does not match filter\n",
 493                                 id, 0, 0 );
 494 #endif
 495                 }
 496
 497 loop_continue:
 498                 if( e != NULL ) {
 499                         /* free reader lock */
 500                         cache_return_entry_r( &li->li_cache, e );
 501                 }
 502
 503                 ldap_pvt_thread_yield();
 504         }
 505
 506         send_search_result( conn, op,
 507                 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
 508                 NULL, NULL, v2refs, NULL, nentries );
 509
 510         rc = 0;
 511
 512 done:
 513         if( candidates != NULL )
 514                 idl_free( candidates );
 515
 516         ber_bvecfree( v2refs );
 517         if( realbase ) free( realbase );
 518
 519         return rc;
 520 }
 521
 522 static ID_BLOCK *
 523 base_candidate(
 524     Backend     *be,
 525         Entry   *e )
 526 {
 527         ID_BLOCK                *idl;
 528
 529 #ifdef NEW_LOGGING
 530         LDAP_LOG(( "backend", LDAP_LEVEL_ENTRY,
 531                    "base_candidate: base (%s)\n", e->e_dn ));
 532 #else
 533         Debug(LDAP_DEBUG_TRACE, "base_candidates: base: \"%s\"\n",
 534                 e->e_dn, 0, 0);
 535 #endif
 536
 537
 538         idl = idl_alloc( 1 );
 539         idl_insert( &idl, e->e_id, 1 );
 540
 541         return( idl );
 542 }
 543
 544 static ID_BLOCK *
 545 search_candidates(
 546     Backend     *be,
 547     Entry       *e,
 548     Filter      *filter,
 549     int         scope,
 550         int             deref,
 551         int             manageDSAit )
 552 {
 553         ID_BLOCK                *candidates;
 554         Filter          f, fand, rf, af, xf;
 555     AttributeAssertion aa_ref, aa_alias;
 556         static struct berval bv_ref = { sizeof("REFERRAL")-1, "REFERRAL" };
 557         static struct berval bv_alias = { sizeof("ALIAS")-1, "ALIAS" };
 558
 559 #ifdef NEW_LOGGING
 560         LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL1,
 561                    "search_candidates: base (%s) scope %d deref %d\n",
 562                    e->e_ndn, scope, deref ));
 563 #else
 564         Debug(LDAP_DEBUG_TRACE,
 565                 "search_candidates: base=\"%s\" s=%d d=%d\n",
 566                 e->e_ndn, scope, deref );
 567 #endif
 568
 569
 570         xf.f_or = filter;
 571         xf.f_choice = LDAP_FILTER_OR;
 572         xf.f_next = NULL;
 573
 574         if( !manageDSAit ) {
 575                 /* match referrals */
 576                 rf.f_choice = LDAP_FILTER_EQUALITY;
 577                 rf.f_ava = &aa_ref;
 578                 rf.f_av_desc = slap_schema.si_ad_objectClass;
 579                 rf.f_av_value = &bv_ref;
 580                 rf.f_next = xf.f_or;
 581                 xf.f_or = &rf;
 582         }
 583
 584         if( deref & LDAP_DEREF_SEARCHING ) {
 585                 /* match aliases */
 586                 af.f_choice = LDAP_FILTER_EQUALITY;
 587                 af.f_ava = &aa_alias;
 588                 af.f_av_desc = slap_schema.si_ad_objectClass;
 589                 af.f_av_value = &bv_alias;
 590                 af.f_next = xf.f_or;
 591                 xf.f_or = &af;
 592         }
 593
 594         f.f_next = NULL;
 595         f.f_choice = LDAP_FILTER_AND;
 596         f.f_and = &fand;
 597         fand.f_choice = scope == LDAP_SCOPE_SUBTREE
 598                 ? SLAPD_FILTER_DN_SUBTREE
 599                 : SLAPD_FILTER_DN_ONE;
 600         fand.f_dn = e->e_ndn;
 601         fand.f_next = xf.f_or == filter ? filter : &xf ;
 602
 603         candidates = filter_candidates( be, &f );
 604
 605         return( candidates );
 606 }