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-2004 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, const char *db_name, const char *db_user, const char *db_password,
  62                  const char *db_address, int db_port, const 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  * DO NOT close the database or free(mdb) here !!!!
 115  */
 116 int
 117 db_open_database(JCR *jcr, B_DB *mdb)
 118 {
 119    int errstat;
 120    char buf[10], *port;
 121
 122    P(mutex);
 123    if (mdb->connected) {
 124       V(mutex);
 125       return 1;
 126    }
 127    mdb->connected = FALSE;
 128
 129    if ((errstat=rwl_init(&mdb->lock)) != 0) {
 130       Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
 131             strerror(errstat));
 132       V(mutex);
 133       return 0;
 134    }
 135
 136    if (mdb->db_port) {
 137       bsnprintf(buf, sizeof(buf), "%d", mdb->db_port);
 138       port = buf;
 139    } else {
 140       port = NULL;
 141    }
 142    /* connect to the database */
 143    mdb->db = PQsetdbLogin(
 144         mdb->db_address,              /* default = localhost */
 145         port,                         /* default port */
 146         NULL,                         /* pg options */
 147         NULL,                         /* tty, ignored */
 148         mdb->db_name,                 /* database name */
 149         mdb->db_user,                 /* login name */
 150         mdb->db_password);            /* password */
 151
 152    /* If no connect, try once more in case it is a timing problem */
 153    if (PQstatus(mdb->db) != CONNECTION_OK) {
 154    mdb->db = PQsetdbLogin(
 155         mdb->db_address,              /* default = localhost */
 156         port,                         /* default port */
 157         NULL,                         /* pg options */
 158         NULL,                         /* tty, ignored */
 159         mdb->db_name,                 /* database name */
 160         mdb->db_user,                 /* login name */
 161         mdb->db_password);            /* password */
 162    }
 163
 164    Dmsg0(50, "pg_real_connect done\n");
 165    Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
 166             mdb->db_password==NULL?"(NULL)":mdb->db_password);
 167
 168    if (PQstatus(mdb->db) != CONNECTION_OK) {
 169       Mmsg2(&mdb->errmsg, _("Unable to connect to PostgreSQL server.\n"
 170             "Database=%s User=%s\n"
 171             "It is probably not running or your password is incorrect.\n"),
 172              mdb->db_name, mdb->db_user);
 173       V(mutex);
 174       return 0;
 175    }
 176
 177    if (!check_tables_version(jcr, mdb)) {
 178       V(mutex);
 179       return 0;
 180    }
 181
 182    mdb->connected = TRUE;
 183    V(mutex);
 184    return 1;
 185 }
 186
 187 void
 188 db_close_database(JCR *jcr, B_DB *mdb)
 189 {
 190    if (!mdb) {
 191       return;
 192    }
 193    P(mutex);
 194    mdb->ref_count--;
 195    if (mdb->ref_count == 0) {
 196       qdchain(&mdb->bq);
 197       if (mdb->connected && mdb->db) {
 198          sql_close(mdb);
 199       }
 200       rwl_destroy(&mdb->lock);
 201       free_pool_memory(mdb->errmsg);
 202       free_pool_memory(mdb->cmd);
 203       free_pool_memory(mdb->cached_path);
 204       free_pool_memory(mdb->fname);
 205       free_pool_memory(mdb->path);
 206       free_pool_memory(mdb->esc_name);
 207       if (mdb->db_name) {
 208          free(mdb->db_name);
 209       }
 210       if (mdb->db_user) {
 211          free(mdb->db_user);
 212       }
 213       if (mdb->db_password) {
 214          free(mdb->db_password);
 215       }
 216       if (mdb->db_address) {
 217          free(mdb->db_address);
 218       }
 219       if (mdb->db_socket) {
 220          free(mdb->db_socket);
 221       }
 222       free(mdb);
 223    }
 224    V(mutex);
 225 }
 226
 227 /*
 228  * Return the next unique index (auto-increment) for
 229  * the given table.  Return NULL on error.
 230  *
 231  * For PostgreSQL, NULL causes the auto-increment value
 232  *  to be updated.
 233  */
 234 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
 235 {
 236    strcpy(index, "NULL");
 237    return 1;
 238 }
 239
 240
 241 /*
 242  * Escape strings so that PostgreSQL is happy
 243  *
 244  *   NOTE! len is the length of the old string. Your new
 245  *         string must be long enough (max 2*old+1) to hold
 246  *         the escaped output.
 247  */
 248 void
 249 db_escape_string(char *snew, char *old, int len)
 250 {
 251    PQescapeString(snew, old, len);
 252 }
 253
 254 /*
 255  * Submit a general SQL command (cmd), and for each row returned,
 256  *  the sqlite_handler is called with the ctx.
 257  */
 258 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
 259 {
 260    SQL_ROW row;
 261
 262    Dmsg0(500, "db_sql_query started\n");
 263
 264    db_lock(mdb);
 265    if (sql_query(mdb, query) != 0) {
 266       Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
 267       db_unlock(mdb);
 268       Dmsg0(500, "db_sql_query failed\n");
 269       return 0;
 270    }
 271    Dmsg0(500, "db_sql_query succeeded. checking handler\n");
 272
 273    if (result_handler != NULL) {
 274       Dmsg0(500, "db_sql_query invoking handler\n");
 275       if ((mdb->result = sql_store_result(mdb)) != NULL) {
 276          int num_fields = sql_num_fields(mdb);
 277
 278          Dmsg0(500, "db_sql_query sql_store_result suceeded\n");
 279          while ((row = sql_fetch_row(mdb)) != NULL) {
 280
 281             Dmsg0(500, "db_sql_query sql_fetch_row worked\n");
 282             if (result_handler(ctx, num_fields, row))
 283                break;
 284          }
 285
 286         sql_free_result(mdb);
 287       }
 288    }
 289    db_unlock(mdb);
 290
 291    Dmsg0(500, "db_sql_query finished\n");
 292
 293    return 1;
 294 }
 295
 296
 297
 298 POSTGRESQL_ROW my_postgresql_fetch_row(B_DB *mdb)
 299 {
 300    int            j;
 301    POSTGRESQL_ROW row = NULL; // by default, return NULL
 302
 303    Dmsg0(500, "my_postgresql_fetch_row start\n");
 304
 305    if (mdb->row_number == -1 || mdb->row == NULL) {
 306       Dmsg1(500, "we have need space of %d bytes\n", sizeof(char *) * mdb->num_fields);
 307
 308       if (mdb->row != NULL) {
 309               Dmsg0(500, "my_postgresql_fetch_row freeing space\n");
 310               free(mdb->row);
 311               mdb->row = NULL;
 312       }
 313
 314       mdb->row = (POSTGRESQL_ROW) malloc(sizeof(char *) * mdb->num_fields);
 315
 316       // now reset the row_number now that we have the space allocated
 317       mdb->row_number = 0;
 318    }
 319
 320    // if still within the result set
 321    if (mdb->row_number < mdb->num_rows) {
 322       Dmsg2(500, "my_postgresql_fetch_row row number '%d' is acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
 323       // get each value from this row
 324       for (j = 0; j < mdb->num_fields; j++) {
 325               mdb->row[j] = PQgetvalue(mdb->result, mdb->row_number, j);
 326               Dmsg2(500, "my_postgresql_fetch_row field '%d' has value '%s'\n", j, mdb->row[j]);
 327       }
 328       // increment the row number for the next call
 329       mdb->row_number++;
 330
 331       row = mdb->row;
 332    } else {
 333       Dmsg2(500, "my_postgresql_fetch_row row number '%d' is NOT acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
 334    }
 335
 336    Dmsg1(500, "my_postgresql_fetch_row finishes returning %x\n", row);
 337
 338    return row;
 339 }
 340
 341 int my_postgresql_max_length(B_DB *mdb, int field_num) {
 342    //
 343    // for a given column, find the max length
 344    //
 345    int     max_length;
 346    int i;
 347    int     this_length;
 348
 349    max_length = 0;
 350    for (i = 0; i < mdb->num_rows; i++) {
 351       if (PQgetisnull(mdb->result, i, field_num)) {
 352           this_length = 4;        // "NULL"
 353       } else {
 354           this_length = strlen(PQgetvalue(mdb->result, i, field_num));
 355       }
 356
 357       if (max_length < this_length) {
 358           max_length = this_length;
 359       }
 360    }
 361
 362    return max_length;
 363 }
 364
 365 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb)
 366 {
 367    int     i;
 368
 369    Dmsg0(500, "my_postgresql_fetch_field starts\n");
 370    if (mdb->fields == NULL) {
 371       Dmsg1(500, "allocating space for %d fields\n", mdb->num_fields);
 372       mdb->fields = (POSTGRESQL_FIELD *)malloc(sizeof(POSTGRESQL_FIELD) * mdb->num_fields);
 373
 374       for (i = 0; i < mdb->num_fields; i++) {
 375          Dmsg1(500, "filling field %d\n", i);
 376          mdb->fields[i].name           = PQfname(mdb->result, i);
 377          mdb->fields[i].max_length = my_postgresql_max_length(mdb, i);
 378          mdb->fields[i].type       = PQftype(mdb->result, i);
 379          mdb->fields[i].flags      = 0;
 380
 381          Dmsg4(500, "my_postgresql_fetch_field finds field '%s' has length='%d' type='%d' and IsNull=%d\n",
 382             mdb->fields[i].name, mdb->fields[i].max_length, mdb->fields[i].type,
 383             mdb->fields[i].flags);
 384       } // end for
 385    } // end if
 386
 387    // increment field number for the next time around
 388
 389    Dmsg0(500, "my_postgresql_fetch_field finishes\n");
 390    return &mdb->fields[mdb->field_number++];
 391 }
 392
 393 void my_postgresql_data_seek(B_DB *mdb, int row)
 394 {
 395    // set the row number to be returned on the next call
 396    // to my_postgresql_fetch_row
 397    mdb->row_number = row;
 398 }
 399
 400 void my_postgresql_field_seek(B_DB *mdb, int field)
 401 {
 402    mdb->field_number = field;
 403 }
 404
 405 int my_postgresql_query(B_DB *mdb, char *query) {
 406    Dmsg0(500, "my_postgresql_query started\n");
 407    // We are starting a new query.  reset everything.
 408    mdb->num_rows     = -1;
 409    mdb->row_number   = -1;
 410    mdb->field_number = -1;
 411
 412
 413    Dmsg1(500, "my_postgresql_query starts with '%s'\n", query);
 414    mdb->result = PQexec(mdb->db, query);
 415    mdb->status = PQresultStatus(mdb->result);
 416    if (mdb->status == PGRES_TUPLES_OK || mdb->status == PGRES_COMMAND_OK) {
 417       Dmsg1(500, "we have a result\n", query);
 418
 419       // how many fields in the set?
 420       mdb->num_fields = (int) PQnfields(mdb->result);
 421       Dmsg1(500, "we have %d fields\n", mdb->num_fields);
 422
 423       mdb->num_rows   = PQntuples(mdb->result);
 424       Dmsg1(500, "we have %d rows\n", mdb->num_rows);
 425
 426       mdb->status = 0;
 427    } else {
 428       Dmsg1(500, "we failed\n", query);
 429       mdb->status = 1;
 430    }
 431
 432    Dmsg0(500, "my_postgresql_query finishing\n");
 433
 434    return mdb->status;
 435 }
 436
 437 void my_postgresql_free_result (B_DB *mdb)
 438 {
 439    if (mdb->result) {
 440       PQclear(mdb->result);
 441    }
 442
 443    if (mdb->row) {
 444       free(mdb->row);
 445       mdb->row = NULL;
 446    }
 447
 448    if (mdb->fields) {
 449       free(mdb->fields);
 450       mdb->fields = NULL;
 451    }
 452 }
 453
 454 int my_postgresql_currval(B_DB *mdb, char *table_name)
 455 {
 456    // Obtain the current value of the sequence that
 457    // provides the serial value for primary key of the table.
 458
 459    // currval is local to our session.  It is not affected by
 460    // other transactions.
 461
 462    // Determine the name of the sequence.
 463    // PostgreSQL automatically creates a sequence using
 464    // <table>_<column>_seq.
 465    // At the time of writing, all tables used this format for
 466    // for their primary key: <table>id
 467    // Except for basefiles which has a primary key on baseid.
 468    // Therefore, we need to special case that one table.
 469
 470    // everything else can use the PostgreSQL formula.
 471
 472    char      sequence[NAMEDATALEN-1];
 473    char      query   [NAMEDATALEN+50];
 474    PGresult *result;
 475    int       id = 0;
 476
 477    if (strcasecmp(table_name, "basefiles") == 0) {
 478       bstrncpy(sequence, "basefiles_baseid", sizeof(sequence));
 479    } else {
 480       bstrncpy(sequence, table_name, sizeof(sequence));
 481       bstrncat(sequence, "_",        sizeof(sequence));
 482       bstrncat(sequence, table_name, sizeof(sequence));
 483       bstrncat(sequence, "id",       sizeof(sequence));
 484    }
 485
 486    bstrncat(sequence, "_seq", sizeof(sequence));
 487    bsnprintf(query, sizeof(query), "SELECT currval('%s')", sequence);
 488
 489 // Mmsg(&query, "SELECT currval('%s')", sequence);
 490    Dmsg1(500, "my_postgresql_currval invoked with '%s'\n", query);
 491    result = PQexec(mdb->db, query);
 492
 493    Dmsg0(500, "exec done");
 494
 495    if (PQresultStatus(result) == PGRES_TUPLES_OK) {
 496       Dmsg0(500, "getting value");
 497       id = atoi(PQgetvalue(result, 0, 0));
 498       Dmsg2(500, "got value '%s' which became %d\n", PQgetvalue(result, 0, 0), id);
 499    } else {
 500       Mmsg1(&mdb->errmsg, _("error fetching currval: %s\n"), PQerrorMessage(mdb->db));
 501    }
 502
 503    PQclear(result);
 504
 505    return id;
 506 }
 507
 508
 509 #endif /* HAVE_POSTGRESQL */