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

   1 /* search.c - ldbm backend search function */
   2
   3 #include "portable.h"
   4
   5 #include <stdio.h>
   6
   7 #include <ac/string.h>
   8 #include <ac/socket.h>
   9
  10 #include "slap.h"
  11 #include "back-ldbm.h"
  12 #include "proto-back-ldbm.h"
  13
  14 static IDList   *base_candidates(Backend *be, Connection *conn, Operation *op, char *base, Filter *filter, char **attrs, int attrsonly, char **matched, int *err);
  15 static IDList   *onelevel_candidates(Backend *be, Connection *conn, Operation *op, char *base, Filter *filter, char **attrs, int attrsonly, char **matched, int *err);
  16 static IDList   *subtree_candidates(Backend *be, Connection *conn, Operation *op, char *base, Filter *filter, char **attrs, int attrsonly, char **matched, Entry *e, int *err, int lookupbase);
  17
  18 #define GRABSIZE        BUFSIZ
  19
  20 #define MAKE_SPACE( n ) { \
  21         if ( rcur + n > rbuf + rmaxsize ) { \
  22                 int     offset = rcur - rbuf; \
  23                 rbuf =  ch_realloc( rbuf, rmaxsize + GRABSIZE ); \
  24                 rmaxsize += GRABSIZE; \
  25                 rcur = rbuf + offset; \
  26         } \
  27 }
  28
  29 int
  30 ldbm_back_search(
  31     Backend     *be,
  32     Connection  *conn,
  33     Operation   *op,
  34     char        *base,
  35     int         scope,
  36     int         deref,
  37     int         slimit,
  38     int         tlimit,
  39     Filter      *filter,
  40     char        *filterstr,
  41     char        **attrs,
  42     int         attrsonly
  43 )
  44 {
  45         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
  46         int             err;
  47         time_t          stoptime;
  48         IDList          *candidates;
  49         ID              id;
  50         Entry           *e;
  51         Attribute       *ref;
  52         char            *matched = NULL;
  53         int             rmaxsize, nrefs;
  54         char            *rbuf, *rcur, *r;
  55         int             nentries = 0;
  56         char            *realBase;
  57
  58         Debug(LDAP_DEBUG_ARGS, "=> ldbm_back_search\n", 0, 0, 0);
  59
  60         if ( tlimit == 0 && be_isroot( be, op->o_ndn ) ) {
  61                 tlimit = -1;    /* allow root to set no limit */
  62         } else {
  63                 tlimit = (tlimit > be->be_timelimit || tlimit < 1) ?
  64                     be->be_timelimit : tlimit;
  65                 stoptime = op->o_time + tlimit;
  66         }
  67         if ( slimit == 0 && be_isroot( be, op->o_ndn ) ) {
  68                 slimit = -1;    /* allow root to set no limit */
  69         } else {
  70                 slimit = (slimit > be->be_sizelimit || slimit < 1) ?
  71                     be->be_sizelimit : slimit;
  72         }
  73
  74         /*
  75          * check and apply aliasing where the dereferencing applies to
  76          * the subordinates of the base
  77          */
  78
  79         switch ( deref ) {
  80         case LDAP_DEREF_FINDING:
  81         case LDAP_DEREF_ALWAYS:
  82                 realBase = derefDN ( be, conn, op, base );
  83                 break;
  84         default:
  85                 realBase = ch_strdup(base);
  86         }
  87
  88         (void) dn_normalize_case( realBase );
  89
  90         Debug( LDAP_DEBUG_TRACE, "using base \"%s\"\n",
  91                 realBase, 0, 0 );
  92
  93         switch ( scope ) {
  94         case LDAP_SCOPE_BASE:
  95                 candidates = base_candidates( be, conn, op, realBase, filter,
  96                     attrs, attrsonly, &matched, &err );
  97                 break;
  98
  99         case LDAP_SCOPE_ONELEVEL:
 100                 candidates = onelevel_candidates( be, conn, op, realBase, filter,
 101                     attrs, attrsonly, &matched, &err );
 102                 break;
 103
 104         case LDAP_SCOPE_SUBTREE:
 105                 candidates = subtree_candidates( be, conn, op, realBase, filter,
 106                     attrs, attrsonly, &matched, NULL, &err, 1 );
 107                 break;
 108
 109         default:
 110                 send_ldap_result( conn, op, LDAP_PROTOCOL_ERROR, "",
 111                     "Bad scope" );
 112                 if( realBase != NULL) {
 113                         free( realBase );
 114                 }
 115                 return( -1 );
 116         }
 117
 118         /* null candidates means we could not find the base object */
 119         if ( candidates == NULL ) {
 120                 send_ldap_result( conn, op, err, matched, "" );
 121                 if ( matched != NULL ) {
 122                         free( matched );
 123                 }
 124                 if( realBase != NULL) {
 125                         free( realBase );
 126                 }
 127                 return( -1 );
 128         }
 129
 130         if ( matched != NULL ) {
 131                 free( matched );
 132         }
 133
 134         rmaxsize = 0;
 135         nrefs = 0;
 136         rbuf = rcur = NULL;
 137         MAKE_SPACE( sizeof("Referral:") + 1 );
 138         strcpy( rbuf, "Referral:" );
 139         rcur = strchr( rbuf, '\0' );
 140         for ( id = idl_firstid( candidates ); id != NOID;
 141             id = idl_nextid( candidates, id ) ) {
 142                 /* check for abandon */
 143                 pthread_mutex_lock( &op->o_abandonmutex );
 144                 if ( op->o_abandon ) {
 145                         pthread_mutex_unlock( &op->o_abandonmutex );
 146                         idl_free( candidates );
 147                         free( rbuf );
 148                         if( realBase != NULL) {
 149                                 free( realBase );
 150                         }
 151                         return( 0 );
 152                 }
 153                 pthread_mutex_unlock( &op->o_abandonmutex );
 154
 155                 /* check time limit */
 156                 pthread_mutex_lock( &currenttime_mutex );
 157                 time( &currenttime );
 158                 if ( tlimit != -1 && currenttime > stoptime ) {
 159                         pthread_mutex_unlock( &currenttime_mutex );
 160                         send_ldap_search_result( conn, op,
 161                             LDAP_TIMELIMIT_EXCEEDED, NULL, nrefs > 0 ? rbuf :
 162                             NULL, nentries );
 163                         idl_free( candidates );
 164                         free( rbuf );
 165                         if( realBase != NULL) {
 166                                 free( realBase );
 167                         }
 168                         return( 0 );
 169                 }
 170                 pthread_mutex_unlock( &currenttime_mutex );
 171
 172                 /* get the entry with reader lock */
 173                 if ( (e = id2entry_r( be, id )) == NULL ) {
 174                         Debug( LDAP_DEBUG_ARGS, "candidate %lu not found\n",
 175                                id, 0, 0 );
 176                         continue;
 177                 }
 178
 179                 /*
 180                  * if it's a referral, add it to the list of referrals. only do
 181                  * this for subtree searches, and don't check the filter explicitly
 182                  * here since it's only a candidate anyway.
 183                  */
 184                 if ( scope == LDAP_SCOPE_SUBTREE &&
 185                         e->e_ndn != NULL &&
 186                         strncmp( e->e_ndn, "REF=", 4 ) == 0 &&
 187                         (ref = attr_find( e->e_attrs, "ref" )) != NULL )
 188                 {
 189                         int     i, len;
 190
 191                         if ( ref->a_vals == NULL ) {
 192                                 Debug( LDAP_DEBUG_ANY, "null ref in (%s)\n",
 193                                         e->e_dn, 0, 0 );
 194                         } else {
 195                                 for ( i = 0; ref->a_vals[i] != NULL; i++ ) {
 196                                         /* referral + newline + null */
 197                                         MAKE_SPACE( ref->a_vals[i]->bv_len + 2 );
 198                                         *rcur++ = '\n';
 199                                         strncpy( rcur, ref->a_vals[i]->bv_val,
 200                                                 ref->a_vals[i]->bv_len );
 201                                         rcur = rcur + ref->a_vals[i]->bv_len;
 202                                         *rcur = '\0';
 203                                         nrefs++;
 204                                 }
 205                         }
 206
 207                 /* otherwise it's an entry - see if it matches the filter */
 208                 } else {
 209                         /* if it matches the filter and scope, send it */
 210                         if ( test_filter( be, conn, op, e, filter ) == 0 ) {
 211                                 int             scopeok;
 212                                 char    *dn;
 213
 214                                 /* check scope */
 215                                 scopeok = 1;
 216                                 if ( scope == LDAP_SCOPE_ONELEVEL ) {
 217                                         if ( (dn = dn_parent( be, e->e_dn )) != NULL ) {
 218                                                 (void) dn_normalize_case( dn );
 219                                                 scopeok = (dn == realBase)
 220                                                         ? 1
 221                                                         : (strcmp( dn, realBase ) ? 0 : 1 );
 222                                                 free( dn );
 223                                         } else {
 224                                                 scopeok = (realBase == NULL || *realBase == '\0');
 225                                         }
 226                                 } else if ( scope == LDAP_SCOPE_SUBTREE ) {
 227                                         dn = ch_strdup( e->e_ndn );
 228                                         scopeok = dn_issuffix( dn, realBase );
 229                                         free( dn );
 230                                 }
 231
 232                                 if ( scopeok ) {
 233                                         /* check size limit */
 234                                         if ( --slimit == -1 ) {
 235                                                 cache_return_entry_r( &li->li_cache, e );
 236                                                 send_ldap_search_result( conn, op,
 237                                                         LDAP_SIZELIMIT_EXCEEDED, NULL,
 238                                                         nrefs > 0 ? rbuf : NULL, nentries );
 239                                                 idl_free( candidates );
 240                                                 free( rbuf );
 241
 242                                                 if( realBase != NULL) {
 243                                                         free( realBase );
 244                                                 }
 245                                                 return( 0 );
 246                                         }
 247
 248                                         /*
 249                                          * check and apply aliasing where the dereferencing applies to
 250                                          * the subordinates of the base
 251                                          */
 252                                         switch ( deref ) {
 253                                         case LDAP_DEREF_SEARCHING:
 254                                         case LDAP_DEREF_ALWAYS:
 255                                                 {
 256                                                         Entry *newe = derefAlias_r( be, conn, op, e );
 257                                                         cache_return_entry_r( &li->li_cache, e );
 258                                                         e = newe;
 259                                                 }
 260                                                 break;
 261                                         }
 262
 263                                         switch ( send_search_entry( be, conn, op, e,
 264                                                 attrs, attrsonly ) ) {
 265                                         case 0:         /* entry sent ok */
 266                                                 nentries++;
 267                                                 break;
 268                                         case 1:         /* entry not sent */
 269                                                 break;
 270                                         case -1:        /* connection closed */
 271                                                 cache_return_entry_r( &li->li_cache, e );
 272                                                 idl_free( candidates );
 273                                                 free( rbuf );
 274
 275                                                 if( realBase != NULL) {
 276                                                         free( realBase );
 277                                                 }
 278                                                 return( 0 );
 279                                         }
 280                                 }
 281                         }
 282                 }
 283
 284                 if( e != NULL ) {
 285                         /* free reader lock */
 286                         cache_return_entry_r( &li->li_cache, e );
 287                 }
 288
 289                 pthread_yield();
 290         }
 291         idl_free( candidates );
 292         if ( nrefs > 0 ) {
 293                 send_ldap_search_result( conn, op, LDAP_PARTIAL_RESULTS, NULL,
 294                     rbuf, nentries );
 295         } else {
 296                 send_ldap_search_result( conn, op, LDAP_SUCCESS, NULL, NULL,
 297                     nentries );
 298         }
 299         free( rbuf );
 300
 301         if( realBase != NULL) {
 302                 free( realBase );
 303         }
 304
 305         return( 0 );
 306 }
 307
 308 static IDList *
 309 base_candidates(
 310     Backend     *be,
 311     Connection  *conn,
 312     Operation   *op,
 313     char        *base,
 314     Filter      *filter,
 315     char        **attrs,
 316     int         attrsonly,
 317     char        **matched,
 318     int         *err
 319 )
 320 {
 321         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
 322         int             rc;
 323         ID              id;
 324         IDList          *idl;
 325         Entry           *e;
 326
 327         Debug(LDAP_DEBUG_TRACE, "base_candidates: base: \"%s\"\n", base, 0, 0);
 328
 329         *err = LDAP_SUCCESS;
 330
 331         /* get entry with reader lock */
 332         if ( (e = dn2entry_r( be, base, matched )) == NULL ) {
 333                 *err = LDAP_NO_SUCH_OBJECT;
 334                 return( NULL );
 335         }
 336
 337         /* check for deleted */
 338
 339         idl = idl_alloc( 1 );
 340         idl_insert( &idl, e->e_id, 1 );
 341
 342
 343         /* free reader lock */
 344         cache_return_entry_r( &li->li_cache, e );
 345
 346         return( idl );
 347 }
 348
 349 static IDList *
 350 onelevel_candidates(
 351     Backend     *be,
 352     Connection  *conn,
 353     Operation   *op,
 354     char        *base,
 355     Filter      *filter,
 356     char        **attrs,
 357     int         attrsonly,
 358     char        **matched,
 359     int         *err
 360 )
 361 {
 362         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
 363         Entry           *e = NULL;
 364         Filter          *f;
 365         char            buf[20];
 366         IDList          *candidates;
 367
 368         Debug(LDAP_DEBUG_TRACE, "onelevel_candidates: base: \"%s\"\n", base, 0, 0);
 369
 370         *err = LDAP_SUCCESS;
 371
 372         /* get the base object with reader lock */
 373         if ( base != NULL && *base != '\0' &&
 374                 (e = dn2entry_r( be, base, matched )) == NULL )
 375         {
 376                 *err = LDAP_NO_SUCH_OBJECT;
 377                 return( NULL );
 378         }
 379
 380         /*
 381          * modify the filter to be something like this:
 382          *
 383          *      parent=baseobject & originalfilter
 384          */
 385
 386         f = (Filter *) ch_malloc( sizeof(Filter) );
 387         f->f_next = NULL;
 388         f->f_choice = LDAP_FILTER_AND;
 389         f->f_and = (Filter *) ch_malloc( sizeof(Filter) );
 390         f->f_and->f_choice = LDAP_FILTER_EQUALITY;
 391         f->f_and->f_ava.ava_type = ch_strdup( "id2children" );
 392         sprintf( buf, "%ld", e != NULL ? e->e_id : 0 );
 393         f->f_and->f_ava.ava_value.bv_val = ch_strdup( buf );
 394         f->f_and->f_ava.ava_value.bv_len = strlen( buf );
 395         f->f_and->f_next = filter;
 396
 397         /* from here, it's just like subtree_candidates */
 398         candidates = subtree_candidates( be, conn, op, base, f, attrs,
 399             attrsonly, matched, e, err, 0 );
 400
 401         /* free up just the filter stuff we allocated above */
 402         f->f_and->f_next = NULL;
 403         filter_free( f );
 404
 405         /* free entry and reader lock */
 406         if( e != NULL ) {
 407                 cache_return_entry_r( &li->li_cache, e );
 408         }
 409         return( candidates );
 410 }
 411
 412 static IDList *
 413 subtree_candidates(
 414     Backend     *be,
 415     Connection  *conn,
 416     Operation   *op,
 417     char        *base,
 418     Filter      *filter,
 419     char        **attrs,
 420     int         attrsonly,
 421     char        **matched,
 422     Entry       *e,
 423     int         *err,
 424     int         lookupbase
 425 )
 426 {
 427         struct ldbminfo *li = (struct ldbminfo *) be->be_private;
 428         Filter          *f, **filterarg_ptr;
 429         IDList          *candidates;
 430
 431         Debug(LDAP_DEBUG_TRACE, "subtree_candidates: base: \"%s\" %s\n",
 432                 base ? base : "NULL", lookupbase ? "lookupbase" : "", 0);
 433
 434         /*
 435          * get the base object - unless we already have it (from one-level).
 436          * also, unless this is a one-level search or a subtree search
 437          * starting at the very top of our subtree, we need to modify the
 438          * filter to be something like this:
 439          *
 440          *      dn=*baseobjectdn & (originalfilter | ref=*)
 441          *
 442          * the "objectclass=referral" part is used to select referrals to return
 443          */
 444
 445         *err = LDAP_SUCCESS;
 446         f = NULL;
 447         if ( lookupbase ) {
 448                 e = NULL;
 449
 450                 if ( base != NULL && *base != '\0' &&
 451                         (e = dn2entry_r( be, base, matched )) == NULL )
 452                 {
 453                         *err = LDAP_NO_SUCH_OBJECT;
 454                         return( NULL );
 455                 }
 456
 457                 if (e) {
 458                         cache_return_entry_r( &li->li_cache, e );
 459                 }
 460
 461                 f = (Filter *) ch_malloc( sizeof(Filter) );
 462                 f->f_next = NULL;
 463                 f->f_choice = LDAP_FILTER_OR;
 464                 f->f_or = (Filter *) ch_malloc( sizeof(Filter) );
 465                 f->f_or->f_choice = LDAP_FILTER_EQUALITY;
 466                 f->f_or->f_avtype = ch_strdup( "objectclass" );
 467                 /* Patch to use normalized uppercase */
 468                 f->f_or->f_avvalue.bv_val = ch_strdup( "REFERRAL" );
 469                 f->f_or->f_avvalue.bv_len = strlen( "REFERRAL" );
 470                 filterarg_ptr = &f->f_or->f_next;
 471                 *filterarg_ptr = filter;
 472                 filter = f;
 473
 474                 if ( ! be_issuffix( be, base ) ) {
 475                         f = (Filter *) ch_malloc( sizeof(Filter) );
 476                         f->f_next = NULL;
 477                         f->f_choice = LDAP_FILTER_AND;
 478                         f->f_and = (Filter *) ch_malloc( sizeof(Filter) );
 479                         f->f_and->f_choice = LDAP_FILTER_SUBSTRINGS;
 480                         f->f_and->f_sub_type = ch_strdup( "dn" );
 481                         f->f_and->f_sub_initial = NULL;
 482                         f->f_and->f_sub_any = NULL;
 483                         f->f_and->f_sub_final = ch_strdup( base );
 484                         value_normalize( f->f_and->f_sub_final, SYNTAX_CIS );
 485                         f->f_and->f_next = filter;
 486                         filter = f;
 487                 }
 488         }
 489
 490         candidates = filter_candidates( be, filter );
 491
 492         /* free up just the parts we allocated above */
 493         if ( f != NULL ) {
 494                 *filterarg_ptr = NULL;
 495                 filter_free( f );
 496         }
 497
 498         return( candidates );
 499 }