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