1 /* entry.c - routines for dealing with entries */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
14 #include <ac/socket.h>
15 #include <ac/string.h>
19 static unsigned char *ebuf; /* buf returned by entry2str */
20 static unsigned char *ecur; /* pointer to end of currently used ebuf */
21 static int emaxsize;/* max size of ebuf */
23 int entry_destroy(void)
41 struct berval *vals[2];
42 AttributeDescription *ad;
47 * LDIF is used as the string format.
48 * An entry looks like this:
51 * [<attr>:[:] <value>\n]
52 * [<tab><continuedvalue>\n]*
55 * If a double colon is used after a type, it means the
56 * following value is encoded as a base 64 string. This
57 * happens if the value contains a non-printing character
61 Debug( LDAP_DEBUG_TRACE, "=> str2entry\n",
62 s ? s : "NULL", 0, 0 );
64 /* initialize reader/writer lock */
65 e = (Entry *) ch_malloc( sizeof(Entry) );
68 Debug( LDAP_DEBUG_ANY,
69 "<= str2entry NULL (entry allocation failed)\n",
74 /* initialize entry */
86 while ( (s = ldif_getline( &next )) != NULL ) {
87 if ( *s == '\n' || *s == '\0' ) {
91 if ( ldif_parse_line( s, &type, &value.bv_val, &value.bv_len ) != 0 ) {
92 Debug( LDAP_DEBUG_TRACE,
93 "<= str2entry NULL (parse_line)\n", 0, 0, 0 );
97 if ( strcasecmp( type, "dn" ) == 0 ) {
100 if ( e->e_dn != NULL ) {
101 Debug( LDAP_DEBUG_ANY,
102 "str2entry: entry %ld has multiple dns \"%s\" and \"%s\" (second ignored)\n",
104 value.bv_val != NULL ? value.bv_val : "" );
105 if( value.bv_val != NULL ) free( value.bv_val );
109 e->e_dn = value.bv_val != NULL ? value.bv_val : ch_strdup( "" );
114 rc = slap_str2ad( type, &ad, &text );
116 if( rc != LDAP_SUCCESS ) {
117 Debug( slapMode & SLAP_TOOL_MODE
118 ? LDAP_DEBUG_ANY : LDAP_DEBUG_TRACE,
119 "<= str2entry: str2ad(%s): %s\n", type, text, 0 );
121 if( slapMode & SLAP_TOOL_MODE ) {
123 free( value.bv_val );
128 rc = slap_str2undef_ad( type, &ad, &text );
130 if( rc != LDAP_SUCCESS ) {
131 Debug( LDAP_DEBUG_ANY,
132 "<= str2entry: str2undef_ad(%s): %s\n",
135 free( value.bv_val );
141 if( slapMode & SLAP_TOOL_MODE ) {
142 slap_syntax_validate_func *validate =
143 ad->ad_type->sat_syntax->ssyn_validate;
146 Debug( LDAP_DEBUG_ANY,
147 "str2entry: no validator for syntax %s\n",
148 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
150 free( value.bv_val );
156 * validate value per syntax
158 rc = validate( ad->ad_type->sat_syntax, &value );
161 Debug( LDAP_DEBUG_ANY,
162 "str2entry: invalid value for syntax %s\n",
163 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
165 free( value.bv_val );
171 rc = attr_merge( e, ad, vals );
176 Debug( LDAP_DEBUG_ANY,
177 "<= str2entry NULL (attr_merge)\n", 0, 0, 0 );
179 free( value.bv_val );
185 free( value.bv_val );
188 /* check to make sure there was a dn: line */
189 if ( e->e_dn == NULL ) {
190 Debug( LDAP_DEBUG_ANY, "str2entry: entry %ld has no dn\n",
196 /* generate normalized dn */
197 e->e_ndn = ch_strdup( e->e_dn );
198 (void) dn_normalize( e->e_ndn );
200 Debug(LDAP_DEBUG_TRACE, "<= str2entry(%s) -> 0x%lx\n",
201 e->e_dn, (unsigned long) e, 0 );
207 #define GRABSIZE BUFSIZ
209 #define MAKE_SPACE( n ) { \
210 while ( ecur + (n) > ebuf + emaxsize ) { \
212 offset = (int) (ecur - ebuf); \
213 ebuf = (unsigned char *) ch_realloc( (char *) ebuf, \
214 emaxsize + GRABSIZE ); \
215 emaxsize += GRABSIZE; \
216 ecur = ebuf + offset; \
230 * In string format, an entry looks like this:
232 * [<attr>: <value>\n]*
238 if ( e->e_dn != NULL ) {
240 tmplen = strlen( e->e_dn );
241 MAKE_SPACE( LDIF_SIZE_NEEDED( 2, tmplen ));
242 ldif_sput( (char **) &ecur, LDIF_PUT_VALUE, "dn", e->e_dn, tmplen );
245 /* put the attributes */
246 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
247 /* put "<type>:[:] <value>" line for each value */
248 for ( i = 0; a->a_vals[i] != NULL; i++ ) {
250 tmplen = a->a_desc->ad_cname->bv_len;
251 MAKE_SPACE( LDIF_SIZE_NEEDED( tmplen, bv->bv_len ));
252 ldif_sput( (char **) &ecur, LDIF_PUT_VALUE,
253 a->a_desc->ad_cname->bv_val,
254 bv->bv_val, bv->bv_len );
261 return( (char *) ebuf );
265 entry_free( Entry *e )
269 if ( e->e_dn != NULL ) {
273 if ( e->e_ndn != NULL ) {
277 for ( a = e->e_attrs; a != NULL; a = next ) {
287 * These routines are used only by Backend.
289 * the Entry has three entry points (ways to find things):
291 * by entry e.g., if you already have an entry from the cache
292 * and want to delete it. (really by entry ptr)
293 * by dn e.g., when looking for the base object of a search
294 * by id e.g., for search candidates
296 * these correspond to three different avl trees that are maintained.
300 entry_cmp( Entry *e1, Entry *e2 )
302 return( e1 < e2 ? -1 : (e1 > e2 ? 1 : 0) );
306 entry_dn_cmp( Entry *e1, Entry *e2 )
308 /* compare their normalized UPPERCASED dn's */
309 return( strcmp( e1->e_ndn, e2->e_ndn ) );
313 entry_id_cmp( Entry *e1, Entry *e2 )
315 return( e1->e_id < e2->e_id ? -1 : (e1->e_id > e2->e_id ? 1 : 0) );
318 #define SLAPD_SLEEPY 1
321 /* a DER encoded entry looks like:
323 * entry :== SEQUENCE {
324 * dn DistinguishedName,
325 * ndn NormalizedDistinguishedName,
326 * attrs SEQUENCE OF SEQUENCE {
327 * type AttributeType,
328 * values SET OF AttributeValue
332 * Encoding/Decoding of DER should be much faster than LDIF
335 int entry_decode( struct berval *bv, Entry **entry )
344 ber = ber_init( bv );
346 Debug( LDAP_DEBUG_ANY,
347 "<= entry_decode: ber_init failed\n",
349 return LDAP_LOCAL_ERROR;
352 /* initialize reader/writer lock */
353 e = (Entry *) ch_malloc( sizeof(Entry) );
356 Debug( LDAP_DEBUG_ANY,
357 "<= entry_decode: entry allocation failed\n",
359 return LDAP_LOCAL_ERROR;
362 /* initialize entry */
369 tag = ber_scanf( ber, "{aa" /*"}"*/, &e->e_dn, &e->e_ndn );
370 if( tag == LBER_ERROR ) {
372 return LDAP_PROTOCOL_ERROR;
375 Debug( LDAP_DEBUG_TRACE,
376 "entry_decode: \"%s\"\n",
380 for ( tag = ber_first_element( ber, &len, &last );
382 tag = ber_next_element( ber, &len, last ) )
385 struct berval **vals;
386 AttributeDescription *ad;
389 tag = ber_scanf( ber, "{O{V}}", &type, &vals );
391 if ( tag == LBER_ERROR ) {
392 Debug( LDAP_DEBUG_ANY, "entry_decode: decoding error\n", 0, 0, 0 );
394 return LDAP_PROTOCOL_ERROR;
397 if ( vals == NULL ) {
398 Debug( LDAP_DEBUG_ANY, "entry_decode: no values for type %s\n",
402 return LDAP_PROTOCOL_ERROR;
406 rc = slap_bv2ad( type, &ad, &text );
408 if( rc != LDAP_SUCCESS ) {
409 Debug( LDAP_DEBUG_TRACE,
410 "<= entry_decode: str2ad(%s): %s\n", type, text, 0 );
412 rc = slap_bv2undef_ad( type, &ad, &text );
414 if( rc != LDAP_SUCCESS ) {
415 Debug( LDAP_DEBUG_ANY,
416 "<= entry_decode: str2undef_ad(%s): %s\n",
419 ber_bvecfree( vals );
425 rc = attr_merge( e, ad, vals );
429 Debug( LDAP_DEBUG_ANY,
430 "<= entry_decode: attr_merge failed\n", 0, 0, 0 );
432 ber_bvecfree( vals );
434 return LDAP_LOCAL_ERROR;
438 ber_bvecfree( vals );
441 rc = ber_scanf( ber, /*"{"*/ "}" );
444 return LDAP_PROTOCOL_ERROR;
447 Debug(LDAP_DEBUG_TRACE, "<= entry_decode(%s)\n",
462 Debug( LDAP_DEBUG_TRACE, "=> entry_encode(0x%08lx): %s\n",
463 e->e_id, e->e_dn, 0 );
465 ber = ber_alloc_t( LBER_USE_DER );
470 rc = ber_printf( ber, "{ss{" /*"}}"*/, e->e_dn, e->e_ndn );
475 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
476 rc = ber_printf( ber, "{O{V}}",
484 rc = ber_printf( ber, /*"{{"*/ "}}" );
489 rc = ber_flatten( ber, bv );
494 Debug( LDAP_DEBUG_ANY, "=> entry_encode(0x%08lx): failed (%d)\n",