2 * Bacula Catalog Database routines specific to MySQL
3 * These are MySQL specific routines -- hopefully all
4 * other files are generic.
6 * Kern Sibbald, March 2000
12 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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.
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.
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,
32 /* The following is necessary so that we do not include
33 * the dummy external definition of DB.
35 #define __SQL_C /* indicate that this is sql.c */
42 /* -----------------------------------------------------------------------
44 * MySQL dependent defines and subroutines
46 * -----------------------------------------------------------------------
49 /* List of open databases */
50 static BQUEUE db_list = {&db_list, &db_list};
52 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
55 * Initialize database data structure. In principal this should
56 * never have errors, or it is really fatal.
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 int mult_db_connections)
66 Jmsg(jcr, M_FATAL, 0, _("A user name for MySQL must be supplied.\n"));
69 P(mutex); /* lock DB queue */
70 /* Look to see if DB already open */
71 if (!mult_db_connections) {
72 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
73 if (strcmp(mdb->db_name, db_name) == 0) {
74 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
77 return mdb; /* already open */
81 Dmsg0(100, "db_open first time\n");
82 mdb = (B_DB *) malloc(sizeof(B_DB));
83 memset(mdb, 0, sizeof(B_DB));
84 mdb->db_name = bstrdup(db_name);
85 mdb->db_user = bstrdup(db_user);
87 mdb->db_password = bstrdup(db_password);
90 mdb->db_address = bstrdup(db_address);
93 mdb->db_socket = bstrdup(db_socket);
95 mdb->db_port = db_port;
96 mdb->have_insert_id = TRUE;
97 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
99 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
100 mdb->cached_path = get_pool_memory(PM_FNAME);
101 mdb->cached_path_id = 0;
103 mdb->fname = get_pool_memory(PM_FNAME);
104 mdb->path = get_pool_memory(PM_FNAME);
105 mdb->esc_name = get_pool_memory(PM_FNAME);
106 qinsert(&db_list, &mdb->bq); /* put db in list */
112 * Now actually open the database. This can generate errors,
113 * which are returned in the errmsg
115 * DO NOT close the database or free(mdb) here !!!!
118 db_open_database(JCR *jcr, B_DB *mdb)
123 if (mdb->connected) {
127 mdb->connected = FALSE;
129 if ((errstat=rwl_init(&mdb->lock)) != 0) {
130 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
136 /* connect to the database */
137 #ifdef HAVE_EMBEDDED_MYSQL
138 mysql_server_init(0, NULL, NULL);
140 mysql_init(&(mdb->mysql));
141 Dmsg0(50, "mysql_init done\n");
142 /* If connection fails, try at 5 sec intervals for 30 seconds. */
143 for (int retry=0; retry < 6; retry++) {
144 mdb->db = mysql_real_connect(
145 &(mdb->mysql), /* db */
146 mdb->db_address, /* default = localhost */
147 mdb->db_user, /* login name */
148 mdb->db_password, /* password */
149 mdb->db_name, /* database name */
150 mdb->db_port, /* default port */
151 mdb->db_socket, /* default = socket */
152 CLIENT_FOUND_ROWS); /* flags */
154 /* If no connect, try once more in case it is a timing problem */
155 if (mdb->db != NULL) {
161 Dmsg0(50, "mysql_real_connect done\n");
162 Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
163 mdb->db_password==NULL?"(NULL)":mdb->db_password);
165 if (mdb->db == NULL) {
166 Mmsg2(&mdb->errmsg, _("Unable to connect to MySQL server. \n"
167 "Database=%s User=%s\n"
168 "It is probably not running or your password is incorrect.\n"),
169 mdb->db_name, mdb->db_user);
174 if (!check_tables_version(jcr, mdb)) {
179 #ifdef HAVE_THREAD_SAFE_MYSQL
183 mdb->connected = TRUE;
189 db_close_database(JCR *jcr, B_DB *mdb)
196 #ifdef HAVE_TREAD_SAFE_MYSQL
199 if (mdb->ref_count == 0) {
201 if (mdb->connected && mdb->db) {
203 #ifdef HAVE_EMBEDDED_MYSQL
207 rwl_destroy(&mdb->lock);
208 free_pool_memory(mdb->errmsg);
209 free_pool_memory(mdb->cmd);
210 free_pool_memory(mdb->cached_path);
211 free_pool_memory(mdb->fname);
212 free_pool_memory(mdb->path);
213 free_pool_memory(mdb->esc_name);
220 if (mdb->db_password) {
221 free(mdb->db_password);
223 if (mdb->db_address) {
224 free(mdb->db_address);
226 if (mdb->db_socket) {
227 free(mdb->db_socket);
235 * Return the next unique index (auto-increment) for
236 * the given table. Return NULL on error.
238 * For MySQL, NULL causes the auto-increment value
241 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
243 strcpy(index, "NULL");
249 * Escape strings so that MySQL is happy
251 * NOTE! len is the length of the old string. Your new
252 * string must be long enough (max 2*old+1) to hold
253 * the escaped output.
256 db_escape_string(char *snew, char *old, int len)
258 mysql_escape_string(snew, old, len);
262 /* Should use mysql_real_escape_string ! */
263 unsigned long mysql_real_escape_string(MYSQL *mysql, char *to, const char *from, unsigned long length);
315 * Submit a general SQL command (cmd), and for each row returned,
316 * the sqlite_handler is called with the ctx.
318 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
323 if (sql_query(mdb, query) != 0) {
324 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
328 if (result_handler != NULL) {
329 if ((mdb->result = sql_store_result(mdb)) != NULL) {
330 int num_fields = sql_num_fields(mdb);
332 while ((row = sql_fetch_row(mdb)) != NULL) {
333 if (result_handler(ctx, num_fields, row))
337 sql_free_result(mdb);
345 #endif /* HAVE_MYSQL */