source: trunk/server/source3/lib/ldb/include/ldb_private.h@ 672

Last change on this file since 672 was 414, checked in by Herwig Bauernfeind, 16 years ago

Samba 3.5.0: Initial import
File size: 7.7 KB
Line 
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
40struct ldb_context;
41
42struct ldb_module_ops;
43
44/* basic module structure */
45struct ldb_module {
46 struct ldb_module *prev, *next;
47 struct ldb_context *ldb;
48 void *private_data;
49 const struct ldb_module_ops *ops;
50};
51
52/*
53 these function pointers define the operations that a ldb module must perform
54 they correspond exactly to the ldb_*() interface
55*/
56struct ldb_module_ops {
57 const char *name;
58 int (*init_context) (struct ldb_module *);
59 int (*search)(struct ldb_module *, struct ldb_request *); /* search */
60 int (*add)(struct ldb_module *, struct ldb_request *); /* add */
61 int (*modify)(struct ldb_module *, struct ldb_request *); /* modify */
62 int (*del)(struct ldb_module *, struct ldb_request *); /* delete */
63 int (*rename)(struct ldb_module *, struct ldb_request *); /* rename */
64 int (*request)(struct ldb_module *, struct ldb_request *); /* match any other operation */
65 int (*extended)(struct ldb_module *, struct ldb_request *); /* extended operations */
66 int (*start_transaction)(struct ldb_module *);
67 int (*end_transaction)(struct ldb_module *);
68 int (*del_transaction)(struct ldb_module *);
69 int (*wait)(struct ldb_handle *, enum ldb_wait_type);
70 int (*sequence_number)(struct ldb_module *, struct ldb_request *);
71};
72
73typedef int (*ldb_connect_fn) (struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[],
74 struct ldb_module **module);
75
76/*
77 schema related information needed for matching rules
78*/
79struct ldb_schema {
80 /* attribute handling table */
81 unsigned num_attrib_handlers;
82 struct ldb_attrib_handler *attrib_handlers;
83
84 /* objectclass information */
85 unsigned num_classes;
86 struct ldb_subclass {
87 char *name;
88 char **subclasses;
89 } *classes;
90};
91
92/*
93 every ldb connection is started by establishing a ldb_context
94*/
95struct ldb_context {
96 /* the operations provided by the backend */
97 struct ldb_module *modules;
98
99 /* debugging operations */
100 struct ldb_debug_ops debug_ops;
101
102 /* custom utf8 functions */
103 struct ldb_utf8_fns utf8_fns;
104
105 /* backend specific opaque parameters */
106 struct ldb_opaque {
107 struct ldb_opaque *next;
108 const char *name;
109 void *value;
110 } *opaque;
111
112 struct ldb_schema schema;
113
114 char *err_string;
115
116 int transaction_active;
117
118 int default_timeout;
119
120 unsigned int flags;
121
122 unsigned int create_perms;
123};
124
125#ifndef ARRAY_SIZE
126#define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
127#endif
128
129/*
130 simplify out of memory handling
131*/
132#define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
133
134/* The following definitions come from lib/ldb/common/ldb.c */
135
136int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
137 struct ldb_module **backend_module);
138
139/* The following definitions come from lib/ldb/common/ldb_modules.c */
140
141const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
142int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out);
143int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
144int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module);
145int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
146int ldb_next_start_trans(struct ldb_module *module);
147int ldb_next_end_trans(struct ldb_module *module);
148int ldb_next_del_trans(struct ldb_module *module);
149int ldb_next_init(struct ldb_module *module);
150
151void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
152void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
153void ldb_reset_err_string(struct ldb_context *ldb);
154
155int ldb_register_module(const struct ldb_module_ops *);
156int ldb_register_backend(const char *url_prefix, ldb_connect_fn);
157int ldb_try_load_dso(struct ldb_context *ldb, const char *name);
158
159/* The following definitions come from lib/ldb/common/ldb_debug.c */
160void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
161void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level,
162 const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
163
164/* The following definitions come from lib/ldb/common/ldb_ldif.c */
165int ldb_should_b64_encode(const struct ldb_val *val);
166
167int ldb_objectclass_init(void);
168int ldb_operational_init(void);
169int ldb_paged_results_init(void);
170int ldb_rdn_name_init(void);
171int ldb_schema_init(void);
172int ldb_asq_init(void);
173int ldb_sort_init(void);
174int ldb_ldap_init(void);
175int ldb_ildap_init(void);
176int ldb_tdb_init(void);
177int ldb_sqlite3_init(void);
178
179int ldb_match_msg(struct ldb_context *ldb,
180 const struct ldb_message *msg,
181 const struct ldb_parse_tree *tree,
182 const struct ldb_dn *base,
183 enum ldb_scope scope);
184
185void ldb_remove_attrib_handler(struct ldb_context *ldb, const char *attrib);
186const struct ldb_attrib_handler *ldb_attrib_handler_syntax(struct ldb_context *ldb,
187 const char *syntax);
188int ldb_set_attrib_handlers(struct ldb_context *ldb,
189 const struct ldb_attrib_handler *handlers,
190 unsigned num_handlers);
191int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
192int ldb_set_attrib_handler_syntax(struct ldb_context *ldb,
193 const char *attr, const char *syntax);
194
195/* The following definitions come from lib/ldb/common/ldb_attributes.c */
196const char **ldb_subclass_list(struct ldb_context *ldb, const char *classname);
197void ldb_subclass_remove(struct ldb_context *ldb, const char *classname);
198int ldb_subclass_add(struct ldb_context *ldb, const char *classname, const char *subclass);
199
200int ldb_handler_copy(struct ldb_context *ldb, void *mem_ctx,
201 const struct ldb_val *in, struct ldb_val *out);
202int ldb_comparison_binary(struct ldb_context *ldb, void *mem_ctx,
203 const struct ldb_val *v1, const struct ldb_val *v2);
204
205/* The following definitions come from lib/ldb/common/ldb_controls.c */
206struct ldb_control *get_control_from_list(struct ldb_control **controls, const char *oid);
207int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
208int check_critical_controls(struct ldb_control **controls);
209
210/* The following definitions come from lib/ldb/common/ldb_utf8.c */
211char *ldb_casefold_default(void *context, void *mem_ctx, const char *s);
212
213void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
214
215/**
216 Obtain current/next database sequence number
217*/
218int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
219
220#define LDB_SEQ_GLOBAL_SEQUENCE 0x01
221#define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
222
223
224#endif
Note: See TracBrowser for help on using the repository browser.