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   vl.time = time (NULL);
 221   sstrncpy (vl.host, q->host, sizeof (vl.host));
 222   sstrncpy (vl.plugin, q->plugin, sizeof (vl.plugin));
 223   sstrncpy (vl.plugin_instance, q->db_name, sizeof (vl.type_instance));
 224   sstrncpy (vl.type, r->type, sizeof (vl.type));
 225
 226   if (r->instance_prefix == NULL)
 227   {
 228     strjoin (vl.type_instance, sizeof (vl.type_instance),
 229         r->instances_buffer, r->instances_num, "-");
 230   }
 231   else
 232   {
 233     char tmp[DATA_MAX_NAME_LEN];
 234
 235     strjoin (tmp, sizeof (tmp), r->instances_buffer, r->instances_num, "-");
 236     tmp[sizeof (tmp) - 1] = 0;
 237
 238     snprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
 239         r->instance_prefix, tmp);
 240   }
 241   vl.type_instance[sizeof (vl.type_instance) - 1] = 0;
 242
 243   plugin_dispatch_values (&vl);
 244
 245   sfree (vl.values);
 246 } /* }}} void udb_result_submit */
 247
 248 static void udb_result_finish_result (udb_result_t *r) /* {{{ */
 249 {
 250   if (r == NULL)
 251     return;
 252
 253   r->ds = NULL;
 254   sfree (r->instances_pos);
 255   sfree (r->values_pos);
 256   sfree (r->instances_buffer);
 257   sfree (r->values_buffer);
 258 } /* }}} void udb_result_finish_result */
 259
 260 static int udb_result_handle_result (udb_result_t *r, /* {{{ */
 261     udb_query_t *q, char **column_values)
 262 {
 263   size_t i;
 264
 265   for (i = 0; i < r->instances_num; i++)
 266     r->instances_buffer[i] = column_values[r->instances_pos[i]];
 267
 268   for (i = 0; i < r->values_num; i++)
 269     r->values_buffer[i] = column_values[r->values_pos[i]];
 270
 271   udb_result_submit (r, q);
 272
 273   return (0);
 274 } /* }}} int udb_result_handle_result */
 275
 276 static int udb_result_prepare_result (udb_result_t *r, /* {{{ */
 277     char **column_names, size_t column_num)
 278 {
 279   size_t i;
 280
 281   if (r == NULL)
 282     return (-EINVAL);
 283
 284 #define BAIL_OUT(status) \
 285   r->ds = NULL; \
 286   sfree (r->instances_pos); \
 287   sfree (r->values_pos); \
 288   sfree (r->instances_buffer); \
 289   sfree (r->values_buffer); \
 290   return (status)
 291
 292   /* Make sure previous preparations are cleaned up. */
 293   udb_result_finish_result (r);
 294   r->instances_pos = NULL;
 295   r->values_pos = NULL;
 296
 297   /* Read `ds' and check number of values {{{ */
 298   r->ds = plugin_get_ds (r->type);
 299   if (r->ds == NULL)
 300   {
 301     ERROR ("db query utils: udb_result_prepare_result: Type `%s' is not "
 302         "known by the daemon. See types.db(5) for details.",
 303         r->type);
 304     BAIL_OUT (-1);
 305   }
 306
 307   if (((size_t) r->ds->ds_num) != r->values_num)
 308   {
 309     ERROR ("db query utils: udb_result_prepare_result: The type `%s' "
 310         "requires exactly %i value%s, but the configuration specifies %zu.",
 311         r->type,
 312         r->ds->ds_num, (r->ds->ds_num == 1) ? "" : "s",
 313         r->values_num);
 314     BAIL_OUT (-1);
 315   }
 316   /* }}} */
 317
 318   /* Allocate r->instances_pos, r->values_pos, r->instances_buffer, and
 319    * r->values_buffer {{{ */
 320   r->instances_pos = (size_t *) calloc (r->instances_num, sizeof (size_t));
 321   if (r->instances_pos == NULL)
 322   {
 323     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 324     BAIL_OUT (-ENOMEM);
 325   }
 326
 327   r->values_pos = (size_t *) calloc (r->values_num, sizeof (size_t));
 328   if (r->values_pos == NULL)
 329   {
 330     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 331     BAIL_OUT (-ENOMEM);
 332   }
 333
 334   r->instances_buffer = (char **) calloc (r->instances_num, sizeof (char *));
 335   if (r->instances_buffer == NULL)
 336   {
 337     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 338     BAIL_OUT (-ENOMEM);
 339   }
 340
 341   r->values_buffer = (char **) calloc (r->values_num, sizeof (char *));
 342   if (r->values_buffer == NULL)
 343   {
 344     ERROR ("db query utils: udb_result_prepare_result: malloc failed.");
 345     BAIL_OUT (-ENOMEM);
 346   }
 347   /* }}} */
 348
 349   /* Determine the position of the instance columns {{{ */
 350   for (i = 0; i < r->instances_num; i++)
 351   {
 352     size_t j;
 353
 354     for (j = 0; j < column_num; j++)
 355     {
 356       if (strcasecmp (r->instances[i], column_names[j]) == 0)
 357       {
 358         r->instances_pos[i] = j;
 359         break;
 360       }
 361     }
 362
 363     if (j >= column_num)
 364     {
 365       ERROR ("db query utils: udb_result_prepare_result: "
 366           "Column `%s' could not be found.",
 367           r->instances[i]);
 368       BAIL_OUT (-ENOENT);
 369     }
 370   } /* }}} for (i = 0; i < r->instances_num; i++) */
 371
 372   /* Determine the position of the value columns {{{ */
 373   for (i = 0; i < r->values_num; i++)
 374   {
 375     size_t j;
 376
 377     for (j = 0; j < column_num; j++)
 378     {
 379       if (strcasecmp (r->values[i], column_names[j]) == 0)
 380       {
 381         r->values_pos[i] = j;
 382         break;
 383       }
 384     }
 385
 386     if (j >= column_num)
 387     {
 388       ERROR ("db query utils: udb_result_prepare_result: "
 389           "Column `%s' could not be found.",
 390           r->values[i]);
 391       BAIL_OUT (-ENOENT);
 392     }
 393   } /* }}} for (i = 0; i < r->values_num; i++) */
 394
 395 #undef BAIL_OUT
 396   return (0);
 397 } /* }}} int udb_result_prepare_result */
 398
 399 static void udb_result_free (udb_result_t *r) /* {{{ */
 400 {
 401   size_t i;
 402
 403   if (r == NULL)
 404     return;
 405
 406   sfree (r->type);
 407
 408   for (i = 0; i < r->instances_num; i++)
 409     sfree (r->instances[i]);
 410   sfree (r->instances);
 411
 412   for (i = 0; i < r->values_num; i++)
 413     sfree (r->values[i]);
 414   sfree (r->values);
 415
 416   udb_result_free (r->next);
 417
 418   sfree (r);
 419 } /* }}} void udb_result_free */
 420
 421 static int udb_result_create (const char *query_name, /* {{{ */
 422     udb_result_t **r_head, oconfig_item_t *ci)
 423 {
 424   udb_result_t *r;
 425   int status;
 426   int i;
 427
 428   if (ci->values_num != 0)
 429   {
 430     WARNING ("db query utils: The `Result' block doesn't accept "
 431         "any arguments. Ignoring %i argument%s.",
 432         ci->values_num, (ci->values_num == 1) ? "" : "s");
 433   }
 434
 435   r = (udb_result_t *) malloc (sizeof (*r));
 436   if (r == NULL)
 437   {
 438     ERROR ("db query utils: malloc failed.");
 439     return (-1);
 440   }
 441   memset (r, 0, sizeof (*r));
 442   r->type = NULL;
 443   r->instance_prefix = NULL;
 444   r->instances = NULL;
 445   r->values = NULL;
 446   r->next = NULL;
 447
 448   /* Fill the `udb_result_t' structure.. */
 449   status = 0;
 450   for (i = 0; i < ci->children_num; i++)
 451   {
 452     oconfig_item_t *child = ci->children + i;
 453
 454     if (strcasecmp ("Type", child->key) == 0)
 455       status = udb_config_set_string (&r->type, child);
 456     else if (strcasecmp ("InstancePrefix", child->key) == 0)
 457       status = udb_config_set_string (&r->instance_prefix, child);
 458     else if (strcasecmp ("InstancesFrom", child->key) == 0)
 459       status = udb_config_add_string (&r->instances, &r->instances_num, child);
 460     else if (strcasecmp ("ValuesFrom", child->key) == 0)
 461       status = udb_config_add_string (&r->values, &r->values_num, child);
 462     else
 463     {
 464       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 465           query_name, child->key);
 466       status = -1;
 467     }
 468
 469     if (status != 0)
 470       break;
 471   }
 472
 473   /* Check that all necessary options have been given. */
 474   while (status == 0)
 475   {
 476     if (r->type == NULL)
 477     {
 478       WARNING ("db query utils: `Type' not given for "
 479           "result in query `%s'", query_name);
 480       status = -1;
 481     }
 482     if (r->instances == NULL)
 483     {
 484       WARNING ("db query utils: `InstancesFrom' not given for "
 485           "result in query `%s'", query_name);
 486       status = -1;
 487     }
 488     if (r->values == NULL)
 489     {
 490       WARNING ("db query utils: `ValuesFrom' not given for "
 491           "result in query `%s'", query_name);
 492       status = -1;
 493     }
 494
 495     break;
 496   } /* while (status == 0) */
 497
 498   if (status != 0)
 499   {
 500     udb_result_free (r);
 501     return (-1);
 502   }
 503
 504   /* If all went well, add this result to the list of results. */
 505   if (*r_head == NULL)
 506   {
 507     *r_head = r;
 508   }
 509   else
 510   {
 511     udb_result_t *last;
 512
 513     last = *r_head;
 514     while (last->next != NULL)
 515       last = last->next;
 516
 517     last->next = r;
 518   }
 519
 520   return (0);
 521 } /* }}} int udb_result_create */
 522
 523 /*
 524  * Query private functions
 525  */
 526 void udb_query_free_one (udb_query_t *q) /* {{{ */
 527 {
 528   if (q == NULL)
 529     return;
 530
 531   sfree (q->name);
 532   sfree (q->statement);
 533
 534   udb_result_free (q->results);
 535
 536   sfree (q);
 537 } /* }}} void udb_query_free_one */
 538
 539 /*
 540  * Query public functions
 541  */
 542 int udb_query_create (udb_query_t ***ret_query_list, /* {{{ */
 543     size_t *ret_query_list_len, oconfig_item_t *ci,
 544     udb_query_create_callback_t cb)
 545 {
 546   udb_query_t **query_list;
 547   size_t        query_list_len;
 548
 549   udb_query_t *q;
 550   int status;
 551   int i;
 552
 553   if ((ret_query_list == NULL) || (ret_query_list_len == NULL))
 554     return (-EINVAL);
 555   query_list     = *ret_query_list;
 556   query_list_len = *ret_query_list_len;
 557
 558   if ((ci->values_num != 1)
 559       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 560   {
 561     WARNING ("db query utils: The `Query' block "
 562         "needs exactly one string argument.");
 563     return (-1);
 564   }
 565
 566   q = (udb_query_t *) malloc (sizeof (*q));
 567   if (q == NULL)
 568   {
 569     ERROR ("db query utils: malloc failed.");
 570     return (-1);
 571   }
 572   memset (q, 0, sizeof (*q));
 573   q->min_version = 0;
 574   q->max_version = UINT_MAX;
 575
 576   status = udb_config_set_string (&q->name, ci);
 577   if (status != 0)
 578   {
 579     sfree (q);
 580     return (status);
 581   }
 582
 583   /* Fill the `udb_query_t' structure.. */
 584   for (i = 0; i < ci->children_num; i++)
 585   {
 586     oconfig_item_t *child = ci->children + i;
 587
 588     if (strcasecmp ("Statement", child->key) == 0)
 589       status = udb_config_set_string (&q->statement, child);
 590     else if (strcasecmp ("Result", child->key) == 0)
 591       status = udb_result_create (q->name, &q->results, child);
 592     else if (strcasecmp ("MinVersion", child->key) == 0)
 593       status = udb_config_set_uint (&q->min_version, child);
 594     else if (strcasecmp ("MaxVersion", child->key) == 0)
 595       status = udb_config_set_uint (&q->max_version, child);
 596     /* PostgreSQL compatibility code */
 597     else if (strcasecmp ("MinPGVersion", child->key) == 0)
 598     {
 599       WARNING ("db query utils: Query `%s': The `MinPGVersion' option is "
 600           "deprecated. Please use `MinVersion' instead.",
 601           q->name);
 602       status = udb_config_set_uint (&q->min_version, child);
 603     }
 604     else if (strcasecmp ("MaxPGVersion", child->key) == 0)
 605     {
 606       WARNING ("db query utils: Query `%s': The `MaxPGVersion' option is "
 607           "deprecated. Please use `MaxVersion' instead.",
 608           q->name);
 609       status = udb_config_set_uint (&q->max_version, child);
 610     }
 611     else if (cb != NULL)
 612     {
 613       status = (*cb) (q, child);
 614       if (status != 0)
 615       {
 616         WARNING ("db query utils: The configuration callback failed "
 617             "to handle `%s'.", child->key);
 618       }
 619     }
 620     else
 621     {
 622       WARNING ("db query utils: Query `%s': Option `%s' not allowed here.",
 623           q->name, child->key);
 624       status = -1;
 625     }
 626
 627     if (status != 0)
 628       break;
 629   }
 630
 631   /* Check that all necessary options have been given. */
 632   if (status == 0)
 633   {
 634     if (q->statement == NULL)
 635     {
 636       WARNING ("db query utils: Query `%s': No `Statement' given.", q->name);
 637       status = -1;
 638     }
 639     if (q->results == NULL)
 640     {
 641       WARNING ("db query utils: Query `%s': No (valid) `Result' block given.",
 642           q->name);
 643       status = -1;
 644     }
 645   } /* if (status == 0) */
 646
 647   /* If all went well, add this query to the list of queries within the
 648    * database structure. */
 649   if (status == 0)
 650   {
 651     udb_query_t **temp;
 652
 653     temp = (udb_query_t **) realloc (query_list,
 654         sizeof (*query_list) * (query_list_len + 1));
 655     if (temp == NULL)
 656     {
 657       ERROR ("db query utils: realloc failed");
 658       status = -1;
 659     }
 660     else
 661     {
 662       query_list = temp;
 663       query_list[query_list_len] = q;
 664       query_list_len++;
 665     }
 666   }
 667
 668   if (status != 0)
 669   {
 670     udb_query_free_one (q);
 671     return (-1);
 672   }
 673
 674   *ret_query_list     = query_list;
 675   *ret_query_list_len = query_list_len;
 676
 677   return (0);
 678 } /* }}} int udb_query_create */
 679
 680 void udb_query_free (udb_query_t **query_list, size_t query_list_len) /* {{{ */
 681 {
 682   size_t i;
 683
 684   if (query_list == NULL)
 685     return;
 686
 687   for (i = 0; i < query_list_len; i++)
 688     udb_query_free_one (query_list[i]);
 689
 690   sfree (query_list);
 691 } /* }}} void udb_query_free */
 692
 693 int udb_query_pick_from_list (oconfig_item_t *ci, /* {{{ */
 694     udb_query_t **src_list, size_t src_list_len,
 695     udb_query_t ***dst_list, size_t *dst_list_len)
 696 {
 697   const char *name;
 698   udb_query_t *q;
 699   udb_query_t **tmp_list;
 700   size_t tmp_list_len;
 701   size_t i;
 702
 703   if ((ci == NULL) || (src_list == NULL) || (dst_list == NULL)
 704       || (dst_list_len == NULL))
 705   {
 706     ERROR ("db query utils: Invalid argument.");
 707     return (-EINVAL);
 708   }
 709
 710   if ((ci->values_num != 1)
 711       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 712   {
 713     ERROR ("db query utils: The `%s' config option "
 714         "needs exactly one string argument.", ci->key);
 715     return (-1);
 716   }
 717   name = ci->values[0].value.string;
 718
 719   q = NULL;
 720   for (i = 0; i < src_list_len; i++)
 721     if (strcasecmp (name, src_list[i]->name) == 0)
 722     {
 723       q = src_list[i];
 724       break;
 725     }
 726
 727   if (q == NULL)
 728   {
 729     ERROR ("db query utils: Cannot find query `%s'. Make sure the <%s> "
 730         "block is above the database definition!",
 731         name, ci->key);
 732     return (-ENOENT);
 733   }
 734
 735   tmp_list_len = *dst_list_len;
 736   tmp_list = (udb_query_t **) realloc (*dst_list, (tmp_list_len + 1)
 737       * sizeof (udb_query_t *));
 738   if (tmp_list == NULL)
 739   {
 740     ERROR ("db query utils: realloc failed.");
 741     return (-ENOMEM);
 742   }
 743   tmp_list[tmp_list_len] = q;
 744   tmp_list_len++;
 745
 746   *dst_list = tmp_list;
 747   *dst_list_len = tmp_list_len;
 748
 749   return (0);
 750 } /* }}} int udb_query_pick_from_list */
 751
 752 const char *udb_query_get_name (udb_query_t *q) /* {{{ */
 753 {
 754   if (q == NULL)
 755     return (NULL);
 756
 757   return (q->name);
 758 } /* }}} const char *udb_query_get_name */
 759
 760 const char *udb_query_get_statement (udb_query_t *q) /* {{{ */
 761 {
 762   if (q == NULL)
 763     return (NULL);
 764
 765   return (q->statement);
 766 } /* }}} const char *udb_query_get_statement */
 767
 768 void udb_query_set_user_data (udb_query_t *q, void *user_data) /* {{{ */
 769 {
 770   if (q == NULL)
 771     return;
 772
 773   q->user_data = user_data;
 774 } /* }}} void udb_query_set_user_data */
 775
 776 void *udb_query_get_user_data (udb_query_t *q) /* {{{ */
 777 {
 778   if (q == NULL)
 779     return (NULL);
 780
 781   return (q->user_data);
 782 } /* }}} void *udb_query_get_user_data */
 783
 784 int udb_query_check_version (udb_query_t *q, unsigned int version) /* {{{ */
 785 {
 786   if (q == NULL)
 787     return (-EINVAL);
 788
 789   if ((version < q->min_version) || (version > q->max_version))
 790     return (0);
 791
 792   return (1);
 793 } /* }}} int udb_query_check_version */
 794
 795 void udb_query_finish_result (udb_query_t *q) /* {{{ */
 796 {
 797   udb_result_t *r;
 798
 799   if (q == NULL)
 800     return;
 801
 802   q->column_num = 0;
 803   sfree (q->host);
 804   sfree (q->plugin);
 805   sfree (q->db_name);
 806
 807   for (r = q->results; r != NULL; r = r->next)
 808     udb_result_finish_result (r);
 809 } /* }}} void udb_query_finish_result */
 810
 811 int udb_query_handle_result (udb_query_t *q, char **column_values) /* {{{ */
 812 {
 813   udb_result_t *r;
 814   int success;
 815   int status;
 816
 817   if (q == NULL)
 818     return (-EINVAL);
 819
 820   if ((q->column_num < 1) || (q->host == NULL) || (q->plugin == NULL)
 821       || (q->db_name == NULL))
 822   {
 823     ERROR ("db query utils: Query `%s': Query is not prepared; "
 824         "can't handle result.", q->name);
 825     return (-EINVAL);
 826   }
 827
 828 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG /* {{{ */
 829   do
 830   {
 831     size_t i;
 832
 833     for (i = 0; i < q->column_num; i++)
 834     {
 835       DEBUG ("db query utils: udb_query_handle_result (%s, %s): "
 836           "column[%zu] = %s;",
 837           q->db_name, q->name, i, column_values[i]);
 838     }
 839   } while (0);
 840 #endif /* }}} */
 841
 842   success = 0;
 843   for (r = q->results; r != NULL; r = r->next)
 844   {
 845     status = udb_result_handle_result (r, q, column_values);
 846     if (status == 0)
 847       success++;
 848   }
 849
 850   if (success == 0)
 851   {
 852     ERROR ("db query utils: udb_query_handle_result (%s, %s): "
 853         "All results failed.", q->db_name, q->name);
 854     return (-1);
 855   }
 856
 857   return (0);
 858 } /* }}} int udb_query_handle_result */
 859
 860 int udb_query_prepare_result (udb_query_t *q, /* {{{ */
 861     const char *host, const char *plugin, const char *db_name,
 862     char **column_names, size_t column_num)
 863 {
 864   udb_result_t *r;
 865   int status;
 866
 867   if (q == NULL)
 868     return (-EINVAL);
 869
 870   udb_query_finish_result (q);
 871
 872   q->column_num = column_num;
 873   q->host = strdup (host);
 874   q->plugin = strdup (plugin);
 875   q->db_name = strdup (db_name);
 876
 877   if ((q->host == NULL) || (q->plugin == NULL) || (q->db_name == NULL))
 878   {
 879     ERROR ("db query utils: Query `%s': Prepare failed: Out of memory.", q->name);
 880     udb_query_finish_result (q);
 881     return (-ENOMEM);
 882   }
 883
 884 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG
 885   do
 886   {
 887     size_t i;
 888
 889     for (i = 0; i < column_num; i++)
 890     {
 891       DEBUG ("db query utils: udb_query_prepare_result: "
 892           "query = %s; column[%zu] = %s;",
 893           q->name, i, column_names[i]);
 894     }
 895   } while (0);
 896 #endif
 897
 898   for (r = q->results; r != NULL; r = r->next)
 899   {
 900     status = udb_result_prepare_result (r, column_names, column_num);
 901     if (status != 0)
 902     {
 903       udb_query_finish_result (q);
 904       return (status);
 905     }
 906   }
 907
 908   return (0);
 909 } /* }}} int udb_query_prepare_result */
 910
 911 /* vim: set sw=2 sts=2 et fdm=marker : */