4 Copyright (C) Derrell Lipman 2005
5 Copyright (C) Simo Sorce 2005-2006
7 ** NOTE! The following LGPL license applies to the ldb
8 ** library. This does NOT imply that all of Samba is released
11 This library is free software; you can redistribute it and/or
12 modify it under the terms of the GNU Lesser General Public
13 License as published by the Free Software Foundation; either
14 version 3 of the License, or (at your option) any later version.
16 This library is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public
22 License along with this library; if not, see <http://www.gnu.org/licenses/>.
28 * Component: ldb sqlite3 backend
30 * Description: core files for SQLITE3 backend
32 * Author: Derrell Lipman (based on Andrew Tridgell's LDAP backend)
36 #include "ldb/include/includes.h"
40 struct lsqlite3_private {
47 struct ldb_module *module;
50 long long current_eid;
51 const char * const * attrs;
52 struct ldb_reply *ares;
56 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
59 static struct ldb_handle *init_handle(struct lsqlite3_private *lsqlite3,
60 struct ldb_module *module,
61 struct ldb_request *req)
63 struct lsql_context *ac;
66 h = talloc_zero(lsqlite3, struct ldb_handle);
68 ldb_set_errstring(module->ldb, "Out of Memory");
74 ac = talloc(h, struct lsql_context);
76 ldb_set_errstring(module->ldb, "Out of Memory");
81 h->private_data = (void *)ac;
83 h->state = LDB_ASYNC_INIT;
84 h->status = LDB_SUCCESS;
87 ac->context = req->context;
88 ac->callback = req->callback;
94 * Macros used throughout
99 # define TRUE (! FALSE)
102 #define RESULT_ATTR_TABLE "temp_result_attrs"
104 //#define TEMPTAB /* for testing, create non-temporary table */
105 #define TEMPTAB "TEMPORARY"
110 sqlite3_stmt * stmtGetEID = NULL;
112 static char *lsqlite3_tprintf(TALLOC_CTX *mem_ctx, const char *fmt, ...)
118 str = sqlite3_vmprintf(fmt, ap);
121 if (str == NULL) return NULL;
123 ret = talloc_strdup(mem_ctx, str);
133 static char base160tab[161] = {
134 48 ,49 ,50 ,51 ,52 ,53 ,54 ,55 ,56 ,57 , /* 0-9 */
135 58 ,59 ,65 ,66 ,67 ,68 ,69 ,70 ,71 ,72 , /* : ; A-H */
136 73 ,74 ,75 ,76 ,77 ,78 ,79 ,80 ,81 ,82 , /* I-R */
137 83 ,84 ,85 ,86 ,87 ,88 ,89 ,90 ,97 ,98 , /* S-Z , a-b */
138 99 ,100,101,102,103,104,105,106,107,108, /* c-l */
139 109,110,111,112,113,114,115,116,117,118, /* m-v */
140 119,120,121,122,160,161,162,163,164,165, /* w-z, latin1 */
141 166,167,168,169,170,171,172,173,174,175, /* latin1 */
142 176,177,178,179,180,181,182,183,184,185, /* latin1 */
143 186,187,188,189,190,191,192,193,194,195, /* latin1 */
144 196,197,198,199,200,201,202,203,204,205, /* latin1 */
145 206,207,208,209,210,211,212,213,214,215, /* latin1 */
146 216,217,218,219,220,221,222,223,224,225, /* latin1 */
147 226,227,228,229,230,231,232,233,234,235, /* latin1 */
148 236,237,238,239,240,241,242,243,244,245, /* latin1 */
149 246,247,248,249,250,251,252,253,254,255, /* latin1 */
157 * Convert an unsigned long integer into a base160 representation of the
162 * value to be converted
165 * character array, 5 bytes long, into which the base160 representation
166 * will be placed. The result will be a four-digit representation of the
167 * number (with leading zeros prepended as necessary), and null
174 base160_sql(sqlite3_context * hContext,
176 sqlite3_value ** argv)
182 val = sqlite3_value_int64(argv[0]);
184 for (i = 3; i >= 0; i--) {
186 result[i] = base160tab[val % 160];
192 sqlite3_result_text(hContext, result, -1, SQLITE_TRANSIENT);
199 * This function enhances sqlite by adding a "base160_next()" function which is
200 * accessible via queries.
202 * Retrieve the next-greater number in the base160 sequence for the terminal
203 * tree node (the last four digits). Only one tree level (four digits) is
207 * A character string: either an empty string (in which case no operation is
208 * performed), or a string of base160 digits with a length of a multiple of
212 * Upon return, the trailing four digits (one tree level) will have been
216 base160next_sql(sqlite3_context * hContext,
218 sqlite3_value ** argv)
223 char * pBase160 = strdup((const char *)sqlite3_value_text(argv[0]));
224 char * pStart = pBase160;
227 * We need a minimum of four digits, and we will always get a multiple
230 if (pBase160 != NULL &&
231 (len = strlen(pBase160)) >= 4 &&
234 if (pBase160 == NULL) {
236 sqlite3_result_null(hContext);
240 pBase160 += strlen(pBase160) - 1;
242 /* We only carry through four digits: one level in the tree */
243 for (i = 0; i < 4; i++) {
245 /* What base160 value does this digit have? */
246 pTab = strchr(base160tab, *pBase160);
248 /* Is there a carry? */
249 if (pTab < base160tab + sizeof(base160tab) - 1) {
252 * Nope. Just increment this value and we're
260 * There's a carry. This value gets
261 * base160tab[0], we decrement the buffer
262 * pointer to get the next higher-order digit,
263 * and continue in the loop.
265 *pBase160-- = base160tab[0];
269 sqlite3_result_text(hContext,
274 sqlite3_result_value(hContext, argv[0]);
275 if (pBase160 != NULL) {
281 static char *parsetree_to_sql(struct ldb_module *module,
283 const struct ldb_parse_tree *t)
285 const struct ldb_attrib_handler *h;
286 struct ldb_val value, subval;
287 char *wild_card_string;
294 switch(t->operation) {
297 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
298 if (tmp == NULL) return NULL;
300 for (i = 1; i < t->u.list.num_elements; i++) {
302 child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
303 if (child == NULL) return NULL;
305 tmp = talloc_asprintf_append(tmp, " INTERSECT %s ", child);
306 if (tmp == NULL) return NULL;
309 ret = talloc_asprintf(mem_ctx, "SELECT * FROM ( %s )\n", tmp);
315 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
316 if (tmp == NULL) return NULL;
318 for (i = 1; i < t->u.list.num_elements; i++) {
320 child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
321 if (child == NULL) return NULL;
323 tmp = talloc_asprintf_append(tmp, " UNION %s ", child);
324 if (tmp == NULL) return NULL;
327 return talloc_asprintf(mem_ctx, "SELECT * FROM ( %s ) ", tmp);
331 child = parsetree_to_sql(module, mem_ctx, t->u.isnot.child);
332 if (child == NULL) return NULL;
334 return talloc_asprintf(mem_ctx,
335 "SELECT eid FROM ldb_entry "
336 "WHERE eid NOT IN ( %s ) ", child);
338 case LDB_OP_EQUALITY:
340 * For simple searches, we want to retrieve the list of EIDs that
341 * match the criteria.
343 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
344 if (attr == NULL) return NULL;
345 h = ldb_attrib_handler(module->ldb, attr);
347 /* Get a canonicalised copy of the data */
348 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
349 if (value.data == NULL) {
353 if (strcasecmp(t->u.equality.attr, "objectclass") == 0) {
355 * For object classes, we want to search for all objectclasses
356 * that are subclasses as well.
358 return lsqlite3_tprintf(mem_ctx,
359 "SELECT eid FROM ldb_attribute_values\n"
360 "WHERE norm_attr_name = 'OBJECTCLASS' "
361 "AND norm_attr_value IN\n"
362 " (SELECT class_name FROM ldb_object_classes\n"
363 " WHERE tree_key GLOB\n"
364 " (SELECT tree_key FROM ldb_object_classes\n"
365 " WHERE class_name = '%q'\n"
369 } else if (strcasecmp(t->u.equality.attr, "dn") == 0) {
370 /* DN query is a special ldb case */
371 char *cdn = ldb_dn_linearize_casefold(module->ldb,
373 ldb_dn_explode(module->ldb,
374 (const char *)value.data));
376 return lsqlite3_tprintf(mem_ctx,
377 "SELECT eid FROM ldb_entry "
378 "WHERE norm_dn = '%q'", cdn);
381 /* A normal query. */
382 return lsqlite3_tprintf(mem_ctx,
383 "SELECT eid FROM ldb_attribute_values "
384 "WHERE norm_attr_name = '%q' "
385 "AND norm_attr_value = '%q'",
391 case LDB_OP_SUBSTRING:
393 wild_card_string = talloc_strdup(mem_ctx,
394 (t->u.substring.start_with_wildcard)?"*":"");
395 if (wild_card_string == NULL) return NULL;
397 for (i = 0; t->u.substring.chunks[i]; i++) {
398 wild_card_string = talloc_asprintf_append(wild_card_string, "%s*",
399 t->u.substring.chunks[i]->data);
400 if (wild_card_string == NULL) return NULL;
403 if ( ! t->u.substring.end_with_wildcard ) {
404 /* remove last wildcard */
405 wild_card_string[strlen(wild_card_string) - 1] = '\0';
408 attr = ldb_attr_casefold(mem_ctx, t->u.substring.attr);
409 if (attr == NULL) return NULL;
410 h = ldb_attrib_handler(module->ldb, attr);
412 subval.data = (void *)wild_card_string;
413 subval.length = strlen(wild_card_string) + 1;
415 /* Get a canonicalised copy of the data */
416 h->canonicalise_fn(module->ldb, mem_ctx, &(subval), &value);
417 if (value.data == NULL) {
421 return lsqlite3_tprintf(mem_ctx,
422 "SELECT eid FROM ldb_attribute_values "
423 "WHERE norm_attr_name = '%q' "
424 "AND norm_attr_value GLOB '%q'",
429 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
430 if (attr == NULL) return NULL;
431 h = ldb_attrib_handler(module->ldb, attr);
433 /* Get a canonicalised copy of the data */
434 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
435 if (value.data == NULL) {
439 return lsqlite3_tprintf(mem_ctx,
440 "SELECT eid FROM ldb_attribute_values "
441 "WHERE norm_attr_name = '%q' "
442 "AND ldap_compare(norm_attr_value, '>=', '%q', '%q') ",
448 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
449 if (attr == NULL) return NULL;
450 h = ldb_attrib_handler(module->ldb, attr);
452 /* Get a canonicalised copy of the data */
453 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
454 if (value.data == NULL) {
458 return lsqlite3_tprintf(mem_ctx,
459 "SELECT eid FROM ldb_attribute_values "
460 "WHERE norm_attr_name = '%q' "
461 "AND ldap_compare(norm_attr_value, '<=', '%q', '%q') ",
467 if (strcasecmp(t->u.present.attr, "dn") == 0) {
468 return talloc_strdup(mem_ctx, "SELECT eid FROM ldb_entry");
471 attr = ldb_attr_casefold(mem_ctx, t->u.present.attr);
472 if (attr == NULL) return NULL;
474 return lsqlite3_tprintf(mem_ctx,
475 "SELECT eid FROM ldb_attribute_values "
476 "WHERE norm_attr_name = '%q' ",
480 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
481 if (attr == NULL) return NULL;
482 h = ldb_attrib_handler(module->ldb, attr);
484 /* Get a canonicalised copy of the data */
485 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
486 if (value.data == NULL) {
490 return lsqlite3_tprintf(mem_ctx,
491 "SELECT eid FROM ldb_attribute_values "
492 "WHERE norm_attr_name = '%q' "
493 "AND ldap_compare(norm_attr_value, '~%', 'q', '%q') ",
498 case LDB_OP_EXTENDED:
499 #warning "work out how to handle bitops"
506 /* should never occur */
514 * This function is used for the common case of queries that return a single
517 * NOTE: If more than one value is returned by the query, all but the first
518 * one will be ignored.
521 query_int(const struct lsqlite3_private * lsqlite3,
529 sqlite3_stmt * pStmt;
532 /* Begin access to variable argument list */
533 va_start(args, pSql);
535 /* Format the query */
536 if ((p = sqlite3_vmprintf(pSql, args)) == NULL) {
541 * Prepare and execute the SQL statement. Loop allows retrying on
542 * certain errors, e.g. SQLITE_SCHEMA occurs if the schema changes,
543 * requiring retrying the operation.
545 for (bLoop = TRUE; bLoop; ) {
547 /* Compile the SQL statement into sqlite virtual machine */
548 if ((ret = sqlite3_prepare(lsqlite3->sqlite,
552 NULL)) == SQLITE_SCHEMA) {
553 if (stmtGetEID != NULL) {
554 sqlite3_finalize(stmtGetEID);
558 } else if (ret != SQLITE_OK) {
562 /* One row expected */
563 if ((ret = sqlite3_step(pStmt)) == SQLITE_SCHEMA) {
564 if (stmtGetEID != NULL) {
565 sqlite3_finalize(stmtGetEID);
568 (void) sqlite3_finalize(pStmt);
570 } else if (ret != SQLITE_ROW) {
571 (void) sqlite3_finalize(pStmt);
575 /* Get the value to be returned */
576 *pRet = sqlite3_column_int64(pStmt, 0);
578 /* Free the virtual machine */
579 if ((ret = sqlite3_finalize(pStmt)) == SQLITE_SCHEMA) {
580 if (stmtGetEID != NULL) {
581 sqlite3_finalize(stmtGetEID);
585 } else if (ret != SQLITE_OK) {
586 (void) sqlite3_finalize(pStmt);
591 * Normal condition is only one time through loop. Loop is
592 * rerun in error conditions, via "continue", above.
597 /* All done with variable argument list */
601 /* Free the memory we allocated for our query string */
608 * This is a bad hack to support ldap style comparisons whithin sqlite.
609 * val is the attribute in the row currently under test
610 * func is the desired test "<=" ">=" "~" ":"
611 * cmp is the value to compare against (eg: "test")
612 * attr is the attribute name the value of which we want to test
615 static void lsqlite3_compare(sqlite3_context *ctx, int argc,
616 sqlite3_value **argv)
618 struct ldb_context *ldb = (struct ldb_context *)sqlite3_user_data(ctx);
619 const char *val = (const char *)sqlite3_value_text(argv[0]);
620 const char *func = (const char *)sqlite3_value_text(argv[1]);
621 const char *cmp = (const char *)sqlite3_value_text(argv[2]);
622 const char *attr = (const char *)sqlite3_value_text(argv[3]);
623 const struct ldb_attrib_handler *h;
631 h = ldb_attrib_handler(ldb, attr);
632 valX.data = (void *)cmp;
633 valX.length = strlen(cmp);
634 valY.data = (void *)val;
635 valY.length = strlen(val);
636 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
638 sqlite3_result_int(ctx, 1);
640 sqlite3_result_int(ctx, 0);
645 h = ldb_attrib_handler(ldb, attr);
646 valX.data = (void *)cmp;
647 valX.length = strlen(cmp);
648 valY.data = (void *)val;
649 valY.length = strlen(val);
650 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
652 sqlite3_result_int(ctx, 1);
654 sqlite3_result_int(ctx, 0);
660 sqlite3_result_int(ctx, 0);
666 sqlite3_result_int(ctx, 0);
673 sqlite3_result_error(ctx, "Value must start with a special operation char (<>~:)!", -1);
678 /* rename a record */
679 static int lsqlite3_safe_rollback(sqlite3 *sqlite)
685 ret = sqlite3_exec(sqlite, "ROLLBACK;", NULL, NULL, &errmsg);
686 if (ret != SQLITE_OK) {
688 printf("lsqlite3_safe_rollback: Error: %s\n", errmsg);
697 /* return an eid as result */
698 static int lsqlite3_eid_callback(void *result, int col_num, char **cols, char **names)
700 long long *eid = (long long *)result;
702 if (col_num != 1) return SQLITE_ABORT;
703 if (strcasecmp(names[0], "eid") != 0) return SQLITE_ABORT;
705 *eid = atoll(cols[0]);
710 * add a single set of ldap message values to a ldb_message
712 static int lsqlite3_search_callback(void *result, int col_num, char **cols, char **names)
714 struct ldb_handle *handle = talloc_get_type(result, struct ldb_handle);
715 struct lsql_context *ac = talloc_get_type(handle->private_data, struct lsql_context);
716 struct ldb_message *msg;
720 /* eid, dn, attr_name, attr_value */
724 eid = atoll(cols[0]);
726 if (eid != ac->current_eid) { /* here begin a new entry */
728 /* call the async callback for the last entry
729 * except the first time */
730 if (ac->current_eid != 0) {
731 ac->ares->message = ldb_msg_canonicalize(ac->module->ldb, ac->ares->message);
732 if (ac->ares->message == NULL)
735 handle->status = ac->callback(ac->module->ldb, ac->context, ac->ares);
736 if (handle->status != LDB_SUCCESS)
741 ac->ares = talloc_zero(ac, struct ldb_reply);
745 ac->ares->message = ldb_msg_new(ac->ares);
746 if (!ac->ares->message)
749 ac->ares->type = LDB_REPLY_ENTRY;
750 ac->current_eid = eid;
753 msg = ac->ares->message;
755 if (msg->dn == NULL) {
756 msg->dn = ldb_dn_explode(msg, cols[1]);
763 for (i = 0; ac->attrs[i]; i++) {
764 if (strcasecmp(cols[2], ac->attrs[i]) == 0) {
769 if (!found) return SQLITE_OK;
772 if (ldb_msg_add_string(msg, cols[2], cols[3]) != 0) {
782 * lsqlite3_get_eid_ndn()
784 * These functions are used for the very common case of retrieving an EID value
785 * given a (normalized) DN.
788 static long long lsqlite3_get_eid_ndn(sqlite3 *sqlite, void *mem_ctx, const char *norm_dn)
796 query = lsqlite3_tprintf(mem_ctx, "SELECT eid "
798 "WHERE norm_dn = '%q';", norm_dn);
799 if (query == NULL) return -1;
801 ret = sqlite3_exec(sqlite, query, lsqlite3_eid_callback, &eid, &errmsg);
802 if (ret != SQLITE_OK) {
804 printf("lsqlite3_get_eid: Fatal Error: %s\n", errmsg);
813 static long long lsqlite3_get_eid(struct ldb_module *module, const struct ldb_dn *dn)
815 TALLOC_CTX *local_ctx;
816 struct lsqlite3_private *lsqlite3 = module->private_data;
820 /* ignore ltdb specials */
821 if (ldb_dn_is_special(dn)) {
825 /* create a local ctx */
826 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_get_eid local context");
827 if (local_ctx == NULL) {
831 cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, local_ctx, dn));
834 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, local_ctx, cdn);
837 talloc_free(local_ctx);
842 * Interface functions referenced by lsqlite3_ops
845 /* search for matching records, by tree */
846 int lsql_search(struct ldb_module *module, struct ldb_request *req)
848 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
849 struct lsql_context *lsql_ac;
856 req->handle = init_handle(lsqlite3, module, req);
857 if (req->handle == NULL) {
858 return LDB_ERR_OPERATIONS_ERROR;
861 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
863 if ((req->op.search.base == NULL || req->op.search.base->comp_num == 0) &&
864 (req->op.search.scope == LDB_SCOPE_BASE || req->op.search.scope == LDB_SCOPE_ONELEVEL))
865 return LDB_ERR_OPERATIONS_ERROR;
867 if (req->op.search.base) {
868 norm_basedn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.search.base));
869 if (norm_basedn == NULL) {
870 ret = LDB_ERR_INVALID_DN_SYNTAX;
873 } else norm_basedn = talloc_strdup(lsql_ac, "");
875 /* Convert filter into a series of SQL conditions (constraints) */
876 sqlfilter = parsetree_to_sql(module, lsql_ac, req->op.search.tree);
878 switch(req->op.search.scope) {
879 case LDB_SCOPE_DEFAULT:
880 case LDB_SCOPE_SUBTREE:
881 if (*norm_basedn != '\0') {
882 query = lsqlite3_tprintf(lsql_ac,
883 "SELECT entry.eid,\n"
887 " FROM ldb_entry AS entry\n"
889 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
890 " ON av.eid = entry.eid\n"
892 " WHERE entry.eid IN\n"
893 " (SELECT DISTINCT ldb_entry.eid\n"
895 " WHERE (ldb_entry.norm_dn GLOB('*,%q')\n"
896 " OR ldb_entry.norm_dn = '%q')\n"
897 " AND ldb_entry.eid IN\n"
901 " ORDER BY entry.eid ASC;",
906 query = lsqlite3_tprintf(lsql_ac,
907 "SELECT entry.eid,\n"
911 " FROM ldb_entry AS entry\n"
913 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
914 " ON av.eid = entry.eid\n"
916 " WHERE entry.eid IN\n"
917 " (SELECT DISTINCT ldb_entry.eid\n"
919 " WHERE ldb_entry.eid IN\n"
923 " ORDER BY entry.eid ASC;",
930 query = lsqlite3_tprintf(lsql_ac,
931 "SELECT entry.eid,\n"
935 " FROM ldb_entry AS entry\n"
937 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
938 " ON av.eid = entry.eid\n"
940 " WHERE entry.eid IN\n"
941 " (SELECT DISTINCT ldb_entry.eid\n"
943 " WHERE ldb_entry.norm_dn = '%q'\n"
944 " AND ldb_entry.eid IN\n"
948 " ORDER BY entry.eid ASC;",
953 case LDB_SCOPE_ONELEVEL:
954 query = lsqlite3_tprintf(lsql_ac,
955 "SELECT entry.eid,\n"
959 " FROM ldb_entry AS entry\n"
961 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
962 " ON av.eid = entry.eid\n"
964 " WHERE entry.eid IN\n"
965 " (SELECT DISTINCT ldb_entry.eid\n"
967 " WHERE norm_dn GLOB('*,%q')\n"
968 " AND NOT norm_dn GLOB('*,*,%q')\n"
969 " AND ldb_entry.eid IN\n(%s)\n"
972 " ORDER BY entry.eid ASC;",
984 printf ("%s\n", query);
987 lsql_ac->current_eid = 0;
988 lsql_ac->attrs = req->op.search.attrs;
989 lsql_ac->ares = NULL;
991 req->handle->state = LDB_ASYNC_PENDING;
993 ret = sqlite3_exec(lsqlite3->sqlite, query, lsqlite3_search_callback, req->handle, &errmsg);
994 if (ret != SQLITE_OK) {
996 ldb_set_errstring(module->ldb, errmsg);
1002 /* complete the last message if any */
1003 if (lsql_ac->ares) {
1004 lsql_ac->ares->message = ldb_msg_canonicalize(module->ldb, lsql_ac->ares->message);
1005 if (lsql_ac->ares->message == NULL)
1008 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, lsql_ac->ares);
1009 if (req->handle->status != LDB_SUCCESS)
1013 req->handle->state = LDB_ASYNC_DONE;
1018 return LDB_ERR_OPERATIONS_ERROR;
1022 static int lsql_add(struct ldb_module *module, struct ldb_request *req)
1024 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1025 struct lsql_context *lsql_ac;
1026 struct ldb_message *msg = req->op.add.message;
1032 int ret = LDB_SUCCESS;
1034 req->handle = init_handle(lsqlite3, module, req);
1035 if (req->handle == NULL) {
1036 return LDB_ERR_OPERATIONS_ERROR;
1038 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1039 req->handle->state = LDB_ASYNC_DONE;
1040 req->handle->status = LDB_SUCCESS;
1042 /* See if this is an ltdb special */
1043 if (ldb_dn_is_special(msg->dn)) {
1046 c = ldb_dn_explode(lsql_ac, "@SUBCLASSES");
1047 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1048 #warning "insert subclasses into object class tree"
1049 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1054 c = ldb_dn_explode(local_ctx, "@INDEXLIST");
1055 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1056 #warning "should we handle indexes somehow ?"
1057 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1061 /* Others return an error */
1062 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1066 /* create linearized and normalized dns */
1067 dn = ldb_dn_linearize(lsql_ac, msg->dn);
1068 ndn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, msg->dn));
1069 if (dn == NULL || ndn == NULL) {
1070 ret = LDB_ERR_OTHER;
1074 query = lsqlite3_tprintf(lsql_ac,
1076 "INSERT OR ABORT INTO ldb_entry "
1077 "('dn', 'norm_dn') "
1078 "VALUES ('%q', '%q');",
1080 if (query == NULL) {
1081 ret = LDB_ERR_OTHER;
1085 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1086 if (ret != SQLITE_OK) {
1088 ldb_set_errstring(module->ldb, errmsg);
1091 ret = LDB_ERR_OTHER;
1095 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, lsql_ac, ndn);
1097 ret = LDB_ERR_OTHER;
1101 for (i = 0; i < msg->num_elements; i++) {
1102 const struct ldb_message_element *el = &msg->elements[i];
1103 const struct ldb_attrib_handler *h;
1107 /* Get a case-folded copy of the attribute name */
1108 attr = ldb_attr_casefold(lsql_ac, el->name);
1110 ret = LDB_ERR_OTHER;
1114 h = ldb_attrib_handler(module->ldb, el->name);
1116 /* For each value of the specified attribute name... */
1117 for (j = 0; j < el->num_values; j++) {
1118 struct ldb_val value;
1121 /* Get a canonicalised copy of the data */
1122 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1123 if (value.data == NULL) {
1124 ret = LDB_ERR_OTHER;
1128 insert = lsqlite3_tprintf(lsql_ac,
1129 "INSERT OR ROLLBACK INTO ldb_attribute_values "
1130 "('eid', 'attr_name', 'norm_attr_name',"
1131 " 'attr_value', 'norm_attr_value') "
1132 "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1133 eid, el->name, attr,
1134 el->values[j].data, value.data);
1135 if (insert == NULL) {
1136 ret = LDB_ERR_OTHER;
1140 ret = sqlite3_exec(lsqlite3->sqlite, insert, NULL, NULL, &errmsg);
1141 if (ret != SQLITE_OK) {
1143 ldb_set_errstring(module->ldb, errmsg);
1146 ret = LDB_ERR_OTHER;
1152 if (lsql_ac->callback) {
1153 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1157 req->handle->state = LDB_ASYNC_DONE;
1161 /* modify a record */
1162 static int lsql_modify(struct ldb_module *module, struct ldb_request *req)
1164 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1165 struct lsql_context *lsql_ac;
1166 struct ldb_message *msg = req->op.mod.message;
1170 int ret = LDB_SUCCESS;
1172 req->handle = init_handle(lsqlite3, module, req);
1173 if (req->handle == NULL) {
1174 return LDB_ERR_OPERATIONS_ERROR;
1176 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1177 req->handle->state = LDB_ASYNC_DONE;
1178 req->handle->status = LDB_SUCCESS;
1180 /* See if this is an ltdb special */
1181 if (ldb_dn_is_special(msg->dn)) {
1184 c = ldb_dn_explode(lsql_ac, "@SUBCLASSES");
1185 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1186 #warning "modify subclasses into object class tree"
1187 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1191 /* Others return an error */
1192 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1196 eid = lsqlite3_get_eid(module, msg->dn);
1198 ret = LDB_ERR_OTHER;
1202 for (i = 0; i < msg->num_elements; i++) {
1203 const struct ldb_message_element *el = &msg->elements[i];
1204 const struct ldb_attrib_handler *h;
1205 int flags = el->flags & LDB_FLAG_MOD_MASK;
1210 /* Get a case-folded copy of the attribute name */
1211 attr = ldb_attr_casefold(lsql_ac, el->name);
1213 ret = LDB_ERR_OTHER;
1217 h = ldb_attrib_handler(module->ldb, el->name);
1221 case LDB_FLAG_MOD_REPLACE:
1223 /* remove all attributes before adding the replacements */
1224 mod = lsqlite3_tprintf(lsql_ac,
1225 "DELETE FROM ldb_attribute_values "
1226 "WHERE eid = '%lld' "
1227 "AND norm_attr_name = '%q';",
1230 ret = LDB_ERR_OTHER;
1234 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1235 if (ret != SQLITE_OK) {
1237 ldb_set_errstring(module->ldb, errmsg);
1240 ret = LDB_ERR_OTHER;
1244 /* MISSING break is INTENTIONAL */
1246 case LDB_FLAG_MOD_ADD:
1247 #warning "We should throw an error if no value is provided!"
1248 /* For each value of the specified attribute name... */
1249 for (j = 0; j < el->num_values; j++) {
1250 struct ldb_val value;
1252 /* Get a canonicalised copy of the data */
1253 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1254 if (value.data == NULL) {
1255 ret = LDB_ERR_OTHER;
1259 mod = lsqlite3_tprintf(lsql_ac,
1260 "INSERT OR ROLLBACK INTO ldb_attribute_values "
1261 "('eid', 'attr_name', 'norm_attr_name',"
1262 " 'attr_value', 'norm_attr_value') "
1263 "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1264 eid, el->name, attr,
1265 el->values[j].data, value.data);
1268 ret = LDB_ERR_OTHER;
1272 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1273 if (ret != SQLITE_OK) {
1275 ldb_set_errstring(module->ldb, errmsg);
1278 ret = LDB_ERR_OTHER;
1285 case LDB_FLAG_MOD_DELETE:
1286 #warning "We should throw an error if the attribute we are trying to delete does not exist!"
1287 if (el->num_values == 0) {
1288 mod = lsqlite3_tprintf(lsql_ac,
1289 "DELETE FROM ldb_attribute_values "
1290 "WHERE eid = '%lld' "
1291 "AND norm_attr_name = '%q';",
1294 ret = LDB_ERR_OTHER;
1298 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1299 if (ret != SQLITE_OK) {
1301 ldb_set_errstring(module->ldb, errmsg);
1304 ret = LDB_ERR_OTHER;
1309 /* For each value of the specified attribute name... */
1310 for (j = 0; j < el->num_values; j++) {
1311 struct ldb_val value;
1313 /* Get a canonicalised copy of the data */
1314 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1315 if (value.data == NULL) {
1316 ret = LDB_ERR_OTHER;
1320 mod = lsqlite3_tprintf(lsql_ac,
1321 "DELETE FROM ldb_attribute_values "
1322 "WHERE eid = '%lld' "
1323 "AND norm_attr_name = '%q' "
1324 "AND norm_attr_value = '%q';",
1325 eid, attr, value.data);
1328 ret = LDB_ERR_OTHER;
1332 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1333 if (ret != SQLITE_OK) {
1335 ldb_set_errstring(module->ldb, errmsg);
1338 ret = LDB_ERR_OTHER;
1347 if (lsql_ac->callback) {
1348 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1352 req->handle->state = LDB_ASYNC_DONE;
1356 /* delete a record */
1357 static int lsql_delete(struct ldb_module *module, struct ldb_request *req)
1359 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1360 struct lsql_context *lsql_ac;
1364 int ret = LDB_SUCCESS;
1367 req->handle = init_handle(lsqlite3, module, req);
1368 if (req->handle == NULL) {
1369 return LDB_ERR_OPERATIONS_ERROR;
1371 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1372 req->handle->state = LDB_ASYNC_DONE;
1373 req->handle->status = LDB_SUCCESS;
1375 eid = lsqlite3_get_eid(module, req->op.del.dn);
1380 query = lsqlite3_tprintf(lsql_ac,
1382 "DELETE FROM ldb_entry WHERE eid = %lld; "
1383 /* Delete attributes */
1384 "DELETE FROM ldb_attribute_values WHERE eid = %lld; ",
1386 if (query == NULL) {
1387 ret = LDB_ERR_OTHER;
1391 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1392 if (ret != SQLITE_OK) {
1394 ldb_set_errstring(module->ldb, errmsg);
1397 req->handle->status = LDB_ERR_OPERATIONS_ERROR;
1401 if (lsql_ac->callback) {
1402 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1406 req->handle->state = LDB_ASYNC_DONE;
1410 /* rename a record */
1411 static int lsql_rename(struct ldb_module *module, struct ldb_request *req)
1413 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1414 struct lsql_context *lsql_ac;
1415 char *new_dn, *new_cdn, *old_cdn;
1418 int ret = LDB_SUCCESS;
1420 req->handle = init_handle(lsqlite3, module, req);
1421 if (req->handle == NULL) {
1422 return LDB_ERR_OPERATIONS_ERROR;
1424 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1425 req->handle->state = LDB_ASYNC_DONE;
1426 req->handle->status = LDB_SUCCESS;
1428 /* create linearized and normalized dns */
1429 old_cdn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.rename.olddn));
1430 new_cdn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.rename.newdn));
1431 new_dn = ldb_dn_linearize(lsql_ac, req->op.rename.newdn);
1432 if (old_cdn == NULL || new_cdn == NULL || new_dn == NULL) {
1436 /* build the SQL query */
1437 query = lsqlite3_tprintf(lsql_ac,
1438 "UPDATE ldb_entry SET dn = '%q', norm_dn = '%q' "
1439 "WHERE norm_dn = '%q';",
1440 new_dn, new_cdn, old_cdn);
1441 if (query == NULL) {
1446 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1447 if (ret != SQLITE_OK) {
1449 ldb_set_errstring(module->ldb, errmsg);
1452 ret = LDB_ERR_OPERATIONS_ERROR;
1456 if (lsql_ac->callback) {
1457 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1461 req->handle->state = LDB_ASYNC_DONE;
1465 static int lsql_start_trans(struct ldb_module * module)
1469 struct lsqlite3_private * lsqlite3 = module->private_data;
1471 if (lsqlite3->trans_count == 0) {
1472 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN IMMEDIATE;", NULL, NULL, &errmsg);
1473 if (ret != SQLITE_OK) {
1475 printf("lsqlite3_start_trans: error: %s\n", errmsg);
1482 lsqlite3->trans_count++;
1487 static int lsql_end_trans(struct ldb_module *module)
1491 struct lsqlite3_private *lsqlite3 = module->private_data;
1493 if (lsqlite3->trans_count > 0) {
1494 lsqlite3->trans_count--;
1497 if (lsqlite3->trans_count == 0) {
1498 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1499 if (ret != SQLITE_OK) {
1501 printf("lsqlite3_end_trans: error: %s\n", errmsg);
1511 static int lsql_del_trans(struct ldb_module *module)
1513 struct lsqlite3_private *lsqlite3 = module->private_data;
1515 if (lsqlite3->trans_count > 0) {
1516 lsqlite3->trans_count--;
1519 if (lsqlite3->trans_count == 0) {
1520 return lsqlite3_safe_rollback(lsqlite3->sqlite);
1526 static int destructor(struct lsqlite3_private *lsqlite3)
1528 if (lsqlite3->sqlite) {
1529 sqlite3_close(lsqlite3->sqlite);
1534 static int lsql_request(struct ldb_module *module, struct ldb_request *req)
1536 return LDB_ERR_OPERATIONS_ERROR;
1539 static int lsql_wait(struct ldb_handle *handle, enum ldb_wait_type type)
1541 return handle->status;
1545 * Table of operations for the sqlite3 backend
1547 static const struct ldb_module_ops lsqlite3_ops = {
1549 .search = lsql_search,
1551 .modify = lsql_modify,
1553 .rename = lsql_rename,
1554 .request = lsql_request,
1555 .start_transaction = lsql_start_trans,
1556 .end_transaction = lsql_end_trans,
1557 .del_transaction = lsql_del_trans,
1565 static int initialize(struct lsqlite3_private *lsqlite3,
1566 struct ldb_context *ldb, const char *url, int flags)
1568 TALLOC_CTX *local_ctx;
1575 /* create a local ctx */
1576 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_rename local context");
1577 if (local_ctx == NULL) {
1581 schema = lsqlite3_tprintf(local_ctx,
1584 "CREATE TABLE ldb_info AS "
1585 " SELECT 'LDB' AS database_type,"
1586 " '1.0' AS version;"
1589 * The entry table holds the information about an entry.
1590 * This table is used to obtain the EID of the entry and to
1591 * support scope=one and scope=base. The parent and child
1592 * table is included in the entry table since all the other
1593 * attributes are dependent on EID.
1595 "CREATE TABLE ldb_entry "
1597 " eid INTEGER PRIMARY KEY AUTOINCREMENT,"
1598 " dn TEXT UNIQUE NOT NULL,"
1599 " norm_dn TEXT UNIQUE NOT NULL"
1603 "CREATE TABLE ldb_object_classes"
1605 " class_name TEXT PRIMARY KEY,"
1606 " parent_class_name TEXT,"
1607 " tree_key TEXT UNIQUE,"
1608 " max_child_num INTEGER DEFAULT 0"
1612 * We keep a full listing of attribute/value pairs here
1614 "CREATE TABLE ldb_attribute_values"
1616 " eid INTEGER REFERENCES ldb_entry,"
1618 " norm_attr_name TEXT,"
1620 " norm_attr_value TEXT "
1627 "CREATE INDEX ldb_attribute_values_eid_idx "
1628 " ON ldb_attribute_values (eid);"
1630 "CREATE INDEX ldb_attribute_values_name_value_idx "
1631 " ON ldb_attribute_values (attr_name, norm_attr_value);"
1639 "CREATE TRIGGER ldb_object_classes_insert_tr"
1641 " ON ldb_object_classes"
1644 " UPDATE ldb_object_classes"
1645 " SET tree_key = COALESCE(tree_key, "
1647 " SELECT tree_key || "
1648 " (SELECT base160(max_child_num + 1)"
1649 " FROM ldb_object_classes"
1650 " WHERE class_name = "
1651 " new.parent_class_name)"
1652 " FROM ldb_object_classes "
1653 " WHERE class_name = new.parent_class_name "
1655 " UPDATE ldb_object_classes "
1656 " SET max_child_num = max_child_num + 1"
1657 " WHERE class_name = new.parent_class_name;"
1661 * Table initialization
1664 "INSERT INTO ldb_object_classes "
1665 " (class_name, tree_key) "
1667 " ('TOP', '0001');");
1669 /* Skip protocol indicator of url */
1670 if (strncmp(url, "sqlite3://", 10) != 0) {
1671 return SQLITE_MISUSE;
1674 /* Update pointer to just after the protocol indicator */
1677 /* Try to open the (possibly empty/non-existent) database */
1678 if ((ret = sqlite3_open(url, &lsqlite3->sqlite)) != SQLITE_OK) {
1682 /* In case this is a new database, enable auto_vacuum */
1683 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA auto_vacuum = 1;", NULL, NULL, &errmsg);
1684 if (ret != SQLITE_OK) {
1686 printf("lsqlite3 initializaion error: %s\n", errmsg);
1692 if (flags & LDB_FLG_NOSYNC) {
1694 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA synchronous = OFF;", NULL, NULL, &errmsg);
1695 if (ret != SQLITE_OK) {
1697 printf("lsqlite3 initializaion error: %s\n", errmsg);
1706 /* Establish a busy timeout of 30 seconds */
1707 if ((ret = sqlite3_busy_timeout(lsqlite3->sqlite,
1708 30000)) != SQLITE_OK) {
1712 /* Create a function, callable from sql, to increment a tree_key */
1714 sqlite3_create_function(lsqlite3->sqlite,/* handle */
1715 "base160_next", /* function name */
1716 1, /* number of args */
1717 SQLITE_ANY, /* preferred text type */
1718 NULL, /* user data */
1719 base160next_sql, /* called func */
1720 NULL, /* step func */
1721 NULL /* final func */
1726 /* Create a function, callable from sql, to convert int to base160 */
1728 sqlite3_create_function(lsqlite3->sqlite,/* handle */
1729 "base160", /* function name */
1730 1, /* number of args */
1731 SQLITE_ANY, /* preferred text type */
1732 NULL, /* user data */
1733 base160_sql, /* called func */
1734 NULL, /* step func */
1735 NULL /* final func */
1740 /* Create a function, callable from sql, to perform various comparisons */
1742 sqlite3_create_function(lsqlite3->sqlite, /* handle */
1743 "ldap_compare", /* function name */
1744 4, /* number of args */
1745 SQLITE_ANY, /* preferred text type */
1746 ldb , /* user data */
1747 lsqlite3_compare, /* called func */
1748 NULL, /* step func */
1749 NULL /* final func */
1754 /* Begin a transaction */
1755 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN EXCLUSIVE;", NULL, NULL, &errmsg);
1756 if (ret != SQLITE_OK) {
1758 printf("lsqlite3: initialization error: %s\n", errmsg);
1765 /* Determine if this is a new database. No tables means it is. */
1766 if (query_int(lsqlite3,
1769 " FROM sqlite_master\n"
1770 " WHERE type = 'table';") != 0) {
1774 if (queryInt == 0) {
1776 * Create the database schema
1778 ret = sqlite3_exec(lsqlite3->sqlite, schema, NULL, NULL, &errmsg);
1779 if (ret != SQLITE_OK) {
1781 printf("lsqlite3 initializaion error: %s\n", errmsg);
1788 * Ensure that the database we opened is one of ours
1790 if (query_int(lsqlite3,
1793 " (SELECT COUNT(*) = 2"
1794 " FROM sqlite_master "
1795 " WHERE type = 'table' "
1799 " 'ldb_object_classes' "
1805 " WHERE database_type = 'LDB' "
1806 " AND version = '1.0'"
1810 /* It's not one that we created. See ya! */
1815 /* Commit the transaction */
1816 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1817 if (ret != SQLITE_OK) {
1819 printf("lsqlite3: iniialization error: %s\n", errmsg);
1828 if (rollback) lsqlite3_safe_rollback(lsqlite3->sqlite);
1829 sqlite3_close(lsqlite3->sqlite);
1834 * connect to the database
1836 static int lsqlite3_connect(struct ldb_context *ldb,
1839 const char *options[],
1840 struct ldb_module **module)
1844 struct lsqlite3_private * lsqlite3 = NULL;
1846 lsqlite3 = talloc(ldb, struct lsqlite3_private);
1851 lsqlite3->sqlite = NULL;
1852 lsqlite3->options = NULL;
1853 lsqlite3->trans_count = 0;
1855 ret = initialize(lsqlite3, ldb, url, flags);
1856 if (ret != SQLITE_OK) {
1860 talloc_set_destructor(lsqlite3, destructor);
1864 *module = talloc(ldb, struct ldb_module);
1869 talloc_set_name_const(*module, "ldb_sqlite3 backend");
1870 (*module)->ldb = ldb;
1871 (*module)->prev = (*module)->next = NULL;
1872 (*module)->private_data = lsqlite3;
1873 (*module)->ops = &lsqlite3_ops;
1877 * take a copy of the options array, so we don't have to rely
1878 * on the caller keeping it around (it might be dynamic)
1880 for (i=0;options[i];i++) ;
1882 lsqlite3->options = talloc_array(lsqlite3, char *, i+1);
1883 if (!lsqlite3->options) {
1887 for (i=0;options[i];i++) {
1889 lsqlite3->options[i+1] = NULL;
1890 lsqlite3->options[i] =
1891 talloc_strdup(lsqlite3->options, options[i]);
1892 if (!lsqlite3->options[i]) {
1901 if (lsqlite3->sqlite != NULL) {
1902 (void) sqlite3_close(lsqlite3->sqlite);
1904 talloc_free(lsqlite3);
1908 int ldb_sqlite3_init(void)
1910 return ldb_register_backend("sqlite3", lsqlite3_connect);