Use struct-based rather than function-based initialization for ldb modules everywhere.
[jelmer/samba4-debian.git] / source / lib / ldb / modules / operational.c
index 084105fd85d1084a6264e814000aee1295e8c2d3..7dc4ae08c380eee8947643e5afc7bb8394728ac8 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/>.
 */
 /*
   handle operational attributes
@@ -50,7 +49,7 @@
 
 
   subschemaSubentry: HIDDEN, not-searchable, 
-                     points at DN CN=Aggregate,CN=Schema,CN=Configuration,$BASEDN
+                     points at DN CN=Aggregate,$SCHEMADN
 
      for this one we do the search as normal, then add the static
      value if requested. How do we work out the $BASEDN from inside a
@@ -74,8 +73,7 @@
   modifiersName: not supported by w2k3?
 */
 
-#include "includes.h"
-#include "ldb/include/includes.h"
+#include "ldb_includes.h"
 
 /*
   construct a canonical name from a message
@@ -169,242 +167,30 @@ failed:
        return -1;
 }
 
-/*
-  hook search operations
-*/
-static int operational_search_bytree(struct ldb_module *module, struct ldb_request *req)
-{
-       int i, r, a;
-       int ret;
-       const char * const *attrs = req->op.search.attrs;
-       const char **search_attrs = NULL;
-
-       req->op.search.res = NULL;
-
-       /* replace any attributes in the parse tree that are
-          searchable, but are stored using a different name in the
-          backend */
-       for (i=0;i<ARRAY_SIZE(parse_tree_sub);i++) {
-               ldb_parse_tree_attr_replace(req->op.search.tree, 
-                                           parse_tree_sub[i].attr, 
-                                           parse_tree_sub[i].replace);
-       }
-
-       /* in the list of attributes we are looking for, rename any
-          attributes to the alias for any hidden attributes that can
-          be fetched directly using non-hidden names */
-       for (a=0;attrs && attrs[a];a++) {
-               for (i=0;i<ARRAY_SIZE(search_sub);i++) {
-                       if (ldb_attr_cmp(attrs[a], search_sub[i].attr) == 0 &&
-                           search_sub[i].replace) {
-                               if (!search_attrs) {
-                                       search_attrs = ldb_attr_list_copy(req, attrs);
-                                       if (search_attrs == NULL) {
-                                               goto failed;
-                                       }
-                               }
-                               search_attrs[a] = search_sub[i].replace;
-                       }
-               }
-       }
-       
-       /* use new set of attrs if any */
-       if (search_attrs) req->op.search.attrs = search_attrs;
-       /* perform the search */
-       ret = ldb_next_request(module, req);
-       /* set back saved attrs if needed */
-       if (search_attrs) req->op.search.attrs = attrs;
-
-       /* check operation result */
-       if (ret != LDB_SUCCESS) {
-               return ret;
-       }
-
-       /* for each record returned post-process to add any derived
-          attributes that have been asked for */
-       for (r = 0; r < req->op.search.res->count; r++) {
-               if (operational_search_post_process(module, req->op.search.res->msgs[r], attrs) != 0) {
-                       goto failed;
-               }
-       }
-
-       /* all done */
-       talloc_free(search_attrs);
-       return ret;
-
-failed:
-       talloc_free(search_attrs);
-       talloc_free(req->op.search.res);
-       ldb_oom(module->ldb);
-       return LDB_ERR_OTHER;
-}
-
-/*
-  add a time element to a record
-*/
-static int add_time_element(struct ldb_message *msg, const char *attr, time_t t)
-{
-       struct ldb_message_element *el;
-       char *s;
-
-       if (ldb_msg_find_element(msg, attr) != NULL) {
-               return 0;
-       }
-
-       s = ldb_timestring(msg, t);
-       if (s == NULL) {
-               return -1;
-       }
-
-       if (ldb_msg_add_string(msg, attr, s) != 0) {
-               return -1;
-       }
-
-       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 0;
-}
-
-/*
-  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;
-       }
-
-       if (ldb_msg_add_fmt(msg, attr, "%llu", v) != 0) {
-               return -1;
-       }
-
-       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 0;
-}
-
-
-/*
-  hook add record ops
-*/
-static int operational_add_sync(struct ldb_module *module, struct ldb_request *req)
-{
-       const struct ldb_message *msg = req->op.add.message;
-       time_t t = time(NULL);
-       struct ldb_message *msg2;
-       int ret;
-
-       if (ldb_dn_is_special(msg->dn)) {
-               return ldb_next_request(module, req);
-       }
-
-       /* we have to copy the message as the caller might have it as a const */
-       msg2 = ldb_msg_copy_shallow(module, msg);
-       if (msg2 == NULL) {
-               return -1;
-       }
-       if (add_time_element(msg2, "whenCreated", t) != 0 ||
-           add_time_element(msg2, "whenChanged", t) != 0) {
-               talloc_free(msg2);
-               return -1;
-       }
-
-       /* see if the backend can give us the USN */
-       if (module->ldb->sequence_number != NULL) {
-               uint64_t seq_num = module->ldb->sequence_number(module->ldb);
-               if (add_uint64_element(msg2, "uSNCreated", seq_num) != 0 ||
-                   add_uint64_element(msg2, "uSNChanged", seq_num) != 0) {
-                       talloc_free(msg2);
-                       return -1;
-               }
-       }
-
-       /* use the new structure for the call chain below this point */
-       req->op.add.message = msg2;
-       /* go on with the call chain */
-       ret = ldb_next_request(module, req);
-       /* put back saved message */
-       req->op.add.message = msg;
-       /* free temproary compy */
-       talloc_free(msg2);
-       return ret;
-}
-
-/*
-  hook modify record ops
-*/
-static int operational_modify_sync(struct ldb_module *module, struct ldb_request *req)
-{
-       const struct ldb_message *msg = req->op.mod.message;
-       time_t t = time(NULL);
-       struct ldb_message *msg2;
-       int ret;
-
-       if (ldb_dn_is_special(msg->dn)) {
-               return ldb_next_request(module, req);
-       }
-
-       /* we have to copy the message as the caller might have it as a const */
-       msg2 = ldb_msg_copy_shallow(module, msg);
-       if (msg2 == NULL) {
-               return -1;
-       }
-       if (add_time_element(msg2, "whenChanged", t) != 0) {
-               talloc_free(msg2);
-               return -1;
-       }
-
-       /* update the records USN if possible */
-       if (module->ldb->sequence_number != NULL &&
-           add_uint64_element(msg2, "uSNChanged", 
-                              module->ldb->sequence_number(module->ldb)) != 0) {
-               talloc_free(msg2);
-               return -1;
-       }
-
-       /* use the new structure for the call chain below this point */
-       req->op.mod.message = msg2;
-       /* go on with the call chain */
-       ret = ldb_next_request(module, req);
-       /* put back saved message */
-       req->op.mod.message = msg;
-       /* free temproary compy */
-       talloc_free(msg2);
-       return ret;
-}
 
 /*
   hook search operations
 */
 
