mr.c 11.3 KB
Newer Older
1
2
/* mr.c - routines to manage matching rule definitions */
/* $OpenLDAP$ */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
4
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 *
Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
 * Copyright 1998-2007 The OpenLDAP Foundation.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
6
7
8
9
10
11
12
13
14
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.
 *
 * A copy of this license is available in the file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
15
16
17
18
19
20
21
22
23
24
25
26
27
 */

#include "portable.h"

#include <stdio.h>

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

#include "slap.h"

struct mindexrec {
Howard Chu's avatar
Howard Chu committed
28
	struct berval	mir_name;
29
30
31
32
	MatchingRule	*mir_mr;
};

static Avlnode	*mr_index = NULL;
33
34
35
36
static LDAP_SLIST_HEAD(MRList, slap_matching_rule) mr_list
	= LDAP_SLIST_HEAD_INITIALIZER(&mr_list);
static LDAP_SLIST_HEAD(MRUList, slap_matching_rule_use) mru_list
	= LDAP_SLIST_HEAD_INITIALIZER(&mru_list);
37
38
39

static int
mr_index_cmp(
40
41
    const void	*v_mir1,
    const void	*v_mir2
42
43
)
{
44
45
	const struct mindexrec	*mir1 = v_mir1;
	const struct mindexrec	*mir2 = v_mir2;
Howard Chu's avatar
Howard Chu committed
46
47
	int i = mir1->mir_name.bv_len - mir2->mir_name.bv_len;
	if (i) return i;
48
	return (strcasecmp( mir1->mir_name.bv_val, mir2->mir_name.bv_val ));
49
50
51
52
}

static int
mr_index_name_cmp(
53
54
    const void	*v_name,
    const void	*v_mir
55
56
)
{
57
58
	const struct berval    *name = v_name;
	const struct mindexrec *mir  = v_mir;
Howard Chu's avatar
Howard Chu committed
59
60
	int i = name->bv_len - mir->mir_name.bv_len;
	if (i) return i;
61
	return (strncasecmp( name->bv_val, mir->mir_name.bv_val, name->bv_len ));
62
63
64
65
}

MatchingRule *
mr_find( const char *mrname )
Howard Chu's avatar
Howard Chu committed
66
67
68
{
	struct berval bv;

Howard Chu's avatar
Howard Chu committed
69
	bv.bv_val = (char *)mrname;
Howard Chu's avatar
Howard Chu committed
70
71
72
73
74
75
	bv.bv_len = strlen( mrname );
	return mr_bvfind( &bv );
}

MatchingRule *
mr_bvfind( struct berval *mrname )
76
77
78
{
	struct mindexrec	*mir = NULL;

79
	if ( (mir = avl_find( mr_index, mrname, mr_index_name_cmp )) != NULL ) {
80
81
82
83
84
		return( mir->mir_mr );
	}
	return( NULL );
}

85
86
87
void
mr_destroy( void )
{
88
	MatchingRule *m;
89
90

	avl_free(mr_index, ldap_memfree);
91
92
93
	while( !LDAP_SLIST_EMPTY(&mr_list) ) {
		m = LDAP_SLIST_FIRST(&mr_list);
		LDAP_SLIST_REMOVE_HEAD(&mr_list, smr_next);
94
		ch_free( m->smr_str.bv_val );
95
		ch_free( m->smr_compat_syntaxes );
96
97
98
99
		ldap_matchingrule_free((LDAPMatchingRule *)m);
	}
}

100
101
102
103
104
105
106
107
108
static int
mr_insert(
    MatchingRule	*smr,
    const char		**err
)
{
	struct mindexrec	*mir;
	char			**names;

Kurt Zeilenga's avatar
Kurt Zeilenga committed
109
	LDAP_SLIST_NEXT( smr, smr_next ) = NULL;
110
	LDAP_SLIST_INSERT_HEAD(&mr_list, smr, smr_next);
111
112
113
114

	if ( smr->smr_oid ) {
		mir = (struct mindexrec *)
			ch_calloc( 1, sizeof(struct mindexrec) );
Howard Chu's avatar
Howard Chu committed
115
116
		mir->mir_name.bv_val = smr->smr_oid;
		mir->mir_name.bv_len = strlen( smr->smr_oid );
117
118
		mir->mir_mr = smr;
		if ( avl_insert( &mr_index, (caddr_t) mir,
119
		                 mr_index_cmp, avl_dup_error ) ) {
120
121
			*err = smr->smr_oid;
			ldap_memfree(mir);
122
			return SLAP_SCHERR_MR_DUP;
123
124
		}
		/* FIX: temporal consistency check */
Howard Chu's avatar
Howard Chu committed
125
		mr_bvfind(&mir->mir_name);
126
127
128
129
130
	}
	if ( (names = smr->smr_names) ) {
		while ( *names ) {
			mir = (struct mindexrec *)
				ch_calloc( 1, sizeof(struct mindexrec) );
Howard Chu's avatar
Howard Chu committed
131
132
			mir->mir_name.bv_val = *names;
			mir->mir_name.bv_len = strlen( *names );
133
134
			mir->mir_mr = smr;
			if ( avl_insert( &mr_index, (caddr_t) mir,
135
			                 mr_index_cmp, avl_dup_error ) ) {
136
137
				*err = *names;
				ldap_memfree(mir);
138
				return SLAP_SCHERR_MR_DUP;
139
140
			}
			/* FIX: temporal consistency check */
Howard Chu's avatar
Howard Chu committed
141
			mr_bvfind(&mir->mir_name);
142
143
144
145
146
147
148
149
			names++;
		}
	}
	return 0;
}

