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 #include "ldb_includes.h"
  41 #include "ldb.h"
  42 #include "ldb_module.h"
  43
  44 struct ldb_context;
  45
  46 struct ldb_module_ops;
  47
  48 struct ldb_backend_ops;
  49
  50 #define LDB_HANDLE_FLAG_DONE_CALLED 1
  51
  52 struct ldb_handle {
  53         int status;
  54         enum ldb_state state;
  55         struct ldb_context *ldb;
  56         unsigned flags;
  57         unsigned nesting;
  58 };
  59
  60 /* basic module structure */
  61 struct ldb_module {
  62         struct ldb_module *prev, *next;
  63         struct ldb_context *ldb;
  64         void *private_data;
  65         const struct ldb_module_ops *ops;
  66 };
  67
  68 /*
  69   schema related information needed for matching rules
  70 */
  71 struct ldb_schema {
  72         void *attribute_handler_override_private;
  73         ldb_attribute_handler_override_fn_t attribute_handler_override;
  74
  75         /* attribute handling table */
  76         unsigned num_attributes;
  77         struct ldb_schema_attribute *attributes;
  78
  79         unsigned num_dn_extended_syntax;
  80         struct ldb_dn_extended_syntax *dn_extended_syntax;
  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         /* custom utf8 functions */
  94         struct ldb_utf8_fns utf8_fns;
  95
  96         /* backend specific opaque parameters */
  97         struct ldb_opaque {
  98                 struct ldb_opaque *next;
  99                 const char *name;
 100                 void *value;
 101         } *opaque;
 102
 103         struct ldb_schema schema;
 104
 105         char *err_string;
 106
 107         int transaction_active;
 108
 109         int default_timeout;
 110
 111         unsigned int flags;
 112
 113         unsigned int create_perms;
 114
 115         char *modules_dir;
 116
 117         struct tevent_context *ev_ctx;
 118
 119         bool prepare_commit_done;
 120
 121         char *partial_debug;
 122 };
 123
 124 /* The following definitions come from lib/ldb/common/ldb.c  */
 125
 126 int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
 127                         struct ldb_module **backend_module);
 128
 129
 130 extern const struct ldb_module_ops ldb_objectclass_module_ops;
 131 extern const struct ldb_module_ops ldb_paged_results_module_ops;
 132 extern const struct ldb_module_ops ldb_rdn_name_module_ops;
 133 extern const struct ldb_module_ops ldb_schema_module_ops;
 134 extern const struct ldb_module_ops ldb_asq_module_ops;
 135 extern const struct ldb_module_ops ldb_server_sort_module_ops;
 136 extern const struct ldb_module_ops ldb_ldap_module_ops;
 137 extern const struct ldb_module_ops ldb_ildap_module_ops;
 138 extern const struct ldb_module_ops ldb_paged_searches_module_ops;
 139 extern const struct ldb_module_ops ldb_tdb_module_ops;
 140 extern const struct ldb_module_ops ldb_skel_module_ops;
 141 extern const struct ldb_module_ops ldb_subtree_rename_module_ops;
 142 extern const struct ldb_module_ops ldb_subtree_delete_module_ops;
 143 extern const struct ldb_module_ops ldb_sqlite3_module_ops;
 144 extern const struct ldb_module_ops ldb_wins_ldb_module_ops;
 145 extern const struct ldb_module_ops ldb_ranged_results_module_ops;
 146
 147 extern const struct ldb_backend_ops ldb_tdb_backend_ops;
 148 extern const struct ldb_backend_ops ldb_sqlite3_backend_ops;
 149 extern const struct ldb_backend_ops ldb_ldap_backend_ops;
 150 extern const struct ldb_backend_ops ldb_ldapi_backend_ops;
 151 extern const struct ldb_backend_ops ldb_ldaps_backend_ops;
 152
 153 int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
 154
 155 const char **ldb_subclass_list(struct ldb_context *ldb, const char *classname);
 156 void ldb_subclass_remove(struct ldb_context *ldb, const char *classname);
 157 int ldb_subclass_add(struct ldb_context *ldb, const char *classname, const char *subclass);
 158
 159 /* The following definitions come from lib/ldb/common/ldb_utf8.c */
 160 char *ldb_casefold_default(void *context, void *mem_ctx, const char *s, size_t n);
 161
 162 void ldb_dump_results(struct ldb_context *ldb, struct ldb_result *result, FILE *f);
 163
 164
 165 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
 166
 167 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
 168 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out);
 169 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
 170 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module);
 171
 172 struct ldb_val ldb_binary_decode(void *mem_ctx, const char *str);
 173
 174 #endif