-struct operational_async_context {
+struct operational_context {
 
        struct ldb_module *module;
        void *up_context;
-       int (*up_callback)(struct ldb_context *, void *, struct ldb_async_result *);
-       int timeout;
+       int (*up_callback)(struct ldb_context *, void *, struct ldb_reply *);
 
        const char * const *attrs;
 };
 
-static int operational_async_callback(struct ldb_context *ldb, void *context, struct ldb_async_result *ares)
+static int operational_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 {
-       struct operational_async_context *ac;
+       struct operational_context *ac;
 
        if (!context || !ares) {
-               ldb_set_errstring(ldb, talloc_asprintf(ldb, "NULL Context or Result in callback"));
+               ldb_set_errstring(ldb, "NULL Context or Result in callback");
                goto error;
        }
 
-       ac = talloc_get_type(context, struct operational_async_context);
+       ac = talloc_get_type(context, struct operational_context);
 
        if (ares->type == LDB_REPLY_ENTRY) {
                /* for each record returned post-process to add any derived
@@ -423,22 +209,21 @@ error:
 
 static int operational_search(struct ldb_module *module, struct ldb_request *req)
 {
-       struct operational_async_context *ac;
+       struct operational_context *ac;
        struct ldb_request *down_req;
        const char **search_attrs = NULL;
        int i, a, ret;
 
-       req->async.handle = NULL;
+       req->handle = NULL;
 
-       ac = talloc(req, struct operational_async_context);
+       ac = talloc(req, struct operational_context);
        if (ac == NULL) {
                return LDB_ERR_OPERATIONS_ERROR;
        }
 
        ac->module = module;
-       ac->up_context = req->async.context;
-       ac->up_callback = req->async.callback;
-       ac->timeout = req->async.timeout;
+       ac->up_context = req->context;
+       ac->up_callback = req->callback;
        ac->attrs = req->op.search.attrs;
 
        down_req = talloc_zero(req, struct ldb_request);
@@ -486,9 +271,9 @@ static int operational_search(struct ldb_module *module, struct ldb_request *req
        
        down_req->controls = req->controls;
 
-       down_req->async.context = ac;
-       down_req->async.callback = operational_async_callback;
-       down_req->async.timeout = req->async.timeout;
+       down_req->context = ac;
+       down_req->callback = operational_callback;
+       ldb_set_timeout_from_prev_req(module->ldb, req, down_req);
 
        /* perform the search */
        ret = ldb_next_request(module, down_req);
@@ -496,158 +281,31 @@ static int operational_search(struct ldb_module *module, struct ldb_request *req
        /* do not free down_req as the call results may be linked to it,
         * it will be freed when the upper level request get freed */
        if (ret == LDB_SUCCESS) {
-               req->async.handle = down_req->async.handle;
-       }
-
-       return ret;
-}
-
-/*
-  hook add record ops
-*/
-static int operational_add(struct ldb_module *module, struct ldb_request *req)
-{
-       struct ldb_request *down_req;
-       struct ldb_message *msg;
-       time_t t = time(NULL);
-       int ret;
-
-       if (ldb_dn_is_special(req->op.add.message->dn)) {
-               return ldb_next_request(module, req);
-       }
-
-       down_req = talloc(req, struct ldb_request);
-       if (down_req == NULL) {
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-
-       *down_req = *req;
-
-       /* we have to copy the message as the caller might have it as a const */
-       down_req->op.mod.message = msg = ldb_msg_copy_shallow(down_req, req->op.mod.message);
-       if (msg == NULL) {
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-       if (add_time_element(msg, "whenCreated", t) != 0 ||
-           add_time_element(msg, "whenChanged", t) != 0) {
-               talloc_free(down_req);
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-
-       /* see if the backend can give us the USN */
-       if (module->ldb->sequence_number != NULL) {
-               uint64_t seq_num = module->ldb->sequence_number(module->ldb);
-               if (add_uint64_element(msg, "uSNCreated", seq_num) != 0 ||
-                   add_uint64_element(msg, "uSNChanged", seq_num) != 0) {
-                       talloc_free(down_req);
-                       return LDB_ERR_OPERATIONS_ERROR;
-               }
-       }
-
-       /* go on with the call chain */
-       ret = ldb_next_request(module, down_req);
-
-       /* do not free down_req as the call results may be linked to it,
-        * it will be freed when the upper level request get freed */
-       if (ret == LDB_SUCCESS) {
-               req->async.handle = down_req->async.handle;
+               req->handle = down_req->handle;
        }
 
        return ret;
 }
 
-/*
-  hook modify record ops
-*/
-static int operational_modify(struct ldb_module *module, struct ldb_request *req)
-{
-       struct ldb_request *down_req;
-       struct ldb_message *msg;
-       time_t t = time(NULL);
-       int ret;
-
-       if (ldb_dn_is_special(req->op.mod.message->dn)) {
-               return ldb_next_request(module, req);
-       }
-
-       down_req = talloc(req, struct ldb_request);
-       if (down_req == NULL) {
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-
-       *down_req = *req;
-
-       /* we have to copy the message as the caller might have it as a const */
-       down_req->op.mod.message = msg = ldb_msg_copy_shallow(down_req, req->op.mod.message);
-       if (msg == NULL) {
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-       if (add_time_element(msg, "whenChanged", t) != 0) {
-               talloc_free(down_req);
-               return LDB_ERR_OPERATIONS_ERROR;
-       }
-
-       /* update the records USN if possible */
-       if (module->ldb->sequence_number != NULL &&
-           add_uint64_element(msg, "uSNChanged", 
-                              module->ldb->sequence_number(module->ldb)) != 0) {
-               talloc_free(down_req);
-               return -1;
-       }
-       
-       /* go on with the call chain */
-       ret = ldb_next_request(module, down_req);
-
-       /* do not free down_req as the call results may be linked to it,
-        * it will be freed when the upper level request get freed */
-       if (ret == LDB_SUCCESS) {
-               req->async.handle = down_req->async.handle;
-       }
-
-       return ret;
-}
-
-
-static int operational_request(struct ldb_module *module, struct ldb_request *req)
+static int operational_init(struct ldb_module *ctx)
 {
-       switch (req->operation) {
-
-       case LDB_REQ_SEARCH:
-               return operational_search_bytree(module, req);
-
-       case LDB_REQ_ADD:
-               return operational_add_sync(module, req);
+       int ret = 0;
 
-       case LDB_REQ_MODIFY:
-               return operational_modify_sync(module, req);
-
-       default:
-               return ldb_next_request(module, req);
+       /* setup some standard attribute handlers */
+       ret |= ldb_schema_attribute_add(ctx->ldb, "whenCreated", 0, LDB_SYNTAX_UTC_TIME);
+       ret |= ldb_schema_attribute_add(ctx->ldb, "whenChanged", 0, LDB_SYNTAX_UTC_TIME);
+       ret |= ldb_schema_attribute_add(ctx->ldb, "subschemaSubentry", 0, LDB_SYNTAX_DN);
+       ret |= ldb_schema_attribute_add(ctx->ldb, "structuralObjectClass", 0, LDB_SYNTAX_OBJECTCLASS);
 
+       if (ret != 0) {
+               return ret;
        }
-}
-
-static int operational_init(struct ldb_module *ctx)
-{
-       /* setup some standard attribute handlers */
-       ldb_set_attrib_handler_syntax(ctx->ldb, "whenCreated", LDB_SYNTAX_UTC_TIME);
-       ldb_set_attrib_handler_syntax(ctx->ldb, "whenChanged", LDB_SYNTAX_UTC_TIME);
-       ldb_set_attrib_handler_syntax(ctx->ldb, "subschemaSubentry", LDB_SYNTAX_DN);
-       ldb_set_attrib_handler_syntax(ctx->ldb, "structuralObjectClass", LDB_SYNTAX_OBJECTCLASS);
 
        return ldb_next_init(ctx);
 }
 
-static const struct ldb_module_ops operational_ops = {
+const struct ldb_module_ops ldb_operational_module_ops = {
        .name              = "operational",
        .search            = operational_search,
-       .add               = operational_add,
-       .modify            = operational_modify,
-       .request           = operational_request,
        .init_context      = operational_init
 };
-
-int ldb_operational_init(void)
-{
-       return ldb_register_module(&operational_ops);
-}