]> git.sur5r.net Git - openldap/blob - servers/slapd/slapi/slapi_pblock.c
more slapi cleanup
[openldap] / servers / slapd / slapi / slapi_pblock.c
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 2002-2005 The OpenLDAP Foundation.
5  * Portions Copyright 1997,2002-2003 IBM Corporation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
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>.
15  */
16 /* ACKNOWLEDGEMENTS:
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:
20  *   Luke Howard
21  */
22
23 #include "portable.h"
24 #include <slap.h>
25 #include <slapi.h>
26
27 static slapi_pblock_class_t 
28 getPBlockClass( int param ) 
29 {
30         switch ( param ) {
31         case SLAPI_PLUGIN_TYPE:
32         case SLAPI_PLUGIN_ARGC:
33         case SLAPI_PLUGIN_VERSION:
34         case SLAPI_PLUGIN_OPRETURN:
35         case SLAPI_PLUGIN_INTOP_RESULT:
36         case SLAPI_CONFIG_LINENO:
37         case SLAPI_CONFIG_ARGC:
38         case SLAPI_BIND_METHOD:
39         case SLAPI_MODRDN_DELOLDRDN:
40         case SLAPI_SEARCH_SCOPE:
41         case SLAPI_SEARCH_DEREF:
42         case SLAPI_SEARCH_SIZELIMIT:
43         case SLAPI_SEARCH_TIMELIMIT:
44         case SLAPI_SEARCH_ATTRSONLY:
45         case SLAPI_NENTRIES:
46         case SLAPI_CHANGENUMBER:
47         case SLAPI_DBSIZE:
48         case SLAPI_REQUESTOR_ISROOT:
49         case SLAPI_BE_READONLY:
50         case SLAPI_BE_LASTMOD:
51         case SLAPI_DB2LDIF_PRINTKEY:
52         case SLAPI_LDIF2DB_REMOVEDUPVALS:
53         case SLAPI_MANAGEDSAIT:
54         case SLAPI_REQUESTOR_ISUPDATEDN:
55         case SLAPI_X_CONN_IS_UDP:
56         case SLAPI_X_CONN_SSF:
57         case SLAPI_RESULT_CODE:
58                 return PBLOCK_CLASS_INTEGER;
59                 break;
60
61         case SLAPI_CONN_ID:
62         case SLAPI_OPERATION_ID:
63         case SLAPI_OPINITIATED_TIME:
64         case SLAPI_ABANDON_MSGID:
65                 return PBLOCK_CLASS_LONG_INTEGER;
66                 break;
67
68         case SLAPI_PLUGIN_DESTROY_FN:
69         case SLAPI_PLUGIN_DB_BIND_FN:
70         case SLAPI_PLUGIN_DB_UNBIND_FN:
71         case SLAPI_PLUGIN_DB_SEARCH_FN:
72         case SLAPI_PLUGIN_DB_COMPARE_FN:
73         case SLAPI_PLUGIN_DB_MODIFY_FN:
74         case SLAPI_PLUGIN_DB_MODRDN_FN:
75         case SLAPI_PLUGIN_DB_ADD_FN:
76         case SLAPI_PLUGIN_DB_DELETE_FN:
77         case SLAPI_PLUGIN_DB_ABANDON_FN:
78         case SLAPI_PLUGIN_DB_CONFIG_FN:
79         case SLAPI_PLUGIN_CLOSE_FN:
80         case SLAPI_PLUGIN_DB_FLUSH_FN:
81         case SLAPI_PLUGIN_START_FN:
82         case SLAPI_PLUGIN_DB_SEQ_FN:
83         case SLAPI_PLUGIN_DB_ENTRY_FN:
84         case SLAPI_PLUGIN_DB_REFERRAL_FN:
85         case SLAPI_PLUGIN_DB_RESULT_FN:
86         case SLAPI_PLUGIN_DB_LDIF2DB_FN:
87         case SLAPI_PLUGIN_DB_DB2LDIF_FN:
88         case SLAPI_PLUGIN_DB_BEGIN_FN:
89         case SLAPI_PLUGIN_DB_COMMIT_FN:
90         case SLAPI_PLUGIN_DB_ABORT_FN:
91         case SLAPI_PLUGIN_DB_ARCHIVE2DB_FN:
92         case SLAPI_PLUGIN_DB_DB2ARCHIVE_FN:
93         case SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN:
94         case SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN:
95         case SLAPI_PLUGIN_DB_SIZE_FN:
96         case SLAPI_PLUGIN_DB_TEST_FN:
97         case SLAPI_PLUGIN_DB_NO_ACL:
98         case SLAPI_PLUGIN_EXT_OP_FN:
99         case SLAPI_PLUGIN_EXT_OP_OIDLIST:
100         case SLAPI_PLUGIN_PRE_BIND_FN:
101         case SLAPI_PLUGIN_PRE_UNBIND_FN:
102         case SLAPI_PLUGIN_PRE_SEARCH_FN:
103         case SLAPI_PLUGIN_PRE_COMPARE_FN:
104         case SLAPI_PLUGIN_PRE_MODIFY_FN:
105         case SLAPI_PLUGIN_PRE_MODRDN_FN:
106         case SLAPI_PLUGIN_PRE_ADD_FN:
107         case SLAPI_PLUGIN_PRE_DELETE_FN:
108         case SLAPI_PLUGIN_PRE_ABANDON_FN:
109         case SLAPI_PLUGIN_PRE_ENTRY_FN:
110         case SLAPI_PLUGIN_PRE_REFERRAL_FN:
111         case SLAPI_PLUGIN_PRE_RESULT_FN:
112         case SLAPI_PLUGIN_POST_BIND_FN:
113         case SLAPI_PLUGIN_POST_UNBIND_FN:
114         case SLAPI_PLUGIN_POST_SEARCH_FN:
115         case SLAPI_PLUGIN_POST_COMPARE_FN:
116         case SLAPI_PLUGIN_POST_MODIFY_FN:
117         case SLAPI_PLUGIN_POST_MODRDN_FN:
118         case SLAPI_PLUGIN_POST_ADD_FN:
119         case SLAPI_PLUGIN_POST_DELETE_FN:
120         case SLAPI_PLUGIN_POST_ABANDON_FN:
121         case SLAPI_PLUGIN_POST_ENTRY_FN:
122         case SLAPI_PLUGIN_POST_REFERRAL_FN:
123         case SLAPI_PLUGIN_POST_RESULT_FN:
124         case SLAPI_PLUGIN_MR_FILTER_CREATE_FN:
125         case SLAPI_PLUGIN_MR_INDEXER_CREATE_FN:
126         case SLAPI_PLUGIN_MR_FILTER_MATCH_FN:
127         case SLAPI_PLUGIN_MR_FILTER_INDEX_FN:
128         case SLAPI_PLUGIN_MR_FILTER_RESET_FN:
129         case SLAPI_PLUGIN_MR_INDEX_FN:
130         case SLAPI_PLUGIN_COMPUTE_EVALUATOR_FN:
131         case SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN:
132         case SLAPI_PLUGIN_ACL_ALLOW_ACCESS:
133         case SLAPI_X_PLUGIN_PRE_GROUP_FN:
134         case SLAPI_X_PLUGIN_POST_GROUP_FN:
135         case SLAPI_PLUGIN_AUDIT_FN:
136                 return PBLOCK_CLASS_FUNCTION_POINTER;
137                 break;
138
139         case SLAPI_BACKEND:
140         case SLAPI_CONNECTION:
141         case SLAPI_OPERATION:
142         case SLAPI_OPERATION_PARAMETERS:
143         case SLAPI_OPERATION_TYPE:
144         case SLAPI_OPERATION_AUTHTYPE:
145         case SLAPI_BE_MONITORDN:
146         case SLAPI_BE_TYPE:
147         case SLAPI_REQUESTOR_DN:
148         case SLAPI_CONN_DN:
149         case SLAPI_CONN_CLIENTIP:
150         case SLAPI_CONN_SERVERIP:
151         case SLAPI_CONN_AUTHTYPE:
152         case SLAPI_CONN_AUTHMETHOD:
153         case SLAPI_CONN_CERT:
154         case SLAPI_X_CONN_CLIENTPATH:
155         case SLAPI_X_CONN_SERVERPATH:
156         case SLAPI_X_CONN_SASL_CONTEXT:
157         case SLAPI_X_CONFIG_ARGV:
158         case SLAPI_X_INTOP_FLAGS:
159         case SLAPI_X_INTOP_RESULT_CALLBACK:
160         case SLAPI_X_INTOP_SEARCH_ENTRY_CALLBACK:
161         case SLAPI_X_INTOP_REFERRAL_ENTRY_CALLBACK:
162         case SLAPI_X_INTOP_CALLBACK_DATA:
163         case SLAPI_PLUGIN_MR_OID:
164         case SLAPI_PLUGIN_MR_TYPE:
165         case SLAPI_PLUGIN_MR_VALUE:
166         case SLAPI_PLUGIN_MR_VALUES:
167         case SLAPI_PLUGIN_MR_KEYS:
168         case SLAPI_PLUGIN:
169         case SLAPI_PLUGIN_PRIVATE:
170         case SLAPI_PLUGIN_ARGV:
171         case SLAPI_PLUGIN_OBJECT:
172         case SLAPI_PLUGIN_DESCRIPTION:
173         case SLAPI_PLUGIN_IDENTITY:
174         case SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES:
175         case SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS:
176         case SLAPI_PLUGIN_MR_FILTER_REUSABLE:
177         case SLAPI_PLUGIN_MR_QUERY_OPERATOR:
178         case SLAPI_PLUGIN_MR_USAGE:
179         case SLAPI_OP_LESS:
180         case SLAPI_OP_LESS_OR_EQUAL:
181         case SLAPI_PLUGIN_MR_USAGE_INDEX:
182         case SLAPI_PLUGIN_SYNTAX_FILTER_AVA:
183         case SLAPI_PLUGIN_SYNTAX_FILTER_SUB:
184         case SLAPI_PLUGIN_SYNTAX_VALUES2KEYS:
185         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA:
186         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB:
187         case SLAPI_PLUGIN_SYNTAX_NAMES:
188         case SLAPI_PLUGIN_SYNTAX_OID:
189         case SLAPI_PLUGIN_SYNTAX_FLAGS:
190         case SLAPI_PLUGIN_SYNTAX_COMPARE:
191         case SLAPI_CONFIG_FILENAME:
192         case SLAPI_CONFIG_ARGV:
193         case SLAPI_TARGET_ADDRESS:
194         case SLAPI_TARGET_UNIQUEID:
195         case SLAPI_TARGET_DN:
196         case SLAPI_REQCONTROLS:
197         case SLAPI_ENTRY_PRE_OP:
198         case SLAPI_ENTRY_POST_OP:
199         case SLAPI_RESCONTROLS:
200         case SLAPI_ADD_RESCONTROL:
201         case SLAPI_ADD_ENTRY:
202         case SLAPI_ADD_EXISTING_DN_ENTRY:
203         case SLAPI_ADD_PARENT_ENTRY:
204         case SLAPI_ADD_PARENT_UNIQUEID:
205         case SLAPI_ADD_EXISTING_UNIQUEID_ENTRY:
206         case SLAPI_BIND_CREDENTIALS:
207         case SLAPI_BIND_SASLMECHANISM:
208         case SLAPI_BIND_RET_SASLCREDS:
209         case SLAPI_COMPARE_TYPE:
210         case SLAPI_COMPARE_VALUE:
211         case SLAPI_MODIFY_MODS:
212         case SLAPI_MODRDN_NEWRDN:
213         case SLAPI_MODRDN_NEWSUPERIOR:
214         case SLAPI_MODRDN_PARENT_ENTRY:
215         case SLAPI_MODRDN_NEWPARENT_ENTRY:
216         case SLAPI_MODRDN_TARGET_ENTRY:
217         case SLAPI_MODRDN_NEWSUPERIOR_ADDRESS:
218         case SLAPI_SEARCH_FILTER:
219         case SLAPI_SEARCH_STRFILTER:
220         case SLAPI_SEARCH_ATTRS:
221         case SLAPI_SEQ_TYPE:
222         case SLAPI_SEQ_ATTRNAME:
223         case SLAPI_SEQ_VAL:
224         case SLAPI_EXT_OP_REQ_OID:
225         case SLAPI_EXT_OP_REQ_VALUE:
226         case SLAPI_EXT_OP_RET_OID:
227         case SLAPI_EXT_OP_RET_VALUE:
228         case SLAPI_MR_FILTER_ENTRY:
229         case SLAPI_MR_FILTER_TYPE:
230         case SLAPI_MR_FILTER_VALUE:
231         case SLAPI_MR_FILTER_OID:
232         case SLAPI_MR_FILTER_DNATTRS:
233         case SLAPI_LDIF2DB_FILE:
234         case SLAPI_PARENT_TXN:
235         case SLAPI_TXN:
236         case SLAPI_SEARCH_RESULT_SET:
237         case SLAPI_SEARCH_RESULT_ENTRY:
238         case SLAPI_SEARCH_REFERRALS:
239         case SLAPI_LOG_OPERATION:
240         case SLAPI_RESULT_TEXT:
241         case SLAPI_RESULT_MATCHED:
242         case SLAPI_X_GROUP_ENTRY:
243         case SLAPI_X_GROUP_ATTRIBUTE:
244         case SLAPI_X_GROUP_OPERATION_DN:
245         case SLAPI_X_GROUP_TARGET_ENTRY:
246         case SLAPI_PLUGIN_AUDIT_DATA:
247         case SLAPI_IBM_PBLOCK:
248                 return PBLOCK_CLASS_POINTER;
249                 break;
250         default:
251                 break;
252         }
253
254         return PBLOCK_CLASS_INVALID;
255 }
256
257 static void
258 Lock( Slapi_PBlock *pb )
259 {
260         ldap_pvt_thread_mutex_lock(&pb->pblockMutex);
261 }
262
263 static void
264 unLock( Slapi_PBlock *pb )
265 {
266         ldap_pvt_thread_mutex_unlock(&pb->pblockMutex);
267 }
268
269 static int 
270 get( Slapi_PBlock *pb, int param, void **val ) 
271 {       
272         int i;
273         slapi_pblock_class_t pbClass;
274
275         pbClass = getPBlockClass( param );
276         if ( pbClass == PBLOCK_CLASS_INVALID ) {
277                 return PBLOCK_ERROR;
278         }
279         
280         Lock( pb );
281
282         switch ( pbClass ) {
283         case PBLOCK_CLASS_INTEGER:
284                 *((int *)val) = 0;
285                 break;
286         case PBLOCK_CLASS_LONG_INTEGER:
287                 *((long *)val) = 0L;
288                 break;
289         case PBLOCK_CLASS_POINTER:
290         case PBLOCK_CLASS_FUNCTION_POINTER:
291                 *val = NULL;
292                 break;
293         }
294
295         for ( i = 0; i < pb->numParams; i++ ) {
296                 if ( pb->curParams[i] == param ) {
297                         switch ( pbClass ) {
298                         case PBLOCK_CLASS_INTEGER:
299                                 *((int *)val) = (int)pb->curVals[i];
300                                 break;
301                         case PBLOCK_CLASS_LONG_INTEGER:
302                                 *((long *)val) = (long)pb->curVals[i];
303                                 break;
304                         case PBLOCK_CLASS_POINTER:
305                         case PBLOCK_CLASS_FUNCTION_POINTER:
306                                 *val = pb->curVals[i];
307                                 break;
308                         default:
309                                 break;
310                         }
311                         break;
312                 }
313         }
314         unLock( pb );   
315         return PBLOCK_SUCCESS;
316 }
317
318 static int 
319 set( Slapi_PBlock *pb, int param, void *val ) 
320 {
321 #if defined(LDAP_SLAPI)
322         int i, freeit;
323         int addcon = 0;
324         slapi_pblock_class_t pbClass;
325
326         pbClass = getPBlockClass( param );
327         if ( pbClass == PBLOCK_CLASS_INVALID ) {
328                 return PBLOCK_ERROR;
329         }
330
331         Lock( pb );     
332
333         if ( pb->numParams == PBLOCK_MAX_PARAMS ) {
334                 unLock( pb );
335                 return PBLOCK_ERROR; 
336         }
337
338         if ( param == SLAPI_ADD_RESCONTROL ) {
339                 addcon = 1;
340                 param = SLAPI_RES_CONTROLS;
341         }
342
343         switch ( param ) {
344         case SLAPI_CONN_DN:
345         case SLAPI_CONN_AUTHMETHOD:
346         case SLAPI_RESULT_TEXT:
347         case SLAPI_RESULT_MATCHED:
348                 freeit = 1;
349                 break;
350         default:
351                 freeit = 0;
352                 break;
353         }
354         for( i = 0; i < pb->numParams; i++ ) { 
355                 if ( pb->curParams[i] == param ) {
356                         break;
357                 }
358         }
359
360         if ( i >= pb->numParams ) {
361                 pb->curParams[i] = param;
362                 pb->numParams++;
363         }
364         if ( addcon ) {
365                 LDAPControl **ctrls = pb->curVals[i];
366                 int j;
367
368                 if ( ctrls ) {
369                         for (j=0; ctrls[j]; j++);
370                         ctrls = ch_realloc( ctrls, (j+2)*sizeof(LDAPControl *) );
371                 } else {
372                         ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
373                         j = 0;
374                 }
375                 ctrls[j] = val;
376                 ctrls[j+1] = NULL;
377                 pb->curVals[i] = ctrls;
378         } else {
379                 if ( freeit ) ch_free( pb->curVals[i] );
380                 pb->curVals[i] = val;
381         }
382
383         unLock( pb );   
384         return PBLOCK_SUCCESS;
385 #endif /* LDAP_SLAPI */
386         return PBLOCK_ERROR;
387 }
388
389 static void
390 clearPB( Slapi_PBlock *pb ) 
391 {
392         pb->numParams = 1;
393 }
394
395 static void
396 checkParams( Slapi_PBlock *pb, int flag ) 
397 {
398         pb->ckParams = flag;
399 }
400
401 static int
402 deleteParam( Slapi_PBlock *p, int param ) 
403 {
404         int i;
405
406         Lock(p);
407         for ( i = 0; i < p->numParams; i++ ) { 
408                 if ( p->curParams[i] == param ) {
409                         break;
410                 }
411         }
412     
413         if (i >= p->numParams ) {
414                 unLock( p );
415                 return PBLOCK_ERROR;
416         }
417         if ( p->numParams > 1 ) {
418                 p->curParams[i] = p->curParams[p->numParams];
419                 p->curVals[i] = p->curVals[p->numParams];
420         }
421         p->numParams--;
422         unLock( p );    
423         return PBLOCK_SUCCESS;
424 }
425
426 Slapi_PBlock *
427 slapi_pblock_new() 
428 {
429 #if defined(LDAP_SLAPI)
430         Slapi_PBlock *pb;
431
432         pb = (Slapi_PBlock *) ch_malloc(sizeof(Slapi_PBlock));
433         if ( pb != NULL ) {
434                 pb->ckParams = 1;
435                 ldap_pvt_thread_mutex_init( &pb->pblockMutex );
436                 memset( pb->curParams, 0, sizeof(pb->curParams) );
437                 memset( pb->curVals, 0, sizeof(pb->curVals) );
438                 pb->curParams[0] = SLAPI_IBM_PBLOCK;
439                 pb->curVals[0] = NULL;
440                 pb->numParams = 1;
441         }
442         return pb;
443 #endif /* LDAP_SLAPI */
444         return NULL;
445 }
446
447 void 
448 slapi_pblock_destroy( Slapi_PBlock* pb ) 
449 {
450 #if defined(LDAP_SLAPI)
451         char *str = NULL;
452         LDAPControl **rescontrols = NULL;
453
454         get( pb, SLAPI_CONN_DN,(void **)&str );
455         if ( str != NULL ) {
456                 ch_free( str );
457                 str = NULL;
458         }
459
460         get( pb, SLAPI_CONN_AUTHMETHOD, (void **)&str );
461         if ( str != NULL ) {
462                 ch_free( str );
463                 str = NULL;
464         }
465
466         get( pb, SLAPI_RESULT_TEXT, (void **)&str );
467         if ( str != NULL ) {
468                 ch_free( str );
469                 str = NULL;
470         }
471
472         get( pb, SLAPI_RESULT_MATCHED, (void **)&str );
473         if ( str != NULL ) {
474                 ch_free( str );
475                 str = NULL;
476         }
477
478         get( pb, SLAPI_RESCONTROLS, (void **)&rescontrols );
479         if ( rescontrols != NULL ) {
480                 ldap_controls_free( rescontrols );
481                 rescontrols = NULL;
482         }
483
484         ldap_pvt_thread_mutex_destroy( &pb->pblockMutex );
485
486         ch_free( pb ); 
487 #endif /* LDAP_SLAPI */
488 }
489
490 int 
491 slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value ) 
492 {
493 #if defined(LDAP_SLAPI)
494         return get( pb, arg, (void **)value );
495 #endif /* LDAP_SLAPI */
496         return PBLOCK_ERROR;
497 }
498
499 int 
500 slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value ) 
501 {
502 #if defined(LDAP_SLAPI)
503         void *pTmp = NULL;
504
505         switch ( arg ) {
506         case SLAPI_CONN_DN:
507         case SLAPI_CONN_AUTHMETHOD:
508         case SLAPI_RESULT_TEXT:
509         case SLAPI_RESULT_MATCHED:
510                 if ( value != NULL ) {
511                         pTmp = (void *)slapi_ch_strdup((char *)value);
512                         if ( pTmp == NULL ) {
513                                 return LDAP_NO_MEMORY;
514                         }
515                 }
516                 break;
517         default:
518                 pTmp = value;
519                 break;
520         }
521         return set( pb, arg, pTmp );
522 #endif /* LDAP_SLAPI */
523         return LDAP_NO_MEMORY;
524 }
525
526 void
527 slapi_pblock_clear( Slapi_PBlock *pb ) 
528 {
529 #if defined(LDAP_SLAPI)
530    clearPB( pb );
531 #endif /* LDAP_SLAPI */
532 }
533
534 int 
535 slapi_pblock_delete_param( Slapi_PBlock *p, int param ) 
536 {
537 #if defined(LDAP_SLAPI)
538         return deleteParam( p, param );
539 #endif /* LDAP_SLAPI */
540         return PBLOCK_ERROR;
541 }
542
543 void
544 slapi_pblock_check_params( Slapi_PBlock *pb, int flag ) 
545 {
546 #if defined(LDAP_SLAPI)
547         checkParams( pb, flag );
548 #endif /* LDAP_SLAPI */
549 }
550
551 /*
552  * OpenLDAP extension
553  */
554 int
555 slapi_int_pblock_get_first( Backend *be, Slapi_PBlock **pb )
556 {
557 #if defined(LDAP_SLAPI)
558         assert( pb != NULL );
559         *pb = SLAPI_BACKEND_PBLOCK( be );
560         return (*pb == NULL ? LDAP_OTHER : LDAP_SUCCESS);
561 #else /* LDAP_SLAPI */
562         return LDAP_OTHER;
563 #endif /* LDAP_SLAPI */
564 }
565
566 /*
567  * OpenLDAP extension
568  */
569 int
570 slapi_int_pblock_get_next( Slapi_PBlock **pb )
571 {
572 #if defined(LDAP_SLAPI)
573         assert( pb != NULL );
574         return slapi_pblock_get( *pb, SLAPI_IBM_PBLOCK, pb );
575 #else /* LDAP_SLAPI */
576         return LDAP_OTHER;
577 #endif /* LDAP_SLAPI */
578 }
579