git.sur5r.net Git - openldap/blob - servers/slapd/back-ldbm/index.c

   1 /* index.c - routines for dealing with attribute indexes */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2000 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/string.h>
  13 #include <ac/socket.h>
  14
  15 #include "slap.h"
  16 #include "back-ldbm.h"
  17
  18 static index_mask(
  19         Backend *be,
  20         AttributeDescription *desc,
  21         char **dbname,
  22         char **atname )
  23 {
  24         AttributeType *at;
  25         slap_index mask = 0;
  26
  27         /* we do support indexing of binary attributes */
  28         if( slap_ad_is_binary( desc ) ) return 0;
  29
  30         attr_mask( be->be_private, desc->ad_cname->bv_val, &mask );
  31
  32         if( mask ) {
  33                 *atname = desc->ad_cname->bv_val;
  34                 *dbname = desc->ad_cname->bv_val;
  35                 return mask;
  36         }
  37
  38         if( slap_ad_is_lang( desc ) ) {
  39                 /* has language tag */
  40                 attr_mask( be->be_private, desc->ad_type->sat_cname, &mask );
  41
  42                 if( mask & SLAP_INDEX_AUTO_LANG ) {
  43                         *atname = desc->ad_cname->bv_val;
  44                         *dbname = desc->ad_type->sat_cname;
  45                         return mask;
  46                 }
  47                 if( mask & SLAP_INDEX_LANG ) {
  48                         *atname = desc->ad_type->sat_cname;
  49                         *dbname = desc->ad_type->sat_cname;
  50                         return mask;
  51                 }
  52         }
  53
  54         /* see if supertype defined mask for its subtypes */
  55         for( at = desc->ad_type; at != NULL ; at = at->sat_sup ) {
  56                 attr_mask( be->be_private, at->sat_cname, &mask );
  57
  58                 if( mask & SLAP_INDEX_AUTO_SUBTYPES ) {
  59                         *atname = desc->ad_type->sat_cname;
  60                         *dbname = at->sat_cname;
  61                         return mask;
  62                 }
  63                 if( mask & SLAP_INDEX_SUBTYPES ) {
  64                         *atname = at->sat_cname;
  65                         *dbname = at->sat_cname;
  66                         return mask;
  67                 }
  68
  69                 if( mask ) break;
  70         }
  71
  72         return 0;
  73 }
  74
  75 int index_param(
  76         Backend *be,
  77         AttributeDescription *desc,
  78         int ftype,
  79         char **dbnamep,
  80         slap_index *maskp,
  81         struct berval **prefixp )
  82 {
  83         slap_index mask;
  84         char *dbname;
  85         char *atname;
  86
  87         mask = index_mask( be, desc, &dbname, &atname );
  88
  89         if( mask == 0 ) {
  90                 return LDAP_INAPPROPRIATE_MATCHING;
  91         }
  92
  93         switch(ftype) {
  94         case LDAP_FILTER_PRESENT:
  95                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
  96                         goto done;
  97                 }
  98                 break;
  99
 100         case LDAP_FILTER_APPROX:
 101                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
 102                         goto done;
 103                 }
 104                 /* fall thru */
 105
 106         case LDAP_FILTER_EQUALITY:
 107                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
 108                         goto done;
 109                 }
 110                 break;
 111
 112         case LDAP_FILTER_SUBSTRINGS:
 113                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
 114                         goto done;
 115                 }
 116                 break;
 117
 118         default:
 119                 return LDAP_OTHER;
 120         }
 121
 122         return LDAP_INAPPROPRIATE_MATCHING;
 123
 124 done:
 125         *dbnamep = dbname;
 126         *prefixp = ber_bvstrdup( atname );
 127         *maskp = mask;
 128         return LDAP_SUCCESS;
 129 }
 130
 131 static int indexer(
 132         Backend *be,
 133         char *dbname,
 134         char *atname,
 135         struct berval **vals,
 136         ID id,
 137         int op,
 138         slap_index mask )
 139 {
 140         int rc, i;
 141         const char *text;
 142     DBCache     *db;
 143         AttributeDescription *ad = NULL;
 144         struct berval **keys;
 145         struct berval prefix;
 146
 147         assert( mask );
 148
 149         rc = slap_str2ad( atname, &ad, &text );
 150
 151         if( rc != LDAP_SUCCESS ) return rc;
 152
 153         prefix.bv_val = atname;
 154         prefix.bv_len = strlen( atname );
 155
 156         db = ldbm_cache_open( be, dbname, LDBM_SUFFIX, LDBM_WRCREAT );
 157
 158         if ( db == NULL ) {
 159                 Debug( LDAP_DEBUG_ANY,
 160                     "<= index_read NULL (could not open %s%s)\n",
 161                         dbname, LDBM_SUFFIX, 0 );
 162                 ad_free( ad, 1 );
 163                 return LDAP_OTHER;
 164         }
 165
 166         if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
 167                 key_change( be, db, &prefix, id, op );
 168         }
 169
 170         if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
 171                 rc = ad->ad_type->sat_equality->smr_indexer(
 172                         mask,
 173                         ad->ad_type->sat_syntax,
 174                         ad->ad_type->sat_equality,
 175                         &prefix, vals, &keys );
 176
 177                 if( rc == LDAP_SUCCESS ) {
 178                         for( i= 0; keys[i] != NULL; i++ ) {
 179                                 key_change( be, db, keys[i], id, op );
 180                         }
 181                 }
 182         }
 183
 184         if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
 185                 rc = ad->ad_type->sat_approx->smr_indexer(
 186                         mask,
 187                         ad->ad_type->sat_syntax,
 188                         ad->ad_type->sat_approx,
 189                         &prefix, vals, &keys );
 190
 191                 if( rc == LDAP_SUCCESS ) {
 192                         for( i= 0; keys[i] != NULL; i++ ) {
 193                                 key_change( be, db, keys[i], id, op );
 194                         }
 195                 }
 196         }
 197
 198         if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
 199                 rc = ad->ad_type->sat_substr->smr_indexer(
 200                         mask,
 201                         ad->ad_type->sat_syntax,
 202                         ad->ad_type->sat_substr,
 203                         &prefix, vals, &keys );
 204
 205                 if( rc == LDAP_SUCCESS ) {
 206                         for( i= 0; keys[i] != NULL; i++ ) {
 207                                 key_change( be, db, keys[i], id, op );
 208                         }
 209                 }
 210         }
 211
 212         ldbm_cache_close( be, db );
 213         ad_free( ad, 1 );
 214         return LDAP_SUCCESS;
 215 }
 216
 217 static int index_at_values(
 218         Backend *be,
 219         AttributeType *type,
 220         const char *lang,
 221         struct berval **vals,
 222         ID id,
 223         int op,
 224         char ** dbnamep,
 225         slap_index *maskp )
 226 {
 227         slap_index mask;
 228         slap_index tmpmask = 0;
 229         int lindex = 0;
 230
 231         if( type->sat_sup ) {
 232                 /* recurse */
 233                 (void) index_at_values( be,
 234                         type->sat_sup, lang,
 235                         vals, id, op,
 236                         dbnamep, &tmpmask );
 237         }
 238
 239         attr_mask( be->be_private, type->sat_cname, &mask );
 240
 241         if( mask ) {
 242                 *dbnamep = type->sat_cname;
 243         } else if ( tmpmask & SLAP_INDEX_AUTO_SUBTYPES ) {
 244                 mask = tmpmask;
 245         }
 246
 247         if( mask ) {
 248                 indexer( be, *dbnamep,
 249                         type->sat_cname,
 250                         vals, id, op,
 251                         mask );
 252         }
 253
 254         if( lang ) {
 255                 char *dbname = NULL;
 256                 size_t tlen = strlen( type->sat_cname );
 257                 size_t llen = strlen( lang );
 258                 char *lname = ch_malloc( tlen + llen + sizeof(";") );
 259
 260                 sprintf( lname, "%s;%s", type->sat_cname, lang );
 261
 262                 attr_mask( be->be_private, lname, &tmpmask );
 263
 264                 if( tmpmask ) {
 265                         dbname = lname;
 266                 } else if ( mask & SLAP_INDEX_AUTO_LANG ) {
 267                         dbname = *dbnamep;
 268                         tmpmask = mask;
 269                 }
 270
 271                 if( dbname != NULL ) {
 272                         indexer( be, dbname, lname,
 273                                 vals, id, op,
 274                                 tmpmask );
 275                 }
 276
 277                 ch_free( lname );
 278         }
 279
 280         return LDAP_SUCCESS;
 281 }
 282
 283 int index_values(
 284         Backend *be,
 285         AttributeDescription *desc,
 286         struct berval **vals,
 287         ID id,
 288         int op )
 289 {
 290         char *dbname = NULL;
 291         slap_index mask;
 292
 293         if( slap_ad_is_binary( desc ) ) {
 294                 /* binary attributes have no index capabilities */
 295                 return LDAP_SUCCESS;
 296         }
 297
 298         (void) index_at_values( be,
 299                 desc->ad_type, desc->ad_lang,
 300                 vals, id, op,
 301                 &dbname, &mask );
 302
 303         return LDAP_SUCCESS;
 304 }
 305
 306
 307 int
 308 index_entry(
 309     Backend     *be,
 310         int op,
 311     Entry       *e,
 312         Attribute *ap
 313 )
 314 {
 315
 316         Debug( LDAP_DEBUG_TRACE, "=> index_entry_%s( %ld, \"%s\" )\n",
 317                 op == SLAP_INDEX_ADD_OP ? "add" : "del",
 318                 e->e_id, e->e_dn );
 319
 320
 321         /* add each attribute to the indexes */
 322         for ( ap; ap != NULL; ap = ap->a_next ) {
 323                 index_values( be, ap->a_desc, ap->a_vals, e->e_id, op );
 324         }
 325
 326         Debug( LDAP_DEBUG_TRACE, "<= index_entry_%s( %ld, \"%s\" ) success\n",
 327             op == SLAP_INDEX_ADD_OP ? "add" : "del",
 328                 e->e_id, e->e_dn );
 329
 330         return LDAP_SUCCESS;
 331 }
 332