r23798: updated old Temple Place FSF addresses to new URL
[kamenim/samba.git] / source4 / lib / ldb / modules / paged_results.c
index 71b99184a1acc7c1ab9961c573c92c440dd2dcd0..61fce2125fbe07d8123fac48fd679cf87ecc699e 100644 (file)
@@ -10,7 +10,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 +18,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/>.
 */
 
 /*
  *  Author: Simo Sorce
  */
 
-#include "includes.h"
-#include "ldb/include/includes.h"
+#include "ldb_includes.h"
 
 struct message_store {
-       /* keep the whole ldb_async_result as an optimization
+       /* keep the whole ldb_reply as an optimization
         * instead of freeing and talloc-ing the container
         * on each result */
-       struct ldb_async_result *r;
+       struct ldb_reply *r;
        struct message_store *next;
 };
 
+struct private_data;
+
 struct results_store {
+
+       struct private_data *priv;
+
        char *cookie;
        time_t timestamp;
-       int num_sent; /* To be removed */
-       struct ldb_result *result; /* To be removed */
+
        struct results_store *prev;
        struct results_store *next;
        
@@ -79,208 +81,80 @@ int store_destructor(struct results_store *store)
        if (store->next) {
                store->next->prev = store->prev;
        }
-       
+
+       if (store == store->priv->store) {
+               store->priv->store = NULL;
+       }
+
        return 0;
 }
 
 static struct results_store *new_store(struct private_data *priv)
 {
-       struct results_store *new;
+       struct results_store *newr;
        int new_id = priv->next_free_id++;
 
        /* TODO: we should have a limit on the number of
         * outstanding paged searches
         */
 
-       new = talloc(priv, struct results_store);
-       if (!new) return NULL;
+       newr = talloc(priv, struct results_store);
+       if (!newr) return NULL;
+
+       newr->priv = priv;
 
-       new->cookie = talloc_asprintf(new, "%d", new_id);
-       if (!new->cookie) {
-               talloc_free(new);
+       newr->cookie = talloc_asprintf(newr, "%d", new_id);
+       if (!newr->cookie) {
+               talloc_free(newr);
                return NULL;
        }
 
-       new->timestamp = time(NULL);
+       newr->timestamp = time(NULL);
 
-       new->num_sent = 0; /* To be removed */
-       new->result = NULL; /* To be removed */
-
-       new->first = NULL;
-       new->num_entries = 0;
-       new->first_ref = NULL;
-       new->controls = NULL;
+       newr->first = NULL;
+       newr->num_entries = 0;
+       newr->first_ref = NULL;
+       newr->controls = NULL;
 
        /* put this entry as first */
-       new->prev = NULL;
-       new->next = priv->store;
-       if (priv->store != NULL) priv->store->prev = new;
-       priv->store = new;
-
-       talloc_set_destructor(new, store_destructor);
-
-       return new;
-}
-
-/* search */
-static int paged_search_sync(struct ldb_module *module, struct ldb_control *control, struct ldb_request *req)
-{
-       struct private_data *private_data = talloc_get_type(module->private_data, struct private_data);
-       struct results_store *current = NULL;
-       struct ldb_result *paged_result;
-       struct ldb_control **saved_controls;
-       struct ldb_paged_control *paged_ctrl;
-       struct ldb_paged_control *paged_ret;
-       int i, ret;
-
-       paged_ctrl = talloc_get_type(control->data, struct ldb_paged_control);
-       if (!paged_ctrl) {
-               return LDB_ERR_PROTOCOL_ERROR;
-       }
-
-       /* check if it is a continuation search the store */
-       if (paged_ctrl->cookie_len != 0) {
-               for (current = private_data->store; current; current = current->next) {
-                       if (strcmp(current->cookie, paged_ctrl->cookie) == 0) {
-                               current->timestamp = time(NULL);
-                               break;
-                       }
-               }
-               if (current == NULL) {
-                       return LDB_ERR_UNWILLING_TO_PERFORM;
-               }
-       }
-
-       /* is this a brand new paged request ? */
-       if (current == NULL) {
-
-               /* save controls list and remove this one from the list */
-               if (!save_controls(control, req, &saved_controls)) {
-                       return LDB_ERR_OTHER;
-               }
-
-               /* perform the search */
-               ret = ldb_next_request(module, req);
-
-               /* restore original controls list */
-               if (req->controls) talloc_free(req->controls);
-               req->controls = saved_controls;
-
-               if (ret != LDB_SUCCESS) {
-                       return ret;
-               }
-
-               /* create a new entry in the cache */
-               current = new_store(private_data);
-               if (!current) {
-                       return LDB_ERR_OTHER;
-               }
-
-               /* steal the search result */
-               current->result = talloc_steal(current, req->op.search.res);
-               req->op.search.res = NULL;
-       }
+       newr->prev = NULL;
+       newr->next = priv->store;
+       if (priv->store != NULL) priv->store->prev = newr;
+       priv->store = newr;
 
-       /* create a container for the next batch of results */
-       paged_result = talloc(current, struct ldb_result);
-       if (!paged_result) {
-               return LDB_ERR_OTHER;
-       }
-       paged_result->count = 0;
-       paged_result->msgs = NULL;
-       paged_result->controls = NULL;
-
-       /* check if it is an abandon */
-       if (paged_ctrl->size == 0) {
-               req->op.search.res = talloc_steal(private_data, paged_result);
-               talloc_free(current);
-               return LDB_SUCCESS;
-       }
-
-       /* return a batch of results */
-               
-       paged_result->controls = talloc_array(paged_result, struct ldb_control *, 2);
-       if (!paged_result->controls) {
-               talloc_free(paged_result);
-               return LDB_ERR_OTHER;
-       }
-
-       paged_result->controls[0] = talloc(paged_result->controls, struct ldb_control);
-       if (!paged_result->controls[0]) {
-               talloc_free(paged_result);
-               return LDB_ERR_OTHER;
-       }
-       paged_result->controls[0]->oid = talloc_strdup(paged_result->controls[0], LDB_CONTROL_PAGED_RESULTS_OID);
-       paged_result->controls[0]->critical = 0;
-       paged_result->controls[1] = NULL;
-
-       paged_ret = talloc(paged_result->controls[0], struct ldb_paged_control);
-       if (!paged_ret) {
-               talloc_free(paged_result);
-               return LDB_ERR_OTHER;
-       }
-       paged_result->controls[0]->data = paged_ret;
-
-       if (paged_ctrl->size >= current->result->count) {
-               paged_ret->size = 0;
-               paged_ret->cookie = NULL;
-               paged_ret->cookie_len = 0;
-               paged_result->count = current->result->count;
-               current->result->count = 0;
-       } else {
-               paged_ret->size = current->result->count;
-               paged_ret->cookie = talloc_strdup(paged_ret, current->cookie);
-               paged_ret->cookie_len = strlen(paged_ret->cookie) + 1;
-               paged_result->count = paged_ctrl->size;
-               current->result->count -= paged_ctrl->size;
-       }
-
-       paged_result->msgs = talloc_array(paged_result, struct ldb_message *, paged_result->count + 1);
-       if (!paged_result->msgs) {
-               talloc_free(paged_result);
-               return LDB_ERR_OTHER;
-       }
-       for (i = 0; i < paged_result->count; i++) {
-               paged_result->msgs[i] = talloc_steal(paged_result->msgs, current->result->msgs[current->num_sent + i]);
-       }
-       current->num_sent += paged_result->count;
-       paged_result->msgs[paged_result->count] = NULL;
-
-       req->op.search.res = paged_result;
+       talloc_set_destructor(newr, store_destructor);
 
-       return LDB_SUCCESS;     
+       return newr;
 }
 
-struct paged_async_context {
+struct paged_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 *);
 
        int size;
 
        struct results_store *store;
 };
 