int
mr_add(
150
    LDAPMatchingRule		*mr,
151
    slap_mrule_defs_rec	*def,
152
	MatchingRule	*amr,
153
154
155
156
157
    const char		**err
)
{
	MatchingRule	*smr;
	Syntax		*syn;
158
	Syntax		**compat_syn = NULL;
159
160
	int		code;

161
162
163
164
165
166
167
168
169
170
171
	if( def->mrd_compat_syntaxes ) {
		int i;
		for( i=0; def->mrd_compat_syntaxes[i]; i++ ) {
			/* just count em */
		}

		compat_syn = ch_malloc( sizeof(Syntax *) * (i+1) );

		for( i=0; def->mrd_compat_syntaxes[i]; i++ ) {
			compat_syn[i] = syn_find( def->mrd_compat_syntaxes[i] );
			if( compat_syn[i] == NULL ) {
Howard Chu's avatar
Howard Chu committed
172
				ch_free( compat_syn );
173
174
175
176
177
178
179
				return SLAP_SCHERR_SYN_NOT_FOUND;
			}
		}

		compat_syn[i] = NULL;
	}

180
	smr = (MatchingRule *) ch_calloc( 1, sizeof(MatchingRule) );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
181
	AC_MEMCPY( &smr->smr_mrule, mr, sizeof(LDAPMatchingRule));
182

183
184
185
186
187
	/*
	 * note: smr_bvoid uses the same memory of smr_mrule.mr_oid;
	 * smr_oidlen is #defined as smr_bvoid.bv_len
	 */
	smr->smr_bvoid.bv_val = smr->smr_mrule.mr_oid;
188
	smr->smr_oidlen = strlen( mr->mr_oid );
189
	smr->smr_usage = def->mrd_usage;
190
	smr->smr_compat_syntaxes = compat_syn;
191
192
193
194
	smr->smr_normalize = def->mrd_normalize;
	smr->smr_match = def->mrd_match;
	smr->smr_indexer = def->mrd_indexer;
	smr->smr_filter = def->mrd_filter;
195
	smr->smr_associated = amr;
196
197
198
199
200
201

	if ( smr->smr_syntax_oid ) {
		if ( (syn = syn_find(smr->smr_syntax_oid)) ) {
			smr->smr_syntax = syn;
		} else {
			*err = smr->smr_syntax_oid;
Howard Chu's avatar
Howard Chu committed
202
			ch_free( smr );
203
204
205
206
			return SLAP_SCHERR_SYN_NOT_FOUND;
		}
	} else {
		*err = "";
Howard Chu's avatar
Howard Chu committed
207
		ch_free( smr );
208
209
210
211
212
213
214
215
		return SLAP_SCHERR_MR_INCOMPLETE;
	}
	code = mr_insert(smr,err);
	return code;
}

int
register_matching_rule(
216
	slap_mrule_defs_rec *def )
