]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/entry.c
minor cleanup
[openldap] / servers / slapd / entry.c
index 8fb1680c003479f7255eef1d04b5ead799f240ab..a150097dae6754c7d7dcdd55723427bc4b6188be 100644 (file)
@@ -1,7 +1,7 @@
 /* entry.c - routines for dealing with entries */
 /* $OpenLDAP$ */
 /*
- * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
 #include <ac/string.h>
 
 #include "slap.h"
+#include "ldif.h"
 
-static unsigned char   *ebuf;  /* buf returned by entry2str             */
+static unsigned char   *ebuf;  /* buf returned by entry2str             */
 static unsigned char   *ecur;  /* pointer to end of currently used ebuf */
-static int             emaxsize;/* max size of ebuf                     */
+static int             emaxsize;/* max size of ebuf                     */
+
+/*
+ * Empty root entry
+ */
+const Entry slap_entry_root = { NOID, "", "", NULL, NULL };
 
 int entry_destroy(void)
 {
@@ -29,19 +35,19 @@ int entry_destroy(void)
        return 0;
 }
 
+
 Entry *
 str2entry( char *s )
 {
+       int rc;
        Entry           *e;
-       Attribute       **a;
+       Attribute       **a = NULL;
        char            *type;
-       char            *value;
-       char            *next;
-       ber_len_t       vlen;
-       int             nvals, maxvals;
-       struct berval   bval;
+       struct berval value;
        struct berval   *vals[2];
-       char            ptype[64];
+       AttributeDescription *ad;
+       const char *text;
+       char    *next;
 
        /*
         * LDIF is used as the string format.
@@ -58,18 +64,26 @@ str2entry( char *s )
         * or newline.
         */
 
+#ifdef NEW_LOGGING
+       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                  "str2entry: \"%s\"\n", s ? s : "NULL" ));
+#else
        Debug( LDAP_DEBUG_TRACE, "=> str2entry\n",
                s ? s : "NULL", 0, 0 );
-
-       next = s;
+#endif
 
        /* initialize reader/writer lock */
        e = (Entry *) ch_malloc( sizeof(Entry) );
 
        if( e == NULL ) {
-               Debug( LDAP_DEBUG_TRACE,
+#ifdef NEW_LOGGING
+               LDAP_LOG(( "operation", LDAP_LEVEL_ERR,
+                          "str2entry: entry allocation failed.\n" ));
+#else
+               Debug( LDAP_DEBUG_ANY,
                    "<= str2entry NULL (entry allocation failed)\n",
                    0, 0, 0 );
+#endif
                return( NULL );
        }
 
@@ -81,68 +95,159 @@ str2entry( char *s )
        e->e_private = NULL;
 
        /* dn + attributes */
-       vals[0] = &bval;
+       vals[0] = &value;
        vals[1] = NULL;
-       ptype[0] = '\0';
 
+       next = s;
        while ( (s = ldif_getline( &next )) != NULL ) {
                if ( *s == '\n' || *s == '\0' ) {
                        break;
                }
 
-               if ( ldif_parse_line( s, &type, &value, &vlen ) != 0 ) {
+               if ( ldif_parse_line( s, &type, &value.bv_val, &value.bv_len ) != 0 ) {
+#ifdef NEW_LOGGING
+                       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                                  "str2entry:  NULL (parse_line)\n" ));
+#else
                        Debug( LDAP_DEBUG_TRACE,
                            "<= str2entry NULL (parse_line)\n", 0, 0, 0 );
+#endif
                        continue;
                }
 
-               if ( strcasecmp( type, ptype ) != 0 ) {
-                       strncpy( ptype, type, sizeof(ptype) - 1 );
-                       nvals = 0;
-                       maxvals = 0;
-                       a = NULL;
-               }
-
                if ( strcasecmp( type, "dn" ) == 0 ) {
                        free( type );
 
                        if ( e->e_dn != NULL ) {
-                               Debug( LDAP_DEBUG_ANY,
- "str2entry: entry %ld has multiple dns \"%s\" and \"%s\" (second ignored)\n",
-                                   e->e_id, e->e_dn,
-                                       value != NULL ? value : NULL );
-                               if( value != NULL ) free( value );
+#ifdef NEW_LOGGING
+                               LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1, "str2entry: "
+                                       "entry %ld has multiple dns \"%s\" and \"%s\" "
+                                       "(second ignored)\n",
+                                       (long) e->e_id, e->e_dn, value.bv_val != NULL ? value.bv_val : "" ));
+#else
+                               Debug( LDAP_DEBUG_ANY, "str2entry: "
+                                       "entry %ld has multiple dns \"%s\" and \"%s\" "
+                                       "(second ignored)\n",
+                                   (long) e->e_id, e->e_dn,
+                                       value.bv_val != NULL ? value.bv_val : "" );
+#endif
+                               if( value.bv_val != NULL ) free( value.bv_val );
                                continue;
                        }
