6871d8d5525a6fb7072acf1d0959a776128a189e
[samba.git] / source / 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 2 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, write to the Free Software
24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25 */
26
27 /*
28  *  Name: ldb
29  *
30  *  Component: ldb private header
31  *
32  *  Description: defines internal ldb structures used by the subsystem and modules
33  *
34  *  Author: Andrew Tridgell
35  *  Author: Stefan Metzmacher
36  */
37
38 #ifndef _LDB_PRIVATE_H_
39 #define _LDB_PRIVATE_H_ 1
40
41 struct ldb_context;
42
43 struct ldb_module_ops;
44
45 /* basic module structure */
46 struct ldb_module {
47         struct ldb_module *prev, *next;
48         struct ldb_context *ldb;
49         void *private_data;
50         const struct ldb_module_ops *ops;
51 };
52
53 /* 
54    these function pointers define the operations that a ldb module must perform
55    they correspond exactly to the ldb_*() interface 
56 */
57 struct ldb_module_ops {
58         const char *name;
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 *);
64 };
65
66
67 /*
68   schema related information needed for matching rules
69 */
70 struct ldb_schema {
71         /* attribute handling table */
72         unsigned num_attrib_handlers;
73         struct ldb_attrib_handler *attrib_handlers;
74
75         /* objectclass information */
76         unsigned num_classes;
77         struct ldb_subclass {
78                 char *name;
79                 char **subclasses;
80         } *classes;
81 };
82
83 /*
84   every ldb connection is started by establishing a ldb_context
85 */
86 struct ldb_context {
87         /* the operations provided by the backend */
88         struct ldb_module *modules;
89
90         /* debugging operations */
91         struct ldb_debug_ops debug_ops;
92
93         /* backend specific opaque parameters */
94         struct ldb_opaque {
95                 struct ldb_opaque *next;
96                 const char *name;
97                 void *value;
98         } *opaque;
99
100         struct ldb_schema schema;
101
102         char *err_string;
103
104         int transaction_active;
105 };
106
107 /* the modules init function */
108 typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, const char **);
109
110 #ifndef ARRAY_SIZE
111 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
112 #endif
113
114 /*
115   simplify out of memory handling
116 */
117 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
118
119 /* The following definitions come from lib/ldb/common/ldb.c */
120 int ldb_second_stage_init(struct ldb_context *ldb);
121         
122 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
123
124 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
125 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
126 int ldb_next_start_trans(struct ldb_module *module);
127 int ldb_next_end_trans(struct ldb_module *module);
128 int ldb_next_del_trans(struct ldb_module *module);
129 int ldb_next_second_stage_init(struct ldb_module *module);
130
131 void ldb_set_errstring(struct ldb_module *module, char *err_string);
132
133 /* The following definitions come from lib/ldb/common/ldb_debug.c  */
134 void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
135 void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level, 
136                    const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
137
138 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
139 int ldb_should_b64_encode(const struct ldb_val *val);
140
141 int ltdb_connect(struct ldb_context *ldb, const char *url, 
142                  unsigned int flags, 
143                  const char *options[]);
144 int lldb_connect(struct ldb_context *ldb, const char *url, 
145                  unsigned int flags, 
146                  const char *options[]);
147 int ildb_connect(struct ldb_context *ldb,
148                  const char *url, 
149                  unsigned int flags, 
150                  const char *options[]);
151 int lsqlite3_connect(struct ldb_context *ldb,
152                      const char *url, 
153                      unsigned int flags, 
154                      const char *options[]);
155 struct ldb_module *objectclass_module_init(struct ldb_context *ldb, const char *options[]);
156 struct ldb_module *operational_module_init(struct ldb_context *ldb, const char *options[]);
157 struct ldb_module *paged_results_module_init(struct ldb_context *ldb, const char *options[]);
158 struct ldb_module *rdn_name_module_init(struct ldb_context *ldb, const char *options[]);
159 struct ldb_module *schema_module_init(struct ldb_context *ldb, const char *options[]);
160 struct ldb_module *server_sort_module_init(struct ldb_context *ldb, const char *options[]);
161 struct ldb_module *asq_module_init(struct ldb_context *ldb, const char *options[]);
162
163
164 int ldb_match_msg(struct ldb_context *ldb,
165                   struct ldb_message *msg,
166                   struct ldb_parse_tree *tree,
167                   const struct ldb_dn *base,
168                   enum ldb_scope scope);
169
170 void ldb_remove_attrib_handler(struct ldb_context *ldb, const char *attrib);
171 const struct ldb_attrib_handler *ldb_attrib_handler_syntax(struct ldb_context *ldb,
172                                                            const char *syntax);
173 int ldb_set_attrib_handlers(struct ldb_context *ldb, 
174                             const struct ldb_attrib_handler *handlers, 
175                             unsigned num_handlers);
176 int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
177 int ldb_set_attrib_handler_syntax(struct ldb_context *ldb, 
178                                   const char *attr, const char *syntax);
179
180 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
181 const char **ldb_subclass_list(struct ldb_context *ldb, const char *class);
182 void ldb_subclass_remove(struct ldb_context *ldb, const char *class);
183 int ldb_subclass_add(struct ldb_context *ldb, const char *class, const char *subclass);
184
185 int ldb_handler_copy(struct ldb_context *ldb, void *mem_ctx,
186                      const struct ldb_val *in, struct ldb_val *out);
187 int ldb_comparison_binary(struct ldb_context *ldb, void *mem_ctx,
188                           const struct ldb_val *v1, const struct ldb_val *v2);
189
190 /* The following definitions come from lib/ldb/common/ldb_controls.c  */
191 struct ldb_control *get_control_from_list(struct ldb_control **controls, const char *oid);
192 int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
193 int check_critical_controls(struct ldb_control **controls);
194 #endif