git.sur5r.net Git - openldap/blob - servers/slapd/mr.c

   1 /* mr.c - routines to manage matching rule definitions */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #include "portable.h"
   9
  10 #include <stdio.h>
  11
  12 #include <ac/ctype.h>
  13 #include <ac/string.h>
  14 #include <ac/socket.h>
  15
  16 #include "slap.h"
  17 #include "ldap_pvt.h"
  18
  19 struct mindexrec {
  20         struct berval   mir_name;
  21         MatchingRule    *mir_mr;
  22 };
  23
  24 static Avlnode  *mr_index = NULL;
  25 static LDAP_SLIST_HEAD(MRList, slap_matching_rule) mr_list
  26         = LDAP_SLIST_HEAD_INITIALIZER(&mr_list);
  27 static LDAP_SLIST_HEAD(MRUList, slap_matching_rule_use) mru_list
  28         = LDAP_SLIST_HEAD_INITIALIZER(&mru_list);
  29
  30 static int
  31 mr_index_cmp(
  32     const void  *v_mir1,
  33     const void  *v_mir2
  34 )
  35 {
  36         const struct mindexrec  *mir1 = v_mir1;
  37         const struct mindexrec  *mir2 = v_mir2;
  38         int i = mir1->mir_name.bv_len - mir2->mir_name.bv_len;
  39         if (i) return i;
  40         return (strcmp( mir1->mir_name.bv_val, mir2->mir_name.bv_val ));
  41 }
  42
  43 static int
  44 mr_index_name_cmp(
  45     const void  *v_name,
  46     const void  *v_mir
  47 )
  48 {
  49         const struct berval    *name = v_name;
  50         const struct mindexrec *mir  = v_mir;
  51         int i = name->bv_len - mir->mir_name.bv_len;
  52         if (i) return i;
  53         return (strncmp( name->bv_val, mir->mir_name.bv_val, name->bv_len ));
  54 }
  55
  56 MatchingRule *
  57 mr_find( const char *mrname )
  58 {
  59         struct berval bv;
  60
  61         bv.bv_val = (char *)mrname;
  62         bv.bv_len = strlen( mrname );
  63         return mr_bvfind( &bv );
  64 }
  65
  66 MatchingRule *
  67 mr_bvfind( struct berval *mrname )
  68 {
  69         struct mindexrec        *mir = NULL;
  70
  71         if ( (mir = avl_find( mr_index, mrname, mr_index_name_cmp )) != NULL ) {
  72                 return( mir->mir_mr );
  73         }
  74         return( NULL );
  75 }
  76
  77 void
  78 mr_destroy( void )
  79 {
  80         MatchingRule *m;
  81
  82         avl_free(mr_index, ldap_memfree);
  83         while( !LDAP_SLIST_EMPTY(&mr_list) ) {
  84                 m = LDAP_SLIST_FIRST(&mr_list);
  85                 LDAP_SLIST_REMOVE_HEAD(&mr_list, smr_next);
  86                 ch_free( m->smr_str.bv_val );
  87                 ch_free( m->smr_compat_syntaxes );
  88                 ldap_matchingrule_free((LDAPMatchingRule *)m);
  89         }
  90 }
  91
  92 static int
  93 mr_insert(
  94     MatchingRule        *smr,
  95     const char          **err
  96 )
  97 {
  98         struct mindexrec        *mir;
  99         char                    **names;
 100
 101         LDAP_SLIST_NEXT( smr, smr_next ) = NULL;
 102         LDAP_SLIST_INSERT_HEAD(&mr_list, smr, smr_next);
 103
 104         if ( smr->smr_oid ) {
 105                 mir = (struct mindexrec *)
 106                         ch_calloc( 1, sizeof(struct mindexrec) );
 107                 mir->mir_name.bv_val = smr->smr_oid;
 108                 mir->mir_name.bv_len = strlen( smr->smr_oid );
 109                 mir->mir_mr = smr;
 110                 if ( avl_insert( &mr_index, (caddr_t) mir,
 111                                  mr_index_cmp, avl_dup_error ) ) {
 112                         *err = smr->smr_oid;
 113                         ldap_memfree(mir);
 114                         return SLAP_SCHERR_MR_DUP;
 115                 }
 116                 /* FIX: temporal consistency check */
 117                 mr_bvfind(&mir->mir_name);
 118         }
 119         if ( (names = smr->smr_names) ) {
 120                 while ( *names ) {
 121                         mir = (struct mindexrec *)
 122                                 ch_calloc( 1, sizeof(struct mindexrec) );
 123                         mir->mir_name.bv_val = *names;
 124                         mir->mir_name.bv_len = strlen( *names );
 125                         mir->mir_mr = smr;
 126                         if ( avl_insert( &mr_index, (caddr_t) mir,
 127                                          mr_index_cmp, avl_dup_error ) ) {
 128                                 *err = *names;
 129                                 ldap_memfree(mir);
 130                                 return SLAP_SCHERR_MR_DUP;
 131                         }
 132                         /* FIX: temporal consistency check */
 133                         mr_bvfind(&mir->mir_name);
 134                         names++;
 135                 }
 136         }
 137         return 0;
 138 }
 139
 140 int
 141 mr_add(
 142     LDAPMatchingRule            *mr,
 143     slap_mrule_defs_rec *def,
 144         MatchingRule    *amr,
 145     const char          **err
 146 )
 147 {
 148         MatchingRule    *smr;
 149         Syntax          *syn;
 150         Syntax          **compat_syn = NULL;
 151         int             code;
 152
 153         if( def->mrd_compat_syntaxes ) {
 154                 int i;
 155                 for( i=0; def->mrd_compat_syntaxes[i]; i++ ) {
 156                         /* just count em */
 157                 }
 158
 159                 compat_syn = ch_malloc( sizeof(Syntax *) * (i+1) );
 160
 161                 for( i=0; def->mrd_compat_syntaxes[i]; i++ ) {
 162                         compat_syn[i] = syn_find( def->mrd_compat_syntaxes[i] );
 163                         if( compat_syn[i] == NULL ) {
 164                                 return SLAP_SCHERR_SYN_NOT_FOUND;
 165                         }
 166                 }
 167
 168                 compat_syn[i] = NULL;
 169         }
 170
 171         smr = (MatchingRule *) ch_calloc( 1, sizeof(MatchingRule) );
 172         AC_MEMCPY( &smr->smr_mrule, mr, sizeof(LDAPMatchingRule));
 173
 174         /*
 175          * note: smr_bvoid uses the same memory of smr_mrule.mr_oid;
 176          * smr_oidlen is #defined as smr_bvoid.bv_len
 177          */
 178         smr->smr_bvoid.bv_val = smr->smr_mrule.mr_oid;
 179         smr->smr_oidlen = strlen( mr->mr_oid );
 180         smr->smr_usage = def->mrd_usage;
 181         smr->smr_compat_syntaxes = compat_syn;
 182         smr->smr_normalize = def->mrd_normalize;
 183         smr->smr_match = def->mrd_match;
 184         smr->smr_indexer = def->mrd_indexer;
 185         smr->smr_filter = def->mrd_filter;
 186         smr->smr_associated = amr;
 187
 188         if ( smr->smr_syntax_oid ) {
 189                 if ( (syn = syn_find(smr->smr_syntax_oid)) ) {
 190                         smr->smr_syntax = syn;
 191                 } else {
 192                         *err = smr->smr_syntax_oid;
 193                         return SLAP_SCHERR_SYN_NOT_FOUND;
 194                 }
 195         } else {
 196                 *err = "";
 197                 return SLAP_SCHERR_MR_INCOMPLETE;
 198         }
 199         code = mr_insert(smr,err);
 200         return code;
 201 }
 202
 203 int
 204 register_matching_rule(
 205         slap_mrule_defs_rec *def )
 206 {
 207         LDAPMatchingRule *mr;
 208         MatchingRule *amr = NULL;
 209         int             code;
 210         const char      *err;
 211
 212         if( def->mrd_usage == SLAP_MR_NONE &&
 213                 def->mrd_compat_syntaxes == NULL )
 214         {
 215 #ifdef NEW_LOGGING
 216                 LDAP_LOG( OPERATION, ERR,
 217                         "register_matching_rule: %s not usable\n", def->mrd_desc, 0, 0 );
 218 #else
 219                 Debug( LDAP_DEBUG_ANY, "register_matching_rule: not usable %s\n",
 220                     def->mrd_desc, 0, 0 );
 221 #endif
 222
 223                 return -1;
 224         }
 225
 226         if( def->mrd_associated != NULL ) {
 227                 amr = mr_find( def->mrd_associated );
 228
 229                 if( amr == NULL ) {
 230 #ifdef NEW_LOGGING
 231                         LDAP_LOG( OPERATION, ERR,
 232                            "register_matching_rule: could not locate associated "
 233                            "matching rule %s for %s\n",
 234                                 def->mrd_associated, def->mrd_desc, 0 );
 235 #else
 236                         Debug( LDAP_DEBUG_ANY, "register_matching_rule: could not locate "
 237                                 "associated matching rule %s for %s\n",
 238                                 def->mrd_associated, def->mrd_desc, 0 );
 239 #endif
 240
 241                         return -1;
 242                 }
 243         }
 244
 245         mr = ldap_str2matchingrule( def->mrd_desc, &code, &err,
 246                 LDAP_SCHEMA_ALLOW_ALL );
 247         if ( !mr ) {
 248 #ifdef NEW_LOGGING
 249                 LDAP_LOG( OPERATION, ERR,
 250                         "register_matching_rule: %s before %s in %s.\n",
 251                         ldap_scherr2str(code), err, def->mrd_desc );
 252 #else
 253                 Debug( LDAP_DEBUG_ANY,
 254                         "Error in register_matching_rule: %s before %s in %s\n",
 255                     ldap_scherr2str(code), err, def->mrd_desc );
 256 #endif
 257
 258                 return( -1 );
 259         }
 260
 261         code = mr_add( mr, def, amr, &err );
 262
 263         ldap_memfree( mr );
 264
 265         if ( code ) {
 266 #ifdef NEW_LOGGING
 267                 LDAP_LOG( OPERATION, ERR,
 268                         "register_matching_rule: %s for %s in %s.\n",
 269                         scherr2str(code), err, def->mrd_desc );
 270 #else
 271                 Debug( LDAP_DEBUG_ANY,
 272                         "Error in register_matching_rule: %s for %s in %s\n",
 273                     scherr2str(code), err, def->mrd_desc );
 274 #endif
 275
 276                 return( -1 );
 277         }
 278
 279         return( 0 );
 280 }
 281
 282 void
 283 mru_destroy( void )
 284 {
 285         MatchingRuleUse *m;
 286
 287         while( !LDAP_SLIST_EMPTY(&mru_list) ) {
 288                 m = LDAP_SLIST_FIRST(&mru_list);
 289                 LDAP_SLIST_REMOVE_HEAD(&mru_list, smru_next);
 290
 291                 if ( m->smru_str.bv_val ) {
 292                         ch_free( m->smru_str.bv_val );
 293                 }
 294                 /* memory borrowed from m->smru_mr */
 295                 m->smru_oid = NULL;
 296                 m->smru_names = NULL;
 297                 m->smru_desc = NULL;
 298
 299                 /* free what's left (basically
 300                  * smru_mruleuse.mru_applies_oids) */
 301                 ldap_matchingruleuse_free((LDAPMatchingRuleUse *)m);
 302         }
 303 }
 304
 305 int
 306 matching_rule_use_init( void )
 307 {
 308         MatchingRule    *mr;
 309         MatchingRuleUse **mru_ptr = &LDAP_SLIST_FIRST(&mru_list);
 310
 311 #ifdef NEW_LOGGING
 312         LDAP_LOG( OPERATION, INFO, "matching_rule_use_init\n", 0, 0, 0 );
 313 #else
 314         Debug( LDAP_DEBUG_TRACE, "matching_rule_use_init\n", 0, 0, 0 );
 315 #endif
 316
 317         LDAP_SLIST_FOREACH( mr, &mr_list, smr_next ) {
 318                 AttributeType   *at;
 319                 MatchingRuleUse mru_storage, *mru = &mru_storage;
 320
 321                 char            **applies_oids = NULL;
 322
 323                 mr->smr_mru = NULL;
 324
 325                 /* hide rules marked as HIDE */
 326                 if ( mr->smr_usage & SLAP_MR_HIDE ) {
 327                         continue;
 328                 }
 329
 330                 /* hide rules not marked as designed for extensibility */
 331                 /* MR_EXT means can be used any attribute type whose
 332                  * syntax is same as the assertion syntax.
 333                  * Another mechanism is needed where rule can be used
 334                  * with attribute of other syntaxes.
 335                  * Framework doesn't support this (yet).
 336                  */
 337
 338                 if (!( ( mr->smr_usage & SLAP_MR_EXT )
 339                         || mr->smr_compat_syntaxes ) )
 340                 {
 341                         continue;
 342                 }
 343
 344                 memset( mru, 0, sizeof( MatchingRuleUse ) );
 345
 346                 /*
 347                  * Note: we're using the same values of the corresponding
 348                  * MatchingRule structure; maybe we'd copy them ...
 349                  */
 350                 mru->smru_mr = mr;
 351                 mru->smru_obsolete = mr->smr_obsolete;
 352                 mru->smru_applies_oids = NULL;
 353                 LDAP_SLIST_NEXT(mru, smru_next) = NULL;
 354                 mru->smru_oid = mr->smr_oid;
 355                 mru->smru_names = mr->smr_names;
 356                 mru->smru_desc = mr->smr_desc;
 357
 358 #ifdef NEW_LOGGING
 359                 LDAP_LOG( OPERATION, INFO, "    %s (%s): ",
 360                                 mru->smru_oid,
 361                                 mru->smru_names ? mru->smru_names[ 0 ] : "", 0 );
 362 #else
 363                 Debug( LDAP_DEBUG_TRACE, "    %s (%s): ",
 364                                 mru->smru_oid,
 365                                 mru->smru_names ? mru->smru_names[ 0 ] : "", 0 );
 366 #endif
 367
 368                 at = NULL;
 369                 for ( at_start( &at ); at; at_next( &at ) ) {
 370                         if( at->sat_flags & SLAP_AT_HIDE ) continue;
 371
 372                         if( mr_usable_with_at( mr, at )) {
 373                                 ldap_charray_add( &applies_oids, at->sat_cname.bv_val );
 374                         }
 375                 }
 376
 377                 /*
 378                  * Note: the matchingRules that are not used
 379                  * by any attributeType are not listed as
 380                  * matchingRuleUse
 381                  */
 382                 if ( applies_oids != NULL ) {
 383                         mru->smru_applies_oids = applies_oids;
 384 #ifdef NEW_LOGGING
 385                         {
 386                                 char *str = ldap_matchingruleuse2str( &mru->smru_mruleuse );
 387                                 LDAP_LOG( OPERATION, INFO, "matchingRuleUse: %s\n", str, 0, 0 );
 388                                 ldap_memfree( str );
 389                         }
 390 #else
 391                         {
 392                                 char *str = ldap_matchingruleuse2str( &mru->smru_mruleuse );
 393                                 Debug( LDAP_DEBUG_TRACE, "matchingRuleUse: %s\n", str, 0, 0 );
 394                                 ldap_memfree( str );
 395                         }
 396 #endif
 397
 398                         mru = (MatchingRuleUse *)ber_memalloc( sizeof( MatchingRuleUse ) );
 399                         /* call-forward from MatchingRule to MatchingRuleUse */
 400                         mr->smr_mru = mru;
 401                         /* copy static data to newly allocated struct */
 402                         *mru = mru_storage;
 403                         /* append the struct pointer to the end of the list */
 404                         *mru_ptr = mru;
 405                         /* update the list head pointer */
 406                         mru_ptr = &LDAP_SLIST_NEXT(mru,smru_next);
 407                 }
 408         }
 409
 410         return( 0 );
 411 }
 412
 413 int mr_usable_with_at(
 414         MatchingRule *mr,
 415         AttributeType *at )
 416 {
 417         if( mr->smr_usage & SLAP_MR_EXT && (
 418                 mr->smr_syntax == at->sat_syntax ||
 419                 mr == at->sat_equality || mr == at->sat_approx ) )
 420         {
 421                 return 1;
 422         }
 423
 424         if ( mr->smr_compat_syntaxes ) {
 425                 int i;
 426                 for( i=0; mr->smr_compat_syntaxes[i]; i++ ) {
 427                         if( at->sat_syntax == mr->smr_compat_syntaxes[i] ) {
 428                                 return 1;
 429                         }
 430                 }
 431         }
 432         return 0;
 433 }
 434
 435 int mr_schema_info( Entry *e )
 436 {
 437         AttributeDescription *ad_matchingRules = slap_schema.si_ad_matchingRules;
 438         MatchingRule *mr;
 439         struct berval nval;
 440
 441         LDAP_SLIST_FOREACH(mr, &mr_list, smr_next ) {
 442                 if ( mr->smr_usage & SLAP_MR_HIDE ) {
 443                         /* skip hidden rules */
 444                         continue;
 445                 }
 446
 447                 if ( ! mr->smr_match ) {
 448                         /* skip rules without matching functions */
 449                         continue;
 450                 }
 451
 452                 if ( mr->smr_str.bv_val == NULL ) {
 453                         if ( ldap_matchingrule2bv( &mr->smr_mrule, &mr->smr_str ) == NULL ) {
 454                                 return -1;
 455                         }
 456                 }
 457 #if 0
 458                 Debug( LDAP_DEBUG_TRACE, "Merging mr [%lu] %s\n",
 459                         mr->smr_str.bv_len, mr->smr_str.bv_val, 0 );
 460 #endif
 461                 nval.bv_val = mr->smr_oid;
 462                 nval.bv_len = strlen(mr->smr_oid);
 463                 if( attr_merge_one( e, ad_matchingRules, &mr->smr_str, &nval ) )
 464                 {
 465                         return -1;
 466                 }
 467         }
 468         return 0;
 469 }
 470
 471 int mru_schema_info( Entry *e )
 472 {
 473         AttributeDescription *ad_matchingRuleUse
 474                 = slap_schema.si_ad_matchingRuleUse;
 475         MatchingRuleUse *mru;
 476         struct berval nval;
 477
 478         LDAP_SLIST_FOREACH( mru, &mru_list, smru_next ) {
 479
 480                 assert( !( mru->smru_usage & SLAP_MR_HIDE ) );
 481
 482                 if ( mru->smru_str.bv_val == NULL ) {
 483                         if ( ldap_matchingruleuse2bv( &mru->smru_mruleuse, &mru->smru_str )
 484                                         == NULL ) {
 485                                 return -1;
 486                         }
 487                 }
 488
 489 #if 0
 490                 Debug( LDAP_DEBUG_TRACE, "Merging mru [%lu] %s\n",
 491                         mru->smru_str.bv_len, mru->smru_str.bv_val, 0 );
 492 #endif
 493                 nval.bv_val = mru->smru_oid;
 494                 nval.bv_len = strlen(mru->smru_oid);
 495                 if( attr_merge_one( e, ad_matchingRuleUse, &mru->smru_str, &nval ) )
 496                 {
 497                         return -1;
 498                 }
 499         }
 500         return 0;
 501 }