-                       e->e_dn = value != NULL ? value : ch_strdup( "" );
+
+                       e->e_dn = value.bv_val != NULL ? value.bv_val : ch_strdup( "" );
                        continue;
                }
 
-               bval.bv_val = value;
-               bval.bv_len = vlen;
-#ifdef SLAPD_SCHEMA_NOT_COMPAT
-               /* not yet implemented */
+               ad = NULL;
+               rc = slap_str2ad( type, &ad, &text );
+
+               if( rc != LDAP_SUCCESS ) {
+#ifdef NEW_LOGGING
+                       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                                  "str2entry:  str2ad(%s):      %s\n", type, text ));
 #else
-               if ( attr_merge_fast( e, type, vals, nvals, 1, &maxvals, &a )
-                   != 0 ) {
-                       Debug( LDAP_DEBUG_TRACE,
+                       Debug( slapMode & SLAP_TOOL_MODE
+                               ? LDAP_DEBUG_ANY : LDAP_DEBUG_TRACE,
+                               "<= str2entry: str2ad(%s): %s\n", type, text, 0 );
+#endif
+                       if( slapMode & SLAP_TOOL_MODE ) {
+                               entry_free( e );
+                               free( value.bv_val );
+                               free( type );
+                               return NULL;
+                       }
+
+                       rc = slap_str2undef_ad( type, &ad, &text );
+
+                       if( rc != LDAP_SUCCESS ) {
+#ifdef NEW_LOGGING
+                               LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                                          "str2entry:  str2undef_ad(%s):  %s\n", type, text ));
+#else
+                               Debug( LDAP_DEBUG_ANY,
+                                       "<= str2entry: str2undef_ad(%s): %s\n",
+                                               type, text, 0 );
+#endif
+                               entry_free( e );
+                               free( value.bv_val );
+                               free( type );
+                               return NULL;
+                       }
+               }
+
+               if( slapMode & SLAP_TOOL_MODE ) {
+                       slap_syntax_validate_func *validate =
+                               ad->ad_type->sat_syntax->ssyn_validate;
+
+                       if( !validate ) {
+#ifdef NEW_LOGGING
+                               LDAP_LOG(( "operation", LDAP_LEVEL_INFO,
+                                          "str2entry: no validator for syntax %s\n", 
+                                          ad->ad_type->sat_syntax->ssyn_oid ));
+#else
+                               Debug( LDAP_DEBUG_ANY,
+                                       "str2entry: no validator for syntax %s\n",
+                                       ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
+#endif
+                               entry_free( e );
+                               free( value.bv_val );
+                               free( type );
+                               return NULL;
+                       }
+
+                       /*
+                        * validate value per syntax
+                        */
+                       rc = validate( ad->ad_type->sat_syntax, &value );
+
+                       if( rc != 0 ) {
+#ifdef NEW_LOGGING
+                               LDAP_LOG(( "operation", LDAP_LEVEL_ERR,
+                                          "str2entry:  invalid value for syntax %s\n",
+                                          ad->ad_type->sat_syntax->ssyn_oid ));
+#else
+                               Debug( LDAP_DEBUG_ANY,
+                                       "str2entry: invalid value for syntax %s\n",
+                                       ad->ad_type->sat_syntax->ssyn_oid, 0, 0 );
+#endif
+                               entry_free( e );
+                               free( value.bv_val );
+                               free( type );
+                               return NULL;
+                       }
+               }
+
+               rc = attr_merge( e, ad, vals );
+
+               if( rc != 0 ) {
+#ifdef NEW_LOGGING
+                       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                                  "str2entry:  NULL (attr_merge)\n" ));
+#else
+                       Debug( LDAP_DEBUG_ANY,
                            "<= str2entry NULL (attr_merge)\n", 0, 0, 0 );
