Fix the mess with ldb includes.
[metze/samba/wip.git] / source4 / dsdb / samdb / ldb_modules / objectguid.c
index 2a27398fbc04e5424ba139438462e22b541dd23a..46ba8ebdb3651021ed523fe2e231baf30abcaafe 100644 (file)
@@ -1,7 +1,9 @@
 /* 
    ldb database library
 
-   Copyright (C) Simo Sorce  2004
+   Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
+   Copyright (C) Andrew Tridgell 2005
+   Copyright (C) Simo Sorce  2004-2008
 
      ** NOTE! The following LGPL license applies to the ldb
      ** library. This does NOT imply that all of Samba is released
@@ -10,7 +12,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
@@ -18,8 +20,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/>.
 */
 
 /*
  */
 
 #include "includes.h"
-#include "ldb/include/ldb.h"
-#include "ldb/include/ldb_private.h"
+#include "ldb_module.h"
 #include "librpc/gen_ndr/ndr_misc.h"
-#include <time.h>
-
-static int objectguid_search(struct ldb_module *module, const struct ldb_dn *base,
-                                 enum ldb_scope scope, const char *expression,
-                                 const char * const *attrs, struct ldb_message ***res)
-{
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_search\n");
-       return ldb_next_search(module, base, scope, expression, attrs, res);
-}
-
-static int objectguid_search_bytree(struct ldb_module *module, const struct ldb_dn *base,
-                                   enum ldb_scope scope, struct ldb_parse_tree *tree,
-                                   const char * const *attrs, struct ldb_message ***res)
-{
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_search\n");
-       return ldb_next_search_bytree(module, base, scope, tree, attrs, res);
-}
+#include "param/param.h"
 
 static struct ldb_message_element *objectguid_find_attribute(const struct ldb_message *msg, const char *name)
 {
@@ -67,129 +51,235 @@ static struct ldb_message_element *objectguid_find_attribute(const struct ldb_me
        return NULL;
 }
 
-/* add_record: add crateTimestamp/modifyTimestamp attributes */
-static int objectguid_add_record(struct ldb_module *module, const struct ldb_message *msg)
+/*
+  add a time element to a record
+*/
+static int add_time_element(struct ldb_message *msg, const char *attr, time_t t)
 {
-       struct ldb_val v;
-       struct ldb_message *msg2;
-       struct ldb_message_element *attribute;
-       struct GUID guid;
-       NTSTATUS nt_status;
-       int ret, i;
+       struct ldb_message_element *el;
+       char *s;
 
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_add_record\n");
-
-       if (ldb_dn_is_special(msg->dn)) { /* do not manipulate our control entries */
-               return ldb_next_add_record(module, msg);
+       if (ldb_msg_find_element(msg, attr) != NULL) {
+               return 0;
        }
 
-       if ((attribute = objectguid_find_attribute(msg, "objectGUID")) != NULL ) {
-               return ldb_next_add_record(module, msg);
+       s = ldb_timestring(msg, t);
+       if (s == NULL) {
+               return -1;
        }
 
-       msg2 = talloc(module, struct ldb_message);
-       if (!msg2) {
+       if (ldb_msg_add_string(msg, attr, s) != 0) {
                return -1;
        }
 
-       msg2->dn = msg->dn;
-       msg2->num_elements = msg->num_elements;
-       msg2->private_data = msg->private_data;
-       msg2->elements = talloc_array(msg2, struct ldb_message_element, msg2->num_elements);
-       for (i = 0; i < msg2->num_elements; i++) {
-               msg2->elements[i] = msg->elements[i];
-       }
+       el = ldb_msg_find_element(msg, attr);
+       /* always set as replace. This works because on add ops, the flag
+          is ignored */
+       el->flags = LDB_FLAG_MOD_REPLACE;
 
-       /* a new GUID */
-       guid = GUID_random();
+       return 0;
+}
 
-       nt_status = ndr_push_struct_blob(&v, msg2, &guid, 
-                                        (ndr_push_flags_fn_t)ndr_push_GUID);
-       if (!NT_STATUS_IS_OK(nt_status)) {
-               return -1;
+/*
+  add a uint64_t element to a record
+*/
+static int add_uint64_element(struct ldb_message *msg, const char *attr, uint64_t v)
+{
+       struct ldb_message_element *el;
+
+       if (ldb_msg_find_element(msg, attr) != NULL) {
+               return 0;
        }
 
-       ret = ldb_msg_add_value(module->ldb, msg2, "objectGUID", &v);
-       if (ret) {
-               return ret;
+       if (ldb_msg_add_fmt(msg, attr, "%llu", (unsigned long long)v) != 0) {
+               return -1;
        }
 
-       ret = ldb_next_add_record(module, msg2);
-       talloc_free(msg2);
+       el = ldb_msg_find_element(msg, attr);
+       /* always set as replace. This works because on add ops, the flag
+          is ignored */
+       el->flags = LDB_FLAG_MOD_REPLACE;
 
-       return ret;
+       return 0;
 }
 
-/* modify_record: change modifyTimestamp as well */
-static int objectguid_modify_record(struct ldb_module *module, const struct ldb_message *msg)
-{
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_modify_record\n");
-       return ldb_next_modify_record(module, msg);
-}
+struct og_context {
+       struct ldb_module *module;
+       struct ldb_request *req;
+};
 
-static int objectguid_delete_record(struct ldb_module *module, const struct ldb_dn *dn)
+static int og_op_callback(struct ldb_request *req, struct ldb_reply *ares)
 {
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_delete_record\n");
-       return ldb_next_delete_record(module, dn);
-}
+       struct og_context *ac;
 
-static int objectguid_rename_record(struct ldb_module *module, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
-{
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_rename_record\n");
-       return ldb_next_rename_record(module, olddn, newdn);
-}
+       ac = talloc_get_type(req->context, struct og_context);
 
-static int objectguid_start_trans(struct ldb_module *module)
-{
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_start_trans\n");
-       return ldb_next_start_trans(module);
+       if (!ares) {
+               return ldb_module_done(ac->req, NULL, NULL,
+                                       LDB_ERR_OPERATIONS_ERROR);
+       }
+       if (ares->error != LDB_SUCCESS) {
+               return ldb_module_done(ac->req, ares->controls,
+                                       ares->response, ares->error);
+       }
+
+       if (ares->type != LDB_REPLY_DONE) {
+               talloc_free(ares);
+               return ldb_module_done(ac->req, NULL, NULL,
+                                       LDB_ERR_OPERATIONS_ERROR);
+       }
+
+       return ldb_module_done(ac->req, ares->controls,
+                               ares->response, ares->error);
 }
 
-static int objectguid_end_trans(struct ldb_module *module, int status)
+/* add_record: add objectGUID attribute */
+static int objectguid_add(struct ldb_module *module, struct ldb_request *req)
 {
-       ldb_debug(module->ldb, LDB_DEBUG_TRACE, "objectguid_end_trans\n");
-       return ldb_next_end_trans(module, status);
+       struct ldb_context *ldb;
+       struct ldb_request *down_req;
+       struct ldb_message_element *attribute;
+       struct ldb_message *msg;
+       struct ldb_val v;
+       struct GUID guid;
+       uint64_t seq_num;
+       enum ndr_err_code ndr_err;
+       int ret;
+       time_t t = time(NULL);
+       struct og_context *ac;
+
+       ldb = ldb_module_get_ctx(module);
+
+       ldb_debug(ldb, LDB_DEBUG_TRACE, "objectguid_add_record\n");
+
+       /* do not manipulate our control entries */
+       if (ldb_dn_is_special(req->op.add.message->dn)) {
+               return ldb_next_request(module, req);
+       }
+
+       if ((attribute = objectguid_find_attribute(req->op.add.message, "objectGUID")) != NULL ) {
+               return ldb_next_request(module, req);
+       }
+
+       ac = talloc(req, struct og_context);
+       if (ac == NULL) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+       ac->module = module;
+       ac->req = req;
+
+       /* we have to copy the message as the caller might have it as a const */
+       msg = ldb_msg_copy_shallow(ac, req->op.add.message);
+       if (msg == NULL) {
+               talloc_free(down_req);
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       /* a new GUID */
+       guid = GUID_random();
+
+       ndr_err = ndr_push_struct_blob(&v, msg, 
+                                      lp_iconv_convenience(ldb_get_opaque(ldb, "loadparm")),
+                                      &guid,
+                                      (ndr_push_flags_fn_t)ndr_push_GUID);
+       if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       ret = ldb_msg_add_value(msg, "objectGUID", &v, NULL);
+       if (ret) {
+               return ret;
+       }
+       
+       if (add_time_element(msg, "whenCreated", t) != 0 ||
+           add_time_element(msg, "whenChanged", t) != 0) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       /* Get a sequence number from the backend */
+       /* FIXME: ldb_sequence_number is a semi-async call,
+        * make sure this function is split and a callback is used */
+       ret = ldb_sequence_number(ldb, LDB_SEQ_NEXT, &seq_num);
+       if (ret == LDB_SUCCESS) {
+               if (add_uint64_element(msg, "uSNCreated", seq_num) != 0 ||
+                   add_uint64_element(msg, "uSNChanged", seq_num) != 0) {
+                       return LDB_ERR_OPERATIONS_ERROR;
+               }
+       }
+
+       ret = ldb_build_add_req(&down_req, ldb, ac,
+                               msg,
+                               req->controls,
+                               ac, og_op_callback,
+                               req);
+       if (ret != LDB_SUCCESS) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       /* go on with the call chain */
+       return ldb_next_request(module, down_req);
 }
 
-static int objectguid_destructor(void *module_ctx)
+/* modify_record: update timestamps */
+static int objectguid_modify(struct ldb_module *module, struct ldb_request *req)
 {
-       /* struct ldb_module *ctx = module_ctx; */
-       /* put your clean-up functions here */
-       return 0;
-}
+       struct ldb_context *ldb;
+       struct ldb_request *down_req;
+       struct ldb_message *msg;
+       int ret;
+       time_t t = time(NULL);
+       uint64_t seq_num;
+       struct og_context *ac;
 
-static const struct ldb_module_ops objectguid_ops = {
-       .name          = "objectguid",
-       .search        = objectguid_search,
-       .search_bytree = objectguid_search_bytree,
-       .add_record    = objectguid_add_record,
-       .modify_record = objectguid_modify_record,
-       .delete_record = objectguid_delete_record,
-       .rename_record = objectguid_rename_record,
-       .start_transaction = objectguid_start_trans,
-       .end_transaction = objectguid_end_trans
-};
+       ldb = ldb_module_get_ctx(module);
 
+       ldb_debug(ldb, LDB_DEBUG_TRACE, "objectguid_add_record\n");
 
-/* the init function */
-#ifdef HAVE_DLOPEN_DISABLED
- struct ldb_module *init_module(struct ldb_context *ldb, const char *options[])
-#else
-struct ldb_module *objectguid_module_init(struct ldb_context *ldb, const char *options[])
-#endif
-{
-       struct ldb_module *ctx;
+       /* do not manipulate our control entries */
+       if (ldb_dn_is_special(req->op.add.message->dn)) {
+               return ldb_next_request(module, req);
+       }
 
-       ctx = talloc(ldb, struct ldb_module);
-       if (!ctx)
-               return NULL;
+       ac = talloc(req, struct og_context);
+       if (ac == NULL) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+       ac->module = module;
+       ac->req = req;
 
-       ctx->private_data = NULL;
-       ctx->ldb = ldb;
-       ctx->prev = ctx->next = NULL;
-       ctx->ops = &objectguid_ops;
+       /* we have to copy the message as the caller might have it as a const */
+       msg = ldb_msg_copy_shallow(ac, req->op.mod.message);
+       if (msg == NULL) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       if (add_time_element(msg, "whenChanged", t) != 0) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       /* Get a sequence number from the backend */
+       ret = ldb_sequence_number(ldb, LDB_SEQ_NEXT, &seq_num);
+       if (ret == LDB_SUCCESS) {
+               if (add_uint64_element(msg, "uSNChanged", seq_num) != 0) {
+                       return LDB_ERR_OPERATIONS_ERROR;
+               }
+       }
 
-       talloc_set_destructor (ctx, objectguid_destructor);
+       ret = ldb_build_mod_req(&down_req, ldb, ac,
+                               msg,
+                               req->controls,
+                               ac, og_op_callback,
+                               req);
+       if (ret != LDB_SUCCESS) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
 
-       return ctx;
+       /* go on with the call chain */
+       return ldb_next_request(module, down_req);
 }
+
+_PUBLIC_ const struct ldb_module_ops ldb_objectguid_module_ops = {
+       .name          = "objectguid",
+       .add           = objectguid_add,
+       .modify        = objectguid_modify,
+};