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 2 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, write to the Free Software
23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 * Component: ldb sqlite3 backend
31 * Description: core files for SQLITE3 backend
33 * Author: Derrell Lipman (based on Andrew Tridgell's LDAP backend)
37 #include "ldb/include/includes.h"
41 struct lsqlite3_private {
48 struct ldb_module *module;
51 long long current_eid;
52 const char * const * attrs;
53 struct ldb_reply *ares;
57 int (*callback)(struct ldb_context *, void *, struct ldb_reply *);
60 static struct ldb_handle *init_handle(struct lsqlite3_private *lsqlite3,
61 struct ldb_module *module,
62 struct ldb_request *req)
64 struct lsql_context *ac;
67 h = talloc_zero(lsqlite3, struct ldb_handle);
69 ldb_set_errstring(module->ldb, "Out of Memory");
75 ac = talloc(h, struct lsql_context);
77 ldb_set_errstring(module->ldb, "Out of Memory");
82 h->private_data = (void *)ac;
84 h->state = LDB_ASYNC_INIT;
85 h->status = LDB_SUCCESS;
88 ac->context = req->context;
89 ac->callback = req->callback;
95 * Macros used throughout
100 # define TRUE (! FALSE)
103 #define RESULT_ATTR_TABLE "temp_result_attrs"
105 //#define TEMPTAB /* for testing, create non-temporary table */
106 #define TEMPTAB "TEMPORARY"
111 sqlite3_stmt * stmtGetEID = NULL;
113 static char *lsqlite3_tprintf(TALLOC_CTX *mem_ctx, const char *fmt, ...)
119 str = sqlite3_vmprintf(fmt, ap);
122 if (str == NULL) return NULL;
124 ret = talloc_strdup(mem_ctx, str);
134 static char base160tab[161] = {
135 48 ,49 ,50 ,51 ,52 ,53 ,54 ,55 ,56 ,57 , /* 0-9 */
136 58 ,59 ,65 ,66 ,67 ,68 ,69 ,70 ,71 ,72 , /* : ; A-H */
137 73 ,74 ,75 ,76 ,77 ,78 ,79 ,80 ,81 ,82 , /* I-R */
138 83 ,84 ,85 ,86 ,87 ,88 ,89 ,90 ,97 ,98 , /* S-Z , a-b */
139 99 ,100,101,102,103,104,105,106,107,108, /* c-l */
140 109,110,111,112,113,114,115,116,117,118, /* m-v */
141 119,120,121,122,160,161,162,163,164,165, /* w-z, latin1 */
142 166,167,168,169,170,171,172,173,174,175, /* latin1 */
143 176,177,178,179,180,181,182,183,184,185, /* latin1 */
144 186,187,188,189,190,191,192,193,194,195, /* latin1 */
145 196,197,198,199,200,201,202,203,204,205, /* latin1 */
146 206,207,208,209,210,211,212,213,214,215, /* latin1 */
147 216,217,218,219,220,221,222,223,224,225, /* latin1 */
148 226,227,228,229,230,231,232,233,234,235, /* latin1 */
149 236,237,238,239,240,241,242,243,244,245, /* latin1 */
150 246,247,248,249,250,251,252,253,254,255, /* latin1 */
158 * Convert an unsigned long integer into a base160 representation of the
163 * value to be converted
166 * character array, 5 bytes long, into which the base160 representation
167 * will be placed. The result will be a four-digit representation of the
168 * number (with leading zeros prepended as necessary), and null
175 base160_sql(sqlite3_context * hContext,
177 sqlite3_value ** argv)
183 val = sqlite3_value_int64(argv[0]);
185 for (i = 3; i >= 0; i--) {
187 result[i] = base160tab[val % 160];
193 sqlite3_result_text(hContext, result, -1, SQLITE_TRANSIENT);
200 * This function enhances sqlite by adding a "base160_next()" function which is
201 * accessible via queries.
203 * Retrieve the next-greater number in the base160 sequence for the terminal
204 * tree node (the last four digits). Only one tree level (four digits) is
208 * A character string: either an empty string (in which case no operation is
209 * performed), or a string of base160 digits with a length of a multiple of
213 * Upon return, the trailing four digits (one tree level) will have been
217 base160next_sql(sqlite3_context * hContext,
219 sqlite3_value ** argv)
224 char * pBase160 = strdup((const char *)sqlite3_value_text(argv[0]));
225 char * pStart = pBase160;
228 * We need a minimum of four digits, and we will always get a multiple
231 if (pBase160 != NULL &&
232 (len = strlen(pBase160)) >= 4 &&
235 if (pBase160 == NULL) {
237 sqlite3_result_null(hContext);
241 pBase160 += strlen(pBase160) - 1;
243 /* We only carry through four digits: one level in the tree */
244 for (i = 0; i < 4; i++) {
246 /* What base160 value does this digit have? */
247 pTab = strchr(base160tab, *pBase160);
249 /* Is there a carry? */
250 if (pTab < base160tab + sizeof(base160tab) - 1) {
253 * Nope. Just increment this value and we're
261 * There's a carry. This value gets
262 * base160tab[0], we decrement the buffer
263 * pointer to get the next higher-order digit,
264 * and continue in the loop.
266 *pBase160-- = base160tab[0];
270 sqlite3_result_text(hContext,
275 sqlite3_result_value(hContext, argv[0]);
276 if (pBase160 != NULL) {
282 static char *parsetree_to_sql(struct ldb_module *module,
284 const struct ldb_parse_tree *t)
286 const struct ldb_attrib_handler *h;
287 struct ldb_val value, subval;
288 char *wild_card_string;
295 switch(t->operation) {
298 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
299 if (tmp == NULL) return NULL;
301 for (i = 1; i < t->u.list.num_elements; i++) {
303 child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
304 if (child == NULL) return NULL;
306 tmp = talloc_asprintf_append(tmp, " INTERSECT %s ", child);
307 if (tmp == NULL) return NULL;
310 ret = talloc_asprintf(mem_ctx, "SELECT * FROM ( %s )\n", tmp);
316 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
317 if (tmp == NULL) return NULL;
319 for (i = 1; i < t->u.list.num_elements; i++) {
321 child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
322 if (child == NULL) return NULL;
324 tmp = talloc_asprintf_append(tmp, " UNION %s ", child);
325 if (tmp == NULL) return NULL;
328 return talloc_asprintf(mem_ctx, "SELECT * FROM ( %s ) ", tmp);
332 child = parsetree_to_sql(module, mem_ctx, t->u.isnot.child);
333 if (child == NULL) return NULL;
335 return talloc_asprintf(mem_ctx,
336 "SELECT eid FROM ldb_entry "
337 "WHERE eid NOT IN ( %s ) ", child);
339 case LDB_OP_EQUALITY:
341 * For simple searches, we want to retrieve the list of EIDs that
342 * match the criteria.
344 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
345 if (attr == NULL) return NULL;
346 h = ldb_attrib_handler(module->ldb, attr);
348 /* Get a canonicalised copy of the data */
349 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
350 if (value.data == NULL) {
354 if (strcasecmp(t->u.equality.attr, "objectclass") == 0) {
356 * For object classes, we want to search for all objectclasses
357 * that are subclasses as well.
359 return lsqlite3_tprintf(mem_ctx,
360 "SELECT eid FROM ldb_attribute_values\n"
361 "WHERE norm_attr_name = 'OBJECTCLASS' "
362 "AND norm_attr_value IN\n"
363 " (SELECT class_name FROM ldb_object_classes\n"
364 " WHERE tree_key GLOB\n"
365 " (SELECT tree_key FROM ldb_object_classes\n"
366 " WHERE class_name = '%q'\n"
370 } else if (strcasecmp(t->u.equality.attr, "dn") == 0) {
371 /* DN query is a special ldb case */
372 char *cdn = ldb_dn_linearize_casefold(module->ldb,
374 ldb_dn_explode(module->ldb,
375 (const char *)value.data));
377 return lsqlite3_tprintf(mem_ctx,
378 "SELECT eid FROM ldb_entry "
379 "WHERE norm_dn = '%q'", cdn);
382 /* A normal query. */
383 return lsqlite3_tprintf(mem_ctx,
384 "SELECT eid FROM ldb_attribute_values "
385 "WHERE norm_attr_name = '%q' "
386 "AND norm_attr_value = '%q'",
392 case LDB_OP_SUBSTRING:
394 wild_card_string = talloc_strdup(mem_ctx,
395 (t->u.substring.start_with_wildcard)?"*":"");
396 if (wild_card_string == NULL) return NULL;
398 for (i = 0; t->u.substring.chunks[i]; i++) {
399 wild_card_string = talloc_asprintf_append(wild_card_string, "%s*",
400 t->u.substring.chunks[i]->data);
401 if (wild_card_string == NULL) return NULL;
404 if ( ! t->u.substring.end_with_wildcard ) {
405 /* remove last wildcard */
406 wild_card_string[strlen(wild_card_string) - 1] = '\0';
409 attr = ldb_attr_casefold(mem_ctx, t->u.substring.attr);
410 if (attr == NULL) return NULL;
411 h = ldb_attrib_handler(module->ldb, attr);
413 subval.data = (void *)wild_card_string;
414 subval.length = strlen(wild_card_string) + 1;
416 /* Get a canonicalised copy of the data */
417 h->canonicalise_fn(module->ldb, mem_ctx, &(subval), &value);
418 if (value.data == NULL) {
422 return lsqlite3_tprintf(mem_ctx,
423 "SELECT eid FROM ldb_attribute_values "
424 "WHERE norm_attr_name = '%q' "
425 "AND norm_attr_value GLOB '%q'",
430 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
431 if (attr == NULL) return NULL;
432 h = ldb_attrib_handler(module->ldb, attr);
434 /* Get a canonicalised copy of the data */
435 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
436 if (value.data == NULL) {
440 return lsqlite3_tprintf(mem_ctx,
441 "SELECT eid FROM ldb_attribute_values "
442 "WHERE norm_attr_name = '%q' "
443 "AND ldap_compare(norm_attr_value, '>=', '%q', '%q') ",
449 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
450 if (attr == NULL) return NULL;
451 h = ldb_attrib_handler(module->ldb, attr);
453 /* Get a canonicalised copy of the data */
454 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
455 if (value.data == NULL) {
459 return lsqlite3_tprintf(mem_ctx,
460 "SELECT eid FROM ldb_attribute_values "
461 "WHERE norm_attr_name = '%q' "
462 "AND ldap_compare(norm_attr_value, '<=', '%q', '%q') ",
468 if (strcasecmp(t->u.present.attr, "dn") == 0) {
469 return talloc_strdup(mem_ctx, "SELECT eid FROM ldb_entry");
472 attr = ldb_attr_casefold(mem_ctx, t->u.present.attr);
473 if (attr == NULL) return NULL;
475 return lsqlite3_tprintf(mem_ctx,
476 "SELECT eid FROM ldb_attribute_values "
477 "WHERE norm_attr_name = '%q' ",
481 attr = ldb_attr_casefold(mem_ctx, t->u.equality.attr);
482 if (attr == NULL) return NULL;
483 h = ldb_attrib_handler(module->ldb, attr);
485 /* Get a canonicalised copy of the data */
486 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
487 if (value.data == NULL) {
491 return lsqlite3_tprintf(mem_ctx,
492 "SELECT eid FROM ldb_attribute_values "
493 "WHERE norm_attr_name = '%q' "
494 "AND ldap_compare(norm_attr_value, '~%', 'q', '%q') ",
499 case LDB_OP_EXTENDED:
500 #warning "work out how to handle bitops"
507 /* should never occur */
515 * This function is used for the common case of queries that return a single
518 * NOTE: If more than one value is returned by the query, all but the first
519 * one will be ignored.
522 query_int(const struct lsqlite3_private * lsqlite3,
530 sqlite3_stmt * pStmt;
533 /* Begin access to variable argument list */
534 va_start(args, pSql);
536 /* Format the query */
537 if ((p = sqlite3_vmprintf(pSql, args)) == NULL) {
542 * Prepare and execute the SQL statement. Loop allows retrying on
543 * certain errors, e.g. SQLITE_SCHEMA occurs if the schema changes,
544 * requiring retrying the operation.
546 for (bLoop = TRUE; bLoop; ) {
548 /* Compile the SQL statement into sqlite virtual machine */
549 if ((ret = sqlite3_prepare(lsqlite3->sqlite,
553 NULL)) == SQLITE_SCHEMA) {
554 if (stmtGetEID != NULL) {
555 sqlite3_finalize(stmtGetEID);
559 } else if (ret != SQLITE_OK) {
563 /* One row expected */
564 if ((ret = sqlite3_step(pStmt)) == SQLITE_SCHEMA) {
565 if (stmtGetEID != NULL) {
566 sqlite3_finalize(stmtGetEID);
569 (void) sqlite3_finalize(pStmt);
571 } else if (ret != SQLITE_ROW) {
572 (void) sqlite3_finalize(pStmt);
576 /* Get the value to be returned */
577 *pRet = sqlite3_column_int64(pStmt, 0);
579 /* Free the virtual machine */
580 if ((ret = sqlite3_finalize(pStmt)) == SQLITE_SCHEMA) {
581 if (stmtGetEID != NULL) {
582 sqlite3_finalize(stmtGetEID);
586 } else if (ret != SQLITE_OK) {
587 (void) sqlite3_finalize(pStmt);
592 * Normal condition is only one time through loop. Loop is
593 * rerun in error conditions, via "continue", above.
598 /* All done with variable argument list */
602 /* Free the memory we allocated for our query string */
609 * This is a bad hack to support ldap style comparisons whithin sqlite.
610 * val is the attribute in the row currently under test
611 * func is the desired test "<=" ">=" "~" ":"
612 * cmp is the value to compare against (eg: "test")
613 * attr is the attribute name the value of which we want to test
616 static void lsqlite3_compare(sqlite3_context *ctx, int argc,
617 sqlite3_value **argv)
619 struct ldb_context *ldb = (struct ldb_context *)sqlite3_user_data(ctx);
620 const char *val = (const char *)sqlite3_value_text(argv[0]);
621 const char *func = (const char *)sqlite3_value_text(argv[1]);
622 const char *cmp = (const char *)sqlite3_value_text(argv[2]);
623 const char *attr = (const char *)sqlite3_value_text(argv[3]);
624 const struct ldb_attrib_handler *h;
632 h = ldb_attrib_handler(ldb, attr);
633 valX.data = (void *)cmp;
634 valX.length = strlen(cmp);
635 valY.data = (void *)val;
636 valY.length = strlen(val);
637 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
639 sqlite3_result_int(ctx, 1);
641 sqlite3_result_int(ctx, 0);
646 h = ldb_attrib_handler(ldb, attr);
647 valX.data = (void *)cmp;
648 valX.length = strlen(cmp);
649 valY.data = (void *)val;
650 valY.length = strlen(val);
651 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
653 sqlite3_result_int(ctx, 1);
655 sqlite3_result_int(ctx, 0);
661 sqlite3_result_int(ctx, 0);
667 sqlite3_result_int(ctx, 0);
674 sqlite3_result_error(ctx, "Value must start with a special operation char (<>~:)!", -1);
679 /* rename a record */
680 static int lsqlite3_safe_rollback(sqlite3 *sqlite)
686 ret = sqlite3_exec(sqlite, "ROLLBACK;", NULL, NULL, &errmsg);
687 if (ret != SQLITE_OK) {
689 printf("lsqlite3_safe_rollback: Error: %s\n", errmsg);
698 /* return an eid as result */
699 static int lsqlite3_eid_callback(void *result, int col_num, char **cols, char **names)
701 long long *eid = (long long *)result;
703 if (col_num != 1) return SQLITE_ABORT;
704 if (strcasecmp(names[0], "eid") != 0) return SQLITE_ABORT;
706 *eid = atoll(cols[0]);
711 * add a single set of ldap message values to a ldb_message
713 static int lsqlite3_search_callback(void *result, int col_num, char **cols, char **names)
715 struct ldb_handle *handle = talloc_get_type(result, struct ldb_handle);
716 struct lsql_context *ac = talloc_get_type(handle->private_data, struct lsql_context);
717 struct ldb_message *msg;
721 /* eid, dn, attr_name, attr_value */
725 eid = atoll(cols[0]);
727 if (eid != ac->current_eid) { /* here begin a new entry */
729 /* call the async callback for the last entry
730 * except the first time */
731 if (ac->current_eid != 0) {
732 ac->ares->message = ldb_msg_canonicalize(ac->module->ldb, ac->ares->message);
733 if (ac->ares->message == NULL)
736 handle->status = ac->callback(ac->module->ldb, ac->context, ac->ares);
737 if (handle->status != LDB_SUCCESS)
742 ac->ares = talloc_zero(ac, struct ldb_reply);
746 ac->ares->message = ldb_msg_new(ac->ares);
747 if (!ac->ares->message)
750 ac->ares->type = LDB_REPLY_ENTRY;
751 ac->current_eid = eid;
754 msg = ac->ares->message;
756 if (msg->dn == NULL) {
757 msg->dn = ldb_dn_explode(msg, cols[1]);
764 for (i = 0; ac->attrs[i]; i++) {
765 if (strcasecmp(cols[2], ac->attrs[i]) == 0) {
770 if (!found) return SQLITE_OK;
773 if (ldb_msg_add_string(msg, cols[2], cols[3]) != 0) {
783 * lsqlite3_get_eid_ndn()
785 * These functions are used for the very common case of retrieving an EID value
786 * given a (normalized) DN.
789 static long long lsqlite3_get_eid_ndn(sqlite3 *sqlite, void *mem_ctx, const char *norm_dn)
797 query = lsqlite3_tprintf(mem_ctx, "SELECT eid "
799 "WHERE norm_dn = '%q';", norm_dn);
800 if (query == NULL) return -1;
802 ret = sqlite3_exec(sqlite, query, lsqlite3_eid_callback, &eid, &errmsg);
803 if (ret != SQLITE_OK) {
805 printf("lsqlite3_get_eid: Fatal Error: %s\n", errmsg);
814 static long long lsqlite3_get_eid(struct ldb_module *module, const struct ldb_dn *dn)
816 TALLOC_CTX *local_ctx;
817 struct lsqlite3_private *lsqlite3 = module->private_data;
821 /* ignore ltdb specials */
822 if (ldb_dn_is_special(dn)) {
826 /* create a local ctx */
827 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_get_eid local context");
828 if (local_ctx == NULL) {
832 cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, local_ctx, dn));
835 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, local_ctx, cdn);
838 talloc_free(local_ctx);
843 * Interface functions referenced by lsqlite3_ops
846 /* search for matching records, by tree */
847 int lsql_search(struct ldb_module *module, struct ldb_request *req)
849 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
850 struct lsql_context *lsql_ac;
857 req->handle = init_handle(lsqlite3, module, req);
858 if (req->handle == NULL) {
859 return LDB_ERR_OPERATIONS_ERROR;
862 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
864 if ((req->op.search.base == NULL || req->op.search.base->comp_num == 0) &&
865 (req->op.search.scope == LDB_SCOPE_BASE || req->op.search.scope == LDB_SCOPE_ONELEVEL))
866 return LDB_ERR_OPERATIONS_ERROR;
868 if (req->op.search.base) {
869 norm_basedn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.search.base));
870 if (norm_basedn == NULL) {
871 ret = LDB_ERR_INVALID_DN_SYNTAX;
874 } else norm_basedn = talloc_strdup(lsql_ac, "");
876 /* Convert filter into a series of SQL conditions (constraints) */
877 sqlfilter = parsetree_to_sql(module, lsql_ac, req->op.search.tree);
879 switch(req->op.search.scope) {
880 case LDB_SCOPE_DEFAULT:
881 case LDB_SCOPE_SUBTREE:
882 if (*norm_basedn != '\0') {
883 query = lsqlite3_tprintf(lsql_ac,
884 "SELECT entry.eid,\n"
888 " FROM ldb_entry AS entry\n"
890 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
891 " ON av.eid = entry.eid\n"
893 " WHERE entry.eid IN\n"
894 " (SELECT DISTINCT ldb_entry.eid\n"
896 " WHERE (ldb_entry.norm_dn GLOB('*,%q')\n"
897 " OR ldb_entry.norm_dn = '%q')\n"
898 " AND ldb_entry.eid IN\n"
902 " ORDER BY entry.eid ASC;",
907 query = lsqlite3_tprintf(lsql_ac,
908 "SELECT entry.eid,\n"
912 " FROM ldb_entry AS entry\n"
914 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
915 " ON av.eid = entry.eid\n"
917 " WHERE entry.eid IN\n"
918 " (SELECT DISTINCT ldb_entry.eid\n"
920 " WHERE ldb_entry.eid IN\n"
924 " ORDER BY entry.eid ASC;",
931 query = lsqlite3_tprintf(lsql_ac,
932 "SELECT entry.eid,\n"
936 " FROM ldb_entry AS entry\n"
938 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
939 " ON av.eid = entry.eid\n"
941 " WHERE entry.eid IN\n"
942 " (SELECT DISTINCT ldb_entry.eid\n"
944 " WHERE ldb_entry.norm_dn = '%q'\n"
945 " AND ldb_entry.eid IN\n"
949 " ORDER BY entry.eid ASC;",
954 case LDB_SCOPE_ONELEVEL:
955 query = lsqlite3_tprintf(lsql_ac,
956 "SELECT entry.eid,\n"
960 " FROM ldb_entry AS entry\n"
962 " LEFT OUTER JOIN ldb_attribute_values AS av\n"
963 " ON av.eid = entry.eid\n"
965 " WHERE entry.eid IN\n"
966 " (SELECT DISTINCT ldb_entry.eid\n"
968 " WHERE norm_dn GLOB('*,%q')\n"
969 " AND NOT norm_dn GLOB('*,*,%q')\n"
970 " AND ldb_entry.eid IN\n(%s)\n"
973 " ORDER BY entry.eid ASC;",
985 printf ("%s\n", query);
988 lsql_ac->current_eid = 0;
989 lsql_ac->attrs = req->op.search.attrs;
990 lsql_ac->ares = NULL;
992 req->handle->state = LDB_ASYNC_PENDING;
994 ret = sqlite3_exec(lsqlite3->sqlite, query, lsqlite3_search_callback, req->handle, &errmsg);
995 if (ret != SQLITE_OK) {
997 ldb_set_errstring(module->ldb, errmsg);
1003 /* complete the last message if any */
1004 if (lsql_ac->ares) {
1005 lsql_ac->ares->message = ldb_msg_canonicalize(module->ldb, lsql_ac->ares->message);
1006 if (lsql_ac->ares->message == NULL)
1009 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, lsql_ac->ares);
1010 if (req->handle->status != LDB_SUCCESS)
1014 req->handle->state = LDB_ASYNC_DONE;
1019 return LDB_ERR_OPERATIONS_ERROR;
1023 static int lsql_add(struct ldb_module *module, struct ldb_request *req)
1025 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1026 struct lsql_context *lsql_ac;
1027 struct ldb_message *msg = req->op.add.message;
1033 int ret = LDB_SUCCESS;
1035 req->handle = init_handle(lsqlite3, module, req);
1036 if (req->handle == NULL) {
1037 return LDB_ERR_OPERATIONS_ERROR;
1039 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1040 req->handle->state = LDB_ASYNC_DONE;
1041 req->handle->status = LDB_SUCCESS;
1043 /* See if this is an ltdb special */
1044 if (ldb_dn_is_special(msg->dn)) {
1047 c = ldb_dn_explode(lsql_ac, "@SUBCLASSES");
1048 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1049 #warning "insert subclasses into object class tree"
1050 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1055 c = ldb_dn_explode(local_ctx, "@INDEXLIST");
1056 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1057 #warning "should we handle indexes somehow ?"
1058 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1062 /* Others return an error */
1063 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1067 /* create linearized and normalized dns */
1068 dn = ldb_dn_linearize(lsql_ac, msg->dn);
1069 ndn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, msg->dn));
1070 if (dn == NULL || ndn == NULL) {
1071 ret = LDB_ERR_OTHER;
1075 query = lsqlite3_tprintf(lsql_ac,
1077 "INSERT OR ABORT INTO ldb_entry "
1078 "('dn', 'norm_dn') "
1079 "VALUES ('%q', '%q');",
1081 if (query == NULL) {
1082 ret = LDB_ERR_OTHER;
1086 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1087 if (ret != SQLITE_OK) {
1089 ldb_set_errstring(module->ldb, errmsg);
1092 ret = LDB_ERR_OTHER;
1096 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, lsql_ac, ndn);
1098 ret = LDB_ERR_OTHER;
1102 for (i = 0; i < msg->num_elements; i++) {
1103 const struct ldb_message_element *el = &msg->elements[i];
1104 const struct ldb_attrib_handler *h;
1108 /* Get a case-folded copy of the attribute name */
1109 attr = ldb_attr_casefold(lsql_ac, el->name);
1111 ret = LDB_ERR_OTHER;
1115 h = ldb_attrib_handler(module->ldb, el->name);
1117 /* For each value of the specified attribute name... */
1118 for (j = 0; j < el->num_values; j++) {
1119 struct ldb_val value;
1122 /* Get a canonicalised copy of the data */
1123 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1124 if (value.data == NULL) {
1125 ret = LDB_ERR_OTHER;
1129 insert = lsqlite3_tprintf(lsql_ac,
1130 "INSERT OR ROLLBACK INTO ldb_attribute_values "
1131 "('eid', 'attr_name', 'norm_attr_name',"
1132 " 'attr_value', 'norm_attr_value') "
1133 "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1134 eid, el->name, attr,
1135 el->values[j].data, value.data);
1136 if (insert == NULL) {
1137 ret = LDB_ERR_OTHER;
1141 ret = sqlite3_exec(lsqlite3->sqlite, insert, NULL, NULL, &errmsg);
1142 if (ret != SQLITE_OK) {
1144 ldb_set_errstring(module->ldb, errmsg);
1147 ret = LDB_ERR_OTHER;
1153 if (lsql_ac->callback) {
1154 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1158 req->handle->state = LDB_ASYNC_DONE;
1162 /* modify a record */
1163 static int lsql_modify(struct ldb_module *module, struct ldb_request *req)
1165 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1166 struct lsql_context *lsql_ac;
1167 struct ldb_message *msg = req->op.mod.message;
1171 int ret = LDB_SUCCESS;
1173 req->handle = init_handle(lsqlite3, module, req);
1174 if (req->handle == NULL) {
1175 return LDB_ERR_OPERATIONS_ERROR;
1177 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1178 req->handle->state = LDB_ASYNC_DONE;
1179 req->handle->status = LDB_SUCCESS;
1181 /* See if this is an ltdb special */
1182 if (ldb_dn_is_special(msg->dn)) {
1185 c = ldb_dn_explode(lsql_ac, "@SUBCLASSES");
1186 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1187 #warning "modify subclasses into object class tree"
1188 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1192 /* Others return an error */
1193 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1197 eid = lsqlite3_get_eid(module, msg->dn);
1199 ret = LDB_ERR_OTHER;
1203 for (i = 0; i < msg->num_elements; i++) {
1204 const struct ldb_message_element *el = &msg->elements[i];
1205 const struct ldb_attrib_handler *h;
1206 int flags = el->flags & LDB_FLAG_MOD_MASK;
1211 /* Get a case-folded copy of the attribute name */
1212 attr = ldb_attr_casefold(lsql_ac, el->name);
1214 ret = LDB_ERR_OTHER;
1218 h = ldb_attrib_handler(module->ldb, el->name);
1222 case LDB_FLAG_MOD_REPLACE:
1224 /* remove all attributes before adding the replacements */
1225 mod = lsqlite3_tprintf(lsql_ac,
1226 "DELETE FROM ldb_attribute_values "
1227 "WHERE eid = '%lld' "
1228 "AND norm_attr_name = '%q';",
1231 ret = LDB_ERR_OTHER;
1235 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1236 if (ret != SQLITE_OK) {
1238 ldb_set_errstring(module->ldb, errmsg);
1241 ret = LDB_ERR_OTHER;
1245 /* MISSING break is INTENTIONAL */
1247 case LDB_FLAG_MOD_ADD:
1248 #warning "We should throw an error if no value is provided!"
1249 /* For each value of the specified attribute name... */
1250 for (j = 0; j < el->num_values; j++) {
1251 struct ldb_val value;
1253 /* Get a canonicalised copy of the data */
1254 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1255 if (value.data == NULL) {
1256 ret = LDB_ERR_OTHER;
1260 mod = lsqlite3_tprintf(lsql_ac,
1261 "INSERT OR ROLLBACK INTO ldb_attribute_values "
1262 "('eid', 'attr_name', 'norm_attr_name',"
1263 " 'attr_value', 'norm_attr_value') "
1264 "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1265 eid, el->name, attr,
1266 el->values[j].data, value.data);
1269 ret = LDB_ERR_OTHER;
1273 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1274 if (ret != SQLITE_OK) {
1276 ldb_set_errstring(module->ldb, errmsg);
1279 ret = LDB_ERR_OTHER;
1286 case LDB_FLAG_MOD_DELETE:
1287 #warning "We should throw an error if the attribute we are trying to delete does not exist!"
1288 if (el->num_values == 0) {
1289 mod = lsqlite3_tprintf(lsql_ac,
1290 "DELETE FROM ldb_attribute_values "
1291 "WHERE eid = '%lld' "
1292 "AND norm_attr_name = '%q';",
1295 ret = LDB_ERR_OTHER;
1299 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1300 if (ret != SQLITE_OK) {
1302 ldb_set_errstring(module->ldb, errmsg);
1305 ret = LDB_ERR_OTHER;
1310 /* For each value of the specified attribute name... */
1311 for (j = 0; j < el->num_values; j++) {
1312 struct ldb_val value;
1314 /* Get a canonicalised copy of the data */
1315 h->canonicalise_fn(module->ldb, lsql_ac, &(el->values[j]), &value);
1316 if (value.data == NULL) {
1317 ret = LDB_ERR_OTHER;
1321 mod = lsqlite3_tprintf(lsql_ac,
1322 "DELETE FROM ldb_attribute_values "
1323 "WHERE eid = '%lld' "
1324 "AND norm_attr_name = '%q' "
1325 "AND norm_attr_value = '%q';",
1326 eid, attr, value.data);
1329 ret = LDB_ERR_OTHER;
1333 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1334 if (ret != SQLITE_OK) {
1336 ldb_set_errstring(module->ldb, errmsg);
1339 ret = LDB_ERR_OTHER;
1348 if (lsql_ac->callback) {
1349 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1353 req->handle->state = LDB_ASYNC_DONE;
1357 /* delete a record */
1358 static int lsql_delete(struct ldb_module *module, struct ldb_request *req)
1360 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1361 struct lsql_context *lsql_ac;
1365 int ret = LDB_SUCCESS;
1368 req->handle = init_handle(lsqlite3, module, req);
1369 if (req->handle == NULL) {
1370 return LDB_ERR_OPERATIONS_ERROR;
1372 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1373 req->handle->state = LDB_ASYNC_DONE;
1374 req->handle->status = LDB_SUCCESS;
1376 eid = lsqlite3_get_eid(module, req->op.del.dn);
1381 query = lsqlite3_tprintf(lsql_ac,
1383 "DELETE FROM ldb_entry WHERE eid = %lld; "
1384 /* Delete attributes */
1385 "DELETE FROM ldb_attribute_values WHERE eid = %lld; ",
1387 if (query == NULL) {
1388 ret = LDB_ERR_OTHER;
1392 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1393 if (ret != SQLITE_OK) {
1395 ldb_set_errstring(module->ldb, errmsg);
1398 req->handle->status = LDB_ERR_OPERATIONS_ERROR;
1402 if (lsql_ac->callback) {
1403 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1407 req->handle->state = LDB_ASYNC_DONE;
1411 /* rename a record */
1412 static int lsql_rename(struct ldb_module *module, struct ldb_request *req)
1414 struct lsqlite3_private *lsqlite3 = talloc_get_type(module->private_data, struct lsqlite3_private);
1415 struct lsql_context *lsql_ac;
1416 char *new_dn, *new_cdn, *old_cdn;
1419 int ret = LDB_SUCCESS;
1421 req->handle = init_handle(lsqlite3, module, req);
1422 if (req->handle == NULL) {
1423 return LDB_ERR_OPERATIONS_ERROR;
1425 lsql_ac = talloc_get_type(req->handle->private_data, struct lsql_context);
1426 req->handle->state = LDB_ASYNC_DONE;
1427 req->handle->status = LDB_SUCCESS;
1429 /* create linearized and normalized dns */
1430 old_cdn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.rename.olddn));
1431 new_cdn = ldb_dn_linearize(lsql_ac, ldb_dn_casefold(module->ldb, lsql_ac, req->op.rename.newdn));
1432 new_dn = ldb_dn_linearize(lsql_ac, req->op.rename.newdn);
1433 if (old_cdn == NULL || new_cdn == NULL || new_dn == NULL) {
1437 /* build the SQL query */
1438 query = lsqlite3_tprintf(lsql_ac,
1439 "UPDATE ldb_entry SET dn = '%q', norm_dn = '%q' "
1440 "WHERE norm_dn = '%q';",
1441 new_dn, new_cdn, old_cdn);
1442 if (query == NULL) {
1447 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1448 if (ret != SQLITE_OK) {
1450 ldb_set_errstring(module->ldb, errmsg);
1453 ret = LDB_ERR_OPERATIONS_ERROR;
1457 if (lsql_ac->callback) {
1458 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1462 req->handle->state = LDB_ASYNC_DONE;
1466 static int lsql_start_trans(struct ldb_module * module)
1470 struct lsqlite3_private * lsqlite3 = module->private_data;
1472 if (lsqlite3->trans_count == 0) {
1473 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN IMMEDIATE;", NULL, NULL, &errmsg);
1474 if (ret != SQLITE_OK) {
1476 printf("lsqlite3_start_trans: error: %s\n", errmsg);
1483 lsqlite3->trans_count++;
1488 static int lsql_end_trans(struct ldb_module *module)
1492 struct lsqlite3_private *lsqlite3 = module->private_data;
1494 if (lsqlite3->trans_count > 0) {
1495 lsqlite3->trans_count--;
1498 if (lsqlite3->trans_count == 0) {
1499 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1500 if (ret != SQLITE_OK) {
1502 printf("lsqlite3_end_trans: error: %s\n", errmsg);
1512 static int lsql_del_trans(struct ldb_module *module)
1514 struct lsqlite3_private *lsqlite3 = module->private_data;
1516 if (lsqlite3->trans_count > 0) {
1517 lsqlite3->trans_count--;
1520 if (lsqlite3->trans_count == 0) {
1521 return lsqlite3_safe_rollback(lsqlite3->sqlite);
1527 static int destructor(struct lsqlite3_private *lsqlite3)
1529 if (lsqlite3->sqlite) {
1530 sqlite3_close(lsqlite3->sqlite);
1535 static int lsql_request(struct ldb_module *module, struct ldb_request *req)
1537 return LDB_ERR_OPERATIONS_ERROR;
1540 static int lsql_wait(struct ldb_handle *handle, enum ldb_wait_type type)
1542 return handle->status;
1546 * Table of operations for the sqlite3 backend
1548 static const struct ldb_module_ops lsqlite3_ops = {
1550 .search = lsql_search,
1552 .modify = lsql_modify,
1554 .rename = lsql_rename,
1555 .request = lsql_request,
1556 .start_transaction = lsql_start_trans,
1557 .end_transaction = lsql_end_trans,
1558 .del_transaction = lsql_del_trans,
1566 static int initialize(struct lsqlite3_private *lsqlite3,
1567 struct ldb_context *ldb, const char *url, int flags)
1569 TALLOC_CTX *local_ctx;
1576 /* create a local ctx */
1577 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_rename local context");
1578 if (local_ctx == NULL) {
1582 schema = lsqlite3_tprintf(local_ctx,
1585 "CREATE TABLE ldb_info AS "
1586 " SELECT 'LDB' AS database_type,"
1587 " '1.0' AS version;"
1590 * The entry table holds the information about an entry.
1591 * This table is used to obtain the EID of the entry and to
1592 * support scope=one and scope=base. The parent and child
1593 * table is included in the entry table since all the other
1594 * attributes are dependent on EID.
1596 "CREATE TABLE ldb_entry "
1598 " eid INTEGER PRIMARY KEY AUTOINCREMENT,"
1599 " dn TEXT UNIQUE NOT NULL,"
1600 " norm_dn TEXT UNIQUE NOT NULL"
1604 "CREATE TABLE ldb_object_classes"
1606 " class_name TEXT PRIMARY KEY,"
1607 " parent_class_name TEXT,"
1608 " tree_key TEXT UNIQUE,"
1609 " max_child_num INTEGER DEFAULT 0"
1613 * We keep a full listing of attribute/value pairs here
1615 "CREATE TABLE ldb_attribute_values"
1617 " eid INTEGER REFERENCES ldb_entry,"
1619 " norm_attr_name TEXT,"
1621 " norm_attr_value TEXT "
1628 "CREATE INDEX ldb_attribute_values_eid_idx "
1629 " ON ldb_attribute_values (eid);"
1631 "CREATE INDEX ldb_attribute_values_name_value_idx "
1632 " ON ldb_attribute_values (attr_name, norm_attr_value);"
1640 "CREATE TRIGGER ldb_object_classes_insert_tr"
1642 " ON ldb_object_classes"
1645 " UPDATE ldb_object_classes"
1646 " SET tree_key = COALESCE(tree_key, "
1648 " SELECT tree_key || "
1649 " (SELECT base160(max_child_num + 1)"
1650 " FROM ldb_object_classes"
1651 " WHERE class_name = "
1652 " new.parent_class_name)"
1653 " FROM ldb_object_classes "
1654 " WHERE class_name = new.parent_class_name "
1656 " UPDATE ldb_object_classes "
1657 " SET max_child_num = max_child_num + 1"
1658 " WHERE class_name = new.parent_class_name;"
1662 * Table initialization
1665 "INSERT INTO ldb_object_classes "
1666 " (class_name, tree_key) "
1668 " ('TOP', '0001');");
1670 /* Skip protocol indicator of url */
1671 if (strncmp(url, "sqlite3://", 10) != 0) {
1672 return SQLITE_MISUSE;
1675 /* Update pointer to just after the protocol indicator */
1678 /* Try to open the (possibly empty/non-existent) database */
1679 if ((ret = sqlite3_open(url, &lsqlite3->sqlite)) != SQLITE_OK) {
1683 /* In case this is a new database, enable auto_vacuum */
1684 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA auto_vacuum = 1;", NULL, NULL, &errmsg);
1685 if (ret != SQLITE_OK) {
1687 printf("lsqlite3 initializaion error: %s\n", errmsg);
1693 if (flags & LDB_FLG_NOSYNC) {
1695 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA synchronous = OFF;", NULL, NULL, &errmsg);
1696 if (ret != SQLITE_OK) {
1698 printf("lsqlite3 initializaion error: %s\n", errmsg);
1707 /* Establish a busy timeout of 30 seconds */
1708 if ((ret = sqlite3_busy_timeout(lsqlite3->sqlite,
1709 30000)) != SQLITE_OK) {
1713 /* Create a function, callable from sql, to increment a tree_key */
1715 sqlite3_create_function(lsqlite3->sqlite,/* handle */
1716 "base160_next", /* function name */
1717 1, /* number of args */
1718 SQLITE_ANY, /* preferred text type */
1719 NULL, /* user data */
1720 base160next_sql, /* called func */
1721 NULL, /* step func */
1722 NULL /* final func */
1727 /* Create a function, callable from sql, to convert int to base160 */
1729 sqlite3_create_function(lsqlite3->sqlite,/* handle */
1730 "base160", /* function name */
1731 1, /* number of args */
1732 SQLITE_ANY, /* preferred text type */
1733 NULL, /* user data */
1734 base160_sql, /* called func */
1735 NULL, /* step func */
1736 NULL /* final func */
1741 /* Create a function, callable from sql, to perform various comparisons */
1743 sqlite3_create_function(lsqlite3->sqlite, /* handle */
1744 "ldap_compare", /* function name */
1745 4, /* number of args */
1746 SQLITE_ANY, /* preferred text type */
1747 ldb , /* user data */
1748 lsqlite3_compare, /* called func */
1749 NULL, /* step func */
1750 NULL /* final func */
1755 /* Begin a transaction */
1756 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN EXCLUSIVE;", NULL, NULL, &errmsg);
1757 if (ret != SQLITE_OK) {
1759 printf("lsqlite3: initialization error: %s\n", errmsg);
1766 /* Determine if this is a new database. No tables means it is. */
1767 if (query_int(lsqlite3,
1770 " FROM sqlite_master\n"
1771 " WHERE type = 'table';") != 0) {
1775 if (queryInt == 0) {
1777 * Create the database schema
1779 ret = sqlite3_exec(lsqlite3->sqlite, schema, NULL, NULL, &errmsg);
1780 if (ret != SQLITE_OK) {
1782 printf("lsqlite3 initializaion error: %s\n", errmsg);
1789 * Ensure that the database we opened is one of ours
1791 if (query_int(lsqlite3,
1794 " (SELECT COUNT(*) = 2"
1795 " FROM sqlite_master "
1796 " WHERE type = 'table' "
1800 " 'ldb_object_classes' "
1806 " WHERE database_type = 'LDB' "
1807 " AND version = '1.0'"
1811 /* It's not one that we created. See ya! */
1816 /* Commit the transaction */
1817 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1818 if (ret != SQLITE_OK) {
1820 printf("lsqlite3: iniialization error: %s\n", errmsg);
1829 if (rollback) lsqlite3_safe_rollback(lsqlite3->sqlite);
1830 sqlite3_close(lsqlite3->sqlite);
1835 * connect to the database
1837 static int lsqlite3_connect(struct ldb_context *ldb,
1840 const char *options[],
1841 struct ldb_module **module)
1845 struct lsqlite3_private * lsqlite3 = NULL;
1847 lsqlite3 = talloc(ldb, struct lsqlite3_private);
1852 lsqlite3->sqlite = NULL;
1853 lsqlite3->options = NULL;
1854 lsqlite3->trans_count = 0;
1856 ret = initialize(lsqlite3, ldb, url, flags);
1857 if (ret != SQLITE_OK) {
1861 talloc_set_destructor(lsqlite3, destructor);
1865 *module = talloc(ldb, struct ldb_module);
1870 talloc_set_name_const(*module, "ldb_sqlite3 backend");
1871 (*module)->ldb = ldb;
1872 (*module)->prev = (*module)->next = NULL;
1873 (*module)->private_data = lsqlite3;
1874 (*module)->ops = &lsqlite3_ops;
1878 * take a copy of the options array, so we don't have to rely
1879 * on the caller keeping it around (it might be dynamic)
1881 for (i=0;options[i];i++) ;
1883 lsqlite3->options = talloc_array(lsqlite3, char *, i+1);
1884 if (!lsqlite3->options) {
1888 for (i=0;options[i];i++) {
1890 lsqlite3->options[i+1] = NULL;
1891 lsqlite3->options[i] =
1892 talloc_strdup(lsqlite3->options, options[i]);
1893 if (!lsqlite3->options[i]) {
1902 if (lsqlite3->sqlite != NULL) {
1903 (void) sqlite3_close(lsqlite3->sqlite);
1905 talloc_free(lsqlite3);
1909 int ldb_sqlite3_init(void)
1911 return ldb_register_backend("sqlite3", lsqlite3_connect);