217
{
218
	LDAPMatchingRule *mr;
219
	MatchingRule *amr = NULL;
220
221
222
	int		code;
	const char	*err;

223
	if( def->mrd_usage == SLAP_MR_NONE && def->mrd_compat_syntaxes == NULL ) {
224
		Debug( LDAP_DEBUG_ANY, "register_matching_rule: not usable %s\n",
225
		    def->mrd_desc, 0, 0 );
226

227
228
229
		return -1;
	}

230
231
	if( def->mrd_associated != NULL ) {
		amr = mr_find( def->mrd_associated );
232
		if( amr == NULL ) {
233
234
			Debug( LDAP_DEBUG_ANY, "register_matching_rule: "
				"could not locate associated matching rule %s for %s\n",
235
				def->mrd_associated, def->mrd_desc, 0 );
236

237
238
			return -1;
		}
239
240
241
242
243
244
245

		if (( def->mrd_usage & SLAP_MR_EQUALITY ) &&
			(( def->mrd_usage & SLAP_MR_SUBTYPE_MASK ) == SLAP_MR_NONE ))
		{
			if (( def->mrd_usage & SLAP_MR_EQUALITY ) &&
				(( def->mrd_usage & SLAP_MR_SUBTYPE_MASK ) != SLAP_MR_NONE ))
			{
246
247
				Debug( LDAP_DEBUG_ANY, "register_matching_rule: "
						"inappropriate (approx) association %s for %s\n",
248
249
250
251
252
					def->mrd_associated, def->mrd_desc, 0 );
				return -1;
			}

		} else if (!( amr->smr_usage & SLAP_MR_EQUALITY )) {
253
254
				Debug( LDAP_DEBUG_ANY, "register_matching_rule: "
					"inappropriate (equalilty) association %s for %s\n",
255
256
257
					def->mrd_associated, def->mrd_desc, 0 );
				return -1;
		}
258
259
	}

260
261
	mr = ldap_str2matchingrule( def->mrd_desc, &code, &err,
		LDAP_SCHEMA_ALLOW_ALL );
262
	if ( !mr ) {
263
264
		Debug( LDAP_DEBUG_ANY,
			"Error in register_matching_rule: %s before %s in %s\n",
265
		    ldap_scherr2str(code), err, def->mrd_desc );
266

267
		return -1;
268
269
	}

270

271
	code = mr_add( mr, def, amr, &err );
272

273
274
	ldap_memfree( mr );

275
	if ( code ) {
276
277
		Debug( LDAP_DEBUG_ANY,
			"Error in register_matching_rule: %s for %s in %s\n",
278
		    scherr2str(code), err, def->mrd_desc );
279

280
		return -1;
281
	}
282

283
	return 0;
284
285
}

286
287
288
void
mru_destroy( void )
{
289
290
291
292
293
	MatchingRuleUse *m;

	while( !LDAP_SLIST_EMPTY(&mru_list) ) {
		m = LDAP_SLIST_FIRST(&mru_list);
		LDAP_SLIST_REMOVE_HEAD(&mru_list, smru_next);
294
295
296

		if ( m->smru_str.bv_val ) {
			ch_free( m->smru_str.bv_val );
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
297
			m->smru_str.bv_val = NULL;
298
299
300
301
302
303
		}
		/* memory borrowed from m->smru_mr */
		m->smru_oid = NULL;
		m->smru_names = NULL;
		m->smru_desc = NULL;

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
304
		/* free what's left (basically smru_mruleuse.mru_applies_oids) */
305
306
307
308
309
310
311
312
		ldap_matchingruleuse_free((LDAPMatchingRuleUse *)m);
	}
}

int
matching_rule_use_init( void )
{
	MatchingRule	*mr;
313
	MatchingRuleUse	**mru_ptr = &LDAP_SLIST_FIRST(&mru_list);
314
315
316

	Debug( LDAP_DEBUG_TRACE, "matching_rule_use_init\n", 0, 0, 0 );

317
	LDAP_SLIST_FOREACH( mr, &mr_list, smr_next ) {
318
		AttributeType	*at;
319
		MatchingRuleUse	mru_storage, *mru = &mru_storage;
320

321
322
		char		**applies_oids = NULL;

323
324
325
326
327
328
329
		mr->smr_mru = NULL;

		/* hide rules marked as HIDE */
		if ( mr->smr_usage & SLAP_MR_HIDE ) {
			continue;
		}

330
331
332
333
334
335
336
337
		/* hide rules not marked as designed for extensibility */
		/* MR_EXT means can be used any attribute type whose
		 * syntax is same as the assertion syntax.
		 * Another mechanism is needed where rule can be used
		 * with attribute of other syntaxes.
		 * Framework doesn't support this (yet).
		 */

338
339
340
		if (!( ( mr->smr_usage & SLAP_MR_EXT )
			|| mr->smr_compat_syntaxes ) )
		{
341
342
343
344
345
346
347
348
349
350
351
352
			continue;
		}

		memset( mru, 0, sizeof( MatchingRuleUse ) );

		/*
		 * Note: we're using the same values of the corresponding 
		 * MatchingRule structure; maybe we'd copy them ...
		 */
		mru->smru_mr = mr;
		mru->smru_obsolete = mr->smr_obsolete;
		mru->smru_applies_oids = NULL;
353
		LDAP_SLIST_NEXT(mru, smru_next) = NULL;
354
355
356
357
358
359
360
361
		mru->smru_oid = mr->smr_oid;
		mru->smru_names = mr->smr_names;
		mru->smru_desc = mr->smr_desc;

		Debug( LDAP_DEBUG_TRACE, "    %s (%s): ", 
				mru->smru_oid, 
				mru->smru_names ? mru->smru_names[ 0 ] : "", 0 );

362
363
		at = NULL;
		for ( at_start( &at ); at; at_next( &at ) ) {
364
			if( at->sat_flags & SLAP_AT_HIDE ) continue;
365

366
367
			if( mr_usable_with_at( mr, at )) {
				ldap_charray_add( &applies_oids, at->sat_cname.bv_val );
368
369
370
371
372
373
374
375
			}
		}

		/*
		 * Note: the matchingRules that are not used
		 * by any attributeType are not listed as
		 * matchingRuleUse
		 */
376
377
		if ( applies_oids != NULL ) {
			mru->smru_applies_oids = applies_oids;
378
			{
379
				char *str = ldap_matchingruleuse2str( &mru->smru_mruleuse );
380
381
382
383
				Debug( LDAP_DEBUG_TRACE, "matchingRuleUse: %s\n", str, 0, 0 );
				ldap_memfree( str );
			}

384
385
			mru = (MatchingRuleUse *)ber_memalloc( sizeof( MatchingRuleUse ) );
			/* call-forward from MatchingRule to MatchingRuleUse */
386
			mr->smr_mru = mru;
387
			/* copy static data to newly allocated struct */
388
			*mru = mru_storage;
389
			/* append the struct pointer to the end of the list */
390
			*mru_ptr = mru;
391
			/* update the list head pointer */
392
			mru_ptr = &LDAP_SLIST_NEXT(mru,smru_next);
393
394
395
396
397
398
		}
	}

	return( 0 );
}

