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