4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2004-2005
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
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 2 of the License, or (at your option) any later version.
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.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Component: ldb private header
32 * Description: defines internal ldb structures used by the subsystem and modules
34 * Author: Andrew Tridgell
35 * Author: Stefan Metzmacher
38 #ifndef _LDB_PRIVATE_H_
39 #define _LDB_PRIVATE_H_ 1
43 struct ldb_module_ops;
45 /* basic module structure */
47 struct ldb_module *prev, *next;
48 struct ldb_context *ldb;
50 const struct ldb_module_ops *ops;
54 these function pointers define the operations that a ldb module must perform
55 they correspond exactly to the ldb_*() interface
57 struct ldb_module_ops {
59 int (*request)(struct ldb_module *, struct ldb_request *);
60 int (*start_transaction)(struct ldb_module *);
61 int (*end_transaction)(struct ldb_module *);
62 int (*del_transaction)(struct ldb_module *);
63 int (*second_stage_init)(struct ldb_module *);
68 schema related information needed for matching rules
71 /* attribute handling table */
72 unsigned num_attrib_handlers;
73 struct ldb_attrib_handler *attrib_handlers;
75 /* objectclass information */
84 every ldb connection is started by establishing a ldb_context
87 /* the operations provided by the backend */
88 struct ldb_module *modules;
90 /* debugging operations */
91 struct ldb_debug_ops debug_ops;
93 /* custom utf8 functions */
94 struct ldb_utf8_fns utf8_fns;
96 /* backend specific opaque parameters */
98 struct ldb_opaque *next;
103 struct ldb_schema schema;
107 int transaction_active;
110 /* the modules init function */
111 typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, const char **);
114 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
118 simplify out of memory handling
120 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
122 /* The following definitions come from lib/ldb/common/ldb.c */
123 int ldb_second_stage_init(struct ldb_context *ldb);
125 /* The following definitions come from lib/ldb/common/ldb_modules.c */
127 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
128 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
129 int ldb_next_start_trans(struct ldb_module *module);
130 int ldb_next_end_trans(struct ldb_module *module);
131 int ldb_next_del_trans(struct ldb_module *module);
132 int ldb_next_second_stage_init(struct ldb_module *module);
134 void ldb_set_errstring(struct ldb_module *module, char *err_string);
136 /* The following definitions come from lib/ldb/common/ldb_debug.c */
137 void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
138 void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level,
139 const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
141 /* The following definitions come from lib/ldb/common/ldb_ldif.c */
142 int ldb_should_b64_encode(const struct ldb_val *val);
144 int ltdb_connect(struct ldb_context *ldb, const char *url,
146 const char *options[]);
147 int lldb_connect(struct ldb_context *ldb, const char *url,
149 const char *options[]);
150 int ildb_connect(struct ldb_context *ldb,
153 const char *options[]);
154 int lsqlite3_connect(struct ldb_context *ldb,
157 const char *options[]);
158 struct ldb_module *objectclass_module_init(struct ldb_context *ldb, const char *options[]);
159 struct ldb_module *operational_module_init(struct ldb_context *ldb, const char *options[]);
160 struct ldb_module *paged_results_module_init(struct ldb_context *ldb, const char *options[]);
161 struct ldb_module *rdn_name_module_init(struct ldb_context *ldb, const char *options[]);
162 struct ldb_module *schema_module_init(struct ldb_context *ldb, const char *options[]);
163 struct ldb_module *server_sort_module_init(struct ldb_context *ldb, const char *options[]);
164 struct ldb_module *asq_module_init(struct ldb_context *ldb, const char *options[]);
167 int ldb_match_msg(struct ldb_context *ldb,
168 struct ldb_message *msg,
169 struct ldb_parse_tree *tree,
170 const struct ldb_dn *base,
171 enum ldb_scope scope);
173 void ldb_remove_attrib_handler(struct ldb_context *ldb, const char *attrib);
174 const struct ldb_attrib_handler *ldb_attrib_handler_syntax(struct ldb_context *ldb,
176 int ldb_set_attrib_handlers(struct ldb_context *ldb,
177 const struct ldb_attrib_handler *handlers,
178 unsigned num_handlers);
179 int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
180 int ldb_set_attrib_handler_syntax(struct ldb_context *ldb,
181 const char *attr, const char *syntax);
183 /* The following definitions come from lib/ldb/common/ldb_attributes.c */
184 const char **ldb_subclass_list(struct ldb_context *ldb, const char *class);
185 void ldb_subclass_remove(struct ldb_context *ldb, const char *class);
186 int ldb_subclass_add(struct ldb_context *ldb, const char *class, const char *subclass);
188 int ldb_handler_copy(struct ldb_context *ldb, void *mem_ctx,
189 const struct ldb_val *in, struct ldb_val *out);
190 int ldb_comparison_binary(struct ldb_context *ldb, void *mem_ctx,
191 const struct ldb_val *v1, const struct ldb_val *v2);
193 /* The following definitions come from lib/ldb/common/ldb_controls.c */
194 struct ldb_control *get_control_from_list(struct ldb_control **controls, const char *oid);
195 int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
196 int check_critical_controls(struct ldb_control **controls);
198 /* The following definitions come from lib/ldb/common/ldb_utf8.c */
199 char *ldb_casefold_default(void *context, void *mem_ctx, const char *s);