+#endif
                        entry_free( e );
-                       free( value );
+                       free( value.bv_val );
                        free( type );
                        return( NULL );
                }
-#endif
 
-               free( value );
                free( type );
-               nvals++;
+               free( value.bv_val );
        }
 
        /* check to make sure there was a dn: line */
        if ( e->e_dn == NULL ) {
+#ifdef NEW_LOGGING
+               LDAP_LOG(( "operation", LDAP_LEVEL_INFO,
+                          "str2entry:  entry %ld has no dn.\n",
+                               (long) e->e_id ));
+#else
                Debug( LDAP_DEBUG_ANY, "str2entry: entry %ld has no dn\n",
-                   e->e_id, 0, 0 );
+                   (long) e->e_id, 0, 0 );
+#endif
                entry_free( e );
                return( NULL );
        }
@@ -151,12 +256,17 @@ str2entry( char *s )
        e->e_ndn = ch_strdup( e->e_dn );
        (void) dn_normalize( e->e_ndn );
 
-       Debug(LDAP_DEBUG_TRACE, "<= str2entry(%s) -> %ld (0x%lx)\n",
-               e->e_dn, e->e_id, (unsigned long)e );
-
+#ifdef NEW_LOGGING
+       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL2,
+                  "str2entry(%s) -> 0x%lx\n", e->e_dn, (unsigned long)e ));
+#else
+       Debug(LDAP_DEBUG_TRACE, "<= str2entry(%s) -> 0x%lx\n",
+               e->e_dn, (unsigned long) e, 0 );
+#endif
        return( e );
 }
 
+
 #define GRABSIZE       BUFSIZ
 
 #define MAKE_SPACE( n )        { \
@@ -200,18 +310,10 @@ entry2str(
                /* put "<type>:[:] <value>" line for each value */
                for ( i = 0; a->a_vals[i] != NULL; i++ ) {
                        bv = a->a_vals[i];
-#ifdef SLAPD_SCHEMA_NOT_COMPAT
-                       tmplen = a->a_desc->ad_cname->bv_len;
-#else
-                       tmplen = strlen( a->a_type );
-#endif
+                       tmplen = a->a_desc->ad_cname.bv_len;
                        MAKE_SPACE( LDIF_SIZE_NEEDED( tmplen, bv->bv_len ));
                        ldif_sput( (char **) &ecur, LDIF_PUT_VALUE,
-#ifdef SLAPD_SCHEMA_NOT_COMPAT
-                               a->a_desc->ad_cname->bv_val,
-#else
-                               a->a_type,
-#endif
+                               a->a_desc->ad_cname.bv_val,
                            bv->bv_val, bv->bv_len );
                }
        }
@@ -225,8 +327,14 @@ entry2str(
 void
 entry_free( Entry *e )
 {
-       Attribute       *a, *next;
+       /* free an entry structure */
+       assert( e != NULL );
+
+       /* e_private must be freed by the caller */
+       assert( e->e_private == NULL );
+       e->e_private = NULL;
 
+       /* free DNs */
        if ( e->e_dn != NULL ) {
                free( e->e_dn );
                e->e_dn = NULL;
@@ -235,12 +343,11 @@ entry_free( Entry *e )
                free( e->e_ndn );
                e->e_ndn = NULL;
        }
-       for ( a = e->e_attrs; a != NULL; a = next ) {
-               next = a->a_next;
-               attr_free( a );
-       }
+
+       /* free attributes */
+       attrs_free( e->e_attrs );
        e->e_attrs = NULL;
-       e->e_private = NULL;
+
        free( e );
 }
 
@@ -249,7 +356,7 @@ entry_free( Entry *e )
  *
  * the Entry has three entry points (ways to find things):
  *
- *     by entry        e.g., if you already have an entry from the cache
+ *     by entry        e.g., if you already have an entry from the cache
  *                     and want to delete it. (really by entry ptr)
  *     by dn           e.g., when looking for the base object of a search
  *     by id           e.g., for search candidates
@@ -276,3 +383,191 @@ entry_id_cmp( Entry *e1, Entry *e2 )
        return( e1->e_id < e2->e_id ? -1 : (e1->e_id > e2->e_id ? 1 : 0) );
 }
 
