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 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 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(char *file, int line, 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(void *jcr, char *db_name, char *db_user, char *db_password)
  63 {
  64    B_DB *mdb;
  65
  66    P(mutex);                          /* lock DB queue */
  67    /* Look to see if DB already open */
  68    for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
  69       if (strcmp(mdb->db_name, db_name) == 0) {
  70          Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
  71          mdb->ref_count++;
  72          V(mutex);
  73          return mdb;                  /* already open */
  74       }
  75    }
  76    Dmsg0(100, "db_open first time\n");
  77    mdb = (B_DB *) malloc(sizeof(B_DB));
  78    memset(mdb, 0, sizeof(B_DB));
  79    mdb->db_name = bstrdup(db_name);
  80    mdb->have_insert_id = TRUE;
  81    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
  82    *mdb->errmsg = 0;
  83    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
  84    mdb->cached_path = get_pool_memory(PM_FNAME);
  85    mdb->cached_path_id = 0;
  86    mdb->ref_count = 1;
  87    qinsert(&db_list, &mdb->bq);            /* put db in list */
  88    mdb->jcr = jcr;
  89    V(mutex);
  90    return mdb;
  91 }
  92
  93 /*
  94  * Now actually open the database.  This can generate errors,
  95  * which are returned in the errmsg
  96  */
  97 int
  98 db_open_database(B_DB *mdb)
  99 {
 100    char *db_name;
 101    int len;
 102    struct stat statbuf;
 103
 104    P(mutex);
 105    if (mdb->connected) {
 106       V(mutex);
 107       return 1;
 108    }
 109    mdb->connected = FALSE;
 110
 111    if (rwl_init(&mdb->lock) != 0) {
 112       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"), strerror(errno));
 113       V(mutex);
 114       return 0;
 115    }
 116
 117    /* open the database */
 118    len = strlen(working_directory) + strlen(mdb->db_name) + 5;
 119    db_name = (char *)malloc(len);
 120    strcpy(db_name, working_directory);
 121    strcat(db_name, "/");
 122    strcat(db_name, mdb->db_name);
 123    strcat(db_name, ".db");
 124    if (stat(db_name, &statbuf) != 0) {
 125       Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
 126          db_name);
 127       free(db_name);
 128       V(mutex);
 129       return 0;
 130    }
 131    mdb->db = sqlite_open(
 132         db_name,                      /* database name */
 133         644,                          /* mode */
 134         &mdb->sqlite_errmsg);         /* error message */
 135
 136    Dmsg0(50, "sqlite_open\n");
 137
 138    if (mdb->db == NULL) {
 139       Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
 140          db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
 141       free(db_name);
 142       V(mutex);
 143       return 0;
 144    }
 145    free(db_name);
 146    if (!check_tables_version(mdb)) {
 147       V(mutex);
 148       return 0;
 149    }
 150
 151    mdb->connected = TRUE;
 152    V(mutex);
 153    return 1;
 154 }
 155
 156 void
 157 db_close_database(B_DB *mdb)
 158 {
 159    P(mutex);
 160    mdb->ref_count--;
 161    if (mdb->ref_count == 0) {
 162       qdchain(&mdb->bq);
 163       if (mdb->connected && mdb->db) {
 164          sqlite_close(mdb->db);
 165       }
 166       rwl_destroy(&mdb->lock);
 167       free_pool_memory(mdb->errmsg);
 168       free_pool_memory(mdb->cmd);
 169       free_pool_memory(mdb->cached_path);
 170       if (mdb->db_name) {
 171          free(mdb->db_name);
 172       }
 173       free(mdb);
 174    }
 175    V(mutex);
 176 }
 177
 178 /*
 179  * Return the next unique index (auto-increment) for
 180  * the given table.  Return 0 on error.
 181  */
 182 int db_next_index(B_DB *mdb, char *table, char *index)
 183 {
 184    SQL_ROW row;
 185
 186    db_lock(mdb);
 187
 188    Mmsg(&mdb->cmd,
 189 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
 190    if (!QUERY_DB(mdb, mdb->cmd)) {
 191       Mmsg(&mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
 192       db_unlock(mdb);
 193       return 0;
 194    }
 195    if ((row = sql_fetch_row(mdb)) == NULL) {
 196       Mmsg(&mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
 197       db_unlock(mdb);
 198       return 0;
 199    }
 200    strncpy(index, row[0], 28);
 201    index[28] = 0;
 202    sql_free_result(mdb);
 203
 204    Mmsg(&mdb->cmd,
 205 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
 206    if (!QUERY_DB(mdb, mdb->cmd)) {
 207       Mmsg(&mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
 208       db_unlock(mdb);
 209       return 0;
 210    }
 211    sql_free_result(mdb);
 212
 213    db_unlock(mdb);
 214    return 1;
 215 }
 216
 217
 218
 219 void
 220 db_escape_string(char *snew, char *old, int len)
 221 {
 222    char *n, *o;
 223
 224    n = snew;
 225    o = old;
 226    while (len--) {
 227       switch (*o) {
 228       case '\'':
 229          *n++ = '\'';
 230          *n++ = '\'';
 231          o++;
 232          break;
 233       case 0:
 234          *n++ = '\\';
 235          *n++ = 0;
 236          o++;
 237          break;
 238       default:
 239          *n++ = *o++;
 240          break;
 241       }
 242    }
 243    *n = 0;
 244 }
 245
 246 struct rh_data {
 247    DB_RESULT_HANDLER *result_handler;
 248    void *ctx;
 249 };
 250
 251 /*
 252  * Convert SQLite's callback into Bacula DB callback
 253  */
 254 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
 255 {
 256    struct rh_data *rh_data = (struct rh_data *)arh_data;
 257
 258    if (rh_data->result_handler) {
 259       (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
 260    }
 261    return 0;
 262 }
 263
 264 /*
 265  * Submit a general SQL command (cmd), and for each row returned,
 266  *  the sqlite_handler is called with the ctx.
 267  */
 268 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 269 {
 270    struct rh_data rh_data;
 271    int stat;
 272
 273    db_lock(mdb);
 274    if (mdb->sqlite_errmsg) {
 275       actuallyfree(mdb->sqlite_errmsg);
 276       mdb->sqlite_errmsg = NULL;
 277    }
 278    rh_data.result_handler = result_handler;
 279    rh_data.ctx = ctx;
 280    stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
 281    if (stat != 0) {
 282       Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 283       db_unlock(mdb);
 284       return 0;
 285    }
 286    db_unlock(mdb);
 287    return 1;
 288 }
 289
 290 /*
 291  * Submit a sqlite query and retrieve all the data
 292  */
 293 int my_sqlite_query(B_DB *mdb, char *cmd)
 294 {
 295    int stat;
 296
 297    if (mdb->sqlite_errmsg) {
 298       actuallyfree(mdb->sqlite_errmsg);
 299       mdb->sqlite_errmsg = NULL;
 300    }
 301    stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
 302             &mdb->sqlite_errmsg);
 303    mdb->row = 0;                      /* row fetched */
 304    return stat;
 305 }
 306
 307 /* Fetch one row at a time */
 308 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
 309 {
 310    if (mdb->row >= mdb->nrow) {
 311       return NULL;
 312    }
 313    mdb->row++;
 314    return &mdb->result[mdb->ncolumn * mdb->row];
 315 }
 316
 317 void my_sqlite_free_table(B_DB *mdb)
 318 {
 319    unsigned int i;
 320
 321    if (mdb->fields_defined) {
 322       for (i=0; i < sql_num_fields(mdb); i++) {
 323          free(mdb->fields[i]);
 324       }
 325       free(mdb->fields);
 326       mdb->fields_defined = FALSE;
 327    }
 328    sqlite_free_table(mdb->result);
 329    mdb->nrow = mdb->ncolumn = 0;
 330 }
 331
 332 void my_sqlite_field_seek(B_DB *mdb, int field)
 333 {
 334    unsigned int i, j;
 335    if (mdb->result == NULL) {
 336       return;
 337    }
 338    /* On first call, set up the fields */
 339    if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
 340       mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
 341       for (i=0; i < sql_num_fields(mdb); i++) {
 342          mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
 343          mdb->fields[i]->name = mdb->result[i];
 344          mdb->fields[i]->length = strlen(mdb->fields[i]->name);
 345          mdb->fields[i]->max_length = mdb->fields[i]->length;
 346          for (j=1; j <= (unsigned)mdb->nrow; j++) {
 347             uint32_t len;
 348             if (mdb->result[i + mdb->ncolumn *j]) {
 349                len = (uint32_t)strlen(mdb->result[i + mdb->ncolumn * j]);
 350             } else {
 351                len = 0;
 352             }
 353             if (len > mdb->fields[i]->max_length) {
 354                mdb->fields[i]->max_length = len;
 355             }
 356          }
 357          mdb->fields[i]->type = 0;
 358          mdb->fields[i]->flags = 1;        /* not null */
 359       }
 360       mdb->fields_defined = TRUE;
 361    }
 362    if (field > (int)sql_num_fields(mdb)) {
 363       field = (int)sql_num_fields(mdb);
 364     }
 365     mdb->field = field;
 366
 367 }
 368
 369 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
 370 {
 371    return mdb->fields[mdb->field++];
 372 }
 373
 374 static void
 375 list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
 376 {
 377    SQL_FIELD *field;
 378    unsigned int i, j;
 379
 380    sql_field_seek(mdb, 0);
 381    send(ctx, "+");
 382    for (i = 0; i < sql_num_fields(mdb); i++) {
 383       field = sql_fetch_field(mdb);
 384       for (j = 0; j < field->max_length + 2; j++)
 385               send(ctx, "-");
 386       send(ctx, "+");
 387    }
 388    send(ctx, "\n");
 389 }
 390
 391 void
 392 list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
 393 {
 394    SQL_FIELD *field;
 395    SQL_ROW row;
 396    unsigned int i, col_len;
 397    char buf[2000], ewc[30];
 398
 399    if (mdb->result == NULL || mdb->nrow == 0) {
 400       send(ctx, _("No results to list.\n"));
 401       return;
 402    }
 403    /* determine column display widths */
 404    sql_field_seek(mdb, 0);
 405    for (i = 0; i < sql_num_fields(mdb); i++) {
 406       field = sql_fetch_field(mdb);
 407       if (IS_NUM(field->type) && field->max_length > 0) { /* fixup for commas */
 408          field->max_length += (field->max_length - 1) / 3;
 409       }
 410       col_len = strlen(field->name);
 411       if (col_len < field->max_length)
 412               col_len = field->max_length;
 413       if (col_len < 4 && !IS_NOT_NULL(field->flags))
 414               col_len = 4;    /* 4 = length of the word "NULL" */
 415       field->max_length = col_len;    /* reset column info */
 416    }
 417
 418    list_dashes(mdb, send, ctx);
 419    send(ctx, "|");
 420    sql_field_seek(mdb, 0);
 421    for (i = 0; i < sql_num_fields(mdb); i++) {
 422       field = sql_fetch_field(mdb);
 423       sprintf(buf, " %-*s |", field->max_length, field->name);
 424       send(ctx, buf);
 425    }
 426    send(ctx, "\n");
 427    list_dashes(mdb, send, ctx);
 428
 429    while ((row = sql_fetch_row(mdb)) != NULL) {
 430       sql_field_seek(mdb, 0);
 431       send(ctx, "|");
 432       for (i = 0; i < sql_num_fields(mdb); i++) {
 433          field = sql_fetch_field(mdb);
 434          if (row[i] == NULL) {
 435             sprintf(buf, " %-*s |", field->max_length, "NULL");
 436          } else if (IS_NUM(field->type)) {
 437             sprintf(buf, " %*s |", field->max_length,
 438                add_commas(row[i], ewc));
 439          } else {
 440             sprintf(buf, " %-*s |", field->max_length, row[i]);
 441          }
 442          send(ctx, buf);
 443       }
 444       send(ctx, "\n");
 445    }
 446    list_dashes(mdb, send, ctx);
 447 }
 448
 449
 450 #endif /* HAVE_SQLITE */