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-2003 Kern Sibbald and John Walker
  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_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(50, "int_handler starts with row pointing at %x\n", row);
  56
  57    if (row[0]) {
  58       Dmsg1(50, "int_handler finds '%s'\n", row[0]);
  59       *val = atoi(row[0]);
  60    } else {
  61       Dmsg0(50, "int_handler finds zero\n");
  62       *val = 0;
  63    }
  64    Dmsg0(50, "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    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(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(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(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(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 char *db_strerror(B_DB *mdb)
 223 {
 224    return mdb->errmsg;
 225 }
 226
 227 void _db_lock(char *file, int line, B_DB *mdb)
 228 {
 229    int errstat;
 230    if ((errstat=rwl_writelock(&mdb->lock)) != 0) {
 231       e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
 232            strerror(errstat));
 233    }
 234 }
 235
 236 void _db_unlock(char *file, int line, B_DB *mdb)
 237 {
 238    int errstat;
 239    if ((errstat=rwl_writeunlock(&mdb->lock)) != 0) {
 240       e_msg(file, line, M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
 241            strerror(errstat));
 242    }
 243 }
 244
 245 /*
 246  * Start a transaction. This groups inserts and makes things
 247  *  much more efficient. Usually started when inserting
 248  *  file attributes.
 249  */
 250 void db_start_transaction(JCR *jcr, B_DB *mdb)
 251 {
 252 #ifdef xAVE_SQLITE
 253    db_lock(mdb);
 254    /* Allow only 10,000 changes per transaction */
 255    if (mdb->transaction && mdb->changes > 10000) {
 256       db_end_transaction(jcr, mdb);
 257    }
 258    if (!mdb->transaction) {
 259       my_sqlite_query(mdb, "BEGIN");  /* begin transaction */
 260       Dmsg0(400, "Start SQLite transaction\n");
 261       mdb->transaction = 1;
 262    }
 263    db_unlock(mdb);
 264 #endif
 265
 266 }
 267
 268 void db_end_transaction(JCR *jcr, B_DB *mdb)
 269 {
 270 #ifdef xAVE_SQLITE
 271    db_lock(mdb);
 272    if (mdb->transaction) {
 273       my_sqlite_query(mdb, "COMMIT"); /* end transaction */
 274       mdb->transaction = 0;
 275       Dmsg1(400, "End SQLite transaction changes=%d\n", mdb->changes);
 276    }
 277    mdb->changes = 0;
 278    db_unlock(mdb);
 279 #endif
 280 }
 281
 282 /*
 283  * Given a full filename, split it into its path
 284  *  and filename parts. They are returned in pool memory
 285  *  in the mdb structure.
 286  */
 287 void split_path_and_filename(JCR *jcr, B_DB *mdb, char *fname)
 288 {
 289    char *p, *f;
 290
 291    /* Find path without the filename.
 292     * I.e. everything after the last / is a "filename".
 293     * OK, maybe it is a directory name, but we treat it like
 294     * a filename. If we don't find a / then the whole name
 295     * must be a path name (e.g. c:).
 296     */
 297    for (p=f=fname; *p; p++) {
 298       if (*p == '/') {
 299          f = p;                       /* set pos of last slash */
 300       }
 301    }
 302    if (*f == '/') {                   /* did we find a slash? */
 303       f++;                            /* yes, point to filename */
 304    } else {                           /* no, whole thing must be path name */
 305       f = p;
 306    }
 307
 308    /* If filename doesn't exist (i.e. root directory), we
 309     * simply create a blank name consisting of a single
 310     * space. This makes handling zero length filenames
 311     * easier.
 312     */
 313    mdb->fnl = p - f;
 314    if (mdb->fnl > 0) {
 315       mdb->fname = check_pool_memory_size(mdb->fname, mdb->fnl+1);
 316       memcpy(mdb->fname, f, mdb->fnl);    /* copy filename */
 317       mdb->fname[mdb->fnl] = 0;
 318    } else {
 319       mdb->fname[0] = ' ';            /* blank filename */
 320       mdb->fname[1] = 0;
 321       mdb->fnl = 1;
 322    }
 323
 324    mdb->pnl = f - fname;
 325    if (mdb->pnl > 0) {
 326       mdb->path = check_pool_memory_size(mdb->path, mdb->pnl+1);
 327       memcpy(mdb->path, fname, mdb->pnl);
 328       mdb->path[mdb->pnl] = 0;
 329    } else {
 330       Mmsg1(&mdb->errmsg, _("Path length is zero. File=%s\n"), fname);
 331       Jmsg(jcr, M_ERROR, 0, "%s", mdb->errmsg);
 332       mdb->path[0] = ' ';
 333       mdb->path[1] = 0;
 334       mdb->pnl = 1;
 335    }
 336
 337    Dmsg2(100, "sllit path=%s file=%s\n", mdb->path, mdb->fname);
 338 }
 339
 340 #endif /* HAVE_MYSQL || HAVE_SQLITE || HAVE_POSTGRESQL */