Until the new ldb changes land, make ldb_wait set the error string.
[kai/samba.git] / source4 / lib / ldb / common / ldb.c
index 00bf5e79babde837b6cea72e52d02e790617d167..5601a3319126926d829ea710911ffbd728a713c4 100644 (file)
@@ -11,7 +11,7 @@
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
+   version 3 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -19,8 +19,7 @@
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
@@ -33,8 +32,7 @@
  *  Author: Andrew Tridgell
  */
 
-#include "includes.h"
-#include "ldb/include/includes.h"
+#include "ldb_includes.h"
 
 /* 
    initialise a ldb context
@@ -52,11 +50,13 @@ struct ldb_context *ldb_init(void *mem_ctx)
        }
 
        ldb_set_utf8_default(ldb);
+       ldb_set_create_perms(ldb, 0666);
+       ldb_set_modules_dir(ldb, LDB_MODULESDIR);
 
        return ldb;
 }
 
-static struct ldb_backend {
+struct ldb_backend {
        const char *name;
        ldb_connect_fn connect_fn;
        struct ldb_backend *prev, *next;
@@ -126,7 +126,11 @@ int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *op
        fn = ldb_find_backend(backend);
 
        if (fn == NULL) {
-               if (ldb_try_load_dso(ldb, backend) == 0) {
+               int (*init_fn) (void);
+
+               init_fn = ldb_dso_load_symbol(ldb, backend,
+                                             "init_module");
+               if (init_fn != NULL && init_fn() == 0) {
                        fn = ldb_find_backend(backend);
                }
        }
@@ -152,37 +156,69 @@ int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *op
   pet hates about ldapsearch, which is that you have to get a long,
   complex basedn right to make any use of it.
 */
-static const struct ldb_dn *ldb_set_default_basedn(struct ldb_context *ldb)
+void ldb_set_default_dns(struct ldb_context *ldb)
 {
        TALLOC_CTX *tmp_ctx;
        int ret;
-       static const char *attrs[] = { "defaultNamingContext", NULL };
        struct ldb_result *res;
-       struct ldb_dn *basedn=NULL;
-
-       basedn = ldb_get_opaque(ldb, "default_baseDN");
-       if (basedn) {
-               return basedn;
-       }
+       struct ldb_dn *tmp_dn=NULL;
+       static const char *attrs[] = {
+               "rootDomainNamingContext",
+               "configurationNamingContext",
+               "schemaNamingContext",
+               "defaultNamingContext",
+               NULL
+       };
 
        tmp_ctx = talloc_new(ldb);
-       ret = ldb_search(ldb, ldb_dn_new(tmp_ctx), LDB_SCOPE_BASE, 
+       ret = ldb_search(ldb, ldb_dn_new(tmp_ctx, ldb, NULL), LDB_SCOPE_BASE, 
                         "(objectClass=*)", attrs, &res);
        if (ret == LDB_SUCCESS) {
                if (res->count == 1) {
-                       basedn = ldb_msg_find_attr_as_dn(ldb, res->msgs[0], "defaultNamingContext");
-                       ldb_set_opaque(ldb, "default_baseDN", basedn);
+                       if (!ldb_get_opaque(ldb, "rootDomainNamingContext")) {
+                               tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "rootDomainNamingContext");
+                               ldb_set_opaque(ldb, "rootDomainNamingContext", tmp_dn);
+                       }
+
+                       if (!ldb_get_opaque(ldb, "configurationNamingContext")) {
+                               tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "configurationNamingContext");
+                               ldb_set_opaque(ldb, "configurationNamingContext", tmp_dn);
+                       }
+
+                       if (!ldb_get_opaque(ldb, "schemaNamingContext")) {
+                               tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "schemaNamingContext");
+                               ldb_set_opaque(ldb, "schemaNamingContext", tmp_dn);
+                       }
+
+                       if (!ldb_get_opaque(ldb, "defaultNamingContext")) {
+                               tmp_dn = ldb_msg_find_attr_as_dn(ldb, ldb, res->msgs[0], "defaultNamingContext");
+                               ldb_set_opaque(ldb, "defaultNamingContext", tmp_dn);
+                       }
                }
                talloc_free(res);
        }
 
        talloc_free(tmp_ctx);
-       return basedn;
 }
 
