]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/mysql.c
Add Raw file save/restore
[bacula/bacula] / 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-2003 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(void *jcr, char *db_name, char *db_user, char *db_password)
60 {
61    B_DB *mdb;
62
63    P(mutex);                          /* lock DB queue */
64    /* Look to see if DB already open */
65    for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
66       if (strcmp(mdb->db_name, db_name) == 0) {
67          Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
68          mdb->ref_count++;
69          V(mutex);
70          return mdb;                  /* already open */
71       }
72    }
73    Dmsg0(100, "db_open first time\n");
74    mdb = (B_DB *) malloc(sizeof(B_DB));
75    memset(mdb, 0, sizeof(B_DB));
76    mdb->db_name = bstrdup(db_name);
77    mdb->db_user = bstrdup(db_user);
78    mdb->db_password = bstrdup(db_password);
79    mdb->have_insert_id = TRUE;
80    mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
81    *mdb->errmsg = 0;
82    mdb->cmd = get_pool_memory(PM_EMSG);    /* get command buffer */
83    mdb->cached_path = get_pool_memory(PM_FNAME);
84    mdb->cached_path_id = 0;
85    mdb->ref_count = 1;
86    mdb->fname = get_pool_memory(PM_FNAME);
87    mdb->path = get_pool_memory(PM_FNAME);
88    mdb->esc_name = get_pool_memory(PM_FNAME);
89    qinsert(&db_list, &mdb->bq);            /* put db in list */
90    mdb->jcr = jcr;
91    V(mutex);
92    return mdb;
93 }
94
95 /*
96  * Now actually open the database.  This can generate errors,
97  * which are returned in the errmsg
98  */
99 int
100 db_open_database(B_DB *mdb)
101 {
102    int errstat;
103
104    P(mutex);
105    if (mdb->connected) {
106       V(mutex);
107       return 1;
108    }
109    mdb->connected = FALSE;
110
111    if ((errstat=rwl_init(&mdb->lock)) != 0) {
112       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"), 
113             strerror(errstat));
114       V(mutex);
115       return 0;
116    }
117
118    /* connect to the database */
119 #ifdef HAVE_EMBEDDED_MYSQL
120    mysql_server_init(0, NULL, NULL);
121 #endif
122    mysql_init(&(mdb->mysql));
123    Dmsg0(50, "mysql_init done\n");
124    mdb->db = mysql_real_connect(
125         &(mdb->mysql),                /* db */
126         NULL,                         /* default = localhost */
127         mdb->db_user,                 /*  login name */
128         mdb->db_password,             /*  password */
129         mdb->db_name,                 /* database name */
130         0,                            /* default port */
131         NULL,                         /* default = socket */
132         0);                           /* flags = none */
133
134    /* If no connect, try once more incase it is a timing problem */
135    if (mdb->db == NULL) {
136       mdb->db = mysql_real_connect(
137            &(mdb->mysql),                /* db */
138            NULL,                         /* default = localhost */
139            mdb->db_user,                 /*  login name */
140            mdb->db_password,             /*  password */
141            mdb->db_name,                 /* database name */
142            0,                            /* default port */
143            NULL,                         /* default = socket */
144            0);                           /* flags = none */
145    }
146     
147    Dmsg0(50, "mysql_real_connect done\n");
148    Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name, 
149             mdb->db_password==NULL?"(NULL)":mdb->db_password);
150   
151    if (mdb->db == NULL) {
152       Mmsg2(&mdb->errmsg, _("Unable to connect to MySQL server. \n\
153 Database=%s User=%s\n\
154 It is probably not running or your password is incorrect.\n"), 
155          mdb->db_name, mdb->db_user);
156       V(mutex);
157       return 0;
158    }
159
160    if (!check_tables_version(mdb)) {
161       V(mutex);
162       return 0;
163    }
164
165    mdb->connected = TRUE;
166    V(mutex);
167    return 1;
168 }
169
170 void
171 db_close_database(B_DB *mdb)
172 {
173    P(mutex);
174    mdb->ref_count--;
175    if (mdb->ref_count == 0) {
176       qdchain(&mdb->bq);
177       if (mdb->connected && mdb->db) {
178          sql_close(mdb);
179 #ifdef HAVE_EMBEDDED_MYSQL
180          mysql_server_end();
181 #endif
182       }
183 /*    pthread_mutex_destroy(&mdb->mutex); */
184       rwl_destroy(&mdb->lock);       
185       free_pool_memory(mdb->errmsg);
186       free_pool_memory(mdb->cmd);
187       free_pool_memory(mdb->cached_path);
188       free_pool_memory(mdb->fname);
189       free_pool_memory(mdb->path);
190       free_pool_memory(mdb->esc_name);
191       if (mdb->db_name) {
192          free(mdb->db_name);
193       }
194       if (mdb->db_user) {
195          free(mdb->db_user);
196       }
197       if (mdb->db_password) {
198          free(mdb->db_password);
199       }
200       free(mdb);
201    }
202    V(mutex);
203 }
204
205 /*
206  * Return the next unique index (auto-increment) for
207  * the given table.  Return NULL on error.
208  *  
209  * For MySQL, NULL causes the auto-increment value
210  *  to be updated.
211  */
212 int db_next_index(B_DB *mdb, char *table, char *index)
213 {
214    strcpy(index, "NULL");
215    return 1;
216 }   
217
218
219
220 void
221 db_escape_string(char *snew, char *old, int len)
222 {
223    mysql_escape_string(snew, old, len);
224 }
225
226 /*
227  * Submit a general SQL command (cmd), and for each row returned,
228  *  the sqlite_handler is called with the ctx.
229  */
230 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
231 {
232    SQL_ROW row;
233   
234    db_lock(mdb);
235    if (sql_query(mdb, query) != 0) {
236       Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
237       db_unlock(mdb);
238       return 0;
239    }
240    if (result_handler != NULL) {
241       if ((mdb->result = sql_store_result(mdb)) != NULL) {
242          int num_fields = sql_num_fields(mdb);
243
244          while ((row = sql_fetch_row(mdb)) != NULL) {
245             if (result_handler(ctx, num_fields, row))
246                break;
247          }
248
249          sql_free_result(mdb);
250       }
251    }
252    db_unlock(mdb);
253    return 1;
254
255 }
256
257
258 static void
259 list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
260 {
261    SQL_FIELD  *field;
262    unsigned int i, j;
263
264    sql_field_seek(mdb, 0);
265    send(ctx, "+");
266    for (i = 0; i < sql_num_fields(mdb); i++) {
267       field = sql_fetch_field(mdb);
268       for (j = 0; j < field->max_length + 2; j++)
269               send(ctx, "-");
270       send(ctx, "+");
271    }
272    send(ctx, "\n");
273 }
274
275 void
276 list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
277 {
278    SQL_FIELD *field;
279    SQL_ROW    row;
280    unsigned int i, col_len;
281    char buf[2000], ewc[30];
282
283    if (mdb->result == NULL) {
284       send(ctx, _("No results to list.\n"));
285       return;
286    }
287    /* determine column display widths */
288    sql_field_seek(mdb, 0);
289    for (i = 0; i < sql_num_fields(mdb); i++) {
290       field = sql_fetch_field(mdb);
291       if (IS_NUM(field->type) && field->max_length > 0) { /* fixup for commas */
292          field->max_length += (field->max_length - 1) / 3;
293       }
294       col_len = strlen(field->name);
295       if (col_len < field->max_length)
296               col_len = field->max_length;
297       if (col_len < 4 && !IS_NOT_NULL(field->flags))
298               col_len = 4;    /* 4 = length of the word "NULL" */
299       field->max_length = col_len;    /* reset column info */
300    }
301
302    list_dashes(mdb, send, ctx);
303    send(ctx, "|");
304    sql_field_seek(mdb, 0);
305    for (i = 0; i < sql_num_fields(mdb); i++) {
306       field = sql_fetch_field(mdb);
307       sprintf(buf, " %-*s |", (int)field->max_length, field->name);
308       send(ctx, buf);
309    }
310    send(ctx, "\n");
311    list_dashes(mdb, send, ctx);
312
313    while ((row = sql_fetch_row(mdb)) != NULL) {
314       sql_field_seek(mdb, 0);
315       send(ctx, "|");
316       for (i = 0; i < sql_num_fields(mdb); i++) {
317          field = sql_fetch_field(mdb);
318          if (row[i] == NULL) {
319             sprintf(buf, " %-*s |", (int)field->max_length, "NULL");
320          } else if (IS_NUM(field->type)) {
321             sprintf(buf, " %*s |", (int)field->max_length,       
322                add_commas(row[i], ewc));
323          } else {
324             sprintf(buf, " %-*s |", (int)field->max_length, row[i]);
325          }
326          send(ctx, buf);
327       }
328       send(ctx, "\n");
329    }
330    list_dashes(mdb, send, ctx);
331 }
332
333
334 #endif /* HAVE_MYSQL */