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

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  * Bacula Catalog Database routines specific to MySQL
  30  *   These are MySQL specific routines -- hopefully all
  31  *    other files are generic.
  32  *
  33  *    Kern Sibbald, March 2000
  34  *
  35  *    Version $Id$
  36  */
  37
  38
  39 /* The following is necessary so that we do not include
  40  * the dummy external definition of DB.
  41  */
  42 #define __SQL_C                       /* indicate that this is sql.c */
  43
  44 #include "bacula.h"
  45 #include "cats.h"
  46
  47 #ifdef HAVE_MYSQL
  48
  49 /* -----------------------------------------------------------------------
  50  *
  51  *   MySQL dependent defines and subroutines
  52  *
  53  * -----------------------------------------------------------------------
  54  */
  55
  56 /* List of open databases */
  57 static BQUEUE db_list = {&db_list, &db_list};
  58
  59 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  60
  61 /*
  62  * Retrieve database type
  63  */
  64 const char *
  65 db_get_type(void)
  66 {
  67    return "MySQL";
  68 }
  69
  70 /*
  71  * Initialize database data structure. In principal this should
  72  * never have errors, or it is really fatal.
  73  */
  74 B_DB *
  75 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
  76                  const char *db_address, int db_port, const char *db_socket,
  77                  int mult_db_connections)
  78 {
  79    B_DB *mdb;
  80
  81    if (!db_user) {
  82       Jmsg(jcr, M_FATAL, 0, _("A user name for MySQL must be supplied.\n"));
  83       return NULL;
  84    }
  85    P(mutex);                          /* lock DB queue */
  86    /* Look to see if DB already open */
  87    if (!mult_db_connections) {
  88       for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
  89          if (bstrcmp(mdb->db_name, db_name) &&
  90              bstrcmp(mdb->db_address, db_address) &&
  91              mdb->db_port == db_port) {
  92             Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
  93             mdb->ref_count++;
  94             V(mutex);
  95             Dmsg3(100, "initdb ref=%d connected=%d db=%p\n", mdb->ref_count,
  96                   mdb->connected, mdb->db);
  97             return mdb;                  /* already open */
  98          }
  99       }
 100    }
 101    Dmsg0(100, "db_open first time\n");
 102    mdb = (B_DB *)malloc(sizeof(B_DB));
 103    memset(mdb, 0, sizeof(B_DB));
 104    mdb->db_name = bstrdup(db_name);
 105    mdb->db_user = bstrdup(db_user);
 106    if (db_password) {
 107       mdb->db_password = bstrdup(db_password);
 108    }
 109    if (db_address) {
 110       mdb->db_address = bstrdup(db_address);
 111    }
 112    if (db_socket) {
 113       mdb->db_socket = bstrdup(db_socket);
 114    }
 115    mdb->db_port = db_port;
 116    mdb->have_insert_id = true;
 117    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
 118    *mdb->errmsg = 0;
 119    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
 120    mdb->cached_path = get_pool_memory(PM_FNAME);
 121    mdb->cached_path_id = 0;
 122    mdb->ref_count = 1;
 123    mdb->fname = get_pool_memory(PM_FNAME);
 124    mdb->path = get_pool_memory(PM_FNAME);
 125    mdb->esc_name = get_pool_memory(PM_FNAME);
 126    mdb->esc_path = get_pool_memory(PM_FNAME);
 127    qinsert(&db_list, &mdb->bq);            /* put db in list */
 128    Dmsg3(100, "initdb ref=%d connected=%d db=%p\n", mdb->ref_count,
 129          mdb->connected, mdb->db);
 130    V(mutex);
 131    return mdb;
 132 }
 133
 134 /*
 135  * Now actually open the database.  This can generate errors,
 136  *  which are returned in the errmsg
 137  *
 138  * DO NOT close the database or free(mdb) here !!!!
 139  */
 140 int
 141 db_open_database(JCR *jcr, B_DB *mdb)
 142 {
 143    int errstat;
 144
 145    P(mutex);
 146    if (mdb->connected) {
 147       V(mutex);
 148       return 1;
 149    }
 150
 151    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 152       berrno be;
 153       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 154             be.bstrerror(errstat));
 155       V(mutex);
 156       return 0;
 157    }
 158
 159    /* connect to the database */
 160 #ifdef xHAVE_EMBEDDED_MYSQL
 161 // mysql_server_init(0, NULL, NULL);
 162 #endif
 163    mysql_init(&mdb->mysql);
 164
 165    Dmsg0(50, "mysql_init done\n");
 166    /* If connection fails, try at 5 sec intervals for 30 seconds. */
 167    for (int retry=0; retry < 6; retry++) {
 168       mdb->db = mysql_real_connect(
 169            &(mdb->mysql),                /* db */
 170            mdb->db_address,              /* default = localhost */
 171            mdb->db_user,                 /*  login name */
 172            mdb->db_password,             /*  password */
 173            mdb->db_name,                 /* database name */
 174            mdb->db_port,                 /* default port */
 175            mdb->db_socket,               /* default = socket */
 176            CLIENT_FOUND_ROWS);           /* flags */
 177
 178       /* If no connect, try once more in case it is a timing problem */
 179       if (mdb->db != NULL) {
 180          break;
 181       }
 182       bmicrosleep(5,0);
 183    }
 184
 185    mdb->mysql.reconnect = 1;             /* so connection does not timeout */
 186    Dmsg0(50, "mysql_real_connect done\n");
 187    Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
 188             mdb->db_password==NULL?"(NULL)":mdb->db_password);
 189
 190    if (mdb->db == NULL) {
 191       Mmsg2(&mdb->errmsg, _("Unable to connect to MySQL server.\n"
 192 "Database=%s User=%s\n"
 193 "MySQL connect failed either server not running or your authorization is incorrect.\n"),
 194          mdb->db_name, mdb->db_user);
 195       V(mutex);
 196       return 0;
 197    }
 198
 199    mdb->connected = true;
 200    if (!check_tables_version(jcr, mdb)) {
 201       V(mutex);
 202       return 0;
 203    }
 204
 205    Dmsg3(100, "opendb ref=%d connected=%d db=%p\n", mdb->ref_count,
 206          mdb->connected, mdb->db);
 207
 208    /* Set connection timeout to 8 days specialy for batch mode */
 209    sql_query(mdb, "SET wait_timeout=691200");
 210    sql_query(mdb, "SET interactive_timeout=691200");
 211
 212    V(mutex);
 213    return 1;
 214 }
 215
 216 void
 217 db_close_database(JCR *jcr, B_DB *mdb)
 218 {
 219    if (!mdb) {
 220       return;
 221    }
 222    db_end_transaction(jcr, mdb);
 223    P(mutex);
 224    sql_free_result(mdb);
 225    mdb->ref_count--;
 226    Dmsg3(100, "closedb ref=%d connected=%d db=%p\n", mdb->ref_count,
 227          mdb->connected, mdb->db);
 228    if (mdb->ref_count == 0) {
 229       qdchain(&mdb->bq);
 230       if (mdb->connected) {
 231          Dmsg1(100, "close db=%p\n", mdb->db);
 232          mysql_close(&mdb->mysql);
 233
 234 #ifdef xHAVE_EMBEDDED_MYSQL
 235 //       mysql_server_end();
 236 #endif
 237       }
 238       rwl_destroy(&mdb->lock);
 239       free_pool_memory(mdb->errmsg);
 240       free_pool_memory(mdb->cmd);
 241       free_pool_memory(mdb->cached_path);
 242       free_pool_memory(mdb->fname);
 243       free_pool_memory(mdb->path);
 244       free_pool_memory(mdb->esc_name);
 245       free_pool_memory(mdb->esc_path);
 246       if (mdb->db_name) {
 247          free(mdb->db_name);
 248       }
 249       if (mdb->db_user) {
 250          free(mdb->db_user);
 251       }
 252       if (mdb->db_password) {
 253          free(mdb->db_password);
 254       }
 255       if (mdb->db_address) {
 256          free(mdb->db_address);
 257       }
 258       if (mdb->db_socket) {
 259          free(mdb->db_socket);
 260       }
 261       free(mdb);
 262    }
 263    V(mutex);
 264 }
 265
 266 /*
 267  * This call is needed because the message channel thread
 268  *  opens a database on behalf of a jcr that was created in
 269  *  a different thread. MySQL then allocates thread specific
 270  *  data, which is NOT freed when the original jcr thread
 271  *  closes the database.  Thus the msgchan must call here
 272  *  to cleanup any thread specific data that it created.
 273  */
 274 void db_thread_cleanup()
 275 {
 276 #ifndef HAVE_WIN32
 277    my_thread_end();
 278 #endif
 279 }
 280
 281 /*
 282  * Return the next unique index (auto-increment) for
 283  * the given table.  Return NULL on error.
 284  *
 285  * For MySQL, NULL causes the auto-increment value
 286  *  to be updated.
 287  */
 288 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 289 {
 290    strcpy(index, "NULL");
 291    return 1;
 292 }
 293
 294
 295 /*
 296  * Escape strings so that MySQL is happy
 297  *
 298  *   NOTE! len is the length of the old string. Your new
 299  *         string must be long enough (max 2*old+1) to hold
 300  *         the escaped output.
 301  */
 302 void
 303 db_escape_string(JCR *jcr, B_DB *mdb, char *snew, char *old, int len)
 304 {
 305    mysql_real_escape_string(mdb->db, snew, old, len);
 306 }
 307
 308 /*
 309  * Submit a general SQL command (cmd), and for each row returned,
 310  *  the sqlite_handler is called with the ctx.
 311  */
 312 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 313 {
 314    SQL_ROW row;
 315    bool send = true;
 316
 317    db_lock(mdb);
 318    if (sql_query(mdb, query) != 0) {
 319       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 320       db_unlock(mdb);
 321       return false;
 322    }
 323    if (result_handler != NULL) {
 324       if ((mdb->result = sql_use_result(mdb)) != NULL) {
 325          int num_fields = sql_num_fields(mdb);
 326
 327          /* We *must* fetch all rows */
 328          while ((row = sql_fetch_row(mdb)) != NULL) {
 329             if (send) {
 330                /* the result handler returns 1 when it has
 331                 *  seen all the data it wants.  However, we
 332                 *  loop to the end of the data.
 333                 */
 334                if (result_handler(ctx, num_fields, row)) {
 335                   send = false;
 336                }
 337             }
 338          }
 339
 340          sql_free_result(mdb);
 341       }
 342    }
 343    db_unlock(mdb);
 344    return true;
 345
 346 }
 347
 348 void my_mysql_free_result(B_DB *mdb)
 349 {
 350    db_lock(mdb);
 351    if (mdb->result) {
 352       mysql_free_result(mdb->result);
 353       mdb->result = NULL;
 354    }
 355    db_unlock(mdb);
 356 }
 357
 358 #ifdef HAVE_BATCH_FILE_INSERT
 359 const char *my_mysql_batch_lock_path_query =
 360    "LOCK TABLES Path write, batch write, Path as p write";
 361
 362
 363 const char *my_mysql_batch_lock_filename_query =
 364    "LOCK TABLES Filename write, batch write, Filename as f write";
 365
 366 const char *my_mysql_batch_unlock_tables_query = "UNLOCK TABLES";
 367
 368 const char *my_mysql_batch_fill_path_query =
 369    "INSERT INTO Path (Path) "
 370     "SELECT a.Path FROM "
 371      "(SELECT DISTINCT Path FROM batch) AS a WHERE NOT EXISTS "
 372      "(SELECT Path FROM Path AS p WHERE p.Path = a.Path)";
 373
 374 const char *my_mysql_batch_fill_filename_query =
 375    "INSERT INTO Filename (Name) "
 376     "SELECT a.Name FROM "
 377      "(SELECT DISTINCT Name FROM batch) AS a WHERE NOT EXISTS "
 378      "(SELECT Name FROM Filename AS f WHERE f.Name = a.Name)";
 379 #endif /* HAVE_BATCH_FILE_INSERT */
 380
 381 #endif /* HAVE_MYSQL */