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

   1 /*
   2  * Bacula Catalog Database routines specific to SQLite
   3  *
   4  *    Kern Sibbald, January 2002
   5  *
   6  *    Version $Id$
   7  */
   8
   9 /*
  10    Copyright (C) 2002-2004 Kern Sibbald and John Walker
  11
  12    This program is free software; you can redistribute it and/or
  13    modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation; either version 2 of
  15    the License, or (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20    General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public
  23    License along with this program; if not, write to the Free
  24    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29
  30 /* The following is necessary so that we do not include
  31  * the dummy external definition of DB.
  32  */
  33 #define __SQL_C                       /* indicate that this is sql.c */
  34
  35 #include "bacula.h"
  36 #include "cats.h"
  37
  38 #ifdef HAVE_SQLITE
  39
  40 /* -----------------------------------------------------------------------
  41  *
  42  *    SQLite dependent defines and subroutines
  43  *
  44  * -----------------------------------------------------------------------
  45  */
  46
  47 extern const char *working_directory;
  48
  49 /* List of open databases */
  50 static BQUEUE db_list = {&db_list, &db_list};
  51
  52 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  53
  54 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
  55
  56
  57 /*
  58  * Initialize database data structure. In principal this should
  59  * never have errors, or it is really fatal.
  60  */
  61 B_DB *
  62 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
  63                  const char *db_address, int db_port, const char *db_socket,
  64                  int mult_db_connections)
  65 {
  66    B_DB *mdb;
  67
  68    P(mutex);                          /* lock DB queue */
  69    /* Look to see if DB already open */
  70    if (!mult_db_connections) {
  71       for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
  72          if (strcmp(mdb->db_name, db_name) == 0) {
  73             Dmsg2(300, "DB REopen %d %s\n", mdb->ref_count, db_name);
  74             mdb->ref_count++;
  75             V(mutex);
  76             return mdb;                  /* already open */
  77          }
  78       }
  79    }
  80    Dmsg0(300, "db_open first time\n");
  81    mdb = (B_DB *) malloc(sizeof(B_DB));
  82    memset(mdb, 0, sizeof(B_DB));
  83    mdb->db_name = bstrdup(db_name);
  84    mdb->have_insert_id = TRUE;
  85    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
  86    *mdb->errmsg = 0;
  87    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
  88    mdb->cached_path = get_pool_memory(PM_FNAME);
  89    mdb->cached_path_id = 0;
  90    mdb->ref_count = 1;
  91    mdb->fname = get_pool_memory(PM_FNAME);
  92    mdb->path = get_pool_memory(PM_FNAME);
  93    mdb->esc_name = get_pool_memory(PM_FNAME);
  94    qinsert(&db_list, &mdb->bq);            /* put db in list */
  95    V(mutex);
  96    return mdb;
  97 }
  98
  99 /*
 100  * Now actually open the database.  This can generate errors,
 101  * which are returned in the errmsg
 102  *
 103  * DO NOT close the database or free(mdb) here !!!!
 104  */
 105 int
 106 db_open_database(JCR *jcr, B_DB *mdb)
 107 {
 108    char *db_name;
 109    int len;
 110    struct stat statbuf;
 111    int errstat;
 112
 113    P(mutex);
 114    if (mdb->connected) {
 115       V(mutex);
 116       return 1;
 117    }
 118    mdb->connected = FALSE;
 119
 120    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 121       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 122             strerror(errstat));
 123       V(mutex);
 124       return 0;
 125    }
 126
 127    /* open the database */
 128    len = strlen(working_directory) + strlen(mdb->db_name) + 5;
 129    db_name = (char *)malloc(len);
 130    strcpy(db_name, working_directory);
 131    strcat(db_name, "/");
 132    strcat(db_name, mdb->db_name);
 133    strcat(db_name, ".db");
 134    if (stat(db_name, &statbuf) != 0) {
 135       Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
 136          db_name);
 137       free(db_name);
 138       V(mutex);
 139       return 0;
 140    }
 141    mdb->db = sqlite_open(
 142         db_name,                      /* database name */
 143         644,                          /* mode */
 144         &mdb->sqlite_errmsg);         /* error message */
 145
 146    Dmsg0(300, "sqlite_open\n");
 147
 148    if (mdb->db == NULL) {
 149       Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
 150          db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
 151       free(db_name);
 152       V(mutex);
 153       return 0;
 154    }
 155    free(db_name);
 156    if (!check_tables_version(jcr, mdb)) {
 157       V(mutex);
 158       return 0;
 159    }
 160
 161    mdb->connected = TRUE;
 162    V(mutex);
 163    return 1;
 164 }
 165
 166 void
 167 db_close_database(JCR *jcr, B_DB *mdb)
 168 {
 169    if (!mdb) {
 170       return;
 171    }
 172    P(mutex);
 173    mdb->ref_count--;
 174    if (mdb->ref_count == 0) {
 175       qdchain(&mdb->bq);
 176       if (mdb->connected && mdb->db) {
 177          sqlite_close(mdb->db);
 178       }
 179       rwl_destroy(&mdb->lock);
 180       free_pool_memory(mdb->errmsg);
 181       free_pool_memory(mdb->cmd);
 182       free_pool_memory(mdb->cached_path);
 183       free_pool_memory(mdb->fname);
 184       free_pool_memory(mdb->path);
 185       free_pool_memory(mdb->esc_name);
 186       if (mdb->db_name) {
 187          free(mdb->db_name);
 188       }
 189       free(mdb);
 190    }
 191    V(mutex);
 192 }
 193
 194 /*
 195  * Return the next unique index (auto-increment) for
 196  * the given table.  Return 0 on error.
 197  */
 198 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 199 {
 200    SQL_ROW row;
 201
 202    db_lock(mdb);
 203
 204    Mmsg(mdb->cmd,
 205 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
 206    if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
 207       Mmsg(mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
 208       db_unlock(mdb);
 209       return 0;
 210    }
 211    if ((row = sql_fetch_row(mdb)) == NULL) {
 212       Mmsg(mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
 213       db_unlock(mdb);
 214       return 0;
 215    }
 216    bstrncpy(index, row[0], 28);
 217    sql_free_result(mdb);
 218
 219    Mmsg(mdb->cmd,
 220 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
 221    if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
 222       Mmsg(mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
 223       db_unlock(mdb);
 224       return 0;
 225    }
 226    sql_free_result(mdb);
 227
 228    db_unlock(mdb);
 229    return 1;
 230 }
 231
 232
 233 /*
 234  * Escape strings so that SQLite is happy
 235  *
 236  *   NOTE! len is the length of the old string. Your new
 237  *         string must be long enough (max 2*old+1) to hold
 238  *         the escaped output.
 239  */
 240 void
 241 db_escape_string(char *snew, char *old, int len)
 242 {
 243    char *n, *o;
 244
 245    n = snew;
 246    o = old;
 247    while (len--) {
 248       switch (*o) {
 249       case '\'':
 250          *n++ = '\'';
 251          *n++ = '\'';
 252          o++;
 253          break;
 254       case 0:
 255          *n++ = '\\';
 256          *n++ = 0;
 257          o++;
 258          break;
 259       default:
 260          *n++ = *o++;
 261          break;
 262       }
 263    }
 264    *n = 0;
 265 }
 266
 267 struct rh_data {
 268    DB_RESULT_HANDLER *result_handler;
 269    void *ctx;
 270 };
 271
 272 /*
 273  * Convert SQLite's callback into Bacula DB callback
 274  */
 275 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
 276 {
 277    struct rh_data *rh_data = (struct rh_data *)arh_data;
 278
 279    if (rh_data->result_handler) {
 280       (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
 281    }
 282    return 0;
 283 }
 284
 285 /*
 286  * Submit a general SQL command (cmd), and for each row returned,
 287  *  the sqlite_handler is called with the ctx.
 288  */
 289 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 290 {
 291    struct rh_data rh_data;
 292    int stat;
 293
 294    db_lock(mdb);
 295    if (mdb->sqlite_errmsg) {
 296       actuallyfree(mdb->sqlite_errmsg);
 297       mdb->sqlite_errmsg = NULL;
 298    }
 299    rh_data.result_handler = result_handler;
 300    rh_data.ctx = ctx;
 301    stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
 302    if (stat != 0) {
 303       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 304       db_unlock(mdb);
 305       return 0;
 306    }
 307    db_unlock(mdb);
 308    return 1;
 309 }
 310
 311 /*
 312  * Submit a sqlite query and retrieve all the data
 313  */
 314 int my_sqlite_query(B_DB *mdb, char *cmd)
 315 {
 316    int stat;
 317
 318    if (mdb->sqlite_errmsg) {
 319       actuallyfree(mdb->sqlite_errmsg);
 320       mdb->sqlite_errmsg = NULL;
 321    }
 322    stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
 323             &mdb->sqlite_errmsg);
 324    mdb->row = 0;                      /* row fetched */
 325    return stat;
 326 }
 327
 328 /* Fetch one row at a time */
 329 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
 330 {
 331    if (mdb->row >= mdb->nrow) {
 332       return NULL;
 333    }
 334    mdb->row++;
 335    return &mdb->result[mdb->ncolumn * mdb->row];
 336 }
 337
 338 void my_sqlite_free_table(B_DB *mdb)
 339 {
 340    int i;
 341
 342    if (mdb->fields_defined) {
 343       for (i=0; i < sql_num_fields(mdb); i++) {
 344          free(mdb->fields[i]);
 345       }
 346       free(mdb->fields);
 347       mdb->fields_defined = false;
 348    }
 349    sqlite_free_table(mdb->result);
 350    mdb->nrow = mdb->ncolumn = 0;
 351 }
 352
 353 void my_sqlite_field_seek(B_DB *mdb, int field)
 354 {
 355    int i, j;
 356    if (mdb->result == NULL) {
 357       return;
 358    }
 359    /* On first call, set up the fields */
 360    if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
 361       mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
 362       for (i=0; i < sql_num_fields(mdb); i++) {
 363          mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
 364          mdb->fields[i]->name = mdb->result[i];
 365          mdb->fields[i]->length = strlen(mdb->fields[i]->name);
 366          mdb->fields[i]->max_length = mdb->fields[i]->length;
 367          for (j=1; j <= mdb->nrow; j++) {
 368             int len;
 369             if (mdb->result[i + mdb->ncolumn *j]) {
 370                len = (uint32_t)strlen(mdb->result[i + mdb->ncolumn * j]);
 371             } else {
 372                len = 0;
 373             }
 374             if (len > mdb->fields[i]->max_length) {
 375                mdb->fields[i]->max_length = len;
 376             }
 377          }
 378          mdb->fields[i]->type = 0;
 379          mdb->fields[i]->flags = 1;        /* not null */
 380       }
 381       mdb->fields_defined = TRUE;
 382    }
 383    if (field > sql_num_fields(mdb)) {
 384       field = sql_num_fields(mdb);
 385     }
 386     mdb->field = field;
 387
 388 }
 389
 390 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
 391 {
 392    return mdb->fields[mdb->field++];
 393 }
 394
 395
 396
 397 #endif /* HAVE_SQLITE */