r17514: Simplify the way to set ldb errors and add another
[abartlet/samba.git/.git] / source4 / lib / ldb / modules / sort.c
index 2757647710e9b1ef02df241738ed7286bd059425..0ae16d08ab9a265b703764f283bd5f0bb216315b 100644 (file)
@@ -33,9 +33,7 @@
  */
 
 #include "includes.h"
-#include "ldb/include/ldb.h"
-#include "ldb/include/ldb_errors.h"
-#include "ldb/include/ldb_private.h"
+#include "ldb/include/includes.h"
 
 struct opaque {
        struct ldb_context *ldb;
@@ -45,30 +43,88 @@ struct opaque {
        int result;
 };
 
-static int build_response(struct ldb_result *res, int result, const char *desc)
+struct sort_context {
+       struct ldb_module *module;
+       void *up_context;
+       int (*up_callback)(struct ldb_context *, void *, struct ldb_reply *);
+
+       char *attributeName;
+       char *orderingRule;
+       int reverse;
+
+       struct ldb_request *req;
+       struct ldb_message **msgs;
+       char **referrals;
+       struct ldb_control **controls;
+       int num_msgs;
+       int num_refs;
+
+       const struct ldb_attrib_handler *h;
+       int sort_result;
+};
+
+static struct ldb_handle *init_handle(void *mem_ctx, struct ldb_module *module,
+                                           void *context,
+                                           int (*callback)(struct ldb_context *, void *, struct ldb_reply *))
 {
+       struct sort_context *ac;
+       struct ldb_handle *h;
+
+       h = talloc_zero(mem_ctx, struct ldb_handle);
+       if (h == NULL) {
+               ldb_set_errstring(module->ldb, "Out of Memory");
+               return NULL;
+       }
+
+       h->module = module;
+
+       ac = talloc_zero(h, struct sort_context);
+       if (ac == NULL) {
+               ldb_set_errstring(module->ldb, "Out of Memory");
+               talloc_free(h);
+               return NULL;
+       }
+
+       h->private_data = (void *)ac;
+
+       h->state = LDB_ASYNC_INIT;
+       h->status = LDB_SUCCESS;
+
+       ac->module = module;
+       ac->up_context = context;
+       ac->up_callback = callback;
+
+       return h;
+}
+
+static int build_response(void *mem_ctx, struct ldb_control ***ctrls, int result, const char *desc)
+{
+       struct ldb_control **controls;
        struct ldb_sort_resp_control *resp;
        int i;
 
-       if (res->controls) {
-               for (i = 0; res->controls[i]; i++);
-               res->controls = talloc_realloc(res, res->controls, struct ldb_control *, i + 2);
+       if (*ctrls) {
+               controls = *ctrls;
+               for (i = 0; controls[i]; i++);
+               controls = talloc_realloc(mem_ctx, controls, struct ldb_control *, i + 2);
        } else {
                i = 0;
-               res->controls = talloc_array(res, struct ldb_control *, 2);
+               controls = talloc_array(mem_ctx, struct ldb_control *, 2);
        }
-       if (! res->controls )
+       if (! controls )
                return LDB_ERR_OPERATIONS_ERROR;
 
-       res->controls[i+1] = NULL;
-       res->controls[i] = talloc(res->controls, struct ldb_control);
-       if (! res->controls[i] )
+       *ctrls = controls;
+
+       controls[i+1] = NULL;
+       controls[i] = talloc(controls, struct ldb_control);
+       if (! controls[i] )
                return LDB_ERR_OPERATIONS_ERROR;
 
-       res->controls[i]->oid = LDB_CONTROL_SORT_RESP_OID;
-       res->controls[i]->critical = 0;
+       controls[i]->oid = LDB_CONTROL_SORT_RESP_OID;
+       controls[i]->critical = 0;
 
-       resp = talloc(res->controls[i], struct ldb_sort_resp_control);
+       resp = talloc(controls[i], struct ldb_sort_resp_control);
        if (! resp )
                return LDB_ERR_OPERATIONS_ERROR;
 
@@ -78,47 +134,106 @@ static int build_response(struct ldb_result *res, int result, const char *desc)
        if (! resp->attr_desc )
                return LDB_ERR_OPERATIONS_ERROR;
        
-       res->controls[i]->data = resp;
+       controls[i]->data = resp;
 
        return LDB_SUCCESS;
 }
 
 static int sort_compare(struct ldb_message **msg1, struct ldb_message **msg2, void *opaque)
 {
-       struct opaque *data = (struct opaque *)opaque;
+       struct sort_context *ac = talloc_get_type(opaque, struct sort_context);
        struct ldb_message_element *el1, *el2;
 
-       if (data->result != 0) {
+       if (ac->sort_result != 0) {
                /* an error occurred previously,
                 * let's exit the sorting by returning always 0 */
                return 0;
        }
 
-       el1 = ldb_msg_find_element(*msg1, data->attribute);
-       el2 = ldb_msg_find_element(*msg2, data->attribute);
+       el1 = ldb_msg_find_element(*msg1, ac->attributeName);
+       el2 = ldb_msg_find_element(*msg2, ac->attributeName);
 
        if (!el1 || !el2) {
                /* the attribute was not found return and
                 * set an error */
-               data->result = 53;
+               ac->sort_result = 53;
                return 0;
        }
 
-       if (data->reverse)
-               return data->h->comparison_fn(data->ldb, data, &el2->values[0], &el1->values[0]);
+       if (ac->reverse)
+               return ac->h->comparison_fn(ac->module->ldb, ac, &el2->values[0], &el1->values[0]);
+
+       return ac->h->comparison_fn(ac->module->ldb, ac, &el1->values[0], &el2->values[0]);
+}
+
+static int server_sort_search_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
+{
+       struct sort_context *ac = NULL;
+       
+       if (!context || !ares) {
+               ldb_set_errstring(ldb, "NULL Context or Result in callback");
+               goto error;
+       }       
+
+               ac = talloc_get_type(context, struct sort_context);
+
+       if (ares->type == LDB_REPLY_ENTRY) {
+               ac->msgs = talloc_realloc(ac, ac->msgs, struct ldb_message *, ac->num_msgs + 2);
+               if (! ac->msgs) {
+                       goto error;
+               }
+
+               ac->msgs[ac->num_msgs + 1] = NULL;
+
+               ac->msgs[ac->num_msgs] = talloc_steal(ac->msgs, ares->message);
+               if (! ac->msgs[ac->num_msgs]) {
+                       goto error;
+               }
+
+               ac->num_msgs++;
+       }
+
+       if (ares->type == LDB_REPLY_REFERRAL) {
+               ac->referrals = talloc_realloc(ac, ac->referrals, char *, ac->num_refs + 2);
+               if (! ac->referrals) {
+                       goto error;
+               }
 
-       return data->h->comparison_fn(data->ldb, data, &el1->values[0], &el2->values[0]);
+               ac->referrals[ac->num_refs + 1] = NULL;
+
+               ac->referrals[ac->num_refs] = talloc_steal(ac->referrals, ares->referral);
+               if (! ac->referrals[ac->num_refs]) {
+                       goto error;
+               }
+
+               ac->num_refs++;
+       }
+
+       if (ares->type == LDB_REPLY_DONE) {
+               if (ares->controls) {
+                       ac->controls = talloc_steal(ac, ares->controls);
+                       if (! ac->controls) {
+                               goto error;
+                       }
+               }
+       }
+
+       talloc_free(ares);
+       return LDB_SUCCESS;
+
+error:
+       talloc_free(ares);
+       return LDB_ERR_OPERATIONS_ERROR;
 }
 
-/* search */
 static int server_sort_search(struct ldb_module *module, struct ldb_request *req)
 {
-       struct ldb_result *sort_result = NULL;
        struct ldb_control *control;
-       struct ldb_control **saved_controls;
        struct ldb_server_sort_control **sort_ctrls;
-       int ret, result = 0;
-       int do_sort = 1;
+       struct ldb_control **saved_controls;
+       struct sort_context *ac;
+       struct ldb_handle *h;
+       int ret;
 
        /* check if there's a paged request control */
        control = get_control_from_list(req->controls, LDB_CONTROL_SERVER_SORT_OID);
@@ -127,139 +242,217 @@ static int server_sort_search(struct ldb_module *module, struct ldb_request *req
                return ldb_next_request(module, req);
        }
 
+       req->handle = NULL;
+
+       if (!req->callback || !req->context) {
+               ldb_set_errstring(module->ldb,
+                                 "Async interface called with NULL callback function or NULL context");
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+       
+       h = init_handle(req, module, req->context, req->callback);
+       if (!h) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+       ac = talloc_get_type(h->private_data, struct sort_context);
+
        sort_ctrls = talloc_get_type(control->data, struct ldb_server_sort_control *);
+       if (!sort_ctrls) {
+               return LDB_ERR_PROTOCOL_ERROR;
+       }
 
        /* FIXME: we do not support more than one attribute for sorting right now */
        /* FIXME: we need to check if the attribute type exist or return an error */
-       if (sort_ctrls[1] != NULL)
-               do_sort = 0;
                
-       if (!do_sort && control->critical) {
-               sort_result = talloc_zero(req, struct ldb_result);
-               if (!sort_result)
-                       return LDB_ERR_OPERATIONS_ERROR;
+       if (sort_ctrls[1] != NULL) {
+               if (control->critical) {
+                       struct ldb_reply *ares;
+
+                       ares = talloc_zero(req, struct ldb_reply);
+                       if (!ares)
+                               return LDB_ERR_OPERATIONS_ERROR;
+
+                       /* 53 = unwilling to perform */
+                       ares->type = LDB_REPLY_DONE;
+                       if ((ret = build_response(ares, &ares->controls, 53, "sort control is not complete yet")) != LDB_SUCCESS) {
+                               return ret;
+                       }
+
+                       h->status = LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION;
+                       h->state = LDB_ASYNC_DONE;
+                       ret = ac->up_callback(module->ldb, ac->up_context, ares);
 
-               req->op.search.res = sort_result;
-       
-               /* 53 = unwilling to perform */
-               if ((ret = build_response(sort_result, 53, "sort control is not complete yet")) != LDB_SUCCESS) {
                        return ret;
+               } else {
+                       /* just pass the call down and don't do any sorting */
+                       ldb_next_request(module, req);
                }
-
-               return LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION;
        }
 
+       ac->attributeName = sort_ctrls[0]->attributeName;
+       ac->orderingRule = sort_ctrls[0]->orderingRule;
+       ac->reverse = sort_ctrls[0]->reverse;
+
+       ac->req = talloc(req, struct ldb_request);
+       if (!ac->req)
+               return LDB_ERR_OPERATIONS_ERROR;
+
+       ac->req->operation = req->operation;
+       ac->req->op.search.base = req->op.search.base;
+       ac->req->op.search.scope = req->op.search.scope;
+       ac->req->op.search.tree = req->op.search.tree;
+       ac->req->op.search.attrs = req->op.search.attrs;
+       ac->req->controls = req->controls;
+
        /* save it locally and remove it from the list */
-       if (!save_controls(control, req, &saved_controls)) {
+       /* we do not need to replace them later as we
+        * are keeping the original req intact */
+       if (!save_controls(control, ac->req, &saved_controls)) {
                return LDB_ERR_OPERATIONS_ERROR;
        }
 
-       ret = ldb_next_request(module, req);
+       ac->req->context = ac;
+       ac->req->callback = server_sort_search_callback;
+       ldb_set_timeout_from_prev_req(module->ldb, req, ac->req);
 
-       if (req->controls) talloc_free(req->controls);
-       req->controls = saved_controls;
+       req->handle = h;
 
-       if (ret != LDB_SUCCESS) {
-               return ret;
+       return ldb_next_request(module, ac->req);
+}
+
+static int server_sort_results(struct ldb_handle *handle)
+{
+       struct sort_context *ac;
+       struct ldb_reply *ares;
+       int i, ret;
+
+       ac = talloc_get_type(handle->private_data, struct sort_context);
+
+       ac->h = ldb_attrib_handler(ac->module->ldb, ac->attributeName);
+       ac->sort_result = 0;
+
+       ldb_qsort(ac->msgs, ac->num_msgs,
+                 sizeof(struct ldb_message *),
+                 ac, (ldb_qsort_cmp_fn_t)sort_compare);
+
+       for (i = 0; i < ac->num_msgs; i++) {
+               ares = talloc_zero(ac, struct ldb_reply);
+               if (!ares) {
+                       handle->status = LDB_ERR_OPERATIONS_ERROR;
+                       return handle->status;
+               }
+
+               ares->type = LDB_REPLY_ENTRY;
+               ares->message = talloc_steal(ares, ac->msgs[i]);
+               
+               handle->status = ac->up_callback(ac->module->ldb, ac->up_context, ares);
+               if (handle->status != LDB_SUCCESS) {
+                       return handle->status;
+               }
        }
 
-       /* SORT HERE */
-       if (do_sort) {
-               struct opaque *data;
-              
-               data = talloc(module, struct opaque);
-               if (!data)
-                       return LDB_ERR_OPERATIONS_ERROR;
+       for (i = 0; i < ac->num_refs; i++) {
+               ares = talloc_zero(ac, struct ldb_reply);
+               if (!ares) {
+                       handle->status = LDB_ERR_OPERATIONS_ERROR;
+                       return handle->status;
+               }
+
+               ares->type = LDB_REPLY_REFERRAL;
+               ares->referral = talloc_steal(ares, ac->referrals[i]);
                
-               data->attribute = sort_ctrls[0]->attributeName;
-               data->reverse = sort_ctrls[0]->reverse;
-               data->ldb = module->ldb;
-               data->h = ldb_attrib_handler(data->ldb, data->attribute);
-               data->result = 0;
-               sort_result = req->op.search.res;
-
-               /* FIXME: I don't like to use a static structure like sort_control
-                * we need to either:
-                * a) write a qsort function that takes a third void parameter
-                * or
-                * b) prepare a structure with all elements pre digested like:
-                *      struct element {
-                *              struct ldb_message_element *el;
-                *              struct ldb_message *msg;
-                *      }
-                *
-                *      this mean we will have to do a linear scan of
-                *      the msgs array to build the new sort array, and
-                *      then do a linear scan of the resulting array
-                *      to rebuild the msgs array in the original shape.
-                */
-
-               ldb_qsort(sort_result->msgs,
-                         sort_result->count,
-                         sizeof(struct ldb_message *),
-                         data,
-                         (ldb_qsort_cmp_fn_t)sort_compare);
-
-               result = data->result;
-
-               talloc_free(data);
-       } else {
-               result = 53;
+               handle->status = ac->up_callback(ac->module->ldb, ac->up_context, ares);
+               if (handle->status != LDB_SUCCESS) {
+                       return handle->status;
+               }
        }
 
-       if ((ret = build_response(sort_result, result, "sort control is not complete yet")) != LDB_SUCCESS) {
+       ares = talloc_zero(ac, struct ldb_reply);
+       if (!ares) {
+               handle->status = LDB_ERR_OPERATIONS_ERROR;
+               return handle->status;
+       }
+
+       ares->type = LDB_REPLY_DONE;
+       ares->controls = talloc_steal(ares, ac->controls);
+               
+       handle->status = ac->up_callback(ac->module->ldb, ac->up_context, ares);
+       if (handle->status != LDB_SUCCESS) {
+               return handle->status;
+       }
+
+       if ((ret = build_response(ac, &ac->controls, ac->sort_result, "sort control is not complete yet")) != LDB_SUCCESS) {
                return ret;
        }
 
        return LDB_SUCCESS;
 }
 
-static int server_sort(struct ldb_module *module, struct ldb_request *req)
+static int server_sort_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 {
-       switch (req->operation) {
+       struct sort_context *ac;
+       int ret;
+    
+       if (!handle || !handle->private_data) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
 
-       case LDB_REQ_SEARCH:
-               return server_sort_search(module, req);
+       ac = talloc_get_type(handle->private_data, struct sort_context);
 
-       default:
-               return ldb_next_request(module, req);
+       ret = ldb_wait(ac->req->handle, type);
 
+       if (ret != LDB_SUCCESS) {
+               handle->status = ret;
+               return ret;
        }
-}
+               
+       handle->state = ac->req->handle->state;
+       handle->status = ac->req->handle->status;
 
-static const struct ldb_module_ops server_sort_ops = {
-       .name              = "server_sort",
-       .request           = server_sort,
-};
+       if (handle->status != LDB_SUCCESS) {
+               return handle->status;
+       }
 
-struct ldb_module *server_sort_module_init(struct ldb_context *ldb, int stage, const char *options[])
-{
-       struct ldb_module *ctx;
+       if (handle->state == LDB_ASYNC_DONE) {
+               ret = server_sort_results(handle);
+       }
 
-       if (stage == LDB_MODULES_INIT_STAGE_2) {
-               struct ldb_request request;
-               int ret;
+       return ret;
+}
 
-               request.operation = LDB_REQ_REGISTER;
-               request.op.reg.oid = LDB_CONTROL_SERVER_SORT_OID;
-               request.controls = NULL;
+static int server_sort_init(struct ldb_module *module)
+{
+       struct ldb_request *req;
+       int ret;
 
-               ret = ldb_request(ldb, &request);
-               if (ret != LDB_SUCCESS) {
-                       ldb_debug(ldb, LDB_DEBUG_ERROR, "server_sort: Unable to register control with rootdse!\n");
-               }
+       req = talloc(module, struct ldb_request);
+       if (req == NULL) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
 
-               return NULL;
+       req->operation = LDB_REQ_REGISTER_CONTROL;
+       req->op.reg_control.oid = LDB_CONTROL_SERVER_SORT_OID;
+       req->controls = NULL;
+
+       ret = ldb_request(module->ldb, req);
+       if (ret != LDB_SUCCESS) {
+               ldb_debug(module->ldb, LDB_DEBUG_ERROR, "server_sort: Unable to register control with rootdse!\n");
+               talloc_free(req);
+               return LDB_ERR_OTHER;
        }
 
-       ctx = talloc(ldb, struct ldb_module);
-       if (!ctx)
-               return NULL;
+       talloc_free(req);
+       return ldb_next_init(module);
+}
 
-       ctx->ldb = ldb;
-       ctx->prev = ctx->next = NULL;
-       ctx->ops = &server_sort_ops;
-       ctx->private_data = NULL;
+static const struct ldb_module_ops server_sort_ops = {
+       .name              = "server_sort",
+       .search            = server_sort_search,
+       .wait              = server_sort_wait,
+       .init_context      = server_sort_init
+};
 
-       return ctx;
+int ldb_sort_init(void)
+{
+       return ldb_register_module(&server_sort_ops);
 }