11503e6d3bb6e0f0567ffe50a0aba759de0a8344
[samba.git] / source4 / dsdb / samdb / ldb_modules / show_deleted.c
1 /* 
2    ldb database library
3
4    Copyright (C) Simo Sorce  2005
5    Copyright (C) Stefan Metzmacher <metze@samba.org> 2007
6    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2009
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 /*
23  *  Name: ldb
24  *
25  *  Component: ldb deleted objects control module
26  *
27  *  Description: this module hides deleted objects, and returns them if the right control is there
28  *
29  *  Author: Stefan Metzmacher
30  */
31
32 #include "includes.h"
33 #include "ldb/include/ldb_module.h"
34 #include "dsdb/samdb/samdb.h"
35
36
37 static int show_deleted_search(struct ldb_module *module, struct ldb_request *req)
38 {
39         struct ldb_context *ldb;
40         struct ldb_control *control;
41         struct ldb_control **saved_controls;
42         struct ldb_request *down_req;
43         struct ldb_parse_tree *new_tree = req->op.search.tree;
44         int ret;
45
46         ldb = ldb_module_get_ctx(module);
47
48         /* check if there's a show deleted control */
49         control = ldb_request_get_control(req, LDB_CONTROL_SHOW_DELETED_OID);
50
51         if (! control) {
52                 /* FIXME: we could use a constant tree here once we
53                    are sure that no ldb modules modify trees
54                    in-situ */
55                 new_tree = talloc(req, struct ldb_parse_tree);
56                 if (!new_tree) {
57                         ldb_oom(ldb);
58                         return LDB_ERR_OPERATIONS_ERROR;
59                 }
60                 new_tree->operation = LDB_OP_AND;
61                 new_tree->u.list.num_elements = 2;
62                 new_tree->u.list.elements = talloc_array(new_tree, struct ldb_parse_tree *, 2);
63                 if (!new_tree->u.list.elements) {
64                         ldb_oom(ldb);
65                         return LDB_ERR_OPERATIONS_ERROR;
66                 }
67                 new_tree->u.list.elements[0] = talloc(new_tree->u.list.elements, struct ldb_parse_tree);
68                 new_tree->u.list.elements[0]->operation = LDB_OP_NOT;
69                 new_tree->u.list.elements[0]->u.isnot.child =
70                         talloc(new_tree->u.list.elements, struct ldb_parse_tree);
71                 if (!new_tree->u.list.elements[0]->u.isnot.child) {
72                         ldb_oom(ldb);
73                         return LDB_ERR_OPERATIONS_ERROR;
74                 }
75                 new_tree->u.list.elements[0]->u.isnot.child->operation = LDB_OP_EQUALITY;
76                 new_tree->u.list.elements[0]->u.isnot.child->u.equality.attr = "isDeleted";
77                 new_tree->u.list.elements[0]->u.isnot.child->u.equality.value = data_blob_string_const("TRUE");
78                 new_tree->u.list.elements[1] = req->op.search.tree;
79         }
80         
81         ret = ldb_build_search_req_ex(&down_req, ldb, req,
82                                       req->op.search.base,
83                                       req->op.search.scope,
84                                       new_tree,
85                                       req->op.search.attrs,
86                                       req->controls,
87                                       req->context, req->callback,
88                                       req);
89         if (ret != LDB_SUCCESS) {
90                 return ret;
91         }
92
93         /* if a control is there remove if from the modified request */
94         if (control && !save_controls(control, down_req, &saved_controls)) {
95                 return LDB_ERR_OPERATIONS_ERROR;
96         }
97
98         /* perform the search */
99         return ldb_next_request(module, down_req);
100 }
101
102 static int show_deleted_init(struct ldb_module *module)
103 {
104         struct ldb_context *ldb;
105         int ret;
106
107         ldb = ldb_module_get_ctx(module);
108
109         ret = ldb_mod_register_control(module, LDB_CONTROL_SHOW_DELETED_OID);
110         if (ret != LDB_SUCCESS) {
111                 ldb_debug(ldb, LDB_DEBUG_ERROR,
112                         "show_deleted: Unable to register control with rootdse!\n");
113                 return LDB_ERR_OPERATIONS_ERROR;
114         }
115
116         return ldb_next_init(module);
117 }
118
119 _PUBLIC_ const struct ldb_module_ops ldb_show_deleted_module_ops = {
120         .name              = "show_deleted",
121         .search            = show_deleted_search,
122         .init_context      = show_deleted_init
123 };