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-1999 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     char        *base,
  33     char        *nbase,
  34     int         scope,
  35     int         deref,
  36     int         slimit,
  37     int         tlimit,
  38     Filter      *filter,
  39     char        *filterstr,
  40     char        **attrs,
  41     int         attrsonly
  42 )
  43 {
  44         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
  45         int             rc, err;
  46         char *text;
  47         time_t          stoptime;
  48         ID_BLOCK                *candidates;
  49         ID              id, cursor;
  50         Entry           *e;
  51         struct berval **v2refs = NULL;
  52         Entry   *matched = NULL;
  53         char    *realbase = NULL;
  54         int             nentries = 0;
  55         int             manageDSAit = get_manageDSAit( op );
  56
  57         Debug(LDAP_DEBUG_TRACE, "=> ldbm_back_search\n", 0, 0, 0);
  58
  59         /* get entry with reader lock */
  60         if ( deref & LDAP_DEREF_FINDING ) {
  61                 e = deref_dn_r( be, nbase, &err, &matched, &text );
  62
  63         } else {
  64                 e = dn2entry_r( be, nbase, &matched );
  65                 err = e != NULL ? LDAP_SUCCESS : LDAP_REFERRAL;
  66                 text = NULL;
  67         }
  68
  69         if ( e == NULL ) {
  70                 char *matched_dn = NULL;
  71                 struct berval **refs = NULL;
  72
  73                 if ( matched != NULL ) {
  74                         matched_dn = ch_strdup( matched->e_dn );
  75
  76                         refs = is_entry_referral( matched )
  77                                 ? get_entry_referrals( be, conn, op, matched )
  78                                 : NULL;
  79
  80                         cache_return_entry_r( &li->li_cache, matched );
  81                 } else {
  82                         refs = default_referral;
  83                 }
  84
  85                 send_ldap_result( conn, op, err,
  86                         matched_dn, text, refs, NULL );
  87
  88                 if( matched != NULL ) {
  89                         ber_bvecfree( refs );
  90                         free( matched_dn );
  91                 }
  92
  93                 return 1;
  94         }
  95
  96         if (!manageDSAit && is_entry_referral( e ) ) {
  97                 /* entry is a referral, don't allow add */
  98                 char *matched_dn = ch_strdup( e->e_dn );
  99                 struct berval **refs = get_entry_referrals( be,
 100                         conn, op, e );
 101
 102                 cache_return_entry_r( &li->li_cache, e );
 103
 104                 Debug( LDAP_DEBUG_TRACE, "entry is referral\n", 0,
 105                     0, 0 );
 106
 107                 send_ldap_result( conn, op, LDAP_REFERRAL,
 108                     matched_dn, NULL, refs, NULL );
 109
 110                 ber_bvecfree( refs );
 111                 free( matched_dn );
 112
 113                 return 1;
 114         }
 115
 116         if ( tlimit == 0 && be_isroot( be, op->o_ndn ) ) {
 117                 tlimit = -1;    /* allow root to set no limit */
 118         } else {
 119                 tlimit = (tlimit > be->be_timelimit || tlimit < 1) ?
 120                     be->be_timelimit : tlimit;
 121                 stoptime = op->o_time + tlimit;
 122         }
 123
 124         if ( slimit == 0 && be_isroot( be, op->o_ndn ) ) {
 125                 slimit = -1;    /* allow root to set no limit */
 126         } else {
 127                 slimit = (slimit > be->be_sizelimit || slimit < 1) ?
 128                     be->be_sizelimit : slimit;
 129         }
 130
 131         if ( scope == LDAP_SCOPE_BASE) {
 132                 candidates = base_candidate( be, e );
 133
 134         } else {
 135                 candidates = search_candidates( be, e, filter,
 136                     scope, deref, manageDSAit );
 137         }
 138
 139         /* need normalized dn below */
 140         realbase = ch_strdup( e->e_ndn );
 141         cache_return_entry_r( &li->li_cache, e );
 142
 143         if ( candidates == NULL ) {
 144                 /* no candidates */
 145                 Debug( LDAP_DEBUG_TRACE, "no candidates\n", 0,
 146                     0, 0 );
 147
 148                 send_search_result( conn, op,
 149                         LDAP_SUCCESS,
 150                         NULL, NULL, NULL, NULL, 0 );
 151
 152                 rc = 1;
 153                 goto done;
 154         }
 155
 156         for ( id = idl_firstid( candidates, &cursor ); id != NOID;
 157             id = idl_nextid( candidates, &cursor ) )
 158         {
 159                 int             scopeok = 0;
 160
 161                 /* check for abandon */
 162                 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
 163
 164                 if ( op->o_abandon ) {
 165                         ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 166                         rc = 0;
 167                         goto done;
 168                 }
 169
 170                 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
 171
 172                 /* check time limit */
 173                 if ( tlimit != -1 && slap_get_time() > stoptime ) {
 174                         send_search_result( conn, op, LDAP_TIMELIMIT_EXCEEDED,
 175                                 NULL, NULL, v2refs, NULL, nentries );
 176                         rc = 0;
 177                         goto done;
 178                 }
 179
 180                 /* get the entry with reader lock */
 181                 e = id2entry_r( be, id );
 182
 183                 if ( e == NULL ) {
 184                         Debug( LDAP_DEBUG_ARGS, "search: candidate %ld not found\n",
 185                                 id, 0, 0 );
 186
 187                         goto loop_continue;
 188                 }
 189
 190                 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
 191                         Entry *matched;
 192                         int err;
 193                         char *text;
 194
 195                         e = deref_entry_r( be, e, &err, &matched, &text );
 196
 197                         if( e == NULL ) {
 198                                 e = matched;
 199                                 goto loop_continue;
 200                         }
 201
 202                         if( e->e_id == id ) {
 203                                 /* circular loop */
 204                                 goto loop_continue;
 205                         }
 206
 207                         /* need to skip alias which deref into scope */
 208                         if( scope & LDAP_SCOPE_ONELEVEL ) {
 209                                 char *pdn = dn_parent( NULL, e->e_ndn );
 210                                 if ( pdn != NULL ) {
 211                                         if( strcmp( pdn, realbase ) ) {
 212                                                 free( pdn );
 213                                                 goto loop_continue;
 214                                         }
 215                                         free(pdn);
 216                                 }
 217
 218                         } else if ( dn_issuffix( e->e_ndn, realbase ) ) {
 219                                 /* alias is within scope */
 220                                 Debug( LDAP_DEBUG_ARGS, "search: \"%s\" in subtree\n",
 221                                         e->e_dn, 0, 0 );
 222                                 goto loop_continue;
 223                         }
 224
 225                         scopeok = 1;
 226                 }
 227
 228                 /*
 229                  * if it's a referral, add it to the list of referrals. only do
 230                  * this for non-base searches, and don't check the filter
 231                  * explicitly here since it's only a candidate anyway.
 232                  */
 233                 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
 234                         is_entry_referral( e ) )
 235                 {
 236                         struct berval **refs = get_entry_referrals(
 237                                 be, conn, op, e );
 238
 239                         send_search_reference( be, conn, op,
 240                                 e, refs, scope, NULL, &v2refs );
 241
 242                         ber_bvecfree( refs );
 243
 244                         goto loop_continue;
 245                 }
 246
 247                 /* if it matches the filter and scope, send it */
 248                 if ( test_filter( be, conn, op, e, filter ) == 0 ) {
 249                         char    *dn;
 250
 251                         /* check scope */
 252                         if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
 253                                 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
 254                                         (void) dn_normalize_case( dn );
 255                                         scopeok = (dn == realbase)
 256                                                 ? 1
 257                                                 : (strcmp( dn, realbase ) ? 0 : 1 );
 258                                         free( dn );
 259
 260                                 } else {
 261                                         scopeok = (realbase == NULL || *realbase == '\0');
 262                                 }
 263
 264                         } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
 265                                 dn = ch_strdup( e->e_ndn );
 266                                 scopeok = dn_issuffix( dn, realbase );
 267                                 free( dn );
 268
 269                         } else {
 270                                 scopeok = 1;
 271                         }
 272
 273                         if ( scopeok ) {
 274                                 /* check size limit */
 275                                 if ( --slimit == -1 ) {
 276                                         cache_return_entry_r( &li->li_cache, e );
 277                                         send_search_result( conn, op,
 278                                                 LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
 279                                                 v2refs, NULL, nentries );
 280                                         rc = 0;
 281                                         goto done;
 282                                 }
 283
 284                                 if (e) {
 285                                         switch ( send_search_entry( be, conn, op, e,
 286                                                 attrs, attrsonly, NULL ) ) {
 287                                         case 0:         /* entry sent ok */
 288                                                 nentries++;
 289                                                 break;
 290                                         case 1:         /* entry not sent */
 291                                                 break;
 292                                         case -1:        /* connection closed */
 293                                                 cache_return_entry_r( &li->li_cache, e );
 294                                                 rc = 0;
 295                                                 goto done;
 296                                         }
 297                                 }
 298                         } else {
 299                                 Debug( LDAP_DEBUG_TRACE, "candidate %ld scope not okay\n",
 300                                         id, 0, 0 );
 301                         }
 302                 } else {
 303                         Debug( LDAP_DEBUG_TRACE, "candidate %ld does match filter\n",
 304                                 id, 0, 0 );
 305                 }
 306
 307 loop_continue:
 308                 if( e != NULL ) {
 309                         /* free reader lock */
 310                         cache_return_entry_r( &li->li_cache, e );
 311                 }
 312
 313                 ldap_pvt_thread_yield();
 314         }
 315         send_search_result( conn, op,
 316                 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
 317                 NULL, NULL, v2refs, NULL, nentries );
 318
 319         rc = 0;
 320
 321 done:
 322         if( candidates != NULL )
 323                 idl_free( candidates );
 324
 325         ber_bvecfree( v2refs );
 326         if( realbase ) free( realbase );
 327
 328         return rc;
 329 }
 330
 331 static ID_BLOCK *
 332 base_candidate(
 333     Backend     *be,
 334         Entry   *e
 335 )
 336 {
 337         ID_BLOCK                *idl;
 338
 339         Debug(LDAP_DEBUG_TRACE, "base_candidates: base: \"%s\"\n",
 340                 e->e_dn, 0, 0);
 341
 342         idl = idl_alloc( 1 );
 343         idl_insert( &idl, e->e_id, 1 );
 344
 345         return( idl );
 346 }
 347
 348 static ID_BLOCK *
 349 search_candidates(
 350     Backend     *be,
 351     Entry       *e,
 352     Filter      *filter,
 353     int         scope,
 354         int             deref,
 355         int             manageDSAit
 356 )
 357 {
 358         ID_BLOCK                *candidates;
 359         Filter          *f, *rf, *af, *lf;
 360
 361         Debug(LDAP_DEBUG_TRACE, "search_candidates: base=\"%s\" s=%d d=%d\n",
 362                 e->e_ndn, scope, deref );
 363
 364         f = NULL;
 365
 366         if( !manageDSAit ) {
 367                 /* match referrals */
 368                 rf = (Filter *) ch_malloc( sizeof(Filter) );
 369                 rf->f_next = NULL;
 370                 rf->f_choice = LDAP_FILTER_OR;
 371                 rf->f_or = (Filter *) ch_malloc( sizeof(Filter) );
 372                 rf->f_or->f_choice = LDAP_FILTER_EQUALITY;
 373                 rf->f_or->f_avtype = ch_strdup( "objectclass" );
 374                 rf->f_or->f_avvalue.bv_val = ch_strdup( "REFERRAL" );
 375                 rf->f_or->f_avvalue.bv_len = sizeof("REFERRAL")-1;
 376                 rf->f_or->f_next = filter;
 377                 f = rf;
 378         } else {
 379                 rf = NULL;
 380                 f = filter;
 381         }
 382
 383         if( deref & LDAP_DEREF_SEARCHING ) {
 384                 /* match aliases */
 385                 af = (Filter *) ch_malloc( sizeof(Filter) );
 386                 af->f_next = NULL;
 387                 af->f_choice = LDAP_FILTER_OR;
 388                 af->f_or = (Filter *) ch_malloc( sizeof(Filter) );
 389                 af->f_or->f_choice = LDAP_FILTER_EQUALITY;
 390                 af->f_or->f_avtype = ch_strdup( "objectclass" );
 391                 af->f_or->f_avvalue.bv_val = ch_strdup( "ALIAS" );
 392                 af->f_or->f_avvalue.bv_len = sizeof("ALIAS")-1;
 393                 af->f_or->f_next = f;
 394                 f = af;
 395         } else {
 396                 af = NULL;
 397         }
 398
 399         if ( scope == LDAP_SCOPE_SUBTREE ) {
 400                 lf = (Filter *) ch_malloc( sizeof(Filter) );
 401                 lf->f_next = NULL;
 402                 lf->f_choice = LDAP_FILTER_AND;
 403                 lf->f_and = (Filter *) ch_malloc( sizeof(Filter) );
 404
 405                 lf->f_and->f_choice = SLAPD_FILTER_DN_SUBTREE;
 406                 lf->f_and->f_dn = e->e_ndn;
 407
 408                 lf->f_and->f_next = f;
 409                 f = lf;
 410
 411         } else if ( scope == LDAP_SCOPE_ONELEVEL ) {
 412                 lf = (Filter *) ch_malloc( sizeof(Filter) );
 413                 lf->f_next = NULL;
 414                 lf->f_choice = LDAP_FILTER_AND;
 415                 lf->f_and = (Filter *) ch_malloc( sizeof(Filter) );
 416
 417                 lf->f_and->f_choice = SLAPD_FILTER_DN_ONE;
 418                 lf->f_and->f_dn = e->e_ndn;
 419
 420                 lf->f_and->f_next = f;
 421                 f = lf;
 422
 423         } else {
 424                 lf = NULL;
 425         }
 426
 427         candidates = filter_candidates( be, f );
 428
 429         /* free up filter additions we allocated above */
 430         if( lf != NULL ) {
 431                 free( lf->f_and );
 432                 free( lf );
 433         }
 434
 435         if( af != NULL ) {
 436                 af->f_or->f_next = NULL;
 437                 filter_free( af );
 438         }
 439
 440         if( rf != NULL ) {
 441                 rf->f_or->f_next = NULL;
 442                 filter_free( rf );
 443         }
 444
 445         return( candidates );
 446 }