2 Bacula® - The Network Backup Solution
4 Copyright (C) 2003-2010 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 Kern Sibbald.
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 Ingres
30 * These are Ingres specific routines
32 * Stefan Reddig, June 2009
33 * based uopn work done
34 * by Dan Langille, December 2003 and
35 * by Kern Sibbald, March 2000
40 /* The following is necessary so that we do not include
41 * the dummy external definition of DB.
43 #define __SQL_C /* indicate that this is sql.c */
52 /* -----------------------------------------------------------------------
54 * Ingres dependent defines and subroutines
56 * -----------------------------------------------------------------------
59 /* List of open databases */ /* SRE: needed for ingres? */
60 static BQUEUE db_list = {&db_list, &db_list};
62 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
65 * Retrieve database type
74 * Initialize database data structure. In principal this should
75 * never have errors, or it is really fatal.
78 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
79 const char *db_address, int db_port, const char *db_socket,
80 int mult_db_connections)
85 Jmsg(jcr, M_FATAL, 0, _("A user name for Ingres must be supplied.\n"));
88 P(mutex); /* lock DB queue */
89 if (!mult_db_connections) {
90 /* Look to see if DB already open */
91 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
92 if (bstrcmp(mdb->db_name, db_name) &&
93 bstrcmp(mdb->db_address, db_address) &&
94 mdb->db_port == db_port) {
95 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
98 return mdb; /* already open */
102 Dmsg0(100, "db_open first time\n");
103 mdb = (B_DB *)malloc(sizeof(B_DB));
104 memset(mdb, 0, sizeof(B_DB));
105 mdb->db_name = bstrdup(db_name);
106 mdb->db_user = bstrdup(db_user);
108 mdb->db_password = bstrdup(db_password);
111 mdb->db_address = bstrdup(db_address);
114 mdb->db_socket = bstrdup(db_socket);
116 mdb->db_port = db_port;
117 mdb->have_insert_id = TRUE;
118 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
120 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
121 mdb->cached_path = get_pool_memory(PM_FNAME);
122 mdb->cached_path_id = 0;
124 mdb->fname = get_pool_memory(PM_FNAME);
125 mdb->path = get_pool_memory(PM_FNAME);
126 mdb->esc_name = get_pool_memory(PM_FNAME);
127 mdb->esc_path = get_pool_memory(PM_FNAME);
128 mdb->allow_transactions = mult_db_connections;
129 mdb->limit_filter = new_bregexp("/LIMIT ([0-9]+)/FETCH FIRST $1 ROW ONLY/g");
130 qinsert(&db_list, &mdb->bq); /* put db in list */
135 /* Check that the database correspond to the encoding we want */
136 static bool check_database_encoding(JCR *jcr, B_DB *mdb)
138 /* SRE: TODO! Needed?
142 if (!db_sql_query(mdb, "SELECT getdatabaseencoding()", NULL, NULL)) {
143 Jmsg(jcr, M_ERROR, 0, "%s", mdb->errmsg);
147 if ((row = sql_fetch_row(mdb)) == NULL) {
148 Mmsg1(mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
149 Jmsg(jcr, M_ERROR, 0, "Can't check database encoding %s", mdb->errmsg);
151 ret = bstrcmp(row[0], "SQL_ASCII");
154 _("Encoding error for database \"%s\". Wanted SQL_ASCII, got %s\n"),
155 mdb->db_name, row[0]);
156 Jmsg(jcr, M_WARNING, 0, "%s", mdb->errmsg);
157 Dmsg1(50, "%s", mdb->errmsg);
166 * Check for errors in DBMS work
168 static int sql_check(B_DB *mdb)
172 if ((errorcode = INGcheck()) < 0) {
173 /* TODO: fill mdb->errmsg */
174 Mmsg(mdb->errmsg, "Something went wrong - still searching!\n");
175 } else if (errorcode > 0) {
176 /* just a warning, proceed */
182 * Now actually open the database. This can generate errors,
183 * which are returned in the errmsg
185 * DO NOT close the database or free(mdb) here !!!!
188 db_open_database(JCR *jcr, B_DB *mdb)
194 if (mdb->connected) {
198 mdb->connected = false;
200 if ((errstat=rwl_init(&mdb->lock)) != 0) {
202 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
203 be.bstrerror(errstat));
209 bsnprintf(buf, sizeof(buf), "%d", mdb->db_port);
215 mdb->db = INGconnectDB(mdb->db_name, mdb->db_user, mdb->db_password);
217 Dmsg0(50, "Ingres real CONNECT done\n");
218 Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
219 mdb->db_password==NULL?"(NULL)":mdb->db_password);
221 if (sql_check(mdb)) {
222 Mmsg2(&mdb->errmsg, _("Unable to connect to Ingres server.\n"
223 "Database=%s User=%s\n"
224 "It is probably not running or your password is incorrect.\n"),
225 mdb->db_name, mdb->db_user);
230 mdb->connected = true;
232 if (!check_tables_version(jcr, mdb)) {
237 //sql_query(mdb, "SET datestyle TO 'ISO, YMD'");
239 /* check that encoding is SQL_ASCII */
240 check_database_encoding(jcr, mdb);
247 db_close_database(JCR *jcr, B_DB *mdb)
252 db_end_transaction(jcr, mdb);
254 sql_free_result(mdb);
256 if (mdb->ref_count == 0) {
258 if (mdb->connected && mdb->db) {
261 rwl_destroy(&mdb->lock);
262 free_pool_memory(mdb->errmsg);
263 free_pool_memory(mdb->cmd);
264 free_pool_memory(mdb->cached_path);
265 free_pool_memory(mdb->fname);
266 free_pool_memory(mdb->path);
267 free_pool_memory(mdb->esc_name);
268 free_pool_memory(mdb->esc_path);
269 free_bregexp(mdb->limit_filter);
276 if (mdb->db_password) {
277 free(mdb->db_password);
279 if (mdb->db_address) {
280 free(mdb->db_address);
282 if (mdb->db_socket) {
283 free(mdb->db_socket);
290 void db_check_backend_thread_safe()
295 void db_thread_cleanup()
299 * Return the next unique index (auto-increment) for
300 * the given table. Return NULL on error.
302 * For Ingres, NULL causes the auto-increment value SRE: true?
305 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
307 strcpy(index, "NULL");
313 * Escape strings so that Ingres is happy
315 * NOTE! len is the length of the old string. Your new
316 * string must be long enough (max 2*old+1) to hold
317 * the escaped output.
320 db_escape_string(JCR *jcr, B_DB *mdb, char *snew, char *old, int len)
347 * Submit a general SQL command (cmd), and for each row returned,
348 * the sqlite_handler is called with the ctx.
350 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
354 Dmsg0(500, "db_sql_query started\n");
357 if (sql_query(mdb, query) != 0) {
358 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
360 Dmsg0(500, "db_sql_query failed\n");
363 Dmsg0(500, "db_sql_query succeeded. checking handler\n");
365 if (result_handler != NULL) {
366 Dmsg0(500, "db_sql_query invoking handler\n");
367 if (mdb->result != NULL) {
368 int num_fields = sql_num_fields(mdb);
370 Dmsg0(500, "db_sql_query sql_store_result suceeded\n");
371 while ((row = sql_fetch_row(mdb)) != NULL) {
373 Dmsg0(500, "db_sql_query sql_fetch_row worked\n");
374 if (result_handler(ctx, num_fields, row))
378 sql_free_result(mdb);
383 Dmsg0(500, "db_sql_query finished\n");
389 * Close database connection
391 void my_ingres_close(B_DB *mdb)
393 INGdisconnectDB(mdb->db);
394 //SRE: error handling?
397 INGRES_ROW my_ingres_fetch_row(B_DB *mdb)
400 INGRES_ROW row = NULL; // by default, return NULL
405 if (mdb->result->num_rows <= 0) {
409 Dmsg0(500, "my_ingres_fetch_row start\n");
411 if (!mdb->row || mdb->row_size < mdb->num_fields) {
412 int num_fields = mdb->num_fields;
413 Dmsg1(500, "we have need space of %d bytes\n", sizeof(char *) * mdb->num_fields);
416 Dmsg0(500, "my_ingres_fetch_row freeing space\n");
419 num_fields += 20; /* add a bit extra */
420 mdb->row = (INGRES_ROW)malloc(sizeof(char *) * num_fields);
421 mdb->row_size = num_fields;
423 // now reset the row_number now that we have the space allocated
424 //mdb->row_number = 1;
428 // if still within the result set
429 //if (mdb->row_number <= mdb->num_rows) {
430 if (mdb->row_number < mdb->num_rows) {
431 Dmsg2(500, "my_ingres_fetch_row row number '%d' is acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
432 // get each value from this row
433 for (j = 0; j < mdb->num_fields; j++) {
434 mdb->row[j] = INGgetvalue(mdb->result, mdb->row_number, j);
435 Dmsg2(500, "my_ingres_fetch_row field '%d' has value '%s'\n", j, mdb->row[j]);
437 // increment the row number for the next call
442 Dmsg2(500, "my_ingres_fetch_row row number '%d' is NOT acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
445 Dmsg1(500, "my_ingres_fetch_row finishes returning %p\n", row);
451 int my_ingres_max_length(B_DB *mdb, int field_num) {
453 // for a given column, find the max length
460 for (i = 0; i < mdb->num_rows; i++) {
461 if (INGgetisnull(mdb->result, i, field_num)) {
462 this_length = 4; // "NULL"
464 this_length = cstrlen(INGgetvalue(mdb->result, i, field_num));
467 if (max_length < this_length) {
468 max_length = this_length;
475 INGRES_FIELD * my_ingres_fetch_field(B_DB *mdb)
479 Dmsg0(500, "my_ingres_fetch_field starts\n");
481 if (!mdb->fields || mdb->fields_size < mdb->num_fields) {
485 Dmsg1(500, "allocating space for %d fields\n", mdb->num_fields);
486 mdb->fields = (INGRES_FIELD *)malloc(sizeof(INGRES_FIELD) * mdb->num_fields);
487 mdb->fields_size = mdb->num_fields;
489 for (i = 0; i < mdb->num_fields; i++) {
490 Dmsg1(500, "filling field %d\n", i);
491 strcpy(mdb->fields[i].name,INGfname(mdb->result, i));
492 mdb->fields[i].max_length = my_ingres_max_length(mdb, i);
493 mdb->fields[i].type = INGftype(mdb->result, i);
494 mdb->fields[i].flags = 0;
496 Dmsg4(500, "my_ingres_fetch_field finds field '%s' has length='%d' type='%d' and IsNull=%d\n",
497 mdb->fields[i].name, mdb->fields[i].max_length, mdb->fields[i].type,
498 mdb->fields[i].flags);
502 // increment field number for the next time around
504 Dmsg0(500, "my_ingres_fetch_field finishes\n");
505 return &mdb->fields[mdb->field_number++];
508 void my_ingres_data_seek(B_DB *mdb, int row)
510 // set the row number to be returned on the next call
511 // to my_ingres_fetch_row
512 mdb->row_number = row;
515 void my_ingres_field_seek(B_DB *mdb, int field)
517 mdb->field_number = field;
521 * Note, if this routine returns 1 (failure), Bacula expects
522 * that no result has been stored.
524 * Returns: 0 on success
528 int my_ingres_query(B_DB *mdb, const char *query)
530 Dmsg0(500, "my_ingres_query started\n");
531 // We are starting a new query. reset everything.
533 mdb->row_number = -1;
534 mdb->field_number = -1;
539 INGclear(mdb->result); /* hmm, someone forgot to free?? */
543 Dmsg1(500, "my_ingres_query starts with '%s'\n", query);
545 /* TODO: differentiate between SELECTs and other queries */
547 if ((cols = INGgetCols(mdb, query)) <= 0) {
549 Dmsg0(500,"my_ingres_query: neg.columns: no DML stmt!\n");
551 Dmsg0(500,"my_ingres_query (non SELECT) starting...\n");
553 mdb->num_rows = INGexec(mdb, mdb->db, query);
555 Dmsg0(500,"my_ingres_query (non SELECT) went wrong\n");
558 Dmsg0(500,"my_ingres_query (non SELECT) seems ok\n");
563 Dmsg0(500,"my_ingres_query (SELECT) starting...\n");
564 mdb->result = INGquery(mdb, mdb->db, query);
565 if ( mdb->result != NULL ) {
566 Dmsg1(500, "we have a result\n", query);
568 // how many fields in the set?
569 mdb->num_fields = (int)INGnfields(mdb->result);
570 Dmsg1(500, "we have %d fields\n", mdb->num_fields);
572 mdb->num_rows = INGntuples(mdb->result);
573 Dmsg1(500, "we have %d rows\n", mdb->num_rows);
575 mdb->status = 0; /* succeed */
577 Dmsg0(500, "No resultset...\n");
578 mdb->status = 1; /* failed */
582 Dmsg0(500, "my_ingres_query finishing\n");
586 void my_ingres_free_result(B_DB *mdb)
591 INGclear(mdb->result);
607 int my_ingres_currval(B_DB *mdb, const char *table_name)
613 #ifdef HAVE_BATCH_FILE_INSERT
615 int my_ingres_batch_start(JCR *jcr, B_DB *mdb)
621 /* set error to something to abort operation */
622 int my_ingres_batch_end(JCR *jcr, B_DB *mdb, const char *error)
628 int my_ingres_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar)
634 #endif /* HAVE_BATCH_FILE_INSERT */
637 * Escape strings so that Ingres is happy on COPY
639 * NOTE! len is the length of the old string. Your new
640 * string must be long enough (max 2*old+1) to hold
641 * the escaped output.
643 char *my_ingres_copy_escape(char *dest, char *src, size_t len)
645 /* we have to escape \t, \n, \r, \ */
648 while (len > 0 && *src) {
683 #ifdef HAVE_BATCH_FILE_INSERT
684 const char *my_ingres_batch_lock_path_query =
685 "BEGIN; LOCK TABLE Path IN SHARE ROW EXCLUSIVE MODE";
688 const char *my_ingres_batch_lock_filename_query =
689 "BEGIN; LOCK TABLE Filename IN SHARE ROW EXCLUSIVE MODE";
691 const char *my_ingres_batch_unlock_tables_query = "COMMIT";
693 const char *my_ingres_batch_fill_path_query =
694 "INSERT INTO Path (Path) "
695 "SELECT a.Path FROM "
696 "(SELECT DISTINCT Path FROM batch) AS a "
697 "WHERE NOT EXISTS (SELECT Path FROM Path WHERE Path = a.Path) ";
700 const char *my_ingres_batch_fill_filename_query =
701 "INSERT INTO Filename (Name) "
702 "SELECT a.Name FROM "
703 "(SELECT DISTINCT Name FROM batch) as a "
705 "(SELECT Name FROM Filename WHERE Name = a.Name)";
706 #endif /* HAVE_BATCH_FILE_INSERT */
708 #endif /* HAVE_INGRES */