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