s3: Call va_end() after all va_start()/va_copy() calls.
[Samba.git] / source3 / lib / ldb / ldb_sqlite3 / ldb_sqlite3.c
blobd8fc1627410c5119226cc82a4f5032ec78e30301
1 /*
2 ldb database library
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
9 ** under the LGPL
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/>.
26 * Name: ldb
28 * Component: ldb sqlite3 backend
30 * Description: core files for SQLITE3 backend
32 * Author: Derrell Lipman (based on Andrew Tridgell's LDAP backend)
35 #include "includes.h"
36 #include "ldb/include/includes.h"
38 #include <sqlite3.h>
40 struct lsqlite3_private {
41 int trans_count;
42 char **options;
43 sqlite3 *sqlite;
46 struct lsql_context {
47 struct ldb_module *module;
49 /* search stuff */
50 long long current_eid;
51 const char * const * attrs;
52 struct ldb_reply *ares;
54 /* async stuff */
55 void *context;
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;
64 struct ldb_handle *h;
66 h = talloc_zero(lsqlite3, struct ldb_handle);
67 if (h == NULL) {
68 ldb_set_errstring(module->ldb, "Out of Memory");
69 return NULL;
72 h->module = module;
74 ac = talloc(h, struct lsql_context);
75 if (ac == NULL) {
76 ldb_set_errstring(module->ldb, "Out of Memory");
77 talloc_free(h);
78 return NULL;
81 h->private_data = (void *)ac;
83 h->state = LDB_ASYNC_INIT;
84 h->status = LDB_SUCCESS;
86 ac->module = module;
87 ac->context = req->context;
88 ac->callback = req->callback;
90 return h;
94 * Macros used throughout
97 #ifndef FALSE
98 # define FALSE (0)
99 # define TRUE (! FALSE)
100 #endif
102 #define RESULT_ATTR_TABLE "temp_result_attrs"
104 //#define TEMPTAB /* for testing, create non-temporary table */
105 #define TEMPTAB "TEMPORARY"
108 * Static variables
110 sqlite3_stmt * stmtGetEID = NULL;
112 static char *lsqlite3_tprintf(TALLOC_CTX *mem_ctx, const char *fmt, ...)
114 char *str, *ret;
115 va_list ap;
117 va_start(ap, fmt);
118 str = sqlite3_vmprintf(fmt, ap);
119 va_end(ap);
121 if (str == NULL) return NULL;
123 ret = talloc_strdup(mem_ctx, str);
124 if (ret == NULL) {
125 sqlite3_free(str);
126 return NULL;
129 sqlite3_free(str);
130 return ret;
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 */
150 '\0'
155 * base160()
157 * Convert an unsigned long integer into a base160 representation of the
158 * number.
160 * Parameters:
161 * val --
162 * value to be converted
164 * result --
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
168 * terminated.
170 * Returns:
171 * Nothing
173 static void
174 base160_sql(sqlite3_context * hContext,
175 int argc,
176 sqlite3_value ** argv)
178 int i;
179 long long val;
180 char result[5];
182 val = sqlite3_value_int64(argv[0]);
184 for (i = 3; i >= 0; i--) {
186 result[i] = base160tab[val % 160];
187 val /= 160;
190 result[4] = '\0';
192 sqlite3_result_text(hContext, result, -1, SQLITE_TRANSIENT);
197 * base160next_sql()
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
204 * operated on.
206 * Input:
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
209 * four digits.
211 * Output:
212 * Upon return, the trailing four digits (one tree level) will have been
213 * incremented by 1.
215 static void
216 base160next_sql(sqlite3_context * hContext,
217 int argc,
218 sqlite3_value ** argv)
220 int i;
221 int len;
222 char * pTab;
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
228 * of four digits.
230 if (pBase160 != NULL &&
231 (len = strlen(pBase160)) >= 4 &&
232 len % 4 == 0) {
234 if (pBase160 == NULL) {
236 sqlite3_result_null(hContext);
237 return;
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
253 * done.
255 *pBase160 = *++pTab;
256 break;
257 } else {
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,
270 pStart,
271 strlen(pStart),
272 free);
273 } else {
274 sqlite3_result_value(hContext, argv[0]);
275 if (pBase160 != NULL) {
276 free(pBase160);
281 static char *parsetree_to_sql(struct ldb_module *module,
282 void *mem_ctx,
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;
288 char *child, *tmp;
289 char *ret = NULL;
290 char *attr;
291 int i;
294 switch(t->operation) {
295 case LDB_OP_AND:
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);
311 return ret;
313 case LDB_OP_OR:
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);
329 case LDB_OP_NOT:
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) {
350 return 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"
366 " ) || '*'\n"
367 " )\n", value.data);
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,
372 mem_ctx,
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);
380 } else {
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'",
386 attr,
387 value.data);
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) {
418 return 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'",
425 attr,
426 value.data);
428 case LDB_OP_GREATER:
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) {
436 return 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') ",
443 attr,
444 value.data,
445 attr);
447 case LDB_OP_LESS:
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) {
455 return 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') ",
462 attr,
463 value.data,
464 attr);
466 case LDB_OP_PRESENT:
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' ",
477 attr);
479 case LDB_OP_APPROX:
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) {
487 return 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') ",
494 attr,
495 value.data,
496 attr);
498 case LDB_OP_EXTENDED:
499 #warning "work out how to handle bitops"
500 return NULL;
502 default:
503 break;
506 /* should never occur */
507 abort();
508 return NULL;
512 * query_int()
514 * This function is used for the common case of queries that return a single
515 * integer value.
517 * NOTE: If more than one value is returned by the query, all but the first
518 * one will be ignored.
520 static int
521 query_int(const struct lsqlite3_private * lsqlite3,
522 long long * pRet,
523 const char * pSql,
524 ...)
526 int ret;
527 int bLoop;
528 char * p;
529 sqlite3_stmt * pStmt;
530 va_list args;
532 /* Begin access to variable argument list */
533 va_start(args, pSql);
535 /* Format the query */
536 if ((p = sqlite3_vmprintf(pSql, args)) == NULL) {
537 va_end(args);
538 return SQLITE_NOMEM;
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,
552 &pStmt,
553 NULL)) == SQLITE_SCHEMA) {
554 if (stmtGetEID != NULL) {
555 sqlite3_finalize(stmtGetEID);
556 stmtGetEID = NULL;
558 continue;
559 } else if (ret != SQLITE_OK) {
560 break;
563 /* One row expected */
564 if ((ret = sqlite3_step(pStmt)) == SQLITE_SCHEMA) {
565 if (stmtGetEID != NULL) {
566 sqlite3_finalize(stmtGetEID);
567 stmtGetEID = NULL;
569 (void) sqlite3_finalize(pStmt);
570 continue;
571 } else if (ret != SQLITE_ROW) {
572 (void) sqlite3_finalize(pStmt);
573 break;
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);
583 stmtGetEID = NULL;
585 continue;
586 } else if (ret != SQLITE_OK) {
587 (void) sqlite3_finalize(pStmt);
588 break;
592 * Normal condition is only one time through loop. Loop is
593 * rerun in error conditions, via "continue", above.
595 bLoop = FALSE;
598 /* All done with variable argument list */
599 va_end(args);
602 /* Free the memory we allocated for our query string */
603 sqlite3_free(p);
605 return ret;
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;
625 struct ldb_val valX;
626 struct ldb_val valY;
627 int ret;
629 switch (func[0]) {
630 /* greater */
631 case '>': /* >= */
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);
638 if (ret >= 0)
639 sqlite3_result_int(ctx, 1);
640 else
641 sqlite3_result_int(ctx, 0);
642 return;
644 /* lesser */
645 case '<': /* <= */
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);
652 if (ret <= 0)
653 sqlite3_result_int(ctx, 1);
654 else
655 sqlite3_result_int(ctx, 0);
656 return;
658 /* approx */
659 case '~':
660 /* TODO */
661 sqlite3_result_int(ctx, 0);
662 return;
664 /* bitops */
665 case ':':
666 /* TODO */
667 sqlite3_result_int(ctx, 0);
668 return;
670 default:
671 break;
674 sqlite3_result_error(ctx, "Value must start with a special operation char (<>~:)!", -1);
675 return;
679 /* rename a record */
680 static int lsqlite3_safe_rollback(sqlite3 *sqlite)
682 char *errmsg;
683 int ret;
685 /* execute */
686 ret = sqlite3_exec(sqlite, "ROLLBACK;", NULL, NULL, &errmsg);
687 if (ret != SQLITE_OK) {
688 if (errmsg) {
689 printf("lsqlite3_safe_rollback: Error: %s\n", errmsg);
690 free(errmsg);
692 return -1;
695 return 0;
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]);
707 return SQLITE_OK;
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;
718 long long eid;
719 int i;
721 /* eid, dn, attr_name, attr_value */
722 if (col_num != 4)
723 return SQLITE_ABORT;
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)
734 return SQLITE_ABORT;
736 handle->status = ac->callback(ac->module->ldb, ac->context, ac->ares);
737 if (handle->status != LDB_SUCCESS)
738 return SQLITE_ABORT;
741 /* start over */
742 ac->ares = talloc_zero(ac, struct ldb_reply);
743 if (!ac->ares)
744 return SQLITE_ABORT;
746 ac->ares->message = ldb_msg_new(ac->ares);
747 if (!ac->ares->message)
748 return SQLITE_ABORT;
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]);
758 if (msg->dn == NULL)
759 return SQLITE_ABORT;
762 if (ac->attrs) {
763 int found = 0;
764 for (i = 0; ac->attrs[i]; i++) {
765 if (strcasecmp(cols[2], ac->attrs[i]) == 0) {
766 found = 1;
767 break;
770 if (!found) return SQLITE_OK;
773 if (ldb_msg_add_string(msg, cols[2], cols[3]) != 0) {
774 return SQLITE_ABORT;
777 return SQLITE_OK;
782 * lsqlite3_get_eid()
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)
791 char *errmsg;
792 char *query;
793 long long eid = -1;
794 long long ret;
796 /* get object eid */
797 query = lsqlite3_tprintf(mem_ctx, "SELECT eid "
798 "FROM ldb_entry "
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) {
804 if (errmsg) {
805 printf("lsqlite3_get_eid: Fatal Error: %s\n", errmsg);
806 free(errmsg);
808 return -1;
811 return eid;
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;
818 long long eid = -1;
819 char *cdn;
821 /* ignore ltdb specials */
822 if (ldb_dn_is_special(dn)) {
823 return -1;
826 /* create a local ctx */
827 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_get_eid local context");
828 if (local_ctx == NULL) {
829 return -1;
832 cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, local_ctx, dn));
833 if (!cdn) goto done;
835 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, local_ctx, cdn);
837 done:
838 talloc_free(local_ctx);
839 return eid;
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;
851 char *norm_basedn;
852 char *sqlfilter;
853 char *errmsg;
854 char *query = NULL;
855 int ret;
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;
872 goto failed;
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"
885 " entry.dn,\n"
886 " av.attr_name,\n"
887 " av.attr_value\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"
895 " FROM ldb_entry\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"
899 " (%s)\n"
900 " )\n"
902 " ORDER BY entry.eid ASC;",
903 norm_basedn,
904 norm_basedn,
905 sqlfilter);
906 } else {
907 query = lsqlite3_tprintf(lsql_ac,
908 "SELECT entry.eid,\n"
909 " entry.dn,\n"
910 " av.attr_name,\n"
911 " av.attr_value\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"
919 " FROM ldb_entry\n"
920 " WHERE ldb_entry.eid IN\n"
921 " (%s)\n"
922 " )\n"
924 " ORDER BY entry.eid ASC;",
925 sqlfilter);
928 break;
930 case LDB_SCOPE_BASE:
931 query = lsqlite3_tprintf(lsql_ac,
932 "SELECT entry.eid,\n"
933 " entry.dn,\n"
934 " av.attr_name,\n"
935 " av.attr_value\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"
943 " FROM ldb_entry\n"
944 " WHERE ldb_entry.norm_dn = '%q'\n"
945 " AND ldb_entry.eid IN\n"
946 " (%s)\n"
947 " )\n"
949 " ORDER BY entry.eid ASC;",
950 norm_basedn,
951 sqlfilter);
952 break;
954 case LDB_SCOPE_ONELEVEL:
955 query = lsqlite3_tprintf(lsql_ac,
956 "SELECT entry.eid,\n"
957 " entry.dn,\n"
958 " av.attr_name,\n"
959 " av.attr_value\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"
967 " FROM ldb_entry\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"
971 " )\n"
973 " ORDER BY entry.eid ASC;",
974 norm_basedn,
975 norm_basedn,
976 sqlfilter);
977 break;
980 if (query == NULL) {
981 goto failed;
984 /* * /
985 printf ("%s\n", query);
986 / * */
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) {
996 if (errmsg) {
997 ldb_set_errstring(module->ldb, errmsg);
998 free(errmsg);
1000 goto failed;
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)
1007 goto failed;
1009 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, lsql_ac->ares);
1010 if (req->handle->status != LDB_SUCCESS)
1011 goto failed;
1014 req->handle->state = LDB_ASYNC_DONE;
1016 return LDB_SUCCESS;
1018 failed:
1019 return LDB_ERR_OPERATIONS_ERROR;
1022 /* add a record */
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;
1028 long long eid;
1029 char *dn, *ndn;
1030 char *errmsg;
1031 char *query;
1032 int i;
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)) {
1045 struct ldb_dn *c;
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;
1051 goto done;
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;
1059 goto done;
1062 /* Others return an error */
1063 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1064 goto done;
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;
1072 goto done;
1075 query = lsqlite3_tprintf(lsql_ac,
1076 /* Add new entry */
1077 "INSERT OR ABORT INTO ldb_entry "
1078 "('dn', 'norm_dn') "
1079 "VALUES ('%q', '%q');",
1080 dn, ndn);
1081 if (query == NULL) {
1082 ret = LDB_ERR_OTHER;
1083 goto done;
1086 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1087 if (ret != SQLITE_OK) {
1088 if (errmsg) {
1089 ldb_set_errstring(module->ldb, errmsg);
1090 free(errmsg);
1092 ret = LDB_ERR_OTHER;
1093 goto done;
1096 eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, lsql_ac, ndn);
1097 if (eid == -1) {
1098 ret = LDB_ERR_OTHER;
1099 goto done;
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;
1105 char *attr;
1106 int j;
1108 /* Get a case-folded copy of the attribute name */
1109 attr = ldb_attr_casefold(lsql_ac, el->name);
1110 if (attr == NULL) {
1111 ret = LDB_ERR_OTHER;
1112 goto done;
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;
1120 char *insert;
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;
1126 goto done;
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;
1138 goto done;
1141 ret = sqlite3_exec(lsqlite3->sqlite, insert, NULL, NULL, &errmsg);
1142 if (ret != SQLITE_OK) {
1143 if (errmsg) {
1144 ldb_set_errstring(module->ldb, errmsg);
1145 free(errmsg);
1147 ret = LDB_ERR_OTHER;
1148 goto done;
1153 if (lsql_ac->callback) {
1154 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1157 done:
1158 req->handle->state = LDB_ASYNC_DONE;
1159 return ret;
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;
1168 long long eid;
1169 char *errmsg;
1170 int i;
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)) {
1183 struct ldb_dn *c;
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;
1189 goto done;
1192 /* Others return an error */
1193 ret = LDB_ERR_UNWILLING_TO_PERFORM;
1194 goto done;
1197 eid = lsqlite3_get_eid(module, msg->dn);
1198 if (eid == -1) {
1199 ret = LDB_ERR_OTHER;
1200 goto done;
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;
1207 char *attr;
1208 char *mod;
1209 int j;
1211 /* Get a case-folded copy of the attribute name */
1212 attr = ldb_attr_casefold(lsql_ac, el->name);
1213 if (attr == NULL) {
1214 ret = LDB_ERR_OTHER;
1215 goto done;
1218 h = ldb_attrib_handler(module->ldb, el->name);
1220 switch (flags) {
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';",
1229 eid, attr);
1230 if (mod == NULL) {
1231 ret = LDB_ERR_OTHER;
1232 goto done;
1235 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1236 if (ret != SQLITE_OK) {
1237 if (errmsg) {
1238 ldb_set_errstring(module->ldb, errmsg);
1239 free(errmsg);
1241 ret = LDB_ERR_OTHER;
1242 goto done;
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;
1257 goto done;
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);
1268 if (mod == NULL) {
1269 ret = LDB_ERR_OTHER;
1270 goto done;
1273 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1274 if (ret != SQLITE_OK) {
1275 if (errmsg) {
1276 ldb_set_errstring(module->ldb, errmsg);
1277 free(errmsg);
1279 ret = LDB_ERR_OTHER;
1280 goto done;
1284 break;
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';",
1293 eid, attr);
1294 if (mod == NULL) {
1295 ret = LDB_ERR_OTHER;
1296 goto done;
1299 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1300 if (ret != SQLITE_OK) {
1301 if (errmsg) {
1302 ldb_set_errstring(module->ldb, errmsg);
1303 free(errmsg);
1305 ret = LDB_ERR_OTHER;
1306 goto done;
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;
1318 goto done;
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);
1328 if (mod == NULL) {
1329 ret = LDB_ERR_OTHER;
1330 goto done;
1333 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1334 if (ret != SQLITE_OK) {
1335 if (errmsg) {
1336 ldb_set_errstring(module->ldb, errmsg);
1337 free(errmsg);
1339 ret = LDB_ERR_OTHER;
1340 goto done;
1344 break;
1348 if (lsql_ac->callback) {
1349 req->handle->status = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1352 done:
1353 req->handle->state = LDB_ASYNC_DONE;
1354 return ret;
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;
1362 long long eid;
1363 char *errmsg;
1364 char *query;
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);
1377 if (eid == -1) {
1378 goto done;
1381 query = lsqlite3_tprintf(lsql_ac,
1382 /* Delete entry */
1383 "DELETE FROM ldb_entry WHERE eid = %lld; "
1384 /* Delete attributes */
1385 "DELETE FROM ldb_attribute_values WHERE eid = %lld; ",
1386 eid, eid);
1387 if (query == NULL) {
1388 ret = LDB_ERR_OTHER;
1389 goto done;
1392 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1393 if (ret != SQLITE_OK) {
1394 if (errmsg) {
1395 ldb_set_errstring(module->ldb, errmsg);
1396 free(errmsg);
1398 req->handle->status = LDB_ERR_OPERATIONS_ERROR;
1399 goto done;
1402 if (lsql_ac->callback) {
1403 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1406 done:
1407 req->handle->state = LDB_ASYNC_DONE;
1408 return ret;
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;
1417 char *errmsg;
1418 char *query;
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) {
1434 goto done;
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) {
1443 goto done;
1446 /* execute */
1447 ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1448 if (ret != SQLITE_OK) {
1449 if (errmsg) {
1450 ldb_set_errstring(module->ldb, errmsg);
1451 free(errmsg);
1453 ret = LDB_ERR_OPERATIONS_ERROR;
1454 goto done;
1457 if (lsql_ac->callback) {
1458 ret = lsql_ac->callback(module->ldb, lsql_ac->context, NULL);
1461 done:
1462 req->handle->state = LDB_ASYNC_DONE;
1463 return ret;
1466 static int lsql_start_trans(struct ldb_module * module)
1468 int ret;
1469 char *errmsg;
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) {
1475 if (errmsg) {
1476 printf("lsqlite3_start_trans: error: %s\n", errmsg);
1477 free(errmsg);
1479 return -1;
1483 lsqlite3->trans_count++;
1485 return 0;
1488 static int lsql_end_trans(struct ldb_module *module)
1490 int ret;
1491 char *errmsg;
1492 struct lsqlite3_private *lsqlite3 = module->private_data;
1494 if (lsqlite3->trans_count > 0) {
1495 lsqlite3->trans_count--;
1496 } else return -1;
1498 if (lsqlite3->trans_count == 0) {
1499 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1500 if (ret != SQLITE_OK) {
1501 if (errmsg) {
1502 printf("lsqlite3_end_trans: error: %s\n", errmsg);
1503 free(errmsg);
1505 return -1;
1509 return 0;
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--;
1518 } else return -1;
1520 if (lsqlite3->trans_count == 0) {
1521 return lsqlite3_safe_rollback(lsqlite3->sqlite);
1524 return -1;
1527 static int destructor(struct lsqlite3_private *lsqlite3)
1529 if (lsqlite3->sqlite) {
1530 sqlite3_close(lsqlite3->sqlite);
1532 return 0;
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 = {
1549 .name = "sqlite",
1550 .search = lsql_search,
1551 .add = lsql_add,
1552 .modify = lsql_modify,
1553 .del = lsql_delete,
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,
1559 .wait = lsql_wait,
1563 * Static functions
1566 static int initialize(struct lsqlite3_private *lsqlite3,
1567 struct ldb_context *ldb, const char *url, int flags)
1569 TALLOC_CTX *local_ctx;
1570 long long queryInt;
1571 int rollback = 0;
1572 char *errmsg;
1573 char *schema;
1574 int ret;
1576 /* create a local ctx */
1577 local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_rename local context");
1578 if (local_ctx == NULL) {
1579 return -1;
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"
1601 ");"
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"
1610 ");"
1613 * We keep a full listing of attribute/value pairs here
1615 "CREATE TABLE ldb_attribute_values"
1617 " eid INTEGER REFERENCES ldb_entry,"
1618 " attr_name TEXT,"
1619 " norm_attr_name TEXT,"
1620 " attr_value TEXT,"
1621 " norm_attr_value TEXT "
1622 ");"
1626 * Indexes
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);"
1637 * Triggers
1640 "CREATE TRIGGER ldb_object_classes_insert_tr"
1641 " AFTER INSERT"
1642 " ON ldb_object_classes"
1643 " FOR EACH ROW"
1644 " BEGIN"
1645 " UPDATE ldb_object_classes"
1646 " SET tree_key = COALESCE(tree_key, "
1647 " ("
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 "
1655 " ));"
1656 " UPDATE ldb_object_classes "
1657 " SET max_child_num = max_child_num + 1"
1658 " WHERE class_name = new.parent_class_name;"
1659 " END;"
1662 * Table initialization
1665 "INSERT INTO ldb_object_classes "
1666 " (class_name, tree_key) "
1667 " VALUES "
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 */
1676 url += 10;
1678 /* Try to open the (possibly empty/non-existent) database */
1679 if ((ret = sqlite3_open(url, &lsqlite3->sqlite)) != SQLITE_OK) {
1680 return ret;
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) {
1686 if (errmsg) {
1687 printf("lsqlite3 initializaion error: %s\n", errmsg);
1688 free(errmsg);
1690 goto failed;
1693 if (flags & LDB_FLG_NOSYNC) {
1694 /* DANGEROUS */
1695 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA synchronous = OFF;", NULL, NULL, &errmsg);
1696 if (ret != SQLITE_OK) {
1697 if (errmsg) {
1698 printf("lsqlite3 initializaion error: %s\n", errmsg);
1699 free(errmsg);
1701 goto failed;
1705 /* */
1707 /* Establish a busy timeout of 30 seconds */
1708 if ((ret = sqlite3_busy_timeout(lsqlite3->sqlite,
1709 30000)) != SQLITE_OK) {
1710 return ret;
1713 /* Create a function, callable from sql, to increment a tree_key */
1714 if ((ret =
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 */
1723 )) != SQLITE_OK) {
1724 return ret;
1727 /* Create a function, callable from sql, to convert int to base160 */
1728 if ((ret =
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 */
1737 )) != SQLITE_OK) {
1738 return ret;
1741 /* Create a function, callable from sql, to perform various comparisons */
1742 if ((ret =
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 */
1751 )) != SQLITE_OK) {
1752 return ret;
1755 /* Begin a transaction */
1756 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN EXCLUSIVE;", NULL, NULL, &errmsg);
1757 if (ret != SQLITE_OK) {
1758 if (errmsg) {
1759 printf("lsqlite3: initialization error: %s\n", errmsg);
1760 free(errmsg);
1762 goto failed;
1764 rollback = 1;
1766 /* Determine if this is a new database. No tables means it is. */
1767 if (query_int(lsqlite3,
1768 &queryInt,
1769 "SELECT COUNT(*)\n"
1770 " FROM sqlite_master\n"
1771 " WHERE type = 'table';") != 0) {
1772 goto failed;
1775 if (queryInt == 0) {
1777 * Create the database schema
1779 ret = sqlite3_exec(lsqlite3->sqlite, schema, NULL, NULL, &errmsg);
1780 if (ret != SQLITE_OK) {
1781 if (errmsg) {
1782 printf("lsqlite3 initializaion error: %s\n", errmsg);
1783 free(errmsg);
1785 goto failed;
1787 } else {
1789 * Ensure that the database we opened is one of ours
1791 if (query_int(lsqlite3,
1792 &queryInt,
1793 "SELECT "
1794 " (SELECT COUNT(*) = 2"
1795 " FROM sqlite_master "
1796 " WHERE type = 'table' "
1797 " AND name IN "
1798 " ("
1799 " 'ldb_entry', "
1800 " 'ldb_object_classes' "
1801 " ) "
1802 " ) "
1803 " AND "
1804 " (SELECT 1 "
1805 " FROM ldb_info "
1806 " WHERE database_type = 'LDB' "
1807 " AND version = '1.0'"
1808 " );") != 0 ||
1809 queryInt != 1) {
1811 /* It's not one that we created. See ya! */
1812 goto failed;
1816 /* Commit the transaction */
1817 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1818 if (ret != SQLITE_OK) {
1819 if (errmsg) {
1820 printf("lsqlite3: iniialization error: %s\n", errmsg);
1821 free(errmsg);
1823 goto failed;
1826 return SQLITE_OK;
1828 failed:
1829 if (rollback) lsqlite3_safe_rollback(lsqlite3->sqlite);
1830 sqlite3_close(lsqlite3->sqlite);
1831 return -1;
1835 * connect to the database
1837 static int lsqlite3_connect(struct ldb_context *ldb,
1838 const char *url,
1839 unsigned int flags,
1840 const char *options[],
1841 struct ldb_module **module)
1843 int i;
1844 int ret;
1845 struct lsqlite3_private * lsqlite3 = NULL;
1847 lsqlite3 = talloc(ldb, struct lsqlite3_private);
1848 if (!lsqlite3) {
1849 goto failed;
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) {
1858 goto failed;
1861 talloc_set_destructor(lsqlite3, destructor);
1865 *module = talloc(ldb, struct ldb_module);
1866 if (!module) {
1867 ldb_oom(ldb);
1868 goto failed;
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;
1876 if (options) {
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) {
1885 goto failed;
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]) {
1894 goto failed;
1899 return 0;
1901 failed:
1902 if (lsqlite3->sqlite != NULL) {
1903 (void) sqlite3_close(lsqlite3->sqlite);
1905 talloc_free(lsqlite3);
1906 return -1;
1909 int ldb_sqlite3_init(void)
1911 return ldb_register_backend("sqlite3", lsqlite3_connect);