2 * Bacula Catalog Database routines specific to SQLite
4 * Kern Sibbald, January 2002
10 Copyright (C) 2002-2003 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /* The following is necessary so that we do not include
31 * the dummy external definition of DB.
33 #define __SQL_C /* indicate that this is sql.c */
40 /* -----------------------------------------------------------------------
42 * SQLite dependent defines and subroutines
44 * -----------------------------------------------------------------------
47 extern char *working_directory;
49 /* List of open databases */
50 static BQUEUE db_list = {&db_list, &db_list};
52 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
54 int QueryDB(char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
58 * Initialize database data structure. In principal this should
59 * never have errors, or it is really fatal.
62 db_init_database(JCR *jcr, char *db_name, char *db_user, char *db_password,
63 char *db_address, int db_port, char *db_socket)
67 P(mutex); /* lock DB queue */
68 /* Look to see if DB already open */
69 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
70 if (strcmp(mdb->db_name, db_name) == 0) {
71 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
74 return mdb; /* already open */
77 Dmsg0(100, "db_open first time\n");
78 mdb = (B_DB *) malloc(sizeof(B_DB));
79 memset(mdb, 0, sizeof(B_DB));
80 mdb->db_name = bstrdup(db_name);
81 mdb->have_insert_id = TRUE;
82 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
84 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
85 mdb->cached_path = get_pool_memory(PM_FNAME);
86 mdb->cached_path_id = 0;
88 mdb->fname = get_pool_memory(PM_FNAME);
89 mdb->path = get_pool_memory(PM_FNAME);
90 mdb->esc_name = get_pool_memory(PM_FNAME);
91 qinsert(&db_list, &mdb->bq); /* put db in list */
97 * Now actually open the database. This can generate errors,
98 * which are returned in the errmsg
101 db_open_database(JCR *jcr, B_DB *mdb)
109 if (mdb->connected) {
113 mdb->connected = FALSE;
115 if ((errstat=rwl_init(&mdb->lock)) != 0) {
116 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
122 /* open the database */
123 len = strlen(working_directory) + strlen(mdb->db_name) + 5;
124 db_name = (char *)malloc(len);
125 strcpy(db_name, working_directory);
126 strcat(db_name, "/");
127 strcat(db_name, mdb->db_name);
128 strcat(db_name, ".db");
129 if (stat(db_name, &statbuf) != 0) {
130 Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
136 mdb->db = sqlite_open(
137 db_name, /* database name */
139 &mdb->sqlite_errmsg); /* error message */
141 Dmsg0(50, "sqlite_open\n");
143 if (mdb->db == NULL) {
144 Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
145 db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
151 if (!check_tables_version(jcr, mdb)) {
156 mdb->connected = TRUE;
162 db_close_database(JCR *jcr, B_DB *mdb)
166 if (mdb->ref_count == 0) {
168 if (mdb->connected && mdb->db) {
169 sqlite_close(mdb->db);
171 rwl_destroy(&mdb->lock);
172 free_pool_memory(mdb->errmsg);
173 free_pool_memory(mdb->cmd);
174 free_pool_memory(mdb->cached_path);
175 free_pool_memory(mdb->fname);
176 free_pool_memory(mdb->path);
177 free_pool_memory(mdb->esc_name);
187 * Return the next unique index (auto-increment) for
188 * the given table. Return 0 on error.
190 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
197 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
198 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
199 Mmsg(&mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
203 if ((row = sql_fetch_row(mdb)) == NULL) {
204 Mmsg(&mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
208 bstrncpy(index, row[0], 28);
209 sql_free_result(mdb);
212 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
213 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
214 Mmsg(&mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
218 sql_free_result(mdb);
226 * Escape strings so that SQLite is happy
228 * NOTE! len is the length of the old string. Your new
229 * string must be long enough (max 2*old+1) to hold
230 * the escaped output.
233 db_escape_string(char *snew, char *old, int len)
260 DB_RESULT_HANDLER *result_handler;
265 * Convert SQLite's callback into Bacula DB callback
267 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
269 struct rh_data *rh_data = (struct rh_data *)arh_data;
271 if (rh_data->result_handler) {
272 (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
278 * Submit a general SQL command (cmd), and for each row returned,
279 * the sqlite_handler is called with the ctx.
281 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
283 struct rh_data rh_data;
287 if (mdb->sqlite_errmsg) {
288 actuallyfree(mdb->sqlite_errmsg);
289 mdb->sqlite_errmsg = NULL;
291 rh_data.result_handler = result_handler;
293 stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
295 Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
304 * Submit a sqlite query and retrieve all the data
306 int my_sqlite_query(B_DB *mdb, char *cmd)
310 if (mdb->sqlite_errmsg) {
311 actuallyfree(mdb->sqlite_errmsg);
312 mdb->sqlite_errmsg = NULL;
314 stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
315 &mdb->sqlite_errmsg);
316 mdb->row = 0; /* row fetched */
320 /* Fetch one row at a time */
321 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
323 if (mdb->row >= mdb->nrow) {
327 return &mdb->result[mdb->ncolumn * mdb->row];
330 void my_sqlite_free_table(B_DB *mdb)
334 if (mdb->fields_defined) {
335 for (i=0; i < sql_num_fields(mdb); i++) {
336 free(mdb->fields[i]);
339 mdb->fields_defined = FALSE;
341 sqlite_free_table(mdb->result);
342 mdb->nrow = mdb->ncolumn = 0;
345 void my_sqlite_field_seek(B_DB *mdb, int field)
348 if (mdb->result == NULL) {
351 /* On first call, set up the fields */
352 if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
353 mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
354 for (i=0; i < sql_num_fields(mdb); i++) {
355 mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
356 mdb->fields[i]->name = mdb->result[i];
357 mdb->fields[i]->length = strlen(mdb->fields[i]->name);
358 mdb->fields[i]->max_length = mdb->fields[i]->length;
359 for (j=1; j <= (unsigned)mdb->nrow; j++) {
361 if (mdb->result[i + mdb->ncolumn *j]) {
362 len = (uint32_t)strlen(mdb->result[i + mdb->ncolumn * j]);
366 if (len > mdb->fields[i]->max_length) {
367 mdb->fields[i]->max_length = len;
370 mdb->fields[i]->type = 0;
371 mdb->fields[i]->flags = 1; /* not null */
373 mdb->fields_defined = TRUE;
375 if (field > (int)sql_num_fields(mdb)) {
376 field = (int)sql_num_fields(mdb);
382 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
384 return mdb->fields[mdb->field++];
388 list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
393 sql_field_seek(mdb, 0);
395 for (i = 0; i < sql_num_fields(mdb); i++) {
396 field = sql_fetch_field(mdb);
397 for (j = 0; j < field->max_length + 2; j++)
405 * If full_list is set, we list vertically, otherwise, we
406 * list on one line horizontally.
409 list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type)
413 unsigned int i, col_len, max_len = 0;
414 char buf[2000], ewc[30];
416 if (mdb->result == NULL || mdb->nrow == 0) {
417 send(ctx, _("No results to list.\n"));
420 /* determine column display widths */
421 sql_field_seek(mdb, 0);
422 for (i = 0; i < sql_num_fields(mdb); i++) {
423 field = sql_fetch_field(mdb);
424 col_len = strlen(field->name);
425 if (type == VERT_LIST) {
426 if (col_len > max_len) {
430 if (IS_NUM(field->type) && field->max_length > 0) { /* fixup for commas */
431 field->max_length += (field->max_length - 1) / 3;
433 if (col_len < field->max_length) {
434 col_len = field->max_length;
436 if (col_len < 4 && !IS_NOT_NULL(field->flags)) {
437 col_len = 4; /* 4 = length of the word "NULL" */
439 field->max_length = col_len; /* reset column info */
443 if (type == VERT_LIST) {
447 list_dashes(mdb, send, ctx);
449 sql_field_seek(mdb, 0);
450 for (i = 0; i < sql_num_fields(mdb); i++) {
451 field = sql_fetch_field(mdb);
452 bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, field->name);
456 list_dashes(mdb, send, ctx);
458 while ((row = sql_fetch_row(mdb)) != NULL) {
459 sql_field_seek(mdb, 0);
461 for (i = 0; i < sql_num_fields(mdb); i++) {
462 field = sql_fetch_field(mdb);
463 if (row[i] == NULL) {
464 bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, "NULL");
465 } else if (IS_NUM(field->type)) {
466 bsnprintf(buf, sizeof(buf), " %*s |", (int)field->max_length,
467 add_commas(row[i], ewc));
469 bsnprintf(buf, sizeof(buf), " %-*s |", (int)field->max_length, row[i]);
475 list_dashes(mdb, send, ctx);
480 while ((row = sql_fetch_row(mdb)) != NULL) {
481 sql_field_seek(mdb, 0);
482 for (i = 0; i < sql_num_fields(mdb); i++) {
483 field = sql_fetch_field(mdb);
484 if (row[i] == NULL) {
485 bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name, "NULL");
486 } else if (IS_NUM(field->type)) {
487 bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name,
488 add_commas(row[i], ewc));
490 bsnprintf(buf, sizeof(buf), " %*s: %s\n", max_len, field->name, row[i]);
500 #endif /* HAVE_SQLITE */