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