2 * Bacula Catalog Database routines specific to SQLite
4 * Kern Sibbald, January 2002
8 Copyright (C) 2002 Kern Sibbald and John Walker
10 This program is free software; you can redistribute it and/or
11 modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 2 of
13 the License, or (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public
21 License along with this program; if not, write to the Free
22 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 /* The following is necessary so that we do not include
29 * the dummy external definition of DB.
31 #define __SQL_C /* indicate that this is sql.c */
38 /* -----------------------------------------------------------------------
40 * SQLite dependent defines and subroutines
42 * -----------------------------------------------------------------------
45 extern char *working_directory;
47 /* List of open databases */
48 static BQUEUE db_list = {&db_list, &db_list};
50 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
52 int QueryDB(char *file, int line, B_DB *db, char *select_cmd);
56 * Initialize database data structure. In principal this should
57 * never have errors, or it is really fatal.
60 db_init_database(char *db_name, char *db_user, char *db_password)
64 P(mutex); /* lock DB queue */
65 /* Look to see if DB already open */
66 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
67 if (strcmp(mdb->db_name, db_name) == 0) {
68 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
71 return mdb; /* already open */
74 Dmsg0(100, "db_open first time\n");
75 mdb = (B_DB *) malloc(sizeof(B_DB));
76 memset(mdb, 0, sizeof(B_DB));
77 mdb->db_name = bstrdup(db_name);
78 mdb->have_insert_id = TRUE;
79 mdb->errmsg = (char *) get_pool_memory(PM_EMSG); /* get error message buffer */
81 mdb->cmd = (char *) get_pool_memory(PM_EMSG); /* get command buffer */
83 qinsert(&db_list, &mdb->bq); /* put db in list */
89 * Now actually open the database. This can generate errors,
90 * which are returned in the errmsg
93 db_open_database(B_DB *mdb)
100 if (mdb->connected) {
104 mdb->connected = FALSE;
105 if (pthread_mutex_init(&mdb->mutex, NULL) != 0) {
106 Mmsg1(&mdb->errmsg, _("Unable to initialize DB mutex. ERR=%s\n"), strerror(errno));
111 /* open the database */
112 len = strlen(working_directory) + strlen(mdb->db_name) + 5;
113 db_name = (char *)malloc(len);
114 strcpy(db_name, working_directory);
115 strcat(db_name, "/");
116 strcat(db_name, mdb->db_name);
117 strcat(db_name, ".db");
118 if (stat(db_name, &statbuf) != 0) {
119 Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
125 mdb->db = sqlite_open(
126 db_name, /* database name */
128 &mdb->sqlite_errmsg); /* error message */
130 Dmsg0(50, "sqlite_open\n");
132 if (mdb->db == NULL) {
133 Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
134 db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
140 if (!check_tables_version(mdb)) {
145 mdb->connected = TRUE;
151 db_close_database(B_DB *mdb)
155 if (mdb->ref_count == 0) {
157 if (mdb->connected && mdb->db) {
158 sqlite_close(mdb->db);
160 pthread_mutex_destroy(&mdb->mutex);
161 free_pool_memory(mdb->errmsg);
162 free_pool_memory(mdb->cmd);
172 * Return the next unique index (auto-increment) for
173 * the given table. Return NULL on error.
175 char *db_next_index(B_DB *mdb, char *table)
180 QUERY_DB(mdb, "BEGIN TRANSACTION");
181 sql_free_result(mdb);
184 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
185 if (!QUERY_DB(mdb, mdb->cmd)) {
186 Mmsg(&mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
187 QUERY_DB(mdb, "ROLLBACK");
190 if ((row = sql_fetch_row(mdb)) == NULL) {
191 Mmsg(&mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
192 QUERY_DB(mdb, "ROLLBACK");
195 strncpy(id, row[0], sizeof(id));
196 id[sizeof(id)-1] = 0;
197 sql_free_result(mdb);
200 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
201 if (!QUERY_DB(mdb, mdb->cmd)) {
202 Mmsg(&mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
203 QUERY_DB(mdb, "ROLLBACK");
206 sql_free_result(mdb);
208 QUERY_DB(mdb, "COMMIT");
209 sql_free_result(mdb);
216 db_escape_string(char *snew, char *old, int len)
248 DB_RESULT_HANDLER *result_handler;
253 * Convert SQLite's callback into Bacula DB callback
255 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
257 struct rh_data *rh_data = (struct rh_data *)arh_data;
259 if (rh_data->result_handler) {
260 (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
266 * Submit a general SQL command (cmd), and for each row returned,
267 * the sqlite_handler is called with the ctx.
269 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
271 struct rh_data rh_data;
275 if (mdb->sqlite_errmsg) {
276 actuallyfree(mdb->sqlite_errmsg);
277 mdb->sqlite_errmsg = NULL;
279 rh_data.result_handler = result_handler;
281 stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
283 Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
292 * Submit a sqlite query and retrieve all the data
294 int my_sqlite_query(B_DB *mdb, char *cmd)
298 if (mdb->sqlite_errmsg) {
299 actuallyfree(mdb->sqlite_errmsg);
300 mdb->sqlite_errmsg = NULL;
302 stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
303 &mdb->sqlite_errmsg);
304 mdb->row = 0; /* row fetched */
308 /* Fetch one row at a time */
309 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
311 if (mdb->row >= mdb->nrow) {
315 return &mdb->result[mdb->ncolumn * mdb->row];
318 void my_sqlite_free_table(B_DB *mdb)
322 if (mdb->fields_defined) {
323 for (i=0; i < sql_num_fields(mdb); i++) {
324 free(mdb->fields[i]);
327 mdb->fields_defined = FALSE;
329 sqlite_free_table(mdb->result);
330 mdb->nrow = mdb->ncolumn = 0;
333 void my_sqlite_field_seek(B_DB *mdb, int field)
336 if (mdb->result == NULL) {
339 /* On first call, set up the fields */
340 if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
341 mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
342 for (i=0; i < sql_num_fields(mdb); i++) {
343 mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
344 mdb->fields[i]->name = mdb->result[i];
345 mdb->fields[i]->length = strlen(mdb->fields[i]->name);
346 mdb->fields[i]->max_length = mdb->fields[i]->length;
347 for (j=1; j <= (unsigned)mdb->nrow; j++) {
349 if (mdb->result[i + mdb->ncolumn *j]) {
350 len = (uint32_t)strlen(mdb->result[i + mdb->ncolumn * j]);
354 if (len > mdb->fields[i]->max_length) {
355 mdb->fields[i]->max_length = len;
358 mdb->fields[i]->type = 0;
359 mdb->fields[i]->flags = 1; /* not null */
361 mdb->fields_defined = TRUE;
363 if (field > (int)sql_num_fields(mdb)) {
364 field = (int)sql_num_fields(mdb);
370 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
372 return mdb->fields[mdb->field++];
376 list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
381 sql_field_seek(mdb, 0);
383 for (i = 0; i < sql_num_fields(mdb); i++) {
384 field = sql_fetch_field(mdb);
385 for (j = 0; j < field->max_length + 2; j++)
393 list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx)
397 unsigned int i, col_len;
398 char buf[2000], ewc[30];
400 if (mdb->result == NULL || mdb->nrow == 0) {
403 /* determine column display widths */
404 sql_field_seek(mdb, 0);
405 for (i = 0; i < sql_num_fields(mdb); i++) {
406 field = sql_fetch_field(mdb);
407 if (IS_NUM(field->type) && field->max_length > 0) { /* fixup for commas */
408 field->max_length += (field->max_length - 1) / 3;
410 col_len = strlen(field->name);
411 if (col_len < field->max_length)
412 col_len = field->max_length;
413 if (col_len < 4 && !IS_NOT_NULL(field->flags))
414 col_len = 4; /* 4 = length of the word "NULL" */
415 field->max_length = col_len; /* reset column info */
418 list_dashes(mdb, send, ctx);
420 sql_field_seek(mdb, 0);
421 for (i = 0; i < sql_num_fields(mdb); i++) {
422 field = sql_fetch_field(mdb);
423 sprintf(buf, " %-*s |", field->max_length, field->name);
427 list_dashes(mdb, send, ctx);
429 while ((row = sql_fetch_row(mdb)) != NULL) {
430 sql_field_seek(mdb, 0);
432 for (i = 0; i < sql_num_fields(mdb); i++) {
433 field = sql_fetch_field(mdb);
434 if (row[i] == NULL) {
435 sprintf(buf, " %-*s |", field->max_length, "NULL");
436 } else if (IS_NUM(field->type)) {
437 sprintf(buf, " %*s |", field->max_length,
438 add_commas(row[i], ewc));
440 sprintf(buf, " %-*s |", field->max_length, row[i]);
446 list_dashes(mdb, send, ctx);
450 #endif /* HAVE_SQLITE */