1 /* search.c - search operation */
4 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include <ac/string.h>
17 static int base_candidate(
21 static int search_candidates(
42 struct berval *filterstr,
46 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
49 const char *text = NULL;
52 ID candidates[BDB_IDL_UM_SIZE];
54 BerVarray v2refs = NULL;
55 Entry *matched = NULL;
56 struct berval realbase = { 0, NULL };
60 struct slap_limits_set *limit = NULL;
63 Debug( LDAP_DEBUG_TRACE, "=> bdb_back_search\n",
66 manageDSAit = get_manageDSAit( op );
68 if ( nbase->bv_len == 0 ) {
69 /* DIT root special case */
70 e = (Entry *) &slap_entry_root;
74 /* get entry with reader lock */
75 if ( deref & LDAP_DEREF_FINDING ) {
76 e = deref_dn_r( be, nbase-, &err, &matched, &text );
81 rc = bdb_dn2entry( be, NULL, nbase, &e, &matched, 0 );
89 send_ldap_result( conn, op, rc=LDAP_OTHER,
90 NULL, "internal error", NULL, NULL );
95 struct berval matched_dn = { 0, NULL };
96 BerVarray refs = NULL;
98 if ( matched != NULL ) {
101 ber_dupbv( &matched_dn, &matched->e_name );
103 erefs = is_entry_referral( matched )
104 ? get_entry_referrals( be, conn, op, matched )
107 bdb_entry_return( be, matched );
111 refs = referral_rewrite( erefs, &matched_dn,
113 ber_bvarray_free( erefs );
117 refs = referral_rewrite( default_referral,
121 send_ldap_result( conn, op, rc=LDAP_REFERRAL ,
122 matched_dn.bv_val, text, refs, NULL );
124 if ( refs ) ber_bvarray_free( refs );
125 if ( matched_dn.bv_val ) ber_memfree( matched_dn.bv_val );
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 BerVarray erefs, refs;
134 ber_dupbv( &matched_dn, &e->e_name );
135 erefs = get_entry_referrals( be, conn, op, e );
138 bdb_entry_return( be, e );
142 refs = referral_rewrite( erefs, &matched_dn,
144 ber_bvarray_free( erefs );
147 Debug( LDAP_DEBUG_TRACE, "bdb_search: entry is referral\n",
150 send_ldap_result( conn, op, LDAP_REFERRAL,
152 refs ? NULL : "bad referral object",
155 ber_bvarray_free( refs );
156 ber_memfree( matched_dn.bv_val );
160 /* if not root, get appropriate limits */
161 if ( be_isroot( be, &op->o_ndn ) ) {
164 ( void ) get_limits( be, &op->o_ndn, &limit );
167 /* The time/size limits come first because they require very little
168 * effort, so there's no chance the candidates are selected and then
169 * the request is not honored only because of time/size constraints */
171 /* if no time limit requested, use soft limit (unless root!) */
174 tlimit = -1; /* allow root to set no limit */
182 /* if no limit is required, use soft limit */
184 tlimit = limit->lms_t_soft;
186 /* if requested limit higher than hard limit, abort */
187 } else if ( tlimit > limit->lms_t_hard ) {
188 /* no hard limit means use soft instead */
189 if ( limit->lms_t_hard == 0 ) {
190 tlimit = limit->lms_t_soft;
192 /* positive hard limit means abort */
193 } else if ( limit->lms_t_hard > 0 ) {
194 send_search_result( conn, op,
195 LDAP_UNWILLING_TO_PERFORM,
196 NULL, NULL, NULL, NULL, 0 );
201 /* negative hard limit means no limit */
204 /* if no limit is required, use soft limit */
206 slimit = limit->lms_s_soft;
208 /* if requested limit higher than hard limit, abort */
209 } else if ( slimit > limit->lms_s_hard ) {
210 /* no hard limit means use soft instead */
211 if ( limit->lms_s_hard == 0 ) {
212 slimit = limit->lms_s_soft;
214 /* positive hard limit means abort */
215 } else if ( limit->lms_s_hard > 0 ) {
216 send_search_result( conn, op,
217 LDAP_UNWILLING_TO_PERFORM,
218 NULL, NULL, NULL, NULL, 0 );
223 /* negative hard limit means no limit */
227 /* compute it anyway; root does not use it */
228 stoptime = op->o_time + tlimit;
230 /* select candidates */
231 if ( scope == LDAP_SCOPE_BASE ) {
232 rc = base_candidate( be, e, candidates );
235 BDB_IDL_ALL( bdb, candidates );
236 rc = search_candidates( be, op, e, filter,
237 scope, deref, candidates );
240 /* need normalized dn below */
241 ber_dupbv( &realbase, &e->e_nname );
243 /* start cursor at base entry's id
244 * FIXME: hack to make "" base work */
245 cursor = e->e_id == NOID ? 1 : e->e_id;
247 if ( e != &slap_entry_root ) {
248 bdb_entry_return( be, e );
252 if ( candidates[0] == 0 ) {
253 Debug( LDAP_DEBUG_TRACE, "bdb_search: no candidates\n",
256 send_search_result( conn, op,
258 NULL, NULL, NULL, NULL, 0 );
264 /* if not root and candidates exceed to-be-checked entries, abort */
265 if ( !isroot && limit->lms_s_unchecked != -1 ) {
266 if ( BDB_IDL_N(candidates) > (unsigned) limit->lms_s_unchecked ) {
267 send_search_result( conn, op,
268 LDAP_UNWILLING_TO_PERFORM,
269 NULL, NULL, NULL, NULL, 0 );
275 for ( id = bdb_idl_first( candidates, &cursor );
277 id = bdb_idl_next( candidates, &cursor ) )
281 /* check for abandon */
282 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
283 abandon = op->o_abandon;
284 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
291 /* check time limit */
292 if ( tlimit != -1 && slap_get_time() > stoptime ) {
293 send_search_result( conn, op, rc = LDAP_TIMELIMIT_EXCEEDED,
294 NULL, NULL, v2refs, NULL, nentries );
298 /* get the entry with reader lock */
299 rc = bdb_id2entry( be, NULL, id, &e );
302 if( !BDB_IDL_IS_RANGE(candidates) ) {
303 /* only complain for non-range IDLs */
304 Debug( LDAP_DEBUG_TRACE,
305 "bdb_search: candidate %ld not found\n",
312 if ( is_entry_subentry( e ) ) {
313 if( scope != LDAP_SCOPE_BASE ) {
314 if(!get_subentries_visibility( op )) {
315 /* only subentries are visible */
318 } else if ( get_subentries( op ) &&
319 !get_subentries_visibility( op ))
321 /* only subentries are visible */
324 } else if ( get_subentries_visibility( op )) {
325 /* only subentries are visible */
330 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
335 e = deref_entry_r( be, e, &err, &matched, &text );
342 if( e->e_id == id ) {
347 /* need to skip alias which deref into scope */
348 if( scope & LDAP_SCOPE_ONELEVEL ) {
352 if ( dnParent( e->e_nname.bv_val, &pdn ) == LDAP_SUCCESS ) {
353 plen = e->e_nname.bv_len - ( pdn - e->e_nname.bv_val );
354 if ( plen != realbase.bv_len || strcmp( pdn, realbase.bv_val ) ) {
359 } else if ( dnIsSuffix( &e->e_nname, &realbase ) ) {
360 /* alias is within scope */
361 Debug( LDAP_DEBUG_TRACE,
362 "bdb_search: \"%s\" in subtree\n",
372 * if it's a referral, add it to the list of referrals. only do
373 * this for non-base searches, and don't check the filter
374 * explicitly here since it's only a candidate anyway.
376 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
377 is_entry_referral( e ) )
379 BerVarray erefs = get_entry_referrals(
381 BerVarray refs = referral_rewrite( erefs,
383 scope == LDAP_SCOPE_SUBTREE
387 send_search_reference( be, conn, op,
388 e, refs, NULL, &v2refs );
390 ber_bvarray_free( refs );
395 /* if it matches the filter and scope, send it */
396 rc = test_filter( be, conn, op, e, filter );
397 if ( rc == LDAP_COMPARE_TRUE ) {
401 if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
402 if ( be_issuffix( be, e->e_nname.bv_val ) ) {
403 scopeok = (realbase.bv_len == 0);
405 dnParent( e->e_nname.bv_val, (const char **)&dn );
406 scopeok = (dn == realbase.bv_val)
408 : (strcmp( dn, realbase.bv_val ) ? 0 : 1 );
411 } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
412 scopeok = dnIsSuffix( &e->e_nname, &realbase );
419 /* check size limit */
420 if ( --slimit == -1 ) {
421 bdb_entry_return( be, e );
423 send_search_result( conn, op,
424 rc = LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
425 v2refs, NULL, nentries );
430 int result = send_search_entry( be, conn, op,
431 e, attrs, attrsonly, NULL);
434 case 0: /* entry sent ok */
437 case 1: /* entry not sent */
439 case -1: /* connection closed */
440 bdb_entry_return( be, e );
447 Debug( LDAP_DEBUG_TRACE,
448 "bdb_search: %ld scope not okay\n",
452 Debug( LDAP_DEBUG_TRACE,
453 "bdb_search: %ld does match filter\n",
459 /* free reader lock */
460 bdb_entry_return( be, e );
463 ldap_pvt_thread_yield();
465 send_search_result( conn, op,
466 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
467 NULL, NULL, v2refs, NULL, nentries );
472 if( v2refs ) ber_bvarray_free( v2refs );
473 if( realbase.bv_val ) ch_free( realbase.bv_val );
479 static int base_candidate(
484 Debug(LDAP_DEBUG_ARGS, "base_candidates: base: \"%s\" (0x%08lx)\n",
485 e->e_dn, (long) e->e_id, 0);
492 /* Is "objectClass=xx" mentioned anywhere in this filter? Presence
493 * doesn't count, we're looking for explicit values.
495 static int oc_filter(
501 switch(f->f_choice) {
502 case LDAP_FILTER_EQUALITY:
503 case LDAP_FILTER_APPROX:
504 if (f->f_av_desc == slap_schema.si_ad_objectClass)
508 case LDAP_FILTER_SUBSTRINGS:
509 if (f->f_sub_desc == slap_schema.si_ad_objectClass)
513 case LDAP_FILTER_AND:
515 for (f=f->f_and; f; f=f->f_next)
516 if ((rc = oc_filter(f)))
525 static int search_candidates(
535 Filter f, scopef, sf, rf, xf;
536 ID tmp[BDB_IDL_UM_SIZE];
537 AttributeAssertion aa_ref;
538 AttributeAssertion aa_subentry;
539 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
542 AttributeAssertion aa_alias;
546 * This routine takes as input a filter (user-filter)
547 * and rewrites it as follows:
548 * (&(scope=DN)[(objectClass=subentry)]
549 * (|[(objectClass=referral)(objectClass=alias)](user-filter))
552 Debug(LDAP_DEBUG_TRACE,
553 "search_candidates: base=\"%s\" (0x%08lx) scope=%d\n",
554 e->e_dn, (long) e->e_id, scope );
557 xf.f_choice = LDAP_FILTER_OR;
560 /* If the user's filter doesn't mention objectClass, or if
561 * it just uses objectClass=*, these clauses are redundant.
563 if (oc_filter(filter) && !get_subentries_visibility(op) ) {
564 if( !get_manageDSAit(op) ) { /* match referrals */
565 struct berval bv_ref = { sizeof("REFERRAL")-1, "REFERRAL" };
566 rf.f_choice = LDAP_FILTER_EQUALITY;
568 rf.f_av_desc = slap_schema.si_ad_objectClass;
569 rf.f_av_value = bv_ref;
575 if( deref & LDAP_DEREF_SEARCHING ) { /* match aliases */
576 struct berval bv_alias = { sizeof("ALIAS")-1, "ALIAS" };
577 af.f_choice = LDAP_FILTER_EQUALITY;
578 af.f_ava = &aa_alias;
579 af.f_av_desc = slap_schema.si_ad_objectClass;
580 af.f_av_value = bv_alias;
588 f.f_choice = LDAP_FILTER_AND;
590 scopef.f_choice = scope == LDAP_SCOPE_SUBTREE
591 ? SLAPD_FILTER_DN_SUBTREE
592 : SLAPD_FILTER_DN_ONE;
593 scopef.f_dn = &e->e_nname;
594 scopef.f_next = xf.f_or == filter ? filter : &xf ;
596 if( get_subentries_visibility( op ) ) {
597 struct berval bv_subentry = { sizeof("SUBENTRY")-1, "SUBENTRY" };
598 sf.f_choice = LDAP_FILTER_EQUALITY;
599 sf.f_ava = &aa_subentry;
600 sf.f_av_desc = slap_schema.si_ad_objectClass;
601 sf.f_av_value = bv_subentry;
602 sf.f_next = scopef.f_next;
606 #ifdef BDB_FILTER_INDICES
607 rc = bdb_filter_candidates( be, &f, ids, tmp );
609 /* FIXME: Original code:
610 BDB_IDL_ID( bdb, ids, e->e_id );
611 * this is a hack to make "" base work; when bdb_filter_candidates
612 * is used this should not be needed any more */
613 BDB_IDL_ID( bdb, ids, (e->e_id == NOID ? 1 : e->e_id) );
617 Debug(LDAP_DEBUG_TRACE,
618 "bdb_search_candidates: id=%ld first=%ld last=%ld\n",
620 (long) BDB_IDL_FIRST(ids),
621 (long) BDB_IDL_LAST(ids) );