-static struct ldb_async_handle *init_handle(void *mem_ctx, struct ldb_module *module,
+static struct ldb_handle *init_handle(void *mem_ctx, struct ldb_module *module,
                                            void *context,
-                                           int (*callback)(struct ldb_context *, void *, struct ldb_async_result *),
-                                           int timeout)
+                                           int (*callback)(struct ldb_context *, void *, struct ldb_reply *))
 {
-       struct paged_async_context *ac;
-       struct ldb_async_handle *h;
+       struct paged_context *ac;
+       struct ldb_handle *h;
 
-       h = talloc_zero(mem_ctx, struct ldb_async_handle);
+       h = talloc_zero(mem_ctx, struct ldb_handle);
        if (h == NULL) {
-               ldb_set_errstring(module->ldb, talloc_asprintf(module, "Out of Memory"));
+               ldb_set_errstring(module->ldb, "Out of Memory");
                return NULL;
        }
 
        h->module = module;
 
-       ac = talloc_zero(h, struct paged_async_context);
+       ac = talloc_zero(h, struct paged_context);
        if (ac == NULL) {
-               ldb_set_errstring(module->ldb, talloc_asprintf(module, "Out of Memory"));
+               ldb_set_errstring(module->ldb, "Out of Memory");
                talloc_free(h);
                return NULL;
        }
@@ -293,21 +167,20 @@ static struct ldb_async_handle *init_handle(void *mem_ctx, struct ldb_module *mo
        ac->module = module;
        ac->up_context = context;
        ac->up_callback = callback;
-       ac->timeout = timeout;
 
        return h;
 }
 
-static int paged_search_async_callback(struct ldb_context *ldb, void *context, struct ldb_async_result *ares)
+static int paged_search_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
 {
-       struct paged_async_context *ac = NULL;
+       struct paged_context *ac = NULL;
 
        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 paged_async_context);
+       ac = talloc_get_type(context, struct paged_context);
 
        if (ares->type == LDB_REPLY_ENTRY) {
                if (ac->store->first == NULL) {
@@ -323,9 +196,6 @@ static int paged_search_async_callback(struct ldb_context *ldb, void *context, s
                ac->store->num_entries++;
 
                ac->store->last->r = talloc_steal(ac->store->last, ares);
-               if (ac->store->last->r == NULL) {
-                       goto error;
-               }
                ac->store->last->next = NULL;
        }
 
@@ -341,19 +211,11 @@ static int paged_search_async_callback(struct ldb_context *ldb, void *context, s
                }
 
                ac->store->last_ref->r = talloc_steal(ac->store->last, ares);
-               if (ac->store->last_ref->r == NULL) {
-                       goto error;
-               }
                ac->store->last_ref->next = NULL;
        }
 
        if (ares->type == LDB_REPLY_DONE) {
-               if (ares->controls) {
-                       ac->store->controls = talloc_steal(ac->store, ares->controls);
-                       if (! ac->store->controls) {
-                               goto error;
-                       }
-               }
+               ac->store->controls = talloc_move(ac->store, &ares->controls);
                talloc_free(ares);
        }
 
@@ -370,12 +232,12 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
        struct private_data *private_data;
        struct ldb_paged_control *paged_ctrl;
        struct ldb_control **saved_controls;
-       struct paged_async_context *ac;
-       struct ldb_async_handle *h;
+       struct paged_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_PAGED_RESULTS_OID);
+       control = ldb_request_get_control(req, LDB_CONTROL_PAGED_RESULTS_OID);
        if (control == NULL) {
                /* not found go on */
                return ldb_next_request(module, req);
@@ -383,11 +245,11 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
 
        private_data = talloc_get_type(module->private_data, struct private_data);
 
-       req->async.handle = NULL;
+       req->handle = NULL;
 
-       if (!req->async.callback || !req->async.context) {
-               ldb_set_errstring(module->ldb, talloc_asprintf(module,
-                                 "Async interface called with NULL callback function or NULL context"));
+       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;
        }
        
@@ -396,11 +258,11 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
                return LDB_ERR_PROTOCOL_ERROR;
        }
 
-       h = init_handle(req, module, req->async.context, req->async.callback, req->async.timeout);
+       h = init_handle(req, module, req->context, req->callback);
        if (!h) {
                return LDB_ERR_OPERATIONS_ERROR;
        }
-       ac = talloc_get_type(h->private_data, struct paged_async_context);
+       ac = talloc_get_type(h->private_data, struct paged_context);
 
        ac->size = paged_ctrl->size;
 
@@ -431,9 +293,9 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
                        return LDB_ERR_OPERATIONS_ERROR;
                }
 
