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

   1 /*
   2  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  */
   5 /*
   6  * (C) Copyright IBM Corp. 1997,2002
   7  * Redistribution and use in source and binary forms are permitted
   8  * provided that this notice is preserved and that due credit is
   9  * given to IBM Corporation. This software is provided ``as is''
  10  * without express or implied warranty.
  11  */
  12
  13 #include "portable.h"
  14 #include "slapi_common.h"
  15 #include <slap.h>
  16 #include <slapi.h>
  17
  18 static int
  19 isOkNetscapeParam( int param )
  20 {
  21         switch ( param ) {
  22         case SLAPI_BACKEND:
  23         case SLAPI_CONNECTION:
  24         case SLAPI_OPERATION:
  25         case SLAPI_OPERATION_PARAMETERS:
  26         case SLAPI_OPERATION_TYPE:
  27         case SLAPI_OPERATION_ID:
  28         case SLAPI_OPERATION_AUTHTYPE:
  29         case SLAPI_REQUESTOR_ISROOT:
  30         case SLAPI_BE_MONITORDN:
  31         case SLAPI_BE_TYPE:
  32         case SLAPI_BE_READONLY:
  33         case SLAPI_BE_LASTMOD:
  34         case SLAPI_CONN_ID:
  35         case SLAPI_OPINITIATED_TIME:
  36         case SLAPI_REQUESTOR_DN:
  37         case SLAPI_REQUESTOR_ISUPDATEDN:
  38         case SLAPI_CONN_DN:
  39         case SLAPI_CONN_CLIENTIP:
  40         case SLAPI_CONN_SERVERIP:
  41         case SLAPI_CONN_AUTHTYPE:
  42         case SLAPI_CONN_AUTHMETHOD:
  43         case SLAPI_CONN_CERT:
  44         case SLAPI_IBM_CONN_DN_ALT:
  45         case SLAPI_IBM_CONN_DN_ORIG:
  46         case SLAPI_IBM_GSSAPI_CONTEXT:
  47         case SLAPI_PLUGIN:
  48         case SLAPI_PLUGIN_PRIVATE:
  49         case SLAPI_PLUGIN_TYPE:
  50         case SLAPI_PLUGIN_ARGV:
  51         case SLAPI_PLUGIN_ARGC:
  52         case SLAPI_PLUGIN_VERSION:
  53         case SLAPI_PLUGIN_OPRETURN:
  54         case SLAPI_PLUGIN_OBJECT:
  55         case SLAPI_PLUGIN_DESTROY_FN:
  56         case SLAPI_PLUGIN_DESCRIPTION:
  57         case SLAPI_PLUGIN_INTOP_RESULT:
  58         case SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES:
  59         case SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS:
  60         case SLAPI_PLUGIN_DB_BIND_FN:
  61         case SLAPI_PLUGIN_DB_UNBIND_FN:
  62         case SLAPI_PLUGIN_DB_SEARCH_FN:
  63         case SLAPI_PLUGIN_DB_COMPARE_FN:
  64         case SLAPI_PLUGIN_DB_MODIFY_FN:
  65         case SLAPI_PLUGIN_DB_MODRDN_FN:
  66         case SLAPI_PLUGIN_DB_ADD_FN:
  67         case SLAPI_PLUGIN_DB_DELETE_FN:
  68         case SLAPI_PLUGIN_DB_ABANDON_FN:
  69         case SLAPI_PLUGIN_DB_CONFIG_FN:
  70         case SLAPI_PLUGIN_CLOSE_FN:
  71         case SLAPI_PLUGIN_DB_FLUSH_FN:
  72         case SLAPI_PLUGIN_START_FN:
  73         case SLAPI_PLUGIN_DB_SEQ_FN:
  74         case SLAPI_PLUGIN_DB_ENTRY_FN:
  75         case SLAPI_PLUGIN_DB_REFERRAL_FN:
  76         case SLAPI_PLUGIN_DB_RESULT_FN:
  77         case SLAPI_PLUGIN_DB_LDIF2DB_FN:
  78         case SLAPI_PLUGIN_DB_DB2LDIF_FN:
  79         case SLAPI_PLUGIN_DB_BEGIN_FN:
  80         case SLAPI_PLUGIN_DB_COMMIT_FN:
  81         case SLAPI_PLUGIN_DB_ABORT_FN:
  82         case SLAPI_PLUGIN_DB_ARCHIVE2DB_FN:
  83         case SLAPI_PLUGIN_DB_DB2ARCHIVE_FN:
  84         case SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN:
  85         case SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN:
  86         case SLAPI_PLUGIN_DB_SIZE_FN:
  87         case SLAPI_PLUGIN_DB_TEST_FN:
  88         case SLAPI_PLUGIN_DB_NO_ACL:
  89         case SLAPI_PLUGIN_EXT_OP_FN:
  90         case SLAPI_PLUGIN_EXT_OP_OIDLIST:
  91         case SLAPI_PLUGIN_PRE_BIND_FN:
  92         case SLAPI_PLUGIN_PRE_UNBIND_FN:
  93         case SLAPI_PLUGIN_PRE_SEARCH_FN:
  94         case SLAPI_PLUGIN_PRE_COMPARE_FN:
  95         case SLAPI_PLUGIN_PRE_MODIFY_FN:
  96         case SLAPI_PLUGIN_PRE_MODRDN_FN:
  97         case SLAPI_PLUGIN_PRE_ADD_FN:
  98         case SLAPI_PLUGIN_PRE_DELETE_FN:
  99         case SLAPI_PLUGIN_PRE_ABANDON_FN:
 100         case SLAPI_PLUGIN_PRE_ENTRY_FN:
 101         case SLAPI_PLUGIN_PRE_REFERRAL_FN:
 102         case SLAPI_PLUGIN_PRE_RESULT_FN:
 103         case SLAPI_PLUGIN_POST_BIND_FN:
 104         case SLAPI_PLUGIN_POST_UNBIND_FN:
 105         case SLAPI_PLUGIN_POST_SEARCH_FN:
 106         case SLAPI_PLUGIN_POST_COMPARE_FN:
 107         case SLAPI_PLUGIN_POST_MODIFY_FN:
 108         case SLAPI_PLUGIN_POST_MODRDN_FN:
 109         case SLAPI_PLUGIN_POST_ADD_FN:
 110         case SLAPI_PLUGIN_POST_DELETE_FN:
 111         case SLAPI_PLUGIN_POST_ABANDON_FN:
 112         case SLAPI_PLUGIN_POST_ENTRY_FN:
 113         case SLAPI_PLUGIN_POST_REFERRAL_FN:
 114         case SLAPI_PLUGIN_POST_RESULT_FN:
 115         case SLAPI_PLUGIN_MR_FILTER_CREATE_FN:
 116         case SLAPI_PLUGIN_MR_INDEXER_CREATE_FN:
 117         case SLAPI_PLUGIN_MR_FILTER_MATCH_FN:
 118         case SLAPI_PLUGIN_MR_FILTER_INDEX_FN:
 119         case SLAPI_PLUGIN_MR_FILTER_RESET_FN:
 120         case SLAPI_PLUGIN_MR_INDEX_FN:
 121         case SLAPI_PLUGIN_MR_OID:
 122         case SLAPI_PLUGIN_MR_TYPE:
 123         case SLAPI_PLUGIN_MR_VALUE:
 124         case SLAPI_PLUGIN_MR_VALUES:
 125         case SLAPI_PLUGIN_MR_KEYS:
 126         case SLAPI_PLUGIN_MR_FILTER_REUSABLE:
 127         case SLAPI_PLUGIN_MR_QUERY_OPERATOR:
 128         case SLAPI_PLUGIN_MR_USAGE:
 129         case SLAPI_OP_LESS:
 130         case SLAPI_OP_LESS_OR_EQUAL:
 131         case SLAPI_PLUGIN_MR_USAGE_INDEX:
 132         case SLAPI_PLUGIN_SYNTAX_FILTER_AVA:
 133         case SLAPI_PLUGIN_SYNTAX_FILTER_SUB:
 134         case SLAPI_PLUGIN_SYNTAX_VALUES2KEYS:
 135         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA:
 136         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB:
 137         case SLAPI_PLUGIN_SYNTAX_NAMES:
 138         case SLAPI_PLUGIN_SYNTAX_OID:
 139         case SLAPI_PLUGIN_SYNTAX_FLAGS:
 140         case SLAPI_PLUGIN_SYNTAX_COMPARE:
 141         case SLAPI_MANAGEDSAIT:
 142         case SLAPI_CONFIG_FILENAME:
 143         case SLAPI_CONFIG_LINENO:
 144         case SLAPI_CONFIG_ARGC:
 145         case SLAPI_CONFIG_ARGV:
 146         case SLAPI_TARGET_DN:
 147         case SLAPI_REQCONTROLS:
 148         case SLAPI_ENTRY_PRE_OP:
 149         case SLAPI_ENTRY_POST_OP:
 150         case SLAPI_RESCONTROLS:
 151         case SLAPI_ADD_RESCONTROL:
 152         case SLAPI_ADD_ENTRY:
 153         case SLAPI_BIND_METHOD:
 154         case SLAPI_BIND_CREDENTIALS:
 155         case SLAPI_BIND_SASLMECHANISM:
 156         case SLAPI_BIND_RET_SASLCREDS:
 157         case SLAPI_COMPARE_TYPE:
 158         case SLAPI_COMPARE_VALUE:
 159         case SLAPI_MODIFY_MODS:
 160         case SLAPI_MODRDN_NEWRDN:
 161         case SLAPI_MODRDN_DELOLDRDN:
 162         case SLAPI_MODRDN_NEWSUPERIOR:
 163         case SLAPI_SEARCH_SCOPE:
 164         case SLAPI_SEARCH_DEREF:
 165         case SLAPI_SEARCH_SIZELIMIT:
 166         case SLAPI_SEARCH_TIMELIMIT:
 167         case SLAPI_SEARCH_FILTER:
 168         case SLAPI_SEARCH_STRFILTER:
 169         case SLAPI_SEARCH_ATTRS:
 170         case SLAPI_SEARCH_ATTRSONLY:
 171         case SLAPI_ABANDON_MSGID:
 172         case SLAPI_SEQ_TYPE:
 173         case SLAPI_SEQ_ATTRNAME:
 174         case SLAPI_SEQ_VAL:
 175         case SLAPI_EXT_OP_REQ_OID:
 176         case SLAPI_EXT_OP_REQ_VALUE:
 177         case SLAPI_EXT_OP_RET_OID:
 178         case SLAPI_EXT_OP_RET_VALUE:
 179         case SLAPI_MR_FILTER_ENTRY:
 180         case SLAPI_MR_FILTER_TYPE:
 181         case SLAPI_MR_FILTER_VALUE:
 182         case SLAPI_MR_FILTER_OID:
 183         case SLAPI_MR_FILTER_DNATTRS:
 184         case SLAPI_LDIF2DB_FILE:
 185         case SLAPI_LDIF2DB_REMOVEDUPVALS:
 186         case SLAPI_DB2LDIF_PRINTKEY:
 187         case SLAPI_PARENT_TXN:
 188         case SLAPI_TXN:
 189         case SLAPI_SEARCH_RESULT_SET:
 190         case SLAPI_SEARCH_RESULT_ENTRY:
 191         case SLAPI_NENTRIES:
 192         case SLAPI_SEARCH_REFERRALS:
 193         case SLAPI_CHANGENUMBER:
 194         case SLAPI_LOG_OPERATION:
 195         case SLAPI_DBSIZE:
 196         case SLAPI_RESULT_CODE:
 197         case SLAPI_RESULT_TEXT:
 198         case SLAPI_RESULT_MATCHED:
 199                 return LDAP_SUCCESS;
 200         default:
 201                 return INVALID_PARAM;
 202         }
 203 }
 204
 205 static int
 206 isValidParam( Slapi_PBlock *pb, int param )
 207 {
 208         if ( pb->ckParams == TRUE ) {
 209                 if ( IBM_RESERVED( param ) ) return LDAP_SUCCESS;
 210                 if (param == SLAPI_PLUGIN_AUDIT_FN ||
 211                                 param == SLAPI_PLUGIN_AUDIT_DATA )
 212                         return LDAP_SUCCESS;
 213                 if ( param < LAST_IBM_PARAM ) {
 214                         return INVALID_PARAM;
 215                 } else if ( NETSCAPE_RESERVED( param ) ) {
 216                         return INVALID_PARAM;
 217                 } else {
 218                         return isOkNetscapeParam(param);
 219                 }
 220         } else {
 221                 return LDAP_SUCCESS;
 222         }
 223 }
 224
 225 static void
 226 Lock( Slapi_PBlock *pb )
 227 {
 228         ldap_pvt_thread_mutex_lock(&pb->pblockMutex);
 229 }
 230
 231 static void
 232 unLock( Slapi_PBlock *pb )
 233 {
 234         ldap_pvt_thread_mutex_unlock(&pb->pblockMutex);
 235 }
 236
 237 static int
 238 get( Slapi_PBlock *pb, int param, void **val )
 239 {
 240         int i;
 241
 242         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 243                 return PBLOCK_ERROR;
 244         }
 245
 246         Lock( pb );
 247
 248         *val = NULL;
 249         for ( i = 0; i < pb->numParams; i++ ) {
 250                 if ( pb->curParams[i] == param ) {
 251                         *val = pb->curVals[i];
 252                         break;
 253                 }
 254         }
 255         unLock( pb );
 256         return LDAP_SUCCESS;
 257 }
 258
 259 static int
 260 set( Slapi_PBlock *pb, int param, void *val )
 261 {
 262 #if defined(LDAP_SLAPI)
 263         int i;
 264
 265         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 266                 return PBLOCK_ERROR;
 267         }
 268
 269         Lock( pb );
 270
 271         if ( pb->numParams == MAX_PARAMS ) {
 272                 unLock( pb );
 273                 return PBLOCK_ERROR;
 274         }
 275
 276         for( i = 0; i < pb->numParams; i++ ) {
 277                 if ( pb->curParams[i] == param ) {
 278                         break;
 279                 }
 280         }
 281
 282         if ( i >= pb->numParams ) {
 283                 pb->curParams[i] = param;
 284                 pb->numParams++;
 285         }
 286         pb->curVals[i] = val;
 287
 288         unLock( pb );
 289         return LDAP_SUCCESS;
 290 #endif /* LDAP_SLAPI */
 291         return PBLOCK_ERROR;
 292 }
 293
 294 static void
 295 clearPB( Slapi_PBlock *pb )
 296 {
 297         pb->numParams = 1;
 298 }
 299
 300 static void
 301 checkParams( Slapi_PBlock *pb, int flag )
 302 {
 303         pb->ckParams = flag;
 304 }
 305
 306 static int
 307 deleteParam( Slapi_PBlock *p, int param )
 308 {
 309         int i;
 310
 311         Lock(p);
 312         for ( i = 0; i < p->numParams; i++ ) {
 313                 if ( p->curParams[i] == param ) {
 314                         break;
 315                 }
 316         }
 317
 318         if (i >= p->numParams ) {
 319                 unLock( p );
 320                 return PBLOCK_ERROR;
 321         }
 322         if ( p->numParams > 1 ) {
 323                 p->curParams[i] = p->curParams[p->numParams];
 324                 p->curVals[i] = p->curVals[p->numParams];
 325         }
 326         p->numParams--;
 327         unLock( p );
 328         return LDAP_SUCCESS;
 329 }
 330
 331 Slapi_PBlock *
 332 slapi_pblock_new()
 333 {
 334 #if defined(LDAP_SLAPI)
 335         Slapi_PBlock *pb;
 336
 337         pb = (Slapi_PBlock *) ch_malloc(sizeof(Slapi_PBlock));
 338         if ( pb != NULL ) {
 339                 pb->ckParams = TRUE;
 340                 ldap_pvt_thread_mutex_init( &pb->pblockMutex );
 341                 memset( pb->curParams, 0, sizeof(pb->curParams) );
 342                 memset( pb->curVals, 0, sizeof(pb->curVals) );
 343                 pb->curParams[0] = SLAPI_IBM_PBLOCK;
 344                 pb->curVals[0] = NULL;
 345                 pb->numParams = 1;
 346         }
 347         return pb;
 348 #endif /* LDAP_SLAPI */
 349         return NULL;
 350 }
 351
 352 void
 353 slapi_pblock_destroy( Slapi_PBlock* pb )
 354 {
 355 #if defined(LDAP_SLAPI)
 356         char *str = NULL;
 357
 358         get( pb, SLAPI_CONN_DN,(void **)&str );
 359         if ( str != NULL ) {
 360                 ch_free( str );
 361                 str = NULL;
 362         }
 363
 364         get( pb, SLAPI_OPERATION_AUTHTYPE, (void **)&str );
 365         if ( str != NULL ) {
 366                 ch_free( str );
 367                 str = NULL;
 368         }
 369
 370         get( pb, SLAPI_CONN_AUTHMETHOD, (void **)&str );
 371         if ( str != NULL ) {
 372                 ch_free( str );
 373                 str = NULL;
 374         }
 375
 376         get( pb, SLAPI_IBM_CONN_DN_ALT, (void **)&str );
 377         if ( str != NULL ) {
 378                 ch_free( str );
 379                 str = NULL;
 380         }
 381
 382         get( pb, SLAPI_IBM_CONN_DN_ORIG, (void **)&str );
 383         if ( str != NULL ) {
 384                 ch_free( str );
 385         }
 386
 387         get( pb, SLAPI_RESULT_TEXT, (void **)&str );
 388         if ( str != NULL ) {
 389                 ch_free( str );
 390                 str = NULL;
 391         }
 392
 393         get( pb, SLAPI_RESULT_MATCHED, (void **)&str );
 394         if ( str != NULL ) {
 395                 ch_free( str );
 396                 str = NULL;
 397         }
 398
 399         ldap_pvt_thread_mutex_destroy( &pb->pblockMutex );
 400
 401         ch_free( pb );
 402 #endif /* LDAP_SLAPI */
 403 }
 404
 405 int
 406 slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value )
 407 {
 408 #if defined(LDAP_SLAPI)
 409         return get( pb, arg, (void **)value );
 410 #endif /* LDAP_SLAPI */
 411         return PBLOCK_ERROR;
 412 }
 413
 414 int
 415 slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value )
 416 {
 417 #if defined(LDAP_SLAPI)
 418         void *pTmp = NULL;
 419
 420         switch ( arg ) {
 421         case SLAPI_CONN_DN:
 422         case SLAPI_CONN_AUTHTYPE:
 423         case SLAPI_IBM_CONN_DN_ALT:
 424         case SLAPI_IBM_CONN_DN_ORIG:
 425                 if ( value != NULL ) {
 426                         pTmp = (void *)slapi_ch_strdup((char *)value);
 427                         if ( pTmp == NULL ) {
 428                                 return LDAP_NO_MEMORY;
 429                         }
 430                 }
 431                 break;
 432         default:
 433                 pTmp = value;
 434                 break;
 435         }
 436         return set( pb, arg, pTmp );
 437 #endif /* LDAP_SLAPI */
 438         return LDAP_NO_MEMORY;
 439 }
 440
 441 void
 442 slapi_pblock_clear( Slapi_PBlock *pb )
 443 {
 444 #if defined(LDAP_SLAPI)
 445    clearPB( pb );
 446 #endif /* LDAP_SLAPI */
 447 }
 448
 449 int
 450 slapi_pblock_delete_param( Slapi_PBlock *p, int param )
 451 {
 452 #if defined(LDAP_SLAPI)
 453         return deleteParam( p, param );
 454 #endif /* LDAP_SLAPI */
 455         return PBLOCK_ERROR;
 456 }
 457
 458 void
 459 slapi_pblock_check_params( Slapi_PBlock *pb, int flag )
 460 {
 461 #if defined(LDAP_SLAPI)
 462         checkParams( pb, flag );
 463 #endif /* LDAP_SLAPI */
 464 }
 465
 466 /*
 467  * OpenLDAP extension
 468  */
 469 int
 470 slapi_x_pblock_get_first( Backend *be, Slapi_PBlock **pb )
 471 {
 472 #if defined(LDAP_SLAPI)
 473         assert( pb );
 474         *pb = (Slapi_PBlock *)be->be_pb;
 475         return (*pb == NULL ? LDAP_OTHER : LDAP_SUCCESS);
 476 #else /* LDAP_SLAPI */
 477         return LDAP_OTHER;
 478 #endif /* LDAP_SLAPI */
 479 }
 480
 481 /*
 482  * OpenLDAP extension
 483  */
 484 int
 485 slapi_x_pblock_get_next( Slapi_PBlock **pb )
 486 {
 487 #if defined(LDAP_SLAPI)
 488         assert( pb );
 489         return slapi_pblock_get( *pb, SLAPI_IBM_PBLOCK, pb );
 490 #else /* LDAP_SLAPI */
 491         return LDAP_OTHER;
 492 #endif /* LDAP_SLAPI */
 493 }
 494