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 0
 230                 /* ignore for now */
 231
 232                 if( amr == NULL ) {
 233 #ifdef NEW_LOGGING
 234                         LDAP_LOG( OPERATION, ERR,
 235                            "register_matching_rule: could not locate associated "
 236                            "matching rule %s for %s\n",
 237                                 def->mrd_associated, def->mrd_desc, 0 );
 238 #else
 239                         Debug( LDAP_DEBUG_ANY, "register_matching_rule: could not locate "
 240                                 "associated matching rule %s for %s\n",
 241                                 def->mrd_associated, def->mrd_desc, 0 );
 242 #endif
 243
 244                         return -1;
 245                 }
 246 #endif
 247         }
 248
 249         mr = ldap_str2matchingrule( def->mrd_desc, &code, &err,
 250                 LDAP_SCHEMA_ALLOW_ALL );
 251         if ( !mr ) {
 252 #ifdef NEW_LOGGING
 253                 LDAP_LOG( OPERATION, ERR,
 254                         "register_matching_rule: %s before %s in %s.\n",
 255                         ldap_scherr2str(code), err, def->mrd_desc );
 256 #else
 257                 Debug( LDAP_DEBUG_ANY,
 258                         "Error in register_matching_rule: %s before %s in %s\n",
 259                     ldap_scherr2str(code), err, def->mrd_desc );
 260 #endif
 261
 262                 return( -1 );
 263         }
 264
 265         code = mr_add( mr, def, amr, &err );
 266
 267         ldap_memfree( mr );
 268
 269         if ( code ) {
 270 #ifdef NEW_LOGGING
 271                 LDAP_LOG( OPERATION, ERR,
 272                         "register_matching_rule: %s for %s in %s.\n",
 273                         scherr2str(code), err, def->mrd_desc );
 274 #else
 275                 Debug( LDAP_DEBUG_ANY,
 276                         "Error in register_matching_rule: %s for %s in %s\n",
 277                     scherr2str(code), err, def->mrd_desc );
 278 #endif
 279
 280                 return( -1 );
 281         }
 282
 283         return( 0 );
 284 }
 285
 286 void
 287 mru_destroy( void )
 288 {
 289         MatchingRuleUse *m;
 290
 291         while( !LDAP_SLIST_EMPTY(&mru_list) ) {
 292                 m = LDAP_SLIST_FIRST(&mru_list);
 293                 LDAP_SLIST_REMOVE_HEAD(&mru_list, smru_next);
 294
 295                 if ( m->smru_str.bv_val ) {
 296                         ch_free( m->smru_str.bv_val );
 297                 }
 298                 /* memory borrowed from m->smru_mr */
 299                 m->smru_oid = NULL;
 300                 m->smru_names = NULL;
 301                 m->smru_desc = NULL;
 302
 303                 /* free what's left (basically
 304                  * smru_mruleuse.mru_applies_oids) */
 305                 ldap_matchingruleuse_free((LDAPMatchingRuleUse *)m);
 306         }
 307 }
 308
 309 int
 310 matching_rule_use_init( void )
 311 {
 312         MatchingRule    *mr;
 313         MatchingRuleUse **mru_ptr = &LDAP_SLIST_FIRST(&mru_list);
 314
 315 #ifdef NEW_LOGGING
 316         LDAP_LOG( OPERATION, INFO, "matching_rule_use_init\n", 0, 0, 0 );
 317 #else
 318         Debug( LDAP_DEBUG_TRACE, "matching_rule_use_init\n", 0, 0, 0 );
 319 #endif
 320
 321         LDAP_SLIST_FOREACH( mr, &mr_list, smr_next ) {
 322                 AttributeType   *at;
 323                 MatchingRuleUse mru_storage, *mru = &mru_storage;
 324
 325                 char            **applies_oids = NULL;
 326
 327                 mr->smr_mru = NULL;
 328
 329                 /* hide rules marked as HIDE */
 330                 if ( mr->smr_usage & SLAP_MR_HIDE ) {
 331                         continue;
 332                 }
 333
 334                 /* hide rules not marked as designed for extensibility */
 335                 /* MR_EXT means can be used any attribute type whose
 336                  * syntax is same as the assertion syntax.
 337                  * Another mechanism is needed where rule can be used
 338                  * with attribute of other syntaxes.
 339                  * Framework doesn't support this (yet).
 340                  */
 341
 342                 if (!( ( mr->smr_usage & SLAP_MR_EXT )
 343                         || mr->smr_compat_syntaxes ) )
 344                 {
 345                         continue;
 346                 }
 347
 348                 memset( mru, 0, sizeof( MatchingRuleUse ) );
 349
 350                 /*
 351                  * Note: we're using the same values of the corresponding
 352                  * MatchingRule structure; maybe we'd copy them ...
 353                  */
 354                 mru->smru_mr = mr;
 355                 mru->smru_obsolete = mr->smr_obsolete;
 356                 mru->smru_applies_oids = NULL;
 357                 LDAP_SLIST_NEXT(mru, smru_next) = NULL;
 358                 mru->smru_oid = mr->smr_oid;
 359                 mru->smru_names = mr->smr_names;
 360                 mru->smru_desc = mr->smr_desc;
 361
 362 #ifdef NEW_LOGGING
 363                 LDAP_LOG( OPERATION, INFO, "    %s (%s): ",
 364                                 mru->smru_oid,
 365                                 mru->smru_names ? mru->smru_names[ 0 ] : "", 0 );
 366 #else
 367                 Debug( LDAP_DEBUG_TRACE, "    %s (%s): ",
 368                                 mru->smru_oid,
 369                                 mru->smru_names ? mru->smru_names[ 0 ] : "", 0 );
 370 #endif
 371
 372                 at = NULL;
 373                 for ( at_start( &at ); at; at_next( &at ) ) {
 374                         if( at->sat_flags & SLAP_AT_HIDE ) continue;
 375
 376                         if( mr_usable_with_at( mr, at )) {
 377                                 ldap_charray_add( &applies_oids, at->sat_cname.bv_val );
 378                         }
 379                 }
 380
 381                 /*
 382                  * Note: the matchingRules that are not used
 383                  * by any attributeType are not listed as
 384                  * matchingRuleUse
 385                  */
 386                 if ( applies_oids != NULL ) {
 387                         mru->smru_applies_oids = applies_oids;
 388 #ifdef NEW_LOGGING
 389                         {
 390                                 char *str = ldap_matchingruleuse2str( &mru->smru_mruleuse );
 391                                 LDAP_LOG( OPERATION, INFO, "matchingRuleUse: %s\n", str, 0, 0 );
 392                                 ldap_memfree( str );
 393                         }
 394 #else
 395                         {
 396                                 char *str = ldap_matchingruleuse2str( &mru->smru_mruleuse );
 397                                 Debug( LDAP_DEBUG_TRACE, "matchingRuleUse: %s\n", str, 0, 0 );
 398                                 ldap_memfree( str );
 399                         }
 400 #endif
 401
 402                         mru = (MatchingRuleUse *)ber_memalloc( sizeof( MatchingRuleUse ) );
 403                         /* call-forward from MatchingRule to MatchingRuleUse */
 404                         mr->smr_mru = mru;
 405                         /* copy static data to newly allocated struct */
 406                         *mru = mru_storage;
 407                         /* append the struct pointer to the end of the list */
 408                         *mru_ptr = mru;
 409                         /* update the list head pointer */
 410                         mru_ptr = &LDAP_SLIST_NEXT(mru,smru_next);
 411                 }
 412         }
 413
 414         return( 0 );
 415 }
 416
 417 int mr_usable_with_at(
 418         MatchingRule *mr,
 419         AttributeType *at )
 420 {
 421         if( mr->smr_usage & SLAP_MR_EXT && (
 422                 mr->smr_syntax == at->sat_syntax ||
 423                 mr == at->sat_equality || mr == at->sat_approx ) )
 424         {
 425                 return 1;
 426         }
 427
 428         if ( mr->smr_compat_syntaxes ) {
 429                 int i;
 430                 for( i=0; mr->smr_compat_syntaxes[i]; i++ ) {
 431                         if( at->sat_syntax == mr->smr_compat_syntaxes[i] ) {
 432                                 return 1;
 433                         }
 434                 }
 435         }
 436         return 0;
 437 }
 438
 439 int mr_schema_info( Entry *e )
 440 {
 441         AttributeDescription *ad_matchingRules = slap_schema.si_ad_matchingRules;
 442         MatchingRule *mr;
 443         struct berval nval;
 444
 445         LDAP_SLIST_FOREACH(mr, &mr_list, smr_next ) {
 446                 if ( mr->smr_usage & SLAP_MR_HIDE ) {
 447                         /* skip hidden rules */
 448                         continue;
 449                 }
 450
 451                 if ( ! mr->smr_match ) {
 452                         /* skip rules without matching functions */
 453                         continue;
 454                 }
 455
 456                 if ( mr->smr_str.bv_val == NULL ) {
 457                         if ( ldap_matchingrule2bv( &mr->smr_mrule, &mr->smr_str ) == NULL ) {
 458                                 return -1;
 459                         }
 460                 }
 461 #if 0
 462                 Debug( LDAP_DEBUG_TRACE, "Merging mr [%lu] %s\n",
 463                         mr->smr_str.bv_len, mr->smr_str.bv_val, 0 );
 464 #endif
 465                 nval.bv_val = mr->smr_oid;
 466                 nval.bv_len = strlen(mr->smr_oid);
 467                 if( attr_merge_one( e, ad_matchingRules, &mr->smr_str, &nval ) )
 468                 {
 469                         return -1;
 470                 }
 471         }
 472         return 0;
 473 }
 474
 475 int mru_schema_info( Entry *e )
 476 {
 477         AttributeDescription *ad_matchingRuleUse
 478                 = slap_schema.si_ad_matchingRuleUse;
 479         MatchingRuleUse *mru;
 480         struct berval nval;
 481
 482         LDAP_SLIST_FOREACH( mru, &mru_list, smru_next ) {
 483
 484                 assert( !( mru->smru_usage & SLAP_MR_HIDE ) );
 485
 486                 if ( mru->smru_str.bv_val == NULL ) {
 487                         if ( ldap_matchingruleuse2bv( &mru->smru_mruleuse, &mru->smru_str )
 488                                         == NULL ) {
 489                                 return -1;
 490                         }
 491                 }
 492
 493 #if 0
 494                 Debug( LDAP_DEBUG_TRACE, "Merging mru [%lu] %s\n",
 495                         mru->smru_str.bv_len, mru->smru_str.bv_val, 0 );
 496 #endif
 497                 nval.bv_val = mru->smru_oid;
 498                 nval.bv_len = strlen(mru->smru_oid);
 499                 if( attr_merge_one( e, ad_matchingRuleUse, &mru->smru_str, &nval ) )
 500                 {
 501                         return -1;
 502                 }
 503         }
 504         return 0;
 505 }