src/utils_db_query.c

   1 /**
   2  * collectd - src/utils_db_query.c
   3  * Copyright (C) 2008,2009  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26 #include "utils_db_query.h"
  27
  28 /*
  29  * Data types
  30  */
  31 struct udb_result_s; /* {{{ */
  32 typedef struct udb_result_s udb_result_t;
  33 struct udb_result_s
  34 {
  35   char    *type;
  36   char    *instance_prefix;
  37   char   **instances;
  38   size_t   instances_num;
  39   char   **values;
  40   size_t   values_num;
  41
  42   /* Preparation area */
  43   const   data_set_t *ds;
  44   size_t *instances_pos;
  45   size_t *values_pos;
  46   char  **instances_buffer;
  47   char  **values_buffer;
  48
  49   udb_result_t *next;
  50 }; /* }}} */
  51
  52 struct udb_query_s /* {{{ */
  53 {
  54   char *name;
  55   char *statement;
  56   void *user_data;
  57
  58   unsigned int min_version;
  59   unsigned int max_version;
  60
  61   /* Preparation area */
  62   size_t column_num;
  63   char *host;
  64   char *plugin;
  65   char *db_name;
  66
  67   udb_result_t *results;
  68 }; /* }}} */
  69
  70 /*
  71  * Config Private functions
  72  */
  73 static int udb_config_set_string (char **ret_string, /* {{{ */
  74     oconfig_item_t *ci)
  75 {
  76   char *string;
  77
  78   if ((ci->values_num != 1)
  79       || (ci->values[0].type != OCONFIG_TYPE_STRING))
  80   {
  81     WARNING ("db query utils: The `%s' config option "
  82         "needs exactly one string argument.", ci->key);
  83     return (-1);
  84   }
  85
  86   string = strdup (ci->values[0].value.string);
  87   if (string == NULL)
  88   {
  89     ERROR ("db query utils: strdup failed.");
  90     return (-1);
  91   }
  92
  93   if (*ret_string != NULL)
  94     free (*ret_string);
  95   *ret_string = string;
  96
  97   return (0);
  98 } /* }}} int udb_config_set_string */
  99
 100 static int udb_config_add_string (char ***ret_array, /* {{{ */
 101     size_t *ret_array_len, oconfig_item_t *ci)
 102 {
 103   char **array;
 104   size_t array_len;
 105   int i;
 106
 107   if (ci->values_num < 1)
 108   {
 109     WARNING ("db query utils: The `%s' config option "
 110         "needs at least one argument.", ci->key);
 111     return (-1);
 112   }
 113
 114   for (i = 0; i < ci->values_num; i++)
 115   {
 116     if (ci->values[i].type != OCONFIG_TYPE_STRING)
 117     {
 118       WARNING ("db query utils: Argument %i to the `%s' option "
 119           "is not a string.", i + 1, ci->key);
 120       return (-1);
 121     }
 122   }
 123
 124   array_len = *ret_array_len;
 125   array = (char **) realloc (*ret_array,
 126       sizeof (char *) * (array_len + ci->values_num));
 127   if (array == NULL)
 128   {
 129     ERROR ("db query utils: realloc failed.");
 130     return (-1);
 131   }
 132   *ret_array = array;
 133
 134   for (i = 0; i < ci->values_num; i++)
 135   {
 136     array[array_len] = strdup (ci->values[i].value.string);
 137     if (array[array_len] == NULL)
 138     {
 139       ERROR ("db query utils: strdup failed.");
 140       *ret_array_len = array_len;
 141       return (-1);
 142     }
 143     array_len++;
 144   }
 145
 146   *ret_array_len = array_len;
 147   return (0);
 148 } /* }}} int udb_config_add_string */
 149
 150 static int udb_config_set_uint (unsigned int *ret_value, /* {{{ */
 151     oconfig_item_t *ci)
 152 {
 153   double tmp;
 154
 155   if ((ci->values_num != 1)
 156       || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 157   {
 158     WARNING ("db query utils: The `%s' config option "
 159         "needs exactly one numeric argument.", ci->key);
 160     return (-1);
 161   }
 162
 163   tmp = ci->values[0].value.number;
 164   if ((tmp < 0.0) || (tmp > ((double) UINT_MAX)))
 165     return (-ERANGE);
 166
 167   *ret_value = (unsigned int) (tmp + .5);
 168   return (0);
 169 } /* }}} int udb_config_set_uint */
 170
 171 /*
 172  * Result private functions
 173  */
 174 static void udb_result_submit (udb_result_t *r, udb_query_t *q) /* {{{ */
 175 {
 176   value_list_t vl = VALUE_LIST_INIT;
 177   size_t i;
 178
 179   assert (((size_t) r->ds->ds_num) == r->values_num);
 180
 181   DEBUG ("db query utils: udb_result_submit: r->instance_prefix = %s;",
 182       (r->instance_prefix == NULL) ? "NULL" : r->instance_prefix);
 183   for (i = 0; i < r->instances_num; i++)
 184   {
 185     DEBUG ("db query utils: udb_result_submit: r->instances_buffer[%zu] = %s;",
 186         i, r->instances_buffer[i]);
 187   }
 188
 189   vl.values = (value_t *) calloc (r->ds->ds_num, sizeof (value_t));
 190   if (vl.values == NULL)
 191   {
 192     ERROR ("db query utils: malloc failed.");
 193     return;
 194   }
 195   vl.values_len = r->ds->ds_num;
 196
 197   for (i = 0; i < r->values_num; i++)
 198   {
 199     char *endptr;
 200
 201     endptr = NULL;
 202     errno = 0;
 203     if (r->ds->ds[i].type == DS_TYPE_COUNTER)
 204       vl.values[i].counter = (counter_t) strtoll (r->values_buffer[i],
 205           &endptr, /* base = */ 0);
 206     else if (r->ds->ds[i].type == DS_TYPE_GAUGE)
 207       vl.values[i].gauge = (gauge_t) strtod (r->values_buffer[i], &endptr);
 208     else
 209       errno = EINVAL;
 210
 211     if ((endptr == r->values_buffer[i]) || (errno != 0))
 212     {
 213       WARNING ("db query utils: udb_result_submit: Parsing `%s' as %s failed.",
 214           r->values_buffer[i],
 215           (r->ds->ds[i].type == DS_TYPE_COUNTER) ? "counter" : "gauge");
 216       vl.values[i].gauge = NAN;
 217     }
 218   }
 219
 220   sstrncpy (vl.host, q->host, sizeof (vl.host));
 221   sstrncpy (vl.plugin, q->plugin, sizeof (vl.plugin));
 222   sstrncpy (vl.plugin_instance, q->db_name, sizeof (vl.type_instance));
 223   sstrncpy (vl.type, r->type, sizeof (vl.type));
 224
 225   if (r->instance_prefix == NULL)
 226   {
 227     strjoin (vl.type_instance, sizeof (vl.type_instance),
 228         r->instances_buffer, r->instances_num, "-");
 229   }
 230   else
 231   {
 232     char tmp[DATA_MAX_NAME_LEN];
 233
 234     strjoin (tmp, sizeof (tmp), r->instances_buffer, r->instances_num, "-");
 235     tmp[sizeof (tmp) - 1] = 0;
 236
 237     snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
 238         r->instance_prefix, tmp);
 239   }
 240   vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
 241
 242   plugin_dispatch_values (&vl);
 243
 244   sfree (vl.values);
 245 } /* }}} void udb_result_submit */
 246
 247 static void udb_result_finish_result (udb_result_t *r) /* {{{ */
 248 {
 249   if (r == NULL)
 250     return;
 251
 252   r->ds = NULL;
 253   sfree (r->instances_pos);
 254   sfree (r->values_pos);
 255   sfree (r->instances_buffer);
 256   sfree (r->values_buffer);
 257 } /* }}} void udb_result_finish_result */
 258
 259 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
 260     udb_query_t *q, char **column_values)
 261 {
 262   size_t i;
 263
 264   for (i = 0; i < r->instances_num; i++)
 265     r->instances_buffer[i] = column_values[r->instances_pos[i]];
 266
 267   for (i = 0; i < r->values_num; i++)
 268     r->values_buffer[i] = column_values[r->values_pos[i]];
 269
 270   udb_result_submit (r, q);
 271
 272   return (0);
 273 } /* }}} int udb_result_handle_result */
 274
 275 static int udb_result_prepare_result (udb_result_t *r, /* {{{ */
 276     char **column_names, size_t column_num)
 277 {
 278   size_t i;
 279
 280   if (r == NULL)
 281     return (-EINVAL);
 282
 283 #define BAIL_OUT(status) \
 284   r->ds = NULL; \
 285   sfree (r->instances_pos); \
 286   sfree (r->values_pos); \
 287   sfree (r->instances_buffer); \
 288   sfree (r->values_buffer); \
 289   return (status)
 290
 291   /* Make sure previous preparations are cleaned up. */
 292   udb_result_finish_result (r);
 293   r->instances_pos = NULL;
 294   r->values_pos = NULL;
 295
 296   /* Read `ds' and check number of values {{{ */
 297   r->ds = plugin_get_ds (r->type);
 298   if (r->ds == NULL)
 299   {
 300     ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
 301         "known by the daemon. See types.db(5) for details.",
 302         r->type);
 303     BAIL_OUT (-1);
 304   }
 305
 306   if (((size_t) r->ds->ds_num) != r->values_num)
 307   {
 308     ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
 309         "requires exactly %i value%s, but the configuration specifies %zu.",
 310         r->type,
 311         r->ds->ds_num, (r->ds->ds_num == 1) ? "" : "s",
 312         r->values_num);
 313     BAIL_OUT (-1);
 314   }
 315   /* }}} */
 316
 317   /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
 318    * r->values_buffer {{{ */
 319   r->instances_pos = (size_t *) calloc (r->instances_num, sizeof (size_t));
 320   if (r->instances_pos == NULL)
 321   {
 322     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 323     BAIL_OUT (-ENOMEM);
 324   }
 325
 326   r->values_pos = (size_t *) calloc (r->values_num, sizeof (size_t));
 327   if (r->values_pos == NULL)
 328   {
 329     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 330     BAIL_OUT (-ENOMEM);
 331   }
 332
 333   r->instances_buffer = (char **) calloc (r->instances_num, sizeof (char *));
 334   if (r->instances_buffer == NULL)
 335   {
 336     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 337     BAIL_OUT (-ENOMEM);
 338   }
 339
 340   r->values_buffer = (char **) calloc (r->values_num, sizeof (char *));
 341   if (r->values_buffer == NULL)
 342   {
 343     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 344     BAIL_OUT (-ENOMEM);
 345   }
 346   /* }}} */
 347
 348   /* Determine the position of the instance columns {{{ */
 349   for (i = 0; i < r->instances_num; i++)
 350   {
 351     size_t j;
 352
 353     for (j = 0; j < column_num; j++)
 354     {
 355       if (strcasecmp (r->instances[i], column_names[j]) == 0)
 356       {
 357         r->instances_pos[i] = j;
 358         break;
 359       }
 360     }
 361
 362     if (j >= column_num)
 363     {
 364       ERROR ("db query utils: udb_result_prepare_result: "
 365           "Column `%s' could not be found.",
 366           r->instances[i]);
 367       BAIL_OUT (-ENOENT);
 368     }
 369   } /* }}} for (i = 0; i < r->instances_num; i++) */
 370
 371   /* Determine the position of the value columns {{{ */
 372   for (i = 0; i < r->values_num; i++)
 373   {
 374     size_t j;
 375
 376     for (j = 0; j < column_num; j++)
 377     {
 378       if (strcasecmp (r->values[i], column_names[j]) == 0)
 379       {
 380         r->values_pos[i] = j;
 381         break;
 382       }
 383     }
 384
 385     if (j >= column_num)
 386     {
 387       ERROR ("db query utils: udb_result_prepare_result: "
 388           "Column `%s' could not be found.",
 389           r->values[i]);
 390       BAIL_OUT (-ENOENT);
 391     }
 392   } /* }}} for (i = 0; i < r->values_num; i++) */
 393
 394 #undef BAIL_OUT
 395   return (0);
 396 } /* }}} int udb_result_prepare_result */
 397
 398 static void udb_result_free (udb_result_t *r) /* {{{ */
 399 {
 400   size_t i;
 401
 402   if (r == NULL)
 403     return;
 404
 405   sfree (r->type);
 406
 407   for (i = 0; i < r->instances_num; i++)
 408     sfree (r->instances[i]);
 409   sfree (r->instances);
 410
 411   for (i = 0; i < r->values_num; i++)
 412     sfree (r->values[i]);
 413   sfree (r->values);
 414
 415   udb_result_free (r->next);
 416
 417   sfree (r);
 418 } /* }}} void udb_result_free */
 419
 420 static int udb_result_create (const char *query_name, /* {{{ */
 421     udb_result_t **r_head, oconfig_item_t *ci)
 422 {
 423   udb_result_t *r;
 424   int status;
 425   int i;
 426
 427   if (ci->values_num != 0)
 428   {
 429     WARNING ("db query utils: The `Result' block doesn't accept "
 430         "any arguments. Ignoring %i argument%s.",
 431         ci->values_num, (ci->values_num == 1) ? "" : "s");
 432   }
 433
 434   r = (udb_result_t *) malloc (sizeof (*r));
 435   if (r == NULL)
 436   {
 437     ERROR ("db query utils: malloc failed.");
 438     return (-1);
 439   }
 440   memset (r, 0, sizeof (*r));
 441   r->type = NULL;
 442   r->instance_prefix = NULL;
 443   r->instances = NULL;
 444   r->values = NULL;
 445   r->next = NULL;
 446
 447   /* Fill the `udb_result_t' structure.. */
 448   status = 0;
 449   for (i = 0; i < ci->children_num; i++)
 450   {
 451     oconfig_item_t *child = ci->children + i;
 452
 453     if (strcasecmp ("Type", child->key) == 0)
 454       status = udb_config_set_string (&r->type, child);
 455     else if (strcasecmp ("InstancePrefix", child->key) == 0)
 456       status = udb_config_set_string (&r->instance_prefix, child);
 457     else if (strcasecmp ("InstancesFrom", child->key) == 0)
 458       status = udb_config_add_string (&r->instances, &r->instances_num, child);
 459     else if (strcasecmp ("ValuesFrom", child->key) == 0)
 460       status = udb_config_add_string (&r->values, &r->values_num, child);
 461     else
 462     {
 463       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 464           query_name, child->key);
 465       status = -1;
 466     }
 467
 468     if (status != 0)
 469       break;
 470   }
 471
 472   /* Check that all necessary options have been given. */
 473   while (status == 0)
 474   {
 475     if (r->type == NULL)
 476     {
 477       WARNING ("db query utils: `Type' not given for "
 478           "result in query `%s'", query_name);
 479       status = -1;
 480     }
 481     if (r->instances == NULL)
 482     {
 483       WARNING ("db query utils: `InstancesFrom' not given for "
 484           "result in query `%s'", query_name);
 485       status = -1;
 486     }
 487     if (r->values == NULL)
 488     {
 489       WARNING ("db query utils: `ValuesFrom' not given for "
 490           "result in query `%s'", query_name);
 491       status = -1;
 492     }
 493
 494     break;
 495   } /* while (status == 0) */
 496
 497   if (status != 0)
 498   {
 499     udb_result_free (r);
 500     return (-1);
 501   }
 502
 503   /* If all went well, add this result to the list of results. */
 504   if (*r_head == NULL)
 505   {
 506     *r_head = r;
 507   }
 508   else
 509   {
 510     udb_result_t *last;
 511
 512     last = *r_head;
 513     while (last->next != NULL)
 514       last = last->next;
 515
 516     last->next = r;
 517   }
 518
 519   return (0);
 520 } /* }}} int udb_result_create */
 521
 522 /*
 523  * Query private functions
 524  */
 525 void udb_query_free_one (udb_query_t *q) /* {{{ */
 526 {
 527   if (q == NULL)
 528     return;
 529
 530   sfree (q->name);
 531   sfree (q->statement);
 532
 533   udb_result_free (q->results);
 534
 535   sfree (q);
 536 } /* }}} void udb_query_free_one */
 537
 538 /*
 539  * Query public functions
 540  */
 541 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
 542     size_t *ret_query_list_len, oconfig_item_t *ci)
 543 {
 544   udb_query_t **query_list;
 545   size_t        query_list_len;
 546
 547   udb_query_t *q;
 548   int status;
 549   int i;
 550
 551   if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
 552     return (-EINVAL);
 553   query_list     = *ret_query_list;
 554   query_list_len = *ret_query_list_len;
 555
 556   if ((ci->values_num != 1)
 557       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 558   {
 559     WARNING ("db query utils: The `Query' block "
 560         "needs exactly one string argument.");
 561     return (-1);
 562   }
 563
 564   q = (udb_query_t *) malloc (sizeof (*q));
 565   if (q == NULL)
 566   {
 567     ERROR ("db query utils: malloc failed.");
 568     return (-1);
 569   }
 570   memset (q, 0, sizeof (*q));
 571   q->min_version = 0;
 572   q->max_version = UINT_MAX;
 573
 574   status = udb_config_set_string (&q->name, ci);
 575   if (status != 0)
 576   {
 577     sfree (q);
 578     return (status);
 579   }
 580
 581   /* Fill the `udb_query_t' structure.. */
 582   for (i = 0; i < ci->children_num; i++)
 583   {
 584     oconfig_item_t *child = ci->children + i;
 585
 586     if (strcasecmp ("Statement", child->key) == 0)
 587       status = udb_config_set_string (&q->statement, child);
 588     else if (strcasecmp ("Result", child->key) == 0)
 589       status = udb_result_create (q->name, &q->results, child);
 590     else if (strcasecmp ("MinVersion", child->key) == 0)
 591       status = udb_config_set_uint (&q->min_version, child);
 592     else if (strcasecmp ("MaxVersion", child->key) == 0)
 593       status = udb_config_set_uint (&q->max_version, child);
 594     /* PostgreSQL compatibility code */
 595     else if (strcasecmp ("MinPGVersion", child->key) == 0)
 596     {
 597       WARNING ("db query utils: Query `%s': The `MinPGVersion' option is "
 598           "deprecated. Please use `MinVersion' instead.",
 599           q->name);
 600       status = udb_config_set_uint (&q->min_version, child);
 601     }
 602     else if (strcasecmp ("MaxPGVersion", child->key) == 0)
 603     {
 604       WARNING ("db query utils: Query `%s': The `MaxPGVersion' option is "
 605           "deprecated. Please use `MaxVersion' instead.",
 606           q->name);
 607       status = udb_config_set_uint (&q->max_version, child);
 608     }
 609     else
 610     {
 611       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 612           q->name, child->key);
 613       status = -1;
 614     }
 615
 616     if (status != 0)
 617       break;
 618   }
 619
 620   /* Check that all necessary options have been given. */
 621   if (status == 0)
 622   {
 623     if (q->statement == NULL)
 624     {
 625       WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
 626       status = -1;
 627     }
 628     if (q->results == NULL)
 629     {
 630       WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
 631           q->name);
 632       status = -1;
 633     }
 634   } /* if (status == 0) */
 635
 636   /* If all went well, add this query to the list of queries within the
 637    * database structure. */
 638   if (status == 0)
 639   {
 640     udb_query_t **temp;
 641
 642     temp = (udb_query_t **) realloc (query_list,
 643         sizeof (*query_list) * (query_list_len + 1));
 644     if (temp == NULL)
 645     {
 646       ERROR ("db query utils: realloc failed");
 647       status = -1;
 648     }
 649     else
 650     {
 651       query_list = temp;
 652       query_list[query_list_len] = q;
 653       query_list_len++;
 654     }
 655   }
 656
 657   if (status != 0)
 658   {
 659     udb_query_free_one (q);
 660     return (-1);
 661   }
 662
 663   *ret_query_list     = query_list;
 664   *ret_query_list_len = query_list_len;
 665
 666   return (0);
 667 } /* }}} int udb_query_create */
 668
 669 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
 670 {
 671   size_t i;
 672
 673   if (query_list == NULL)
 674     return;
 675
 676   for (i = 0; i < query_list_len; i++)
 677     udb_query_free_one (query_list[i]);
 678
 679   sfree (query_list);
 680 } /* }}} void udb_query_free */
 681
 682 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
 683     udb_query_t **src_list, size_t src_list_len,
 684     udb_query_t ***dst_list, size_t *dst_list_len)
 685 {
 686   const char *name;
 687   udb_query_t *q;
 688   udb_query_t **tmp_list;
 689   size_t tmp_list_len;
 690   size_t i;
 691
 692   if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
 693       || (dst_list_len == NULL))
 694   {
 695     ERROR ("db query utils: Invalid argument.");
 696     return (-EINVAL);
 697   }
 698
 699   if ((ci->values_num != 1)
 700       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 701   {
 702     ERROR ("db query utils: The `%s' config option "
 703         "needs exactly one string argument.", ci->key);
 704     return (-1);
 705   }
 706   name = ci->values[0].value.string;
 707
 708   q = NULL;
 709   for (i = 0; i < src_list_len; i++)
 710     if (strcasecmp (name, src_list[i]->name) == 0)
 711     {
 712       q = src_list[i];
 713       break;
 714     }
 715
 716   if (q == NULL)
 717   {
 718     ERROR ("db query utils: Cannot find query `%s'. Make sure the <%s> "
 719         "block is above the database definition!",
 720         name, ci->key);
 721     return (-ENOENT);
 722   }
 723
 724   tmp_list_len = *dst_list_len;
 725   tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
 726       * sizeof (udb_query_t *));
 727   if (tmp_list == NULL)
 728   {
 729     ERROR ("db query utils: realloc failed.");
 730     return (-ENOMEM);
 731   }
 732   tmp_list[tmp_list_len] = q;
 733   tmp_list_len++;
 734
 735   *dst_list = tmp_list;
 736   *dst_list_len = tmp_list_len;
 737
 738   return (0);
 739 } /* }}} int udb_query_pick_from_list */
 740
 741 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
 742 {
 743   if (q == NULL)
 744     return (NULL);
 745
 746   return (q->name);
 747 } /* }}} const char *udb_query_get_name */
 748
 749 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
 750 {
 751   if (q == NULL)
 752     return (NULL);
 753
 754   return (q->statement);
 755 } /* }}} const char *udb_query_get_statement */
 756
 757 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
 758 {
 759   if (q == NULL)
 760     return;
 761
 762   q->user_data = user_data;
 763 } /* }}} void udb_query_set_user_data */
 764
 765 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
 766 {
 767   if (q == NULL)
 768     return (NULL);
 769
 770   return (q->user_data);
 771 } /* }}} void *udb_query_get_user_data */
 772
 773 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
 774 {
 775   if (q == NULL)
 776     return (-EINVAL);
 777
 778   if ((version < q->min_version) || (version > q->max_version))
 779     return (0);
 780
 781   return (1);
 782 } /* }}} int udb_query_check_version */
 783
 784 void udb_query_finish_result (udb_query_t *q) /* {{{ */
 785 {
 786   udb_result_t *r;
 787
 788   if (q == NULL)
 789     return;
 790
 791   q->column_num = 0;
 792   sfree (q->host);
 793   sfree (q->plugin);
 794   sfree (q->db_name);
 795
 796   for (r = q->results; r != NULL; r = r->next)
 797     udb_result_finish_result (r);
 798 } /* }}} void udb_query_finish_result */
 799
 800 int udb_query_handle_result (udb_query_t *q, char **column_values) /* {{{ */
 801 {
 802   udb_result_t *r;
 803   int success;
 804   int status;
 805
 806   if (q == NULL)
 807     return (-EINVAL);
 808
 809   if ((q->column_num < 1) || (q->host == NULL) || (q->plugin == NULL)
 810       || (q->db_name == NULL))
 811   {
 812     ERROR ("db query utils: Query `%s': Query is not prepared; "
 813         "can't handle result.", q->name);
 814     return (-EINVAL);
 815   }
 816
 817 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
 818   do
 819   {
 820     size_t i;
 821
 822     for (i = 0; i < q->column_num; i++)
 823     {
 824       DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
 825           "column[%zu] = %s;",
 826           q->db_name, q->name, i, column_values[i]);
 827     }
 828   } while (0);
 829 #endif /* }}} */
 830
 831   success = 0;
 832   for (r = q->results; r != NULL; r = r->next)
 833   {
 834     status = udb_result_handle_result (r, q, column_values);
 835     if (status == 0)
 836       success++;
 837   }
 838
 839   if (success == 0)
 840   {
 841     ERROR ("db query utils: udb_query_handle_result (%s, %s): "
 842         "All results failed.", q->db_name, q->name);
 843     return (-1);
 844   }
 845
 846   return (0);
 847 } /* }}} int udb_query_handle_result */
 848
 849 int udb_query_prepare_result (udb_query_t *q, /* {{{ */
 850     const char *host, const char *plugin, const char *db_name,
 851     char **column_names, size_t column_num)
 852 {
 853   udb_result_t *r;
 854   int status;
 855
 856   if (q == NULL)
 857     return (-EINVAL);
 858
 859   udb_query_finish_result (q);
 860
 861   q->column_num = column_num;
 862   q->host = strdup (host);
 863   q->plugin = strdup (plugin);
 864   q->db_name = strdup (db_name);
 865
 866   if ((q->host == NULL) || (q->plugin == NULL) || (q->db_name == NULL))
 867   {
 868     ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
 869     udb_query_finish_result (q);
 870     return (-ENOMEM);
 871   }
 872
 873 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
 874   do
 875   {
 876     size_t i;
 877
 878     for (i = 0; i < column_num; i++)
 879     {
 880       DEBUG ("db query utils: udb_query_prepare_result: "
 881           "query = %s; column[%zu] = %s;",
 882           q->name, i, column_names[i]);
 883     }
 884   } while (0);
 885 #endif
 886
 887   for (r = q->results; r != NULL; r = r->next)
 888   {
 889     status = udb_result_prepare_result (r, column_names, column_num);
 890     if (status != 0)
 891     {
 892       udb_query_finish_result (q);
 893       return (status);
 894     }
 895   }
 896
 897   return (0);
 898 } /* }}} int udb_query_prepare_result */
 899
 900 /* vim: set sw=2 sts=2 et fdm=marker : */