LDB:sort module - change counters to "unsigned" where appropriate
[ira/wip.git] / source4 / lib / ldb / modules / sort.c
1 /* 
2    ldb database library
3
4    Copyright (C) Simo Sorce  2005-2008
5
6      ** NOTE! The following LGPL license applies to the ldb
7      ** library. This does NOT imply that all of Samba is released
8      ** under the LGPL
9    
10    This library is free software; you can redistribute it and/or
11    modify it under the terms of the GNU Lesser General Public
12    License as published by the Free Software Foundation; either
13    version 3 of the License, or (at your option) any later version.
14
15    This library is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    Lesser General Public License for more details.
19
20    You should have received a copy of the GNU Lesser General Public
21    License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 */
23
24 /*
25  *  Name: ldb
26  *
27  *  Component: ldb server side sort control module
28  *
29  *  Description: this module sorts the results of a search
30  *
31  *  Author: Simo Sorce
32  */
33
34 #include "ldb_module.h"
35
36 struct opaque {
37         struct ldb_context *ldb;
38         const struct ldb_attrib_handler *h;
39         const char *attribute;
40         int reverse;
41         int result;
42 };
43
44 struct sort_context {
45         struct ldb_module *module;
46
47         const char *attributeName;
48         const char *orderingRule;
49         int reverse;
50
51         struct ldb_request *req;
52         struct ldb_message **msgs;
53         char **referrals;
54         unsigned int num_msgs;
55         unsigned int num_refs;
56
57         const struct ldb_schema_attribute *a;
58         int sort_result;
59 };
60
61 static int build_response(void *mem_ctx, struct ldb_control ***ctrls, int result, const char *desc)
62 {
63         struct ldb_control **controls;
64         struct ldb_sort_resp_control *resp;
65         unsigned int i;
66
67         if (*ctrls) {
68                 controls = *ctrls;
69                 for (i = 0; controls[i]; i++);
70                 controls = talloc_realloc(mem_ctx, controls, struct ldb_control *, i + 2);
71         } else {
72                 i = 0;
73                 controls = talloc_array(mem_ctx, struct ldb_control *, 2);
74         }
75         if (! controls )
76                 return LDB_ERR_OPERATIONS_ERROR;
77
78         *ctrls = controls;
79
80         controls[i+1] = NULL;
81         controls[i] = talloc(controls, struct ldb_control);
82         if (! controls[i] )
83                 return LDB_ERR_OPERATIONS_ERROR;
84
85         controls[i]->oid = LDB_CONTROL_SORT_RESP_OID;
86         controls[i]->critical = 0;
87
88         resp = talloc(controls[i], struct ldb_sort_resp_control);
89         if (! resp )
90                 return LDB_ERR_OPERATIONS_ERROR;
91
92         resp->result = result;
93         resp->attr_desc = talloc_strdup(resp, desc);
94
95         if (! resp->attr_desc )
96                 return LDB_ERR_OPERATIONS_ERROR;
97         
98         controls[i]->data = resp;
99
100         return LDB_SUCCESS;
101 }
102
103 static int sort_compare(struct ldb_message **msg1, struct ldb_message **msg2, void *opaque)
104 {
105         struct sort_context *ac = talloc_get_type(opaque, struct sort_context);
106         struct ldb_message_element *el1, *el2;
107         struct ldb_context *ldb;
108
109         ldb = ldb_module_get_ctx(ac->module);
110
111         if (ac->sort_result != 0) {
112                 /* an error occurred previously,
113                  * let's exit the sorting by returning always 0 */
114                 return 0;
115         }
116
117         el1 = ldb_msg_find_element(*msg1, ac->attributeName);
118         el2 = ldb_msg_find_element(*msg2, ac->attributeName);
119
120         if (!el1 && el2) {
121                 return 1;
122         }
123         if (el1 && !el2) {
124                 return -1;
125         }
126         if (!el1 && !el2) {
127                 return 0;
128         }
129
130         if (ac->reverse)
131                 return ac->a->syntax->comparison_fn(ldb, ac, &el2->values[0], &el1->values[0]);
132
133         return ac->a->syntax->comparison_fn(ldb, ac, &el1->values[0], &el2->values[0]);
134 }
135
136 static int server_sort_results(struct sort_context *ac)
137 {
138         struct ldb_context *ldb;
139         struct ldb_reply *ares;
140         unsigned int i;
141         int ret;
142
143         ldb = ldb_module_get_ctx(ac->module);
144
145         ac->a = ldb_schema_attribute_by_name(ldb, ac->attributeName);
146         ac->sort_result = 0;
147
148         LDB_TYPESAFE_QSORT(ac->msgs, ac->num_msgs, ac, sort_compare);
149
150         if (ac->sort_result != LDB_SUCCESS) {
151                 return ac->sort_result;
152         }
153
154         for (i = 0; i < ac->num_msgs; i++) {
155                 ares = talloc_zero(ac, struct ldb_reply);
156                 if (!ares) {
157                         return LDB_ERR_OPERATIONS_ERROR;
158                 }
159
160                 ares->type = LDB_REPLY_ENTRY;
161                 ares->message = talloc_move(ares, &ac->msgs[i]);
162
163                 ret = ldb_module_send_entry(ac->req, ares->message, ares->controls);
164                 if (ret != LDB_SUCCESS) {
165                         return ret;
166                 }
167         }
168
169         for (i = 0; i < ac->num_refs; i++) {
170                 ares = talloc_zero(ac, struct ldb_reply);
171                 if (!ares) {
172                         return LDB_ERR_OPERATIONS_ERROR;
173                 }
174
175                 ares->type = LDB_REPLY_REFERRAL;
176                 ares->referral = talloc_move(ares, &ac->referrals[i]);
177
178                 ret = ldb_module_send_referral(ac->req, ares->referral);
179                 if (ret != LDB_SUCCESS) {
180                         return ret;
181                 }
182         }
183
184         return LDB_SUCCESS;
185 }
186
187 static int server_sort_search_callback(struct ldb_request *req, struct ldb_reply *ares)
188 {
189         struct sort_context *ac;
190         struct ldb_context *ldb;
191         int ret;
192
193         ac = talloc_get_type(req->context, struct sort_context);
194         ldb = ldb_module_get_ctx(ac->module);
195
196         if (!ares) {
197                 return ldb_module_done(ac->req, NULL, NULL,
198                                         LDB_ERR_OPERATIONS_ERROR);
199         }
200         if (ares->error != LDB_SUCCESS) {
201                 return ldb_module_done(ac->req, ares->controls,
202                                         ares->response, ares->error);
203         }
204
205         switch (ares->type) {
206         case LDB_REPLY_ENTRY:
207                 ac->msgs = talloc_realloc(ac, ac->msgs, struct ldb_message *, ac->num_msgs + 2);
208                 if (! ac->msgs) {
209                         talloc_free(ares);
210                         ldb_oom(ldb);
211                         return ldb_module_done(ac->req, NULL, NULL,
212                                                 LDB_ERR_OPERATIONS_ERROR);
213                 }
214
215                 ac->msgs[ac->num_msgs] = talloc_steal(ac->msgs, ares->message);
216                 ac->num_msgs++;
217                 ac->msgs[ac->num_msgs] = NULL;
218
219                 break;
220
221         case LDB_REPLY_REFERRAL:
222                 ac->referrals = talloc_realloc(ac, ac->referrals, char *, ac->num_refs + 2);
223                 if (! ac->referrals) {
224                         talloc_free(ares);
225                         ldb_oom(ldb);
226                         return ldb_module_done(ac->req, NULL, NULL,
227                                                 LDB_ERR_OPERATIONS_ERROR);
228                 }
229
230                 ac->referrals[ac->num_refs] = talloc_steal(ac->referrals, ares->referral);
231                 ac->num_refs++;
232                 ac->referrals[ac->num_refs] = NULL;
233
234                 break;
235
236         case LDB_REPLY_DONE:
237
238                 ret = server_sort_results(ac);
239                 return ldb_module_done(ac->req, ares->controls,
240                                         ares->response, ret);
241         }
242
243         talloc_free(ares);
244         return LDB_SUCCESS;
245 }
246
247 static int server_sort_search(struct ldb_module *module, struct ldb_request *req)
248 {
249         struct ldb_control *control;
250         struct ldb_server_sort_control **sort_ctrls;
251         struct ldb_control **saved_controls;
252         struct ldb_control **controls;
253         struct ldb_request *down_req;
254         struct sort_context *ac;
255         struct ldb_context *ldb;
256         int ret;
257
258         ldb = ldb_module_get_ctx(module);
259
260         /* check if there's a server sort control */
261         control = ldb_request_get_control(req, LDB_CONTROL_SERVER_SORT_OID);
262         if (control == NULL) {
263                 /* not found go on */
264                 return ldb_next_request(module, req);
265         }
266
267         ac = talloc_zero(req, struct sort_context);
268         if (ac == NULL) {
269                 ldb_oom(ldb);
270                 return LDB_ERR_OPERATIONS_ERROR;
271         }
272
273         ac->module = module;
274         ac->req = req;
275
276         sort_ctrls = talloc_get_type(control->data, struct ldb_server_sort_control *);
277         if (!sort_ctrls) {
278                 return LDB_ERR_PROTOCOL_ERROR;
279         }
280
281         /* FIXME: we do not support more than one attribute for sorting right now */
282         /* FIXME: we need to check if the attribute type exist or return an error */
283                 
284         if (sort_ctrls[1] != NULL) {
285                 if (control->critical) {
286
287                         /* callback immediately */
288                         ret = build_response(req, &controls,
289                                              LDB_ERR_UNWILLING_TO_PERFORM,
290                                              "sort control is not complete yet");
291                         if (ret != LDB_SUCCESS) {
292                                 return ldb_module_done(req, NULL, NULL,
293                                                     LDB_ERR_OPERATIONS_ERROR);
294                         }
295
296                         return ldb_module_done(req, controls, NULL, ret);
297                 } else {
298                         /* just pass the call down and don't do any sorting */
299                         return ldb_next_request(module, req);
300                 }
301         }
302
303         ac->attributeName = sort_ctrls[0]->attributeName;
304         ac->orderingRule = sort_ctrls[0]->orderingRule;
305         ac->reverse = sort_ctrls[0]->reverse;
306
307         ret = ldb_build_search_req_ex(&down_req, ldb, ac,
308                                         req->op.search.base,
309                                         req->op.search.scope,
310                                         req->op.search.tree,
311                                         req->op.search.attrs,
312                                         req->controls,
313                                         ac,
314                                         server_sort_search_callback,
315                                         req);
316         if (ret != LDB_SUCCESS) {
317                 return ret;
318         }
319
320         /* save it locally and remove it from the list */
321         /* we do not need to replace them later as we
322          * are keeping the original req intact */
323         if (!save_controls(control, down_req, &saved_controls)) {
324                 return LDB_ERR_OPERATIONS_ERROR;
325         }
326
327         return ldb_next_request(module, down_req);
328 }
329
330 static int server_sort_init(struct ldb_module *module)
331 {
332         struct ldb_context *ldb;
333         int ret;
334
335         ldb = ldb_module_get_ctx(module);
336
337         ret = ldb_mod_register_control(module, LDB_CONTROL_SERVER_SORT_OID);
338         if (ret != LDB_SUCCESS) {
339                 ldb_debug(ldb, LDB_DEBUG_WARNING,
340                         "server_sort:"
341                         "Unable to register control with rootdse!");
342         }
343
344         return ldb_next_init(module);
345 }
346
347 const struct ldb_module_ops ldb_server_sort_module_ops = {
348         .name              = "server_sort",
349         .search            = server_sort_search,
350         .init_context      = server_sort_init
351 };