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