30adadcfdc9e4fa0a126a68117babe65c4298b00
[kai/samba.git] / source4 / lib / ldb / include / ldb_private.h
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell    2004
5    Copyright (C) Stefan Metzmacher  2004
6    Copyright (C) Simo Sorce         2004-2005
7
8      ** NOTE! The following LGPL license applies to the ldb
9      ** library. This does NOT imply that all of Samba is released
10      ** under the LGPL
11    
12    This library is free software; you can redistribute it and/or
13    modify it under the terms of the GNU Lesser General Public
14    License as published by the Free Software Foundation; either
15    version 3 of the License, or (at your option) any later version.
16
17    This library is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20    Lesser General Public License for more details.
21
22    You should have received a copy of the GNU Lesser General Public
23    License along with this library; if not, see <http://www.gnu.org/licenses/>.
24 */
25
26 /*
27  *  Name: ldb
28  *
29  *  Component: ldb private header
30  *
31  *  Description: defines internal ldb structures used by the subsystem and modules
32  *
33  *  Author: Andrew Tridgell
34  *  Author: Stefan Metzmacher
35  */
36
37 #ifndef _LDB_PRIVATE_H_
38 #define _LDB_PRIVATE_H_ 1
39
40 struct ldb_context;
41
42 struct ldb_module_ops;
43
44 struct ldb_backend_ops;
45
46 /* basic module structure */
47 struct ldb_module {
48         struct ldb_module *prev, *next;
49         struct ldb_context *ldb;
50         void *private_data;
51         const struct ldb_module_ops *ops;
52 };
53
54 /* 
55    these function pointers define the operations that a ldb module must perform
56    they correspond exactly to the ldb_*() interface 
57 */
58 struct ldb_module_ops {
59         const char *name;
60         int (*init_context) (struct ldb_module *);
61         int (*search)(struct ldb_module *, struct ldb_request *); /* search */
62         int (*add)(struct ldb_module *, struct ldb_request *); /* add */
63         int (*modify)(struct ldb_module *, struct ldb_request *); /* modify */
64         int (*del)(struct ldb_module *, struct ldb_request *); /* delete */
65         int (*rename)(struct ldb_module *, struct ldb_request *); /* rename */
66         int (*request)(struct ldb_module *, struct ldb_request *); /* match any other operation */
67         int (*extended)(struct ldb_module *, struct ldb_request *); /* extended operations */
68         int (*start_transaction)(struct ldb_module *);
69         int (*end_transaction)(struct ldb_module *);
70         int (*del_transaction)(struct ldb_module *);
71         int (*wait)(struct ldb_handle *, enum ldb_wait_type);
72         int (*sequence_number)(struct ldb_module *, struct ldb_request *);
73     void *private_data;
74 };
75
76
77 typedef int (*ldb_connect_fn) (struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[],
78                                struct ldb_module **module);
79
80
81 struct ldb_backend_ops {
82         const char *name;
83         ldb_connect_fn connect_fn;
84 };
85
86 const char *ldb_default_modules_dir(void);
87
88 /*
89   schema related information needed for matching rules
90 */
91 struct ldb_schema {
92         /* attribute handling table */
93         unsigned num_attributes;
94         struct ldb_schema_attribute *attributes;
95 };
96
97 /*
98   every ldb connection is started by establishing a ldb_context
99 */
100 struct ldb_context {
101         /* the operations provided by the backend */
102         struct ldb_module *modules;
103
104         /* debugging operations */
105         struct ldb_debug_ops debug_ops;
106
107         /* custom utf8 functions */
108         struct ldb_utf8_fns utf8_fns;
109
110         /* backend specific opaque parameters */
111         struct ldb_opaque {
112                 struct ldb_opaque *next;
113                 const char *name;
114                 void *value;
115         } *opaque;
116
117         struct ldb_schema schema;
118
119         char *err_string;
120
121         int transaction_active;
122
123         int default_timeout;
124
125         unsigned int flags;
126
127         unsigned int create_perms;
128
129         char *modules_dir;
130
131         struct event_context *ev_ctx;
132 };
133
134 #ifndef ARRAY_SIZE
135 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
136 #endif
137
138 /*
139   simplify out of memory handling
140 */
141 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
142
143 /* The following definitions come from lib/ldb/common/ldb.c  */
144
145 int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
146                         struct ldb_module **backend_module);
147 void ldb_set_default_dns(struct ldb_context *ldb);
148
149 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
150
151 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
152 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out);
153 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
154 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module);
155 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
156 int ldb_next_start_trans(struct ldb_module *module);
157 int ldb_next_end_trans(struct ldb_module *module);
158 int ldb_next_del_trans(struct ldb_module *module);
159 int ldb_next_init(struct ldb_module *module);
160
161 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
162 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
163 void ldb_reset_err_string(struct ldb_context *ldb);
164
165 int ldb_register_module(const struct ldb_module_ops *);
166 int ldb_register_backend(const char *url_prefix, ldb_connect_fn);
167 void *ldb_dso_load_symbol(struct ldb_context *ldb, const char *name,
168                             const char *symbol);
169
170 /* The following definitions come from lib/ldb/common/ldb_debug.c  */
171 void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
172 void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level, 
173                    const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
174
175 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
176 int ldb_should_b64_encode(const struct ldb_val *val);
177
178 extern const struct ldb_module_ops ldb_objectclass_module_ops;
179 extern const struct ldb_module_ops ldb_operational_module_ops;
180 extern const struct ldb_module_ops ldb_paged_results_module_ops;
181 extern const struct ldb_module_ops ldb_rdn_name_module_ops;
182 extern const struct ldb_module_ops ldb_schema_module_ops;
183 extern const struct ldb_module_ops ldb_asq_module_ops;
184 extern const struct ldb_module_ops ldb_server_sort_module_ops;
185 extern const struct ldb_module_ops ldb_ldap_module_ops;
186 extern const struct ldb_module_ops ldb_ildap_module_ops;
187 extern const struct ldb_module_ops ldb_paged_searches_module_ops;
188 extern const struct ldb_module_ops ldb_tdb_module_ops;
189 extern const struct ldb_module_ops ldb_skel_module_ops;
190 extern const struct ldb_module_ops ldb_subtree_rename_module_ops;
191 extern const struct ldb_module_ops ldb_subtree_delete_module_ops;
192 extern const struct ldb_module_ops ldb_sqlite3_module_ops;
193 extern const struct ldb_module_ops ldb_wins_ldb_module_ops;
194 extern const struct ldb_module_ops ldb_ranged_results_module_ops;
195
196 extern const struct ldb_backend_ops ldb_tdb_backend_ops;
197 extern const struct ldb_backend_ops ldb_sqlite3_backend_ops;
198 extern const struct ldb_backend_ops ldb_ldap_backend_ops;
199 extern const struct ldb_backend_ops ldb_ldapi_backend_ops;
200 extern const struct ldb_backend_ops ldb_ldaps_backend_ops;
201
202 int ldb_match_msg(struct ldb_context *ldb,
203                   const struct ldb_message *msg,
204                   const struct ldb_parse_tree *tree,
205                   struct ldb_dn *base,
206                   enum ldb_scope scope);
207
208 const struct ldb_schema_syntax *ldb_standard_syntax_by_name(struct ldb_context *ldb,
209                                                             const char *syntax);
210
211 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
212
213 int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
214                                          const char *name,
215                                          unsigned flags,
216                                          const struct ldb_schema_syntax *syntax);
217 int ldb_schema_attribute_add(struct ldb_context *ldb, 
218                              const char *name,
219                              unsigned flags,
220                              const char *syntax);
221 void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
222 int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
223
224 const char **ldb_subclass_list(struct ldb_context *ldb, const char *classname);
225 void ldb_subclass_remove(struct ldb_context *ldb, const char *classname);
226 int ldb_subclass_add(struct ldb_context *ldb, const char *classname, const char *subclass);
227
228 int ldb_handler_copy(struct ldb_context *ldb, void *mem_ctx,
229                      const struct ldb_val *in, struct ldb_val *out);
230 int ldb_comparison_binary(struct ldb_context *ldb, void *mem_ctx,
231                           const struct ldb_val *v1, const struct ldb_val *v2);
232
233 /* The following definitions come from lib/ldb/common/ldb_controls.c  */
234 struct ldb_control *get_control_from_list(struct ldb_control **controls, const char *oid);
235 int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
236 int check_critical_controls(struct ldb_control **controls);
237
238 /* The following definitions come from lib/ldb/common/ldb_utf8.c */
239 char *ldb_casefold_default(void *context, void *mem_ctx, const char *s, size_t n);
240
241 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
242
243 /**
244   Obtain current/next database sequence number
245 */
246 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
247
248 #define LDB_SEQ_GLOBAL_SEQUENCE    0x01
249 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
250
251
252 #endif