Remove last traces of the old 'subclass' feature
[kai/samba.git] / source4 / lib / ldb / include / ldb_private.h
index e8a4d1820a20b9109edae4598fd1630d935cfd28..62a6e35999d69c3e5382191c02b6570110ab7051 100644 (file)
@@ -12,7 +12,7 @@
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
+   version 3 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -20,8 +20,7 @@
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
@@ -29,7 +28,7 @@
  *
  *  Component: ldb private header
  *
- *  Description: defines internal ldb structures used by th esubsystem and modules
+ *  Description: defines internal ldb structures used by thsubsystem and modules
  *
  *  Author: Andrew Tridgell
  *  Author: Stefan Metzmacher
@@ -42,6 +41,8 @@ struct ldb_context;
 
 struct ldb_module_ops;
 
+struct ldb_backend_ops;
+
 /* basic module structure */
 struct ldb_module {
        struct ldb_module *prev, *next;
@@ -56,27 +57,40 @@ struct ldb_module {
 */
 struct ldb_module_ops {
        const char *name;
-       int (*request)(struct ldb_module *, struct ldb_request *);
+       int (*init_context) (struct ldb_module *);
+       int (*search)(struct ldb_module *, struct ldb_request *); /* search */
+       int (*add)(struct ldb_module *, struct ldb_request *); /* add */
+       int (*modify)(struct ldb_module *, struct ldb_request *); /* modify */
+       int (*del)(struct ldb_module *, struct ldb_request *); /* delete */
+       int (*rename)(struct ldb_module *, struct ldb_request *); /* rename */
+       int (*request)(struct ldb_module *, struct ldb_request *); /* match any other operation */
+       int (*extended)(struct ldb_module *, struct ldb_request *); /* extended operations */
        int (*start_transaction)(struct ldb_module *);
        int (*end_transaction)(struct ldb_module *);
        int (*del_transaction)(struct ldb_module *);
+       int (*wait)(struct ldb_handle *, enum ldb_wait_type);
+       int (*sequence_number)(struct ldb_module *, struct ldb_request *);
+};
+
+
+typedef int (*ldb_connect_fn) (struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[],
+                              struct ldb_module **module);
+
+
+struct ldb_backend_ops {
+       const char *name;
+       ldb_connect_fn connect_fn;
 };
 
+const char *ldb_default_modules_dir(void);
 
 /*
   schema related information needed for matching rules
 */
 struct ldb_schema {
        /* attribute handling table */
-       unsigned num_attrib_handlers;
-       struct ldb_attrib_handler *attrib_handlers;
-
-       /* objectclass information */
-       unsigned num_classes;
-       struct ldb_subclass {
-               char *name;
-               char **subclasses;
-       } *classes;
+       unsigned num_attributes;
+       struct ldb_schema_attribute *attributes;
 };
 
 /*
@@ -89,6 +103,9 @@ struct ldb_context {
        /* debugging operations */
        struct ldb_debug_ops debug_ops;
 
+       /* custom utf8 functions */
+       struct ldb_utf8_fns utf8_fns;
+
        /* backend specific opaque parameters */
        struct ldb_opaque {
                struct ldb_opaque *next;
@@ -101,12 +118,17 @@ struct ldb_context {
        char *err_string;
 
        int transaction_active;
-};
 
-/* the modules init function */
-#define LDB_MODULES_INIT_STAGE_1 1
-#define LDB_MODULES_INIT_STAGE_2 2
-typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, int stage, const char **);
+       int default_timeout;
+
+       unsigned int flags;
+
+       unsigned int create_perms;
+
+       char *modules_dir;
+
+       struct event_context *ev_ctx;
+};
 
 #ifndef ARRAY_SIZE
 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
@@ -117,15 +139,32 @@ typedef struct ldb_module *(*ldb_module_init_t)(struct ldb_context *, int stage,
 */
 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
 
+/* The following definitions come from lib/ldb/common/ldb.c  */
+
+int ldb_connect_backend(struct ldb_context *ldb, const char *url, const char *options[],
+                       struct ldb_module **backend_module);
+void ldb_set_default_dns(struct ldb_context *ldb);
+
 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
 
+const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
+int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out);
 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
+int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module);
 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
 int ldb_next_start_trans(struct ldb_module *module);
 int ldb_next_end_trans(struct ldb_module *module);
 int ldb_next_del_trans(struct ldb_module *module);
+int ldb_next_init(struct ldb_module *module);
+
+void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
+void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
+void ldb_reset_err_string(struct ldb_context *ldb);
 
-void ldb_set_errstring(struct ldb_module *module, char *err_string);
+int ldb_register_module(const struct ldb_module_ops *);
+int ldb_register_backend(const char *url_prefix, ldb_connect_fn);
+void *ldb_dso_load_symbol(struct ldb_context *ldb, const char *name,
+                           const char *symbol);
 
 /* The following definitions come from lib/ldb/common/ldb_debug.c  */
 void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
@@ -135,48 +174,55 @@ void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level,
 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
 int ldb_should_b64_encode(const struct ldb_val *val);
 
