r12534: Make the transaction code fill the error string on failure.
[samba.git] / source4 / lib / ldb / common / ldb.c
index 450fa75d8e536e4ec01db726e687dd1c38aad16b..6095f4fc04ce2a7efea971a8f31857083b5012ad 100644 (file)
@@ -34,6 +34,7 @@
 
 #include "includes.h"
 #include "ldb/include/ldb.h"
+#include "ldb/include/ldb_errors.h"
 #include "ldb/include/ldb_private.h"
 
 /* 
 struct ldb_context *ldb_init(void *mem_ctx)
 {
        struct ldb_context *ldb = talloc_zero(mem_ctx, struct ldb_context);
+       int ret;
+
+       ret = ldb_setup_wellknown_attributes(ldb);
+       if (ret != 0) {
+               talloc_free(ldb);
+               return NULL;
+       }
+
        return ldb;
 }
 
@@ -76,42 +85,194 @@ int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, co
 #endif
 #if HAVE_SQLITE3
        else if (strncmp(url, "sqlite:", 7) == 0) {
-               ldb_ctx = lsqlite3_connect(url, flags, options);
+                ret = lsqlite3_connect(ldb, url, flags, options);
        }
 #endif
        else {
-               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to find backend for '%s'", url);
-               return -1;
+               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to find backend for '%s'\n", url);
+               return LDB_ERR_OTHER;
        }
 
-       if (ret != 0) {
-               ldb_debug(ldb, LDB_DEBUG_ERROR, "Failed to connect to '%s'", url);
+       if (ret != LDB_SUCCESS) {
+               ldb_debug(ldb, LDB_DEBUG_ERROR, "Failed to connect to '%s'\n", url);
                return ret;
        }
 
-       if (ldb_load_modules(ldb, options) != 0) {
-               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for '%s'", url);
-               return -1;
+       if (ldb_load_modules(ldb, options) != LDB_SUCCESS) {
+               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for '%s'\n", url);
+               return LDB_ERR_OTHER;
        }
 
-       return 0;
+       return LDB_SUCCESS;
 }
 
+static void ldb_reset_err_string(struct ldb_context *ldb)
+{
+       if (ldb->err_string) {
+               talloc_free(ldb->err_string);
+               ldb->err_string = NULL;
+       }
+}
+
+#define FIRST_OP(ldb, op) do { \
+       module = ldb->modules; \
+       while (module && module->ops->op == NULL) module = module->next; \
+       if (module == NULL) return -1; \
+} while (0)
+
 /*
-  search the database given a LDAP-like search expression
+  start a transaction
+*/
+int ldb_transaction_start(struct ldb_context *ldb)
+{
+       struct ldb_module *module;
+       int status;
+       FIRST_OP(ldb, start_transaction);
+       
+       ldb->transaction_active++;
 
-  return the number of records found, or -1 on error
+       ldb_reset_err_string(ldb);
 
-  Use talloc_free to free the ldb_message returned in 'res'
+       status = module->ops->start_transaction(module);
+       if (status != LDB_SUCCESS) {
+               if (ldb->err_string == NULL) {
+                       /* no error string was setup by the backend */
+                       ldb_set_errstring(ldb->modules, 
+                                         talloc_asprintf(ldb, "ldb transaction start error %d", status));
+               }
+       }
+       return status;
+}
 
+/*
+  commit a transaction
 */
