1 /* oc.c - object class routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2008 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
22 #include <ac/string.h>
23 #include <ac/socket.h>
27 int is_object_subclass(
33 if( sub == NULL || sup == NULL ) return 0;
36 Debug( LDAP_DEBUG_TRACE, "is_object_subclass(%s,%s) %d\n",
37 sup->soc_oid, sub->soc_oid, sup == sub );
44 if ( sub->soc_sups == NULL ) {
48 for ( i = 0; sub->soc_sups[i] != NULL; i++ ) {
49 if ( is_object_subclass( sup, sub->soc_sups[i] ) ) {
57 int is_entry_objectclass(
63 * set_flags should only be true if oc is one of operational
64 * object classes which we support objectClass flags for
65 * (e.g., referral, alias, ...). See <slap.h>.
71 assert( !( e == NULL || oc == NULL ) );
72 assert( ( flags & SLAP_OCF_MASK ) != SLAP_OCF_MASK );
74 if ( e == NULL || oc == NULL ) {
78 if ( flags == SLAP_OCF_SET_FLAGS && ( e->e_ocflags & SLAP_OC__END ) )
80 /* flags are set, use them */
81 return (e->e_ocflags & oc->soc_flags & SLAP_OC__MASK) != 0;
85 * find objectClass attribute
87 attr = attr_find( e->e_attrs, slap_schema.si_ad_objectClass );
89 /* no objectClass attribute */
90 Debug( LDAP_DEBUG_ANY, "is_entry_objectclass(\"%s\", \"%s\") "
91 "no objectClass attribute\n",
92 e->e_dn == NULL ? "" : e->e_dn,
93 oc->soc_oclass.oc_oid, 0 );
98 for ( bv = attr->a_vals; bv->bv_val; bv++ ) {
99 ObjectClass *objectClass = oc_bvfind( bv );
101 if ( objectClass == NULL ) {
102 /* FIXME: is this acceptable? */
106 if ( !( flags & SLAP_OCF_SET_FLAGS ) ) {
107 if ( objectClass == oc ) {
111 if ( ( flags & SLAP_OCF_CHECK_SUP )
112 && is_object_subclass( oc, objectClass ) )
118 e->e_ocflags |= objectClass->soc_flags;
121 /* mark flags as set */
122 e->e_ocflags |= SLAP_OC__END;
124 return ( e->e_ocflags & oc->soc_flags & SLAP_OC__MASK ) != 0;
129 struct berval oir_name;
133 static Avlnode *oc_index = NULL;
134 static Avlnode *oc_cache = NULL;
135 static LDAP_STAILQ_HEAD(OCList, ObjectClass) oc_list
136 = LDAP_STAILQ_HEAD_INITIALIZER(oc_list);
138 ObjectClass *oc_sys_tail;
145 const struct oindexrec *oir1 = v_oir1, *oir2 = v_oir2;
146 int i = oir1->oir_name.bv_len - oir2->oir_name.bv_len;
148 return strcasecmp( oir1->oir_name.bv_val, oir2->oir_name.bv_val );
156 const struct berval *name = v_name;
157 const struct oindexrec *oir = v_oir;
158 int i = name->bv_len - oir->oir_name.bv_len;
160 return strncasecmp( name->bv_val, oir->oir_name.bv_val, name->bv_len );
164 oc_find( const char *ocname )
168 bv.bv_val = (char *)ocname;
169 bv.bv_len = strlen( ocname );
171 return( oc_bvfind( &bv ) );
175 oc_bvfind( struct berval *ocname )
177 struct oindexrec *oir;
180 oir = avl_find( oc_cache, ocname, oc_index_name_cmp );
181 if ( oir ) return oir->oir_oc;
183 oir = avl_find( oc_index, ocname, oc_index_name_cmp );
187 avl_insert( &oc_cache, (caddr_t) oir,
188 oc_index_cmp, avl_dup_error );
190 return( oir->oir_oc );
196 static LDAP_STAILQ_HEAD(OCUList, ObjectClass) oc_undef_list
197 = LDAP_STAILQ_HEAD_INITIALIZER(oc_undef_list);
200 oc_bvfind_undef( struct berval *ocname )
202 ObjectClass *oc = oc_bvfind( ocname );
208 LDAP_STAILQ_FOREACH( oc, &oc_undef_list, soc_next ) {
209 int d = oc->soc_cname.bv_len - ocname->bv_len;
215 if ( strcasecmp( oc->soc_cname.bv_val, ocname->bv_val ) == 0 ) {
224 oc = ch_malloc( sizeof( ObjectClass ) + ocname->bv_len + 1 );
225 memset( oc, 0, sizeof( ObjectClass ) );
227 oc->soc_cname.bv_len = ocname->bv_len;
228 oc->soc_cname.bv_val = (char *)&oc[ 1 ];
229 AC_MEMCPY( oc->soc_cname.bv_val, ocname->bv_val, ocname->bv_len );
231 /* canonical to upper case */
232 ldap_pvt_str2upper( oc->soc_cname.bv_val );
234 LDAP_STAILQ_NEXT( oc, soc_next ) = NULL;
235 ldap_pvt_thread_mutex_lock( &oc_undef_mutex );
236 LDAP_STAILQ_INSERT_HEAD( &oc_undef_list, oc, soc_next );
237 ldap_pvt_thread_mutex_unlock( &oc_undef_mutex );
251 AttributeType **satp;
257 sat = at_find(*attrs1);
260 return SLAP_SCHERR_ATTR_NOT_FOUND;
263 if( is_at_operational( sat )) (*op)++;
265 if ( at_find_in_list(sat, soc->soc_required) < 0) {
266 if ( at_append_to_list(sat, &soc->soc_required) ) {
268 return SLAP_SCHERR_OUTOFMEM;
273 /* Now delete duplicates from the allowed list */
274 for ( satp = soc->soc_required; *satp; satp++ ) {
275 i = at_find_in_list(*satp, soc->soc_allowed);
277 at_delete_from_list(i, &soc->soc_allowed);
297 sat = at_find(*attrs1);
300 return SLAP_SCHERR_ATTR_NOT_FOUND;
303 if( is_at_operational( sat )) (*op)++;
305 if ( at_find_in_list(sat, soc->soc_required) < 0 &&
306 at_find_in_list(sat, soc->soc_allowed) < 0 ) {
307 if ( at_append_to_list(sat, &soc->soc_allowed) ) {
309 return SLAP_SCHERR_OUTOFMEM;
332 if ( !soc->soc_sups ) {
333 /* We are at the first recursive level */
341 soc->soc_sups = (ObjectClass **)ch_calloc(nsups,
342 sizeof(ObjectClass *));
348 soc1 = oc_find(*sups1);
351 return SLAP_SCHERR_CLASS_NOT_FOUND;
354 /* check object class usage
355 * abstract classes can only sup abstract classes
356 * structural classes can not sup auxiliary classes
357 * auxiliary classes can not sup structural classes
359 if( soc->soc_kind != soc1->soc_kind
360 && soc1->soc_kind != LDAP_SCHEMA_ABSTRACT )
363 return SLAP_SCHERR_CLASS_BAD_SUP;
366 if( soc1->soc_obsolete && !soc->soc_obsolete ) {
368 return SLAP_SCHERR_CLASS_BAD_SUP;
371 if( soc->soc_flags & SLAP_OC_OPERATIONAL ) (*op)++;
374 soc->soc_sups[nsups] = soc1;
377 code = oc_add_sups( soc, soc1->soc_sup_oids, op, err );
378 if ( code ) return code;
380 code = oc_create_required( soc, soc1->soc_at_oids_must, op, err );
381 if ( code ) return code;
383 code = oc_create_allowed( soc, soc1->soc_at_oids_may, op, err );
384 if ( code ) return code;
395 oc_delete_names( ObjectClass *oc )
397 char **names = oc->soc_names;
400 struct oindexrec tmpoir, *oir;
402 ber_str2bv( *names, 0, 0, &tmpoir.oir_name );
404 oir = (struct oindexrec *)avl_delete( &oc_index,
405 (caddr_t)&tmpoir, oc_index_cmp );
406 assert( oir != NULL );
412 /* Mark the ObjectClass as deleted, remove from list, and remove all its
413 * names from the AVL tree. Leave the OID in the tree.
416 oc_delete( ObjectClass *oc )
418 oc->soc_flags |= SLAP_OC_DELETED;
420 LDAP_STAILQ_REMOVE(&oc_list, oc, ObjectClass, soc_next);
422 oc_delete_names( oc );
426 oc_clean( ObjectClass *o )
429 ldap_memfree(o->soc_sups);
432 if (o->soc_required) {
433 ldap_memfree(o->soc_required);
434 o->soc_required = NULL;
436 if (o->soc_allowed) {
437 ldap_memfree(o->soc_allowed);
438 o->soc_allowed = NULL;
440 if (o->soc_oidmacro) {
441 ldap_memfree(o->soc_oidmacro);
442 o->soc_oidmacro = NULL;
447 oc_destroy_one( void *v )
449 struct oindexrec *oir = v;
450 ObjectClass *o = oir->oir_oc;
453 ldap_objectclass_free((LDAPObjectClass *)o);
462 while( !LDAP_STAILQ_EMPTY(&oc_list) ) {
463 o = LDAP_STAILQ_FIRST(&oc_list);
464 LDAP_STAILQ_REMOVE_HEAD(&oc_list, soc_next);
466 oc_delete_names( o );
469 avl_free( oc_index, oc_destroy_one );
471 while( !LDAP_STAILQ_EMPTY(&oc_undef_list) ) {
472 o = LDAP_STAILQ_FIRST(&oc_undef_list);
473 LDAP_STAILQ_REMOVE_HEAD(&oc_undef_list, soc_next);
475 ch_free( (ObjectClass *)o );
480 oc_start( ObjectClass **oc )
482 assert( oc != NULL );
484 *oc = LDAP_STAILQ_FIRST(&oc_list);
486 return (*oc != NULL);
490 oc_next( ObjectClass **oc )
492 assert( oc != NULL );
494 #if 0 /* pedantic check: breaks when deleting an oc, don't use it. */
496 ObjectClass *tmp = NULL;
498 LDAP_STAILQ_FOREACH(tmp,&oc_list,soc_next) {
504 assert( tmp != NULL );
512 *oc = LDAP_STAILQ_NEXT(*oc,soc_next);
514 return (*oc != NULL);
518 * check whether the two ObjectClasses actually __are__ identical,
519 * or rather inconsistent
524 ObjectClass *new_soc )
526 if ( new_soc->soc_oid != NULL ) {
527 if ( soc->soc_oid == NULL ) {
528 return SLAP_SCHERR_CLASS_INCONSISTENT;
531 if ( strcmp( soc->soc_oid, new_soc->soc_oid ) != 0 ) {
532 return SLAP_SCHERR_CLASS_INCONSISTENT;
536 if ( soc->soc_oid != NULL ) {
537 return SLAP_SCHERR_CLASS_INCONSISTENT;
541 if ( new_soc->soc_names ) {
544 if ( soc->soc_names == NULL ) {
545 return SLAP_SCHERR_CLASS_INCONSISTENT;
548 for ( i = 0; new_soc->soc_names[ i ]; i++ ) {
549 if ( soc->soc_names[ i ] == NULL ) {
550 return SLAP_SCHERR_CLASS_INCONSISTENT;
553 if ( strcasecmp( soc->soc_names[ i ],
554 new_soc->soc_names[ i ] ) != 0 )
556 return SLAP_SCHERR_CLASS_INCONSISTENT;
560 if ( soc->soc_names != NULL ) {
561 return SLAP_SCHERR_CLASS_INCONSISTENT;
565 return SLAP_SCHERR_CLASS_DUP;
568 static struct oindexrec *oir_old;
571 oc_dup_error( void *left, void *right )
583 struct oindexrec *oir;
585 ObjectClass *soc = *roc;
587 if ( soc->soc_oid ) {
588 oir = (struct oindexrec *)
589 ch_calloc( 1, sizeof(struct oindexrec) );
590 ber_str2bv( soc->soc_oid, 0, 0, &oir->oir_name );
594 if ( avl_insert( &oc_index, (caddr_t) oir,
595 oc_index_cmp, oc_dup_error ) )
597 ObjectClass *old_soc;
602 assert( oir_old != NULL );
603 old_soc = oir_old->oir_oc;
605 /* replacing a deleted definition? */
606 if ( old_soc->soc_flags & SLAP_OC_DELETED ) {
609 /* Keep old oid, free new oid;
610 * Keep new everything else, free old
614 old_soc->soc_oid = tmp.soc_oid;
615 tmp.soc_oid = soc->soc_oid;
619 oc_destroy_one( oir );
625 rc = oc_check_dup( old_soc, soc );
632 /* FIX: temporal consistency check */
633 assert( oc_bvfind( &oir->oir_name ) != NULL );
636 if ( (names = soc->soc_names) ) {
638 oir = (struct oindexrec *)
639 ch_calloc( 1, sizeof(struct oindexrec) );
640 oir->oir_name.bv_val = *names;
641 oir->oir_name.bv_len = strlen( *names );
644 assert( oir->oir_name.bv_val != NULL );
645 assert( oir->oir_oc != NULL );
647 if ( avl_insert( &oc_index, (caddr_t) oir,
648 oc_index_cmp, avl_dup_error ) )
650 ObjectClass *old_soc;
655 old_soc = oc_bvfind( &oir->oir_name );
656 assert( old_soc != NULL );
657 rc = oc_check_dup( old_soc, soc );
661 while ( names > soc->soc_names ) {
662 struct oindexrec tmpoir;
665 ber_str2bv( *names, 0, 0, &tmpoir.oir_name );
667 oir = (struct oindexrec *)avl_delete( &oc_index,
668 (caddr_t)&tmpoir, oc_index_cmp );
669 assert( oir != NULL );
673 if ( soc->soc_oid ) {
674 struct oindexrec tmpoir;
676 ber_str2bv( soc->soc_oid, 0, 0, &tmpoir.oir_name );
678 oir = (struct oindexrec *)avl_delete( &oc_index,
679 (caddr_t)&tmpoir, oc_index_cmp );
680 assert( oir != NULL );
687 /* FIX: temporal consistency check */
688 assert( oc_bvfind(&oir->oir_name) != NULL );
693 if ( soc->soc_flags & SLAP_OC_HARDCODE ) {
698 LDAP_STAILQ_INSERT_AFTER( &oc_list, prev, soc, soc_next );
700 LDAP_STAILQ_INSERT_TAIL( &oc_list, soc, soc_next );
719 if ( oc->oc_names != NULL ) {
722 for( i=0; oc->oc_names[i]; i++ ) {
723 if( !slap_valid_descr( oc->oc_names[i] ) ) {
724 return SLAP_SCHERR_BAD_DESCR;
729 if ( !OID_LEADCHAR( oc->oc_oid[0] )) {
730 /* Expand OID macros */
731 char *oid = oidm_find( oc->oc_oid );
734 return SLAP_SCHERR_OIDM;
736 if ( oid != oc->oc_oid ) {
742 soc = (ObjectClass *) ch_calloc( 1, sizeof(ObjectClass) );
743 AC_MEMCPY( &soc->soc_oclass, oc, sizeof(LDAPObjectClass) );
745 soc->soc_oidmacro = oidm;
746 if( oc->oc_names != NULL ) {
747 soc->soc_cname.bv_val = soc->soc_names[0];
749 soc->soc_cname.bv_val = soc->soc_oid;
751 soc->soc_cname.bv_len = strlen( soc->soc_cname.bv_val );
753 if( soc->soc_sup_oids == NULL &&
754 soc->soc_kind == LDAP_SCHEMA_STRUCTURAL )
756 /* structural object classes implicitly inherit from 'top' */
757 static char *top_oids[] = { SLAPD_TOP_OID, NULL };
758 code = oc_add_sups( soc, top_oids, &op, err );
760 code = oc_add_sups( soc, soc->soc_sup_oids, &op, err );
768 code = SLAP_SCHERR_CLASS_BAD_SUP;
772 code = oc_create_required( soc, soc->soc_at_oids_must, &op, err );
777 code = oc_create_allowed( soc, soc->soc_at_oids_may, &op, err );
783 code = SLAP_SCHERR_CLASS_BAD_USAGE;
788 soc->soc_flags |= SLAP_OC_HARDCODE;
791 code = oc_insert(&soc,prev,err);
794 if ( soc->soc_sups ) {
795 ch_free( soc->soc_sups );
798 if ( soc->soc_required ) {
799 ch_free( soc->soc_required );
802 if ( soc->soc_allowed ) {
803 ch_free( soc->soc_allowed );
815 oc_unparse( BerVarray *res, ObjectClass *start, ObjectClass *end, int sys )
819 struct berval bv, *bva = NULL, idx;
823 start = LDAP_STAILQ_FIRST( &oc_list );
825 /* count the result size */
827 for ( oc=start; oc; oc=LDAP_STAILQ_NEXT(oc, soc_next)) {
828 if ( sys && !(oc->soc_flags & SLAP_OC_HARDCODE)) break;
830 if ( oc == end ) break;
835 bva = ch_malloc( (num+1) * sizeof(struct berval) );
843 for ( oc=start; oc; oc=LDAP_STAILQ_NEXT(oc, soc_next)) {
844 LDAPObjectClass loc, *locp;
845 if ( sys && !(oc->soc_flags & SLAP_OC_HARDCODE)) break;
846 if ( oc->soc_oidmacro ) {
847 loc = oc->soc_oclass;
848 loc.oc_oid = oc->soc_oidmacro;
851 locp = &oc->soc_oclass;
853 if ( ldap_objectclass2bv( locp, &bv ) == NULL ) {
854 ber_bvarray_free( bva );
857 idx.bv_len = sprintf(idx.bv_val, "{%d}", i);
859 bva[i].bv_len = idx.bv_len + bv.bv_len;
860 bva[i].bv_val = ch_malloc( bva[i].bv_len + 1 );
861 strcpy( bva[i].bv_val, ibuf );
862 strcpy( bva[i].bv_val + idx.bv_len, bv.bv_val );
864 bva[i].bv_val = NULL;
865 ldap_memfree( bv.bv_val );
866 if ( oc == end ) break;
872 oc_schema_info( Entry *e )
874 AttributeDescription *ad_objectClasses = slap_schema.si_ad_objectClasses;
879 LDAP_STAILQ_FOREACH( oc, &oc_list, soc_next ) {
880 if( oc->soc_flags & SLAP_OC_HIDE ) continue;
882 if ( ldap_objectclass2bv( &oc->soc_oclass, &val ) == NULL ) {
886 nval = oc->soc_cname;
889 Debug( LDAP_DEBUG_TRACE, "Merging oc [%ld] %s (%s)\n",
890 (long) val.bv_len, val.bv_val, nval.bv_val );
893 if( attr_merge_one( e, ad_objectClasses, &val, &nval ) ) {
896 ldap_memfree( val.bv_val );
902 register_oc( const char *def, ObjectClass **soc, int dupok )
908 oc = ldap_str2objectclass( def, &code, &err, LDAP_SCHEMA_ALLOW_ALL );
910 Debug( LDAP_DEBUG_ANY,
911 "register_oc: objectclass \"%s\": %s, %s\n",
912 def, ldap_scherr2str(code), err );
915 code = oc_add(oc,0,NULL,NULL,&err);
916 if ( code && ( code != SLAP_SCHERR_CLASS_DUP || !dupok )) {
917 Debug( LDAP_DEBUG_ANY,
918 "register_oc: objectclass \"%s\": %s, %s\n",
919 def, scherr2str(code), err );
920 ldap_objectclass_free(oc);
924 *soc = oc_find(oc->oc_names[0]);
926 ldap_objectclass_free(oc);