diff options
author | Derrell Lipman <derrell@samba.org> | 2005-06-09 17:16:49 +0000 |
---|---|---|
committer | Gerald (Jerry) Carter <jerry@samba.org> | 2007-10-10 13:17:54 -0500 |
commit | b501bf17ab89b0838cdd13d67f2e16fcc881e59d (patch) | |
tree | 606266b27064642f478daa6da28c531caca1dfd7 | |
parent | 4140ccd0dd9a4570992c1a5b4b688aaab6c1c050 (diff) | |
download | samba-b501bf17ab89b0838cdd13d67f2e16fcc881e59d.tar.gz samba-b501bf17ab89b0838cdd13d67f2e16fcc881e59d.tar.bz2 samba-b501bf17ab89b0838cdd13d67f2e16fcc881e59d.zip |
r7443: reorg functions for readability
(This used to be commit 7543acfa9fe87b43cfee482cf02e56d73d29596b)
-rw-r--r-- | source4/lib/ldb/ldb_sqlite3/ldb_sqlite3.c | 1391 |
1 files changed, 724 insertions, 667 deletions
diff --git a/source4/lib/ldb/ldb_sqlite3/ldb_sqlite3.c b/source4/lib/ldb/ldb_sqlite3/ldb_sqlite3.c index c0e3963743..c16708672d 100644 --- a/source4/lib/ldb/ldb_sqlite3/ldb_sqlite3.c +++ b/source4/lib/ldb/ldb_sqlite3/ldb_sqlite3.c @@ -40,6 +40,10 @@ #include "ldb/include/ldb_explode_dn.h" #include "ldb/ldb_sqlite3/ldb_sqlite3.h" +/* + * Macros used throughout + */ + #ifndef FALSE # define FALSE (0) # define TRUE (! FALSE) @@ -47,9 +51,9 @@ #define QUERY_NOROWS(lsqlite3, bRollbackOnError, sql...) \ do { \ - if (lsqlite3_query_norows(lsqlite3, sql) != 0) { \ + if (query_norows(lsqlite3, sql) != 0) { \ if (bRollbackOnError) { \ - lsqlite3_query_norows(lsqlite3, \ + query_norows(lsqlite3, \ "ROLLBACK;"); \ } \ return -1; \ @@ -58,17 +62,699 @@ #define QUERY_INT(lsqlite3, result_var, bRollbackOnError, sql...) \ do { \ - if (lsqlite3_query_int(lsqlite3, &result_var, sql) != 0) { \ + if (query_int(lsqlite3, &result_var, sql) != 0) { \ if (bRollbackOnError) { \ - lsqlite3_query_norows(lsqlite3, \ + query_norows(lsqlite3, \ "ROLLBACK;"); \ } \ return -1; \ } \ } while (0) + +/* + * Forward declarations + */ +static int +lsqlite3_rename(struct ldb_module * module, + const char * olddn, + const char * newdn); + +static int +lsqlite3_delete(struct ldb_module *module, + const char *dn); + +static int +lsqlite3_search(struct ldb_module * module, + const char * pBaseDN, + enum ldb_scope scope, + const char * pExpression, + const char * const attrs[], + struct ldb_message *** res); + +static int +lsqlite3_add(struct ldb_module *module, + const struct ldb_message *msg); + +static int +lsqlite3_modify(struct ldb_module *module, + const struct ldb_message *msg); + +static int +lsqlite3_lock(struct ldb_module *module, + const char *lockname); + +static int +lsqlite3_unlock(struct ldb_module *module, + const char *lockname); + +static const char * +lsqlite3_errstring(struct ldb_module *module); + +static int +initialize(struct lsqlite3_private *lsqlite3, + const char *url); + +static int +destructor(void *p); + +static int +query_norows(const struct lsqlite3_private *lsqlite3, + const char *pSql, + ...); + +static int +query_int(const struct lsqlite3_private * lsqlite3, + long long * pRet, + const char * pSql, + ...); + +static int case_fold_attr_required(void * hUserData, + char *attr); + +static char * +parsetree_to_sql(struct ldb_module *module, + char * hTalloc, + const struct ldb_parse_tree *t); + +static char * +parsetree_to_tablelist(struct ldb_module *module, + char * hTalloc, + const struct ldb_parse_tree *t); + +static int +new_attr(struct ldb_module * module, + char * pAttrName); + +static int +msg_to_sql(struct ldb_module * module, + const struct ldb_message * msg, + long long eid, + int use_flags); + +static int +new_dn(struct ldb_module * module, + char * pDN, + long long * pEID); + + +/* + * Table of operations for the sqlite3 backend + */ +static const struct ldb_module_ops lsqlite3_ops = { + "sqlite", + lsqlite3_search, + lsqlite3_add, + lsqlite3_modify, + lsqlite3_delete, + lsqlite3_rename, + lsqlite3_lock, + lsqlite3_unlock, + lsqlite3_errstring +}; + + + + +/* + * Public functions + */ + + +/* + * connect to the database + */ +struct ldb_context * +lsqlite3_connect(const char *url, + unsigned int flags, + const char *options[]) +{ + int i; + int ret; + struct ldb_context * ldb = NULL; + struct lsqlite3_private * lsqlite3 = NULL; + + ldb = talloc(NULL, struct ldb_context); + if (!ldb) { + errno = ENOMEM; + goto failed; + } + + lsqlite3 = talloc(ldb, struct lsqlite3_private); + if (!lsqlite3) { + errno = ENOMEM; + goto failed; + } + + lsqlite3->sqlite = NULL; + lsqlite3->options = NULL; + lsqlite3->lock_count = 0; + + ret = initialize(lsqlite3, url); + if (ret != SQLITE_OK) { + goto failed; + } + + talloc_set_destructor(lsqlite3, destructor); + + ldb->modules = talloc(ldb, struct ldb_module); + if (!ldb->modules) { + errno = ENOMEM; + goto failed; + } + ldb->modules->ldb = ldb; + ldb->modules->prev = ldb->modules->next = NULL; + ldb->modules->private_data = lsqlite3; + ldb->modules->ops = &lsqlite3_ops; + + if (options) { + /* + * take a copy of the options array, so we don't have to rely + * on the caller keeping it around (it might be dynamic) + */ + for (i=0;options[i];i++) ; + + lsqlite3->options = talloc_array(lsqlite3, char *, i+1); + if (!lsqlite3->options) { + goto failed; + } + + for (i=0;options[i];i++) { + + lsqlite3->options[i+1] = NULL; + lsqlite3->options[i] = + talloc_strdup(lsqlite3->options, options[i]); + if (!lsqlite3->options[i]) { + goto failed; + } + } + } + + return ldb; + +failed: + if (lsqlite3->sqlite != NULL) { + (void) sqlite3_close(lsqlite3->sqlite); + } + talloc_free(ldb); + return NULL; +} + + /* - * lsqlite3_query_norows() + * Interface functions referenced by lsqlite3_ops + */ + +/* rename a record */ +static int +lsqlite3_rename(struct ldb_module * module, + const char * olddn, + const char * newdn) +{ + /* ignore ltdb specials */ + if (olddn[0] == '@' ||newdn[0] == '@') { + return 0; + } + +#warning "lsqlite3_rename() is not yet supported" + return -1; +} + +/* delete a record */ +static int +lsqlite3_delete(struct ldb_module *module, + const char *dn) +{ + /* ignore ltdb specials */ + if (dn[0] == '@') { + return 0; + } + + return -1; +} + +/* search for matching records */ +static int +lsqlite3_search(struct ldb_module * module, + const char * pBaseDN, + enum ldb_scope scope, + const char * pExpression, + const char * const attrs[], + struct ldb_message *** res) +{ + long long eid = 0; + char * sql; + char * sql_constraints; + char * table_list; + char * hTalloc; + struct ldb_parse_tree * pTree; + struct lsqlite3_private * lsqlite3 = module->private_data; + + if (pBaseDN == NULL) { + pBaseDN = ""; + } + + /* Begin a transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "BEGIN IMMEDIATE;"); + + /* + * Obtain the eid of the base DN + */ + QUERY_INT(lsqlite3, + eid, + TRUE, + "SELECT eid " + " FROM ldb_attr_dn " + " WHERE attr_value = %Q;", + pBaseDN); + + /* Parse the filter expression into a tree we can work with */ + if ((pTree = ldb_parse_tree(module->ldb, pExpression)) == NULL) { + return -1; + } + + /* Allocate a temporary talloc context */ + hTalloc = talloc_new(module->ldb); + + /* Move the parse tree to our temporary context */ + talloc_steal(hTalloc, pTree); + + /* Convert filter into a series of SQL statements (constraints) */ + sql_constraints = parsetree_to_sql(module, hTalloc, pTree); + + /* Get the list of attribute names to use as our extra table list */ + table_list = parsetree_to_tablelist(module, hTalloc, pTree); + + switch(scope) { + case LDB_SCOPE_DEFAULT: + case LDB_SCOPE_SUBTREE: + sql = sqlite3_mprintf( + "SELECT entry.entry_data\n" + " FROM ldb_entry AS entry\n" + " WHERE entry.eid IN\n" + " (SELECT DISTINCT ldb_entry.eid\n" + " FROM ldb_entry,\n" + " ldb_descendants,\n" + " %q\n" + " WHERE ldb_descendants.aeid = %lld\n" + " AND ldb_entry.eid = ldb_descendants.deid\n" + " AND ldap_entry.eid IN\n" + "%s" + ");", + table_list, + eid, + sql_constraints); + break; + + case LDB_SCOPE_BASE: + sql = sqlite3_mprintf( + "SELECT entry.entry_data\n" + " FROM ldb_entry AS entry\n" + " WHERE entry.eid IN\n" + " (SELECT DISTINCT ldb_entry.eid\n" + " FROM %q\n" + " WHERE ldb_entry.eid = %lld\n" + " AND ldb_entry.eid IN\n" + "%s" + ");", + table_list, + eid, + sql_constraints); + break; + + case LDB_SCOPE_ONELEVEL: + sql = sqlite3_mprintf( + "SELECT entry.entry_data\n" + " FROM ldb_entry AS entry\n" + " WHERE entry.eid IN\n" + " (SELECT DISTINCT ldb_entry.eid\n" + " FROM ldb_entry AS pchild, " + " %q\n" + " WHERE ldb_entry.eid = pchild.eid " + " AND pchild.peid = %lld " + " AND ldb_entry.eid IN\n" + "%s" + ");", + table_list, + eid, + sql_constraints); + break; + } + +#warning "retrieve and return the result set of the search here" + + /* End the transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "END TRANSACTION;"); + + return 0; +} + + +/* add a record */ +static int +lsqlite3_add(struct ldb_module *module, + const struct ldb_message *msg) +{ + long long eid; + struct lsqlite3_private * lsqlite3 = module->private_data; + + /* ignore ltdb specials */ + if (msg->dn[0] == '@') { + return 0; + } + + /* Begin a transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); + + /* + * Build any portions of the directory tree that don't exist. If the + * final component already exists, it's an error. + */ + if (new_dn(module, msg->dn, &eid) != 0) { + QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); + return -1; + } + + /* Add attributes to this new entry */ + if (msg_to_sql(module, msg, eid, FALSE) != 0) { + QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); + return -1; + } + + /* Everything worked. Commit it! */ + QUERY_NOROWS(lsqlite3, TRUE, "COMMIT;"); + return 0; +} + + +/* modify a record */ +static int +lsqlite3_modify(struct ldb_module *module, + const struct ldb_message *msg) +{ + struct lsqlite3_private * lsqlite3 = module->private_data; + + /* ignore ltdb specials */ + if (msg->dn[0] == '@') { + return 0; + } + + /* Begin a transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); + + /* Everything worked. Commit it! */ + QUERY_NOROWS(lsqlite3, TRUE, "COMMIT;"); + return 0 ; +} + +/* obtain a named lock */ +static int +lsqlite3_lock(struct ldb_module *module, + const char *lockname) +{ + if (lockname == NULL) { + return -1; + } + + /* TODO implement a local locking mechanism here */ + + return 0; +} + +/* release a named lock */ +static int +lsqlite3_unlock(struct ldb_module *module, + const char *lockname) +{ + if (lockname == NULL) { + return -1; + } + + /* TODO implement a local locking mechanism here */ + + return 0; +} + +/* return extended error information */ +static const char * +lsqlite3_errstring(struct ldb_module *module) +{ + struct lsqlite3_private * lsqlite3 = module->private_data; + + return sqlite3_errmsg(lsqlite3->sqlite); +} + + + + +/* + * Static functions + */ + +static int +initialize(struct lsqlite3_private *lsqlite3, + const char *url) +{ + int ret; + long long queryInt; + const char * pTail; + sqlite3_stmt * stmt; + const char * schema = + "-- ------------------------------------------------------" + + "PRAGMA auto_vacuum=1;" + + "-- ------------------------------------------------------" + + "BEGIN EXCLUSIVE;" + + "-- ------------------------------------------------------" + + "CREATE TABLE ldb_info AS" + " SELECT 'LDB' AS database_type," + " '1.0' AS version;" + + "-- ------------------------------------------------------" + "-- Schema" + + "/*" + " * The entry table holds the information about an entry. " + " * This table is used to obtain the EID of the entry and to " + " * support scope=one and scope=base. The parent and child" + " * table is included in the entry table since all the other" + " * attributes are dependent on EID." + " */" + "CREATE TABLE ldb_entry" + "(" + " -- Unique identifier of this LDB entry" + " eid INTEGER PRIMARY KEY," + + " -- Unique identifier of the parent LDB entry" + " peid INTEGER REFERENCES ldb_entry," + + " -- Distinguished name of this entry" + " dn TEXT," + + " -- Time when the entry was created" + " create_timestamp INTEGER," + + " -- Time when the entry was last modified" + " modify_timestamp INTEGER," + + " -- Attributes of this entry, in the form" + " -- attr\1value\0[attr\1value\0]*\0" + " entry_data TEXT" + ");" + + + "/*" + " * The purpose of the descendant table is to support the" + " * subtree search feature. For each LDB entry with a unique" + " * ID (AEID), this table contains the unique identifiers" + " * (DEID) of the descendant entries." + " *" + " * For evern entry in the directory, a row exists in this" + " * table for each of its ancestors including itself. The " + " * size of the table depends on the depth of each entry. In " + " * the worst case, if all the entries were at the same " + " * depth, the number of rows in the table is O(nm) where " + " * n is the number of nodes in the directory and m is the " + " * depth of the tree. " + " */" + "CREATE TABLE ldb_descendants" + "(" + " -- The unique identifier of the ancestor LDB entry" + " aeid INTEGER REFERENCES ldb_entry," + + " -- The unique identifier of the descendant LDB entry" + " deid INTEGER REFERENCES ldb_entry" + ");" + + + "CREATE TABLE ldb_object_classes" + "(" + " -- Object classes are inserted into this table to track" + " -- their class hierarchy. 'top' is the top-level class" + " -- of which all other classes are subclasses." + " class_name TEXT PRIMARY KEY," + + " -- tree_key tracks the position of the class in" + " -- the hierarchy" + " tree_key TEXT UNIQUE" + ");" + + "/*" + " * There is one attribute table per searchable attribute." + " */" + "/*" + "CREATE TABLE ldb_attr_ATTRIBUTE_NAME" + "(" + " -- The unique identifier of the LDB entry" + " eid INTEGER REFERENCES ldb_entry," + + " -- Normalized attribute value" + " attr_value TEXT" + ");" + "*/" + + + "-- ------------------------------------------------------" + "-- Indexes" + + + "-- ------------------------------------------------------" + "-- Triggers" + + "CREATE TRIGGER ldb_entry_insert_tr" + " AFTER INSERT" + " ON ldb_entry" + " FOR EACH ROW" + " BEGIN" + " UPDATE ldb_entry" + " SET create_timestamp = strftime('%s', 'now')," + " modify_timestamp = strftime('%s', 'now')" + " WHERE eid = new.eid;" + " END;" + + "CREATE TRIGGER ldb_entry_update_tr" + " AFTER UPDATE" + " ON ldb_entry" + " FOR EACH ROW" + " BEGIN" + " UPDATE ldb_entry" + " SET modify_timestamp = strftime('%s', 'now')" + " WHERE eid = old.eid;" + " END;" + + "-- ------------------------------------------------------" + "-- Table initialization" + + "/* We need an implicit 'top' level object class */" + "INSERT INTO ldb_attributes (attr_name," + " parent_tree_key)" + " SELECT 'top', '';" + + "-- ------------------------------------------------------" + + "COMMIT;" + + "-- ------------------------------------------------------" + ; + + /* Skip protocol indicator of url */ + if (strncmp(url, "sqlite://", 9) != 0) { + return SQLITE_MISUSE; + } + + /* Update pointer to just after the protocol indicator */ + url += 9; + + /* Try to open the (possibly empty/non-existent) database */ + if ((ret = sqlite3_open(url, &lsqlite3->sqlite)) != SQLITE_OK) { + return ret; + } + + /* Begin a transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); + + /* Determine if this is a new database. No tables means it is. */ + QUERY_INT(lsqlite3, + queryInt, + TRUE, + "SELECT COUNT(*) " + " FROM sqlite_master " + " WHERE type = 'table';"); + + if (queryInt == 0) { + /* + * Create the database schema + */ + for (pTail = discard_const_p(char, schema); pTail != NULL; ) { + + if ((ret = sqlite3_prepare( + lsqlite3->sqlite, + pTail, + -1, + &stmt, + &pTail)) != SQLITE_OK || + (ret = sqlite3_step(stmt)) != SQLITE_DONE || + (ret = sqlite3_finalize(stmt)) != SQLITE_OK) { + + QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); + (void) sqlite3_close(lsqlite3->sqlite); + return ret; + } + } + } else { + /* + * Ensure that the database we opened is one of ours + */ + if (query_int(lsqlite3, + &queryInt, + "SELECT " + " (SELECT COUNT(*) = 3" + " FROM sqlite_master " + " WHERE type = 'table' " + " AND name IN " + " (" + " 'ldb_entry', " + " 'ldb_descendants', " + " 'ldb_object_classes' " + " ) " + " ) " + " AND " + " (SELECT 1 " + " FROM ldb_info " + " WHERE database_type = 'LDB' " + " AND version = '1.0'" + " );") != 0 || + queryInt != 1) { + + /* It's not one that we created. See ya! */ + QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); + (void) sqlite3_close(lsqlite3->sqlite); + return SQLITE_MISUSE; + } + } + + /* Commit the transaction */ + QUERY_NOROWS(lsqlite3, FALSE, "COMMIT;"); + + return SQLITE_OK; +} + +static int +destructor(void *p) +{ + struct lsqlite3_private * lsqlite3 = p; + + (void) sqlite3_close(lsqlite3->sqlite); + return 0; +} + + +/* + * query_norows() * * This function is used for queries that are not expected to return any rows, * e.g. BEGIN, COMMIT, ROLLBACK, CREATE TABLE, INSERT, UPDATE, DELETE, etc. @@ -76,9 +762,9 @@ * not pass SELECT queries to this function. */ static int -lsqlite3_query_norows(const struct lsqlite3_private *lsqlite3, - const char *pSql, - ...) +query_norows(const struct lsqlite3_private *lsqlite3, + const char *pSql, + ...) { int ret; int bLoop; @@ -151,7 +837,7 @@ lsqlite3_query_norows(const struct lsqlite3_private *lsqlite3, /* - * lsqlite3_query_int() + * query_int() * * This function is used for the common case of queries that return a single * integer value. @@ -160,10 +846,10 @@ lsqlite3_query_norows(const struct lsqlite3_private *lsqlite3, * one will be ignored. */ static int -lsqlite3_query_int(const struct lsqlite3_private * lsqlite3, - long long * pRet, - const char * pSql, - ...) +query_int(const struct lsqlite3_private * lsqlite3, + long long * pRet, + const char * pSql, + ...) { int ret; int bLoop; @@ -238,41 +924,13 @@ lsqlite3_query_int(const struct lsqlite3_private * lsqlite3, } -#if 0 -/* - * we don't need this right now, but will once we add some backend options - * - * find an option in an option list (a null terminated list of strings) - * - * this assumes the list is short. If it ever gets long then we really should - * do this in some smarter way - */ -static const char * -lsqlite3_option_find(const struct lsqlite3_private *lsqlite3, - const char *name) -{ - int i; - size_t len = strlen(name); - - if (!lsqlite3->options) return NULL; - - for (i=0;lsqlite3->options[i];i++) { - if (strncmp(lsqlite3->options[i], name, len) == 0 && - lsqlite3->options[i][len] == '=') { - return &lsqlite3->options[i][len+1]; - } - } - - return NULL; -} -#endif - /* callback function used in call to ldb_dn_fold() for determining whether an attribute type requires case folding. */ -static int lsqlite3_case_fold_attr_required(void * hUserData, - char *attr) +static int +case_fold_attr_required(void * hUserData, + char *attr) { // struct ldb_module * module = hUserData; @@ -282,65 +940,13 @@ static int lsqlite3_case_fold_attr_required(void * hUserData, /* - * rename a record - */ -static int -lsqlite3_rename(struct ldb_module * module, - const char * olddn, - const char * newdn) -{ - /* ignore ltdb specials */ - if (olddn[0] == '@' ||newdn[0] == '@') { - return 0; - } - -#warning "lsqlite3_rename() is not yet supported" - return -1; -} - -/* - * delete a record - */ -static int -lsqlite3_delete(struct ldb_module *module, - const char *dn) -{ - /* ignore ltdb specials */ - if (dn[0] == '@') { - return 0; - } - - return -1; -} - -#if 0 /* not currently used */ -/* - * free a search result - */ -static int -lsqlite3_search_free(struct ldb_module *module, - struct ldb_message **res) -{ - talloc_free(res); - return 0; -} -#endif - - -/* * add a single set of ldap message values to a ldb_message */ -/* get things to compile before we actually implement this function */ -struct berval -{ - int x; -}; - -#warning "lsqlite3_add_msg_attr() not yet implemented or used" +#warning "add_msg_attr() not yet implemented or used" #if 0 static int -lsqlite3_add_msg_attr(struct ldb_context *ldb, +add_msg_attr(struct ldb_context *ldb, struct ldb_message *msg, const char *attr, struct berval **bval) @@ -396,7 +1002,7 @@ lsqlite3_add_msg_attr(struct ldb_context *ldb, #endif static char * -lsqlite3_parsetree_to_sql(struct ldb_module *module, +parsetree_to_sql(struct ldb_module *module, char * hTalloc, const struct ldb_parse_tree *t) { @@ -412,13 +1018,13 @@ lsqlite3_parsetree_to_sql(struct ldb_module *module, break; case LDB_OP_AND: - ret = lsqlite3_parsetree_to_sql(module, - hTalloc, - t->u.list.elements[0]); + ret = parsetree_to_sql(module, + hTalloc, + t->u.list.elements[0]); for (i = 1; i < t->u.list.num_elements; i++) { child = - lsqlite3_parsetree_to_sql( + parsetree_to_sql( module, hTalloc, t->u.list.elements[i]); @@ -439,14 +1045,14 @@ lsqlite3_parsetree_to_sql(struct ldb_module *module, case LDB_OP_OR: child = - lsqlite3_parsetree_to_sql( + parsetree_to_sql( module, hTalloc, t->u.list.elements[0]); for (i = 1; i < t->u.list.num_elements; i++) { child = - lsqlite3_parsetree_to_sql( + parsetree_to_sql( module, hTalloc, t->u.list.elements[i]); @@ -466,7 +1072,7 @@ lsqlite3_parsetree_to_sql(struct ldb_module *module, case LDB_OP_NOT: child = - lsqlite3_parsetree_to_sql( + parsetree_to_sql( module, hTalloc, t->u.not.child); @@ -557,7 +1163,7 @@ lsqlite3_parsetree_to_sql(struct ldb_module *module, static char * -lsqlite3_parsetree_to_tablelist(struct ldb_module *module, +parsetree_to_tablelist(struct ldb_module *module, char * hTalloc, const struct ldb_parse_tree *t) { @@ -566,127 +1172,8 @@ lsqlite3_parsetree_to_tablelist(struct ldb_module *module, } -/* - * search for matching records - */ static int -lsqlite3_search(struct ldb_module * module, - const char * pBaseDN, - enum ldb_scope scope, - const char * pExpression, - const char * const attrs[], - struct ldb_message *** res) -{ - long long eid = 0; - char * sql; - char * sql_constraints; - char * table_list; - char * hTalloc; - struct ldb_parse_tree * pTree; - struct lsqlite3_private * lsqlite3 = module->private_data; - - if (pBaseDN == NULL) { - pBaseDN = ""; - } - - /* Begin a transaction */ - QUERY_NOROWS(lsqlite3, FALSE, "BEGIN IMMEDIATE;"); - - /* - * Obtain the eid of the base DN - */ - QUERY_INT(lsqlite3, - eid, - TRUE, - "SELECT eid " - " FROM ldb_attr_dn " - " WHERE attr_value = %Q;", - pBaseDN); - - /* Parse the filter expression into a tree we can work with */ - if ((pTree = ldb_parse_tree(module->ldb, pExpression)) == NULL) { - return -1; - } - - /* Allocate a temporary talloc context */ - hTalloc = talloc_new(module->ldb); - - /* Move the parse tree to our temporary context */ - talloc_steal(hTalloc, pTree); - - /* Convert filter into a series of SQL statements (constraints) */ - sql_constraints = lsqlite3_parsetree_to_sql(module, hTalloc, pTree); - - /* Get the list of attribute names to use as our extra table list */ - table_list = lsqlite3_parsetree_to_tablelist(module, hTalloc, pTree); - - switch(scope) { - case LDB_SCOPE_DEFAULT: - case LDB_SCOPE_SUBTREE: - sql = sqlite3_mprintf( - "SELECT entry.entry_data\n" - " FROM ldb_entry AS entry\n" - " WHERE entry.eid IN\n" - " (SELECT DISTINCT ldb_entry.eid\n" - " FROM ldb_entry,\n" - " ldb_descendants,\n" - " %q\n" - " WHERE ldb_descendants.aeid = %lld\n" - " AND ldb_entry.eid = ldb_descendants.deid\n" - " AND ldap_entry.eid IN\n" - "%s" - ");", - table_list, - eid, - sql_constraints); - break; - - case LDB_SCOPE_BASE: - sql = sqlite3_mprintf( - "SELECT entry.entry_data\n" - " FROM ldb_entry AS entry\n" - " WHERE entry.eid IN\n" - " (SELECT DISTINCT ldb_entry.eid\n" - " FROM %q\n" - " WHERE ldb_entry.eid = %lld\n" - " AND ldb_entry.eid IN\n" - "%s" - ");", - table_list, - eid, - sql_constraints); - break; - - case LDB_SCOPE_ONELEVEL: - sql = sqlite3_mprintf( - "SELECT entry.entry_data\n" - " FROM ldb_entry AS entry\n" - " WHERE entry.eid IN\n" - " (SELECT DISTINCT ldb_entry.eid\n" - " FROM ldb_entry AS pchild, " - " %q\n" - " WHERE ldb_entry.eid = pchild.eid " - " AND pchild.peid = %lld " - " AND ldb_entry.eid IN\n" - "%s" - ");", - table_list, - eid, - sql_constraints); - break; - } - -#warning "retrieve and return the result set of the search here" - - /* End the transaction */ - QUERY_NOROWS(lsqlite3, FALSE, "END TRANSACTION;"); - - return 0; -} - - -static int -lsqlite3_new_attr(struct ldb_module * module, +new_attr(struct ldb_module * module, char * pAttrName) { struct lsqlite3_private * lsqlite3 = module->private_data; @@ -709,10 +1196,10 @@ lsqlite3_new_attr(struct ldb_module * module, * requests in the ldb_message */ static int -lsqlite3_msg_to_sql(struct ldb_module * module, - const struct ldb_message * msg, - long long eid, - int use_flags) +msg_to_sql(struct ldb_module * module, + const struct ldb_message * msg, + long long eid, + int use_flags) { int flags; char * pAttrName; @@ -735,7 +1222,7 @@ lsqlite3_msg_to_sql(struct ldb_module * module, if (flags == LDB_FLAG_MOD_ADD) { /* Create the attribute table if it doesn't exist */ - if (lsqlite3_new_attr(module, pAttrName) != 0) { + if (new_attr(module, pAttrName) != 0) { return -1; } } @@ -815,9 +1302,9 @@ lsqlite3_msg_to_sql(struct ldb_module * module, static int -lsqlite3_new_dn(struct ldb_module * module, - char * pDN, - long long * pEID) +new_dn(struct ldb_module * module, + char * pDN, + long long * pEID) { struct ldb_dn * pExplodedDN; struct ldb_context * ldb = module->ldb; @@ -828,442 +1315,12 @@ lsqlite3_new_dn(struct ldb_module * module, ldb_explode_dn(ldb, pDN, ldb, - lsqlite3_case_fold_attr_required)) == NULL) { + case_fold_attr_required)) == NULL) { return -1; } -#warning "*** lsqlite3_new_dn() not yet fully implemented ***" +#warning "*** new_dn() not yet fully implemented ***" return -1; } -/* - * add a record - */ -static int -lsqlite3_add(struct ldb_module *module, - const struct ldb_message *msg) -{ - long long eid; - struct lsqlite3_private * lsqlite3 = module->private_data; - - /* ignore ltdb specials */ - if (msg->dn[0] == '@') { - return 0; - } - - /* Begin a transaction */ - QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); - - /* - * Build any portions of the directory tree that don't exist. If the - * final component already exists, it's an error. - */ - if (lsqlite3_new_dn(module, msg->dn, &eid) != 0) { - QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); - return -1; - } - - /* Add attributes to this new entry */ - if (lsqlite3_msg_to_sql(module, msg, eid, FALSE) != 0) { - QUERY_NOROWS(lsqlite3, FALSE, "ROLLBACK;"); - return -1; - } - - /* Everything worked. Commit it! */ - QUERY_NOROWS(lsqlite3, TRUE, "COMMIT;"); - return 0; -} - - -/* - * modify a record - */ -static int -lsqlite3_modify(struct ldb_module *module, - const struct ldb_message *msg) -{ - struct lsqlite3_private * lsqlite3 = module->private_data; - - /* ignore ltdb specials */ - if (msg->dn[0] == '@') { - return 0; - } - - /* Begin a transaction */ - QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); - - /* Everything worked. Commit it! */ - QUERY_NOROWS(lsqlite3, TRUE, "COMMIT;"); - return 0 ; -} - -static int -lsqlite3_lock(struct ldb_module *module, - const char *lockname) -{ - if (lockname == NULL) { - return -1; - } - - /* TODO implement a local locking mechanism here */ - - return 0; -} - -static int -lsqlite3_unlock(struct ldb_module *module, - const char *lockname) -{ - if (lockname == NULL) { - return -1; - } - - /* TODO implement a local locking mechanism here */ - - return 0; -} - -/* - * return extended error information - */ -static const char * -lsqlite3_errstring(struct ldb_module *module) -{ - struct lsqlite3_private * lsqlite3 = module->private_data; - - return sqlite3_errmsg(lsqlite3->sqlite); -} - - -static const struct ldb_module_ops lsqlite3_ops = { - "sqlite", - lsqlite3_search, - lsqlite3_add, - lsqlite3_modify, - lsqlite3_delete, - lsqlite3_rename, - lsqlite3_lock, - lsqlite3_unlock, - lsqlite3_errstring -}; - - -static int -lsqlite3_destructor(void *p) -{ - struct lsqlite3_private * lsqlite3 = p; - - (void) sqlite3_close(lsqlite3->sqlite); - return 0; -} - -static int -lsqlite3_initialize(struct lsqlite3_private *lsqlite3, - const char *url) -{ - int ret; - const char * p; - long long queryInt; - const char * pTail; - sqlite3_stmt * stmt; - const char * schema = - "-- ------------------------------------------------------" - - "PRAGMA auto_vacuum=1;" - - "-- ------------------------------------------------------" - - "BEGIN EXCLUSIVE;" - - "-- ------------------------------------------------------" - - "CREATE TABLE ldb_info AS" - " SELECT 'LDB' AS database_type," - " '1.0' AS version;" - - "-- ------------------------------------------------------" - "-- Schema" - - "/*" - " * The entry table holds the information about an entry. " - " * This table is used to obtain the EID of the entry and to " - " * support scope=one and scope=base. The parent and child" - " * table is included in the entry table since all the other" - " * attributes are dependent on EID." - " */" - "CREATE TABLE ldb_entry" - "(" - " -- Unique identifier of this LDB entry" - " eid INTEGER PRIMARY KEY," - - " -- Unique identifier of the parent LDB entry" - " peid INTEGER REFERENCES ldb_entry," - - " -- Distinguished name of this entry" - " dn TEXT," - - " -- Time when the entry was created" - " create_timestamp INTEGER," - - " -- Time when the entry was last modified" - " modify_timestamp INTEGER," - - " -- Attributes of this entry, in the form" - " -- attr\1value\0[attr\1value\0]*\0" - " entry_data TEXT" - ");" - - - "/*" - " * The purpose of the descendant table is to support the" - " * subtree search feature. For each LDB entry with a unique" - " * ID (AEID), this table contains the unique identifiers" - " * (DEID) of the descendant entries." - " *" - " * For evern entry in the directory, a row exists in this" - " * table for each of its ancestors including itself. The " - " * size of the table depends on the depth of each entry. In " - " * the worst case, if all the entries were at the same " - " * depth, the number of rows in the table is O(nm) where " - " * n is the number of nodes in the directory and m is the " - " * depth of the tree. " - " */" - "CREATE TABLE ldb_descendants" - "(" - " -- The unique identifier of the ancestor LDB entry" - " aeid INTEGER REFERENCES ldb_entry," - - " -- The unique identifier of the descendant LDB entry" - " deid INTEGER REFERENCES ldb_entry" - ");" - - - "CREATE TABLE ldb_object_classes" - "(" - " -- Object classes are inserted into this table to track" - " -- their class hierarchy. 'top' is the top-level class" - " -- of which all other classes are subclasses." - " class_name TEXT PRIMARY KEY," - - " -- tree_key tracks the position of the class in" - " -- the hierarchy" - " tree_key TEXT UNIQUE" - ");" - - "/*" - " * There is one attribute table per searchable attribute." - " */" - "/*" - "CREATE TABLE ldb_attr_ATTRIBUTE_NAME" - "(" - " -- The unique identifier of the LDB entry" - " eid INTEGER REFERENCES ldb_entry," - - " -- Normalized attribute value" - " attr_value TEXT" - ");" - "*/" - - - "-- ------------------------------------------------------" - "-- Indexes" - - - "-- ------------------------------------------------------" - "-- Triggers" - - "CREATE TRIGGER ldb_entry_insert_tr" - " AFTER INSERT" - " ON ldb_entry" - " FOR EACH ROW" - " BEGIN" - " UPDATE ldb_entry" - " SET create_timestamp = strftime('%s', 'now')," - " modify_timestamp = strftime('%s', 'now')" - " WHERE eid = new.eid;" - " END;" - - "CREATE TRIGGER ldb_entry_update_tr" - " AFTER UPDATE" - " ON ldb_entry" - " FOR EACH ROW" - " BEGIN" - " UPDATE ldb_entry" - " SET modify_timestamp = strftime('%s', 'now')" - " WHERE eid = old.eid;" - " END;" - - "-- ------------------------------------------------------" - "-- Table initialization" - - "/* We need an implicit 'top' level object class */" - "INSERT INTO ldb_attributes (attr_name," - " parent_tree_key)" - " SELECT 'top', '';" - - "-- ------------------------------------------------------" - - "COMMIT;" - - "-- ------------------------------------------------------" - ; - - /* Skip protocol indicator of url */ - if (strncmp(url, "sqlite://", 9) != 0) { - return SQLITE_MISUSE; - } else { - p = url + 9; - } - - /* - * See if we'll be creating a new database, or opening an existing one - */ - /* Try to open the (possibly empty/non-existent) database */ - if ((ret = sqlite3_open(p, &lsqlite3->sqlite)) != SQLITE_OK) { - return ret; - } - - /* Begin a transaction */ - QUERY_NOROWS(lsqlite3, FALSE, "BEGIN EXCLUSIVE;"); - - /* Determine if this is a new database */ - QUERY_INT(lsqlite3, - queryInt, - TRUE, - "SELECT COUNT(*) " - " FROM sqlite_master " - " WHERE type = 'table';"); - - if (queryInt == 0) { - /* - * Create the database schema - */ - for (pTail = discard_const_p(char, schema); pTail != NULL; ) { - - if ((ret = sqlite3_prepare( - lsqlite3->sqlite, - pTail, - -1, - &stmt, - &pTail)) != SQLITE_OK || - (ret = sqlite3_step(stmt)) != SQLITE_DONE || - (ret = sqlite3_finalize(stmt)) != SQLITE_OK) { - - (void) sqlite3_close(lsqlite3->sqlite); - return ret; - } - } - } else { - /* - * Ensure that the database we opened is one of ours - */ - if (lsqlite3_query_int(lsqlite3, - &queryInt, - "SELECT " - " (SELECT COUNT(*) = 3" - " FROM sqlite_master " - " WHERE type = 'table' " - " AND name IN " - " (" - " 'ldb_entry', " - " 'ldb_descendants', " - " 'ldb_object_classes' " - " ) " - " ) " - " AND " - " (SELECT 1 " - " FROM ldb_info " - " WHERE database_type = 'LDB' " - " AND version = '1.0'" - " );") != 0 || - queryInt != 1) { - - /* It's not one that we created. See ya! */ - (void) sqlite3_close(lsqlite3->sqlite); - return SQLITE_MISUSE; - } - } - - return SQLITE_OK; -} - -/* - * connect to the database - */ -struct ldb_context * -lsqlite3_connect(const char *url, - unsigned int flags, - const char *options[]) -{ - int i; - int ret; - struct ldb_context * ldb = NULL; - struct lsqlite3_private * lsqlite3 = NULL; - - ldb = talloc(NULL, struct ldb_context); - if (!ldb) { - errno = ENOMEM; - goto failed; - } - - lsqlite3 = talloc(ldb, struct lsqlite3_private); - if (!lsqlite3) { - errno = ENOMEM; - goto failed; - } - - lsqlite3->sqlite = NULL; - lsqlite3->options = NULL; - lsqlite3->lock_count = 0; - - ret = lsqlite3_initialize(lsqlite3, url); - if (ret != SQLITE_OK) { - goto failed; - } - - talloc_set_destructor(lsqlite3, lsqlite3_destructor); - - ldb->modules = talloc(ldb, struct ldb_module); - if (!ldb->modules) { - errno = ENOMEM; - goto failed; - } - ldb->modules->ldb = ldb; - ldb->modules->prev = ldb->modules->next = NULL; - ldb->modules->private_data = lsqlite3; - ldb->modules->ops = &lsqlite3_ops; - - if (options) { - /* - * take a copy of the options array, so we don't have to rely - * on the caller keeping it around (it might be dynamic) - */ - for (i=0;options[i];i++) ; - - lsqlite3->options = talloc_array(lsqlite3, char *, i+1); - if (!lsqlite3->options) { - goto failed; - } - - for (i=0;options[i];i++) { - - lsqlite3->options[i+1] = NULL; - lsqlite3->options[i] = - talloc_strdup(lsqlite3->options, options[i]); - if (!lsqlite3->options[i]) { - goto failed; - } - } - } - - return ldb; - -failed: - if (lsqlite3->sqlite != NULL) { - (void) sqlite3_close(lsqlite3->sqlite); - } - talloc_free(ldb); - return NULL; -} - |