-int ltdb_connect(struct ldb_context *ldb, const char *url, 
-                unsigned int flags, 
-                const char *options[]);
-int lldb_connect(struct ldb_context *ldb, const char *url, 
-                unsigned int flags, 
-                const char *options[]);
-int ildb_connect(struct ldb_context *ldb,
-                const char *url, 
-                unsigned int flags, 
-                const char *options[]);
-int lsqlite3_connect(struct ldb_context *ldb,
-                    const char *url, 
-                    unsigned int flags, 
-                    const char *options[]);
-struct ldb_module *objectclass_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-struct ldb_module *operational_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-struct ldb_module *paged_results_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-struct ldb_module *rdn_name_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-struct ldb_module *schema_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-struct ldb_module *server_sort_module_init(struct ldb_context *ldb, int stage, const char *options[]);
-
+extern const struct ldb_module_ops ldb_objectclass_module_ops;
+extern const struct ldb_module_ops ldb_operational_module_ops;
+extern const struct ldb_module_ops ldb_paged_results_module_ops;
+extern const struct ldb_module_ops ldb_rdn_name_module_ops;
+extern const struct ldb_module_ops ldb_schema_module_ops;
+extern const struct ldb_module_ops ldb_asq_module_ops;
+extern const struct ldb_module_ops ldb_server_sort_module_ops;
+extern const struct ldb_module_ops ldb_ldap_module_ops;
+extern const struct ldb_module_ops ldb_ildap_module_ops;
+extern const struct ldb_module_ops ldb_paged_searches_module_ops;
+extern const struct ldb_module_ops ldb_tdb_module_ops;
+extern const struct ldb_module_ops ldb_skel_module_ops;
+extern const struct ldb_module_ops ldb_subtree_rename_module_ops;
+extern const struct ldb_module_ops ldb_subtree_delete_module_ops;
+extern const struct ldb_module_ops ldb_sqlite3_module_ops;
+extern const struct ldb_module_ops ldb_wins_ldb_module_ops;
+extern const struct ldb_module_ops ldb_ranged_results_module_ops;
+
+extern const struct ldb_backend_ops ldb_tdb_backend_ops;
+extern const struct ldb_backend_ops ldb_sqlite3_backend_ops;
+extern const struct ldb_backend_ops ldb_ldap_backend_ops;
+extern const struct ldb_backend_ops ldb_ldapi_backend_ops;
+extern const struct ldb_backend_ops ldb_ldaps_backend_ops;
 
 int ldb_match_msg(struct ldb_context *ldb,
-                 struct ldb_message *msg,
-                 struct ldb_parse_tree *tree,
-                 const struct ldb_dn *base,
+                 const struct ldb_message *msg,
+                 const struct ldb_parse_tree *tree,
+                 struct ldb_dn *base,
                  enum ldb_scope scope);
 
-void ldb_remove_attrib_handler(struct ldb_context *ldb, const char *attrib);
-const struct ldb_attrib_handler *ldb_attrib_handler_syntax(struct ldb_context *ldb,
-                                                          const char *syntax);
-int ldb_set_attrib_handlers(struct ldb_context *ldb, 
-                           const struct ldb_attrib_handler *handlers, 
-                           unsigned num_handlers);
-int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
-int ldb_set_attrib_handler_syntax(struct ldb_context *ldb, 
-                                 const char *attr, const char *syntax);
+const struct ldb_schema_syntax *ldb_standard_syntax_by_name(struct ldb_context *ldb,
+                                                           const char *syntax);
 
 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
-const char **ldb_subclass_list(struct ldb_context *ldb, const char *class);
-void ldb_subclass_remove(struct ldb_context *ldb, const char *class);
-int ldb_subclass_add(struct ldb_context *ldb, const char *class, const char *subclass);
+
+int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
+                                        const char *name,
+                                        unsigned flags,
+                                        const struct ldb_schema_syntax *syntax);
+int ldb_schema_attribute_add(struct ldb_context *ldb, 
+                            const char *name,
+                            unsigned flags,
+                            const char *syntax);
+void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
+int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
+
+const char **ldb_subclass_list(struct ldb_context *ldb, const char *classname);
+void ldb_subclass_remove(struct ldb_context *ldb, const char *classname);
+int ldb_subclass_add(struct ldb_context *ldb, const char *classname, const char *subclass);
 
 int ldb_handler_copy(struct ldb_context *ldb, void *mem_ctx,
                     const struct ldb_val *in, struct ldb_val *out);
@@ -187,4 +233,19 @@ int ldb_comparison_binary(struct ldb_context *ldb, void *mem_ctx,
 struct ldb_control *get_control_from_list(struct ldb_control **controls, const char *oid);
 int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
 int check_critical_controls(struct ldb_control **controls);
+
+/* The following definitions come from lib/ldb/common/ldb_utf8.c */
+char *ldb_casefold_default(void *context, void *mem_ctx, const char *s);
+
+void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
+
+/**
+  Obtain current/next database sequence number
+*/
+int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
+
+#define LDB_SEQ_GLOBAL_SEQUENCE    0x01
+#define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
+
+
 #endif