-const struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
+struct ldb_dn *ldb_get_root_basedn(struct ldb_context *ldb)
+{
+       return talloc_get_type(ldb_get_opaque(ldb, "rootDomainNamingContext"), struct ldb_dn);
+}
+
+struct ldb_dn *ldb_get_config_basedn(struct ldb_context *ldb)
+{
+       return talloc_get_type(ldb_get_opaque(ldb, "configurationNamingContext"), struct ldb_dn);
+}
+
+struct ldb_dn *ldb_get_schema_basedn(struct ldb_context *ldb)
 {
-       return ldb_get_opaque(ldb, "default_baseDN");
+       return talloc_get_type(ldb_get_opaque(ldb, "schemaNamingContext"), struct ldb_dn);
+}
+
+struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
+{
+       return talloc_get_type(ldb_get_opaque(ldb, "defaultNamingContext"), struct ldb_dn);
 }
 
 /* 
@@ -198,16 +234,30 @@ const struct ldb_dn *ldb_get_default_basedn(struct ldb_context *ldb)
 int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[])
 {
        int ret;
+       const char *url2;
+       /* We seem to need to do this here, or else some utilities don't get ldb backends */
+       ldb_global_init();
 
        ldb->flags = flags;
 
+       url2 = talloc_strdup(ldb, url);
+       if (!url2) {
+               ldb_oom(ldb);
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+       ret = ldb_set_opaque(ldb, "ldb_url", talloc_strdup(ldb, url2));
+       if (ret != LDB_SUCCESS) {
+               return ret;
+       }
+
        ret = ldb_connect_backend(ldb, url, options, &ldb->modules);
        if (ret != LDB_SUCCESS) {
                return ret;
        }
 
        if (ldb_load_modules(ldb, options) != LDB_SUCCESS) {
-               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for '%s'\n", url);
+               ldb_debug(ldb, LDB_DEBUG_FATAL, "Unable to load modules for %s: %s\n",
+                         url, ldb_errstring(ldb));
                return LDB_ERR_OTHER;
        }
 
@@ -215,7 +265,7 @@ int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, co
        ldb->default_timeout = 300; /* set default to 5 minutes */
 
        /* set the default base dn */
-       ldb_set_default_basedn(ldb);
+       ldb_set_default_dns(ldb);
 
        return LDB_SUCCESS;
 }
@@ -231,14 +281,16 @@ void ldb_set_errstring(struct ldb_context *ldb, const char *err_string)
 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...)
 {
        va_list ap;
+       char *old_string = NULL;
 
        if (ldb->err_string) {
-               talloc_free(ldb->err_string);
+               old_string = ldb->err_string;
        }
 
        va_start(ap, format);
        ldb->err_string = talloc_vasprintf(ldb, format, ap);
        va_end(ap);
+       talloc_free(old_string);
 }
 
 void ldb_reset_err_string(struct ldb_context *ldb)