-               ac->store->req->async.context = ac;
-               ac->store->req->async.callback = paged_search_async_callback;
-               ac->store->req->async.timeout = req->async.timeout;
+               ac->store->req->context = ac;
+               ac->store->req->callback = paged_search_callback;
+               ldb_set_timeout_from_prev_req(module->ldb, req, ac->store->req);
 
                ret = ldb_next_request(module, ac->store->req);
 
@@ -455,7 +317,7 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
                ret = LDB_SUCCESS;
        }
 
-       req->async.handle = h;
+       req->handle = h;
 
        /* check if it is an abandon */
        if (ac->size == 0) {
@@ -471,15 +333,15 @@ static int paged_search(struct ldb_module *module, struct ldb_request *req)
 
 }
 
-static int paged_results(struct ldb_async_handle *handle)
+static int paged_results(struct ldb_handle *handle)
 {
-       struct paged_async_context *ac;
+       struct paged_context *ac;
        struct ldb_paged_control *paged;
-       struct ldb_async_result *ares;
+       struct ldb_reply *ares;
        struct message_store *msg;
        int i, num_ctrls, ret;
 
-       ac = talloc_get_type(handle->private_data, struct paged_async_context);
+       ac = talloc_get_type(handle->private_data, struct paged_context);
 
        if (ac->store == NULL)
                return LDB_ERR_OPERATIONS_ERROR;
@@ -514,7 +376,7 @@ static int paged_results(struct ldb_async_handle *handle)
                talloc_free(msg);
        }
 
