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    V(mutex);
 209    return 1;
 210 }
 211
 212 void
 213 db_close_database(JCR *jcr, B_DB *mdb)
 214 {
 215    if (!mdb) {
 216       return;
 217    }
 218    db_end_transaction(jcr, mdb);
 219    P(mutex);
 220    sql_free_result(mdb);
 221    mdb->ref_count--;
 222    Dmsg3(100, "closedb ref=%d connected=%d db=%p\n", mdb->ref_count,
 223          mdb->connected, mdb->db);
 224    if (mdb->ref_count == 0) {
 225       qdchain(&mdb->bq);
 226       if (mdb->connected) {
 227          Dmsg1(100, "close db=%p\n", mdb->db);
 228          mysql_close(&mdb->mysql);
 229
 230 #ifdef xHAVE_EMBEDDED_MYSQL
 231 //       mysql_server_end();
 232 #endif
 233       }
 234       rwl_destroy(&mdb->lock);
 235       free_pool_memory(mdb->errmsg);
 236       free_pool_memory(mdb->cmd);
 237       free_pool_memory(mdb->cached_path);
 238       free_pool_memory(mdb->fname);
 239       free_pool_memory(mdb->path);
 240       free_pool_memory(mdb->esc_name);
 241       free_pool_memory(mdb->esc_path);
 242       if (mdb->db_name) {
 243          free(mdb->db_name);
 244       }
 245       if (mdb->db_user) {
 246          free(mdb->db_user);
 247       }
 248       if (mdb->db_password) {
 249          free(mdb->db_password);
 250       }
 251       if (mdb->db_address) {
 252          free(mdb->db_address);
 253       }
 254       if (mdb->db_socket) {
 255          free(mdb->db_socket);
 256       }
 257       free(mdb);
 258    }
 259    V(mutex);
 260 }
 261
 262 /*
 263  * This call is needed because the message channel thread
 264  *  opens a database on behalf of a jcr that was created in
 265  *  a different thread. MySQL then allocates thread specific
 266  *  data, which is NOT freed when the original jcr thread
 267  *  closes the database.  Thus the msgchan must call here
 268  *  to cleanup any thread specific data that it created.
 269  */
 270 void db_thread_cleanup()
 271 {
 272 #ifndef HAVE_WIN32
 273    my_thread_end();
 274 #endif
 275 }
 276
 277 /*
 278  * Return the next unique index (auto-increment) for
 279  * the given table.  Return NULL on error.
 280  *
 281  * For MySQL, NULL causes the auto-increment value
 282  *  to be updated.
 283  */
 284 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 285 {
 286    strcpy(index, "NULL");
 287    return 1;
 288 }
 289
 290
 291 /*
 292  * Escape strings so that MySQL is happy
 293  *
 294  *   NOTE! len is the length of the old string. Your new
 295  *         string must be long enough (max 2*old+1) to hold
 296  *         the escaped output.
 297  */
 298 void
 299 db_escape_string(JCR *jcr, B_DB *mdb, char *snew, char *old, int len)
 300 {
 301    mysql_real_escape_string(mdb->db, snew, old, len);
 302 }
 303
 304 /*
 305  * Submit a general SQL command (cmd), and for each row returned,
 306  *  the sqlite_handler is called with the ctx.
 307  */
 308 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 309 {
 310    SQL_ROW row;
 311    bool send = true;
 312
 313    db_lock(mdb);
 314    if (sql_query(mdb, query) != 0) {
 315       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 316       db_unlock(mdb);
 317       return false;
 318    }
 319    if (result_handler != NULL) {
 320       if ((mdb->result = sql_use_result(mdb)) != NULL) {
 321          int num_fields = sql_num_fields(mdb);
 322
 323          /* We *must* fetch all rows */
 324          while ((row = sql_fetch_row(mdb)) != NULL) {
 325             if (send) {
 326                /* the result handler returns 1 when it has
 327                 *  seen all the data it wants.  However, we
 328                 *  loop to the end of the data.
 329                 */
 330                if (result_handler(ctx, num_fields, row)) {
 331                   send = false;
 332                }
 333             }
 334          }
 335
 336          sql_free_result(mdb);
 337       }
 338    }
 339    db_unlock(mdb);
 340    return true;
 341
 342 }
 343
 344 void my_mysql_free_result(B_DB *mdb)
 345 {
 346    db_lock(mdb);
 347    if (mdb->result) {
 348       mysql_free_result(mdb->result);
 349       mdb->result = NULL;
 350    }
 351    db_unlock(mdb);
 352 }
 353
 354 #ifdef HAVE_BATCH_FILE_INSERT
 355 const char *my_mysql_batch_lock_path_query =
 356    "LOCK TABLES Path write, batch write, Path as p write";
 357
 358
 359 const char *my_mysql_batch_lock_filename_query =
 360    "LOCK TABLES Filename write, batch write, Filename as f write";
 361
 362 const char *my_mysql_batch_unlock_tables_query = "UNLOCK TABLES";
 363
 364 const char *my_mysql_batch_fill_path_query =
 365    "INSERT INTO Path (Path) "
 366     "SELECT a.Path FROM "
 367      "(SELECT DISTINCT Path FROM batch) AS a WHERE NOT EXISTS "
 368      "(SELECT Path FROM Path AS p WHERE p.Path = a.Path)";
 369
 370 const char *my_mysql_batch_fill_filename_query =
 371    "INSERT INTO Filename (Name) "
 372     "SELECT a.Name FROM "
 373      "(SELECT DISTINCT Name FROM batch) AS a WHERE NOT EXISTS "
 374      "(SELECT Name FROM Filename AS f WHERE f.Name = a.Name)";
 375 #endif /* HAVE_BATCH_FILE_INSERT */
 376
 377 #endif /* HAVE_MYSQL */