git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/postgresql.c

   1 /*
   2  * Bacula Catalog Database routines specific to PostgreSQL
   3  *   These are PostgreSQL specific routines
   4  *
   5  *    Dan Langille, December 2003
   6  *    based upon work done by Kern Sibbald, March 2000
   7  *
   8  *    Version $Id$
   9  */
  10
  11 /*
  12    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of
  17    the License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public
  25    License along with this program; if not, write to the Free
  26    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31
  32 /* The following is necessary so that we do not include
  33  * the dummy external definition of DB.
  34  */
  35 #define __SQL_C                       /* indicate that this is sql.c */
  36
  37 #include "bacula.h"
  38 #include "cats.h"
  39
  40 #ifdef HAVE_POSTGRESQL
  41
  42 #include "postgres_ext.h"       /* needed for NAMEDATALEN */
  43
  44 /* -----------------------------------------------------------------------
  45  *
  46  *   PostgreSQL dependent defines and subroutines
  47  *
  48  * -----------------------------------------------------------------------
  49  */
  50
  51 /* List of open databases */
  52 static BQUEUE db_list = {&db_list, &db_list};
  53
  54 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
  55
  56 /*
  57  * Initialize database data structure. In principal this should
  58  * never have errors, or it is really fatal.
  59  */
  60 B_DB *
  61 db_init_database(JCR *jcr, char *db_name, char *db_user, char *db_password,
  62                  char *db_address, int db_port, char *db_socket)
  63 {
  64    B_DB *mdb;
  65
  66    if (!db_user) {
  67       Jmsg(jcr, M_FATAL, 0, _("A user name for PostgreSQL must be supplied.\n"));
  68       return NULL;
  69    }
  70    P(mutex);                          /* lock DB queue */
  71    /* Look to see if DB already open */
  72    for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
  73       if (strcmp(mdb->db_name, db_name) == 0) {
  74          Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
  75          mdb->ref_count++;
  76          V(mutex);
  77          return mdb;                  /* already open */
  78       }
  79    }
  80    Dmsg0(100, "db_open first time\n");
  81    mdb = (B_DB *) malloc(sizeof(B_DB));
  82    memset(mdb, 0, sizeof(B_DB));
  83    mdb->db_name = bstrdup(db_name);
  84    mdb->db_user = bstrdup(db_user);
  85    if (db_password) {
  86       mdb->db_password = bstrdup(db_password);
  87    }
  88    if (db_address) {
  89       mdb->db_address  = bstrdup(db_address);
  90    }
  91    if (db_socket) {
  92       mdb->db_socket   = bstrdup(db_socket);
  93    }
  94    mdb->db_port        = db_port;
  95    mdb->have_insert_id = TRUE;
  96    mdb->errmsg         = get_pool_memory(PM_EMSG); /* get error message buffer */
  97    *mdb->errmsg        = 0;
  98    mdb->cmd                = get_pool_memory(PM_EMSG); /* get command buffer */
  99    mdb->cached_path    = get_pool_memory(PM_FNAME);
 100    mdb->cached_path_id = 0;
 101    mdb->ref_count      = 1;
 102    mdb->fname          = get_pool_memory(PM_FNAME);
 103    mdb->path           = get_pool_memory(PM_FNAME);
 104    mdb->esc_name       = get_pool_memory(PM_FNAME);
 105    qinsert(&db_list, &mdb->bq);            /* put db in list */
 106    V(mutex);
 107    return mdb;
 108 }
 109
 110 /*
 111  * Now actually open the database.  This can generate errors,
 112  * which are returned in the errmsg
 113  */
 114 int
 115 db_open_database(JCR *jcr, B_DB *mdb)
 116 {
 117    int errstat;
 118
 119    P(mutex);
 120    if (mdb->connected) {
 121       V(mutex);
 122       return 1;
 123    }
 124    mdb->connected = FALSE;
 125
 126    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 127       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 128             strerror(errstat));
 129       V(mutex);
 130       return 0;
 131    }
 132
 133    /* connect to the database */
 134    mdb->db = PQsetdbLogin(
 135         mdb->db_address,              /* default = localhost */
 136         (char *) mdb->db_port,    /* default port */
 137         NULL,                     /* pg options */
 138         NULL,                     /* tty, ignored */
 139         mdb->db_name,                 /* database name */
 140         mdb->db_user,                 /* login name */
 141         mdb->db_password);            /* password */
 142
 143    /* If no connect, try once more in case it is a timing problem */
 144    if (PQstatus(mdb->db) != CONNECTION_OK) {
 145    mdb->db = PQsetdbLogin(
 146         mdb->db_address,              /* default = localhost */
 147         (char *) mdb->db_port,    /* default port */
 148         NULL,                     /* pg options */
 149         NULL,                     /* tty, ignored */
 150         mdb->db_name,                 /* database name */
 151         mdb->db_user,                 /* login name */
 152         mdb->db_password);            /* password */
 153    }
 154
 155    Dmsg0(50, "pg_real_connect done\n");
 156    Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
 157             mdb->db_password==NULL?"(NULL)":mdb->db_password);
 158
 159    if (PQstatus(mdb->db) != CONNECTION_OK) {
 160       Mmsg2(&mdb->errmsg, _("Unable to connect to PostgreSQL server.\n"
 161             "Database=%s User=%s\n"
 162             "It is probably not running or your password is incorrect.\n"),
 163       mdb->db_name, mdb->db_user);
 164       V(mutex);
 165       return 0;
 166    }
 167
 168    if (!check_tables_version(jcr, mdb)) {
 169       V(mutex);
 170       db_close_database(jcr, mdb);
 171       return 0;
 172    }
 173
 174    mdb->connected = TRUE;
 175    V(mutex);
 176    return 1;
 177 }
 178
 179 void
 180 db_close_database(JCR *jcr, B_DB *mdb)
 181 {
 182    P(mutex);
 183    mdb->ref_count--;
 184    if (mdb->ref_count == 0) {
 185       qdchain(&mdb->bq);
 186       if (mdb->connected && mdb->db) {
 187          sql_close(mdb);
 188       }
 189       rwl_destroy(&mdb->lock);
 190       free_pool_memory(mdb->errmsg);
 191       free_pool_memory(mdb->cmd);
 192       free_pool_memory(mdb->cached_path);
 193       free_pool_memory(mdb->fname);
 194       free_pool_memory(mdb->path);
 195       free_pool_memory(mdb->esc_name);
 196       if (mdb->db_name) {
 197          free(mdb->db_name);
 198       }
 199       if (mdb->db_user) {
 200          free(mdb->db_user);
 201       }
 202       if (mdb->db_password) {
 203          free(mdb->db_password);
 204       }
 205       if (mdb->db_address) {
 206          free(mdb->db_address);
 207       }
 208       if (mdb->db_socket) {
 209          free(mdb->db_socket);
 210       }
 211       free(mdb);
 212    }
 213    V(mutex);
 214 }
 215
 216 /*
 217  * Return the next unique index (auto-increment) for
 218  * the given table.  Return NULL on error.
 219  *
 220  * For PostgreSQL, NULL causes the auto-increment value
 221  *  to be updated.
 222  */
 223 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 224 {
 225    strcpy(index, "NULL");
 226    return 1;
 227 }
 228
 229
 230 /*
 231  * Escape strings so that PostgreSQL is happy
 232  *
 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.
 236  */
 237 void
 238 db_escape_string(char *snew, char *old, int len)
 239 {
 240    PQescapeString(snew, old, len);
 241 }
 242
 243 /*
 244  * Submit a general SQL command (cmd), and for each row returned,
 245  *  the sqlite_handler is called with the ctx.
 246  */
 247 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 248 {
 249    SQL_ROW row;
 250
 251    Dmsg0(50, "db_sql_query started\n");
 252
 253    db_lock(mdb);
 254    if (sql_query(mdb, query) != 0) {
 255       Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 256       db_unlock(mdb);
 257       Dmsg0(50, "db_sql_query failed\n");
 258       return 0;
 259    }
 260    Dmsg0(50, "db_sql_query succeeded. checking handler\n");
 261
 262    if (result_handler != NULL) {
 263       Dmsg0(50, "db_sql_query invoking handler\n");
 264       if ((mdb->result = sql_store_result(mdb)) != NULL) {
 265          int num_fields = sql_num_fields(mdb);
 266
 267          Dmsg0(50, "db_sql_query sql_store_result suceeded\n");
 268          while ((row = sql_fetch_row(mdb)) != NULL) {
 269
 270             Dmsg0(50, "db_sql_query sql_fetch_row worked\n");
 271             if (result_handler(ctx, num_fields, row))
 272                break;
 273          }
 274
 275         sql_free_result(mdb);
 276       }
 277    }
 278    db_unlock(mdb);
 279
 280    Dmsg0(50, "db_sql_query finished\n");
 281
 282    return 1;
 283 }
 284
 285
 286
 287 POSTGRESQL_ROW my_postgresql_fetch_row(B_DB *mdb)
 288 {
 289         int            j;
 290         POSTGRESQL_ROW row = NULL; // by default, return NULL
 291
 292         Dmsg0(50, "my_postgresql_fetch_row start\n");
 293
 294         if (mdb->row_number == -1 || mdb->row == NULL) {
 295
 296                 Dmsg1(50, "we have need space of %d bytes\n", sizeof(char *) * mdb->num_fields);
 297
 298                 if (mdb->row != NULL) {
 299                         Dmsg0(50, "my_postgresql_fetch_row freeing space\n");
 300                         free(mdb->row);
 301                         mdb->row = NULL;
 302                 }
 303
 304                 mdb->row = (POSTGRESQL_ROW) malloc(sizeof(char *) * mdb->num_fields);
 305
 306                 // now reset the row_number now that we have the space allocated
 307                 mdb->row_number = 0;
 308         }
 309
 310         // if still within the result set
 311         if (mdb->row_number < mdb->num_rows) {
 312                 Dmsg2(50, "my_postgresql_fetch_row row number '%d' is acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
 313                 // get each value from this row
 314                 for (j = 0; j < mdb->num_fields; j++) {
 315                         mdb->row[j] = PQgetvalue(mdb->result, mdb->row_number, j);
 316                         Dmsg2(50, "my_postgresql_fetch_row field '%d' has value '%s'\n", j, mdb->row[j]);
 317                 }
 318                 // increment the row number for the next call
 319                 mdb->row_number++;
 320
 321                 row = mdb->row;
 322         } else {
 323                 Dmsg2(50, "my_postgresql_fetch_row row number '%d' is NOT acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
 324         }
 325
 326         Dmsg1(50, "my_postgresql_fetch_row finishes returning %x\n", row);
 327
 328         return row;
 329 }
 330
 331 int my_postgresql_max_length(B_DB *mdb, int field_num) {
 332         //
 333         // for a given column, find the max length
 334         //
 335         int     max_length;
 336         int i;
 337         int     this_length;
 338
 339         max_length = 0;
 340         for (i = 0; i < mdb->num_rows; i++) {
 341                 if (PQgetisnull(mdb->result, i, field_num)) {
 342                         this_length = 4;        // "NULL"
 343                 } else {
 344                         this_length = strlen(PQgetvalue(mdb->result, i, field_num));
 345                 }
 346
 347                 if (max_length < this_length) {
 348                         max_length = this_length;
 349                 }
 350         }
 351
 352         return max_length;
 353 }
 354
 355 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb)
 356 {
 357         int     i;
 358
 359         Dmsg0(50, "my_postgresql_fetch_field starts\n");
 360         if (mdb->fields == NULL) {
 361                 Dmsg1(50, "allocating space for %d fields\n", mdb->num_fields);
 362                 mdb->fields = (POSTGRESQL_FIELD *)
 363                                  malloc(sizeof(POSTGRESQL_FIELD) * mdb->num_fields);
 364
 365                 for (i = 0; i < mdb->num_fields; i++) {
 366                         Dmsg1(50, "filling field %d\n", i);
 367                         mdb->fields[i].name           = PQfname(mdb->result, i);
 368                         mdb->fields[i].max_length = my_postgresql_max_length(mdb, i);
 369                         mdb->fields[i].type       = PQftype(mdb->result, i);
 370                         mdb->fields[i].flags      = 0;
 371
 372                         Dmsg4(50, "my_postgresql_fetch_field finds field '%s' has length='%d' type='%d' and IsNull=%d\n",
 373                            mdb->fields[i].name, mdb->fields[i].max_length, mdb->fields[i].type,
 374                            mdb->fields[i].flags);
 375                 } // end for
 376         } // end if
 377
 378         // increment field number for the next time around
 379
 380         Dmsg0(50, "my_postgresql_fetch_field finishes\n");
 381         return &mdb->fields[mdb->field_number++];
 382 }
 383
 384 void my_postgresql_data_seek(B_DB *mdb, int row)
 385 {
 386         // set the row number to be returned on the next call
 387         // to my_postgresql_fetch_row
 388         mdb->row_number = row;
 389 }
 390
 391 void my_postgresql_field_seek(B_DB *mdb, int field)
 392 {
 393         mdb->field_number = field;
 394 }
 395
 396 int my_postgresql_query(B_DB *mdb, char *query) {
 397         Dmsg0(50, "my_postgresql_query started\n");
 398         // We are starting a new query.  reset everything.
 399         mdb->num_rows     = -1;
 400         mdb->row_number   = -1;
 401         mdb->field_number = -1;
 402
 403
 404         Dmsg1(50, "my_postgresql_query starts with '%s'\n", query);
 405         mdb->result = PQexec(mdb->db, query);
 406         mdb->status = PQresultStatus(mdb->result);
 407         if (mdb->status == PGRES_TUPLES_OK || mdb->status == PGRES_COMMAND_OK) {
 408                 Dmsg1(50, "we have a result\n", query);
 409
 410                 // how many fields in the set?
 411                 mdb->num_fields = (int) PQnfields(mdb->result);
 412                 Dmsg1(50, "we have %d fields\n", mdb->num_fields);
 413
 414                 mdb->num_rows   = PQntuples(mdb->result);
 415                 Dmsg1(50, "we have %d rows\n", mdb->num_rows);
 416
 417                 mdb->status = 0;
 418         } else {
 419                 Dmsg1(50, "we failed\n", query);
 420                 mdb->status = 1;
 421         }
 422
 423         Dmsg0(50, "my_postgresql_query finishing\n");
 424
 425         return mdb->status;
 426 }
 427
 428 void my_postgresql_free_result (B_DB *mdb)
 429 {
 430         if (mdb->result) {
 431                 PQclear(mdb->result);
 432         }
 433
 434         if (mdb->row) {
 435                 free(mdb->row);
 436                 mdb->row = NULL;
 437         }
 438
 439         if (mdb->fields) {
 440                 free(mdb->fields);
 441                 mdb->fields = NULL;
 442         }
 443 }
 444
 445 int my_postgresql_currval(B_DB *mdb, char *table_name)
 446 {
 447         // Obtain the current value of the sequence that
 448         // provides the serial value for primary key of the table.
 449
 450         // currval is local to our session.  It is not affected by
 451         // other transactions.
 452
 453         // Determine the name of the sequence.
 454         // PostgreSQL automatically creates a sequence using
 455         // <table>_<column>_seq.
 456         // At the time of writing, all tables used this format for
 457         // for their primary key: <table>id
 458         // Except for basefiles which has a primary key on baseid.
 459         // Therefore, we need to special case that one table.
 460
 461         // everything else can use the PostgreSQL formula.
 462
 463         char      sequence[NAMEDATALEN-1];
 464         char      query   [NAMEDATALEN+50];
 465         PGresult *result;
 466         int       id = 0;
 467
 468         if (strcasecmp(table_name, "basefiles") == 0) {
 469                 bstrncpy(sequence, "basefiles_baseid", sizeof(sequence));
 470         } else {
 471                 bstrncpy(sequence, table_name, sizeof(sequence));
 472                 bstrncat(sequence, "_",        sizeof(sequence));
 473                 bstrncat(sequence, table_name, sizeof(sequence));
 474                 bstrncat(sequence, "id",       sizeof(sequence));
 475         }
 476
 477         bstrncat(sequence, "_seq", sizeof(sequence));
 478         bsnprintf(query, sizeof(query), "SELECT currval('%s')", sequence);
 479
 480 //      Mmsg(&query, "SELECT currval('%s')", sequence);
 481         Dmsg1(50, "my_postgresql_currval invoked with '%s'\n", query);
 482         result = PQexec(mdb->db, query);
 483
 484         Dmsg0(50, "exec done");
 485
 486         if (PQresultStatus(result) == PGRES_TUPLES_OK) {
 487                 Dmsg0(50, "getting value");
 488                 id = atoi(PQgetvalue(result, 0, 0));
 489                 Dmsg2(50, "got value '%s' which became %d\n", PQgetvalue(result, 0, 0), id);
 490         } else {
 491                 Mmsg1(&mdb->errmsg, _("error fetching currval: %s\n"), PQerrorMessage(mdb->db));
 492         }
 493
 494         PQclear(result);
 495
 496         return id;
 497 }
 498
 499
 500 #endif /* HAVE_POSTGRESQL */