2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2002-2005 The OpenLDAP Foundation.
5 * Portions Copyright 1997,2002-2003 IBM Corporation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 * This work was initially developed by IBM Corporation for use in
18 * IBM products and subsequently ported to OpenLDAP Software by
19 * Steve Omrani. Additional significant contributors include:
28 isOkNetscapeParam( int param )
32 case SLAPI_CONNECTION:
34 case SLAPI_OPERATION_PARAMETERS:
35 case SLAPI_OPERATION_TYPE:
36 case SLAPI_OPERATION_ID:
37 case SLAPI_OPERATION_AUTHTYPE:
38 case SLAPI_REQUESTOR_ISROOT:
39 case SLAPI_BE_MONITORDN:
41 case SLAPI_BE_READONLY:
42 case SLAPI_BE_LASTMOD:
44 case SLAPI_OPINITIATED_TIME:
45 case SLAPI_REQUESTOR_DN:
46 case SLAPI_REQUESTOR_ISUPDATEDN:
48 case SLAPI_CONN_CLIENTIP:
49 case SLAPI_CONN_SERVERIP:
50 case SLAPI_CONN_AUTHTYPE:
51 case SLAPI_CONN_AUTHMETHOD:
53 case SLAPI_X_CONN_IS_UDP:
54 case SLAPI_X_CONN_CLIENTPATH:
55 case SLAPI_X_CONN_SERVERPATH:
56 case SLAPI_X_CONN_SSF:
57 case SLAPI_X_CONN_SASL_CONTEXT:
58 case SLAPI_IBM_CONN_DN_ALT:
59 case SLAPI_IBM_CONN_DN_ORIG:
60 case SLAPI_IBM_GSSAPI_CONTEXT:
62 case SLAPI_PLUGIN_PRIVATE:
63 case SLAPI_PLUGIN_TYPE:
64 case SLAPI_PLUGIN_ARGV:
65 case SLAPI_PLUGIN_ARGC:
66 case SLAPI_PLUGIN_VERSION:
67 case SLAPI_PLUGIN_OPRETURN:
68 case SLAPI_PLUGIN_OBJECT:
69 case SLAPI_PLUGIN_DESTROY_FN:
70 case SLAPI_PLUGIN_DESCRIPTION:
71 case SLAPI_PLUGIN_INTOP_RESULT:
72 case SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES:
73 case SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS:
74 case SLAPI_PLUGIN_DB_BIND_FN:
75 case SLAPI_PLUGIN_DB_UNBIND_FN:
76 case SLAPI_PLUGIN_DB_SEARCH_FN:
77 case SLAPI_PLUGIN_DB_COMPARE_FN:
78 case SLAPI_PLUGIN_DB_MODIFY_FN:
79 case SLAPI_PLUGIN_DB_MODRDN_FN:
80 case SLAPI_PLUGIN_DB_ADD_FN:
81 case SLAPI_PLUGIN_DB_DELETE_FN:
82 case SLAPI_PLUGIN_DB_ABANDON_FN:
83 case SLAPI_PLUGIN_DB_CONFIG_FN:
84 case SLAPI_PLUGIN_CLOSE_FN:
85 case SLAPI_PLUGIN_DB_FLUSH_FN:
86 case SLAPI_PLUGIN_START_FN:
87 case SLAPI_PLUGIN_DB_SEQ_FN:
88 case SLAPI_PLUGIN_DB_ENTRY_FN:
89 case SLAPI_PLUGIN_DB_REFERRAL_FN:
90 case SLAPI_PLUGIN_DB_RESULT_FN:
91 case SLAPI_PLUGIN_DB_LDIF2DB_FN:
92 case SLAPI_PLUGIN_DB_DB2LDIF_FN:
93 case SLAPI_PLUGIN_DB_BEGIN_FN:
94 case SLAPI_PLUGIN_DB_COMMIT_FN:
95 case SLAPI_PLUGIN_DB_ABORT_FN:
96 case SLAPI_PLUGIN_DB_ARCHIVE2DB_FN:
97 case SLAPI_PLUGIN_DB_DB2ARCHIVE_FN:
98 case SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN:
99 case SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN:
100 case SLAPI_PLUGIN_DB_SIZE_FN:
101 case SLAPI_PLUGIN_DB_TEST_FN:
102 case SLAPI_PLUGIN_DB_NO_ACL:
103 case SLAPI_PLUGIN_EXT_OP_FN:
104 case SLAPI_PLUGIN_EXT_OP_OIDLIST:
105 case SLAPI_PLUGIN_PRE_BIND_FN:
106 case SLAPI_PLUGIN_PRE_UNBIND_FN:
107 case SLAPI_PLUGIN_PRE_SEARCH_FN:
108 case SLAPI_PLUGIN_PRE_COMPARE_FN:
109 case SLAPI_PLUGIN_PRE_MODIFY_FN:
110 case SLAPI_PLUGIN_PRE_MODRDN_FN:
111 case SLAPI_PLUGIN_PRE_ADD_FN:
112 case SLAPI_PLUGIN_PRE_DELETE_FN:
113 case SLAPI_PLUGIN_PRE_ABANDON_FN:
114 case SLAPI_PLUGIN_PRE_ENTRY_FN:
115 case SLAPI_PLUGIN_PRE_REFERRAL_FN:
116 case SLAPI_PLUGIN_PRE_RESULT_FN:
117 case SLAPI_PLUGIN_POST_BIND_FN:
118 case SLAPI_PLUGIN_POST_UNBIND_FN:
119 case SLAPI_PLUGIN_POST_SEARCH_FN:
120 case SLAPI_PLUGIN_POST_COMPARE_FN:
121 case SLAPI_PLUGIN_POST_MODIFY_FN:
122 case SLAPI_PLUGIN_POST_MODRDN_FN:
123 case SLAPI_PLUGIN_POST_ADD_FN:
124 case SLAPI_PLUGIN_POST_DELETE_FN:
125 case SLAPI_PLUGIN_POST_ABANDON_FN:
126 case SLAPI_PLUGIN_POST_ENTRY_FN:
127 case SLAPI_PLUGIN_POST_REFERRAL_FN:
128 case SLAPI_PLUGIN_POST_RESULT_FN:
129 case SLAPI_PLUGIN_MR_FILTER_CREATE_FN:
130 case SLAPI_PLUGIN_MR_INDEXER_CREATE_FN:
131 case SLAPI_PLUGIN_MR_FILTER_MATCH_FN:
132 case SLAPI_PLUGIN_MR_FILTER_INDEX_FN:
133 case SLAPI_PLUGIN_MR_FILTER_RESET_FN:
134 case SLAPI_PLUGIN_MR_INDEX_FN:
135 case SLAPI_PLUGIN_MR_OID:
136 case SLAPI_PLUGIN_MR_TYPE:
137 case SLAPI_PLUGIN_MR_VALUE:
138 case SLAPI_PLUGIN_MR_VALUES:
139 case SLAPI_PLUGIN_MR_KEYS:
140 case SLAPI_PLUGIN_MR_FILTER_REUSABLE:
141 case SLAPI_PLUGIN_MR_QUERY_OPERATOR:
142 case SLAPI_PLUGIN_MR_USAGE:
144 case SLAPI_OP_LESS_OR_EQUAL:
145 case SLAPI_PLUGIN_MR_USAGE_INDEX:
146 case SLAPI_PLUGIN_SYNTAX_FILTER_AVA:
147 case SLAPI_PLUGIN_SYNTAX_FILTER_SUB:
148 case SLAPI_PLUGIN_SYNTAX_VALUES2KEYS:
149 case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA:
150 case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB:
151 case SLAPI_PLUGIN_SYNTAX_NAMES:
152 case SLAPI_PLUGIN_SYNTAX_OID:
153 case SLAPI_PLUGIN_SYNTAX_FLAGS:
154 case SLAPI_PLUGIN_SYNTAX_COMPARE:
155 case SLAPI_MANAGEDSAIT:
156 case SLAPI_CONFIG_FILENAME:
157 case SLAPI_CONFIG_LINENO:
158 case SLAPI_CONFIG_ARGC:
159 case SLAPI_CONFIG_ARGV:
160 case SLAPI_TARGET_DN:
161 case SLAPI_REQCONTROLS:
162 case SLAPI_ENTRY_PRE_OP:
163 case SLAPI_ENTRY_POST_OP:
164 case SLAPI_RESCONTROLS:
165 case SLAPI_ADD_RESCONTROL:
166 case SLAPI_ADD_ENTRY:
167 case SLAPI_BIND_METHOD:
168 case SLAPI_BIND_CREDENTIALS:
169 case SLAPI_BIND_SASLMECHANISM:
170 case SLAPI_BIND_RET_SASLCREDS:
171 case SLAPI_COMPARE_TYPE:
172 case SLAPI_COMPARE_VALUE:
173 case SLAPI_MODIFY_MODS:
174 case SLAPI_MODRDN_NEWRDN:
175 case SLAPI_MODRDN_DELOLDRDN:
176 case SLAPI_MODRDN_NEWSUPERIOR:
177 case SLAPI_SEARCH_SCOPE:
178 case SLAPI_SEARCH_DEREF:
179 case SLAPI_SEARCH_SIZELIMIT:
180 case SLAPI_SEARCH_TIMELIMIT:
181 case SLAPI_SEARCH_FILTER:
182 case SLAPI_SEARCH_STRFILTER:
183 case SLAPI_SEARCH_ATTRS:
184 case SLAPI_SEARCH_ATTRSONLY:
185 case SLAPI_ABANDON_MSGID:
187 case SLAPI_SEQ_ATTRNAME:
189 case SLAPI_EXT_OP_REQ_OID:
190 case SLAPI_EXT_OP_REQ_VALUE:
191 case SLAPI_EXT_OP_RET_OID:
192 case SLAPI_EXT_OP_RET_VALUE:
193 case SLAPI_MR_FILTER_ENTRY:
194 case SLAPI_MR_FILTER_TYPE:
195 case SLAPI_MR_FILTER_VALUE:
196 case SLAPI_MR_FILTER_OID:
197 case SLAPI_MR_FILTER_DNATTRS:
198 case SLAPI_LDIF2DB_FILE:
199 case SLAPI_LDIF2DB_REMOVEDUPVALS:
200 case SLAPI_DB2LDIF_PRINTKEY:
201 case SLAPI_PARENT_TXN:
203 case SLAPI_SEARCH_RESULT_SET:
204 case SLAPI_SEARCH_RESULT_ENTRY:
206 case SLAPI_SEARCH_REFERRALS:
207 case SLAPI_CHANGENUMBER:
208 case SLAPI_LOG_OPERATION:
210 case SLAPI_RESULT_CODE:
211 case SLAPI_RESULT_TEXT:
212 case SLAPI_RESULT_MATCHED:
213 case SLAPI_PLUGIN_COMPUTE_EVALUATOR_FN:
214 case SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN:
215 case SLAPI_PLUGIN_ACL_ALLOW_ACCESS:
216 case SLAPI_X_PLUGIN_PRE_GROUP_FN:
217 case SLAPI_X_PLUGIN_POST_GROUP_FN:
218 case SLAPI_X_GROUP_ENTRY:
219 case SLAPI_X_GROUP_ATTRIBUTE:
220 case SLAPI_X_GROUP_OPERATION_DN:
221 case SLAPI_X_GROUP_TARGET_ENTRY:
224 return INVALID_PARAM;
229 isValidParam( Slapi_PBlock *pb, int param )
231 if ( pb->ckParams == TRUE ) {
232 if ( IBM_RESERVED( param ) ) return LDAP_SUCCESS;
233 if (param == SLAPI_PLUGIN_AUDIT_FN ||
234 param == SLAPI_PLUGIN_AUDIT_DATA )
236 if ( param < LAST_IBM_PARAM ) {
237 return INVALID_PARAM;
238 } else if ( NETSCAPE_RESERVED( param ) ) {
239 return INVALID_PARAM;
241 return isOkNetscapeParam(param);
249 Lock( Slapi_PBlock *pb )
251 ldap_pvt_thread_mutex_lock(&pb->pblockMutex);
255 unLock( Slapi_PBlock *pb )
257 ldap_pvt_thread_mutex_unlock(&pb->pblockMutex);
261 get( Slapi_PBlock *pb, int param, void **val )
265 if ( isValidParam( pb, param ) == INVALID_PARAM ) {
272 for ( i = 0; i < pb->numParams; i++ ) {
273 if ( pb->curParams[i] == param ) {
274 *val = pb->curVals[i];
283 set( Slapi_PBlock *pb, int param, void *val )
285 #if defined(LDAP_SLAPI)
289 if ( isValidParam( pb, param ) == INVALID_PARAM ) {
295 if ( pb->numParams == PBLOCK_MAX_PARAMS ) {
300 if ( param == SLAPI_ADD_RESCONTROL ) {
302 param = SLAPI_RES_CONTROLS;
307 case SLAPI_CONN_AUTHMETHOD:
308 case SLAPI_IBM_CONN_DN_ALT:
309 case SLAPI_IBM_CONN_DN_ORIG:
310 case SLAPI_RESULT_TEXT:
311 case SLAPI_RESULT_MATCHED:
316 for( i = 0; i < pb->numParams; i++ ) {
317 if ( pb->curParams[i] == param ) {
322 if ( i >= pb->numParams ) {
323 pb->curParams[i] = param;
327 LDAPControl **ctrls = pb->curVals[i];
331 for (j=0; ctrls[j]; j++);
332 ctrls = ch_realloc( ctrls, (j+2)*sizeof(LDAPControl *) );
334 ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
339 pb->curVals[i] = ctrls;
341 if ( freeit ) ch_free( pb->curVals[i] );
342 pb->curVals[i] = val;
347 #endif /* LDAP_SLAPI */
352 clearPB( Slapi_PBlock *pb )
358 checkParams( Slapi_PBlock *pb, int flag )
364 deleteParam( Slapi_PBlock *p, int param )
369 for ( i = 0; i < p->numParams; i++ ) {
370 if ( p->curParams[i] == param ) {
375 if (i >= p->numParams ) {
379 if ( p->numParams > 1 ) {
380 p->curParams[i] = p->curParams[p->numParams];
381 p->curVals[i] = p->curVals[p->numParams];
391 #if defined(LDAP_SLAPI)
394 pb = (Slapi_PBlock *) ch_malloc(sizeof(Slapi_PBlock));
397 ldap_pvt_thread_mutex_init( &pb->pblockMutex );
398 memset( pb->curParams, 0, sizeof(pb->curParams) );
399 memset( pb->curVals, 0, sizeof(pb->curVals) );
400 pb->curParams[0] = SLAPI_IBM_PBLOCK;
401 pb->curVals[0] = NULL;
405 #endif /* LDAP_SLAPI */
410 slapi_pblock_destroy( Slapi_PBlock* pb )
412 #if defined(LDAP_SLAPI)
414 LDAPControl **rescontrols = NULL;
416 get( pb, SLAPI_CONN_DN,(void **)&str );
422 get( pb, SLAPI_CONN_AUTHMETHOD, (void **)&str );
428 get( pb, SLAPI_IBM_CONN_DN_ALT, (void **)&str );
434 get( pb, SLAPI_IBM_CONN_DN_ORIG, (void **)&str );
439 get( pb, SLAPI_RESULT_TEXT, (void **)&str );
445 get( pb, SLAPI_RESULT_MATCHED, (void **)&str );
451 get( pb, SLAPI_RESCONTROLS, (void **)&rescontrols );
452 if ( rescontrols != NULL ) {
453 ldap_controls_free( rescontrols );
457 ldap_pvt_thread_mutex_destroy( &pb->pblockMutex );
460 #endif /* LDAP_SLAPI */
464 slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value )
466 #if defined(LDAP_SLAPI)
467 return get( pb, arg, (void **)value );
468 #endif /* LDAP_SLAPI */
473 slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value )
475 #if defined(LDAP_SLAPI)
480 case SLAPI_CONN_AUTHMETHOD:
481 case SLAPI_IBM_CONN_DN_ALT:
482 case SLAPI_IBM_CONN_DN_ORIG:
483 case SLAPI_RESULT_TEXT:
484 case SLAPI_RESULT_MATCHED:
485 if ( value != NULL ) {
486 pTmp = (void *)slapi_ch_strdup((char *)value);
487 if ( pTmp == NULL ) {
488 return LDAP_NO_MEMORY;
496 return set( pb, arg, pTmp );
497 #endif /* LDAP_SLAPI */
498 return LDAP_NO_MEMORY;
502 slapi_pblock_clear( Slapi_PBlock *pb )
504 #if defined(LDAP_SLAPI)
506 #endif /* LDAP_SLAPI */
510 slapi_pblock_delete_param( Slapi_PBlock *p, int param )
512 #if defined(LDAP_SLAPI)
513 return deleteParam( p, param );
514 #endif /* LDAP_SLAPI */
519 slapi_pblock_check_params( Slapi_PBlock *pb, int flag )
521 #if defined(LDAP_SLAPI)
522 checkParams( pb, flag );
523 #endif /* LDAP_SLAPI */
530 slapi_int_pblock_get_first( Backend *be, Slapi_PBlock **pb )
532 #if defined(LDAP_SLAPI)
534 *pb = (Slapi_PBlock *)be->be_pb;
535 return (*pb == NULL ? LDAP_OTHER : LDAP_SUCCESS);
536 #else /* LDAP_SLAPI */
538 #endif /* LDAP_SLAPI */
545 slapi_int_pblock_get_next( Slapi_PBlock **pb )
547 #if defined(LDAP_SLAPI)
549 return slapi_pblock_get( *pb, SLAPI_IBM_PBLOCK, pb );
550 #else /* LDAP_SLAPI */
552 #endif /* LDAP_SLAPI */