3 * Copyright (C) 2008-2015 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
31 #include "utils_db_query.h"
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)
50 struct cdbi_driver_option_s /* {{{ */
60 typedef struct cdbi_driver_option_s cdbi_driver_option_t; /* }}} */
62 struct cdbi_database_s /* {{{ */
71 cdbi_driver_option_t *driver_options;
72 size_t driver_options_num;
74 udb_query_preparation_area_t **q_prep_areas;
75 udb_query_t **queries;
80 typedef struct cdbi_database_s cdbi_database_t; /* }}} */
85 #if !defined(HAVE_LEGACY_LIBDBI) || !HAVE_LEGACY_LIBDBI
86 static dbi_inst dbi_instance = 0;
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;
93 static int cdbi_read_database (user_data_t *ud);
98 static const char *cdbi_strerror (dbi_conn conn, /* {{{ */
99 char *buffer, size_t buffer_size)
106 sstrncpy (buffer, "connection is NULL", buffer_size);
111 status = dbi_conn_error (conn, &msg);
112 if ((status >= 0) && (msg != NULL))
113 ssnprintf (buffer, buffer_size, "%s (status %i)", msg, status);
115 ssnprintf (buffer, buffer_size, "dbi_conn_error failed with status %i",
119 } /* }}} const char *cdbi_conn_error */
121 static int cdbi_result_get_field (dbi_result res, /* {{{ */
122 unsigned int index, char *buffer, size_t buffer_size)
124 unsigned short src_type;
126 src_type = dbi_result_get_field_type_idx (res, index);
127 if (src_type == DBI_TYPE_ERROR)
129 ERROR ("dbi plugin: cdbi_result_get: "
130 "dbi_result_get_field_type_idx failed.");
134 if (src_type == DBI_TYPE_INTEGER)
138 value = dbi_result_get_longlong_idx (res, index);
139 ssnprintf (buffer, buffer_size, "%lli", value);
141 else if (src_type == DBI_TYPE_DECIMAL)
145 value = dbi_result_get_double_idx (res, index);
146 ssnprintf (buffer, buffer_size, "%63.15g", value);
148 else if (src_type == DBI_TYPE_STRING)
152 value = dbi_result_get_string_idx (res, index);
154 sstrncpy (buffer, "", buffer_size);
155 else if (strcmp ("ERROR", value) == 0)
158 sstrncpy (buffer, value, buffer_size);
160 /* DBI_TYPE_BINARY */
161 /* DBI_TYPE_DATETIME */
164 const char *field_name;
166 field_name = dbi_result_get_field_name (res, index);
167 if (field_name == NULL)
168 field_name = "<unknown>";
170 ERROR ("dbi plugin: Column `%s': Don't know how to handle "
172 field_name, src_type);
177 } /* }}} int cdbi_result_get_field */
179 static void cdbi_database_free (cdbi_database_t *db) /* {{{ */
187 for (size_t i = 0; i < db->driver_options_num; i++)
189 sfree (db->driver_options[i].key);
190 if (!db->driver_options[i].is_numeric)
191 sfree (db->driver_options[i].value.string);
193 sfree (db->driver_options);
195 if (db->q_prep_areas)
196 for (size_t i = 0; i < db->queries_num; ++i)
197 udb_query_delete_preparation_area (db->q_prep_areas[i]);
198 free (db->q_prep_areas);
201 } /* }}} void cdbi_database_free */
203 /* Configuration handling functions {{{
206 * <Query "plugin_instance0">
207 * Statement "SELECT name, value FROM table"
210 * InstancesFrom "name"
216 * <Database "plugin_instance1">
219 * DriverOption "hostname" "localhost"
221 * Query "plugin_instance0"
226 static int cdbi_config_add_database_driver_option (cdbi_database_t *db, /* {{{ */
229 cdbi_driver_option_t *option;
231 if ((ci->values_num != 2)
232 || (ci->values[0].type != OCONFIG_TYPE_STRING)
233 || ((ci->values[1].type != OCONFIG_TYPE_STRING)
234 && (ci->values[1].type != OCONFIG_TYPE_NUMBER)))
236 WARNING ("dbi plugin: The `DriverOption' config option "
237 "needs exactly two arguments.");
241 option = realloc (db->driver_options,
242 sizeof (*option) * (db->driver_options_num + 1));
245 ERROR ("dbi plugin: realloc failed");
249 db->driver_options = option;
250 option = db->driver_options + db->driver_options_num;
251 memset (option, 0, sizeof (*option));
253 option->key = strdup (ci->values[0].value.string);
254 if (option->key == NULL)
256 ERROR ("dbi plugin: strdup failed.");
260 if (ci->values[1].type == OCONFIG_TYPE_STRING)
262 option->value.string = strdup (ci->values[1].value.string);
263 if (option->value.string == NULL)
265 ERROR ("dbi plugin: strdup failed.");
272 assert (ci->values[1].type == OCONFIG_TYPE_NUMBER);
273 option->value.numeric = (int) (ci->values[1].value.number + .5);
274 option->is_numeric = 1;
277 db->driver_options_num++;
279 } /* }}} int cdbi_config_add_database_driver_option */
281 static int cdbi_config_add_database (oconfig_item_t *ci) /* {{{ */
286 if ((ci->values_num != 1)
287 || (ci->values[0].type != OCONFIG_TYPE_STRING))
289 WARNING ("dbi plugin: The `Database' block "
290 "needs exactly one string argument.");
294 db = calloc (1, sizeof (*db));
297 ERROR ("dbi plugin: calloc failed.");
301 status = cf_util_get_string (ci, &db->name);
308 /* Fill the `cdbi_database_t' structure.. */
309 for (int i = 0; i < ci->children_num; i++)
311 oconfig_item_t *child = ci->children + i;
313 if (strcasecmp ("Driver", child->key) == 0)
314 status = cf_util_get_string (child, &db->driver);
315 else if (strcasecmp ("DriverOption", child->key) == 0)
316 status = cdbi_config_add_database_driver_option (db, child);
317 else if (strcasecmp ("SelectDB", child->key) == 0)
318 status = cf_util_get_string (child, &db->select_db);
319 else if (strcasecmp ("Query", child->key) == 0)
320 status = udb_query_pick_from_list (child, queries, queries_num,
321 &db->queries, &db->queries_num);
322 else if (strcasecmp ("Host", child->key) == 0)
323 status = cf_util_get_string (child, &db->host);
324 else if (strcasecmp ("Interval", child->key) == 0)
325 status = cf_util_get_cdtime(child, &db->interval);
328 WARNING ("dbi plugin: Option `%s' not allowed here.", child->key);
336 /* Check that all necessary options have been given. */
339 if (db->driver == NULL)
341 WARNING ("dbi plugin: `Driver' not given for database `%s'", db->name);
344 if (db->driver_options_num == 0)
346 WARNING ("dbi plugin: No `DriverOption' given for database `%s'. "
347 "This will likely not work.", db->name);
351 } /* while (status == 0) */
353 while ((status == 0) && (db->queries_num > 0))
355 db->q_prep_areas = calloc (db->queries_num, sizeof (*db->q_prep_areas));
356 if (db->q_prep_areas == NULL)
358 WARNING ("dbi plugin: calloc failed");
363 for (size_t i = 0; i < db->queries_num; ++i)
366 = udb_query_allocate_preparation_area (db->queries[i]);
368 if (db->q_prep_areas[i] == NULL)
370 WARNING ("dbi plugin: udb_query_allocate_preparation_area failed");
379 /* If all went well, add this database to the global list of databases. */
382 cdbi_database_t **temp;
384 temp = realloc (databases,
385 sizeof (*databases) * (databases_num + 1));
388 ERROR ("dbi plugin: realloc failed");
396 databases[databases_num] = db;
399 name = ssnprintf_alloc("dbi:%s", db->name);
405 plugin_register_complex_read (/* group = */ NULL,
406 /* name = */ name ? name : db->name,
407 /* callback = */ cdbi_read_database,
408 /* interval = */ (db->interval > 0) ? db->interval : 0,
409 /* user_data = */ &ud);
416 cdbi_database_free (db);
421 } /* }}} int cdbi_config_add_database */
423 static int cdbi_config (oconfig_item_t *ci) /* {{{ */
425 for (int i = 0; i < ci->children_num; i++)
427 oconfig_item_t *child = ci->children + i;
428 if (strcasecmp ("Query", child->key) == 0)
429 udb_query_create (&queries, &queries_num, child,
430 /* callback = */ NULL);
431 else if (strcasecmp ("Database", child->key) == 0)
432 cdbi_config_add_database (child);
435 WARNING ("dbi plugin: Ignoring unknown config option `%s'.", child->key);
437 } /* for (ci->children) */
440 } /* }}} int cdbi_config */
442 /* }}} End of configuration handling functions */
444 static int cdbi_init (void) /* {{{ */
446 static int did_init = 0;
452 if (queries_num == 0)
454 ERROR ("dbi plugin: No <Query> blocks have been found. Without them, "
455 "this plugin can't do anything useful, so we will returns an error.");
459 if (databases_num == 0)
461 ERROR ("dbi plugin: No <Database> blocks have been found. Without them, "
462 "this plugin can't do anything useful, so we will returns an error.");
466 status = dbi_initialize_r (/* driverdir = */ NULL, &dbi_instance);
469 ERROR ("dbi plugin: cdbi_init: dbi_initialize_r failed with status %i.",
473 else if (status == 0)
475 ERROR ("dbi plugin: `dbi_initialize_r' could not load any drivers. Please "
476 "install at least one `DBD' or check your installation.");
479 DEBUG ("dbi plugin: cdbi_init: dbi_initialize_r reports %i driver%s.",
480 status, (status == 1) ? "" : "s");
483 } /* }}} int cdbi_init */
485 static int cdbi_read_database_query (cdbi_database_t *db, /* {{{ */
486 udb_query_t *q, udb_query_preparation_area_t *prep_area)
488 const char *statement;
492 char **column_values;
495 /* Macro that cleans up dynamically allocated memory and returns the
496 * specified status. */
497 #define BAIL_OUT(status) \
498 if (column_names != NULL) { sfree (column_names[0]); sfree (column_names); } \
499 if (column_values != NULL) { sfree (column_values[0]); sfree (column_values); } \
500 if (res != NULL) { dbi_result_free (res); res = NULL; } \
504 column_values = NULL;
506 statement = udb_query_get_statement (q);
507 assert (statement != NULL);
509 res = dbi_conn_query (db->connection, statement);
513 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
514 "dbi_conn_query failed: %s",
515 db->name, udb_query_get_name (q),
516 cdbi_strerror (db->connection, errbuf, sizeof (errbuf)));
519 else /* Get the number of columns */
521 unsigned int db_status;
523 db_status = dbi_result_get_numfields (res);
524 if (db_status == DBI_FIELD_ERROR)
527 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
528 "dbi_result_get_numfields failed: %s",
529 db->name, udb_query_get_name (q),
530 cdbi_strerror (db->connection, errbuf, sizeof (errbuf)));
534 column_num = (size_t) db_status;
535 DEBUG ("cdbi_read_database_query (%s, %s): There are %zu columns.",
536 db->name, udb_query_get_name (q), column_num);
539 /* Allocate `column_names' and `column_values'. {{{ */
540 column_names = calloc (column_num, sizeof (*column_names));
541 if (column_names == NULL)
543 ERROR ("dbi plugin: calloc failed.");
547 column_names[0] = calloc (column_num, DATA_MAX_NAME_LEN);
548 if (column_names[0] == NULL)
550 ERROR ("dbi plugin: calloc failed.");
553 for (size_t i = 1; i < column_num; i++)
554 column_names[i] = column_names[i - 1] + DATA_MAX_NAME_LEN;
556 column_values = calloc (column_num, sizeof (*column_values));
557 if (column_values == NULL)
559 ERROR ("dbi plugin: calloc failed.");
563 column_values[0] = calloc (column_num, DATA_MAX_NAME_LEN);
564 if (column_values[0] == NULL)
566 ERROR ("dbi plugin: calloc failed.");
569 for (size_t i = 1; i < column_num; i++)
570 column_values[i] = column_values[i - 1] + DATA_MAX_NAME_LEN;
573 /* Copy the field names to `column_names' */
574 for (size_t i = 0; i < column_num; i++) /* {{{ */
576 const char *column_name;
578 column_name = dbi_result_get_field_name (res, (unsigned int) (i + 1));
579 if (column_name == NULL)
581 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
582 "Cannot retrieve name of field %zu.",
583 db->name, udb_query_get_name (q), i + 1);
587 sstrncpy (column_names[i], column_name, DATA_MAX_NAME_LEN);
588 } /* }}} for (i = 0; i < column_num; i++) */
590 udb_query_prepare_result (q, prep_area, (db->host ? db->host : hostname_g),
591 /* plugin = */ "dbi", db->name,
592 column_names, column_num, /* interval = */ (db->interval > 0) ? db->interval : 0);
594 /* 0 = error; 1 = success; */
595 status = dbi_result_first_row (res); /* {{{ */
599 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
600 "dbi_result_first_row failed: %s. Maybe the statement didn't "
602 db->name, udb_query_get_name (q),
603 cdbi_strerror (db->connection, errbuf, sizeof (errbuf)));
604 udb_query_finish_result (q, prep_area);
608 /* Iterate over all rows and call `udb_query_handle_result' with each list of
613 /* Copy the value of the columns to `column_values' */
614 for (size_t i = 0; i < column_num; i++) /* {{{ */
616 status = cdbi_result_get_field (res, (unsigned int) (i + 1),
617 column_values[i], DATA_MAX_NAME_LEN);
621 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
622 "cdbi_result_get_field (%zu) failed.",
623 db->name, udb_query_get_name (q), i + 1);
627 } /* }}} for (i = 0; i < column_num; i++) */
629 /* If all values were copied successfully, call `udb_query_handle_result'
630 * to dispatch the row to the daemon. */
631 if (status == 0) /* {{{ */
633 status = udb_query_handle_result (q, prep_area, column_values);
636 ERROR ("dbi plugin: cdbi_read_database_query (%s, %s): "
637 "udb_query_handle_result failed.",
638 db->name, udb_query_get_name (q));
642 /* Get the next row from the database. */
643 status = dbi_result_next_row (res); /* {{{ */
646 if (dbi_conn_error (db->connection, NULL) != 0)
649 WARNING ("dbi plugin: cdbi_read_database_query (%s, %s): "
650 "dbi_result_next_row failed: %s.",
651 db->name, udb_query_get_name (q),
652 cdbi_strerror (db->connection, errbuf, sizeof (errbuf)));
656 } /* }}} while (42) */
658 /* Tell the db query interface that we're done with this query. */
659 udb_query_finish_result (q, prep_area);
661 /* Clean up and return `status = 0' (success) */
664 } /* }}} int cdbi_read_database_query */
666 static int cdbi_connect_database (cdbi_database_t *db) /* {{{ */
672 if (db->connection != NULL)
674 status = dbi_conn_ping (db->connection);
675 if (status != 0) /* connection is alive */
678 dbi_conn_close (db->connection);
679 db->connection = NULL;
682 driver = dbi_driver_open_r (db->driver, dbi_instance);
685 ERROR ("dbi plugin: cdbi_connect_database: dbi_driver_open_r (%s) failed.",
687 INFO ("dbi plugin: Maybe the driver isn't installed? "
688 "Known drivers are:");
689 for (driver = dbi_driver_list_r (NULL, dbi_instance);
691 driver = dbi_driver_list_r (driver, dbi_instance))
693 INFO ("dbi plugin: * %s", dbi_driver_get_name (driver));
698 connection = dbi_conn_open (driver);
699 if (connection == NULL)
701 ERROR ("dbi plugin: cdbi_connect_database: dbi_conn_open (%s) failed.",
706 /* Set all the driver options. Because this is a very very very generic
707 * interface, the error handling is kind of long. If an invalid option is
708 * encountered, it will get a list of options understood by the driver and
709 * report that as `INFO'. This way, users hopefully don't have too much
710 * trouble finding out how to configure the plugin correctly.. */
711 for (size_t i = 0; i < db->driver_options_num; i++)
713 if (db->driver_options[i].is_numeric)
715 status = dbi_conn_set_option_numeric (connection,
716 db->driver_options[i].key, db->driver_options[i].value.numeric);
720 ERROR ("dbi plugin: cdbi_connect_database (%s): "
721 "dbi_conn_set_option_numeric (\"%s\", %i) failed: %s.",
723 db->driver_options[i].key, db->driver_options[i].value.numeric,
724 cdbi_strerror (connection, errbuf, sizeof (errbuf)));
729 status = dbi_conn_set_option (connection,
730 db->driver_options[i].key, db->driver_options[i].value.string);
734 ERROR ("dbi plugin: cdbi_connect_database (%s): "
735 "dbi_conn_set_option (\"%s\", \"%s\") failed: %s.",
737 db->driver_options[i].key, db->driver_options[i].value.string,
738 cdbi_strerror (connection, errbuf, sizeof (errbuf)));
744 INFO ("dbi plugin: This is a list of all options understood "
745 "by the `%s' driver:", db->driver);
746 for (const char *opt = dbi_conn_get_option_list (connection, NULL);
748 opt = dbi_conn_get_option_list (connection, opt))
750 INFO ("dbi plugin: * %s", opt);
753 dbi_conn_close (connection);
756 } /* for (i = 0; i < db->driver_options_num; i++) */
758 status = dbi_conn_connect (connection);
762 ERROR ("dbi plugin: cdbi_connect_database (%s): "
763 "dbi_conn_connect failed: %s",
764 db->name, cdbi_strerror (connection, errbuf, sizeof (errbuf)));
765 dbi_conn_close (connection);
769 if (db->select_db != NULL)
771 status = dbi_conn_select_db (connection, db->select_db);
775 WARNING ("dbi plugin: cdbi_connect_database (%s): "
776 "dbi_conn_select_db (%s) failed: %s. Check the `SelectDB' option.",
777 db->name, db->select_db,
778 cdbi_strerror (connection, errbuf, sizeof (errbuf)));
779 dbi_conn_close (connection);
784 db->connection = connection;
786 } /* }}} int cdbi_connect_database */
788 static int cdbi_read_database (user_data_t *ud) /* {{{ */
790 cdbi_database_t *db = (cdbi_database_t *) ud->data;
794 unsigned int db_version;
796 status = cdbi_connect_database (db);
799 assert (db->connection != NULL);
801 db_version = dbi_conn_get_engine_version (db->connection);
802 /* TODO: Complain if `db_version == 0' */
805 for (size_t i = 0; i < db->queries_num; i++)
807 /* Check if we know the database's version and if so, if this query applies
808 * to that version. */
809 if ((db_version != 0)
810 && (udb_query_check_version (db->queries[i], db_version) == 0))
813 status = cdbi_read_database_query (db,
814 db->queries[i], db->q_prep_areas[i]);
821 ERROR ("dbi plugin: All queries failed for database `%s'.", db->name);
826 } /* }}} int cdbi_read_database */
828 static int cdbi_shutdown (void) /* {{{ */
830 for (size_t i = 0; i < databases_num; i++)
832 if (databases[i]->connection != NULL)
834 dbi_conn_close (databases[i]->connection);
835 databases[i]->connection = NULL;
837 cdbi_database_free (databases[i]);
842 udb_query_free (queries, queries_num);
847 } /* }}} int cdbi_shutdown */
849 void module_register (void) /* {{{ */
851 plugin_register_complex_config ("dbi", cdbi_config);
852 plugin_register_init ("dbi", cdbi_init);
853 plugin_register_shutdown ("dbi", cdbi_shutdown);
854 } /* }}} void module_register */
857 * vim: shiftwidth=2 softtabstop=2 et fdm=marker