s4-dsdb: move dsdb_request_add_controls() into dsdb/common/util.c

This will be used to allow the flag based ldb functions to work on
both a ldb or a module, thus saving a lot of specialist functions.

6 files changed, 115 insertions, 85 deletions

diff --git a/source4/dsdb/common/util.c b/source4/dsdb/common/util.c
index eb021dfc94..dab46f01e5 100644
--- a/source4/dsdb/common/util.c
+++ b/source4/dsdb/common/util.c
@@ -39,6 +39,7 @@
 #include "librpc/gen_ndr/ndr_drsblobs.h"
 #include "system/locale.h"
 #include "lib/util/tsort.h"
+#include "dsdb/common/util.h"
 
 /*
   search the sam for the specified attributes in a specific domain, filter on
@@ -3396,3 +3397,73 @@ int dsdb_modify_permissive(struct ldb_context *ldb,
 	talloc_free(req);
 	return ret;
 }
+
+
+
+/*
+  add a set of controls to a ldb_request structure based on a set of
+  flags. See util.h for a list of available flags
+ */
+int dsdb_request_add_controls(struct ldb_request *req, uint32_t dsdb_flags)
+{
+	int ret;
+	if (dsdb_flags & DSDB_SEARCH_SEARCH_ALL_PARTITIONS) {
+		struct ldb_search_options_control *options;
+		/* Using the phantom root control allows us to search all partitions */
+		options = talloc(req, struct ldb_search_options_control);
+		if (options == NULL) {
+			return LDB_ERR_OPERATIONS_ERROR;
+		}
+		options->search_options = LDB_SEARCH_OPTION_PHANTOM_ROOT;
+
+		ret = ldb_request_add_control(req,
+					      LDB_CONTROL_SEARCH_OPTIONS_OID,
+					      true, options);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	if (dsdb_flags & DSDB_SEARCH_SHOW_DELETED) {
+		ret = ldb_request_add_control(req, LDB_CONTROL_SHOW_DELETED_OID, true, NULL);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	if (dsdb_flags & DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT) {
+		ret = ldb_request_add_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID, true, NULL);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	if (dsdb_flags & DSDB_SEARCH_SHOW_EXTENDED_DN) {
+		struct ldb_extended_dn_control *extended_ctrl = talloc(req, struct ldb_extended_dn_control);
+		if (!extended_ctrl) {
+			return LDB_ERR_OPERATIONS_ERROR;
+		}
+		extended_ctrl->type = 1;
+
+		ret = ldb_request_add_control(req, LDB_CONTROL_EXTENDED_DN_OID, true, extended_ctrl);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	if (dsdb_flags & DSDB_SEARCH_REVEAL_INTERNALS) {
+		ret = ldb_request_add_control(req, LDB_CONTROL_REVEAL_INTERNALS, false, NULL);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	if (dsdb_flags & DSDB_MODIFY_RELAX) {
+		ret = ldb_request_add_control(req, LDB_CONTROL_RELAX_OID, false, NULL);
+		if (ret != LDB_SUCCESS) {
+			return ret;
+		}
+	}
+
+	return LDB_SUCCESS;
+}
diff --git a/source4/dsdb/common/util.h b/source4/dsdb/common/util.h
new file mode 100644
index 0000000000..9152ac4220
--- /dev/null
+++ b/source4/dsdb/common/util.h
@@ -0,0 +1,31 @@
+/*
+   Unix SMB/CIFS implementation.
+   Samba utility functions
+
+   Copyright (C) Andrew Tridgell 2010
+   Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*
+   flags for dsdb_request_add_controls(). For the module functions,
+   the upper 16 bits are in dsdb/samdb/ldb_modules/util.h
+*/
+#define DSDB_SEARCH_SEARCH_ALL_PARTITIONS     0x0001
+#define DSDB_SEARCH_SHOW_DELETED              0x0002
+#define DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT 0x0004
+#define DSDB_SEARCH_REVEAL_INTERNALS          0x0008
+#define DSDB_SEARCH_SHOW_EXTENDED_DN          0x0010
+#define DSDB_MODIFY_RELAX		      0x0020
diff --git a/source4/dsdb/samdb/ldb_modules/extended_dn_store.c b/source4/dsdb/samdb/ldb_modules/extended_dn_store.c
index 0b9a105be6..3c4c171c19 100644
--- a/source4/dsdb/samdb/ldb_modules/extended_dn_store.c
+++ b/source4/dsdb/samdb/ldb_modules/extended_dn_store.c
@@ -275,7 +275,7 @@ static int extended_store_replace(struct extended_dn_context *ac,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(ac->module, os->search_req,
+	ret = dsdb_request_add_controls(os->search_req,
 					DSDB_SEARCH_SHOW_DELETED|DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(os);
diff --git a/source4/dsdb/samdb/ldb_modules/samldb.c b/source4/dsdb/samdb/ldb_modules/samldb.c
index ccf76aaef2..9d79776e66 100644
--- a/source4/dsdb/samdb/ldb_modules/samldb.c
+++ b/source4/dsdb/samdb/ldb_modules/samldb.c
@@ -680,7 +680,7 @@ static int samldb_find_for_defaultObjectCategory(struct samldb_ctx *ac)
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(ac->module, req,
+	ret = dsdb_request_add_controls(req,
 					DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT);
 	if (ret != LDB_SUCCESS) {
 		return ret;
diff --git a/source4/dsdb/samdb/ldb_modules/util.c b/source4/dsdb/samdb/ldb_modules/util.c
index 46252cb279..d3c58568ac 100644
--- a/source4/dsdb/samdb/ldb_modules/util.c
+++ b/source4/dsdb/samdb/ldb_modules/util.c
@@ -29,76 +29,6 @@
 #include "libcli/security/security.h"
 
 /*
-  add a set of controls to a ldb_request structure based on a set of
-  flags. See util.h for a list of available flags
- */
-int dsdb_request_add_controls(struct ldb_module *module, struct ldb_request *req, uint32_t dsdb_flags)
-{
-	int ret;
-	if (dsdb_flags & DSDB_SEARCH_SEARCH_ALL_PARTITIONS) {
-		struct ldb_search_options_control *options;
-		/* Using the phantom root control allows us to search all partitions */
-		options = talloc(req, struct ldb_search_options_control);
-		if (options == NULL) {
-			ldb_module_oom(module);
-			return LDB_ERR_OPERATIONS_ERROR;
-		}
-		options->search_options = LDB_SEARCH_OPTION_PHANTOM_ROOT;
-		
-		ret = ldb_request_add_control(req,
-					      LDB_CONTROL_SEARCH_OPTIONS_OID,
-					      true, options);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	if (dsdb_flags & DSDB_SEARCH_SHOW_DELETED) {
-		ret = ldb_request_add_control(req, LDB_CONTROL_SHOW_DELETED_OID, true, NULL);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	if (dsdb_flags & DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT) {
-		ret = ldb_request_add_control(req, DSDB_CONTROL_DN_STORAGE_FORMAT_OID, true, NULL);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	if (dsdb_flags & DSDB_SEARCH_SHOW_EXTENDED_DN) {
-		struct ldb_extended_dn_control *extended_ctrl = talloc(req, struct ldb_extended_dn_control);
-		if (!extended_ctrl) {
-			ldb_module_oom(module);
-			return LDB_ERR_OPERATIONS_ERROR;
-		}
-		extended_ctrl->type = 1;
-		
-		ret = ldb_request_add_control(req, LDB_CONTROL_EXTENDED_DN_OID, true, extended_ctrl);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	if (dsdb_flags & DSDB_SEARCH_REVEAL_INTERNALS) {
-		ret = ldb_request_add_control(req, LDB_CONTROL_REVEAL_INTERNALS, false, NULL);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	if (dsdb_flags & DSDB_MODIFY_RELAX) {
-		ret = ldb_request_add_control(req, LDB_CONTROL_RELAX_OID, false, NULL);
-		if (ret != LDB_SUCCESS) {
-			return ret;
-		}
-	}
-
-	return LDB_SUCCESS;
-}
-
-/*
   search for attrs on one DN, in the modules below
  */
 int dsdb_module_search_dn(struct ldb_module *module,
@@ -134,7 +64,7 @@ int dsdb_module_search_dn(struct ldb_module *module,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(module, req, dsdb_flags);
+	ret = dsdb_request_add_controls(req, dsdb_flags);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(tmp_ctx);
 		return ret;
@@ -206,7 +136,7 @@ int dsdb_module_search(struct ldb_module *module,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(module, req, dsdb_flags);
+	ret = dsdb_request_add_controls(req, dsdb_flags);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(tmp_ctx);
 		return ret;
@@ -325,7 +255,7 @@ int dsdb_module_modify(struct ldb_module *module,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(module, mod_req, dsdb_flags);
+	ret = dsdb_request_add_controls(mod_req, dsdb_flags);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(tmp_ctx);
 		return ret;
@@ -375,7 +305,7 @@ int dsdb_module_rename(struct ldb_module *module,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(module, req, dsdb_flags);
+	ret = dsdb_request_add_controls(req, dsdb_flags);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(tmp_ctx);
 		return ret;
@@ -422,7 +352,7 @@ int dsdb_module_add(struct ldb_module *module,
 		return ret;
 	}
 
-	ret = dsdb_request_add_controls(module, req, dsdb_flags);
+	ret = dsdb_request_add_controls(req, dsdb_flags);
 	if (ret != LDB_SUCCESS) {
 		talloc_free(tmp_ctx);
 		return ret;
diff --git a/source4/dsdb/samdb/ldb_modules/util.h b/source4/dsdb/samdb/ldb_modules/util.h
index 53ed9bd48e..9ba2e33f56 100644
--- a/source4/dsdb/samdb/ldb_modules/util.h
+++ b/source4/dsdb/samdb/ldb_modules/util.h
@@ -26,12 +26,10 @@ struct dsdb_attribute;
 struct dsdb_fsmo_extended_op;
 
 #include "dsdb/samdb/ldb_modules/util_proto.h"
+#include "dsdb/common/util.h"
+
+/* extend the dsdb_request_add_controls() flags for module
+   specific functions */
+#define DSDB_FLAG_OWN_MODULE		      0x00400000
+#define DSDB_FLAG_TOP_MODULE		      0x00800000
 
-#define DSDB_SEARCH_SEARCH_ALL_PARTITIONS     0x0001
-#define DSDB_SEARCH_SHOW_DELETED              0x0002
-#define DSDB_SEARCH_SHOW_DN_IN_STORAGE_FORMAT 0x0004
-#define DSDB_SEARCH_REVEAL_INTERNALS          0x0008
-#define DSDB_SEARCH_SHOW_EXTENDED_DN          0x0010
-#define DSDB_MODIFY_RELAX		      0x0020
-#define DSDB_FLAG_OWN_MODULE		      0x0040
-#define DSDB_FLAG_TOP_MODULE		      0x0080