1 /* search.c - ldbm backend search function */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
12 #include <ac/string.h>
13 #include <ac/socket.h>
16 #include "back-ldbm.h"
17 #include "proto-back-ldbm.h"
19 static ID_BLOCK *base_candidate(
20 Backend *be, Entry *e );
22 static ID_BLOCK *search_candidates(
23 Backend *be, Entry *e, Filter *filter,
24 int scope, int deref, int manageDSAit );
39 const char *filterstr,
43 struct ldbminfo *li = (struct ldbminfo *) be->be_private;
45 const char *text = NULL;
50 struct berval **v2refs = NULL;
51 Entry *matched = NULL;
52 char *realbase = NULL;
54 int manageDSAit = get_manageDSAit( op );
55 int cscope = LDAP_SCOPE_DEFAULT;
57 struct slap_limits_set *limit = NULL;
61 LDAP_LOG(( "backend", LDAP_LEVEL_ENTRY,
62 "ldbm_back_search: enter\n" ));
64 Debug(LDAP_DEBUG_TRACE, "=> ldbm_back_search\n", 0, 0, 0);
68 if ( *nbase == '\0' ) {
69 /* DIT root special case */
70 e = (Entry *) &slap_entry_root;
72 /* need normalized dn below */
73 realbase = ch_strdup( e->e_ndn );
75 candidates = search_candidates( be, e, filter,
76 scope, deref, manageDSAit );
80 } else if ( deref & LDAP_DEREF_FINDING ) {
81 /* deref dn and get entry with reader lock */
82 e = deref_dn_r( be, nbase, &err, &matched, &text );
84 if( err == LDAP_NO_SUCH_OBJECT ) err = LDAP_REFERRAL;
87 /* get entry with reader lock */
88 e = dn2entry_r( be, nbase, &matched );
89 err = e != NULL ? LDAP_SUCCESS : LDAP_REFERRAL;
94 char *matched_dn = NULL;
95 struct berval **refs = NULL;
97 if ( matched != NULL ) {
98 struct berval **erefs;
99 matched_dn = ch_strdup( matched->e_dn );
101 erefs = is_entry_referral( matched )
102 ? get_entry_referrals( be, conn, op, matched,
106 cache_return_entry_r( &li->li_cache, matched );
109 refs = referral_rewrite( erefs, matched_dn,
112 ber_bvecfree( erefs );
116 refs = referral_rewrite( default_referral,
120 send_ldap_result( conn, op, err,
121 matched_dn, text, refs, NULL );
123 ber_bvecfree( refs );
128 if (!manageDSAit && is_entry_referral( e ) ) {
129 /* entry is a referral, don't allow add */
130 char *matched_dn = ch_strdup( e->e_dn );
131 struct berval **erefs = get_entry_referrals( be,
132 conn, op, e, base, scope );
133 struct berval **refs = NULL;
135 cache_return_entry_r( &li->li_cache, e );
138 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
139 "ldbm_search: entry (%s) is a referral.\n",
142 Debug( LDAP_DEBUG_TRACE,
143 "ldbm_search: entry is referral\n",
148 refs = referral_rewrite( erefs, matched_dn,
151 ber_bvecfree( erefs );
155 send_ldap_result( conn, op, LDAP_REFERRAL,
156 matched_dn, NULL, refs, NULL );
157 ber_bvecfree( refs );
160 send_ldap_result( conn, op, LDAP_OTHER, matched_dn,
161 "bad referral object", NULL, NULL );
168 if ( is_entry_alias( e ) ) {
170 deref = LDAP_DEREF_NEVER;
173 if ( scope == LDAP_SCOPE_BASE ) {
174 cscope = LDAP_SCOPE_BASE;
175 candidates = base_candidate( be, e );
178 cscope = ( scope != LDAP_SCOPE_SUBTREE )
179 ? LDAP_SCOPE_BASE : LDAP_SCOPE_SUBTREE;
180 candidates = search_candidates( be, e, filter,
181 scope, deref, manageDSAit );
184 /* need normalized dn below */
185 realbase = ch_strdup( e->e_ndn );
187 cache_return_entry_r( &li->li_cache, e );
190 if ( candidates == NULL ) {
193 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
194 "ldbm_search: no candidates\n" ));
196 Debug( LDAP_DEBUG_TRACE, "ldbm_search: no candidates\n",
200 send_search_result( conn, op,
202 NULL, NULL, NULL, NULL, 0 );
208 /* if not root, get appropriate limits */
209 if ( be_isroot( be, op->o_ndn ) ) {
212 ( void ) get_limits( be, op->o_ndn, &limit );
215 /* if candidates exceed to-be-checked entries, abort */
216 if ( !isroot && limit->lms_s_unchecked != -1 ) {
217 if ( ID_BLOCK_NIDS( candidates ) > limit->lms_s_unchecked ) {
218 send_search_result( conn, op, LDAP_UNWILLING_TO_PERFORM,
219 NULL, NULL, NULL, NULL, 0 );
225 /* if root an no specific limit is required, allow unlimited search */
236 /* if no limit is required, use soft limit */
238 tlimit = limit->lms_t_soft;
240 /* if requested limit higher than hard limit, abort */
241 } else if ( tlimit > limit->lms_t_hard ) {
242 /* no hard limit means use soft instead */
243 if ( limit->lms_t_hard == 0 ) {
244 tlimit = limit->lms_t_soft;
246 /* positive hard limit means abort */
247 } else if ( limit->lms_t_hard > 0 ) {
248 send_search_result( conn, op,
249 LDAP_UNWILLING_TO_PERFORM,
250 NULL, NULL, NULL, NULL, 0 );
255 /* negative hard limit means no limit */
258 /* if no limit is required, use soft limit */
260 slimit = limit->lms_s_soft;
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;
268 /* positive hard limit means abort */
269 } else if ( limit->lms_s_hard > 0 ) {
270 send_search_result( conn, op,
271 LDAP_UNWILLING_TO_PERFORM,
272 NULL, NULL, NULL, NULL, 0 );
277 /* negative hard limit means no limit */
281 /* compute it anyway; root does not use it */
282 stoptime = op->o_time + tlimit;
284 for ( id = idl_firstid( candidates, &cursor ); id != NOID;
285 id = idl_nextid( candidates, &cursor ) )
289 /* check for abandon */
290 ldap_pvt_thread_mutex_lock( &op->o_abandonmutex );
292 if ( op->o_abandon ) {
293 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
298 ldap_pvt_thread_mutex_unlock( &op->o_abandonmutex );
300 /* check time limit */
301 if ( tlimit != -1 && slap_get_time() > stoptime ) {
302 send_search_result( conn, op, LDAP_TIMELIMIT_EXCEEDED,
303 NULL, NULL, v2refs, NULL, nentries );
308 /* get the entry with reader lock */
309 e = id2entry_r( be, id );
313 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
314 "ldbm_search: candidate %ld not found.\n", id ));
316 Debug( LDAP_DEBUG_TRACE,
317 "ldbm_search: candidate %ld not found\n",
324 if ( deref & LDAP_DEREF_SEARCHING && is_entry_alias( e ) ) {
329 e = deref_entry_r( be, e, &err, &matched, &text );
336 if( e->e_id == id ) {
341 /* need to skip alias which deref into scope */
342 if( scope & LDAP_SCOPE_ONELEVEL ) {
343 char *pdn = dn_parent( NULL, e->e_ndn );
345 if( strcmp( pdn, realbase ) ) {
352 } else if ( dn_issuffix( e->e_ndn, realbase ) ) {
353 /* alias is within scope */
355 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL1,
356 "ldbm_search: alias \"%s\" in subtree\n", e->e_dn ));
358 Debug( LDAP_DEBUG_TRACE,
359 "ldbm_search: alias \"%s\" in subtree\n",
370 * if it's a referral, add it to the list of referrals. only do
371 * this for non-base searches, and don't check the filter
372 * explicitly here since it's only a candidate anyway.
374 if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
375 is_entry_referral( e ) )
380 if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
381 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
382 (void) dn_normalize( dn );
383 scopeok = (dn == realbase)
385 : (strcmp( dn, realbase ) ? 0 : 1 );
389 scopeok = (realbase == NULL || *realbase == '\0');
392 } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
393 dn = ch_strdup( e->e_ndn );
394 scopeok = dn_issuffix( dn, realbase );
402 struct berval **erefs = get_entry_referrals(
403 be, conn, op, e, NULL, cscope );
404 struct berval **refs = referral_rewrite( erefs, e->e_dn,
407 send_search_reference( be, conn, op,
408 e, refs, NULL, &v2refs );
410 ber_bvecfree( refs );
414 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
415 "ldbm_search: candidate referral %ld scope not okay\n",
418 Debug( LDAP_DEBUG_TRACE,
419 "ldbm_search: candidate referral %ld scope not okay\n",
427 /* if it matches the filter and scope, send it */
428 if ( test_filter( be, conn, op, e, filter ) == LDAP_COMPARE_TRUE ) {
432 if ( !scopeok && scope == LDAP_SCOPE_ONELEVEL ) {
433 if ( (dn = dn_parent( be, e->e_ndn )) != NULL ) {
434 (void) dn_normalize( dn );
435 scopeok = (dn == realbase)
437 : (strcmp( dn, realbase ) ? 0 : 1 );
441 scopeok = (realbase == NULL || *realbase == '\0');
444 } else if ( !scopeok && scope == LDAP_SCOPE_SUBTREE ) {
445 dn = ch_strdup( e->e_ndn );
446 scopeok = dn_issuffix( dn, realbase );
454 /* check size limit */
455 if ( --slimit == -1 ) {
456 cache_return_entry_r( &li->li_cache, e );
457 send_search_result( conn, op,
458 LDAP_SIZELIMIT_EXCEEDED, NULL, NULL,
459 v2refs, NULL, nentries );
465 int result = send_search_entry(be, conn, op,
466 e, attrs, attrsonly, NULL);
469 case 0: /* entry sent ok */
472 case 1: /* entry not sent */
474 case -1: /* connection closed */
475 cache_return_entry_r( &li->li_cache, e );
482 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
483 "ldbm_search: candidate entry %ld scope not okay\n", id ));
485 Debug( LDAP_DEBUG_TRACE,
486 "ldbm_search: candidate entry %ld scope not okay\n",
493 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL2,
494 "ldbm_search: candidate entry %ld does not match filter\n", id ));
496 Debug( LDAP_DEBUG_TRACE,
497 "ldbm_search: candidate entry %ld does not match filter\n",
504 /* free reader lock */
505 cache_return_entry_r( &li->li_cache, e );
508 ldap_pvt_thread_yield();
511 send_search_result( conn, op,
512 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
513 NULL, NULL, v2refs, NULL, nentries );
518 if( candidates != NULL )
519 idl_free( candidates );
521 ber_bvecfree( v2refs );
522 if( realbase ) free( realbase );
535 LDAP_LOG(( "backend", LDAP_LEVEL_ENTRY,
536 "base_candidate: base (%s)\n", e->e_dn ));
538 Debug(LDAP_DEBUG_TRACE, "base_candidates: base: \"%s\"\n",
543 idl = idl_alloc( 1 );
544 idl_insert( &idl, e->e_id, 1 );
558 ID_BLOCK *candidates;
559 Filter f, fand, rf, af, xf;
560 AttributeAssertion aa_ref, aa_alias;
561 static struct berval bv_ref = { sizeof("REFERRAL")-1, "REFERRAL" };
562 static struct berval bv_alias = { sizeof("ALIAS")-1, "ALIAS" };
565 LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL1,
566 "search_candidates: base (%s) scope %d deref %d\n",
567 e->e_ndn, scope, deref ));
569 Debug(LDAP_DEBUG_TRACE,
570 "search_candidates: base=\"%s\" s=%d d=%d\n",
571 e->e_ndn, scope, deref );
576 xf.f_choice = LDAP_FILTER_OR;
580 /* match referrals */
581 rf.f_choice = LDAP_FILTER_EQUALITY;
583 rf.f_av_desc = slap_schema.si_ad_objectClass;
584 rf.f_av_value = &bv_ref;
589 if( deref & LDAP_DEREF_SEARCHING ) {
591 af.f_choice = LDAP_FILTER_EQUALITY;
592 af.f_ava = &aa_alias;
593 af.f_av_desc = slap_schema.si_ad_objectClass;
594 af.f_av_value = &bv_alias;
600 f.f_choice = LDAP_FILTER_AND;
602 fand.f_choice = scope == LDAP_SCOPE_SUBTREE
603 ? SLAPD_FILTER_DN_SUBTREE
604 : SLAPD_FILTER_DN_ONE;
605 fand.f_dn = e->e_ndn;
606 fand.f_next = xf.f_or == filter ? filter : &xf ;
608 candidates = filter_candidates( be, &f );
610 return( candidates );