source/lib/ldb/ldb_sqlite3/ldb_sqlite3.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Derrell Lipman  2005
   5    Copyright (C) Simo Sorce 2005
   6
   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
  10
  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.
  15
  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.
  20
  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
  24 */
  25
  26 /*
  27  *  Name: ldb
  28  *
  29  *  Component: ldb sqlite3 backend
  30  *
  31  *  Description: core files for SQLITE3 backend
  32  *
  33  *  Author: Derrell Lipman (based on Andrew Tridgell's LDAP backend)
  34  */
  35
  36 #include <stdarg.h>
  37 #include "includes.h"
  38 #include "ldb/include/ldb.h"
  39 #include "ldb/include/ldb_errors.h"
  40 #include "ldb/include/ldb_private.h"
  41 #include "ldb/ldb_sqlite3/ldb_sqlite3.h"
  42
  43 /*
  44  * Macros used throughout
  45  */
  46
  47 #ifndef FALSE
  48 # define FALSE  (0)
  49 # define TRUE   (! FALSE)
  50 #endif
  51
  52 #define RESULT_ATTR_TABLE       "temp_result_attrs"
  53
  54 //#define TEMPTAB                 /* for testing, create non-temporary table */
  55 #define TEMPTAB                 "TEMPORARY"
  56
  57 /*
  58  * Static variables
  59  */
  60 sqlite3_stmt *  stmtGetEID = NULL;
  61
  62 static char *lsqlite3_tprintf(TALLOC_CTX *mem_ctx, const char *fmt, ...)
  63 {
  64         char *str, *ret;
  65         va_list ap;
  66
  67         va_start(ap, fmt);
  68         str = sqlite3_vmprintf(fmt, ap);
  69         va_end(ap);
  70
  71         if (str == NULL) return NULL;
  72
  73         ret = talloc_strdup(mem_ctx, str);
  74         if (ret == NULL) {
  75                 sqlite3_free(str);
  76                 return NULL;
  77         }
  78
  79         sqlite3_free(str);
  80         return ret;
  81 }
  82
  83 static unsigned char        base160tab[161] = {
  84         48 ,49 ,50 ,51 ,52 ,53 ,54 ,55 ,56 ,57 , /* 0-9 */
  85         58 ,59 ,65 ,66 ,67 ,68 ,69 ,70 ,71 ,72 , /* : ; A-H */
  86         73 ,74 ,75 ,76 ,77 ,78 ,79 ,80 ,81 ,82 , /* I-R */
  87         83 ,84 ,85 ,86 ,87 ,88 ,89 ,90 ,97 ,98 , /* S-Z , a-b */
  88         99 ,100,101,102,103,104,105,106,107,108, /* c-l */
  89         109,110,111,112,113,114,115,116,117,118, /* m-v */
  90         119,120,121,122,160,161,162,163,164,165, /* w-z, latin1 */
  91         166,167,168,169,170,171,172,173,174,175, /* latin1 */
  92         176,177,178,179,180,181,182,183,184,185, /* latin1 */
  93         186,187,188,189,190,191,192,193,194,195, /* latin1 */
  94         196,197,198,199,200,201,202,203,204,205, /* latin1 */
  95         206,207,208,209,210,211,212,213,214,215, /* latin1 */
  96         216,217,218,219,220,221,222,223,224,225, /* latin1 */
  97         226,227,228,229,230,231,232,233,234,235, /* latin1 */
  98         236,237,238,239,240,241,242,243,244,245, /* latin1 */
  99         246,247,248,249,250,251,252,253,254,255, /* latin1 */
 100         '\0'
 101 };
 102
 103
 104 /*
 105  * base160()
 106  *
 107  * Convert an unsigned long integer into a base160 representation of the
 108  * number.
 109  *
 110  * Parameters:
 111  *   val --
 112  *     value to be converted
 113  *
 114  *   result --
 115  *     character array, 5 bytes long, into which the base160 representation
 116  *     will be placed.  The result will be a four-digit representation of the
 117  *     number (with leading zeros prepended as necessary), and null
 118  *     terminated.
 119  *
 120  * Returns:
 121  *   Nothing
 122  */
 123 static void
 124 base160_sql(sqlite3_context * hContext,
 125             int argc,
 126             sqlite3_value ** argv)
 127 {
 128     int             i;
 129     long long       val;
 130     char            result[5];
 131
 132     val = sqlite3_value_int64(argv[0]);
 133
 134     for (i = 3; i >= 0; i--) {
 135
 136         result[i] = base160tab[val % 160];
 137         val /= 160;
 138     }
 139
 140     result[4] = '\0';
 141
 142     sqlite3_result_text(hContext, result, -1, SQLITE_TRANSIENT);
 143 }
 144
 145
 146 /*
 147  * base160next_sql()
 148  *
 149  * This function enhances sqlite by adding a "base160_next()" function which is
 150  * accessible via queries.
 151  *
 152  * Retrieve the next-greater number in the base160 sequence for the terminal
 153  * tree node (the last four digits).  Only one tree level (four digits) is
 154  * operated on.
 155  *
 156  * Input:
 157  *   A character string: either an empty string (in which case no operation is
 158  *   performed), or a string of base160 digits with a length of a multiple of
 159  *   four digits.
 160  *
 161  * Output:
 162  *   Upon return, the trailing four digits (one tree level) will have been
 163  *   incremented by 1.
 164  */
 165 static void
 166 base160next_sql(sqlite3_context * hContext,
 167                 int argc,
 168                 sqlite3_value ** argv)
 169 {
 170         int                         i;
 171         int                         len;
 172         unsigned char *             pTab;
 173         unsigned char *             pBase160 =
 174                 strdup(sqlite3_value_text(argv[0]));
 175         unsigned char *             pStart = pBase160;
 176
 177         /*
 178          * We need a minimum of four digits, and we will always get a multiple
 179          * of four digits.
 180          */
 181         if (pBase160 != NULL &&
 182             (len = strlen(pBase160)) >= 4 &&
 183             len % 4 == 0) {
 184
 185                 if (pBase160 == NULL) {
 186
 187                         sqlite3_result_null(hContext);
 188                         return;
 189                 }
 190
 191                 pBase160 += strlen(pBase160) - 1;
 192
 193                 /* We only carry through four digits: one level in the tree */
 194                 for (i = 0; i < 4; i++) {
 195
 196                         /* What base160 value does this digit have? */
 197                         pTab = strchr(base160tab, *pBase160);
 198
 199                         /* Is there a carry? */
 200                         if (pTab < base160tab + sizeof(base160tab) - 1) {
 201
 202                                 /*
 203                                  * Nope.  Just increment this value and we're
 204                                  * done.
 205                                  */
 206                                 *pBase160 = *++pTab;
 207                                 break;
 208                         } else {
 209
 210                                 /*
 211                                  * There's a carry.  This value gets
 212                                  * base160tab[0], we decrement the buffer
 213                                  * pointer to get the next higher-order digit,
 214                                  * and continue in the loop.
 215                                  */
 216                                 *pBase160-- = base160tab[0];
 217                         }
 218                 }
 219
 220                 sqlite3_result_text(hContext,
 221                                     pStart,
 222                                     strlen(pStart),
 223                                     free);
 224         } else {
 225                 sqlite3_result_value(hContext, argv[0]);
 226                 if (pBase160 != NULL) {
 227                         free(pBase160);
 228                 }
 229         }
 230 }
 231
 232 static char *parsetree_to_sql(struct ldb_module *module,
 233                               void *mem_ctx,
 234                               const struct ldb_parse_tree *t)
 235 {
 236         const struct ldb_attrib_handler *h;
 237         struct ldb_val value, subval;
 238         char *wild_card_string;
 239         char *child, *tmp;
 240         char *ret = NULL;
 241         char *attr;
 242         int i;
 243
 244
 245         switch(t->operation) {
 246         case LDB_OP_AND:
 247
 248                 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
 249                 if (tmp == NULL) return NULL;
 250
 251                 for (i = 1; i < t->u.list.num_elements; i++) {
 252
 253                         child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
 254                         if (child == NULL) return NULL;
 255
 256                         tmp = talloc_asprintf_append(tmp, " INTERSECT %s ", child);
 257                         if (tmp == NULL) return NULL;
 258                 }
 259
 260                 ret = talloc_asprintf(mem_ctx, "SELECT * FROM ( %s )\n", tmp);
 261
 262                 return ret;
 263
 264         case LDB_OP_OR:
 265
 266                 tmp = parsetree_to_sql(module, mem_ctx, t->u.list.elements[0]);
 267                 if (tmp == NULL) return NULL;
 268
 269                 for (i = 1; i < t->u.list.num_elements; i++) {
 270
 271                         child = parsetree_to_sql(module, mem_ctx, t->u.list.elements[i]);
 272                         if (child == NULL) return NULL;
 273
 274                         tmp = talloc_asprintf_append(tmp, " UNION %s ", child);
 275                         if (tmp == NULL) return NULL;
 276                 }
 277
 278                 return talloc_asprintf(mem_ctx, "SELECT * FROM ( %s ) ", tmp);
 279
 280         case LDB_OP_NOT:
 281
 282                 child = parsetree_to_sql(module, mem_ctx, t->u.isnot.child);
 283                 if (child == NULL) return NULL;
 284
 285                 return talloc_asprintf(mem_ctx,
 286                                         "SELECT eid FROM ldb_entry "
 287                                         "WHERE eid NOT IN ( %s ) ", child);
 288
 289         case LDB_OP_EQUALITY:
 290                 /*
 291                  * For simple searches, we want to retrieve the list of EIDs that
 292                  * match the criteria.
 293                 */
 294                 attr = ldb_casefold(mem_ctx, t->u.equality.attr);
 295                 if (attr == NULL) return NULL;
 296                 h = ldb_attrib_handler(module->ldb, attr);
 297
 298                 /* Get a canonicalised copy of the data */
 299                 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
 300                 if (value.data == NULL) {
 301                         return NULL;
 302                 }
 303
 304                 if (strcasecmp(t->u.equality.attr, "objectclass") == 0) {
 305                 /*
 306                  * For object classes, we want to search for all objectclasses
 307                  * that are subclasses as well.
 308                 */
 309                         return lsqlite3_tprintf(mem_ctx,
 310                                         "SELECT eid  FROM ldb_attribute_values\n"
 311                                         "WHERE norm_attr_name = 'OBJECTCLASS' "
 312                                         "AND norm_attr_value IN\n"
 313                                         "  (SELECT class_name FROM ldb_object_classes\n"
 314                                         "   WHERE tree_key GLOB\n"
 315                                         "     (SELECT tree_key FROM ldb_object_classes\n"
 316                                         "      WHERE class_name = '%q'\n"
 317                                         "     ) || '*'\n"
 318                                         "  )\n", value.data);
 319
 320                 } else if (strcasecmp(t->u.equality.attr, "dn") == 0) {
 321                         /* DN query is a special ldb case */
 322                         char *cdn = ldb_dn_linearize_casefold(module->ldb,
 323                                                               ldb_dn_explode(module->ldb,
 324                                                               value.data));
 325
 326                         return lsqlite3_tprintf(mem_ctx,
 327                                                 "SELECT eid FROM ldb_entry "
 328                                                 "WHERE norm_dn = '%q'", cdn);
 329
 330                 } else {
 331                         /* A normal query. */
 332                         return lsqlite3_tprintf(mem_ctx,
 333                                                 "SELECT eid FROM ldb_attribute_values "
 334                                                 "WHERE norm_attr_name = '%q' "
 335                                                 "AND norm_attr_value = '%q'",
 336                                                 attr,
 337                                                 value.data);
 338
 339                 }
 340
 341         case LDB_OP_SUBSTRING:
 342
 343                 wild_card_string = talloc_strdup(mem_ctx,
 344                                         (t->u.substring.start_with_wildcard)?"*":"");
 345                 if (wild_card_string == NULL) return NULL;
 346
 347                 for (i = 0; t->u.substring.chunks[i]; i++) {
 348                         wild_card_string = talloc_asprintf_append(wild_card_string, "%s*",
 349                                                         t->u.substring.chunks[i]->data);
 350                         if (wild_card_string == NULL) return NULL;
 351                 }
 352
 353                 if ( ! t->u.substring.end_with_wildcard ) {
 354                         /* remove last wildcard */
 355                         wild_card_string[strlen(wild_card_string) - 1] = '\0';
 356                 }
 357
 358                 attr = ldb_casefold(mem_ctx, t->u.substring.attr);
 359                 if (attr == NULL) return NULL;
 360                 h = ldb_attrib_handler(module->ldb, attr);
 361
 362                 subval.data = wild_card_string;
 363                 subval.length = strlen(wild_card_string) + 1;
 364
 365                 /* Get a canonicalised copy of the data */
 366                 h->canonicalise_fn(module->ldb, mem_ctx, &(subval), &value);
 367                 if (value.data == NULL) {
 368                         return NULL;
 369                 }
 370
 371                 return lsqlite3_tprintf(mem_ctx,
 372                                         "SELECT eid FROM ldb_attribute_values "
 373                                         "WHERE norm_attr_name = '%q' "
 374                                         "AND norm_attr_value GLOB '%q'",
 375                                         attr,
 376                                         value.data);
 377
 378         case LDB_OP_GREATER:
 379                 attr = ldb_casefold(mem_ctx, t->u.equality.attr);
 380                 if (attr == NULL) return NULL;
 381                 h = ldb_attrib_handler(module->ldb, attr);
 382
 383                 /* Get a canonicalised copy of the data */
 384                 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
 385                 if (value.data == NULL) {
 386                         return NULL;
 387                 }
 388
 389                 return lsqlite3_tprintf(mem_ctx,
 390                                         "SELECT eid FROM ldb_attribute_values "
 391                                         "WHERE norm_attr_name = '%q' "
 392                                         "AND ldap_compare(norm_attr_value, '>=', '%q', '%q') ",
 393                                         attr,
 394                                         value.data,
 395                                         attr);
 396
 397         case LDB_OP_LESS:
 398                 attr = ldb_casefold(mem_ctx, t->u.equality.attr);
 399                 if (attr == NULL) return NULL;
 400                 h = ldb_attrib_handler(module->ldb, attr);
 401
 402                 /* Get a canonicalised copy of the data */
 403                 h->canonicalise_fn(module->ldb, mem_ctx, &(t->u.equality.value), &value);
 404                 if (value.data == NULL) {
 405                         return NULL;
 406                 }
 407
 408                 return lsqlite3_tprintf(mem_ctx,
 409                                         "SELECT eid FROM ldb_attribute_values "
 410                                         "WHERE norm_attr_name = '%q' "
 411                                         "AND ldap_compare(norm_attr_value, '<=', '%q', '%q') ",
 412                                         attr,
 413                                         value.data,
 414                                         attr);
 415
 416         case LDB_OP_PRESENT:
 417                 if (strcasecmp(t->u.present.attr, "dn") == 0) {
 418                         return talloc_strdup(mem_ctx, "SELECT eid FROM ldb_entry");
 419                 }
 420
 421                 attr = ldb_casefold(mem_ctx, t->u.present.attr);
 422                 if (attr == NULL) return NULL;
 423
 424                 return lsqlite3_tprintf(mem_ctx,
 425                                         "SELECT eid FROM ldb_attribute_values "
 426                                         "WHERE norm_attr_name = '%q' ",
 427                                         attr);
 428
 429         case LDB_OP_APPROX:
 430                 attr = ldb_casefold(mem_ctx, t->u.equality.attr);
 431                 if (attr == NULL) return NULL;
 432                 h = ldb_attrib_handler(module->ldb, attr);
 433
 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) {
 437                         return NULL;
 438                 }
 439
 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') ",
 444                                         attr,
 445                                         value.data,
 446                                         attr);
 447
 448         case LDB_OP_EXTENDED:
 449 #warning  "work out how to handle bitops"
 450                 return NULL;
 451
 452         default:
 453                 break;
 454         };
 455
 456         /* should never occur */
 457         abort();
 458         return NULL;
 459 }
 460
 461 /*
 462  * query_int()
 463  *
 464  * This function is used for the common case of queries that return a single
 465  * integer value.
 466  *
 467  * NOTE: If more than one value is returned by the query, all but the first
 468  * one will be ignored.
 469  */
 470 static int
 471 query_int(const struct lsqlite3_private * lsqlite3,
 472           long long * pRet,
 473           const char * pSql,
 474           ...)
 475 {
 476         int             ret;
 477         int             bLoop;
 478         char *          p;
 479         sqlite3_stmt *  pStmt;
 480         va_list         args;
 481
 482         /* Begin access to variable argument list */
 483         va_start(args, pSql);
 484
 485         /* Format the query */
 486         if ((p = sqlite3_vmprintf(pSql, args)) == NULL) {
 487                 return SQLITE_NOMEM;
 488         }
 489
 490         /*
 491          * Prepare and execute the SQL statement.  Loop allows retrying on
 492          * certain errors, e.g. SQLITE_SCHEMA occurs if the schema changes,
 493          * requiring retrying the operation.
 494          */
 495         for (bLoop = TRUE; bLoop; ) {
 496
 497                 /* Compile the SQL statement into sqlite virtual machine */
 498                 if ((ret = sqlite3_prepare(lsqlite3->sqlite,
 499                                            p,
 500                                            -1,
 501                                            &pStmt,
 502                                            NULL)) == SQLITE_SCHEMA) {
 503                         if (stmtGetEID != NULL) {
 504                                 sqlite3_finalize(stmtGetEID);
 505                                 stmtGetEID = NULL;
 506                         }
 507                         continue;
 508                 } else if (ret != SQLITE_OK) {
 509                         break;
 510                 }
 511
 512                 /* One row expected */
 513                 if ((ret = sqlite3_step(pStmt)) == SQLITE_SCHEMA) {
 514                         if (stmtGetEID != NULL) {
 515                                 sqlite3_finalize(stmtGetEID);
 516                                 stmtGetEID = NULL;
 517                         }
 518                         (void) sqlite3_finalize(pStmt);
 519                         continue;
 520                 } else if (ret != SQLITE_ROW) {
 521                         (void) sqlite3_finalize(pStmt);
 522                         break;
 523                 }
 524
 525                 /* Get the value to be returned */
 526                 *pRet = sqlite3_column_int64(pStmt, 0);
 527
 528                 /* Free the virtual machine */
 529                 if ((ret = sqlite3_finalize(pStmt)) == SQLITE_SCHEMA) {
 530                         if (stmtGetEID != NULL) {
 531                                 sqlite3_finalize(stmtGetEID);
 532                                 stmtGetEID = NULL;
 533                         }
 534                         continue;
 535                 } else if (ret != SQLITE_OK) {
 536                         (void) sqlite3_finalize(pStmt);
 537                         break;
 538                 }
 539
 540                 /*
 541                  * Normal condition is only one time through loop.  Loop is
 542                  * rerun in error conditions, via "continue", above.
 543                  */
 544                 bLoop = FALSE;
 545         }
 546
 547         /* All done with variable argument list */
 548         va_end(args);
 549
 550
 551         /* Free the memory we allocated for our query string */
 552         sqlite3_free(p);
 553
 554         return ret;
 555 }
 556
 557 /*
 558  * This is a bad hack to support ldap style comparisons whithin sqlite.
 559  * val is the attribute in the row currently under test
 560  * func is the desired test "<=" ">=" "~" ":"
 561  * cmp is the value to compare against (eg: "test")
 562  * attr is the attribute name the value of which we want to test
 563  */
 564
 565 static void lsqlite3_compare(sqlite3_context *ctx, int argc,
 566                                         sqlite3_value **argv)
 567 {
 568         struct ldb_context *ldb = (struct ldb_context *)sqlite3_user_data(ctx);
 569         const unsigned char *val = sqlite3_value_text(argv[0]);
 570         const unsigned char *func = sqlite3_value_text(argv[1]);
 571         const unsigned char *cmp = sqlite3_value_text(argv[2]);
 572         const unsigned char *attr = sqlite3_value_text(argv[3]);
 573         const struct ldb_attrib_handler *h;
 574         struct ldb_val valX;
 575         struct ldb_val valY;
 576         int ret;
 577
 578         switch (func[0]) {
 579         /* greater */
 580         case '>': /* >= */
 581                 h = ldb_attrib_handler(ldb, attr);
 582                 valX.data = cmp;
 583                 valX.length = strlen(cmp);
 584                 valY.data = val;
 585                 valY.length = strlen(val);
 586                 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
 587                 if (ret >= 0)
 588                         sqlite3_result_int(ctx, 1);
 589                 else
 590                         sqlite3_result_int(ctx, 0);
 591                 return;
 592
 593         /* lesser */
 594         case '<': /* <= */
 595                 h = ldb_attrib_handler(ldb, attr);
 596                 valX.data = cmp;
 597                 valX.length = strlen(cmp);
 598                 valY.data = val;
 599                 valY.length = strlen(val);
 600                 ret = h->comparison_fn(ldb, ldb, &valY, &valX);
 601                 if (ret <= 0)
 602                         sqlite3_result_int(ctx, 1);
 603                 else
 604                         sqlite3_result_int(ctx, 0);
 605                 return;
 606
 607         /* approx */
 608         case '~':
 609                 /* TODO */
 610                 sqlite3_result_int(ctx, 0);
 611                 return;
 612
 613         /* bitops */
 614         case ':':
 615                 /* TODO */
 616                 sqlite3_result_int(ctx, 0);
 617                 return;
 618
 619         default:
 620                 break;
 621         }
 622
 623         sqlite3_result_error(ctx, "Value must start with a special operation char (<>~:)!", -1);
 624         return;
 625 }
 626
 627
 628 /* rename a record */
 629 static int lsqlite3_safe_rollback(sqlite3 *sqlite)
 630 {
 631         char *errmsg;
 632         int ret;
 633
 634         /* execute */
 635         ret = sqlite3_exec(sqlite, "ROLLBACK;", NULL, NULL, &errmsg);
 636         if (ret != SQLITE_OK) {
 637                 if (errmsg) {
 638                         printf("lsqlite3_safe_rollback: Error: %s\n", errmsg);
 639                         free(errmsg);
 640                 }
 641                 return -1;
 642         }
 643
 644         return 0;
 645 }
 646
 647 /* return an eid as result */
 648 static int lsqlite3_eid_callback(void *result, int col_num, char **cols, char **names)
 649 {
 650         long long *eid = (long long *)result;
 651
 652         if (col_num != 1) return SQLITE_ABORT;
 653         if (strcasecmp(names[0], "eid") != 0) return SQLITE_ABORT;
 654
 655         *eid = atoll(cols[0]);
 656         return SQLITE_OK;
 657 }
 658
 659 struct lsqlite3_msgs {
 660         int count;
 661         struct ldb_message **msgs;
 662         long long current_eid;
 663         const char * const * attrs;
 664         TALLOC_CTX *mem_ctx;
 665 };
 666
 667 /*
 668  * add a single set of ldap message values to a ldb_message
 669  */
 670
 671 static int lsqlite3_search_callback(void *result, int col_num, char **cols, char **names)
 672 {
 673         struct lsqlite3_msgs *msgs = (struct lsqlite3_msgs *)result;
 674         struct ldb_message *msg;
 675         long long eid;
 676         int i;
 677
 678         /* eid, dn, attr_name, attr_value */
 679         if (col_num != 4) return SQLITE_ABORT;
 680
 681         eid = atoll(cols[0]);
 682
 683         if (eid != msgs->current_eid) {
 684                 msgs->msgs = talloc_realloc(msgs->mem_ctx,
 685                                             msgs->msgs,
 686                                             struct ldb_message *,
 687                                             msgs->count + 2);
 688                 if (msgs->msgs == NULL) return SQLITE_ABORT;
 689
 690                 msgs->msgs[msgs->count] = talloc(msgs->msgs, struct ldb_message);
 691                 if (msgs->msgs[msgs->count] == NULL) return SQLITE_ABORT;
 692
 693                 msgs->msgs[msgs->count]->dn = NULL;
 694                 msgs->msgs[msgs->count]->num_elements = 0;
 695                 msgs->msgs[msgs->count]->elements = NULL;
 696                 msgs->msgs[msgs->count]->private_data = NULL;
 697
 698                 msgs->count++;
 699                 msgs->current_eid = eid;
 700         }
 701
 702         msg = msgs->msgs[msgs->count -1];
 703
 704         if (msg->dn == NULL) {
 705                 msg->dn = ldb_dn_explode(msg, cols[1]);
 706                 if (msg->dn == NULL) return SQLITE_ABORT;
 707         }
 708
 709         if (msgs->attrs) {
 710                 int found = 0;
 711                 for (i = 0; msgs->attrs[i]; i++) {
 712                         if (strcasecmp(cols[2], msgs->attrs[i]) == 0) {
 713                                 found = 1;
 714                                 break;
 715                         }
 716                 }
 717                 if (!found) return 0;
 718         }
 719
 720         msg->elements = talloc_realloc(msg,
 721                                        msg->elements,
 722                                        struct ldb_message_element,
 723                                        msg->num_elements + 1);
 724         if (msg->elements == NULL) return SQLITE_ABORT;
 725
 726         msg->elements[msg->num_elements].flags = 0;
 727         msg->elements[msg->num_elements].name = talloc_strdup(msg->elements, cols[2]);
 728         if (msg->elements[msg->num_elements].name == NULL) return SQLITE_ABORT;
 729
 730         msg->elements[msg->num_elements].num_values = 1;
 731         msg->elements[msg->num_elements].values = talloc_array(msg->elements,
 732                                                                 struct ldb_val, 1);
 733         if (msg->elements[msg->num_elements].values == NULL) return SQLITE_ABORT;
 734
 735         msg->elements[msg->num_elements].values[0].length = strlen(cols[3]);
 736         msg->elements[msg->num_elements].values[0].data = talloc_strdup(msg->elements, cols[3]);
 737         if (msg->elements[msg->num_elements].values[0].data == NULL) return SQLITE_ABORT;
 738
 739         msg->num_elements++;
 740
 741         return SQLITE_OK;
 742 }
 743
 744
 745 /*
 746  * lsqlite3_get_eid()
 747  * lsqlite3_get_eid_ndn()
 748  *
 749  * These functions are used for the very common case of retrieving an EID value
 750  * given a (normalized) DN.
 751  */
 752
 753 static long long lsqlite3_get_eid_ndn(sqlite3 *sqlite, void *mem_ctx, const char *norm_dn)
 754 {
 755         char *errmsg;
 756         char *query;
 757         long long eid = -1;
 758         long long ret;
 759
 760         /* get object eid */
 761         query = lsqlite3_tprintf(mem_ctx, "SELECT eid "
 762                                           "FROM ldb_entry "
 763                                           "WHERE norm_dn = '%q';", norm_dn);
 764         if (query == NULL) return -1;
 765
 766         ret = sqlite3_exec(sqlite, query, lsqlite3_eid_callback, &eid, &errmsg);
 767         if (ret != SQLITE_OK) {
 768                 if (errmsg) {
 769                         printf("lsqlite3_get_eid: Fatal Error: %s\n", errmsg);
 770                         free(errmsg);
 771                 }
 772                 return -1;
 773         }
 774
 775         return eid;
 776 }
 777
 778 static long long lsqlite3_get_eid(struct ldb_module *module, const struct ldb_dn *dn)
 779 {
 780         TALLOC_CTX *local_ctx;
 781         struct lsqlite3_private *lsqlite3 = module->private_data;
 782         long long eid = -1;
 783         char *cdn;
 784
 785         /* ignore ltdb specials */
 786         if (ldb_dn_is_special(dn)) {
 787                 return -1;
 788         }
 789
 790         /* create a local ctx */
 791         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_get_eid local context");
 792         if (local_ctx == NULL) {
 793                 return -1;
 794         }
 795
 796         cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, dn));
 797         if (!cdn) goto done;
 798
 799         eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, local_ctx, cdn);
 800
 801 done:
 802         talloc_free(local_ctx);
 803         return eid;
 804 }
 805
 806 /*
 807  * Interface functions referenced by lsqlite3_ops
 808  */
 809
 810 /* search for matching records, by tree */
 811 static int lsqlite3_search_bytree(struct ldb_module * module, const struct ldb_dn* basedn,
 812                                   enum ldb_scope scope, struct ldb_parse_tree * tree,
 813                                   const char * const * attrs, struct ldb_result ** res)
 814 {
 815         TALLOC_CTX *local_ctx;
 816         struct lsqlite3_private *lsqlite3 = module->private_data;
 817         struct lsqlite3_msgs msgs;
 818         char *norm_basedn;
 819         char *sqlfilter;
 820         char *errmsg;
 821         char *query;
 822         int ret, i;
 823
 824         /* create a local ctx */
 825         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_search_bytree local context");
 826         if (local_ctx == NULL) {
 827                 return -1;
 828         }
 829
 830         if (basedn) {
 831                 norm_basedn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, basedn));
 832                 if (norm_basedn == NULL) {
 833                         ret = LDB_ERR_INVALID_DN_SYNTAX;
 834                         goto failed;
 835                 }
 836         } else norm_basedn = talloc_strdup(local_ctx, "");
 837
 838         if (*norm_basedn == '\0' &&
 839                 (scope == LDB_SCOPE_BASE || scope == LDB_SCOPE_ONELEVEL)) {
 840                         ret = LDB_ERR_UNWILLING_TO_PERFORM;
 841                         goto failed;
 842                 }
 843
 844         /* Convert filter into a series of SQL conditions (constraints) */
 845         sqlfilter = parsetree_to_sql(module, local_ctx, tree);
 846
 847         switch(scope) {
 848         case LDB_SCOPE_DEFAULT:
 849         case LDB_SCOPE_SUBTREE:
 850                 if (*norm_basedn != '\0') {
 851                         query = lsqlite3_tprintf(local_ctx,
 852                                 "SELECT entry.eid,\n"
 853                                 "       entry.dn,\n"
 854                                 "       av.attr_name,\n"
 855                                 "       av.attr_value\n"
 856                                 "  FROM ldb_entry AS entry\n"
 857
 858                                 "  LEFT OUTER JOIN ldb_attribute_values AS av\n"
 859                                 "    ON av.eid = entry.eid\n"
 860
 861                                 "  WHERE entry.eid IN\n"
 862                                 "    (SELECT DISTINCT ldb_entry.eid\n"
 863                                 "       FROM ldb_entry\n"
 864                                 "       WHERE (ldb_entry.norm_dn GLOB('*,%q')\n"
 865                                 "       OR ldb_entry.norm_dn = '%q')\n"
 866                                 "       AND ldb_entry.eid IN\n"
 867                                 "         (%s)\n"
 868                                 "    )\n"
 869
 870                                 "  ORDER BY entry.eid ASC;",
 871                                 norm_basedn,
 872                                 norm_basedn,
 873                                 sqlfilter);
 874                 } else {
 875                         query = lsqlite3_tprintf(local_ctx,
 876                                 "SELECT entry.eid,\n"
 877                                 "       entry.dn,\n"
 878                                 "       av.attr_name,\n"
 879                                 "       av.attr_value\n"
 880                                 "  FROM ldb_entry AS entry\n"
 881
 882                                 "  LEFT OUTER JOIN ldb_attribute_values AS av\n"
 883                                 "    ON av.eid = entry.eid\n"
 884
 885                                 "  WHERE entry.eid IN\n"
 886                                 "    (SELECT DISTINCT ldb_entry.eid\n"
 887                                 "       FROM ldb_entry\n"
 888                                 "       WHERE ldb_entry.eid IN\n"
 889                                 "         (%s)\n"
 890                                 "    )\n"
 891
 892                                 "  ORDER BY entry.eid ASC;",
 893                                 sqlfilter);
 894                 }
 895
 896                 break;
 897
 898         case LDB_SCOPE_BASE:
 899                 query = lsqlite3_tprintf(local_ctx,
 900                         "SELECT entry.eid,\n"
 901                         "       entry.dn,\n"
 902                         "       av.attr_name,\n"
 903                         "       av.attr_value\n"
 904                         "  FROM ldb_entry AS entry\n"
 905
 906                         "  LEFT OUTER JOIN ldb_attribute_values AS av\n"
 907                         "    ON av.eid = entry.eid\n"
 908
 909                         "  WHERE entry.eid IN\n"
 910                         "    (SELECT DISTINCT ldb_entry.eid\n"
 911                         "       FROM ldb_entry\n"
 912                         "       WHERE ldb_entry.norm_dn = '%q'\n"
 913                         "         AND ldb_entry.eid IN\n"
 914                         "           (%s)\n"
 915                         "    )\n"
 916
 917                         "  ORDER BY entry.eid ASC;",
 918                         norm_basedn,
 919                         sqlfilter);
 920                 break;
 921
 922         case LDB_SCOPE_ONELEVEL:
 923                 query = lsqlite3_tprintf(local_ctx,
 924                         "SELECT entry.eid,\n"
 925                         "       entry.dn,\n"
 926                         "       av.attr_name,\n"
 927                         "       av.attr_value\n"
 928                         "  FROM ldb_entry AS entry\n"
 929
 930                         "  LEFT OUTER JOIN ldb_attribute_values AS av\n"
 931                         "    ON av.eid = entry.eid\n"
 932
 933                         "  WHERE entry.eid IN\n"
 934                         "    (SELECT DISTINCT ldb_entry.eid\n"
 935                         "       FROM ldb_entry\n"
 936                         "       WHERE norm_dn GLOB('*,%q')\n"
 937                         "         AND NOT norm_dn GLOB('*,*,%q')\n"
 938                         "         AND ldb_entry.eid IN\n(%s)\n"
 939                         "    )\n"
 940
 941                         "  ORDER BY entry.eid ASC;",
 942                         norm_basedn,
 943                         norm_basedn,
 944                         sqlfilter);
 945                 break;
 946         }
 947
 948         if (query == NULL) {
 949                 ret = LDB_ERR_OTHER;
 950                 goto failed;
 951         }
 952
 953         /* * /
 954         printf ("%s\n", query);
 955         / * */
 956
 957         msgs.msgs = NULL;
 958         msgs.count = 0;
 959         msgs.current_eid = 0;
 960         msgs.mem_ctx = local_ctx;
 961         msgs.attrs = attrs;
 962
 963         ret = sqlite3_exec(lsqlite3->sqlite, query, lsqlite3_search_callback, &msgs, &errmsg);
 964         if (ret != SQLITE_OK) {
 965                 if (errmsg) {
 966                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
 967                         free(errmsg);
 968                 }
 969                 ret = LDB_ERR_OTHER;
 970                 goto failed;
 971         }
 972
 973         for (i = 0; i < msgs.count; i++) {
 974                 msgs.msgs[i] = ldb_msg_canonicalize(module->ldb, msgs.msgs[i]);
 975                 if (msgs.msgs[i] ==  NULL) {
 976                         goto failed;
 977                 }
 978         }
 979
 980         *res = talloc(module, struct ldb_result);
 981         if (! *res) {
 982                 goto failed;
 983         }
 984
 985         (*res)->msgs = talloc_steal(*res, msgs.msgs);
 986         (*res)->count = msgs.count;
 987
 988         talloc_free(local_ctx);
 989         return LDB_SUCCESS;
 990
 991 /* If error, return error code; otherwise return number of results */
 992 failed:
 993         talloc_free(local_ctx);
 994         return LDB_ERR_OTHER;
 995 }
 996
 997
 998 /* add a record */
 999 static int lsqlite3_add(struct ldb_module *module, const struct ldb_message *msg)
