X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=servers%2Fslapd%2Fbackover.c;h=ddcc0233c14cb2c247507e973d82bef1a21269e9;hb=173330187ef1a4139e2e4c4fb30ad23832e40f77;hp=fed40f1cfd0c90c20d5a88f65cb638c0622f73c7;hpb=829bc9969daa744ce14b72312c4b9d3375d79904;p=openldap

diff --git a/servers/slapd/backover.c b/servers/slapd/backover.c
index fed40f1cfd..ddcc0233c1 100644
--- a/servers/slapd/backover.c
+++ b/servers/slapd/backover.c
@@ -2,7 +2,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 2003-2004 The OpenLDAP Foundation.
+ * Copyright 2003-2005 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -36,27 +36,26 @@ over_db_func(
 	enum db_which which
 )
 {
-	slap_overinfo *oi = (slap_overinfo *) be->bd_info;
+	slap_overinfo *oi = be->bd_info->bi_private;
 	slap_overinst *on = oi->oi_list;
-	BackendDB bd;
+	BackendInfo *bi_orig = be->bd_info;
 	BI_db_open **func;
 	int rc = 0;
 
-	func = &oi->oi_bd.bd_info->bi_db_open;
+	func = &oi->oi_orig->bi_db_open;
 	if ( func[which] ) {
-		rc = func[which]( &oi->oi_bd );
-		if ( rc ) return rc;
+		be->bd_info = oi->oi_orig;
+		rc = func[which]( be );
 	}
 
-	bd = *be;
-	for (; on; on=on->on_next) {
-		bd.bd_info = &on->on_bi;
+	for (; on && rc == 0; on=on->on_next) {
+		be->bd_info = &on->on_bi;
 		func = &on->on_bi.bi_db_open;
 		if (func[which]) {
-			rc = func[which]( &bd );
-			if ( rc ) break;
+			rc = func[which]( be );
 		}
 	}
+	be->bd_info = bi_orig;
 	return rc;
 }
 
@@ -69,26 +68,70 @@ over_db_config(
 	char **argv
 )
 {
-	slap_overinfo *oi = (slap_overinfo *) be->bd_info;
+	slap_overinfo *oi = be->bd_info->bi_private;
 	slap_overinst *on = oi->oi_list;
-	BackendDB bd;
+	BackendInfo *bi_orig = be->bd_info;
 	int rc = 0;
 
-	if ( oi->oi_bd.bd_info->bi_db_config ) {
-		rc = oi->oi_bd.bd_info->bi_db_config( &oi->oi_bd, fname, lineno,
+	if ( oi->oi_orig->bi_db_config ) {
+		be->bd_info = oi->oi_orig;
+		rc = oi->oi_orig->bi_db_config( be, fname, lineno,
 			argc, argv );
+
+		if ( be->bd_info != oi->oi_orig ) {
+			slap_overinfo	*oi2;
+			slap_overinst	*on2, **onp;
+			BackendDB	be2 = *be;
+			int		i;
+
+			/* a database added an overlay;
+			 * work it around... */
+			assert( overlay_is_over( be ) );
+			
+			oi2 = ( slap_overinfo * )be->bd_info->bi_private;
+			on2 = oi2->oi_list;
+
+			/* need to put a uniqueness check here as well;
+			 * note that in principle there could be more than
+			 * one overlay as a result of multiple calls to
+			 * overlay_config() */
+			be2.bd_info = (BackendInfo *)oi;
+
+			for ( i = 0, onp = &on2; *onp; i++, onp = &(*onp)->on_next ) {
+				if ( overlay_is_inst( &be2, (*onp)->on_bi.bi_type ) ) {
+					Debug( LDAP_DEBUG_ANY, "over_db_config(): "
+							"warning, freshly added "
+							"overlay #%d \"%s\" is already in list\n",
+							i, (*onp)->on_bi.bi_type, 0 );
+
+					/* NOTE: if the overlay already exists,
+					 * there is no way to merge the results
+					 * of the configuration that may have 
+					 * occurred during bi_db_config(); we
+					 * just issue a warning, and the 
+					 * administrator should deal with this */
+				}
+			}
+			*onp = oi->oi_list;
+
+			oi->oi_list = on2;
+
+			ch_free( be->bd_info );
+		}
+
+		be->bd_info = (BackendInfo *)oi;
 		if ( rc != SLAP_CONF_UNKNOWN ) return rc;
 	}
 
-	bd = *be;
 	for (; on; on=on->on_next) {
-		bd.bd_info = &on->on_bi;
 		if (on->on_bi.bi_db_config) {
-			rc = on->on_bi.bi_db_config( &bd, fname, lineno,
+			be->bd_info = &on->on_bi;
+			rc = on->on_bi.bi_db_config( be, fname, lineno,
 				argc, argv );
 			if ( rc != SLAP_CONF_UNKNOWN ) break;
 		}
 	}
+	be->bd_info = bi_orig;
 	return rc;
 }
 
@@ -105,7 +148,25 @@ over_db_close(
 	BackendDB *be
 )
 {
-	return over_db_func( be, db_close );
+	slap_overinfo *oi = be->bd_info->bi_private;
+	slap_overinst *on = oi->oi_list;
+	BackendInfo *bi_orig = be->bd_info;
+	int rc = 0;
+
+	for (; on && rc == 0; on=on->on_next) {
+		be->bd_info = &on->on_bi;
+		if ( be->bd_info->bi_db_close ) {
+			rc = be->bd_info->bi_db_close( be );
+		}
+	}
+
+	if ( oi->oi_orig->bi_db_close ) {
+		be->bd_info = oi->oi_orig;
+		rc = be->bd_info->bi_db_close( be );
+	}
+
+	be->bd_info = bi_orig;
+	return rc;
 }
 
 static int
@@ -113,7 +174,7 @@ over_db_destroy(
 	BackendDB *be
 )
 {
-	slap_overinfo *oi = (slap_overinfo *) be->bd_info;
+	slap_overinfo *oi = be->bd_info->bi_private;
 	slap_overinst *on = oi->oi_list, *next;
 	int rc;
 
@@ -135,6 +196,7 @@ over_back_response ( Operation *op, SlapReply *rs )
 	int rc = SLAP_CB_CONTINUE;
 	BackendDB *be = op->o_bd, db = *op->o_bd;
 
+	db.be_flags |= SLAP_DBFLAG_OVERLAY;
 	op->o_bd = &db;
 	for (; on; on=on->on_next ) {
 		if ( on->on_response ) {
@@ -147,9 +209,115 @@ over_back_response ( Operation *op, SlapReply *rs )
 	return rc;
 }
 
-enum op_which { op_bind = 0, op_unbind, op_search, op_compare,
-	op_modify, op_modrdn, op_add, op_delete, op_abandon,
-	op_cancel, op_extended };
+enum op_which {
+	op_bind = 0,
+	op_unbind,
+	op_search,
+	op_compare,
+	op_modify,
+	op_modrdn,
+	op_add,
+	op_delete,
+	op_abandon,
+	op_cancel,
+	op_extended,
+	op_aux_operational,
+	op_aux_chk_referrals,
+	op_aux_chk_controls,
+	op_last
+};
+
+/*
+ * default return code in case of missing backend function
+ * and overlay stack returning SLAP_CB_CONTINUE
+ */
+static int op_rc[] = {
+	LDAP_UNWILLING_TO_PERFORM,	/* bind */
+	LDAP_UNWILLING_TO_PERFORM,	/* unbind */
+	LDAP_UNWILLING_TO_PERFORM,	/* search */
+	SLAP_CB_CONTINUE,		/* compare; pass to frontend */
+	LDAP_UNWILLING_TO_PERFORM,	/* modify */
+	LDAP_UNWILLING_TO_PERFORM,	/* modrdn */
+	LDAP_UNWILLING_TO_PERFORM,	/* add */
+	LDAP_UNWILLING_TO_PERFORM,	/* delete */
+	LDAP_UNWILLING_TO_PERFORM,	/* abandon */
+	LDAP_UNWILLING_TO_PERFORM,	/* cancel */
+	LDAP_UNWILLING_TO_PERFORM,	/* extended */
+	LDAP_SUCCESS,			/* aux_operational */
+	LDAP_SUCCESS,			/* aux_chk_referrals */
+	SLAP_CB_CONTINUE		/* aux_chk_controls; pass to frontend */
+};
+
+#ifdef SLAP_OVERLAY_ACCESS
+static int
+over_access_allowed(
+	Operation		*op,
+	Entry			*e,
+	AttributeDescription	*desc,
+	struct berval		*val,
+	slap_access_t		access,
+	AccessControlState	*state,
+	slap_mask_t		*maskp )
+{
+	slap_overinfo *oi;
+	slap_overinst *on;
+	BackendInfo *bi = op->o_bd->bd_info;
+	BackendDB *be = op->o_bd, db;
+	int rc = SLAP_CB_CONTINUE;
+
+	/* FIXME: used to happen for instance during abandon
+	 * when global overlays are used... */
+	assert( op->o_bd != NULL );
+
+	oi = op->o_bd->bd_info->bi_private;
+	on = oi->oi_list;
+
+	for ( ; on; on = on->on_next ) {
+		if ( on->on_bi.bi_access_allowed ) {
+			/* NOTE: do not copy the structure until required */
+		 	if ( !SLAP_ISOVERLAY( op->o_bd ) ) {
+ 				db = *op->o_bd;
+				db.be_flags |= SLAP_DBFLAG_OVERLAY;
+				op->o_bd = &db;
+			}
+
+			op->o_bd->bd_info = (BackendInfo *)on;
+			rc = on->on_bi.bi_access_allowed( op, e,
+				desc, val, access, state, maskp );
+			if ( rc != SLAP_CB_CONTINUE ) break;
+		}
+	}
+
+	if ( rc == SLAP_CB_CONTINUE ) {
+		BI_access_allowed	*bi_access_allowed;
+
+		/* if the database structure was changed, o_bd points to a
+		 * copy of the structure; put the original bd_info in place */
+		if ( SLAP_ISOVERLAY( op->o_bd ) ) {
+			op->o_bd->bd_info = oi->oi_orig;
+		}
+
+		if ( oi->oi_orig->bi_access_allowed ) {
+			bi_access_allowed = oi->oi_orig->bi_access_allowed;
+		} else {
+			bi_access_allowed = slap_access_allowed;
+		}
+
+		rc = bi_access_allowed( op, e,
+			desc, val, access, state, maskp );
+	}
+	/* should not fall thru this far without anything happening... */
+	if ( rc == SLAP_CB_CONTINUE ) {
+		/* access not allowed */
+		rc = 0;
+	}
+
+	op->o_bd = be;
+	op->o_bd->bd_info = bi;
+
+	return rc;
+}
+#endif /* SLAP_OVERLAY_ACCESS */
 
 static int
 over_op_func(
@@ -158,14 +326,25 @@ over_op_func(
 	enum op_which which
 )
 {
-	slap_overinfo *oi = (slap_overinfo *) op->o_bd->bd_info;
-	slap_overinst *on = oi->oi_list;
+	slap_overinfo *oi;
+	slap_overinst *on;
 	BI_op_bind **func;
-	BackendDB *be = op->o_bd, db = *op->o_bd;
+	BackendDB *be = op->o_bd, db;
 	slap_callback cb = {NULL, over_back_response, NULL, NULL};
 	int rc = SLAP_CB_CONTINUE;
 
-	op->o_bd = &db;
+	/* FIXME: used to happen for instance during abandon
+	 * when global overlays are used... */
+	assert( op->o_bd != NULL );
+
+	oi = op->o_bd->bd_info->bi_private;
+	on = oi->oi_list;
+
+ 	if ( !SLAP_ISOVERLAY( op->o_bd )) {
+ 		db = *op->o_bd;
+		db.be_flags |= SLAP_DBFLAG_OVERLAY;
+		op->o_bd = &db;
+	}
 	cb.sc_next = op->o_callback;
 	cb.sc_private = oi;
 	op->o_callback = &cb;
@@ -173,21 +352,36 @@ over_op_func(
 	for (; on; on=on->on_next ) {
 		func = &on->on_bi.bi_op_bind;
 		if ( func[which] ) {
-			db.bd_info = (BackendInfo *)on;
+			op->o_bd->bd_info = (BackendInfo *)on;
 			rc = func[which]( op, rs );
 			if ( rc != SLAP_CB_CONTINUE ) break;
 		}
 	}
 
-	op->o_bd = be;
-	func = &oi->oi_bd.bd_info->bi_op_bind;
+	func = &oi->oi_orig->bi_op_bind;
 	if ( func[which] && rc == SLAP_CB_CONTINUE ) {
+		op->o_bd->bd_info = oi->oi_orig;
 		rc = func[which]( op, rs );
 	}
 	/* should not fall thru this far without anything happening... */
 	if ( rc == SLAP_CB_CONTINUE ) {
-		rc = LDAP_UNWILLING_TO_PERFORM;
+		rc = op_rc[ which ];
 	}
+
+	/* The underlying backend didn't handle the request, make sure
+	 * overlay cleanup is processed.
+	 */
+	if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
+		slap_callback *sc_next;
+		for ( ; op->o_callback && op->o_callback != cb.sc_next; 
+			op->o_callback = sc_next ) {
+			sc_next = op->o_callback->sc_next;
+			if ( op->o_callback->sc_cleanup ) {
+				op->o_callback->sc_cleanup( op, rs );
+			}
+		}
+	}
+	op->o_bd = be;
 	op->o_callback = cb.sc_next;
 	return rc;
 }
@@ -258,6 +452,68 @@ over_op_extended( Operation *op, SlapReply *rs )
 	return over_op_func( op, rs, op_extended );
 }
 
+static int
+over_aux_operational( Operation *op, SlapReply *rs )
+{
+	return over_op_func( op, rs, op_aux_operational );
+}
+
+static int
+over_aux_chk_referrals( Operation *op, SlapReply *rs )
+{
+	return over_op_func( op, rs, op_aux_chk_referrals );
+}
+
+static int
+over_aux_chk_controls( Operation *op, SlapReply *rs )
+{
+	return over_op_func( op, rs, op_aux_chk_controls );
+}
+
+static int
+over_connection_destroy(
+	BackendDB	*bd,
+	Connection	*conn
+)
+{
+	slap_overinfo *oi;
+	slap_overinst *on;
+	BackendDB db;
+	int rc = SLAP_CB_CONTINUE;
+
+	/* FIXME: used to happen for instance during abandon
+	 * when global overlays are used... */
+	assert( bd != NULL );
+
+	oi = bd->bd_info->bi_private;
+	on = oi->oi_list;
+
+ 	if ( !SLAP_ISOVERLAY( bd )) {
+ 		db = *bd;
+		db.be_flags |= SLAP_DBFLAG_OVERLAY;
+		bd = &db;
+	}
+
+	for (; on; on=on->on_next ) {
+		if ( on->on_bi.bi_connection_destroy ) {
+			bd->bd_info = (BackendInfo *)on;
+			rc = on->on_bi.bi_connection_destroy( bd, conn );
+			if ( rc != SLAP_CB_CONTINUE ) break;
+		}
+	}
+
+	if ( oi->oi_orig->bi_connection_destroy && rc == SLAP_CB_CONTINUE ) {
+		bd->bd_info = oi->oi_orig;
+		rc = oi->oi_orig->bi_connection_destroy( bd, conn );
+	}
+	/* should not fall thru this far without anything happening... */
+	if ( rc == SLAP_CB_CONTINUE ) {
+		rc = LDAP_UNWILLING_TO_PERFORM;
+	}
+
+	return rc;
+}
+
 int
 overlay_register(
 	slap_overinst *on
@@ -268,6 +524,13 @@ overlay_register(
 	return 0;
 }
 
+/*
+ * iterator on registered overlays; overlay_next( NULL ) returns the first
+ * overlay; * subsequent calls with the previously returned value allow to 
+ * iterate * over the entire list; returns NULL when no more overlays are 
+ * registered.
+ */
+
 slap_overinst *
 overlay_next(
 	slap_overinst *on
@@ -280,32 +543,133 @@ overlay_next(
 	return on->on_next;
 }
 
+/*
+ * returns a specific registered overlay based on the type; NULL if not
+ * registered.
+ */
+
+slap_overinst *
+overlay_find( const char *over_type )
+{
+	slap_overinst *on = overlays;
+
+	assert( over_type );
+
+	for ( ; on; on = on->on_next ) {
+		if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
+			break;
+		}
+	}
+
+	return on;
+}
+
 static const char overtype[] = "over";
 
+/*
+ * returns TRUE (1) if the database is actually an overlay instance;
+ * FALSE (0) otherwise.
+ */
+
+int
+overlay_is_over( BackendDB *be )
+{
+	return be->bd_info->bi_type == overtype;
+}
+
+/*
+ * returns TRUE (1) if the given database is actually an overlay
+ * instance and, somewhere in the list, contains the requested overlay;
+ * FALSE (0) otherwise.
+ */
+
+int
+overlay_is_inst( BackendDB *be, const char *over_type )
+{
+	slap_overinst	*on;
+
+	assert( be );
+
+	if ( !overlay_is_over( be ) ) {
+		return 0;
+	}
+	
+	on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
+	for ( ; on; on = on->on_next ) {
+		if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
+			return 1;
+		}
+	}
+
+	return 0;
+}
+
+int
+overlay_register_control( BackendDB *be, const char *oid )
+{
+	int		rc = 0;
+	int		gotit = 0;
+	int		cid;
+
+	if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
+		return -1;
+	}
+
+	if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
+		BackendDB *bd;
+		
+		/* add to all backends... */
+		LDAP_STAILQ_FOREACH( bd, &backendDB, be_next ) {
+			if ( be == bd ) {
+				gotit = 1;
+			}
+
+			bd->be_ctrls[ cid ] = 1;
+			bd->be_ctrls[ SLAP_MAX_CIDS ] = 1;
+		}
+
+	}
+	
+	if ( rc == 0 && !gotit ) {
+		be->be_ctrls[ cid ] = 1;
+		be->be_ctrls[ SLAP_MAX_CIDS ] = 1;
+	}
+
+	return rc;
+}
+
 /* add an overlay to a particular backend. */
 int
 overlay_config( BackendDB *be, const char *ov )
 {
-	slap_overinst *on = NULL, *on2 = NULL, *prev = NULL;
+	slap_overinst *on = NULL, *on2 = NULL;
 	slap_overinfo *oi = NULL;
 	BackendInfo *bi = NULL;
 
-	for ( on = overlays; on; on=on->on_next ) {
-		if (!strcmp( ov, on->on_bi.bi_type ) )
-			break;
-	}
-	if (!on) {
-		Debug( LDAP_DEBUG_ANY, "overlay %s not found\n", ov, 0, 0 );
+	on = overlay_find( ov );
+	if ( !on ) {
+		Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
 		return 1;
 	}
 
 	/* If this is the first overlay on this backend, set up the
 	 * overlay info structure
 	 */
-	if ( be->bd_info->bi_type != overtype ) {
-		oi = ch_malloc( sizeof(slap_overinfo) );
-		oi->oi_bd = *be;
+	if ( !overlay_is_over( be ) ) {
+		oi = ch_malloc( sizeof( slap_overinfo ) );
+		oi->oi_orig = be->bd_info;
 		oi->oi_bi = *be->bd_info;
+
+		/* NOTE: the first time a global overlay is configured,
+		 * frontendDB gets this flag; it is used later by overlays
+		 * to determine if they're stacked on top of the frontendDB */
+		if ( oi->oi_orig == frontendDB->bd_info ) {
+			SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
+		}
+
+		/* Save a pointer to ourself in bi_private.
+		 */
+		oi->oi_bi.bi_private = oi;
 		oi->oi_list = NULL;
 		bi = (BackendInfo *)oi;
 
@@ -326,29 +690,38 @@ overlay_config( BackendDB *be, const char *ov )
 		bi->bi_op_delete = over_op_delete;
 		bi->bi_op_abandon = over_op_abandon;
 		bi->bi_op_cancel = over_op_cancel;
+
 		bi->bi_extended = over_op_extended;
 
+		/*
+		 * this is fine because it has the same
+		 * args of the operations; we need to rework
+		 * all the hooks to share the same args
+		 * of the operations...
+		 */
+		bi->bi_operational = over_aux_operational;
+		bi->bi_chk_referrals = over_aux_chk_referrals;
+		bi->bi_chk_controls = over_aux_chk_controls;
+
+#ifdef SLAP_OVERLAY_ACCESS
+		/* this has a specific arglist */
+		bi->bi_access_allowed = over_access_allowed;
+#endif /* SLAP_OVERLAY_ACCESS */
+		
+		bi->bi_connection_destroy = over_connection_destroy;
+
 		be->bd_info = bi;
 
 	} else {
-		oi = (slap_overinfo *) be->bd_info;
-	}
+		if ( overlay_is_inst( be, ov ) ) {
+			Debug( LDAP_DEBUG_ANY, "overlay_config(): "
+					"warning, overlay \"%s\" "
+					"already in list\n", ov, 0, 0 );
+		}
 
-#if 0
-	/* Walk to the end of the list of overlays, add the new
-	 * one onto the end
-	 */
-	for ( prev=NULL, on2 = oi->oi_list; on2; prev=on2, on2=on2->on_next );
-	on2 = ch_calloc( 1, sizeof(slap_overinst) );
-	if ( !prev ) {
-		oi->oi_list = on2;
-	} else {
-		prev->on_next = on2;
+		oi = be->bd_info->bi_private;
 	}
-	*on2 = *on;
-	on2->on_next = NULL;
-	on2->on_info = oi;
-#else
+
 	/* Insert new overlay on head of list. Overlays are executed
 	 * in reverse of config order...
 	 */
@@ -357,13 +730,14 @@ overlay_config( BackendDB *be, const char *ov )
 	on2->on_info = oi;
 	on2->on_next = oi->oi_list;
 	oi->oi_list = on2;
-#endif
 
 	/* Any initialization needed? */
 	if ( on->on_bi.bi_db_init ) {
+		int rc;
 		be->bd_info = (BackendInfo *)on2;
-		on2->on_bi.bi_db_init( be );
+		rc = on2->on_bi.bi_db_init( be );
 		be->bd_info = (BackendInfo *)oi;
+		if ( rc ) return rc;
 	}
 
 	return 0;