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