]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/search.c
Ensure that global plugins are called after backend-specific plugins
[openldap] / servers / slapd / search.c
index fada8cb8cdec9f3bebfc1fe3831aade9efb4693a..720992c58b2e14f3792ffae16b837475651bdb78 100644 (file)
@@ -1,6 +1,6 @@
 /* $OpenLDAP$ */
 /*
- * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 /* Portions
@@ -16,6 +16,7 @@
  */
 
 #include "portable.h"
+#include "slapi_common.h"
 
 #include <stdio.h>
 
 #include <ac/socket.h>
 
 #include "ldap_pvt.h"
+#include "lutil.h"
 #include "slap.h"
+#include "slapi.h"
+
+#ifdef LDAP_SLAPI
+static char **anlist2charray( AttributeName *an );
+static Slapi_PBlock *initSearchPlugin( Backend *be, Connection *conn, Operation *op,
+       struct berval *base, int scope, int deref, int sizelimit, int timelimit,
+       Filter *filter, struct berval *fstr, char **attrs,
+       int attrsonly, int managedsait );
+static int doPreSearchPluginFNs( Backend *be, Slapi_PBlock *pb );
+static int doSearchRewriteFNs( Backend *be, Slapi_PBlock *pb, Filter **filter, struct berval *fstr );
+static int doPostSearchPluginFNs( Backend *be, Slapi_PBlock *pb );
+#endif /* LDAPI_SLAPI */
 
 int
 do_search(
@@ -43,6 +57,10 @@ do_search(
        int                     rc;
        const char      *text;
        int                     manageDSAit;
+#ifdef LDAP_SLAPI
+       Slapi_PBlock    *pb = NULL;
+       char            **attrs = NULL;
+#endif
 
 #ifdef NEW_LOGGING
        LDAP_LOG( OPERATION, ENTRY, "do_search: conn %d\n", conn->c_connid, 0, 0 );
@@ -209,9 +227,33 @@ do_search(
        Debug( LDAP_DEBUG_ARGS, "\n", 0, 0, 0 );
 #endif
 
-       Statslog( LDAP_DEBUG_STATS,
-           "conn=%lu op=%lu SRCH base=\"%s\" scope=%d filter=\"%s\"\n",
-           op->o_connid, op->o_opid, pbase.bv_val, scope, fstr.bv_val );
+       if ( StatslogTest( LDAP_DEBUG_STATS ) ) {
+               char abuf[BUFSIZ/2], *ptr = abuf;
+               int len = 0;
+
+               Statslog( LDAP_DEBUG_STATS,
+                       "conn=%lu op=%lu SRCH base=\"%s\" scope=%d filter=\"%s\"\n",
+                       op->o_connid, op->o_opid, pbase.bv_val, scope, fstr.bv_val );
+
+               for ( i = 0; i<siz; i++ ) {
+                       if (len + 1 + an[i].an_name.bv_len > sizeof(abuf)) {
+                               Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
+                                   op->o_connid, op->o_opid, abuf, 0, 0 );
+                               len = 0;
+                               ptr = abuf;
+                       }
+                       if (len) {
+                               *ptr++ = ' ';
+                               len++;
+                       }
+                       ptr = lutil_strcopy(ptr, an[i].an_name.bv_val);
+                       len += an[i].an_name.bv_len;
+               }
+               if (len) {
+                       Statslog( LDAP_DEBUG_STATS, "conn=%lu op=%lu SRCH attr=%s\n",
+                               op->o_connid, op->o_opid, abuf, 0, 0 );
+               }
+       }
 
        manageDSAit = get_manageDSAit( op );
 
@@ -221,7 +263,7 @@ do_search(
                if ( nbase.bv_len == 0 ) {
 #ifdef LDAP_CONNECTIONLESS
                        /* Ignore LDAPv2 CLDAP Root DSE queries */
-                       if (op->o_protocol==LDAP_VERSION2 && conn->c_is_udp) {
+                       if (op->o_protocol == LDAP_VERSION2 && conn->c_is_udp) {
                                goto return_results;
                        }
 #endif
@@ -233,11 +275,21 @@ do_search(
                                goto return_results;
                        }
 
+#ifdef LDAP_SLAPI
+                       attrs = anlist2charray( an );
+                       pb = initSearchPlugin( NULL, conn, op, &nbase, scope,
+                               deref, sizelimit, timelimit, filter, &fstr,
+                               attrs, attrsonly, manageDSAit );
+                       rc = doPreSearchPluginFNs( NULL, pb );
+                       if ( rc == LDAP_SUCCESS ) {
+                               doSearchRewriteFNs( NULL, pb, &filter, &fstr );
+#endif /* LDAP_SLAPI */
                        rc = root_dse_info( conn, &entry, &text );
-               }
+#ifdef LDAP_SLAPI
+                       }
+#endif /* LDAP_SLAPI */
 
-#if defined( SLAPD_SCHEMA_DN )
-               else if ( bvmatch( &nbase, &global_schemandn ) ) {
+               } else if ( bvmatch( &nbase, &global_schemandn ) ) {
                        /* check restrictions */
                        rc = backend_check_restrictions( NULL, conn, op, NULL, &text ) ;
                        if( rc != LDAP_SUCCESS ) {
@@ -246,13 +298,27 @@ do_search(
                                goto return_results;
                        }
 
+#ifdef LDAP_SLAPI
+                       attrs = anlist2charray( an );
+                       pb = initSearchPlugin( NULL, conn, op, &nbase, scope,
+                               deref, sizelimit, timelimit, filter, &fstr,
+                               attrs, attrsonly, manageDSAit );
+                       rc = doPreSearchPluginFNs( NULL, pb );
+                       if ( rc == LDAP_SUCCESS ) {
+                               doSearchRewriteFNs( NULL, pb, &filter, &fstr );
+#endif /* LDAP_SLAPI */
                        rc = schema_info( &entry, &text );
+#ifdef LDAP_SLAPI
+                       }
+#endif /* LDAP_SLAPI */
                }
-#endif
 
                if( rc != LDAP_SUCCESS ) {
                        send_ldap_result( conn, op, rc,
                                NULL, text, NULL, NULL );
+#ifdef LDAP_SLAPI
+                       doPostSearchPluginFNs( NULL, pb );
+#endif /* LDAP_SLAPI */
                        goto return_results;
 
                } else if ( entry != NULL ) {
@@ -267,7 +333,9 @@ do_search(
 
                        send_ldap_result( conn, op, LDAP_SUCCESS,
                                NULL, NULL, NULL, NULL );
-
+#ifdef LDAP_SLAPI
+                       doPostSearchPluginFNs( NULL, pb );
+#endif /* LDAP_SLAPI */
                        goto return_results;
                }
        }
@@ -313,6 +381,20 @@ do_search(
        /* deref the base if needed */
        suffix_alias( be, &nbase );
 
+#ifdef LDAP_SLAPI
+       attrs = anlist2charray( an );
+       pb = initSearchPlugin( be, conn, op, &pbase,
+               scope, deref, sizelimit,
+               timelimit, filter, &fstr, attrs, attrsonly,
+               manageDSAit );
+       rc = doPreSearchPluginFNs( be, pb );
+       if ( rc != LDAP_SUCCESS ) {
+               goto return_results;
+       }
+
+       doSearchRewriteFNs( be, pb, &filter, &fstr );
+#endif /* LDAP_SLAPI */
+
        /* actually do the search and send the result(s) */
        if ( be->be_search ) {
                (*be->be_search)( be, conn, op, &pbase, &nbase,
@@ -324,13 +406,149 @@ do_search(
                        NULL, NULL );
        }
 
+#ifdef LDAP_SLAPI
+       doPostSearchPluginFNs( be, pb );
+#endif /* LDAP_SLAPI */
+
 return_results:;
-       if( pbase.bv_val != NULL) free( pbase.bv_val );
-       if( nbase.bv_val != NULL) free( nbase.bv_val );
+#ifdef LDAP_CLIENT_UPDATE
+       if ( !( op->o_clientupdate_type & SLAP_LCUP_PERSIST ) )
+#endif /* LDAP_CLIENT_UPDATE */
+       {
+               if( pbase.bv_val != NULL) free( pbase.bv_val );
+               if( nbase.bv_val != NULL) free( nbase.bv_val );
+
+               if( fstr.bv_val != NULL) free( fstr.bv_val );
+               if( filter != NULL) filter_free( filter );
+               if( an != NULL ) free( an );
+#ifdef LDAP_SLAPI
+               if( attrs != NULL) ch_free( attrs );
+#endif /* LDAP_SLAPI */
+       }
+
+       return rc;
+}
+
+#ifdef LDAP_SLAPI
+
+static char **anlist2charray( AttributeName *an )
+{
+       char **attrs;
+       int i;
+
+       if ( an != NULL ) {
+               for ( i = 0; an[i].an_name.bv_val != NULL; i++ )
+                       ;
+               attrs = (char **)ch_malloc( (i + 1) * sizeof(char *) );
+               for ( i = 0; an[i].an_name.bv_val != NULL; i++ ) {
+                       attrs[i] = an[i].an_name.bv_val;
+               }
+               attrs[i] = NULL;
+       } else {
+               attrs = NULL;
+       }
+
+       return attrs;
+}
+
+static Slapi_PBlock *initSearchPlugin( Backend *be, Connection *conn, Operation *op,
+       struct berval *base, int scope, int deref, int sizelimit,
+       int timelimit, Filter *filter, struct berval *fstr,
+       char **attrs, int attrsonly, int managedsait )
+{
+       Slapi_PBlock *pb;
+
+       pb = op->o_pb;
+
+       slapi_x_backend_set_pb( pb, be );
+       slapi_x_connection_set_pb( pb, conn );
+       slapi_x_operation_set_pb( pb, op );
+       slapi_pblock_set( pb, SLAPI_SEARCH_TARGET, (void *)base->bv_val );
+       slapi_pblock_set( pb, SLAPI_SEARCH_SCOPE, (void *)scope );
+       slapi_pblock_set( pb, SLAPI_SEARCH_DEREF, (void *)deref );
+       slapi_pblock_set( pb, SLAPI_SEARCH_SIZELIMIT, (void *)sizelimit );
+       slapi_pblock_set( pb, SLAPI_SEARCH_TIMELIMIT, (void *)timelimit );
+       slapi_pblock_set( pb, SLAPI_SEARCH_FILTER, (void *)filter );
+       slapi_pblock_set( pb, SLAPI_SEARCH_STRFILTER, (void *)fstr->bv_val );
+       slapi_pblock_set( pb, SLAPI_SEARCH_ATTRS, (void *)attrs );
+       slapi_pblock_set( pb, SLAPI_SEARCH_ATTRSONLY, (void *)attrsonly );
+       slapi_pblock_set( pb, SLAPI_MANAGEDSAIT, (void *)managedsait );
+
+       return pb;
+}
 
-       if( fstr.bv_val != NULL) free( fstr.bv_val );
-       if( filter != NULL) filter_free( filter );
-       if( an != NULL ) free( an );
+static int doPreSearchPluginFNs( Backend *be, Slapi_PBlock *pb )
+{
+       int rc;
+
+       rc = doPluginFNs( be, SLAPI_PLUGIN_PRE_SEARCH_FN, pb );
+       if ( rc != 0 ) {
+               /*
+                * A preoperation plugin failure will abort the
+                * entire operation.
+                */
+#ifdef NEW_LOGGING
+               LDAP_LOG( OPERATION, INFO, "doPreSearchPluginFNs: search preoperation plugin "
+                               "returned %d\n", rc, 0, 0 );
+#else
+               Debug(LDAP_DEBUG_TRACE, "doPreSearchPluginFNs: search preoperation plugin "
+                               "returned %d.\n", rc, 0, 0);
+#endif
+               if ( slapi_pblock_get( pb, SLAPI_RESULT_CODE, (void *)&rc ) != 0)
+                       rc = LDAP_OTHER;
+       } else {
+               rc = LDAP_SUCCESS;
+       }
 
        return rc;
 }
+
+static int doSearchRewriteFNs( Backend *be, Slapi_PBlock *pb, Filter **filter, struct berval *fstr )
+{
+       if ( doPluginFNs( be, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, pb ) == 0 ) {
+               /*
+                * The plugin can set the SLAPI_SEARCH_FILTER.
+                * SLAPI_SEARCH_STRFILER is not normative.
+                */
+               slapi_pblock_get( pb, SLAPI_SEARCH_FILTER, (void *)filter);
+               ch_free( fstr->bv_val );
+               filter2bv( *filter, fstr );
+#ifdef NEW_LOGGING
+               LDAP_LOG( OPERATION, ARGS, 
+                       "doSearchRewriteFNs: after compute_rewrite_search filter: %s\n", 
+                       fstr->bv_len ? fstr->bv_val : "empty", 0, 0 );
+#else
+               Debug( LDAP_DEBUG_ARGS, "    after compute_rewrite_search filter: %s\n",
+                       fstr->bv_len ? fstr->bv_val : "empty", 0, 0 );
+#endif
+       }
+
+       return LDAP_SUCCESS;
+}
+
+static int doPostSearchPluginFNs( Backend *be, Slapi_PBlock *pb )
+{
+       if ( doPluginFNs( be, SLAPI_PLUGIN_POST_SEARCH_FN, pb ) != 0 ) {
+#ifdef NEW_LOGGING
+               LDAP_LOG( OPERATION, INFO, "doPostSearchPluginFNs: search postoperation plugins "
+                               "failed\n", 0, 0, 0 );
+#else
+               Debug(LDAP_DEBUG_TRACE, "doPostSearchPluginFNs: search postoperation plugins "
+                               "failed.\n", 0, 0, 0);
+#endif
+       }
+
+       return LDAP_SUCCESS;
+}
+
+void dummy(void)
+{
+       /*
+        * XXX slapi_search_internal() was no getting pulled
+        * in; all manner of linker flags failed to link it.
+        * FIXME
+        */
+       slapi_search_internal( NULL, 0, NULL, NULL, NULL, 0 );
+}
+#endif /* LDAP_SLAPI */
+