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

   1 /*
   2  * Bacula Catalog Database routines specific to MySQL
   3  *   These are MySQL specific routines -- hopefully all
   4  *    other files are generic.
   5  *
   6  *    Kern Sibbald, March 2000
   7  *
   8  *    Version $Id$
   9  */
  10
  11 /*
  12    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of
  17    the License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public
  25    License along with this program; if not, write to the Free
  26    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31
  32 /* The following is necessary so that we do not include
  33  * the dummy external definition of DB.
  34  */
  35 #define __SQL_C                       /* indicate that this is sql.c */
  36
  37 #include "bacula.h"
  38 #include "cats.h"
  39
  40 #ifdef HAVE_MYSQL
  41
  42 /* -----------------------------------------------------------------------
  43  *
  44  *   MySQL dependent defines and subroutines
  45  *
  46  * -----------------------------------------------------------------------
  47  */
  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 /*
  55  * Initialize database data structure. In principal this should
  56  * never have errors, or it is really fatal.
  57  */
  58 B_DB *
  59 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
  60                  const char *db_address, int db_port, const char *db_socket)
  61 {
  62    B_DB *mdb;
  63
  64    if (!db_user) {
  65       Jmsg(jcr, M_FATAL, 0, _("A user name for MySQL must be supplied.\n"));
  66       return NULL;
  67    }
  68    P(mutex);                          /* lock DB queue */
  69    /* Look to see if DB already open */
  70    for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
  71       if (strcmp(mdb->db_name, db_name) == 0) {
  72          Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
  73          mdb->ref_count++;
  74          V(mutex);
  75          return mdb;                  /* already open */
  76       }
  77    }
  78    Dmsg0(100, "db_open first time\n");
  79    mdb = (B_DB *) malloc(sizeof(B_DB));
  80    memset(mdb, 0, sizeof(B_DB));
  81    mdb->db_name = bstrdup(db_name);
  82    mdb->db_user = bstrdup(db_user);
  83    if (db_password) {
  84       mdb->db_password = bstrdup(db_password);
  85    }
  86    if (db_address) {
  87       mdb->db_address = bstrdup(db_address);
  88    }
  89    if (db_socket) {
  90       mdb->db_socket = bstrdup(db_socket);
  91    }
  92    mdb->db_port = db_port;
  93    mdb->have_insert_id = TRUE;
  94    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
  95    *mdb->errmsg = 0;
  96    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
  97    mdb->cached_path = get_pool_memory(PM_FNAME);
  98    mdb->cached_path_id = 0;
  99    mdb->ref_count = 1;
 100    mdb->fname = get_pool_memory(PM_FNAME);
 101    mdb->path = get_pool_memory(PM_FNAME);
 102    mdb->esc_name = get_pool_memory(PM_FNAME);
 103    qinsert(&db_list, &mdb->bq);            /* put db in list */
 104    V(mutex);
 105    return mdb;
 106 }
 107
 108 /*
 109  * Now actually open the database.  This can generate errors,
 110  *  which are returned in the errmsg
 111  *
 112  * DO NOT close the database or free(mdb) here !!!!
 113  */
 114 int
 115 db_open_database(JCR *jcr, B_DB *mdb)
 116 {
 117    int errstat;
 118
 119    P(mutex);
 120    if (mdb->connected) {
 121       V(mutex);
 122       return 1;
 123    }
 124    mdb->connected = FALSE;
 125
 126    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 127       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 128             strerror(errstat));
 129       V(mutex);
 130       return 0;
 131    }
 132
 133    /* connect to the database */
 134 #ifdef HAVE_EMBEDDED_MYSQL
 135    mysql_server_init(0, NULL, NULL);
 136 #endif
 137    mysql_init(&(mdb->mysql));
 138    Dmsg0(50, "mysql_init done\n");
 139    /* If connection fails, try at 5 sec intervals for 30 seconds. */
 140    for (int retry=0; retry < 6; retry++) {
 141       mdb->db = mysql_real_connect(
 142            &(mdb->mysql),                /* db */
 143            mdb->db_address,              /* default = localhost */
 144            mdb->db_user,                 /*  login name */
 145            mdb->db_password,             /*  password */
 146            mdb->db_name,                 /* database name */
 147            mdb->db_port,                 /* default port */
 148            mdb->db_socket,               /* default = socket */
 149            CLIENT_FOUND_ROWS);           /* flags */
 150
 151       /* If no connect, try once more in case it is a timing problem */
 152       if (mdb->db != NULL) {
 153          break;
 154       }
 155       bmicrosleep(5,0);
 156    }
 157
 158    Dmsg0(50, "mysql_real_connect done\n");
 159    Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
 160             mdb->db_password==NULL?"(NULL)":mdb->db_password);
 161
 162    if (mdb->db == NULL) {
 163       Mmsg2(&mdb->errmsg, _("Unable to connect to MySQL server. \n\
 164 Database=%s User=%s\n\
 165 It is probably not running or your password is incorrect.\n"),
 166          mdb->db_name, mdb->db_user);
 167       V(mutex);
 168       return 0;
 169    }
 170
 171    if (!check_tables_version(jcr, mdb)) {
 172       V(mutex);
 173       return 0;
 174    }
 175
 176 #ifdef HAVE_TREAD_SAFE_MYSQL
 177    my_thread_init();
 178 #endif
 179
 180    mdb->connected = TRUE;
 181    V(mutex);
 182    return 1;
 183 }
 184
 185 void
 186 db_close_database(JCR *jcr, B_DB *mdb)
 187 {
 188    if (!mdb) {
 189       return;
 190    }
 191    P(mutex);
 192    mdb->ref_count--;
 193 #ifdef HAVE_TREAD_SAFE_MYSQL
 194    my_thread_end();
 195 #endif
 196    if (mdb->ref_count == 0) {
 197       qdchain(&mdb->bq);
 198       if (mdb->connected && mdb->db) {
 199          sql_close(mdb);
 200 #ifdef HAVE_EMBEDDED_MYSQL
 201          mysql_server_end();
 202 #endif
 203       }
 204       rwl_destroy(&mdb->lock);
 205       free_pool_memory(mdb->errmsg);
 206       free_pool_memory(mdb->cmd);
 207       free_pool_memory(mdb->cached_path);
 208       free_pool_memory(mdb->fname);
 209       free_pool_memory(mdb->path);
 210       free_pool_memory(mdb->esc_name);
 211       if (mdb->db_name) {
 212          free(mdb->db_name);
 213       }
 214       if (mdb->db_user) {
 215          free(mdb->db_user);
 216       }
 217       if (mdb->db_password) {
 218          free(mdb->db_password);
 219       }
 220       if (mdb->db_address) {
 221          free(mdb->db_address);
 222       }
 223       if (mdb->db_socket) {
 224          free(mdb->db_socket);
 225       }
 226       free(mdb);
 227    }
 228    V(mutex);
 229 }
 230
 231 /*
 232  * Return the next unique index (auto-increment) for
 233  * the given table.  Return NULL on error.
 234  *
 235  * For MySQL, NULL causes the auto-increment value
 236  *  to be updated.
 237  */
 238 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 239 {
 240    strcpy(index, "NULL");
 241    return 1;
 242 }
 243
 244
 245 /*
 246  * Escape strings so that MySQL is happy
 247  *
 248  *   NOTE! len is the length of the old string. Your new
 249  *         string must be long enough (max 2*old+1) to hold
 250  *         the escaped output.
 251  */
 252 void
 253 db_escape_string(char *snew, char *old, int len)
 254 {
 255    mysql_escape_string(snew, old, len);
 256
 257 #ifdef DO_IT_MYSELF
 258
 259 /* Should use mysql_real_escape_string ! */
 260 unsigned long mysql_real_escape_string(MYSQL *mysql, char *to, const char *from, unsigned long length);
 261
 262    char *n, *o;
 263
 264    n = snew;
 265    o = old;
 266    while (len--) {
 267       switch (*o) {
 268       case 0:
 269          *n++= '\\';
 270          *n++= '0';
 271          o++;
 272          break;
 273       case '\n':
 274          *n++= '\\';
 275          *n++= 'n';
 276          o++;
 277          break;
 278       case '\r':
 279          *n++= '\\';
 280          *n++= 'r';
 281          o++;
 282          break;
 283       case '\\':
 284          *n++= '\\';
 285          *n++= '\\';
 286          o++;
 287          break;
 288       case '\'':
 289          *n++= '\\';
 290          *n++= '\'';
 291          o++;
 292          break;
 293       case '"':
 294          *n++= '\\';
 295          *n++= '"';
 296          o++;
 297          break;
 298       case '\032':
 299          *n++= '\\';
 300          *n++= 'Z';
 301          o++;
 302          break;
 303       default:
 304          *n++= *o++;
 305       }
 306    }
 307    *n = 0;
 308 #endif
 309 }
 310
 311 /*
 312  * Submit a general SQL command (cmd), and for each row returned,
 313  *  the sqlite_handler is called with the ctx.
 314  */
 315 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 316 {
 317    SQL_ROW row;
 318
 319    db_lock(mdb);
 320    if (sql_query(mdb, query) != 0) {
 321       Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 322       db_unlock(mdb);
 323       return 0;
 324    }
 325    if (result_handler != NULL) {
 326       if ((mdb->result = sql_store_result(mdb)) != NULL) {
 327          int num_fields = sql_num_fields(mdb);
 328
 329          while ((row = sql_fetch_row(mdb)) != NULL) {
 330             if (result_handler(ctx, num_fields, row))
 331                break;
 332          }
 333
 334          sql_free_result(mdb);
 335       }
 336    }
 337    db_unlock(mdb);
 338    return 1;
 339
 340 }
 341
 342 #endif /* HAVE_MYSQL */