@@ -411,11 +463,17 @@ static int ldb_autotransaction_request(struct ldb_context *ldb, struct ldb_reque
 
 int ldb_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 {
+       int ret;
        if (!handle) {
                return LDB_SUCCESS;
        }
 
-       return handle->module->ops->wait(handle, type);
+       ret = handle->module->ops->wait(handle, type);
+       if (!ldb_errstring(handle->module->ldb)) {
+               /* Set a default error string, to place the blame somewhere */
+               ldb_asprintf_errstring(handle->module->ldb, "error waiting on module %s: %s (%d)", handle->module->ops->name, ldb_strerror(ret), ret);
+       }
+       return ret;
 }
 
 /* set the specified timeout or, if timeout is 0 set the default timeout */
@@ -455,6 +513,16 @@ int ldb_set_timeout_from_prev_req(struct ldb_context *ldb, struct ldb_request *o
        return LDB_SUCCESS;
 }
 
+
+/* 
+   set the permissions for new files to be passed to open() in
+   backends that use local files
+ */
+void ldb_set_create_perms(struct ldb_context *ldb, unsigned int perms)
+{
+       ldb->create_perms = perms;
+}
+
 /*
   start an ldb request
   NOTE: the request must be a talloc context.
@@ -489,6 +557,10 @@ int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
                FIRST_OP(ldb, rename);
                ret = module->ops->rename(module, req);
                break;
+       case LDB_EXTENDED:
+               FIRST_OP(ldb, extended);
+               ret = module->ops->extended(module, req);
+               break;
        case LDB_SEQUENCE_NUMBER:
                FIRST_OP(ldb, sequence_number);
                ret = module->ops->sequence_number(module, req);
@@ -510,7 +582,7 @@ int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
   Use talloc_free to free the ldb_message returned in 'res', if successful
 
 */
-static int ldb_search_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
+int ldb_search_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 {
        struct ldb_result *res;
        int n;
@@ -520,13 +592,15 @@ static int ldb_search_callback(struct ldb_context *ldb, void *context, struct ld
                return LDB_ERR_OPERATIONS_ERROR;
        }       
 
-       res = *((struct ldb_result **)context);
+       res = talloc_get_type(context, struct ldb_result);
 
        if (!res || !ares) {
+               ldb_set_errstring(ldb, "NULL res or ares in callback");
                goto error;
        }
 
-       if (ares->type == LDB_REPLY_ENTRY) {
+       switch (ares->type) {
+       case LDB_REPLY_ENTRY:
                res->msgs = talloc_realloc(res, res->msgs, struct ldb_message *, res->count + 2);
                if (! res->msgs) {
                        goto error;
@@ -536,9 +610,8 @@ static int ldb_search_callback(struct ldb_context *ldb, void *context, struct ld
 
                res->msgs[res->count] = talloc_move(res->msgs, &ares->message);
                res->count++;
-       }
-
-       if (ares->type == LDB_REPLY_REFERRAL) {
+               break;
+       case LDB_REPLY_REFERRAL:
                if (res->refs) {
                        for (n = 0; res->refs[n]; n++) /*noop*/ ;
                } else {
@@ -552,23 +625,25 @@ static int ldb_search_callback(struct ldb_context *ldb, void *context, struct ld
 
                res->refs[n] = talloc_move(res->refs, &ares->referral);
                res->refs[n + 1] = NULL;
+               break;
+       case LDB_REPLY_EXTENDED:
+       case LDB_REPLY_DONE:
+               /* TODO: we should really support controls on entries and referrals too! */
+               res->controls = talloc_move(res, &ares->controls);
+               break;          
        }
-
-       talloc_steal(res, ares->controls);
        talloc_free(ares);
        return LDB_SUCCESS;
 
 error:
        talloc_free(ares);
-       talloc_free(res);
-       *((struct ldb_result **)context) = NULL;
        return LDB_ERR_OPERATIONS_ERROR;
 }
 
 int ldb_build_search_req(struct ldb_request **ret_req,
                        struct ldb_context *ldb,
                        void *mem_ctx,
-                       const struct ldb_dn *base,
+                       struct ldb_dn *base,
                        enum ldb_scope scope,
                        const char *expression,
                        const char * const *attrs,
@@ -588,7 +663,7 @@ int ldb_build_search_req(struct ldb_request **ret_req,
 
        req->operation = LDB_SEARCH;
        if (base == NULL) {
-               req->op.search.base = ldb_dn_new(req);
+               req->op.search.base = ldb_dn_new(req, ldb, NULL);
        } else {
                req->op.search.base = base;
        }
@@ -671,7 +746,7 @@ int ldb_build_mod_req(struct ldb_request **ret_req,
 int ldb_build_del_req(struct ldb_request **ret_req,
                        struct ldb_context *ldb,
                        void *mem_ctx,
-                       const struct ldb_dn *dn,
+                       struct ldb_dn *dn,
                        struct ldb_control **controls,
                        void *context,
                        ldb_request_callback_t callback)
@@ -700,8 +775,8 @@ int ldb_build_del_req(struct ldb_request **ret_req,
 int ldb_build_rename_req(struct ldb_request **ret_req,
                        struct ldb_context *ldb,
                        void *mem_ctx,
-                       const struct ldb_dn *olddn,
-                       const struct ldb_dn *newdn,
+                       struct ldb_dn *olddn,
+                       struct ldb_dn *newdn,
                        struct ldb_control **controls,
                        void *context,
                        ldb_request_callback_t callback)
@@ -728,25 +803,134 @@ int ldb_build_rename_req(struct ldb_request **ret_req,
        return LDB_SUCCESS;
 }
 
+int ldb_extended_default_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
+{
+       struct ldb_result *res;
+       
+       if (!context) {
+               ldb_set_errstring(ldb, "NULL Context in callback");
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       res = talloc_get_type(context, struct ldb_result);
+       if (!res || !ares) {
+               ldb_set_errstring(ldb, "NULL res or ares in callback");
+               goto error;
+       }
+
+       switch (ares->type) {
+       case LDB_REPLY_ENTRY:
+       case LDB_REPLY_REFERRAL:
+       case LDB_REPLY_DONE:
+               ldb_set_errstring(ldb, "invalid ares type in callback");
+               goto error;
+       case LDB_REPLY_EXTENDED:
+               /* TODO: we should really support controls on entries and referrals too! */
+               res->extended = talloc_move(res, &ares->response);
+               res->controls = talloc_move(res, &ares->controls);
+               break;          
+       }
+       talloc_free(ares);
+       return LDB_SUCCESS;
+
+error:
+       talloc_free(ares);
+       return LDB_ERR_OPERATIONS_ERROR;
+}
+
+int ldb_build_extended_req(struct ldb_request **ret_req,
+                          struct ldb_context *ldb,
+                          void *mem_ctx,
+                          const char *oid,
+                          void *data,
+                          struct ldb_control **controls,
+                          void *context,
+                          ldb_request_callback_t callback)
+{
+       struct ldb_request *req;
+
+       *ret_req = NULL;
+
+       req = talloc(mem_ctx, struct ldb_request);
+       if (req == NULL) {
+               ldb_set_errstring(ldb, "Out of Memory");
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       req->operation = LDB_EXTENDED;
+       req->op.extended.oid = oid;
+       req->op.extended.data = data;
+       req->controls = controls;
+       req->context = context;
+       req->callback = callback;
+
+       *ret_req = req;
+
+       return LDB_SUCCESS;
+}
+
+int ldb_extended(struct ldb_context *ldb, 
+                const char *oid,
+                void *data,
+                struct ldb_result **_res)
+{
+       struct ldb_request *req;
+       int ret;
+       struct ldb_result *res;
+
+       *_res = NULL;
+
+       res = talloc_zero(ldb, struct ldb_result);
+       if (!res) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       ret = ldb_build_extended_req(&req, ldb, ldb,
+                                    oid, data, NULL,
+                                    res, ldb_extended_default_callback);
+       if (ret != LDB_SUCCESS) goto done;
+
+       ldb_set_timeout(ldb, req, 0); /* use default timeout */
+
+       ret = ldb_request(ldb, req);
+       
+       if (ret == LDB_SUCCESS) {
+               ret = ldb_wait(req->handle, LDB_WAIT_ALL);
+       }
+
+       talloc_free(req);
+
+done:
+       if (ret != LDB_SUCCESS) {
+               talloc_free(res);
+       }
+
+       *_res = res;
+       return ret;
+}
+
 /*
   note that ldb_search() will automatically replace a NULL 'base' value with the 
   defaultNamingContext from the rootDSE if available.
 */
 int ldb_search(struct ldb_context *ldb, 
-              const struct ldb_dn *base,
+              struct ldb_dn *base,
               enum ldb_scope scope,
               const char *expression,
               const char * const *attrs, 
-              struct ldb_result **res)
+              struct ldb_result **_res)
 {
        struct ldb_request *req;
        int ret;
+       struct ldb_result *res;
 
-       *res = talloc_zero(ldb, struct ldb_result);
-       if (! *res) {
+       *_res = NULL;
+
+       res = talloc_zero(ldb, struct ldb_result);
+       if (!res) {
                return LDB_ERR_OPERATIONS_ERROR;
        }
-       
+
        ret = ldb_build_search_req(&req, ldb, ldb,
                                        base?base:ldb_get_default_basedn(ldb),
                                        scope,
@@ -754,7 +938,7 @@ int ldb_search(struct ldb_context *ldb,
                                        attrs,
                                        NULL,
                                        res,
-                                       ldb_search_callback);
+                                       ldb_search_default_callback);
 
        if (ret != LDB_SUCCESS) goto done;
 
@@ -770,10 +954,47 @@ int ldb_search(struct ldb_context *ldb,
 
 done:
        if (ret != LDB_SUCCESS) {
-               talloc_free(*res);
-               *res = NULL;
+               talloc_free(res);
        }
 
+       *_res = res;
+       return ret;
+}
+
+/*
+ a useful search function where you can easily define the expression and that
+ takes a memory context where results are allocated
+*/
+
+int ldb_search_exp_fmt(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_result **result,
+                        struct ldb_dn *base, enum ldb_scope scope, const char * const *attrs,
+                        const char *exp_fmt, ...)
+{
+       struct ldb_result *res;
+       char *expression;
+       va_list ap;
+       int ret;
+
+       res = NULL;
+       *result = NULL;
+
+       va_start(ap, exp_fmt);
+       expression = talloc_vasprintf(mem_ctx, exp_fmt, ap);
+       va_end(ap);
+
+       if ( ! expression) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       ret = ldb_search(ldb, base, scope, expression, attrs, &res);
+
+       if (ret == LDB_SUCCESS) {
+               talloc_steal(mem_ctx, res);
+               *result = res;
+       }
+
+       talloc_free(expression);
+
        return ret;
 }
 
@@ -844,7 +1065,7 @@ int ldb_modify(struct ldb_context *ldb,
 /*
   delete a record from the database
 */
-int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn)
+int ldb_delete(struct ldb_context *ldb, struct ldb_dn *dn)
 {
        struct ldb_request *req;
        int ret;
@@ -869,7 +1090,7 @@ int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn)
 /*
   rename a record in the database
 */
-int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
+int ldb_rename(struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn)
 {
        struct ldb_request *req;
        int ret;