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