-       ares = talloc_zero(ac->store, struct ldb_async_result);
+       ares = talloc_zero(ac->store, struct ldb_reply);
        if (ares == NULL) {
                handle->status = LDB_ERR_OPERATIONS_ERROR;
                return handle->status;
@@ -526,7 +388,7 @@ static int paged_results(struct ldb_async_handle *handle)
                ares->controls = ac->store->controls;
                while (ares->controls[i]) i++; /* counting */
 
-               ares->controls = talloc_steal(ares, ac->store->controls);
+               ares->controls = talloc_move(ares, &ac->store->controls);
                num_ctrls += i;
        }
 
@@ -578,9 +440,9 @@ static int paged_results(struct ldb_async_handle *handle)
        return ret;
 }
 
-static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait_type type)
+static int paged_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 {
-       struct paged_async_context *ac;
+       struct paged_context *ac;
        int ret;
     
        if (!handle || !handle->private_data) {
@@ -593,9 +455,9 @@ static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait
 
        handle->state = LDB_ASYNC_PENDING;
 
-       ac = talloc_get_type(handle->private_data, struct paged_async_context);
+       ac = talloc_get_type(handle->private_data, struct paged_context);
 
-       if (ac->store->req->async.handle->state == LDB_ASYNC_DONE) {
+       if (ac->store->req->handle->state == LDB_ASYNC_DONE) {
                /* if lower level is finished we do not need to call it anymore */
                /* return all we have until size == 0 or we empty storage */
                ret = paged_results(handle);
@@ -610,8 +472,8 @@ static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait
        }
 
        if (type == LDB_WAIT_ALL) {
-               while (ac->store->req->async.handle->state != LDB_ASYNC_DONE) {
-                       ret = ldb_async_wait(ac->store->req->async.handle, type);
+               while (ac->store->req->handle->state != LDB_ASYNC_DONE) {
+                       ret = ldb_wait(ac->store->req->handle, type);
                        if (ret != LDB_SUCCESS) {
                                handle->state = LDB_ASYNC_DONE;
                                handle->status = ret;
@@ -630,7 +492,7 @@ static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait
                return ret;
        }
 
-       ret = ldb_async_wait(ac->store->req->async.handle, type);
+       ret = ldb_wait(ac->store->req->handle, type);
        if (ret != LDB_SUCCESS) {
                handle->state = LDB_ASYNC_DONE;
                handle->status = ret;
@@ -640,7 +502,7 @@ static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait
        handle->status = ret;
 
        if (ac->store->num_entries >= ac->size ||
-           ac->store->req->async.handle->state == LDB_ASYNC_DONE) {
+           ac->store->req->handle->state == LDB_ASYNC_DONE) {
 
                ret = paged_results(handle);
 
@@ -654,28 +516,6 @@ static int paged_async_wait(struct ldb_async_handle *handle, enum ldb_async_wait
        return ret;
 }
 
-static int paged_request(struct ldb_module *module, struct ldb_request *req)
-{
-       struct ldb_control *control;
-
-       /* check if there's a paged request control */
-       control = get_control_from_list(req->controls, LDB_CONTROL_PAGED_RESULTS_OID);
-       if (control == NULL) {
-               /* not found go on */
-               return ldb_next_request(module, req);
-       }
-
-       switch (req->operation) {
-
-       case LDB_REQ_SEARCH:
-               return paged_search_sync(module, control, req);
-
-       default:
-               return LDB_ERR_PROTOCOL_ERROR;
-
-       }
-}
-
 static int paged_request_init(struct ldb_module *module)
 {
        struct private_data *data;
@@ -696,15 +536,13 @@ static int paged_request_init(struct ldb_module *module)
                return LDB_ERR_OPERATIONS_ERROR;
        }
 
-       req->operation = LDB_REQ_REGISTER;
-       req->op.reg.oid = LDB_CONTROL_PAGED_RESULTS_OID;
+       req->operation = LDB_REQ_REGISTER_CONTROL;
+       req->op.reg_control.oid = LDB_CONTROL_PAGED_RESULTS_OID;
        req->controls = NULL;
 
        ret = ldb_request(module->ldb, req);
        if (ret != LDB_SUCCESS) {
-               ldb_debug(module->ldb, LDB_DEBUG_ERROR, "paged_request: Unable to register control with rootdse!\n");
-               talloc_free(req);
-               return LDB_ERR_OTHER;
+               ldb_debug(module->ldb, LDB_DEBUG_WARNING, "paged_request: Unable to register control with rootdse!\n");
        }
 
        talloc_free(req);
@@ -714,8 +552,7 @@ static int paged_request_init(struct ldb_module *module)
 static const struct ldb_module_ops paged_ops = {
        .name           = "paged_results",
        .search         = paged_search,
-       .request        = paged_request,
-       .async_wait     = paged_async_wait,
+       .wait           = paged_wait,
        .init_context   = paged_request_init
 };