1 /* entry.c - routines for dealing with entries */
4 * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
14 #include <ac/socket.h>
15 #include <ac/string.h>
20 static unsigned char *ebuf; /* buf returned by entry2str */
21 static unsigned char *ecur; /* pointer to end of currently used ebuf */
22 static int emaxsize;/* max size of ebuf */
27 const Entry slap_entry_root = { NOID, { 0, "" }, { 0, "" }, NULL, 0, { 0, "" }, NULL };
29 int entry_destroy(void)
31 if ( ebuf ) free( ebuf );
45 struct berval vals[2];
46 AttributeDescription *ad;
51 * LDIF is used as the string format.
52 * An entry looks like this:
55 * [<attr>:[:] <value>\n]
56 * [<tab><continuedvalue>\n]*
59 * If a double colon is used after a type, it means the
60 * following value is encoded as a base 64 string. This
61 * happens if the value contains a non-printing character
66 LDAP_LOG( OPERATION, DETAIL1, "str2entry: \"%s\"\n", s ? s : "NULL", 0, 0 );
68 Debug( LDAP_DEBUG_TRACE, "=> str2entry\n",
69 s ? s : "NULL", 0, 0 );
72 /* initialize reader/writer lock */
73 e = (Entry *) ch_calloc( 1, sizeof(Entry) );
77 LDAP_LOG( OPERATION, ERR, "str2entry: entry allocation failed.\n", 0, 0, 0 );
79 Debug( LDAP_DEBUG_ANY,
80 "<= str2entry NULL (entry allocation failed)\n",
86 /* initialize entry */
90 vals[1].bv_val = NULL;
93 while ( (s = ldif_getline( &next )) != NULL ) {
94 if ( *s == '\n' || *s == '\0' ) {
98 if ( ldif_parse_line( s, &type, &vals[0].bv_val, &vals[0].bv_len ) != 0 ) {
100 LDAP_LOG( OPERATION, DETAIL1, "str2entry: NULL (parse_line)\n",0, 0, 0 );
102 Debug( LDAP_DEBUG_TRACE,
103 "<= str2entry NULL (parse_line)\n", 0, 0, 0 );
108 if ( strcasecmp( type, "dn" ) == 0 ) {
111 if ( e->e_dn != NULL ) {
113 LDAP_LOG( OPERATION, DETAIL1, "str2entry: "
114 "entry %ld has multiple DNs \"%s\" and \"%s\"\n",
115 (long) e->e_id, e->e_dn, vals[0].bv_val );
117 Debug( LDAP_DEBUG_ANY, "str2entry: "
118 "entry %ld has multiple DNs \"%s\" and \"%s\"\n",
119 (long) e->e_id, e->e_dn, vals[0].bv_val );
121 free( vals[0].bv_val );
126 rc = dnPrettyNormal( NULL, &vals[0], &e->e_name, &e->e_nname );
127 if( rc != LDAP_SUCCESS ) {
129 LDAP_LOG( OPERATION, DETAIL1,
130 "str2entry: entry %ld has invalid DN \"%s\"\n",
131 (long) e->e_id, vals[0].bv_val, 0 );
133 Debug( LDAP_DEBUG_ANY, "str2entry: "
134 "entry %ld has invalid DN \"%s\"\n",
135 (long) e->e_id, vals[0].bv_val, 0 );
138 free( vals[0].bv_val );
141 free( vals[0].bv_val );
146 rc = slap_str2ad( type, &ad, &text );
148 if( rc != LDAP_SUCCESS ) {
150 LDAP_LOG( OPERATION, DETAIL1,
151 "str2entry: str2ad(%s): %s\n", type, text, 0 );
153 Debug( slapMode & SLAP_TOOL_MODE
154 ? LDAP_DEBUG_ANY : LDAP_DEBUG_TRACE,
155 "<= str2entry: str2ad(%s): %s\n", type, text, 0 );
157 if( slapMode & SLAP_TOOL_MODE ) {
159 free( vals[0].bv_val );
164 rc = slap_str2undef_ad( type, &ad, &text );
165 if( rc != LDAP_SUCCESS ) {
167 LDAP_LOG( OPERATION, DETAIL1,
168 "str2entry: str2undef_ad(%s): %s\n", type, text, 0 );
170 Debug( LDAP_DEBUG_ANY,
171 "<= str2entry: str2undef_ad(%s): %s\n",
175 free( vals[0].bv_val );
181 if( slapMode & SLAP_TOOL_MODE ) {
183 slap_syntax_validate_func *validate =
184 ad->ad_type->sat_syntax->ssyn_validate;
185 slap_syntax_transform_func *pretty =
186 ad->ad_type->sat_syntax->ssyn_pretty;
189 rc = pretty( ad->ad_type->sat_syntax,
192 } else if( validate ) {
194 * validate value per syntax
196 rc = validate( ad->ad_type->sat_syntax, &vals[0] );
200 LDAP_LOG( OPERATION, INFO,
201 "str2entry: no validator for syntax %s\n",
202 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
204 Debug( LDAP_DEBUG_ANY,
205 "str2entry: no validator for syntax %s\n",
206 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
209 free( vals[0].bv_val );
216 LDAP_LOG( OPERATION, ERR,
217 "str2entry: invalid value for syntax %s\n",
218 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
220 Debug( LDAP_DEBUG_ANY,
221 "str2entry: invalid value for syntax %s\n",
222 ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
225 free( vals[0].bv_val );
231 free( vals[0].bv_val );
236 rc = attr_merge( e, ad, vals );
239 LDAP_LOG( OPERATION, DETAIL1,
240 "str2entry: NULL (attr_merge)\n" , 0, 0, 0 );
242 Debug( LDAP_DEBUG_ANY,
243 "<= str2entry NULL (attr_merge)\n", 0, 0, 0 );
246 free( vals[0].bv_val );
252 free( vals[0].bv_val );
255 /* check to make sure there was a dn: line */
256 if ( e->e_dn == NULL ) {
258 LDAP_LOG( OPERATION, INFO,
259 "str2entry: entry %ld has no dn.\n", (long) e->e_id, 0, 0 );
261 Debug( LDAP_DEBUG_ANY, "str2entry: entry %ld has no dn\n",
262 (long) e->e_id, 0, 0 );
269 LDAP_LOG( OPERATION, DETAIL2,
270 "str2entry(%s) -> 0x%lx\n", e->e_dn, (unsigned long)e, 0 );
272 Debug(LDAP_DEBUG_TRACE, "<= str2entry(%s) -> 0x%lx\n",
273 e->e_dn, (unsigned long) e, 0 );
279 #define GRABSIZE BUFSIZ
281 #define MAKE_SPACE( n ) { \
282 while ( ecur + (n) > ebuf + emaxsize ) { \
284 offset = (int) (ecur - ebuf); \
285 ebuf = (unsigned char *) ch_realloc( (char *) ebuf, \
286 emaxsize + GRABSIZE ); \
287 emaxsize += GRABSIZE; \
288 ecur = ebuf + offset; \
305 * In string format, an entry looks like this:
307 * [<attr>: <value>\n]*
313 if ( e->e_dn != NULL ) {
315 tmplen = e->e_name.bv_len;
316 MAKE_SPACE( LDIF_SIZE_NEEDED( 2, tmplen ));
317 ldif_sput( (char **) &ecur, LDIF_PUT_VALUE, "dn", e->e_dn, tmplen );
320 /* put the attributes */
321 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
322 /* put "<type>:[:] <value>" line for each value */
323 for ( i = 0; a->a_vals[i].bv_val != NULL; i++ ) {
325 tmplen = a->a_desc->ad_cname.bv_len;
326 MAKE_SPACE( LDIF_SIZE_NEEDED( tmplen, bv->bv_len ));
327 ldif_sput( (char **) &ecur, LDIF_PUT_VALUE,
328 a->a_desc->ad_cname.bv_val,
329 bv->bv_val, bv->bv_len );
336 return( (char *) ebuf );
340 entry_free( Entry *e )
342 /* free an entry structure */
345 /* e_private must be freed by the caller */
346 assert( e->e_private == NULL );
350 if ( e->e_dn != NULL ) {
354 if ( e->e_ndn != NULL ) {
359 if ( e->e_bv.bv_val != NULL ) {
360 free( e->e_bv.bv_val );
361 e->e_bv.bv_val = NULL;
364 /* free attributes */
365 attrs_free( e->e_attrs );
372 * These routines are used only by Backend.
374 * the Entry has three entry points (ways to find things):
376 * by entry e.g., if you already have an entry from the cache
377 * and want to delete it. (really by entry ptr)
378 * by dn e.g., when looking for the base object of a search
379 * by id e.g., for search candidates
381 * these correspond to three different avl trees that are maintained.
385 entry_cmp( Entry *e1, Entry *e2 )
387 return( e1 < e2 ? -1 : (e1 > e2 ? 1 : 0) );
391 entry_dn_cmp( Entry *e1, Entry *e2 )
393 /* compare their normalized UPPERCASED dn's */
394 int rc = e1->e_nname.bv_len - e2->e_nname.bv_len;
396 return( strcmp( e1->e_ndn, e2->e_ndn ) );
400 entry_id_cmp( Entry *e1, Entry *e2 )
402 return( e1->e_id < e2->e_id ? -1 : (e1->e_id > e2->e_id ? 1 : 0) );
407 /* This is like a ber_len */
409 entry_lenlen(ber_len_t len)
423 entry_putlen(unsigned char **buf, ber_len_t len)
425 ber_len_t lenlen = entry_lenlen(len);
428 **buf = (unsigned char) len;
431 **buf = 0x80 | ((unsigned char) lenlen - 1);
432 for (i=lenlen-1; i>0; i--) {
433 (*buf)[i] = (unsigned char) len;
441 entry_getlen(unsigned char **buf)
458 /* Flatten an Entry into a buffer. The buffer is filled with just the
459 * strings/bervals of all the entry components. Each field is preceded
460 * by its length, encoded the way ber_put_len works. Every field is NUL
461 * terminated. The entire buffer size is precomputed so that a single
462 * malloc can be performed. The entry size is also recorded,
463 * to aid in entry_decode.
465 int entry_encode(Entry *e, struct berval *bv)
467 ber_len_t siz = sizeof(Entry);
468 ber_len_t len, dnlen, ndnlen;
474 LDAP_LOG( OPERATION, DETAIL1, "entry_encode: id: 0x%08lx \"%s\"\n",
475 (long) e->e_id, e->e_dn, 0 );
477 Debug( LDAP_DEBUG_TRACE, "=> entry_encode(0x%08lx): %s\n",
478 (long) e->e_id, e->e_dn, 0 );
480 dnlen = e->e_name.bv_len;
481 ndnlen = e->e_nname.bv_len;
482 len = dnlen + ndnlen + 2; /* two trailing NUL bytes */
483 len += entry_lenlen(dnlen);
484 len += entry_lenlen(ndnlen);
485 for (a=e->e_attrs; a; a=a->a_next) {
486 /* For AttributeDesc, we only store the attr name */
487 siz += sizeof(Attribute);
488 len += a->a_desc->ad_cname.bv_len+1;
489 len += entry_lenlen(a->a_desc->ad_cname.bv_len);
490 for (i=0; a->a_vals[i].bv_val; i++) {
491 siz += sizeof(struct berval);
492 len += a->a_vals[i].bv_len + 1;
493 len += entry_lenlen(a->a_vals[i].bv_len);
495 len += entry_lenlen(i);
496 siz += sizeof(struct berval); /* empty berval at end */
498 len += 1; /* NUL byte at end */
499 len += entry_lenlen(siz);
501 bv->bv_val = ch_malloc(len);
502 ptr = (unsigned char *)bv->bv_val;
503 entry_putlen(&ptr, siz);
504 entry_putlen(&ptr, dnlen);
505 AC_MEMCPY(ptr, e->e_dn, dnlen);
508 entry_putlen(&ptr, ndnlen);
509 AC_MEMCPY(ptr, e->e_ndn, ndnlen);
513 for (a=e->e_attrs; a; a=a->a_next) {
514 entry_putlen(&ptr, a->a_desc->ad_cname.bv_len);
515 AC_MEMCPY(ptr, a->a_desc->ad_cname.bv_val,
516 a->a_desc->ad_cname.bv_len);
517 ptr += a->a_desc->ad_cname.bv_len;
520 for (i=0; a->a_vals[i].bv_val; i++);
521 entry_putlen(&ptr, i);
522 for (i=0; a->a_vals[i].bv_val; i++) {
523 entry_putlen(&ptr, a->a_vals[i].bv_len);
524 memcpy(ptr, a->a_vals[i].bv_val,
525 a->a_vals[i].bv_len);
526 ptr += a->a_vals[i].bv_len;
535 /* Retrieve an Entry that was stored using entry_encode above.
536 * We malloc a single block with the size stored above for the Entry
537 * and all if its Attributes. We also must lookup the stored
538 * attribute names to get AttributeDescriptions. To detect if the
539 * attributes of an Entry are later modified, we note that e->e_attr
540 * is always a constant offset from (e).
542 * Note: everything is stored in a single contiguous block, so
543 * you can not free individual attributes or names from this
544 * structure. Attempting to do so will likely corrupt memory.
546 int entry_decode(struct berval *bv, Entry **e)
553 AttributeDescription *ad;
554 unsigned char *ptr = (unsigned char *)bv->bv_val;
557 i = entry_getlen(&ptr);
559 i = entry_getlen(&ptr);
560 x->e_name.bv_val = ptr;
561 x->e_name.bv_len = i;
563 i = entry_getlen(&ptr);
564 x->e_nname.bv_val = ptr;
565 x->e_nname.bv_len = i;
568 LDAP_LOG( OPERATION, DETAIL2, "entry_decode: \"%s\"\n", x->e_dn, 0, 0 );
570 Debug( LDAP_DEBUG_TRACE,
571 "entry_decode: \"%s\"\n",
576 /* A valid entry must have at least one attr, so this
577 * pointer can never be NULL
579 x->e_attrs = (Attribute *)(x+1);
580 bptr = (BerVarray)x->e_attrs;
583 while ((i = entry_getlen(&ptr))) {
588 a->a_next = (Attribute *)bptr;
590 a = (Attribute *)bptr;
592 rc = slap_bv2ad( &bv, &ad, &text );
594 if( rc != LDAP_SUCCESS ) {
596 LDAP_LOG( OPERATION, INFO,
597 "entry_decode: str2ad(%s): %s\n", ptr, text, 0 );
599 Debug( LDAP_DEBUG_TRACE,
600 "<= entry_decode: str2ad(%s): %s\n", ptr, text, 0 );
602 rc = slap_bv2undef_ad( &bv, &ad, &text );
604 if( rc != LDAP_SUCCESS ) {
606 LDAP_LOG( OPERATION, INFO,
607 "entry_decode: str2undef_ad(%s): %s\n", ptr, text, 0 );
609 Debug( LDAP_DEBUG_ANY,
610 "<= entry_decode: str2undef_ad(%s): %s\n",
618 bptr = (BerVarray)(a+1);
621 j = entry_getlen(&ptr);
624 i = entry_getlen(&ptr);
626 bptr->bv_val = (char *)ptr;
638 LDAP_LOG( OPERATION, DETAIL1, "entry_decode: %s\n", x->e_dn, 0, 0 );
640 Debug(LDAP_DEBUG_TRACE, "<= entry_decode(%s)\n",