1000 {
1001         TALLOC_CTX *local_ctx;
1002         struct lsqlite3_private *lsqlite3 = module->private_data;
1003         long long eid;
1004         char *dn, *ndn;
1005         char *errmsg;
1006         char *query;
1007         int ret;
1008         int i;
1009
1010         /* create a local ctx */
1011         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_add local context");
1012         if (local_ctx == NULL) {
1013                 return LDB_ERR_OTHER;
1014         }
1015
1016         /* See if this is an ltdb special */
1017         if (ldb_dn_is_special(msg->dn)) {
1018                 struct ldb_dn *c;
1019
1020                 c = ldb_dn_explode(local_ctx, "@SUBCLASSES");
1021                 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1022 #warning "insert subclasses into object class tree"
1023                         ret = LDB_ERR_UNWILLING_TO_PERFORM;
1024                         goto failed;
1025                 }
1026
1027 /*
1028                 c = ldb_dn_explode(local_ctx, "@INDEXLIST");
1029                 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1030 #warning "should we handle indexes somehow ?"
1031                         goto failed;
1032                 }
1033 */
1034                 /* Others are implicitly ignored */
1035                 return LDB_SUCCESS;
1036         }
1037
1038         /* create linearized and normalized dns */
1039         dn = ldb_dn_linearize(local_ctx, msg->dn);
1040         ndn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, msg->dn));
1041         if (dn == NULL || ndn == NULL) {
1042                 ret = LDB_ERR_OTHER;
1043                 goto failed;
1044         }
1045
1046         query = lsqlite3_tprintf(local_ctx,
1047                                    /* Add new entry */
1048                                    "INSERT OR ABORT INTO ldb_entry "
1049                                    "('dn', 'norm_dn') "
1050                                    "VALUES ('%q', '%q');",
1051                                 dn, ndn);
1052         if (query == NULL) {
1053                 ret = LDB_ERR_OTHER;
1054                 goto failed;
1055         }
1056
1057         ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1058         if (ret != SQLITE_OK) {
1059                 if (errmsg) {
1060                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
1061                         free(errmsg);
1062                 }
1063                 ret = LDB_ERR_OTHER;
1064                 goto failed;
1065         }
1066
1067         eid = lsqlite3_get_eid_ndn(lsqlite3->sqlite, local_ctx, ndn);
1068         if (eid == -1) {
1069                 ret = LDB_ERR_OTHER;
1070                 goto failed;
1071         }
1072
1073         for (i = 0; i < msg->num_elements; i++) {
1074                 const struct ldb_message_element *el = &msg->elements[i];
1075                 const struct ldb_attrib_handler *h;
1076                 char *attr;
1077                 int j;
1078
1079                 /* Get a case-folded copy of the attribute name */
1080                 attr = ldb_casefold(local_ctx, el->name);
1081                 if (attr == NULL) {
1082                         ret = LDB_ERR_OTHER;
1083                         goto failed;
1084                 }
1085
1086                 h = ldb_attrib_handler(module->ldb, el->name);
1087
1088                 /* For each value of the specified attribute name... */
1089                 for (j = 0; j < el->num_values; j++) {
1090                         struct ldb_val value;
1091                         char *insert;
1092
1093                         /* Get a canonicalised copy of the data */
1094                         h->canonicalise_fn(module->ldb, local_ctx, &(el->values[j]), &value);
1095                         if (value.data == NULL) {
1096                                 ret = LDB_ERR_OTHER;
1097                                 goto failed;
1098                         }
1099
1100                         insert = lsqlite3_tprintf(local_ctx,
1101                                         "INSERT OR ROLLBACK INTO ldb_attribute_values "
1102                                         "('eid', 'attr_name', 'norm_attr_name',"
1103                                         " 'attr_value', 'norm_attr_value') "
1104                                         "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1105                                         eid, el->name, attr,
1106                                         el->values[j].data, value.data);
1107                         if (insert == NULL) {
1108                                 ret = LDB_ERR_OTHER;
1109                                 goto failed;
1110                         }
1111
1112                         ret = sqlite3_exec(lsqlite3->sqlite, insert, NULL, NULL, &errmsg);
1113                         if (ret != SQLITE_OK) {
1114                                 if (errmsg) {
1115                                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
1116                                         free(errmsg);
1117                                 }
1118                                 ret = LDB_ERR_OTHER;
1119                                 goto failed;
1120                         }
1121                 }
1122         }
1123
1124         talloc_free(local_ctx);
1125         return LDB_SUCCESS;
1126
1127 failed:
1128         talloc_free(local_ctx);
1129         return ret;
1130 }
1131
1132
1133 /* modify a record */
1134 static int lsqlite3_modify(struct ldb_module *module, const struct ldb_message *msg)
1135 {
1136         TALLOC_CTX *local_ctx;
1137         struct lsqlite3_private *lsqlite3 = module->private_data;
1138         long long eid;
1139         char *errmsg;
1140         int ret;
1141         int i;
1142
1143         /* create a local ctx */
1144         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_modify local context");
1145         if (local_ctx == NULL) {
1146                 return LDB_ERR_OTHER;
1147         }
1148
1149         /* See if this is an ltdb special */
1150         if (ldb_dn_is_special(msg->dn)) {
1151                 struct ldb_dn *c;
1152
1153                 c = ldb_dn_explode(local_ctx, "@SUBCLASSES");
1154                 if (ldb_dn_compare(module->ldb, msg->dn, c) == 0) {
1155 #warning "modify subclasses into object class tree"
1156                         ret = LDB_ERR_UNWILLING_TO_PERFORM;
1157                         goto failed;
1158                 }
1159
1160                 /* Others are implicitly ignored */
1161                 return LDB_SUCCESS;
1162         }
1163
1164         eid = lsqlite3_get_eid(module, msg->dn);
1165         if (eid == -1) {
1166                 ret = LDB_ERR_OTHER;
1167                 goto failed;
1168         }
1169
1170         for (i = 0; i < msg->num_elements; i++) {
1171                 const struct ldb_message_element *el = &msg->elements[i];
1172                 const struct ldb_attrib_handler *h;
1173                 int flags = el->flags & LDB_FLAG_MOD_MASK;
1174                 char *attr;
1175                 char *mod;
1176                 int j;
1177
1178                 /* Get a case-folded copy of the attribute name */
1179                 attr = ldb_casefold(local_ctx, el->name);
1180                 if (attr == NULL) {
1181                         ret = LDB_ERR_OTHER;
1182                         goto failed;
1183                 }
1184
1185                 h = ldb_attrib_handler(module->ldb, el->name);
1186
1187                 switch (flags) {
1188
1189                 case LDB_FLAG_MOD_REPLACE:
1190
1191                         /* remove all attributes before adding the replacements */
1192                         mod = lsqlite3_tprintf(local_ctx,
1193                                                 "DELETE FROM ldb_attribute_values "
1194                                                 "WHERE eid = '%lld' "
1195                                                 "AND norm_attr_name = '%q';",
1196                                                 eid, attr);
1197                         if (mod == NULL) {
1198                                 ret = LDB_ERR_OTHER;
1199                                 goto failed;
1200                         }
1201
1202                         ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1203                         if (ret != SQLITE_OK) {
1204                                 if (errmsg) {
1205                                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
1206                                         free(errmsg);
1207                                 }
1208                                 ret = LDB_ERR_OTHER;
1209                                 goto failed;
1210                         }
1211
1212                         /* MISSING break is INTENTIONAL */
1213
1214                 case LDB_FLAG_MOD_ADD:
1215 #warning "We should throw an error if no value is provided!"
1216                         /* For each value of the specified attribute name... */
1217                         for (j = 0; j < el->num_values; j++) {
1218                                 struct ldb_val value;
1219
1220                                 /* Get a canonicalised copy of the data */
1221                                 h->canonicalise_fn(module->ldb, local_ctx, &(el->values[j]), &value);
1222                                 if (value.data == NULL) {
1223                                         ret = LDB_ERR_OTHER;
1224                                         goto failed;
1225                                 }
1226
1227                                 mod = lsqlite3_tprintf(local_ctx,
1228                                         "INSERT OR ROLLBACK INTO ldb_attribute_values "
1229                                         "('eid', 'attr_name', 'norm_attr_name',"
1230                                         " 'attr_value', 'norm_attr_value') "
1231                                         "VALUES ('%lld', '%q', '%q', '%q', '%q');",
1232                                         eid, el->name, attr,
1233                                         el->values[j].data, value.data);
1234
1235                                 if (mod == NULL) {
1236                                         ret = LDB_ERR_OTHER;
1237                                         goto failed;
1238                                 }
1239
1240                                 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1241                                 if (ret != SQLITE_OK) {
1242                                         if (errmsg) {
1243                                                 ldb_set_errstring(module, talloc_strdup(module, errmsg));
1244                                                 free(errmsg);
1245                                         }
1246                                         ret = LDB_ERR_OTHER;
1247                                         goto failed;
1248                                 }
1249                         }
1250
1251                         break;
1252
1253                 case LDB_FLAG_MOD_DELETE:
1254 #warning "We should throw an error if the attribute we are trying to delete does not exist!"
1255                         if (el->num_values == 0) {
1256                                 mod = lsqlite3_tprintf(local_ctx,
1257                                                         "DELETE FROM ldb_attribute_values "
1258                                                         "WHERE eid = '%lld' "
1259                                                         "AND norm_attr_name = '%q';",
1260                                                         eid, attr);
1261                                 if (mod == NULL) {
1262                                         ret = LDB_ERR_OTHER;
1263                                         goto failed;
1264                                 }
1265
1266                                 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1267                                 if (ret != SQLITE_OK) {
1268                                         if (errmsg) {
1269                                                 ldb_set_errstring(module, talloc_strdup(module, errmsg));
1270                                                 free(errmsg);
1271                                         }
1272                                         ret = LDB_ERR_OTHER;
1273                                         goto failed;
1274                                 }
1275                         }
1276
1277                         /* For each value of the specified attribute name... */
1278                         for (j = 0; j < el->num_values; j++) {
1279                                 struct ldb_val value;
1280
1281                                 /* Get a canonicalised copy of the data */
1282                                 h->canonicalise_fn(module->ldb, local_ctx, &(el->values[j]), &value);
1283                                 if (value.data == NULL) {
1284                                         ret = LDB_ERR_OTHER;
1285                                         goto failed;
1286                                 }
1287
1288                                 mod = lsqlite3_tprintf(local_ctx,
1289                                         "DELETE FROM ldb_attribute_values "
1290                                         "WHERE eid = '%lld' "
1291                                         "AND norm_attr_name = '%q' "
1292                                         "AND norm_attr_value = '%q';",
1293                                         eid, attr, value.data);
1294
1295                                 if (mod == NULL) {
1296                                         ret = LDB_ERR_OTHER;
1297                                         goto failed;
1298                                 }
1299
1300                                 ret = sqlite3_exec(lsqlite3->sqlite, mod, NULL, NULL, &errmsg);
1301                                 if (ret != SQLITE_OK) {
1302                                         if (errmsg) {
1303                                                 ldb_set_errstring(module, talloc_strdup(module, errmsg));
1304                                                 free(errmsg);
1305                                         }
1306                                         ret = LDB_ERR_OTHER;
1307                                         goto failed;
1308                                 }
1309                         }
1310
1311                         break;
1312                 }
1313         }
1314
1315         talloc_free(local_ctx);
1316         return LDB_SUCCESS;
1317
1318 failed:
1319         talloc_free(local_ctx);
1320         return ret;
1321 }
1322
1323 /* delete a record */
1324 static int lsqlite3_delete(struct ldb_module *module, const struct ldb_dn *dn)
1325 {
1326         TALLOC_CTX *local_ctx;
1327         struct lsqlite3_private *lsqlite3 = module->private_data;
1328         long long eid;
1329         char *errmsg;
1330         char *query;
1331         int ret;
1332
1333         /* ignore ltdb specials */
1334         if (ldb_dn_is_special(dn)) {
1335                 return LDB_SUCCESS;
1336         }
1337
1338         /* create a local ctx */
1339         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_delete local context");
1340         if (local_ctx == NULL) {
1341                 return LDB_ERR_OTHER;
1342         }
1343
1344         eid = lsqlite3_get_eid(module, dn);
1345         if (eid == -1) {
1346                 ret = LDB_ERR_OTHER;
1347                 goto failed;
1348         }
1349
1350         query = lsqlite3_tprintf(local_ctx,
1351                                    /* Delete entry */
1352                                    "DELETE FROM ldb_entry WHERE eid = %lld; "
1353                                    /* Delete attributes */
1354                                    "DELETE FROM ldb_attribute_values WHERE eid = %lld; ",
1355                                 eid, eid);
1356         if (query == NULL) {
1357                 ret = LDB_ERR_OTHER;
1358                 goto failed;
1359         }
1360
1361         ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1362         if (ret != SQLITE_OK) {
1363                 if (errmsg) {
1364                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
1365                         free(errmsg);
1366                 }
1367                 ret = LDB_ERR_OTHER;
1368                 goto failed;
1369         }
1370
1371         talloc_free(local_ctx);
1372         return LDB_SUCCESS;
1373
1374 failed:
1375         talloc_free(local_ctx);
1376         return ret;
1377 }
1378
1379 /* rename a record */
1380 static int lsqlite3_rename(struct ldb_module *module, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
1381 {
1382         TALLOC_CTX *local_ctx;
1383         struct lsqlite3_private *lsqlite3 = module->private_data;
1384         char *new_dn, *new_cdn, *old_cdn;
1385         char *errmsg;
1386         char *query;
1387         int ret;
1388
1389         /* ignore ltdb specials */
1390         if (ldb_dn_is_special(olddn) || ldb_dn_is_special(newdn)) {
1391                 return LDB_SUCCESS;
1392         }
1393
1394         /* create a local ctx */
1395         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_rename local context");
1396         if (local_ctx == NULL) {
1397                 return LDB_ERR_OTHER;
1398         }
1399
1400         /* create linearized and normalized dns */
1401         old_cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, olddn));
1402         new_cdn = ldb_dn_linearize(local_ctx, ldb_dn_casefold(module->ldb, newdn));
1403         new_dn = ldb_dn_linearize(local_ctx, newdn);
1404         if (old_cdn == NULL || new_cdn == NULL || new_dn == NULL) {
1405                 ret = LDB_ERR_OTHER;
1406                 goto failed;
1407         }
1408
1409         /* build the SQL query */
1410         query = lsqlite3_tprintf(local_ctx,
1411                                  "UPDATE ldb_entry SET dn = '%q', norm_dn = '%q' "
1412                                  "WHERE norm_dn = '%q';",
1413                                  new_dn, new_cdn, old_cdn);
1414         if (query == NULL) {
1415                 ret = LDB_ERR_OTHER;
1416                 goto failed;
1417         }
1418
1419         /* execute */
1420         ret = sqlite3_exec(lsqlite3->sqlite, query, NULL, NULL, &errmsg);
1421         if (ret != SQLITE_OK) {
1422                 if (errmsg) {
1423                         ldb_set_errstring(module, talloc_strdup(module, errmsg));
1424                         free(errmsg);
1425                 }
1426                 ret = LDB_ERR_OTHER;
1427                 goto failed;
1428         }
1429
1430         /* clean up and exit */
1431         talloc_free(local_ctx);
1432         return LDB_SUCCESS;
1433
1434 failed:
1435         talloc_free(local_ctx);
1436         return ret;
1437 }
1438
1439 static int lsqlite3_start_trans(struct ldb_module * module)
1440 {
1441         int ret;
1442         char *errmsg;
1443         struct lsqlite3_private *   lsqlite3 = module->private_data;
1444
1445         if (lsqlite3->trans_count == 0) {
1446                 ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN IMMEDIATE;", NULL, NULL, &errmsg);
1447                 if (ret != SQLITE_OK) {
1448                         if (errmsg) {
1449                                 printf("lsqlite3_start_trans: error: %s\n", errmsg);
1450                                 free(errmsg);
1451                         }
1452                         return -1;
1453                 }
1454         };
1455
1456         lsqlite3->trans_count++;
1457
1458         return 0;
1459 }
1460
1461 static int lsqlite3_end_trans(struct ldb_module *module)
1462 {
1463         int ret;
1464         char *errmsg;
1465         struct lsqlite3_private *lsqlite3 = module->private_data;
1466
1467         if (lsqlite3->trans_count > 0) {
1468                 lsqlite3->trans_count--;
1469         } else return -1;
1470
1471         if (lsqlite3->trans_count == 0) {
1472                 ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1473                 if (ret != SQLITE_OK) {
1474                         if (errmsg) {
1475                                 printf("lsqlite3_end_trans: error: %s\n", errmsg);
1476                                 free(errmsg);
1477                         }
1478                         return -1;
1479                 }
1480         }
1481
1482         return 0;
1483 }
1484
1485 static int lsqlite3_del_trans(struct ldb_module *module)
1486 {
1487         struct lsqlite3_private *lsqlite3 = module->private_data;
1488
1489         if (lsqlite3->trans_count > 0) {
1490                 lsqlite3->trans_count--;
1491         } else return -1;
1492
1493         if (lsqlite3->trans_count == 0) {
1494                 return lsqlite3_safe_rollback(lsqlite3->sqlite);
1495         }
1496
1497         return -1;
1498 }
1499
1500 /*
1501  * Static functions
1502  */
1503
1504 static int initialize(struct lsqlite3_private *lsqlite3,
1505                       struct ldb_context *ldb, const char *url, int flags)
1506 {
1507         TALLOC_CTX *local_ctx;
1508         long long queryInt;
1509         int rollback = 0;
1510         char *errmsg;
1511         char *schema;
1512         int ret;
1513
1514         /* create a local ctx */
1515         local_ctx = talloc_named(lsqlite3, 0, "lsqlite3_rename local context");
1516         if (local_ctx == NULL) {
1517                 return -1;
1518         }
1519
1520         schema = lsqlite3_tprintf(local_ctx,
1521
1522
1523                 "CREATE TABLE ldb_info AS "
1524                 "  SELECT 'LDB' AS database_type,"
1525                 "         '1.0' AS version;"
1526
1527                 /*
1528                  * The entry table holds the information about an entry.
1529                  * This table is used to obtain the EID of the entry and to
1530                  * support scope=one and scope=base.  The parent and child
1531                  * table is included in the entry table since all the other
1532                  * attributes are dependent on EID.
1533                  */
1534                 "CREATE TABLE ldb_entry "
1535                 "("
1536                 "  eid     INTEGER PRIMARY KEY AUTOINCREMENT,"
1537                 "  dn      TEXT UNIQUE NOT NULL,"
1538                 "  norm_dn TEXT UNIQUE NOT NULL"
1539                 ");"
1540
1541
1542                 "CREATE TABLE ldb_object_classes"
1543                 "("
1544                 "  class_name            TEXT PRIMARY KEY,"
1545                 "  parent_class_name     TEXT,"
1546                 "  tree_key              TEXT UNIQUE,"
1547                 "  max_child_num         INTEGER DEFAULT 0"
1548                 ");"
1549
1550                 /*
1551                  * We keep a full listing of attribute/value pairs here
1552                  */
1553                 "CREATE TABLE ldb_attribute_values"
1554                 "("
1555                 "  eid             INTEGER REFERENCES ldb_entry,"
1556                 "  attr_name       TEXT,"
1557                 "  norm_attr_name  TEXT,"
1558                 "  attr_value      TEXT,"
1559                 "  norm_attr_value TEXT "
1560                 ");"
1561
1562
1563                 /*
1564                  * Indexes
1565                  */
1566                 "CREATE INDEX ldb_attribute_values_eid_idx "
1567                 "  ON ldb_attribute_values (eid);"
1568
1569                 "CREATE INDEX ldb_attribute_values_name_value_idx "
1570                 "  ON ldb_attribute_values (attr_name, norm_attr_value);"
1571
1572
1573
1574                 /*
1575                  * Triggers
1576                  */
1577
1578                 "CREATE TRIGGER ldb_object_classes_insert_tr"
1579                 "  AFTER INSERT"
1580                 "  ON ldb_object_classes"
1581                 "  FOR EACH ROW"
1582                 "    BEGIN"
1583                 "      UPDATE ldb_object_classes"
1584                 "        SET tree_key = COALESCE(tree_key, "
1585                 "              ("
1586                 "                SELECT tree_key || "
1587                 "                       (SELECT base160(max_child_num + 1)"
1588                 "                                FROM ldb_object_classes"
1589                 "                                WHERE class_name = "
1590                 "                                      new.parent_class_name)"
1591                 "                  FROM ldb_object_classes "
1592                 "                  WHERE class_name = new.parent_class_name "
1593                 "              ));"
1594                 "      UPDATE ldb_object_classes "
1595                 "        SET max_child_num = max_child_num + 1"
1596                 "        WHERE class_name = new.parent_class_name;"
1597                 "    END;"
1598
1599                 /*
1600                  * Table initialization
1601                  */
1602
1603                 "INSERT INTO ldb_object_classes "
1604                 "    (class_name, tree_key) "
1605                 "  VALUES "
1606                 "    ('TOP', '0001');");
1607
1608         /* Skip protocol indicator of url  */
1609         if (strncmp(url, "sqlite://", 9) != 0) {
1610                 return SQLITE_MISUSE;
1611         }
1612
1613         /* Update pointer to just after the protocol indicator */
1614         url += 9;
1615
1616         /* Try to open the (possibly empty/non-existent) database */
1617         if ((ret = sqlite3_open(url, &lsqlite3->sqlite)) != SQLITE_OK) {
1618                 return ret;
1619         }
1620
1621         /* In case this is a new database, enable auto_vacuum */
1622         ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA auto_vacuum = 1;", NULL, NULL, &errmsg);
1623         if (ret != SQLITE_OK) {
1624                 if (errmsg) {
1625                         printf("lsqlite3 initializaion error: %s\n", errmsg);
1626                         free(errmsg);
1627                 }
1628                 goto failed;
1629         }
1630
1631         if (flags & LDB_FLG_NOSYNC) {
1632                 /* DANGEROUS */
1633                 ret = sqlite3_exec(lsqlite3->sqlite, "PRAGMA synchronous = OFF;", NULL, NULL, &errmsg);
1634                 if (ret != SQLITE_OK) {
1635                         if (errmsg) {
1636                                 printf("lsqlite3 initializaion error: %s\n", errmsg);
1637                                 free(errmsg);
1638                         }
1639                         goto failed;
1640                 }
1641         }
1642
1643         /* */
1644
1645         /* Establish a busy timeout of 30 seconds */
1646         if ((ret = sqlite3_busy_timeout(lsqlite3->sqlite,
1647                                         30000)) != SQLITE_OK) {
1648                 return ret;
1649         }
1650
1651         /* Create a function, callable from sql, to increment a tree_key */
1652         if ((ret =
1653              sqlite3_create_function(lsqlite3->sqlite,/* handle */
1654                                      "base160_next",  /* function name */
1655                                      1,               /* number of args */
1656                                      SQLITE_ANY,      /* preferred text type */
1657                                      NULL,            /* user data */
1658                                      base160next_sql, /* called func */
1659                                      NULL,            /* step func */
1660                                      NULL             /* final func */
1661                      )) != SQLITE_OK) {
1662                 return ret;
1663         }
1664
1665         /* Create a function, callable from sql, to convert int to base160 */
1666         if ((ret =
1667              sqlite3_create_function(lsqlite3->sqlite,/* handle */
1668                                      "base160",       /* function name */
1669                                      1,               /* number of args */
1670                                      SQLITE_ANY,      /* preferred text type */
1671                                      NULL,            /* user data */
1672                                      base160_sql,     /* called func */
1673                                      NULL,            /* step func */
1674                                      NULL             /* final func */
1675                      )) != SQLITE_OK) {
1676                 return ret;
1677         }
1678
1679         /* Create a function, callable from sql, to perform various comparisons */
1680         if ((ret =
1681              sqlite3_create_function(lsqlite3->sqlite, /* handle */
1682                                      "ldap_compare",   /* function name */
1683                                      4,                /* number of args */
1684                                      SQLITE_ANY,       /* preferred text type */
1685                                      ldb  ,            /* user data */
1686                                      lsqlite3_compare, /* called func */
1687                                      NULL,             /* step func */
1688                                      NULL              /* final func */
1689                      )) != SQLITE_OK) {
1690                 return ret;
1691         }
1692
1693         /* Begin a transaction */
1694         ret = sqlite3_exec(lsqlite3->sqlite, "BEGIN EXCLUSIVE;", NULL, NULL, &errmsg);
1695         if (ret != SQLITE_OK) {
1696                 if (errmsg) {
1697                         printf("lsqlite3: initialization error: %s\n", errmsg);
1698                         free(errmsg);
1699                 }
1700                 goto failed;
1701         }
1702         rollback = 1;
1703
1704         /* Determine if this is a new database.  No tables means it is. */
1705         if (query_int(lsqlite3,
1706                       &queryInt,
1707                       "SELECT COUNT(*)\n"
1708                       "  FROM sqlite_master\n"
1709                       "  WHERE type = 'table';") != 0) {
1710                 goto failed;
1711         }
1712
1713         if (queryInt == 0) {
1714                 /*
1715                  * Create the database schema
1716                  */
1717                 ret = sqlite3_exec(lsqlite3->sqlite, schema, NULL, NULL, &errmsg);
1718                 if (ret != SQLITE_OK) {
1719                         if (errmsg) {
1720                                 printf("lsqlite3 initializaion error: %s\n", errmsg);
1721                                 free(errmsg);
1722                         }
1723                         goto failed;
1724                 }
1725         } else {
1726                 /*
1727                  * Ensure that the database we opened is one of ours
1728                  */
1729                 if (query_int(lsqlite3,
1730                               &queryInt,
1731                               "SELECT "
1732                               "  (SELECT COUNT(*) = 2"
1733                               "     FROM sqlite_master "
1734                               "     WHERE type = 'table' "
1735                               "       AND name IN "
1736                               "         ("
1737                               "           'ldb_entry', "
1738                               "           'ldb_object_classes' "
1739                               "         ) "
1740                               "  ) "
1741                               "  AND "
1742                               "  (SELECT 1 "
1743                               "     FROM ldb_info "
1744                               "     WHERE database_type = 'LDB' "
1745                               "       AND version = '1.0'"
1746                               "  );") != 0 ||
1747                     queryInt != 1) {
1748
1749                         /* It's not one that we created.  See ya! */
1750                         goto failed;
1751                 }
1752         }
1753
1754         /* Commit the transaction */
1755         ret = sqlite3_exec(lsqlite3->sqlite, "COMMIT;", NULL, NULL, &errmsg);
1756         if (ret != SQLITE_OK) {
1757                 if (errmsg) {
1758                         printf("lsqlite3: iniialization error: %s\n", errmsg);
1759                         free(errmsg);
1760                 }
1761                 goto failed;
1762         }
1763
1764         return SQLITE_OK;
1765
1766 failed:
1767         if (rollback) lsqlite3_safe_rollback(lsqlite3->sqlite);
1768         sqlite3_close(lsqlite3->sqlite);
1769         return -1;
1770 }
1771
1772 static int
1773 destructor(void *p)
1774 {
1775         struct lsqlite3_private *lsqlite3 = p;
1776
1777         if (lsqlite3->sqlite) {
1778                 sqlite3_close(lsqlite3->sqlite);
1779         }
1780         return 0;
1781 }
1782
1783
1784 static int lsqlite3_request(struct ldb_module *module, struct ldb_request *req)
1785 {
1786         switch (req->operation) {
1787
1788         case LDB_REQ_SEARCH:
1789                 return lsqlite3_search_bytree(module,
1790                                           req->op.search.base,
1791                                           req->op.search.scope,
1792                                           req->op.search.tree,
1793                                           req->op.search.attrs,
1794                                           req->op.search.res);
1795
1796         case LDB_REQ_ADD:
1797                 return lsqlite3_add(module, req->op.add.message);
1798
1799         case LDB_REQ_MODIFY:
1800                 return lsqlite3_modify(module, req->op.mod.message);
1801
1802         case LDB_REQ_DELETE:
1803                 return lsqlite3_delete(module, req->op.del.dn);
1804
1805         case LDB_REQ_RENAME:
1806                 return lsqlite3_rename(module,
1807                                         req->op.rename.olddn,
1808                                         req->op.rename.newdn);
1809
1810         default:
1811                 return LDB_ERR_OPERATIONS_ERROR;
1812
1813         }
1814 }
1815
1816
1817 /*
1818  * Table of operations for the sqlite3 backend
1819  */
1820 static const struct ldb_module_ops lsqlite3_ops = {
1821         .name              = "sqlite",
1822         .request           = lsqlite3_request,
1823         .start_transaction = lsqlite3_start_trans,
1824         .end_transaction   = lsqlite3_end_trans,
1825         .del_transaction   = lsqlite3_del_trans
1826 };
1827
1828 /*
1829  * connect to the database
1830  */
1831 int lsqlite3_connect(struct ldb_context *ldb,
1832                      const char *url,
1833                      unsigned int flags,
1834                      const char *options[])
1835 {
1836         int                         i;
1837         int                         ret;
1838         struct lsqlite3_private *   lsqlite3 = NULL;
1839
1840         lsqlite3 = talloc(ldb, struct lsqlite3_private);
1841         if (!lsqlite3) {
1842                 goto failed;
1843         }
1844
1845         lsqlite3->sqlite = NULL;
1846         lsqlite3->options = NULL;
1847         lsqlite3->trans_count = 0;
1848
1849         ret = initialize(lsqlite3, ldb, url, flags);
1850         if (ret != SQLITE_OK) {
1851                 goto failed;
1852         }
1853
1854         talloc_set_destructor(lsqlite3, destructor);
1855
1856         ldb->modules = talloc(ldb, struct ldb_module);
1857         if (!ldb->modules) {
1858                 goto failed;
1859         }
1860         ldb->modules->ldb = ldb;
1861         ldb->modules->prev = ldb->modules->next = NULL;
1862         ldb->modules->private_data = lsqlite3;
1863         ldb->modules->ops = &lsqlite3_ops;
1864
1865         if (options) {
1866                 /*
1867                  * take a copy of the options array, so we don't have to rely
1868                  * on the caller keeping it around (it might be dynamic)
1869                  */
1870                 for (i=0;options[i];i++) ;
1871
1872                 lsqlite3->options = talloc_array(lsqlite3, char *, i+1);
1873                 if (!lsqlite3->options) {
1874                         goto failed;
1875                 }
1876
1877                 for (i=0;options[i];i++) {
1878
1879                         lsqlite3->options[i+1] = NULL;
1880                         lsqlite3->options[i] =
1881                                 talloc_strdup(lsqlite3->options, options[i]);
1882                         if (!lsqlite3->options[i]) {
1883                                 goto failed;
1884                         }
1885                 }
1886         }
1887
1888         return 0;
1889
1890 failed:
1891         if (lsqlite3->sqlite != NULL) {
1892                 (void) sqlite3_close(lsqlite3->sqlite);
1893         }
1894         talloc_free(lsqlite3);
1895         return -1;
1896 }
1897