+#ifdef SLAPD_BDB
+
+/* Flatten an Entry into a buffer. The buffer contents become a direct
+ * copy of the entry, with all pointers converted to offsets from the
+ * beginning of the buffer. We do this by first walking through all
+ * the fields of the Entry, adding up their sizes. Then a single chunk
+ * of memory is malloc'd and the entry is copied. We differentiate between
+ * fixed size fields and variable-length content when tallying up the
+ * entry size, so that we can stick all of the variable-length stuff
+ * into the back half of the buffer.
+ */
+int entry_encode(Entry *e, struct berval **bv)
+{
+       int siz = sizeof(Entry);
+       int len, dnlen, ndnlen;
+       int i, j;
+       Entry *f;
+       Attribute *a, *b;
+       struct berval **bvl, *bz;
+       char *ptr, *base, *data;
+
+       *bv = ch_malloc(sizeof(struct berval));
+#ifdef NEW_LOGGING
+       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+               "entry_encode: id: 0x%08lx  \"%s\"\n",
+               (long) e->e_id, e->e_dn ));
+#else
+       Debug( LDAP_DEBUG_TRACE, "=> entry_encode(0x%08lx): %s\n",
+               (long) e->e_id, e->e_dn, 0 );
+#endif
+       dnlen = strlen(e->e_dn);
+       ndnlen = strlen(e->e_ndn);
+       len = dnlen + ndnlen + 2;       /* two trailing NUL bytes */
+       for (a=e->e_attrs; a; a=a->a_next) {
+               /* For AttributeDesc, we only store the attr name */
+               siz += sizeof(Attribute);
+               len += a->a_desc->ad_cname.bv_len+1;
+               for (i=0; a->a_vals[i]; i++) {
+                       siz += sizeof(struct berval *);
+                       siz += sizeof(struct berval);
+                       len += a->a_vals[i]->bv_len + 1;
+               }
+               siz += sizeof(struct berval *); /* NULL pointer at end */
+       }
+       (*bv)->bv_len = siz + len;
+       (*bv)->bv_val = ch_malloc(siz+len);
+       base = (*bv)->bv_val;
+       ptr = base + siz;
+       f = (Entry *)base;
+       data = (char *)(f+1);
+       f->e_id = e->e_id;
+       f->e_dn = (char *)(ptr-base);
+       memcpy(ptr, e->e_dn, dnlen);
+       ptr += dnlen;
+       *ptr++ = '\0';
+       f->e_ndn = (char *)(ptr-base);
+       memcpy(ptr, e->e_ndn, ndnlen);
+       ptr += ndnlen;
+       *ptr++ = '\0';
+       f->e_attrs = e->e_attrs ? (Attribute *)sizeof(Entry) : NULL;
+       f->e_private = NULL;
+       for (a=e->e_attrs; a; a=a->a_next) {
+               b = (Attribute *)data;
+               data = (char *)(b+1);
+               b->a_desc = (AttributeDescription *)(ptr-base);
+               memcpy(ptr, a->a_desc->ad_cname.bv_val,
+                       a->a_desc->ad_cname.bv_len);
+               ptr += a->a_desc->ad_cname.bv_len;
+               *ptr++ = '\0';
+               if (a->a_vals) {
+                   bvl = (struct berval **)data;
+                   b->a_vals = (struct berval **)(data-base);
+                   for (i=0; a->a_vals[i]; i++);
+                   data = (char *)(bvl+i+1);
+                   bz = (struct berval *)data;
+                   for (j=0; j<i; j++) {
+                           bz->bv_len = a->a_vals[j]->bv_len;
+                           if (a->a_vals[j]->bv_val) {
+                               bz->bv_val = (char *)(ptr-base);
+                               memcpy(ptr, a->a_vals[j]->bv_val, bz->bv_len);
+                           } else {
+                               bz->bv_val = NULL;
+                           }
+                           ptr += bz->bv_len;
+                           *ptr++ = '\0';
+                           bvl[j] = (struct berval *)(data-base);
+                           bz++;
+                           data = (char *)bz;
+                   }
+                   bvl[j] = NULL;
+               } else {
+                   b->a_vals = NULL;
+               }
+
+               if (a->a_next)
+                   b->a_next = (Attribute *)(data-base);
+               else
+                   b->a_next = NULL;
+       }
+       return 0;
+}
+
+/* Retrieve an Entry that was stored using entry_encode above.
+ * All we have to do is add the buffer address to all of the
+ * stored offsets. We also must lookup the stored attribute names
+ * to get AttributeDescriptions. To detect if the attributes of
+ * an Entry are later modified, we also store the address of the
+ * end of this block in e_private.
+ *
+ * Note: everything is stored in a single contiguous block, so
+ * you can not free individual attributes or names from this
+ * structure. Attempting to do so will likely corrupt memory.
+ */
+int entry_decode(struct berval *bv, Entry **e)
+{
+       int i;
+       long base;
+       Attribute *a;
+       Entry *x = (Entry *)bv->bv_val;
+       char *type;
+       const char *text;
+       AttributeDescription *ad;
+
+       base = (long)bv->bv_val;
+       x->e_dn += base;
+       x->e_ndn += base;
+#ifdef NEW_LOGGING
+       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL2,
+                  "entry_decode: \"%s\"\n", x->e_dn ));
+#else
+       Debug( LDAP_DEBUG_TRACE,
+           "entry_decode: \"%s\"\n",
+           x->e_dn, 0, 0 );
+#endif
+       x->e_private = bv->bv_val + bv->bv_len;
+       if (x->e_attrs)
+               x->e_attrs = (Attribute *)((long)x->e_attrs+base);
+       for (a=x->e_attrs; a; a=a->a_next) {
+               if (a->a_next)
+                       a->a_next = (Attribute *)((long)a->a_next+base);
+               ad = NULL;
+               type = (char *)a->a_desc+base;
+               i = slap_str2ad( type, &ad, &text );
+
+               if( i != LDAP_SUCCESS ) {
+#ifdef NEW_LOGGING
+                       LDAP_LOG(( "operation", LDAP_LEVEL_INFO,
+                                  "entry_decode: str2ad(%s): %s\n", type, text ));
+#else
+                       Debug( LDAP_DEBUG_TRACE,
+                               "<= entry_decode: str2ad(%s): %s\n", type, text, 0 );
+#endif
+                       i = slap_str2undef_ad( type, &ad, &text );
+
+                       if( i != LDAP_SUCCESS ) {
+#ifdef NEW_LOGGING
+                               LDAP_LOG(( "operation", LDAP_LEVEL_INFO,
+                                          "entry_decode:  str2undef_ad(%s): %s\n", type, text));
+#else
+                               Debug( LDAP_DEBUG_ANY,
+                                       "<= entry_decode: str2undef_ad(%s): %s\n",
+                                               type, text, 0 );
+#endif
+                               return i;
+                       }
+               }
+               a->a_desc = ad;
+               if (a->a_vals) {
+                       a->a_vals = (struct berval **)((long)a->a_vals+base);
+                       for (i=0; a->a_vals[i]; i++) {
+                               a->a_vals[i] = (struct berval *)
+                                       ((long)a->a_vals[i]+base);
+                               if (a->a_vals[i]->bv_val)
+                                   a->a_vals[i]->bv_val += base;
+                       }
+               }
+       }
+#ifdef NEW_LOGGING
+       LDAP_LOG(( "operation", LDAP_LEVEL_DETAIL1,
+                  "entry_decode:  %s\n", x->e_dn ));
+#else
+       Debug(LDAP_DEBUG_TRACE, "<= entry_decode(%s)\n",
+               x->e_dn, 0, 0 );
+#endif
+       *e = x;
+       return 0;
+}
+#endif