399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
int mr_usable_with_at(
	MatchingRule *mr,
	AttributeType *at )
{
	if( mr->smr_usage & SLAP_MR_EXT && ( 
		mr->smr_syntax == at->sat_syntax ||
		mr == at->sat_equality || mr == at->sat_approx ) )
	{
		return 1;
	}

	if ( mr->smr_compat_syntaxes ) {
		int i;
		for( i=0; mr->smr_compat_syntaxes[i]; i++ ) {
			if( at->sat_syntax == mr->smr_compat_syntaxes[i] ) {
				return 1;
			}
		}
	}
	return 0;
}
420
421
422

int mr_schema_info( Entry *e )
{
423
	AttributeDescription *ad_matchingRules = slap_schema.si_ad_matchingRules;
424
425
	MatchingRule *mr;
	struct berval nval;
426

427
	LDAP_SLIST_FOREACH(mr, &mr_list, smr_next ) {
428
429
430
431
432
		if ( mr->smr_usage & SLAP_MR_HIDE ) {
			/* skip hidden rules */
			continue;
		}

433
434
435
436
437
		if ( ! mr->smr_match ) {
			/* skip rules without matching functions */
			continue;
		}

438
439
440
441
		if ( mr->smr_str.bv_val == NULL ) {
			if ( ldap_matchingrule2bv( &mr->smr_mrule, &mr->smr_str ) == NULL ) {
				return -1;
			}
442
		}
443
#if 0
444
445
		Debug( LDAP_DEBUG_TRACE, "Merging mr [%lu] %s\n",
			mr->smr_str.bv_len, mr->smr_str.bv_val, 0 );
446
#endif
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
447

448
449
		nval.bv_val = mr->smr_oid;
		nval.bv_len = strlen(mr->smr_oid);
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
450
		if( attr_merge_one( e, ad_matchingRules, &mr->smr_str, &nval ) ) {
Julius Enarusai's avatar
   
Julius Enarusai committed
451
			return -1;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
452
		}
453
454
455
456
	}
	return 0;
}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
457
458
int mru_schema_info( Entry *e )
{
459
460
	AttributeDescription *ad_matchingRuleUse 
		= slap_schema.si_ad_matchingRuleUse;
461
462
	MatchingRuleUse	*mru;
	struct berval nval;
463

464
	LDAP_SLIST_FOREACH( mru, &mru_list, smru_next ) {
465
466
467
468
469
470
471
472
473
474
475
476
477
		assert( !( mru->smru_usage & SLAP_MR_HIDE ) );

		if ( mru->smru_str.bv_val == NULL ) {
			if ( ldap_matchingruleuse2bv( &mru->smru_mruleuse, &mru->smru_str )
					== NULL ) {
				return -1;
			}
		}

#if 0
		Debug( LDAP_DEBUG_TRACE, "Merging mru [%lu] %s\n",
			mru->smru_str.bv_len, mru->smru_str.bv_val, 0 );
#endif
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
478

479
480
		nval.bv_val = mru->smru_oid;
		nval.bv_len = strlen(mru->smru_oid);
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
481
		if( attr_merge_one( e, ad_matchingRuleUse, &mru->smru_str, &nval ) ) {
Julius Enarusai's avatar
   
Julius Enarusai committed
482
			return -1;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
483
		}
484
	}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
485
486
	return 0;
}