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
100 * DO NOT close the database or free(mdb) here !!!!
103 db_open_database(JCR *jcr, B_DB *mdb)
111 if (mdb->connected) {
115 mdb->connected = FALSE;
117 if ((errstat=rwl_init(&mdb->lock)) != 0) {
118 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
124 /* open the database */
125 len = strlen(working_directory) + strlen(mdb->db_name) + 5;
126 db_name = (char *)malloc(len);
127 strcpy(db_name, working_directory);
128 strcat(db_name, "/");
129 strcat(db_name, mdb->db_name);
130 strcat(db_name, ".db");
131 if (stat(db_name, &statbuf) != 0) {
132 Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
138 mdb->db = sqlite_open(
139 db_name, /* database name */
141 &mdb->sqlite_errmsg); /* error message */
143 Dmsg0(50, "sqlite_open\n");
145 if (mdb->db == NULL) {
146 Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
147 db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
153 if (!check_tables_version(jcr, mdb)) {
158 mdb->connected = TRUE;
164 db_close_database(JCR *jcr, B_DB *mdb)
171 if (mdb->ref_count == 0) {
173 if (mdb->connected && mdb->db) {
174 sqlite_close(mdb->db);
176 rwl_destroy(&mdb->lock);
177 free_pool_memory(mdb->errmsg);
178 free_pool_memory(mdb->cmd);
179 free_pool_memory(mdb->cached_path);
180 free_pool_memory(mdb->fname);
181 free_pool_memory(mdb->path);
182 free_pool_memory(mdb->esc_name);
192 * Return the next unique index (auto-increment) for
193 * the given table. Return 0 on error.
195 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
202 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
203 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
204 Mmsg(&mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
208 if ((row = sql_fetch_row(mdb)) == NULL) {
209 Mmsg(&mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
213 bstrncpy(index, row[0], 28);
214 sql_free_result(mdb);
217 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
218 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
219 Mmsg(&mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
223 sql_free_result(mdb);
231 * Escape strings so that SQLite is happy
233 * NOTE! len is the length of the old string. Your new
234 * string must be long enough (max 2*old+1) to hold
235 * the escaped output.
238 db_escape_string(char *snew, char *old, int len)
265 DB_RESULT_HANDLER *result_handler;
270 * Convert SQLite's callback into Bacula DB callback
272 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
274 struct rh_data *rh_data = (struct rh_data *)arh_data;
276 if (rh_data->result_handler) {
277 (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
283 * Submit a general SQL command (cmd), and for each row returned,
284 * the sqlite_handler is called with the ctx.
286 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
288 struct rh_data rh_data;
292 if (mdb->sqlite_errmsg) {
293 actuallyfree(mdb->sqlite_errmsg);
294 mdb->sqlite_errmsg = NULL;
296 rh_data.result_handler = result_handler;
298 stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
300 Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
309 * Submit a sqlite query and retrieve all the data
311 int my_sqlite_query(B_DB *mdb, char *cmd)
315 if (mdb->sqlite_errmsg) {
316 actuallyfree(mdb->sqlite_errmsg);
317 mdb->sqlite_errmsg = NULL;
319 stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
320 &mdb->sqlite_errmsg);
321 mdb->row = 0; /* row fetched */
325 /* Fetch one row at a time */
326 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
328 if (mdb->row >= mdb->nrow) {
332 return &mdb->result[mdb->ncolumn * mdb->row];
335 void my_sqlite_free_table(B_DB *mdb)
339 if (mdb->fields_defined) {
340 for (i=0; i < sql_num_fields(mdb); i++) {
341 free(mdb->fields[i]);
344 mdb->fields_defined = FALSE;
346 sqlite_free_table(mdb->result);
347 mdb->nrow = mdb->ncolumn = 0;
350 void my_sqlite_field_seek(B_DB *mdb, int field)
353 if (mdb->result == NULL) {
356 /* On first call, set up the fields */
357 if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
358 mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
359 for (i=0; i < sql_num_fields(mdb); i++) {
360 mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
361 mdb->fields[i]->name = mdb->result[i];
362 mdb->fields[i]->length = strlen(mdb->fields[i]->name);
363 mdb->fields[i]->max_length = mdb->fields[i]->length;
364 for (j=1; j <= mdb->nrow; j++) {
366 if (mdb->result[i + mdb->ncolumn *j]) {
367 len = (uint32_t)strlen(mdb->result[i + mdb->ncolumn * j]);
371 if (len > mdb->fields[i]->max_length) {
372 mdb->fields[i]->max_length = len;
375 mdb->fields[i]->type = 0;
376 mdb->fields[i]->flags = 1; /* not null */
378 mdb->fields_defined = TRUE;
380 if (field > sql_num_fields(mdb)) {
381 field = sql_num_fields(mdb);
387 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
389 return mdb->fields[mdb->field++];
394 #endif /* HAVE_SQLITE */