search.c 11.1 KB
Newer Older
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1
2
/* search.c - ldbm backend search function */

Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
4
#include "portable.h"

Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
#include <stdio.h>
6
7
8
9

#include <ac/string.h>
#include <ac/socket.h>

Kurt Zeilenga's avatar
Kurt Zeilenga committed
10
11
#include "slap.h"
#include "back-ldbm.h"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
12
#include "proto-back-ldbm.h"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

extern time_t		currenttime;
extern pthread_mutex_t	currenttime_mutex;

extern IDList		*idl_alloc();
extern Attribute	*attr_find();
extern IDList		*filter_candidates();
extern char		*ch_realloc();
extern char		*dn_parent();

static IDList	*base_candidates();
static IDList	*onelevel_candidates();
static IDList	*subtree_candidates();

#define GRABSIZE	BUFSIZ

#define MAKE_SPACE( n ) { \
	if ( rcur + n > rbuf + rmaxsize ) { \
		int	offset = rcur - rbuf; \
		rbuf =  ch_realloc( rbuf, rmaxsize + GRABSIZE ); \
		rmaxsize += GRABSIZE; \
		rcur = rbuf + offset; \
	} \
}

int
ldbm_back_search(
    Backend	*be,
    Connection	*conn,
    Operation	*op,
    char	*base,
    int		scope,
    int		deref,
    int		slimit,
    int		tlimit,
    Filter	*filter,
    char	*filterstr,
    char	**attrs,
    int		attrsonly
)
{
	struct ldbminfo	*li = (struct ldbminfo *) be->be_private;
	int		err;
	time_t		stoptime;
	IDList		*candidates;
	ID		id;
	Entry		*e;
	Attribute	*ref;
	char		*matched = NULL;
	int		rmaxsize, nrefs;
	char		*rbuf, *rcur, *r;
	int		nentries = 0;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
65
	char		*realBase;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
66

Kurt Zeilenga's avatar
Kurt Zeilenga committed
67
68
	Debug(LDAP_DEBUG_ARGS, "=> ldbm_back_search\n", 0, 0, 0);

Kurt Zeilenga's avatar
Kurt Zeilenga committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
	if ( tlimit == 0 && be_isroot( be, op->o_dn ) ) {
		tlimit = -1;	/* allow root to set no limit */
	} else {
		tlimit = (tlimit > be->be_timelimit || tlimit < 1) ?
		    be->be_timelimit : tlimit;
		stoptime = op->o_time + tlimit;
	}
	if ( slimit == 0 && be_isroot( be, op->o_dn ) ) {
		slimit = -1;	/* allow root to set no limit */
	} else {
		slimit = (slimit > be->be_sizelimit || slimit < 1) ?
		    be->be_sizelimit : slimit;
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
	/*
	 * check and apply aliasing where the dereferencing applies to
	 * the subordinates of the base
	 */
	realBase = strdup (base);
	switch ( deref ) {
	case LDAP_DEREF_FINDING:
	case LDAP_DEREF_ALWAYS:
		free (realBase);
		realBase = derefDN ( be, conn, op, base );
		break;
	}

	(void) dn_normalize (realBase);

	Debug( LDAP_DEBUG_TRACE, "using base %s\n",
		realBase, 0, 0 );

Kurt Zeilenga's avatar
Kurt Zeilenga committed
101
102
	switch ( scope ) {
	case LDAP_SCOPE_BASE:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
103
		candidates = base_candidates( be, conn, op, realBase, filter,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
104
105
106
107
		    attrs, attrsonly, &matched, &err );
		break;

	case LDAP_SCOPE_ONELEVEL:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
108
		candidates = onelevel_candidates( be, conn, op, realBase, filter,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
109
110
111
112
		    attrs, attrsonly, &matched, &err );
		break;

	case LDAP_SCOPE_SUBTREE:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
113
		candidates = subtree_candidates( be, conn, op, realBase, filter,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
		    attrs, attrsonly, &matched, NULL, &err, 1 );
		break;

	default:
		send_ldap_result( conn, op, LDAP_PROTOCOL_ERROR, "",
		    "Bad scope" );
		return( -1 );
	}

	/* null candidates means we could not find the base object */
	if ( candidates == NULL ) {
		send_ldap_result( conn, op, err, matched, "" );
		if ( matched != NULL ) {
			free( matched );
		}
		return( -1 );
	}

	rmaxsize = 0;
	nrefs = 0;
	rbuf = rcur = NULL;
	MAKE_SPACE( sizeof("Referral:") + 1 );
	strcpy( rbuf, "Referral:" );
	rcur = strchr( rbuf, '\0' );
	for ( id = idl_firstid( candidates ); id != NOID;
	    id = idl_nextid( candidates, id ) ) {
		/* check for abandon */
		pthread_mutex_lock( &op->o_abandonmutex );
		if ( op->o_abandon ) {
			pthread_mutex_unlock( &op->o_abandonmutex );
			idl_free( candidates );
			free( rbuf );
			return( 0 );
		}
		pthread_mutex_unlock( &op->o_abandonmutex );

		/* check time limit */
		pthread_mutex_lock( &currenttime_mutex );
		time( &currenttime );
		if ( tlimit != -1 && currenttime > stoptime ) {
			pthread_mutex_unlock( &currenttime_mutex );
			send_ldap_search_result( conn, op,
			    LDAP_TIMELIMIT_EXCEEDED, NULL, nrefs > 0 ? rbuf :
			    NULL, nentries );
			idl_free( candidates );
			free( rbuf );
			return( 0 );
		}
		pthread_mutex_unlock( &currenttime_mutex );

Kurt Zeilenga's avatar
Kurt Zeilenga committed
164
165
166
		/* get the entry with reader lock */
		if ( (e = id2entry_r( be, id )) == NULL ) {
			Debug( LDAP_DEBUG_ARGS, "candidate %d not found\n", id, 0, 0 );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
167
168
169
170
171
172
173
174
175
			continue;
		}

		/*
		 * if it's a referral, add it to the list of referrals. only do
		 * this for subtree searches, and don't check the filter explicitly
		 * here since it's only a candidate anyway.
		 */
		if ( e->e_dn != NULL && strncasecmp( e->e_dn, "ref=", 4 )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
176
177
			== 0 && (ref = attr_find( e->e_attrs, "ref" )) != NULL &&
			scope == LDAP_SCOPE_SUBTREE )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
178
179
180
181
		{
			int	i, len;

			if ( ref->a_vals == NULL ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
182
183
				Debug( LDAP_DEBUG_ANY, "null ref in (%s)\n", 
					e->e_dn, 0, 0 );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
184
185
186
187
188
189
			} else {
				for ( i = 0; ref->a_vals[i] != NULL; i++ ) {
					/* referral + newline + null */
					MAKE_SPACE( ref->a_vals[i]->bv_len + 2 );
					*rcur++ = '\n';
					strncpy( rcur, ref->a_vals[i]->bv_val,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
190
						ref->a_vals[i]->bv_len );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
					rcur = rcur + ref->a_vals[i]->bv_len;
					*rcur = '\0';
					nrefs++;
				}
			}

		/* otherwise it's an entry - see if it matches the filter */
		} else {
			/* if it matches the filter and scope, send it */
			if ( test_filter( be, conn, op, e, filter ) == 0 ) {
				int		scopeok;
				char	*dn;

				/* check scope */
				scopeok = 1;
				if ( scope == LDAP_SCOPE_ONELEVEL ) {
					if ( (dn = dn_parent( be, e->e_dn )) != NULL ) {
						(void) dn_normalize( dn );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
209
						scopeok = (dn == realBase) ? 1 : (! strcasecmp( dn, realBase ));
Kurt Zeilenga's avatar
Kurt Zeilenga committed
210
					} else {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
211
						scopeok = (realBase == NULL || *realBase == '\0');
Kurt Zeilenga's avatar
Kurt Zeilenga committed
212
213
214
215
216
					}
					free( dn );
				} else if ( scope == LDAP_SCOPE_SUBTREE ) {
					dn = strdup( e->e_dn );
					(void) dn_normalize( dn );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
217
					scopeok = dn_issuffix( dn, realBase );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
218
219
220
221
222
223
					free( dn );
				}

				if ( scopeok ) {
					/* check size limit */
					if ( --slimit == -1 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
224
						cache_return_entry_r( &li->li_cache, e );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
225
226
227
228
229
230
231
232
						send_ldap_search_result( conn, op,
							LDAP_SIZELIMIT_EXCEEDED, NULL,
							nrefs > 0 ? rbuf : NULL, nentries );
						idl_free( candidates );
						free( rbuf );
						return( 0 );
					}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
					/*
					 * check and apply aliasing where the dereferencing applies to
					 * the subordinates of the base
					 */
					switch ( deref ) {
					case LDAP_DEREF_SEARCHING:
					case LDAP_DEREF_ALWAYS:
						{
							Entry *newe = derefAlias_r( be, conn, op, e );
							cache_return_entry_r( &li->li_cache, e );
							e = newe;
						}
						break;
					}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
248
249
250
251
252
253
254
255
					switch ( send_search_entry( be, conn, op, e,
						attrs, attrsonly ) ) {
					case 0:		/* entry sent ok */
						nentries++;
						break;
					case 1:		/* entry not sent */
						break;
					case -1:	/* connection closed */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
256
						cache_return_entry_r( &li->li_cache, e );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
257
258
259
260
261
262
263
264
						idl_free( candidates );
						free( rbuf );
						return( 0 );
					}
				}
			}
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
265
266
267
268
		if( e == NULL ) {
			/* free reader lock */
			cache_return_entry_r( &li->li_cache, e );
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

		pthread_yield();
	}
	idl_free( candidates );
	if ( nrefs > 0 ) {
		send_ldap_search_result( conn, op, LDAP_PARTIAL_RESULTS, NULL,
		    rbuf, nentries );
	} else {
		send_ldap_search_result( conn, op, LDAP_SUCCESS, NULL, NULL,
		    nentries );
	}
	free( rbuf );

	return( 0 );
}

static IDList *
base_candidates(
    Backend	*be,
    Connection	*conn,
    Operation	*op,
    char	*base,
    Filter	*filter,
    char	**attrs,
    int		attrsonly,
    char	**matched,
    int		*err
)
{
	struct ldbminfo	*li = (struct ldbminfo *) be->be_private;
	int		rc;
	ID		id;
	IDList		*idl;
	Entry		*e;

Kurt Zeilenga's avatar
Kurt Zeilenga committed
304
305
	Debug(LDAP_DEBUG_TRACE, "base_candidates: base: %s\n", base, 0, 0);

Kurt Zeilenga's avatar
Kurt Zeilenga committed
306
	*err = LDAP_SUCCESS;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
307
308
309

	/* get entry with reader lock */
	if ( (e = dn2entry_r( be, base, matched )) == NULL ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
310
311
312
313
		*err = LDAP_NO_SUCH_OBJECT;
		return( NULL );
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
314
315
	/* check for deleted */

Kurt Zeilenga's avatar
Kurt Zeilenga committed
316
317
318
	idl = idl_alloc( 1 );
	idl_insert( &idl, e->e_id, 1 );

Kurt Zeilenga's avatar
Kurt Zeilenga committed
319
320
321

	/* free reader lock */
	cache_return_entry_r( &li->li_cache, e );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

	return( idl );
}

static IDList *
onelevel_candidates(
    Backend	*be,
    Connection	*conn,
    Operation	*op,
    char	*base,
    Filter	*filter,
    char	**attrs,
    int		attrsonly,
    char	**matched,
    int		*err
)
{
	struct ldbminfo	*li = (struct ldbminfo *) be->be_private;
	Entry		*e;
	Filter		*f;
	char		buf[20];
	IDList		*candidates;

Kurt Zeilenga's avatar
Kurt Zeilenga committed
345
346
	Debug(LDAP_DEBUG_TRACE, "onelevel_candidates: base: %s\n", base, 0, 0);

Kurt Zeilenga's avatar
Kurt Zeilenga committed
347
348
	*err = LDAP_SUCCESS;
	e = NULL;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
349
350
351
352
	/* get the base object with reader lock */
	if ( base != NULL && *base != '\0' &&
		(e = dn2entry_r( be, base, matched )) == NULL )
	{
Kurt Zeilenga's avatar
Kurt Zeilenga committed
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
		*err = LDAP_NO_SUCH_OBJECT;
		return( NULL );
	}

	/*
	 * modify the filter to be something like this:
	 *
	 *	parent=baseobject & originalfilter
	 */

	f = (Filter *) ch_malloc( sizeof(Filter) );
	f->f_next = NULL;
	f->f_choice = LDAP_FILTER_AND;
	f->f_and = (Filter *) ch_malloc( sizeof(Filter) );
	f->f_and->f_choice = LDAP_FILTER_EQUALITY;
	f->f_and->f_ava.ava_type = strdup( "id2children" );
	sprintf( buf, "%d", e != NULL ? e->e_id : 0 );
	f->f_and->f_ava.ava_value.bv_val = strdup( buf );
	f->f_and->f_ava.ava_value.bv_len = strlen( buf );
	f->f_and->f_next = filter;

	/* from here, it's just like subtree_candidates */
	candidates = subtree_candidates( be, conn, op, base, f, attrs,
	    attrsonly, matched, e, err, 0 );

	/* free up just the filter stuff we allocated above */
	f->f_and->f_next = NULL;
	filter_free( f );

Kurt Zeilenga's avatar
Kurt Zeilenga committed
382
383
	/* free entry and reader lock */
	cache_return_entry_r( &li->li_cache, e );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
	return( candidates );
}

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
)
{
	struct ldbminfo	*li = (struct ldbminfo *) be->be_private;
	Filter		*f;
	IDList		*candidates;

Kurt Zeilenga's avatar
Kurt Zeilenga committed
406
407
408
	Debug(LDAP_DEBUG_TRACE, "subtree_candidates: base: %s\n",
		base ? base : "NULL", 0, 0);

Kurt Zeilenga's avatar
Kurt Zeilenga committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
	/*
	 * get the base object - unless we already have it (from one-level).
	 * also, unless this is a one-level search or a subtree search
	 * starting at the very top of our subtree, we need to modify the
	 * filter to be something like this:
	 *
	 *	dn=*baseobjectdn & (originalfilter | ref=*)
	 *
	 * the "objectclass=referral" part is used to select referrals to return
	 */

	*err = LDAP_SUCCESS;
	f = NULL;
	if ( lookupbase ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
423
424
425
		if ( base != NULL && *base != '\0' &&
			(e = dn2entry_r( be, base, matched )) == NULL )
		{
Kurt Zeilenga's avatar
Kurt Zeilenga committed
426
427
428
429
			*err = LDAP_NO_SUCH_OBJECT;
			return( NULL );
	 	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
430
431
432
433
		if (e) {
			cache_return_entry_r( &li->li_cache, e );
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
434
435
436
437
438
439
		f = (Filter *) ch_malloc( sizeof(Filter) );
		f->f_next = NULL;
		f->f_choice = LDAP_FILTER_OR;
		f->f_or = (Filter *) ch_malloc( sizeof(Filter) );
		f->f_or->f_choice = LDAP_FILTER_EQUALITY;
		f->f_or->f_avtype = strdup( "objectclass" );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
440
441
442
		/* Patch to use normalized uppercase */
		f->f_or->f_avvalue.bv_val = strdup( "REFERRAL" );
		f->f_or->f_avvalue.bv_len = strlen( "REFERRAL" );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
		f->f_or->f_next = filter;
		filter = f;

		if ( ! be_issuffix( be, base ) ) {
			f = (Filter *) ch_malloc( sizeof(Filter) );
			f->f_next = NULL;
			f->f_choice = LDAP_FILTER_AND;
			f->f_and = (Filter *) ch_malloc( sizeof(Filter) );
			f->f_and->f_choice = LDAP_FILTER_SUBSTRINGS;
			f->f_and->f_sub_type = strdup( "dn" );
			f->f_and->f_sub_initial = NULL;
			f->f_and->f_sub_any = NULL;
			f->f_and->f_sub_final = strdup( base );
			value_normalize( f->f_and->f_sub_final, SYNTAX_CIS );
			f->f_and->f_next = filter;
			filter = f;
		}
	}

	candidates = filter_candidates( be, filter );

	/* free up just the parts we allocated above */
	if ( f != NULL ) {
		f->f_and->f_next = NULL;
		filter_free( f );
	}

	return( candidates );
}