src/dbi.c

   1 /**
   2  * collectd - src/dbi.c
   3  * Copyright (C) 2008-2015  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31 #include "utils_db_query.h"
  32
  33 #include <dbi/dbi.h>
  34
  35 /* libdbi 0.9.0 introduced a new thread-safe interface and marked the old
  36  * functions "deprecated". These macros convert the new functions to their old
  37  * counterparts for backwards compatibility. */
  38 #if !defined(LIBDBI_VERSION) || (LIBDBI_VERSION < 900)
  39 #define HAVE_LEGACY_LIBDBI 1
  40 #define dbi_initialize_r(a, inst) dbi_initialize(a)
  41 #define dbi_shutdown_r(inst) dbi_shutdown()
  42 #define dbi_set_verbosity_r(a, inst) dbi_set_verbosity(a)
  43 #define dbi_driver_list_r(a, inst) dbi_driver_list(a)
  44 #define dbi_driver_open_r(a, inst) dbi_driver_open(a)
  45 #endif
  46
  47 /*
  48  * Data types
  49  */
  50 struct cdbi_driver_option_s /* {{{ */
  51 {
  52   char *key;
  53   union {
  54     char *string;
  55     int numeric;
  56   } value;
  57   _Bool is_numeric;
  58 };
  59 typedef struct cdbi_driver_option_s cdbi_driver_option_t; /* }}} */
  60
  61 struct cdbi_database_s /* {{{ */
  62 {
  63   char *name;
  64   char *select_db;
  65
  66   cdtime_t interval;
  67
  68   char *driver;
  69   char *host;
  70   cdbi_driver_option_t *driver_options;
  71   size_t driver_options_num;
  72
  73   udb_query_preparation_area_t **q_prep_areas;
  74   udb_query_t **queries;
  75   size_t queries_num;
  76
  77   dbi_conn connection;
  78 };
  79 typedef struct cdbi_database_s cdbi_database_t; /* }}} */
  80
  81 /*
  82  * Global variables
  83  */
  84 #if !defined(HAVE_LEGACY_LIBDBI) || !HAVE_LEGACY_LIBDBI
  85 static dbi_inst dbi_instance = 0;
  86 #endif
  87 static udb_query_t **queries = NULL;
  88 static size_t queries_num = 0;
  89 static cdbi_database_t **databases = NULL;
  90 static size_t databases_num = 0;
  91
  92 static int cdbi_read_database(user_data_t *ud);
  93
  94 /*
  95  * Functions
  96  */
  97 static const char *cdbi_strerror(dbi_conn conn, /* {{{ */
  98                                  char *buffer, size_t buffer_size) {
  99   const char *msg;
 100   int status;
 101
 102   if (conn == NULL) {
 103     sstrncpy(buffer, "connection is NULL", buffer_size);
 104     return (buffer);
 105   }
 106
 107   msg = NULL;
 108   status = dbi_conn_error(conn, &msg);
 109   if ((status >= 0) && (msg != NULL))
 110     ssnprintf(buffer, buffer_size, "%s (status %i)", msg, status);
 111   else
 112     ssnprintf(buffer, buffer_size, "dbi_conn_error failed with status %i",
 113               status);
 114
 115   return (buffer);
 116 } /* }}} const char *cdbi_conn_error */
 117
 118 static int cdbi_result_get_field(dbi_result res, /* {{{ */
 119                                  unsigned int index, char *buffer,
 120                                  size_t buffer_size) {
 121   unsigned short src_type;
 122
 123   src_type = dbi_result_get_field_type_idx(res, index);
 124   if (src_type == DBI_TYPE_ERROR) {
 125     ERROR("dbi plugin: cdbi_result_get: "
 126           "dbi_result_get_field_type_idx failed.");
 127     return (-1);
 128   }
 129
 130   if (src_type == DBI_TYPE_INTEGER) {
 131     long long value;
 132
 133     value = dbi_result_get_longlong_idx(res, index);
 134     ssnprintf(buffer, buffer_size, "%lli", value);
 135   } else if (src_type == DBI_TYPE_DECIMAL) {
 136     double value;
 137
 138     value = dbi_result_get_double_idx(res, index);
 139     ssnprintf(buffer, buffer_size, "%63.15g", value);
 140   } else if (src_type == DBI_TYPE_STRING) {
 141     const char *value;
 142
 143     value = dbi_result_get_string_idx(res, index);
 144     if (value == NULL)
 145       sstrncpy(buffer, "", buffer_size);
 146     else if (strcmp("ERROR", value) == 0)
 147       return (-1);
 148     else
 149       sstrncpy(buffer, value, buffer_size);
 150   }
 151   /* DBI_TYPE_BINARY */
 152   /* DBI_TYPE_DATETIME */
 153   else {
 154     const char *field_name;
 155
 156     field_name = dbi_result_get_field_name(res, index);
 157     if (field_name == NULL)
 158       field_name = "<unknown>";
 159
 160     ERROR("dbi plugin: Column `%s': Don't know how to handle "
 161           "source type %hu.",
 162           field_name, src_type);
 163     return (-1);
 164   }
 165
 166   return (0);
 167 } /* }}} int cdbi_result_get_field */
 168
 169 static void cdbi_database_free(cdbi_database_t *db) /* {{{ */
 170 {
 171   if (db == NULL)
 172     return;
 173
 174   sfree(db->name);
 175   sfree(db->select_db);
 176   sfree(db->driver);
 177   sfree(db->host);
 178
 179   for (size_t i = 0; i < db->driver_options_num; i++) {
 180     sfree(db->driver_options[i].key);
 181     if (!db->driver_options[i].is_numeric)
 182       sfree(db->driver_options[i].value.string);
 183   }
 184   sfree(db->driver_options);
 185
 186   if (db->q_prep_areas)
 187     for (size_t i = 0; i < db->queries_num; ++i)
 188       udb_query_delete_preparation_area(db->q_prep_areas[i]);
 189   sfree(db->q_prep_areas);
 190   /* N.B.: db->queries references objects "owned" by the global queries
 191    * variable. Free the array here, but not the content. */
 192   sfree(db->queries);
 193
 194   sfree(db);
 195 } /* }}} void cdbi_database_free */
 196
 197 /* Configuration handling functions {{{
 198  *
 199  * <Plugin dbi>
 200  *   <Query "plugin_instance0">
 201  *     Statement "SELECT name, value FROM table"
 202  *     <Result>
 203  *       Type "gauge"
 204  *       InstancesFrom "name"
 205  *       ValuesFrom "value"
 206  *     </Result>
 207  *     ...
 208  *   </Query>
 209  *
 210  *   <Database "plugin_instance1">
 211  *     Driver "mysql"
 212  *     Interval 120
 213  *     DriverOption "hostname" "localhost"
 214  *     ...
 215  *     Query "plugin_instance0"
 216  *   </Database>
 217  * </Plugin>
 218  */
 219
 220 static int cdbi_config_add_database_driver_option(cdbi_database_t *db, /* {{{ */
 221                                                   oconfig_item_t *ci) {
 222   cdbi_driver_option_t *option;
 223
 224   if ((ci->values_num != 2) || (ci->values[0].type != OCONFIG_TYPE_STRING) ||
 225       ((ci->values[1].type != OCONFIG_TYPE_STRING) &&
 226        (ci->values[1].type != OCONFIG_TYPE_NUMBER))) {
 227     WARNING("dbi plugin: The `DriverOption' config option "
 228             "needs exactly two arguments.");
 229     return (-1);
 230   }
 231
 232   option = realloc(db->driver_options,
 233                    sizeof(*option) * (db->driver_options_num + 1));
 234   if (option == NULL) {
 235     ERROR("dbi plugin: realloc failed");
 236     return (-1);
 237   }
 238
 239   db->driver_options = option;
 240   option = db->driver_options + db->driver_options_num;
 241   memset(option, 0, sizeof(*option));
 242
 243   option->key = strdup(ci->values[0].value.string);
 244   if (option->key == NULL) {
 245     ERROR("dbi plugin: strdup failed.");
 246     return (-1);
 247   }
 248
 249   if (ci->values[1].type == OCONFIG_TYPE_STRING) {
 250     option->value.string = strdup(ci->values[1].value.string);
 251     if (option->value.string == NULL) {
 252       ERROR("dbi plugin: strdup failed.");
 253       sfree(option->key);
 254       return (-1);
 255     }
 256   } else {
 257     assert(ci->values[1].type == OCONFIG_TYPE_NUMBER);
 258     option->value.numeric = (int)(ci->values[1].value.number + .5);
 259     option->is_numeric = 1;
 260   }
 261
 262   db->driver_options_num++;
 263   return (0);
 264 } /* }}} int cdbi_config_add_database_driver_option */
 265
 266 static int cdbi_config_add_database(oconfig_item_t *ci) /* {{{ */
 267 {
 268   cdbi_database_t *db;
 269   int status;
 270
 271   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) {
 272     WARNING("dbi plugin: The `Database' block "
 273             "needs exactly one string argument.");
 274     return (-1);
 275   }
 276
 277   db = calloc(1, sizeof(*db));
 278   if (db == NULL) {
 279     ERROR("dbi plugin: calloc failed.");
 280     return (-1);
 281   }
 282
 283   status = cf_util_get_string(ci, &db->name);
 284   if (status != 0) {
 285     sfree(db);
 286     return (status);
 287   }
 288
 289   /* Fill the `cdbi_database_t' structure.. */
 290   for (int i = 0; i < ci->children_num; i++) {
 291     oconfig_item_t *child = ci->children + i;
 292
 293     if (strcasecmp("Driver", child->key) == 0)
 294       status = cf_util_get_string(child, &db->driver);
 295     else if (strcasecmp("DriverOption", child->key) == 0)
 296       status = cdbi_config_add_database_driver_option(db, child);
 297     else if (strcasecmp("SelectDB", child->key) == 0)
 298       status = cf_util_get_string(child, &db->select_db);
 299     else if (strcasecmp("Query", child->key) == 0)
 300       status = udb_query_pick_from_list(child, queries, queries_num,
 301                                         &db->queries, &db->queries_num);
 302     else if (strcasecmp("Host", child->key) == 0)
 303       status = cf_util_get_string(child, &db->host);
 304     else if (strcasecmp("Interval", child->key) == 0)
 305       status = cf_util_get_cdtime(child, &db->interval);
 306     else {
 307       WARNING("dbi plugin: Option `%s' not allowed here.", child->key);
 308       status = -1;
 309     }
 310
 311     if (status != 0)
 312       break;
 313   }
 314
 315   /* Check that all necessary options have been given. */
 316   while (status == 0) {
 317     if (db->driver == NULL) {
 318       WARNING("dbi plugin: `Driver' not given for database `%s'", db->name);
 319       status = -1;
 320     }
 321     if (db->driver_options_num == 0) {
 322       WARNING("dbi plugin: No `DriverOption' given for database `%s'. "
 323               "This will likely not work.",
 324               db->name);
 325     }
 326
 327     break;
 328   } /* while (status == 0) */
 329
 330   while ((status == 0) && (db->queries_num > 0)) {
 331     db->q_prep_areas = calloc(db->queries_num, sizeof(*db->q_prep_areas));
 332     if (db->q_prep_areas == NULL) {
 333       WARNING("dbi plugin: calloc failed");
 334       status = -1;
 335       break;
 336     }
 337
 338     for (size_t i = 0; i < db->queries_num; ++i) {
 339       db->q_prep_areas[i] = udb_query_allocate_preparation_area(db->queries[i]);
 340
 341       if (db->q_prep_areas[i] == NULL) {
 342         WARNING("dbi plugin: udb_query_allocate_preparation_area failed");
 343         status = -1;
 344         break;
 345       }
 346     }
 347
 348     break;
 349   }
 350
 351   /* If all went well, add this database to the global list of databases. */
 352   if (status == 0) {
 353     cdbi_database_t **temp;
 354
 355     temp = realloc(databases, sizeof(*databases) * (databases_num + 1));
 356     if (temp == NULL) {
 357       ERROR("dbi plugin: realloc failed");
 358       status = -1;
 359     } else {
 360       char *name = NULL;
 361
 362       databases = temp;
 363       databases[databases_num] = db;
 364       databases_num++;
 365
 366       name = ssnprintf_alloc("dbi:%s", db->name);
 367
 368       user_data_t ud = {.data = db};
 369
 370       plugin_register_complex_read(
 371           /* group = */ NULL,
 372           /* name = */ name ? name : db->name,
 373           /* callback = */ cdbi_read_database,
 374           /* interval = */ (db->interval > 0) ? db->interval : 0,
 375           /* user_data = */ &ud);
 376       free(name);
 377     }
 378   }
 379
 380   if (status != 0) {
 381     cdbi_database_free(db);
 382     return (-1);
 383   }
 384
 385   return (0);
 386 } /* }}} int cdbi_config_add_database */
 387
 388 static int cdbi_config(oconfig_item_t *ci) /* {{{ */
 389 {
 390   for (int i = 0; i < ci->children_num; i++) {
 391     oconfig_item_t *child = ci->children + i;
 392     if (strcasecmp("Query", child->key) == 0)
 393       udb_query_create(&queries, &queries_num, child,
 394                        /* callback = */ NULL);
 395     else if (strcasecmp("Database", child->key) == 0)
 396       cdbi_config_add_database(child);
 397     else {
 398       WARNING("dbi plugin: Ignoring unknown config option `%s'.", child->key);
 399     }
 400   } /* for (ci->children) */
 401
 402   return (0);
 403 } /* }}} int cdbi_config */
 404
 405 /* }}} End of configuration handling functions */
 406
 407 static int cdbi_init(void) /* {{{ */
 408 {
 409   static int did_init = 0;
 410   int status;
 411
 412   if (did_init != 0)
 413     return (0);
 414
 415   if (queries_num == 0) {
 416     ERROR("dbi plugin: No <Query> blocks have been found. Without them, "
 417           "this plugin can't do anything useful, so we will returns an error.");
 418     return (-1);
 419   }
 420
 421   if (databases_num == 0) {
 422     ERROR("dbi plugin: No <Database> blocks have been found. Without them, "
 423           "this plugin can't do anything useful, so we will returns an error.");
 424     return (-1);
 425   }
 426
 427   status = dbi_initialize_r(/* driverdir = */ NULL, &dbi_instance);
 428   if (status < 0) {
 429     ERROR("dbi plugin: cdbi_init: dbi_initialize_r failed with status %i.",
 430           status);
 431     return (-1);
 432   } else if (status == 0) {
 433     ERROR("dbi plugin: `dbi_initialize_r' could not load any drivers. Please "
 434           "install at least one `DBD' or check your installation.");
 435     return (-1);
 436   }
 437   DEBUG("dbi plugin: cdbi_init: dbi_initialize_r reports %i driver%s.", status,
 438         (status == 1) ? "" : "s");
 439
 440   return (0);
 441 } /* }}} int cdbi_init */
 442
 443 static int cdbi_read_database_query(cdbi_database_t *db, /* {{{ */
 444                                     udb_query_t *q,
 445                                     udb_query_preparation_area_t *prep_area) {
 446   const char *statement;
 447   dbi_result res;
 448   size_t column_num;
 449   char **column_names;
 450   char **column_values;
 451   int status;
 452
 453 /* Macro that cleans up dynamically allocated memory and returns the
 454  * specified status. */
 455 #define BAIL_OUT(status)                                                       \
 456   if (column_names != NULL) {                                                  \
 457     sfree(column_names[0]);                                                    \
 458     sfree(column_names);                                                       \
 459   }                                                                            \
 460   if (column_values != NULL) {                                                 \
 461     sfree(column_values[0]);                                                   \
 462     sfree(column_values);                                                      \
 463   }                                                                            \
 464   if (res != NULL) {                                                           \
 465     dbi_result_free(res);                                                      \
 466     res = NULL;                                                                \
 467   }                                                                            \
 468   return (status)
 469
 470   column_names = NULL;
 471   column_values = NULL;
 472
 473   statement = udb_query_get_statement(q);
 474   assert(statement != NULL);
 475
 476   res = dbi_conn_query(db->connection, statement);
 477   if (res == NULL) {
 478     char errbuf[1024];
 479     ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 480           "dbi_conn_query failed: %s",
 481           db->name, udb_query_get_name(q),
 482           cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
 483     BAIL_OUT(-1);
 484   } else /* Get the number of columns */
 485   {
 486     unsigned int db_status;
 487
 488     db_status = dbi_result_get_numfields(res);
 489     if (db_status == DBI_FIELD_ERROR) {
 490       char errbuf[1024];
 491       ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 492             "dbi_result_get_numfields failed: %s",
 493             db->name, udb_query_get_name(q),
 494             cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
 495       BAIL_OUT(-1);
 496     }
 497
 498     column_num = (size_t)db_status;
 499     DEBUG("cdbi_read_database_query (%s, %s): There are %zu columns.", db->name,
 500           udb_query_get_name(q), column_num);
 501   }
 502
 503   /* Allocate `column_names' and `column_values'. {{{ */
 504   column_names = calloc(column_num, sizeof(*column_names));
 505   if (column_names == NULL) {
 506     ERROR("dbi plugin: calloc failed.");
 507     BAIL_OUT(-1);
 508   }
 509
 510   column_names[0] = calloc(column_num, DATA_MAX_NAME_LEN);
 511   if (column_names[0] == NULL) {
 512     ERROR("dbi plugin: calloc failed.");
 513     BAIL_OUT(-1);
 514   }
 515   for (size_t i = 1; i < column_num; i++)
 516     column_names[i] = column_names[i - 1] + DATA_MAX_NAME_LEN;
 517
 518   column_values = calloc(column_num, sizeof(*column_values));
 519   if (column_values == NULL) {
 520     ERROR("dbi plugin: calloc failed.");
 521     BAIL_OUT(-1);
 522   }
 523
 524   column_values[0] = calloc(column_num, DATA_MAX_NAME_LEN);
 525   if (column_values[0] == NULL) {
 526     ERROR("dbi plugin: calloc failed.");
 527     BAIL_OUT(-1);
 528   }
 529   for (size_t i = 1; i < column_num; i++)
 530     column_values[i] = column_values[i - 1] + DATA_MAX_NAME_LEN;
 531   /* }}} */
 532
 533   /* Copy the field names to `column_names' */
 534   for (size_t i = 0; i < column_num; i++) /* {{{ */
 535   {
 536     const char *column_name;
 537
 538     column_name = dbi_result_get_field_name(res, (unsigned int)(i + 1));
 539     if (column_name == NULL) {
 540       ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 541             "Cannot retrieve name of field %zu.",
 542             db->name, udb_query_get_name(q), i + 1);
 543       BAIL_OUT(-1);
 544     }
 545
 546     sstrncpy(column_names[i], column_name, DATA_MAX_NAME_LEN);
 547   } /* }}} for (i = 0; i < column_num; i++) */
 548
 549   udb_query_prepare_result(
 550       q, prep_area, (db->host ? db->host : hostname_g),
 551       /* plugin = */ "dbi", db->name, column_names, column_num,
 552       /* interval = */ (db->interval > 0) ? db->interval : 0);
 553
 554   /* 0 = error; 1 = success; */
 555   status = dbi_result_first_row(res); /* {{{ */
 556   if (status != 1) {
 557     char errbuf[1024];
 558     ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 559           "dbi_result_first_row failed: %s. Maybe the statement didn't "
 560           "return any rows?",
 561           db->name, udb_query_get_name(q),
 562           cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
 563     udb_query_finish_result(q, prep_area);
 564     BAIL_OUT(-1);
 565   } /* }}} */
 566
 567   /* Iterate over all rows and call `udb_query_handle_result' with each list of
 568    * values. */
 569   while (42) /* {{{ */
 570   {
 571     status = 0;
 572     /* Copy the value of the columns to `column_values' */
 573     for (size_t i = 0; i < column_num; i++) /* {{{ */
 574     {
 575       status = cdbi_result_get_field(res, (unsigned int)(i + 1),
 576                                      column_values[i], DATA_MAX_NAME_LEN);
 577
 578       if (status != 0) {
 579         ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 580               "cdbi_result_get_field (%zu) failed.",
 581               db->name, udb_query_get_name(q), i + 1);
 582         status = -1;
 583         break;
 584       }
 585     } /* }}} for (i = 0; i < column_num; i++) */
 586
 587     /* If all values were copied successfully, call `udb_query_handle_result'
 588      * to dispatch the row to the daemon. */
 589     if (status == 0) /* {{{ */
 590     {
 591       status = udb_query_handle_result(q, prep_area, column_values);
 592       if (status != 0) {
 593         ERROR("dbi plugin: cdbi_read_database_query (%s, %s): "
 594               "udb_query_handle_result failed.",
 595               db->name, udb_query_get_name(q));
 596       }
 597     } /* }}} */
 598
 599     /* Get the next row from the database. */
 600     status = dbi_result_next_row(res); /* {{{ */
 601     if (status != 1) {
 602       if (dbi_conn_error(db->connection, NULL) != 0) {
 603         char errbuf[1024];
 604         WARNING("dbi plugin: cdbi_read_database_query (%s, %s): "
 605                 "dbi_result_next_row failed: %s.",
 606                 db->name, udb_query_get_name(q),
 607                 cdbi_strerror(db->connection, errbuf, sizeof(errbuf)));
 608       }
 609       break;
 610     } /* }}} */
 611   }   /* }}} while (42) */
 612
 613   /* Tell the db query interface that we're done with this query. */
 614   udb_query_finish_result(q, prep_area);
 615
 616   /* Clean up and return `status = 0' (success) */
 617   BAIL_OUT(0);
 618 #undef BAIL_OUT
 619 } /* }}} int cdbi_read_database_query */
 620
 621 static int cdbi_connect_database(cdbi_database_t *db) /* {{{ */
 622 {
 623   dbi_driver driver;
 624   dbi_conn connection;
 625   int status;
 626
 627   if (db->connection != NULL) {
 628     status = dbi_conn_ping(db->connection);
 629     if (status != 0) /* connection is alive */
 630       return (0);
 631
 632     dbi_conn_close(db->connection);
 633     db->connection = NULL;
 634   }
 635
 636   driver = dbi_driver_open_r(db->driver, dbi_instance);
 637   if (driver == NULL) {
 638     ERROR("dbi plugin: cdbi_connect_database: dbi_driver_open_r (%s) failed.",
 639           db->driver);
 640     INFO("dbi plugin: Maybe the driver isn't installed? "
 641          "Known drivers are:");
 642     for (driver = dbi_driver_list_r(NULL, dbi_instance); driver != NULL;
 643          driver = dbi_driver_list_r(driver, dbi_instance)) {
 644       INFO("dbi plugin: * %s", dbi_driver_get_name(driver));
 645     }
 646     return (-1);
 647   }
 648
 649   connection = dbi_conn_open(driver);
 650   if (connection == NULL) {
 651     ERROR("dbi plugin: cdbi_connect_database: dbi_conn_open (%s) failed.",
 652           db->driver);
 653     return (-1);
 654   }
 655
 656   /* Set all the driver options. Because this is a very very very generic
 657    * interface, the error handling is kind of long. If an invalid option is
 658    * encountered, it will get a list of options understood by the driver and
 659    * report that as `INFO'. This way, users hopefully don't have too much
 660    * trouble finding out how to configure the plugin correctly.. */
 661   for (size_t i = 0; i < db->driver_options_num; i++) {
 662     if (db->driver_options[i].is_numeric) {
 663       status =
 664           dbi_conn_set_option_numeric(connection, db->driver_options[i].key,
 665                                       db->driver_options[i].value.numeric);
 666       if (status != 0) {
 667         char errbuf[1024];
 668         ERROR("dbi plugin: cdbi_connect_database (%s): "
 669               "dbi_conn_set_option_numeric (\"%s\", %i) failed: %s.",
 670               db->name, db->driver_options[i].key,
 671               db->driver_options[i].value.numeric,
 672               cdbi_strerror(connection, errbuf, sizeof(errbuf)));
 673       }
 674     } else {
 675       status = dbi_conn_set_option(connection, db->driver_options[i].key,
 676                                    db->driver_options[i].value.string);
 677       if (status != 0) {
 678         char errbuf[1024];
 679         ERROR("dbi plugin: cdbi_connect_database (%s): "
 680               "dbi_conn_set_option (\"%s\", \"%s\") failed: %s.",
 681               db->name, db->driver_options[i].key,
 682               db->driver_options[i].value.string,
 683               cdbi_strerror(connection, errbuf, sizeof(errbuf)));
 684       }
 685     }
 686
 687     if (status != 0) {
 688       INFO("dbi plugin: This is a list of all options understood "
 689            "by the `%s' driver:",
 690            db->driver);
 691       for (const char *opt = dbi_conn_get_option_list(connection, NULL);
 692            opt != NULL; opt = dbi_conn_get_option_list(connection, opt)) {
 693         INFO("dbi plugin: * %s", opt);
 694       }
 695
 696       dbi_conn_close(connection);
 697       return (-1);
 698     }
 699   } /* for (i = 0; i < db->driver_options_num; i++) */
 700
 701   status = dbi_conn_connect(connection);
 702   if (status != 0) {
 703     char errbuf[1024];
 704     ERROR("dbi plugin: cdbi_connect_database (%s): "
 705           "dbi_conn_connect failed: %s",
 706           db->name, cdbi_strerror(connection, errbuf, sizeof(errbuf)));
 707     dbi_conn_close(connection);
 708     return (-1);
 709   }
 710
 711   if (db->select_db != NULL) {
 712     status = dbi_conn_select_db(connection, db->select_db);
 713     if (status != 0) {
 714       char errbuf[1024];
 715       WARNING(
 716           "dbi plugin: cdbi_connect_database (%s): "
 717           "dbi_conn_select_db (%s) failed: %s. Check the `SelectDB' option.",
 718           db->name, db->select_db,
 719           cdbi_strerror(connection, errbuf, sizeof(errbuf)));
 720       dbi_conn_close(connection);
 721       return (-1);
 722     }
 723   }
 724
 725   db->connection = connection;
 726   return (0);
 727 } /* }}} int cdbi_connect_database */
 728
 729 static int cdbi_read_database(user_data_t *ud) /* {{{ */
 730 {
 731   cdbi_database_t *db = (cdbi_database_t *)ud->data;
 732   int success;
 733   int status;
 734
 735   unsigned int db_version;
 736
 737   status = cdbi_connect_database(db);
 738   if (status != 0)
 739     return (status);
 740   assert(db->connection != NULL);
 741
 742   db_version = dbi_conn_get_engine_version(db->connection);
 743   /* TODO: Complain if `db_version == 0' */
 744
 745   success = 0;
 746   for (size_t i = 0; i < db->queries_num; i++) {
 747     /* Check if we know the database's version and if so, if this query applies
 748      * to that version. */
 749     if ((db_version != 0) &&
 750         (udb_query_check_version(db->queries[i], db_version) == 0))
 751       continue;
 752
 753     status = cdbi_read_database_query(db, db->queries[i], db->q_prep_areas[i]);
 754     if (status == 0)
 755       success++;
 756   }
 757
 758   if (success == 0) {
 759     ERROR("dbi plugin: All queries failed for database `%s'.", db->name);
 760     return (-1);
 761   }
 762
 763   return (0);
 764 } /* }}} int cdbi_read_database */
 765
 766 static int cdbi_shutdown(void) /* {{{ */
 767 {
 768   for (size_t i = 0; i < databases_num; i++) {
 769     if (databases[i]->connection != NULL) {
 770       dbi_conn_close(databases[i]->connection);
 771       databases[i]->connection = NULL;
 772     }
 773     cdbi_database_free(databases[i]);
 774   }
 775   sfree(databases);
 776   databases_num = 0;
 777
 778   udb_query_free(queries, queries_num);
 779   queries = NULL;
 780   queries_num = 0;
 781
 782   return (0);
 783 } /* }}} int cdbi_shutdown */
 784
 785 void module_register(void) /* {{{ */
 786 {
 787   plugin_register_complex_config("dbi", cdbi_config);
 788   plugin_register_init("dbi", cdbi_init);
 789   plugin_register_shutdown("dbi", cdbi_shutdown);
 790 } /* }}} void module_register */
 791
 792 /*
 793  * vim: shiftwidth=2 softtabstop=2 et fdm=marker
 794  */