-int ldb_search(struct ldb_context *ldb, 
-              const char *base,
-              enum ldb_scope scope,
-              const char *expression,
-              const char * const *attrs, struct ldb_message ***res)
+int ldb_transaction_commit(struct ldb_context *ldb)
 {
-       return ldb->modules->ops->search(ldb->modules, base, scope, expression, attrs, res);
+       struct ldb_module *module;
+       int status;
+       FIRST_OP(ldb, end_transaction);
+
+       if (ldb->transaction_active > 0) {
+               ldb->transaction_active--;
+       } else {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       ldb_reset_err_string(ldb);
+
+       status = module->ops->end_transaction(module);
+       if (status != LDB_SUCCESS) {
+               if (ldb->err_string == NULL) {
+                       /* no error string was setup by the backend */
+                       ldb_set_errstring(ldb->modules, 
+                                         talloc_asprintf(ldb, "ldb transaction commit error %d", status));
+               }
+       }
+       return status;
+}
+
+/*
+  cancel a transaction
+*/
+int ldb_transaction_cancel(struct ldb_context *ldb)
+{
+       struct ldb_module *module;
+       int status;
+       FIRST_OP(ldb, del_transaction);
+
+       if (ldb->transaction_active > 0) {
+               ldb->transaction_active--;
+       } else {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       status = module->ops->del_transaction(module);
+       if (status != LDB_SUCCESS) {
+               if (ldb->err_string == NULL) {
+                       /* no error string was setup by the backend */
+                       ldb_set_errstring(ldb->modules, 
+                                         talloc_asprintf(ldb, "ldb transaction cancel error %d", status));
+               }
+       }
+       return status;
+}
+
+/*
+  check for an error return from an op 
+  if an op fails, but has not setup an error string, then setup one now
+*/
+static int ldb_op_finish(struct ldb_context *ldb, int status)
+{
+       if (status == LDB_SUCCESS) {
+               return ldb_transaction_commit(ldb);
+       }
+       if (ldb->err_string == NULL) {
+               /* no error string was setup by the backend */
+               ldb_set_errstring(ldb->modules, 
+                                 talloc_asprintf(ldb, "ldb error %d", status));
+       }
+       ldb_transaction_cancel(ldb);
+       return status;
+}
+
+/*
+  start an ldb request
+  autostarts a transacion if none active and the operation is not a search
+  returns LDB_ERR_* on errors.
+*/
+int ldb_request(struct ldb_context *ldb, struct ldb_request *request)
+{
+       int status, started_transaction=0;
+       struct ldb_request *r;
+
+       ldb_reset_err_string(ldb);
+
+       /* to allow ldb modules to assume they can use the request ptr
+          as a talloc context for the request, we have to copy the 
+          structure here */
+       r = talloc(ldb, struct ldb_request);
+       if (r == NULL) {
+               ldb_oom(ldb);
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       *r = *request;
+
+       if (r->operation == LDB_REQ_SEARCH) {
+               r->op.search.res = NULL;
+       }
+
+       /* start a transaction if needed */
+       if ((!ldb->transaction_active) &&
+           (request->operation == LDB_REQ_ADD ||
+            request->operation == LDB_REQ_MODIFY ||
+            request->operation == LDB_REQ_DELETE ||
+            request->operation == LDB_REQ_RENAME)) {
+               status = ldb_transaction_start(ldb);
+               if (status != LDB_SUCCESS) {
+                       talloc_free(r);
+                       return status;
+               }
+               started_transaction = 1;
+       }
+
+       /* call the first module in the chain */
+       status = ldb->modules->ops->request(ldb->modules, r);
+
+       /* the search call is the only one that returns something
+          other than a status code. We steal the results into
+          the context of the ldb before freeing the request */
+       if (request->operation == LDB_REQ_SEARCH) {
+               request->op.search.res = talloc_steal(ldb, r->op.search.res);
+       }
+       talloc_free(r);
+
+       if (started_transaction) {
+               return ldb_op_finish(ldb, status);
+       }
+
+       return status;
 }
 
 /*
@@ -122,13 +283,38 @@ int ldb_search(struct ldb_context *ldb,
   Use talloc_free to free the ldb_message returned in 'res'
 
 */
-int ldb_search_bytree(struct ldb_context *ldb, 
-                     const char *base,
-                     enum ldb_scope scope,
-                     struct ldb_parse_tree *tree,
-                     const char * const *attrs, struct ldb_message ***res)
+int ldb_search(struct ldb_context *ldb, 
+              const struct ldb_dn *base,
+              enum ldb_scope scope,
+              const char *expression,
+              const char * const *attrs, 
+              struct ldb_result **res)
 {
-       return ldb->modules->ops->search_bytree(ldb->modules, base, scope, tree, attrs, res);
+       struct ldb_request request;
+       struct ldb_parse_tree *tree;
+       int ret;
+
+       (*res) = NULL;
+
+       tree = ldb_parse_tree(ldb, expression);
+       if (tree == NULL) {
+               ldb_set_errstring(ldb->modules, talloc_strdup(ldb, "Unable to parse search expression"));
+               return -1;
+       }
+
+       request.operation = LDB_REQ_SEARCH;
+       request.op.search.base = base;
+       request.op.search.scope = scope;
+       request.op.search.tree = tree;
+       request.op.search.attrs = attrs;
+
+       ret = ldb_request(ldb, &request);
+
+       (*res) = request.op.search.res;
+
+       talloc_free(tree);
+
+       return ret;
 }
 
 /*
@@ -138,7 +324,16 @@ int ldb_search_bytree(struct ldb_context *ldb,
 int ldb_add(struct ldb_context *ldb, 
            const struct ldb_message *message)
 {
-       return ldb->modules->ops->add_record(ldb->modules, message);
+       struct ldb_request request;
+       int status;
+
+       status = ldb_msg_sanity_check(message);
+       if (status != LDB_SUCCESS) return status;
+
+       request.operation = LDB_REQ_ADD;
+       request.op.add.message = message;
+
+       return ldb_request(ldb, &request);
 }
 
 /*
@@ -147,34 +342,98 @@ int ldb_add(struct ldb_context *ldb,
 int ldb_modify(struct ldb_context *ldb, 
               const struct ldb_message *message)
 {
-       return ldb->modules->ops->modify_record(ldb->modules, message);
+       struct ldb_request request;
+       int status;
+
+       status = ldb_msg_sanity_check(message);
+       if (status != LDB_SUCCESS) return status;
+
+       request.operation = LDB_REQ_MODIFY;
+       request.op.mod.message = message;
+
+       return ldb_request(ldb, &request);
 }
 
 
 /*
   delete a record from the database
 */
-int ldb_delete(struct ldb_context *ldb, const char *dn)
+int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn)
 {
-       return ldb->modules->ops->delete_record(ldb->modules, dn);
+       struct ldb_request request;
+
+       request.operation = LDB_REQ_DELETE;
+       request.op.del.dn = dn;
+
+       return ldb_request(ldb, &request);
 }
 
 /*
   rename a record in the database
 */
-int ldb_rename(struct ldb_context *ldb, const char *olddn, const char *newdn)
+int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
 {
-       return ldb->modules->ops->rename_record(ldb->modules, olddn, newdn);
+       struct ldb_request request;
+
+       request.operation = LDB_REQ_RENAME;
+       request.op.rename.olddn = olddn;
+       request.op.rename.newdn = newdn;
+
+       return ldb_request(ldb, &request);
 }
 
+
+
 /*
   return extended error information 
 */
 const char *ldb_errstring(struct ldb_context *ldb)
 {
-       if (ldb->modules == NULL) {
-               return "ldb not connected";
+       if (ldb->err_string) {
+               return ldb->err_string;
+       }
+
+       return NULL;
+}
+
+
+/*
+  set backend specific opaque parameters
+*/
+int ldb_set_opaque(struct ldb_context *ldb, const char *name, void *value)
+{
+       struct ldb_opaque *o;
+
+       /* allow updating an existing value */
+       for (o=ldb->opaque;o;o=o->next) {
+               if (strcmp(o->name, name) == 0) {
+                       o->value = value;
+                       return LDB_SUCCESS;
+               }
        }
-       return ldb->modules->ops->errstring(ldb->modules);
+
+       o = talloc(ldb, struct ldb_opaque);
+       if (o == NULL) {
+               ldb_oom(ldb);
+               return LDB_ERR_OTHER;
+       }
+       o->next = ldb->opaque;
+       o->name = name;
+       o->value = value;
+       ldb->opaque = o;
+       return LDB_SUCCESS;
 }
 
+/*
+  get a previously set opaque value
+*/
+void *ldb_get_opaque(struct ldb_context *ldb, const char *name)
+{
+       struct ldb_opaque *o;
+       for (o=ldb->opaque;o;o=o->next) {
+               if (strcmp(o->name, name) == 0) {
+                       return o->value;
+               }
+       }
+       return NULL;
+}