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->have_insert_id = true;
 125    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
 126    *mdb->errmsg = 0;
 127    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
 128    mdb->cached_path = get_pool_memory(PM_FNAME);
 129    mdb->cached_path_id = 0;
 130    mdb->ref_count = 1;
 131    mdb->fname = get_pool_memory(PM_FNAME);
 132    mdb->path = get_pool_memory(PM_FNAME);
 133    mdb->esc_name = get_pool_memory(PM_FNAME);
 134    mdb->esc_path = 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       if (mdb->db_name) {
 263          free(mdb->db_name);
 264       }
 265       free(mdb);
 266       if (db_list->size() == 0) {
 267          delete db_list;
 268          db_list = NULL;
 269       }
 270    }
 271    V(mutex);
 272 }
 273
 274 void db_check_backend_thread_safe()
 275 {
 276 #ifdef HAVE_BATCH_FILE_INSERT
 277    if (!sqlite3_threadsafe()) {
 278       Emsg0(M_ABORT, 0, _("SQLite3 client library must be thread-safe "
 279                           "when using BatchMode.\n"));
 280    }
 281 #endif
 282 }
 283
 284 void db_thread_cleanup()
 285 {
 286 #ifdef HAVE_SQLITE3
 287    sqlite3_thread_cleanup();
 288 #endif
 289 }
 290
 291 /*
 292  * Return the next unique index (auto-increment) for
 293  * the given table.  Return 0 on error.
 294  */
 295 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 296 {
 297    strcpy(index, "NULL");
 298    return 1;
 299 }
 300
 301
 302 /*
 303  * Escape strings so that SQLite is happy
 304  *
 305  *   NOTE! len is the length of the old string. Your new
 306  *         string must be long enough (max 2*old+1) to hold
 307  *         the escaped output.
 308  */
 309 void
 310 db_escape_string(JCR *jcr, B_DB *db, char *snew, char *old, int len)
 311 {
 312    char *n, *o;
 313
 314    n = snew;
 315    o = old;
 316    while (len--) {
 317       switch (*o) {
 318       case '\'':
 319          *n++ = '\'';
 320          *n++ = '\'';
 321          o++;
 322          break;
 323       case 0:
 324          *n++ = '\\';
 325          *n++ = 0;
 326          o++;
 327          break;
 328       default:
 329          *n++ = *o++;
 330          break;
 331       }
 332    }
 333    *n = 0;
 334 }
 335
 336 struct rh_data {
 337    DB_RESULT_HANDLER *result_handler;
 338    void *ctx;
 339 };
 340
 341 /*
 342  * Convert SQLite's callback into Bacula DB callback
 343  */
 344 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
 345 {
 346    struct rh_data *rh_data = (struct rh_data *)arh_data;
 347
 348    if (rh_data->result_handler) {
 349       (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
 350    }
 351    return 0;
 352 }
 353
 354 /*
 355  * Submit a general SQL command (cmd), and for each row returned,
 356  *  the sqlite_handler is called with the ctx.
 357  */
 358 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 359 {
 360    struct rh_data rh_data;
 361    int stat;
 362
 363    db_lock(mdb);
 364    if (mdb->sqlite_errmsg) {
 365 #ifdef HAVE_SQLITE3
 366       sqlite3_free(mdb->sqlite_errmsg);
 367 #else
 368       actuallyfree(mdb->sqlite_errmsg);
 369 #endif
 370       mdb->sqlite_errmsg = NULL;
 371    }
 372    rh_data.result_handler = result_handler;
 373    rh_data.ctx = ctx;
 374    stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
 375    if (stat != SQLITE_OK) {
 376       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 377       db_unlock(mdb);
 378       return false;
 379    }
 380    db_unlock(mdb);
 381    return true;
 382 }
 383
 384 /*
 385  * Submit a sqlite query and retrieve all the data
 386  */
 387 int my_sqlite_query(B_DB *mdb, const char *cmd)
 388 {
 389    int stat;
 390
 391    my_sqlite_free_table(mdb);
 392    if (mdb->sqlite_errmsg) {
 393 #ifdef HAVE_SQLITE3
 394       sqlite3_free(mdb->sqlite_errmsg);
 395 #else
 396       actuallyfree(mdb->sqlite_errmsg);
 397 #endif
 398       mdb->sqlite_errmsg = NULL;
 399    }
 400    stat = sqlite_get_table(mdb->db, (char *)cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
 401             &mdb->sqlite_errmsg);
 402    mdb->row = 0;                      /* no row fetched yet */
 403    if (stat != 0) {                   /* something went wrong */
 404       mdb->nrow = mdb->ncolumn = 0;
 405    }
 406    return stat;
 407 }
 408
 409 /* Fetch one row at a time */
 410 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
 411 {
 412    if (!mdb->result || (mdb->row >= mdb->nrow)) {
 413       return NULL;
 414    }
 415    mdb->row++;
 416    return &mdb->result[mdb->ncolumn * mdb->row];
 417 }
 418
 419 void my_sqlite_free_table(B_DB *mdb)
 420 {
 421    int i;
 422
 423    if (mdb->fields_defined) {
 424       for (i=0; i < sql_num_fields(mdb); i++) {
 425          if (mdb->fields[i]) {
 426             free(mdb->fields[i]);
 427             mdb->fields[i] = NULL;
 428          }
 429       }
 430       if (mdb->fields) {
 431          free(mdb->fields);
 432          mdb->fields = NULL;
 433       }
 434       mdb->fields_defined = false;
 435    }
 436    if (mdb->result) {
 437       sqlite_free_table(mdb->result);
 438       mdb->result = NULL;
 439    }
 440    mdb->nrow = mdb->ncolumn = 0;
 441 }
 442
 443 void my_sqlite_field_seek(B_DB *mdb, int field)
 444 {
 445    int i, j;
 446    if (mdb->result == NULL) {
 447       mdb->field = 0;
 448       return;
 449    }
 450    /* On first call, set up the fields */
 451    if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
 452       mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
 453       for (i=0; i < sql_num_fields(mdb); i++) {
 454          mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
 455          if (mdb->result[i] == NULL) {
 456             mdb->fields_defined = false;
 457             free(mdb->fields);
 458             mdb->fields = NULL;
 459             mdb->field = 0;
 460             return;
 461          }
 462          mdb->fields[i]->name = mdb->result[i];
 463          mdb->fields[i]->length = cstrlen(mdb->fields[i]->name);
 464          mdb->fields[i]->max_length = mdb->fields[i]->length;
 465          for (j=1; j <= mdb->nrow; j++) {
 466             int len;
 467             if (mdb->result[i + mdb->ncolumn *j]) {
 468                len = (uint32_t)cstrlen(mdb->result[i + mdb->ncolumn * j]);
 469             } else {
 470                len = 0;
 471             }
 472             if (len > mdb->fields[i]->max_length) {
 473                mdb->fields[i]->max_length = len;
 474             }
 475          }
 476          mdb->fields[i]->type = 0;
 477          mdb->fields[i]->flags = 1;        /* not null */
 478       }
 479       mdb->fields_defined = true;
 480    }
 481    if (sql_num_fields(mdb) <= 0) {
 482       field = 0;
 483    } else if (field > sql_num_fields(mdb) - 1) {
 484       field = sql_num_fields(mdb) - 1;
 485     }
 486     mdb->field = field;
 487 }
 488
 489 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
 490 {
 491    if (mdb->fields_defined && mdb->field < sql_num_fields(mdb)) {
 492       return mdb->fields[mdb->field++];
 493    } else {
 494       mdb->field = 0;
 495       return NULL;
 496    }
 497 }
 498
 499 #ifdef HAVE_BATCH_FILE_INSERT
 500 const char *my_sqlite_batch_lock_query = "BEGIN";
 501 const char *my_sqlite_batch_unlock_query = "COMMIT";
 502
 503 const char *my_sqlite_batch_fill_path_query =
 504    "INSERT INTO Path (Path)"
 505    " SELECT DISTINCT Path FROM batch"
 506    " EXCEPT SELECT Path FROM Path";
 507
 508 const char *my_sqlite_batch_fill_filename_query =
 509    "INSERT INTO Filename (Name)"
 510    " SELECT DISTINCT Name FROM batch "
 511    " EXCEPT SELECT Name FROM Filename";
 512 #endif /* HAVE_BATCH_FILE_INSERT */
 513
 514
 515 #endif /* HAVE_SQLITE */