2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
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
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.
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
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.
29 * Bacula Catalog Database routines specific to SQLite
31 * Kern Sibbald, January 2002
38 /* The following is necessary so that we do not include
39 * the dummy external definition of DB.
41 #define __SQL_C /* indicate that this is sql.c */
46 #if HAVE_SQLITE || HAVE_SQLITE3
48 /* -----------------------------------------------------------------------
50 * SQLite dependent defines and subroutines
52 * -----------------------------------------------------------------------
55 /* List of open databases */
56 static BQUEUE db_list = {&db_list, &db_list};
58 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
60 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
64 * Retrieve database type
73 * When using mult_db_connections = 1,
74 * sqlite can be BUSY. We just need sleep a little in this case.
78 static int my_busy_handler(void *arg, int calls)
84 static int my_busy_handler(void *arg, const char* p, int calls)
93 * Initialize database data structure. In principal this should
94 * never have errors, or it is really fatal.
97 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
98 const char *db_address, int db_port, const char *db_socket,
99 int mult_db_connections)
103 P(mutex); /* lock DB queue */
104 /* Look to see if DB already open */
105 if (!mult_db_connections) {
106 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
107 if (bstrcmp(mdb->db_name, db_name) &&
108 bstrcmp(mdb->db_address, db_address) &&
109 mdb->db_port == db_port) {
110 Dmsg2(300, "DB REopen %d %s\n", mdb->ref_count, db_name);
113 return mdb; /* already open */
117 Dmsg0(300, "db_open first time\n");
118 mdb = (B_DB *) malloc(sizeof(B_DB));
119 memset(mdb, 0, sizeof(B_DB));
120 mdb->db_name = bstrdup(db_name);
121 mdb->have_insert_id = TRUE;
122 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
124 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
125 mdb->cached_path = get_pool_memory(PM_FNAME);
126 mdb->cached_path_id = 0;
128 mdb->fname = get_pool_memory(PM_FNAME);
129 mdb->path = get_pool_memory(PM_FNAME);
130 mdb->esc_name = get_pool_memory(PM_FNAME);
131 mdb->esc_path = get_pool_memory(PM_FNAME);
132 mdb->allow_transactions = mult_db_connections;
133 qinsert(&db_list, &mdb->bq); /* put db in list */
139 * Now actually open the database. This can generate errors,
140 * which are returned in the errmsg
142 * DO NOT close the database or free(mdb) here !!!!
145 db_open_database(JCR *jcr, B_DB *mdb)
153 if (mdb->connected) {
157 mdb->connected = FALSE;
159 if ((errstat=rwl_init(&mdb->lock)) != 0) {
160 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
166 /* open the database */
167 len = strlen(working_directory) + strlen(mdb->db_name) + 5;
168 db_name = (char *)malloc(len);
169 strcpy(db_name, working_directory);
170 strcat(db_name, "/");
171 strcat(db_name, mdb->db_name);
172 strcat(db_name, ".db");
173 if (stat(db_name, &statbuf) != 0) {
174 Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
182 int stat = sqlite3_open(db_name, &mdb->db);
183 if (stat != SQLITE_OK) {
184 mdb->sqlite_errmsg = (char *)sqlite3_errmsg(mdb->db);
185 sqlite3_close(mdb->db);
188 mdb->sqlite_errmsg = NULL;
190 #ifdef SQLITE3_INIT_QUERY
191 db_sql_query(mdb, SQLITE3_INIT_QUERY, NULL, NULL);
195 mdb->db = sqlite_open(
196 db_name, /* database name */
198 &mdb->sqlite_errmsg); /* error message */
201 Dmsg0(300, "sqlite_open\n");
203 if (mdb->db == NULL) {
204 Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
205 db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
210 mdb->connected = true;
212 if (!check_tables_version(jcr, mdb)) {
217 /* set busy handler to wait when we use mult_db_connections = 1 */
219 sqlite3_busy_handler(mdb->db, my_busy_handler, NULL);
221 sqlite_busy_handler(mdb->db, my_busy_handler, NULL);
229 db_close_database(JCR *jcr, B_DB *mdb)
234 db_end_transaction(jcr, mdb);
236 sql_free_result(mdb);
238 if (mdb->ref_count == 0) {
240 if (mdb->connected && mdb->db) {
241 sqlite_close(mdb->db);
243 rwl_destroy(&mdb->lock);
244 free_pool_memory(mdb->errmsg);
245 free_pool_memory(mdb->cmd);
246 free_pool_memory(mdb->cached_path);
247 free_pool_memory(mdb->fname);
248 free_pool_memory(mdb->path);
249 free_pool_memory(mdb->esc_name);
250 free_pool_memory(mdb->esc_path);
259 void db_thread_cleanup()
262 sqlite3_thread_cleanup();
267 * Return the next unique index (auto-increment) for
268 * the given table. Return 0 on error.
270 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
272 strcpy(index, "NULL");
278 * Escape strings so that SQLite is happy
280 * NOTE! len is the length of the old string. Your new
281 * string must be long enough (max 2*old+1) to hold
282 * the escaped output.
285 db_escape_string(char *snew, char *old, int len)
312 DB_RESULT_HANDLER *result_handler;
317 * Convert SQLite's callback into Bacula DB callback
319 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
321 struct rh_data *rh_data = (struct rh_data *)arh_data;
323 if (rh_data->result_handler) {
324 (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
330 * Submit a general SQL command (cmd), and for each row returned,
331 * the sqlite_handler is called with the ctx.
333 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
335 struct rh_data rh_data;
339 if (mdb->sqlite_errmsg) {
341 sqlite3_free(mdb->sqlite_errmsg);
343 actuallyfree(mdb->sqlite_errmsg);
345 mdb->sqlite_errmsg = NULL;
347 rh_data.result_handler = result_handler;
349 stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
351 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
360 * Submit a sqlite query and retrieve all the data
362 int my_sqlite_query(B_DB *mdb, const char *cmd)
366 my_sqlite_free_table(mdb);
367 if (mdb->sqlite_errmsg) {
369 sqlite3_free(mdb->sqlite_errmsg);
371 actuallyfree(mdb->sqlite_errmsg);
373 mdb->sqlite_errmsg = NULL;
375 stat = sqlite_get_table(mdb->db, (char *)cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
376 &mdb->sqlite_errmsg);
377 mdb->row = 0; /* row fetched */
381 /* Fetch one row at a time */
382 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
384 if (mdb->row >= mdb->nrow) {
388 return &mdb->result[mdb->ncolumn * mdb->row];
391 void my_sqlite_free_table(B_DB *mdb)
395 if (mdb->fields_defined) {
396 for (i=0; i < sql_num_fields(mdb); i++) {
397 free(mdb->fields[i]);
400 mdb->fields_defined = false;
403 sqlite_free_table(mdb->result);
406 mdb->nrow = mdb->ncolumn = 0;
409 void my_sqlite_field_seek(B_DB *mdb, int field)
412 if (mdb->result == NULL) {
415 /* On first call, set up the fields */
416 if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
417 mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
418 for (i=0; i < sql_num_fields(mdb); i++) {
419 mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
420 mdb->fields[i]->name = mdb->result[i];
421 mdb->fields[i]->length = cstrlen(mdb->fields[i]->name);
422 mdb->fields[i]->max_length = mdb->fields[i]->length;
423 for (j=1; j <= mdb->nrow; j++) {
425 if (mdb->result[i + mdb->ncolumn *j]) {
426 len = (uint32_t)cstrlen(mdb->result[i + mdb->ncolumn * j]);
430 if (len > mdb->fields[i]->max_length) {
431 mdb->fields[i]->max_length = len;
434 mdb->fields[i]->type = 0;
435 mdb->fields[i]->flags = 1; /* not null */
437 mdb->fields_defined = TRUE;
439 if (field > sql_num_fields(mdb)) {
440 field = sql_num_fields(mdb);
446 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
448 return mdb->fields[mdb->field++];
451 char *my_sqlite_batch_lock_query = "BEGIN";
452 char *my_sqlite_batch_unlock_query = "COMMIT";
453 char *my_sqlite_batch_fill_path_query = "INSERT INTO Path (Path) "
454 " SELECT DISTINCT Path FROM batch "
455 " EXCEPT SELECT Path FROM Path ";
457 char *my_sqlite_batch_fill_filename_query = "INSERT INTO Filename (Name) "
458 " SELECT DISTINCT Name FROM batch "
459 " EXCEPT SELECT Name FROM Filename ";
463 #endif /* HAVE_SQLITE */