git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/sqlite.c

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2010 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of Kern Sibbald.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Bacula Catalog Database routines specific to SQLite
  30  *
  31  *    Kern Sibbald, January 2002
  32  *
  33  */
  34
  35
  36
  37 /* The following is necessary so that we do not include
  38  * the dummy external definition of DB.
  39  */
  40 #define __SQL_C                       /* indicate that this is sql.c */
  41
  42 #include "bacula.h"
  43 #include "cats.h"
  44
  45 #if    HAVE_SQLITE || HAVE_SQLITE3
  46
  47 /* -----------------------------------------------------------------------
  48  *
  49  *    SQLite dependent defines and subroutines
  50  *
  51  * -----------------------------------------------------------------------
  52  */
  53
  54 /* List of open databases */
  55 static dlist *db_list = NULL;
  56
  57 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  58
  59 /*
  60  * Retrieve database type
  61  */
  62 const char *
  63 db_get_type(void)
  64 {
  65 #ifdef HAVE_SQLITE3
  66    return "SQLite3";
  67 #else
  68    return "SQLite";
  69 #endif
  70 }
  71
  72 /*
  73  * When using mult_db_connections = 1,
  74  * sqlite can be BUSY. We just need sleep a little in this case.
  75  */
  76
  77 #ifdef HAVE_SQLITE3
  78 static int my_busy_handler(void *arg, int calls)
  79 {
  80    bmicrosleep(0, 500);
  81    return 1;
  82 }
  83 #else
  84 static int my_busy_handler(void *arg, const char* p, int calls)
  85 {
  86    bmicrosleep(0, 500);
  87    return 1;
  88 }
  89 #endif
  90
  91
  92 /*
  93  * Initialize database data structure. In principal this should
  94  * never have errors, or it is really fatal.
  95  */
  96 B_DB *
  97 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
  98                  const char *db_address, int db_port, const char *db_socket,
  99                  int mult_db_connections)
 100 {
 101    B_DB *mdb = NULL;
 102
 103    P(mutex);                          /* lock DB queue */
 104    if (db_list == NULL) {
 105       db_list = New(dlist(mdb, &mdb->link));
 106    }
 107    /* Look to see if DB already open */
 108    if (!mult_db_connections) {
 109       foreach_dlist(mdb, db_list) {
 110          if (bstrcmp(mdb->db_name, db_name) &&
 111              bstrcmp(mdb->db_address, db_address) &&
 112              mdb->db_port == db_port) {
 113             Dmsg2(300, "DB REopen %d %s\n", mdb->ref_count, db_name);
 114             mdb->ref_count++;
 115             V(mutex);
 116             return mdb;                  /* already open */
 117          }
 118       }
 119    }
 120    Dmsg0(300, "db_open first time\n");
 121    mdb = (B_DB *)malloc(sizeof(B_DB));
 122    memset(mdb, 0, sizeof(B_DB));
 123    mdb->db_name = bstrdup(db_name);
 124    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
 125    *mdb->errmsg = 0;
 126    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
 127    mdb->cached_path = get_pool_memory(PM_FNAME);
 128    mdb->cached_path_id = 0;
 129    mdb->ref_count = 1;
 130    mdb->fname = get_pool_memory(PM_FNAME);
 131    mdb->path = get_pool_memory(PM_FNAME);
 132    mdb->esc_name = get_pool_memory(PM_FNAME);
 133    mdb->esc_path = get_pool_memory(PM_FNAME);
 134    mdb->esc_obj  = get_pool_memory(PM_FNAME);
 135    mdb->allow_transactions = mult_db_connections;
 136    db_list->append(mdb);
 137    V(mutex);
 138    return mdb;
 139 }
 140
 141 /*
 142  * Now actually open the database.  This can generate errors,
 143  * which are returned in the errmsg
 144  *
 145  * DO NOT close the database or free(mdb) here !!!!
 146  */
 147 int
 148 db_open_database(JCR *jcr, B_DB *mdb)
 149 {
 150    char *db_name;
 151    int len;
 152    struct stat statbuf;
 153    int errstat;
 154    int retry = 0;
 155
 156    P(mutex);
 157    if (mdb->connected) {
 158       V(mutex);
 159       return 1;
 160    }
 161    mdb->connected = FALSE;
 162
 163    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 164       berrno be;
 165       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 166             be.bstrerror(errstat));
 167       V(mutex);
 168       return 0;
 169    }
 170
 171    /* open the database */
 172    len = strlen(working_directory) + strlen(mdb->db_name) + 5;
 173    db_name = (char *)malloc(len);
 174    strcpy(db_name, working_directory);
 175    strcat(db_name, "/");
 176    strcat(db_name, mdb->db_name);
 177    strcat(db_name, ".db");
 178    if (stat(db_name, &statbuf) != 0) {
 179       Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
 180          db_name);
 181       free(db_name);
 182       V(mutex);
 183       return 0;
 184    }
 185
 186    for (mdb->db=NULL; !mdb->db && retry++ < 10; ) {
 187 #ifdef HAVE_SQLITE3
 188       int stat = sqlite3_open(db_name, &mdb->db);
 189       if (stat != SQLITE_OK) {
 190          mdb->sqlite_errmsg = (char *)sqlite3_errmsg(mdb->db);
 191          sqlite3_close(mdb->db);
 192          mdb->db = NULL;
 193       } else {
 194          mdb->sqlite_errmsg = NULL;
 195       }
 196 #else
 197       mdb->db = sqlite_open(
 198            db_name,                      /* database name */
 199            644,                          /* mode */
 200            &mdb->sqlite_errmsg);         /* error message */
 201 #endif
 202
 203       Dmsg0(300, "sqlite_open\n");
 204       if (!mdb->db) {
 205          bmicrosleep(1, 0);
 206       }
 207    }
 208    if (mdb->db == NULL) {
 209       Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
 210          db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
 211       free(db_name);
 212       V(mutex);
 213       return 0;
 214    }
 215    mdb->connected = true;
 216    free(db_name);
 217
 218    /* set busy handler to wait when we use mult_db_connections = 1 */
 219 #ifdef HAVE_SQLITE3
 220    sqlite3_busy_handler(mdb->db, my_busy_handler, NULL);
 221 #else
 222    sqlite_busy_handler(mdb->db, my_busy_handler, NULL);
 223 #endif
 224
 225 #if  defined(HAVE_SQLITE3) && defined(SQLITE3_INIT_QUERY)
 226    db_sql_query(mdb, SQLITE3_INIT_QUERY, NULL, NULL);
 227 #endif
 228
 229    if (!check_tables_version(jcr, mdb)) {
 230       V(mutex);
 231       return 0;
 232    }
 233
 234
 235    V(mutex);
 236    return 1;
 237 }
 238
 239 void
 240 db_close_database(JCR *jcr, B_DB *mdb)
 241 {
 242    if (!mdb) {
 243       return;
 244    }
 245    db_end_transaction(jcr, mdb);
 246    P(mutex);
 247    sql_free_result(mdb);
 248    mdb->ref_count--;
 249    if (mdb->ref_count == 0) {
 250       db_list->remove(mdb);
 251       if (mdb->connected && mdb->db) {
 252          sqlite_close(mdb->db);
 253       }
 254       rwl_destroy(&mdb->lock);
 255       free_pool_memory(mdb->errmsg);
 256       free_pool_memory(mdb->cmd);
 257       free_pool_memory(mdb->cached_path);
 258       free_pool_memory(mdb->fname);
 259       free_pool_memory(mdb->path);
 260       free_pool_memory(mdb->esc_name);
 261       free_pool_memory(mdb->esc_path);
 262       free_pool_memory(mdb->esc_obj);
 263       if (mdb->db_name) {
 264          free(mdb->db_name);
 265       }
 266       free(mdb);
 267       if (db_list->size() == 0) {
 268          delete db_list;
 269          db_list = NULL;
 270       }
 271    }
 272    V(mutex);
 273 }
 274
 275 void db_check_backend_thread_safe()
 276 {
 277 #ifdef HAVE_BATCH_FILE_INSERT
 278 # ifdef HAVE_SQLITE3_THREADSAFE
 279    if (!sqlite3_threadsafe()) {
 280       Emsg0(M_ABORT, 0, _("SQLite3 client library must be thread-safe "
 281                           "when using BatchMode.\n"));
 282    }
 283 # endif
 284 #endif
 285 }
 286
 287 void db_thread_cleanup()
 288 {
 289 #ifdef HAVE_SQLITE3
 290    sqlite3_thread_cleanup();
 291 #endif
 292 }
 293
 294 /*
 295  * Return the next unique index (auto-increment) for
 296  * the given table.  Return 0 on error.
 297  */
 298 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 299 {
 300    strcpy(index, "NULL");
 301    return 1;
 302 }
 303
 304 /*
 305  * Escape binary object so that SQLite is happy
 306  * Memory is stored in B_DB struct, no need to free it
 307  *
 308  * TODO: this should be implemented  (escape \0)
 309  */
 310 char *
 311 db_escape_object(JCR *jcr, B_DB *db, char *old, int len)
 312 {
 313    char *n, *o;
 314
 315    n = mdb->esc_obj = check_pool_memory_size(mdb->esc_obj, len*2+1);
 316    o = old;
 317    while (len--) {
 318       switch (*o) {
 319       case '\'':
 320          *n++ = '\'';
 321          *n++ = '\'';
 322          o++;
 323          break;
 324       case 0:
 325          *n++ = '\\';
 326          *n++ = 0;
 327          o++;
 328          break;
 329       default:
 330          *n++ = *o++;
 331          break;
 332       }
 333    }
 334    *n = 0;
 335    return mdb->esc_obj;
 336 }
 337
 338 /*
 339  * Unescape binary object so that SQLIte is happy
 340  *
 341  * TODO: need to be implemented (escape \0)
 342  */
 343 void
 344 db_unescape_object(JCR *jcr, B_DB *db,
 345                    char *from, int32_t expected_len,
 346                    POOLMEM **dest, int32_t *dest_len)
 347 {
 348    if (!from) {
 349       *dest[0] = 0;
 350       *dest_len = 0;
 351       return;
 352    }
 353    *dest = check_pool_memory_size(*dest, expected_len+1);
 354    *dest_len = expected_len;
 355    memcpy(*dest, from, expected_len);
 356    (*dest)[expected_len]=0;
 357 }
 358
 359 /*
 360  * Escape strings so that SQLite is happy
 361  *
 362  *   NOTE! len is the length of the old string. Your new
 363  *         string must be long enough (max 2*old+1) to hold
 364  *         the escaped output.
 365  */
 366 void
 367 db_escape_string(JCR *jcr, B_DB *db, char *snew, char *old, int len)
 368 {
 369    char *n, *o;
 370
 371    n = snew;
 372    o = old;
 373    while (len--) {
 374       switch (*o) {
 375       case '\'':
 376          *n++ = '\'';
 377          *n++ = '\'';
 378          o++;
 379          break;
 380       case 0:
 381          *n++ = '\\';
 382          *n++ = 0;
 383          o++;
 384          break;
 385       default:
 386          *n++ = *o++;
 387          break;
 388       }
 389    }
 390    *n = 0;
 391 }
 392
 393 struct rh_data {
 394    DB_RESULT_HANDLER *result_handler;
 395    void *ctx;
 396 };
 397
 398 /*
 399  * Convert SQLite's callback into Bacula DB callback
 400  */
 401 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
 402 {
 403    struct rh_data *rh_data = (struct rh_data *)arh_data;
 404
 405    if (rh_data->result_handler) {
 406       (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
 407    }
 408    return 0;
 409 }
 410
 411 /*
 412  * Submit a general SQL command (cmd), and for each row returned,
 413  *  the sqlite_handler is called with the ctx.
 414  */
 415 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 416 {
 417    struct rh_data rh_data;
 418    int stat;
 419
 420    db_lock(mdb);
 421    if (mdb->sqlite_errmsg) {
 422 #ifdef HAVE_SQLITE3
 423       sqlite3_free(mdb->sqlite_errmsg);
 424 #else
 425       actuallyfree(mdb->sqlite_errmsg);
 426 #endif
 427       mdb->sqlite_errmsg = NULL;
 428    }
 429    rh_data.result_handler = result_handler;
 430    rh_data.ctx = ctx;
 431    stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
 432    if (stat != SQLITE_OK) {
 433       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 434       db_unlock(mdb);
 435       return false;
 436    }
 437    db_unlock(mdb);
 438    return true;
 439 }
 440
 441 /*
 442  * Submit a sqlite query and retrieve all the data
 443  */
 444 int my_sqlite_query(B_DB *mdb, const char *cmd)
 445 {
 446    int stat;
 447
 448    my_sqlite_free_table(mdb);
 449    if (mdb->sqlite_errmsg) {
 450 #ifdef HAVE_SQLITE3
 451       sqlite3_free(mdb->sqlite_errmsg);
 452 #else
 453       actuallyfree(mdb->sqlite_errmsg);
 454 #endif
 455       mdb->sqlite_errmsg = NULL;
 456    }
 457    stat = sqlite_get_table(mdb->db, (char *)cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
 458             &mdb->sqlite_errmsg);
 459    mdb->row = 0;                      /* no row fetched yet */
 460    if (stat != 0) {                   /* something went wrong */
 461       mdb->nrow = mdb->ncolumn = 0;
 462    }
 463    return stat;
 464 }
 465
 466 /* Fetch one row at a time */
 467 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
 468 {
 469    if (!mdb->result || (mdb->row >= mdb->nrow)) {
 470       return NULL;
 471    }
 472    mdb->row++;
 473    return &mdb->result[mdb->ncolumn * mdb->row];
 474 }
 475
 476 void my_sqlite_free_table(B_DB *mdb)
 477 {
 478    int i;
 479
 480    if (mdb->fields_defined) {
 481       for (i=0; i < sql_num_fields(mdb); i++) {
 482          if (mdb->fields[i]) {
 483             free(mdb->fields[i]);
 484             mdb->fields[i] = NULL;
 485          }
 486       }
 487       if (mdb->fields) {
 488          free(mdb->fields);
 489          mdb->fields = NULL;
 490       }
 491       mdb->fields_defined = false;
 492    }
 493    if (mdb->result) {
 494       sqlite_free_table(mdb->result);
 495       mdb->result = NULL;
 496    }
 497    mdb->nrow = mdb->ncolumn = 0;
 498 }
 499
 500 void my_sqlite_field_seek(B_DB *mdb, int field)
 501 {
 502    int i, j;
 503    if (mdb->result == NULL) {
 504       mdb->field = 0;
 505       return;
 506    }
 507    /* On first call, set up the fields */
 508    if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
 509       mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
 510       for (i=0; i < sql_num_fields(mdb); i++) {
 511          mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
 512          /* ***FIXME***  it seems to me that this is wrong
 513           *   fields has lots of items
 514           */
 515          if (mdb->result[i] == NULL) {
 516             mdb->fields_defined = false;
 517             free(mdb->fields);
 518             mdb->fields = NULL;
 519             mdb->field = 0;
 520             return;
 521          }
 522          mdb->fields[i]->name = mdb->result[i];
 523          mdb->fields[i]->length = cstrlen(mdb->fields[i]->name);
 524          mdb->fields[i]->max_length = mdb->fields[i]->length;
 525          for (j=1; j <= mdb->nrow; j++) {
 526             int len;
 527             if (mdb->result[i + mdb->ncolumn *j]) {
 528                len = (uint32_t)cstrlen(mdb->result[i + mdb->ncolumn * j]);
 529             } else {
 530                len = 0;
 531             }
 532             if (len > mdb->fields[i]->max_length) {
 533                mdb->fields[i]->max_length = len;
 534             }
 535          }
 536          mdb->fields[i]->type = 0;
 537          mdb->fields[i]->flags = 1;        /* not null */
 538       }
 539       mdb->fields_defined = true;
 540    }
 541    if (sql_num_fields(mdb) <= 0) {
 542       field = 0;
 543    } else if (field > sql_num_fields(mdb) - 1) {
 544       field = sql_num_fields(mdb) - 1;
 545     }
 546     mdb->field = field;
 547 }
 548
 549 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
 550 {
 551    if (mdb->fields_defined && mdb->field < sql_num_fields(mdb)) {
 552       return mdb->fields[mdb->field++];
 553    } else {
 554       mdb->field = 0;
 555       return NULL;
 556    }
 557 }
 558
 559 int my_sqlite_insert_autokey_record(B_DB *mdb, const char *query, const char *table_name)
 560 {
 561    /*
 562     * First execute the insert query and then retrieve the currval.
 563     */
 564    if (my_sqlite_query(mdb, query)) {
 565       return 0;
 566    }
 567
 568    mdb->num_rows = sql_affected_rows(mdb);
 569    if (mdb->num_rows != 1) {
 570       return 0;
 571    }
 572
 573    mdb->changes++;
 574
 575 #ifdef HAVE_SQLITE3
 576    return sqlite3_last_insert_rowid(mdb->db);
 577 #else
 578    return sqlite_last_insert_rowid(mdb->db);
 579 #endif
 580 }
 581
 582 #ifdef HAVE_BATCH_FILE_INSERT
 583 const char *my_sqlite_batch_lock_query = "BEGIN";
 584 const char *my_sqlite_batch_unlock_query = "COMMIT";
 585
 586 const char *my_sqlite_batch_fill_path_query =
 587    "INSERT INTO Path (Path)"
 588    " SELECT DISTINCT Path FROM batch"
 589    " EXCEPT SELECT Path FROM Path";
 590
 591 const char *my_sqlite_batch_fill_filename_query =
 592    "INSERT INTO Filename (Name)"
 593    " SELECT DISTINCT Name FROM batch "
 594    " EXCEPT SELECT Name FROM Filename";
 595 #endif /* HAVE_BATCH_FILE_INSERT */
 596
 597
 598 #endif /* HAVE_SQLITE */