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