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