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

   1 /*
   2  * Bacula Catalog Database interface routines
   3  *
   4  *     Almost generic set of SQL database interface routines
   5  *      (with a little more work)
   6  *
   7  *    Kern Sibbald, March 2000
   8  *
   9  *    Version $Id$
  10  */
  11
  12 /*
  13    Copyright (C) 2000-2005 Kern Sibbald
  14
  15    This program is free software; you can redistribute it and/or
  16    modify it under the terms of the GNU General Public License as
  17    published by the Free Software Foundation; either version 2 of
  18    the License, or (at your option) any later version.
  19
  20    This program is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  23    General Public License for more details.
  24
  25    You should have received a copy of the GNU General Public
  26    License along with this program; if not, write to the Free
  27    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  28    MA 02111-1307, USA.
  29
  30  */
  31
  32 /* The following is necessary so that we do not include
  33  * the dummy external definition of B_DB.
  34  */
  35 #define __SQL_C                       /* indicate that this is sql.c */
  36
  37 #include "bacula.h"
  38 #include "cats.h"
  39
  40 #if    HAVE_SQLITE3 || HAVE_MYSQL || HAVE_SQLITE || HAVE_POSTGRESQL
  41
  42 uint32_t bacula_db_version = 0;
  43
  44 /* Forward referenced subroutines */
  45 void print_dashes(B_DB *mdb);
  46 void print_result(B_DB *mdb);
  47
  48 /*
  49  * Called here to retrieve an integer from the database
  50  */
  51 static int int_handler(void *ctx, int num_fields, char **row)
  52 {
  53    uint32_t *val = (uint32_t *)ctx;
  54
  55    Dmsg1(800, "int_handler starts with row pointing at %x\n", row);
  56
  57    if (row[0]) {
  58       Dmsg1(800, "int_handler finds '%s'\n", row[0]);
  59       *val = atoi(row[0]);
  60    } else {
  61       Dmsg0(800, "int_handler finds zero\n");
  62       *val = 0;
  63    }
  64    Dmsg0(800, "int_handler finishes\n");
  65    return 0;
  66 }
  67
  68
  69
  70 /* NOTE!!! The following routines expect that the
  71  *  calling subroutine sets and clears the mutex
  72  */
  73
  74 /* Check that the tables correspond to the version we want */
  75 int check_tables_version(JCR *jcr, B_DB *mdb)
  76 {
  77    const char *query = "SELECT VersionId FROM Version";
  78
  79    bacula_db_version = 0;
  80    db_sql_query(mdb, query, int_handler, (void *)&bacula_db_version);
  81    if (bacula_db_version != BDB_VERSION) {
  82       Mmsg(mdb->errmsg, "Version error for database \"%s\". Wanted %d, got %d\n",
  83           mdb->db_name, BDB_VERSION, bacula_db_version);
  84       Jmsg(jcr, M_FATAL, 0, "%s", mdb->errmsg);
  85       return 0;
  86    }
  87    return 1;
  88 }
  89
  90 /* Utility routine for queries. The database MUST be locked before calling here. */
  91 int
  92 QueryDB(const char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
  93 {
  94    int status;
  95    if ((status=sql_query(mdb, cmd)) != 0) {
  96       m_msg(file, line, &mdb->errmsg, _("query %s failed:\n%s\n"), cmd, sql_strerror(mdb));
  97       j_msg(file, line, jcr, M_FATAL, 0, "%s", mdb->errmsg);
  98       if (verbose) {
  99          j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 100       }
 101       return 0;
 102    }
 103
 104    mdb->result = sql_store_result(mdb);
 105
 106    return mdb->result != NULL;
 107 }
 108
 109 /*
 110  * Utility routine to do inserts
 111  * Returns: 0 on failure
 112  *          1 on success
 113  */
 114 int
 115 InsertDB(const char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
 116 {
 117    if (sql_query(mdb, cmd)) {
 118       m_msg(file, line, &mdb->errmsg,  _("insert %s failed:\n%s\n"), cmd, sql_strerror(mdb));
 119       j_msg(file, line, jcr, M_FATAL, 0, "%s", mdb->errmsg);
 120       if (verbose) {
 121          j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 122       }
 123       return 0;
 124    }
 125    if (mdb->have_insert_id) {
 126       mdb->num_rows = sql_affected_rows(mdb);
 127    } else {
 128       mdb->num_rows = 1;
 129    }
 130    if (mdb->num_rows != 1) {
 131       char ed1[30];
 132       m_msg(file, line, &mdb->errmsg, _("Insertion problem: affected_rows=%s\n"),
 133          edit_uint64(mdb->num_rows, ed1));
 134       if (verbose) {
 135          j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 136       }
 137       return 0;
 138    }
 139    mdb->changes++;
 140    return 1;
 141 }
 142
 143 /* Utility routine for updates.
 144  *  Returns: 0 on failure
 145  *           1 on success
 146  */
 147 int
 148 UpdateDB(const char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
 149 {
 150
 151    if (sql_query(mdb, cmd)) {
 152       m_msg(file, line, &mdb->errmsg, _("update %s failed:\n%s\n"), cmd, sql_strerror(mdb));
 153       j_msg(file, line, jcr, M_ERROR, 0, "%s", mdb->errmsg);
 154       if (verbose) {
 155          j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 156       }
 157       return 0;
 158    }
 159    mdb->num_rows = sql_affected_rows(mdb);
 160    if (mdb->num_rows < 1) {
 161       char ed1[30];
 162       m_msg(file, line, &mdb->errmsg, _("Update problem: affected_rows=%s\n"),
 163          edit_uint64(mdb->num_rows, ed1));
 164       if (verbose) {
 165 //       j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 166       }
 167       return 0;
 168    }
 169    mdb->changes++;
 170    return 1;
 171 }
 172
 173 /* Utility routine for deletes
 174  *
 175  * Returns: -1 on error
 176  *           n number of rows affected
 177  */
 178 int
 179 DeleteDB(const char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
 180 {
 181
 182    if (sql_query(mdb, cmd)) {
 183       m_msg(file, line, &mdb->errmsg, _("delete %s failed:\n%s\n"), cmd, sql_strerror(mdb));
 184       j_msg(file, line, jcr, M_ERROR, 0, "%s", mdb->errmsg);
 185       if (verbose) {
 186          j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
 187       }
 188       return -1;
 189    }
 190    mdb->changes++;
 191    return sql_affected_rows(mdb);
 192 }
 193
 194
 195 /*
 196  * Get record max. Query is already in mdb->cmd
 197  *  No locking done
 198  *
 199  * Returns: -1 on failure
 200  *          count on success
 201  */
 202 int get_sql_record_max(JCR *jcr, B_DB *mdb)
 203 {
 204    SQL_ROW row;
 205    int stat = 0;
 206
 207    if (QUERY_DB(jcr, mdb, mdb->cmd)) {
 208       if ((row = sql_fetch_row(mdb)) == NULL) {
 209          Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
 210          stat = -1;
 211       } else {
 212          stat = atoi(row[0]);
 213       }
 214       sql_free_result(mdb);
 215    } else {
 216       Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
 217       stat = -1;
 218    }
 219    return stat;
 220 }
 221
 222 /*
 223  * Return pre-edited error message
 224  */
 225 char *db_strerror(B_DB *mdb)
 226 {
 227    return mdb->errmsg;
 228 }
 229
 230 /*
 231  * Lock database, this can be called multiple times by the same
 232  *   thread without blocking, but must be unlocked the number of
 233  *   times it was locked.
 234  */
 235 void _db_lock(const char *file, int line, B_DB *mdb)
 236 {
 237    int errstat;
 238    if ((errstat=rwl_writelock(&mdb->lock)) != 0) {
 239       berrno be;
 240       e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
 241            be.strerror(errstat));
 242    }
 243 }
 244
 245 /*
 246  * Unlock the database. This can be called multiple times by the
 247  *   same thread up to the number of times that thread called
 248  *   db_lock()/
 249  */
 250 void _db_unlock(const char *file, int line, B_DB *mdb)
 251 {
 252    int errstat;
 253    if ((errstat=rwl_writeunlock(&mdb->lock)) != 0) {
 254       berrno be;
 255       e_msg(file, line, M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
 256            be.strerror(errstat));
 257    }
 258 }
 259
 260 /*
 261  * Start a transaction. This groups inserts and makes things
 262  *  much more efficient. Usually started when inserting
 263  *  file attributes.
 264  */
 265 void db_start_transaction(JCR *jcr, B_DB *mdb)
 266 {
 267 #ifdef HAVE_SQLITE
 268    if (!mdb->allow_transactions) {
 269       return;
 270    }
 271    db_lock(mdb);
 272    /* Allow only 10,000 changes per transaction */
 273    if (mdb->transaction && mdb->changes > 10000) {
 274       db_end_transaction(jcr, mdb);
 275    }
 276    if (!mdb->transaction) {
 277       my_sqlite_query(mdb, "BEGIN");  /* begin transaction */
 278       Dmsg0(400, "Start SQLite transaction\n");
 279       mdb->transaction = 1;
 280    }
 281    db_unlock(mdb);
 282 #endif
 283
 284 /*
 285  * This is turned off because transactions break
 286  * if multiple simultaneous jobs are run.
 287  */
 288 #ifdef HAVE_POSTGRESQL
 289    if (!mdb->allow_transactions) {
 290       return;
 291    }
 292    db_lock(mdb);
 293    /* Allow only 25,000 changes per transaction */
 294    if (mdb->transaction && mdb->changes > 25000) {
 295       db_end_transaction(jcr, mdb);
 296    }
 297    if (!mdb->transaction) {
 298       db_sql_query(mdb, "BEGIN", NULL, NULL);  /* begin transaction */
 299       Dmsg0(400, "Start PosgreSQL transaction\n");
 300       mdb->transaction = 1;
 301    }
 302    db_unlock(mdb);
 303 #endif
 304 }
 305
 306 void db_end_transaction(JCR *jcr, B_DB *mdb)
 307 {
 308    /*
 309     * This can be called during thread cleanup and
 310     *   the db may already be closed.  So simply return.
 311     */
 312    if (!mdb) {
 313       return;
 314    }
 315 #ifdef HAVE_SQLITE
 316    if (!mdb->allow_transactions) {
 317       return;
 318    }
 319    db_lock(mdb);
 320    if (mdb->transaction) {
 321       my_sqlite_query(mdb, "COMMIT"); /* end transaction */
 322       mdb->transaction = 0;
 323       Dmsg1(400, "End SQLite transaction changes=%d\n", mdb->changes);
 324    }
 325    mdb->changes = 0;
 326    db_unlock(mdb);
 327 #endif
 328
 329 #ifdef HAVE_POSTGRESQL
 330    if (!mdb->allow_transactions) {
 331       return;
 332    }
 333    db_lock(mdb);
 334    if (mdb->transaction) {
 335       db_sql_query(mdb, "COMMIT", NULL, NULL); /* end transaction */
 336       mdb->transaction = 0;
 337       Dmsg1(400, "End PostgreSQL transaction changes=%d\n", mdb->changes);
 338    }
 339    mdb->changes = 0;
 340    db_unlock(mdb);
 341 #endif
 342 }
 343
 344 /*
 345  * Given a full filename, split it into its path
 346  *  and filename parts. They are returned in pool memory
 347  *  in the mdb structure.
 348  */
 349 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname)
 350 {
 351    const char *p, *f;
 352
 353    /* Find path without the filename.
 354     * I.e. everything after the last / is a "filename".
 355     * OK, maybe it is a directory name, but we treat it like
 356     * a filename. If we don't find a / then the whole name
 357     * must be a path name (e.g. c:).
 358     */
 359    for (p=f=fname; *p; p++) {
 360       if (*p == '/') {
 361          f = p;                       /* set pos of last slash */
 362       }
 363    }
 364    if (*f == '/') {                   /* did we find a slash? */
 365       f++;                            /* yes, point to filename */
 366    } else {                           /* no, whole thing must be path name */
 367       f = p;
 368    }
 369
 370    /* If filename doesn't exist (i.e. root directory), we
 371     * simply create a blank name consisting of a single
 372     * space. This makes handling zero length filenames
 373     * easier.
 374     */
 375    mdb->fnl = p - f;
 376    if (mdb->fnl > 0) {
 377       mdb->fname = check_pool_memory_size(mdb->fname, mdb->fnl+1);
 378       memcpy(mdb->fname, f, mdb->fnl);    /* copy filename */
 379       mdb->fname[mdb->fnl] = 0;
 380    } else {
 381       mdb->fname[0] = 0;
 382       mdb->fnl = 0;
 383    }
 384
 385    mdb->pnl = f - fname;
 386    if (mdb->pnl > 0) {
 387       mdb->path = check_pool_memory_size(mdb->path, mdb->pnl+1);
 388       memcpy(mdb->path, fname, mdb->pnl);
 389       mdb->path[mdb->pnl] = 0;
 390    } else {
 391       Mmsg1(&mdb->errmsg, _("Path length is zero. File=%s\n"), fname);
 392       Jmsg(jcr, M_ERROR, 0, "%s", mdb->errmsg);
 393       mdb->path[0] = 0;
 394       mdb->pnl = 0;
 395    }
 396
 397    Dmsg2(500, "split path=%s file=%s\n", mdb->path, mdb->fname);
 398 }
 399
 400 /*
 401  * List dashes as part of header for listing SQL results in a table
 402  */
 403 void
 404 list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
 405 {
 406    SQL_FIELD  *field;
 407    int i, j;
 408
 409    sql_field_seek(mdb, 0);
 410    send(ctx, "+");
 411    for (i = 0; i < sql_num_fields(mdb); i++) {
 412       field = sql_fetch_field(mdb);
 413       for (j = 0; j < (int)field->max_length + 2; j++) {
 414          send(ctx, "-");
 415       }
 416       send(ctx, "+");
 417    }
 418    send(ctx, "\n");
 419 }
 420
 421 /*
 422  * If full_list is set, we list vertically, otherwise, we
 423  * list on one line horizontally.
 424  */
 425 void
 426 list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type)
 427 {
 428    SQL_FIELD *field;
 429    SQL_ROW row;
 430    int i, col_len, max_len = 0;
 431    char buf[2000], ewc[30];
 432
 433    Dmsg0(800, "list_result starts\n");
 434    if (mdb->result == NULL || sql_num_rows(mdb) == 0) {
 435       send(ctx, _("No results to list.\n"));
 436       return;
 437    }
 438
 439    Dmsg1(800, "list_result starts looking at %d fields\n", sql_num_fields(mdb));
 440    /* determine column display widths */
 441    sql_field_seek(mdb, 0);
 442    for (i = 0; i < sql_num_fields(mdb); i++) {
 443       Dmsg1(800, "list_result processing field %d\n", i);
 444       field = sql_fetch_field(mdb);
 445       col_len = strlen(field->name);
 446       if (type == VERT_LIST) {
 447          if (col_len > max_len) {
 448             max_len = col_len;
 449          }
 450       } else {
 451          if (IS_NUM(field->type) && (int)field->max_length > 0) { /* fixup for commas */
 452             field->max_length += (field->max_length - 1) / 3;
 453          }
 454          if (col_len < (int)field->max_length) {
 455             col_len = field->max_length;
 456          }
 457          if (col_len < 4 && !IS_NOT_NULL(field->flags)) {
 458             col_len = 4;                 /* 4 = length of the word "NULL" */
 459          }
 460          field->max_length = col_len;    /* reset column info */
 461       }
 462    }
 463
 464    Dmsg0(800, "list_result finished first loop\n");
 465    if (type == VERT_LIST) {
 466       goto vertical_list;
 467    }
 468
 469    Dmsg1(800, "list_result starts second loop looking at %d fields\n", sql_num_fields(mdb));
 470    list_dashes(mdb, send, ctx);
 471    send(ctx, "|");
 472    sql_field_seek(mdb, 0);
 473    for (i = 0; i < sql_num_fields(mdb); i++) {
 474       Dmsg1(800, "list_result looking at field %d\n", i);
 475       field = sql_fetch_field(mdb);
 476       bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, field->name);
 477       send(ctx, buf);
 478    }
 479    send(ctx, "\n");
 480    list_dashes(mdb, send, ctx);
 481
 482    Dmsg1(800, "list_result starts third loop looking at %d fields\n", sql_num_fields(mdb));
 483    while ((row = sql_fetch_row(mdb)) != NULL) {
 484       sql_field_seek(mdb, 0);
 485       send(ctx, "|");
 486       for (i = 0; i < sql_num_fields(mdb); i++) {
 487          field = sql_fetch_field(mdb);
 488          if (row[i] == NULL) {
 489             bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, "NULL");
 490          } else if (IS_NUM(field->type) && !jcr->gui && is_an_integer(row[i])) {
 491             bsnprintf(buf, sizeof(buf), " %*s |", (int)field->max_length,
 492                       add_commas(row[i], ewc));
 493          } else {
 494             bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, row[i]);
 495          }
 496          send(ctx, buf);
 497       }
 498       send(ctx, "\n");
 499    }
 500    list_dashes(mdb, send, ctx);
 501    return;
 502
 503 vertical_list:
 504
 505    Dmsg1(800, "list_result starts vertical list at %d fields\n", sql_num_fields(mdb));
 506    while ((row = sql_fetch_row(mdb)) != NULL) {
 507       sql_field_seek(mdb, 0);
 508       for (i = 0; i < sql_num_fields(mdb); i++) {
 509          field = sql_fetch_field(mdb);
 510          if (row[i] == NULL) {
 511             bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name, "NULL");
 512          } else if (IS_NUM(field->type) && !jcr->gui && is_an_integer(row[i])) {
 513             bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name,
 514                 add_commas(row[i], ewc));
 515          } else {
 516             bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name, row[i]);
 517          }
 518          send(ctx, buf);
 519       }
 520       send(ctx, "\n");
 521    }
 522    return;
 523 }
 524
 525
 526 #endif /* HAVE_SQLITE3 || HAVE_MYSQL || HAVE_SQLITE || HAVE_POSTGRESQL*/