src/curl_xml.c

   1 /**
   2  * collectd - src/curl_xml.c
   3  * Copyright (C) 2009,2010       Amit Gupta
   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  *   Amit Gupta <amit.gupta221 at gmail.com>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26 #include "utils_llist.h"
  27
  28 #include <libxml/parser.h>
  29 #include <libxml/tree.h>
  30 #include <libxml/xpath.h>
  31 #include <libxml/xpathInternals.h>
  32
  33 #include <curl/curl.h>
  34
  35 #define CX_DEFAULT_HOST "localhost"
  36
  37 /*
  38  * Private data structures
  39  */
  40 struct cx_values_s /* {{{ */
  41 {
  42   char path[DATA_MAX_NAME_LEN];
  43   size_t path_len;
  44 };
  45 typedef struct cx_values_s cx_values_t;
  46 /* }}} */
  47
  48 struct cx_xpath_s /* {{{ */
  49 {
  50   char *path;
  51   char *type;
  52   cx_values_t *values;
  53   size_t values_len;
  54   char *instance_prefix;
  55   char *instance;
  56   int is_table;
  57   unsigned long magic;
  58 };
  59 typedef struct cx_xpath_s cx_xpath_t;
  60 /* }}} */
  61
  62 struct cx_namespace_s /* {{{ */
  63 {
  64   char *prefix;
  65   char *url;
  66 };
  67 typedef struct cx_namespace_s cx_namespace_t;
  68 /* }}} */
  69
  70 struct cx_s /* {{{ */
  71 {
  72   char *instance;
  73   char *host;
  74
  75   char *url;
  76   char *user;
  77   char *pass;
  78   char *credentials;
  79   _Bool digest;
  80   _Bool verify_peer;
  81   _Bool verify_host;
  82   char *cacert;
  83   char *post_body;
  84   int timeout;
  85   struct curl_slist *headers;
  86
  87   cx_namespace_t *namespaces;
  88   size_t namespaces_num;
  89
  90   CURL *curl;
  91   char curl_errbuf[CURL_ERROR_SIZE];
  92   char *buffer;
  93   size_t buffer_size;
  94   size_t buffer_fill;
  95
  96   llist_t *list; /* list of xpath blocks */
  97 };
  98 typedef struct cx_s cx_t; /* }}} */
  99
 100 /*
 101  * Private functions
 102  */
 103 static size_t cx_curl_callback (void *buf, /* {{{ */
 104     size_t size, size_t nmemb, void *user_data)
 105 {
 106   size_t len = size * nmemb;
 107   cx_t *db;
 108
 109   db = user_data;
 110   if (db == NULL)
 111   {
 112     ERROR ("curl_xml plugin: cx_curl_callback: "
 113            "user_data pointer is NULL.");
 114     return (0);
 115   }
 116
 117    if (len <= 0)
 118     return (len);
 119
 120   if ((db->buffer_fill + len) >= db->buffer_size)
 121   {
 122     char *temp;
 123
 124     temp = (char *) realloc (db->buffer,
 125                     db->buffer_fill + len + 1);
 126     if (temp == NULL)
 127     {
 128       ERROR ("curl_xml plugin: realloc failed.");
 129       return (0);
 130     }
 131     db->buffer = temp;
 132     db->buffer_size = db->buffer_fill + len + 1;
 133   }
 134
 135   memcpy (db->buffer + db->buffer_fill, (char *) buf, len);
 136   db->buffer_fill += len;
 137   db->buffer[db->buffer_fill] = 0;
 138
 139   return (len);
 140 } /* }}} size_t cx_curl_callback */
 141
 142 static void cx_xpath_free (cx_xpath_t *xpath) /* {{{ */
 143 {
 144   if (xpath == NULL)
 145     return;
 146
 147   sfree (xpath->path);
 148   sfree (xpath->type);
 149   sfree (xpath->instance_prefix);
 150   sfree (xpath->instance);
 151   sfree (xpath->values);
 152   sfree (xpath);
 153 } /* }}} void cx_xpath_free */
 154
 155 static void cx_list_free (llist_t *list) /* {{{ */
 156 {
 157   llentry_t *le;
 158
 159   le = llist_head (list);
 160   while (le != NULL)
 161   {
 162     llentry_t *le_next;
 163
 164     le_next = le->next;
 165
 166     sfree (le->key);
 167     cx_xpath_free (le->value);
 168
 169     le = le_next;
 170   }
 171
 172   llist_destroy (list);
 173   list = NULL;
 174 } /* }}} void cx_list_free */
 175
 176 static void cx_free (void *arg) /* {{{ */
 177 {
 178   cx_t *db;
 179   size_t i;
 180
 181   DEBUG ("curl_xml plugin: cx_free (arg = %p);", arg);
 182
 183   db = (cx_t *) arg;
 184
 185   if (db == NULL)
 186     return;
 187
 188   if (db->curl != NULL)
 189     curl_easy_cleanup (db->curl);
 190   db->curl = NULL;
 191
 192   if (db->list != NULL)
 193     cx_list_free (db->list);
 194
 195   sfree (db->buffer);
 196   sfree (db->instance);
 197   sfree (db->host);
 198
 199   sfree (db->url);
 200   sfree (db->user);
 201   sfree (db->pass);
 202   sfree (db->credentials);
 203   sfree (db->cacert);
 204   sfree (db->post_body);
 205   curl_slist_free_all (db->headers);
 206
 207   for (i = 0; i < db->namespaces_num; i++)
 208   {
 209     sfree (db->namespaces[i].prefix);
 210     sfree (db->namespaces[i].url);
 211   }
 212   sfree (db->namespaces);
 213
 214   sfree (db);
 215 } /* }}} void cx_free */
 216
 217 static int cx_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
 218     oconfig_item_t *ci)
 219 {
 220   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 221   {
 222     WARNING ("curl_xml plugin: `%s' needs exactly one string argument.", name);
 223     return (-1);
 224   }
 225
 226   *dest = curl_slist_append(*dest, ci->values[0].value.string);
 227   if (*dest == NULL)
 228     return (-1);
 229
 230   return (0);
 231 } /* }}} int cx_config_append_string */
 232
 233 static int cx_check_type (const data_set_t *ds, cx_xpath_t *xpath) /* {{{ */
 234 {
 235   if (!ds)
 236   {
 237     WARNING ("curl_xml plugin: DataSet `%s' not defined.", xpath->type);
 238     return (-1);
 239   }
 240
 241   if (ds->ds_num != xpath->values_len)
 242   {
 243     WARNING ("curl_xml plugin: DataSet `%s' requires %zu values, but config talks about %zu",
 244         xpath->type, ds->ds_num, xpath->values_len);
 245     return (-1);
 246   }
 247
 248   return (0);
 249 } /* }}} cx_check_type */
 250
 251 static xmlXPathObjectPtr cx_evaluate_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */
 252            xmlChar *expr)
 253 {
 254   xmlXPathObjectPtr xpath_obj;
 255
 256   /* XXX: When to free this? */
 257   xpath_obj = xmlXPathEvalExpression(BAD_CAST expr, xpath_ctx);
 258   if (xpath_obj == NULL)
 259   {
 260      WARNING ("curl_xml plugin: "
 261                "Error unable to evaluate xpath expression \"%s\". Skipping...", expr);
 262      return NULL;
 263   }
 264
 265   return xpath_obj;
 266 } /* }}} cx_evaluate_xpath */
 267
 268 static int cx_if_not_text_node (xmlNodePtr node) /* {{{ */
 269 {
 270   if (node->type == XML_TEXT_NODE || node->type == XML_ATTRIBUTE_NODE ||
 271       node->type == XML_ELEMENT_NODE)
 272     return (0);
 273
 274   WARNING ("curl_xml plugin: "
 275            "Node \"%s\" doesn't seem to be a text node. Skipping...", node->name);
 276   return -1;
 277 } /* }}} cx_if_not_text_node */
 278
 279 static int cx_handle_single_value_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */
 280     cx_xpath_t *xpath,
 281     const data_set_t *ds, value_list_t *vl, int index)
 282 {
 283   xmlXPathObjectPtr values_node_obj;
 284   xmlNodeSetPtr values_node;
 285   int tmp_size;
 286   char *node_value;
 287
 288   values_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->values[index].path);
 289   if (values_node_obj == NULL)
 290     return (-1); /* Error already logged. */
 291
 292   values_node = values_node_obj->nodesetval;
 293   tmp_size = (values_node) ? values_node->nodeNr : 0;
 294
 295   if (tmp_size == 0)
 296   {
 297     WARNING ("curl_xml plugin: "
 298         "relative xpath expression \"%s\" doesn't match any of the nodes. "
 299         "Skipping...", xpath->values[index].path);
 300     xmlXPathFreeObject (values_node_obj);
 301     return (-1);
 302   }
 303
 304   if (tmp_size > 1)
 305   {
 306     WARNING ("curl_xml plugin: "
 307         "relative xpath expression \"%s\" is expected to return "
 308         "only one node. Skipping...", xpath->values[index].path);
 309     xmlXPathFreeObject (values_node_obj);
 310     return (-1);
 311   }
 312
 313   /* ignoring the element if other than textnode/attribute*/
 314   if (cx_if_not_text_node(values_node->nodeTab[0]))
 315   {
 316     WARNING ("curl_xml plugin: "
 317         "relative xpath expression \"%s\" is expected to return "
 318         "only text/attribute node which is not the case. Skipping...",
 319         xpath->values[index].path);
 320     xmlXPathFreeObject (values_node_obj);
 321     return (-1);
 322   }
 323
 324   node_value = (char *) xmlNodeGetContent(values_node->nodeTab[0]);
 325   switch (ds->ds[index].type)
 326   {
 327     case DS_TYPE_COUNTER:
 328       vl->values[index].counter = (counter_t) strtoull (node_value,
 329           /* endptr = */ NULL, /* base = */ 0);
 330       break;
 331     case DS_TYPE_DERIVE:
 332       vl->values[index].derive = (derive_t) strtoll (node_value,
 333           /* endptr = */ NULL, /* base = */ 0);
 334       break;
 335     case DS_TYPE_ABSOLUTE:
 336       vl->values[index].absolute = (absolute_t) strtoull (node_value,
 337           /* endptr = */ NULL, /* base = */ 0);
 338       break;
 339     case DS_TYPE_GAUGE:
 340       vl->values[index].gauge = (gauge_t) strtod (node_value,
 341           /* endptr = */ NULL);
 342   }
 343
 344   /* free up object */
 345   xmlXPathFreeObject (values_node_obj);
 346   sfree (node_value);
 347
 348   /* We have reached here which means that
 349    * we have got something to work */
 350   return (0);
 351 } /* }}} int cx_handle_single_value_xpath */
 352
 353 static int cx_handle_all_value_xpaths (xmlXPathContextPtr xpath_ctx, /* {{{ */
 354     cx_xpath_t *xpath,
 355     const data_set_t *ds, value_list_t *vl)
 356 {
 357   value_t values[xpath->values_len];
 358   int status;
 359   size_t i;
 360
 361   assert (xpath->values_len > 0);
 362   assert (xpath->values_len == vl->values_len);
 363   assert (xpath->values_len == ds->ds_num);
 364   vl->values = values;
 365
 366   for (i = 0; i < xpath->values_len; i++)
 367   {
 368     status = cx_handle_single_value_xpath (xpath_ctx, xpath, ds, vl, i);
 369     if (status != 0)
 370       return (-1); /* An error has been printed. */
 371   } /* for (i = 0; i < xpath->values_len; i++) */
 372
 373   plugin_dispatch_values (vl);
 374   vl->values = NULL;
 375
 376   return (0);
 377 } /* }}} int cx_handle_all_value_xpaths */
 378
 379 static int cx_handle_instance_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */
 380     cx_xpath_t *xpath, value_list_t *vl,
 381     _Bool is_table)
 382 {
 383   xmlXPathObjectPtr instance_node_obj = NULL;
 384   xmlNodeSetPtr instance_node = NULL;
 385
 386   memset (vl->type_instance, 0, sizeof (vl->type_instance));
 387
 388   /* If the base xpath returns more than one block, the result is assumed to be
 389    * a table. The `Instance' option is not optional in this case. Check for the
 390    * condition and inform the user. */
 391   if (is_table && (xpath->instance == NULL))
 392   {
 393     WARNING ("curl_xml plugin: "
 394         "Base-XPath %s is a table (more than one result was returned), "
 395         "but no instance-XPath has been defined.",
 396         xpath->path);
 397     return (-1);
 398   }
 399
 400   /* instance has to be an xpath expression */
 401   if (xpath->instance != NULL)
 402   {
 403     int tmp_size;
 404
 405     instance_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->instance);
 406     if (instance_node_obj == NULL)
 407       return (-1); /* error is logged already */
 408
 409     instance_node = instance_node_obj->nodesetval;
 410     tmp_size = (instance_node) ? instance_node->nodeNr : 0;
 411
 412     if (tmp_size <= 0)
 413     {
 414       WARNING ("curl_xml plugin: "
 415           "relative xpath expression for 'InstanceFrom' \"%s\" doesn't match "
 416           "any of the nodes. Skipping the node.", xpath->instance);
 417       xmlXPathFreeObject (instance_node_obj);
 418       return (-1);
 419     }
 420
 421     if (tmp_size > 1)
 422     {
 423       WARNING ("curl_xml plugin: "
 424           "relative xpath expression for 'InstanceFrom' \"%s\" is expected "
 425           "to return only one text node. Skipping the node.", xpath->instance);
 426       xmlXPathFreeObject (instance_node_obj);
 427       return (-1);
 428     }
 429
 430     /* ignoring the element if other than textnode/attribute */
 431     if (cx_if_not_text_node(instance_node->nodeTab[0]))
 432     {
 433       WARNING ("curl_xml plugin: "
 434           "relative xpath expression \"%s\" is expected to return only text node "
 435           "which is not the case. Skipping the node.", xpath->instance);
 436       xmlXPathFreeObject (instance_node_obj);
 437       return (-1);
 438     }
 439   } /* if (xpath->instance != NULL) */
 440
 441   if (xpath->instance_prefix != NULL)
 442   {
 443     if (instance_node != NULL)
 444     {
 445       char *node_value = (char *) xmlNodeGetContent(instance_node->nodeTab[0]);
 446       ssnprintf (vl->type_instance, sizeof (vl->type_instance),"%s%s",
 447           xpath->instance_prefix, node_value);
 448       sfree (node_value);
 449     }
 450     else
 451       sstrncpy (vl->type_instance, xpath->instance_prefix,
 452           sizeof (vl->type_instance));
 453   }
 454   else
 455   {
 456     /* If instance_prefix and instance_node are NULL, then
 457      * don't set the type_instance */
 458     if (instance_node != NULL)
 459     {
 460       char *node_value = (char *) xmlNodeGetContent(instance_node->nodeTab[0]);
 461       sstrncpy (vl->type_instance, node_value, sizeof (vl->type_instance));
 462       sfree (node_value);
 463     }
 464   }
 465
 466   /* Free `instance_node_obj' this late, because `instance_node' points to
 467    * somewhere inside this structure. */
 468   xmlXPathFreeObject (instance_node_obj);
 469
 470   return (0);
 471 } /* }}} int cx_handle_instance_xpath */
 472
 473 static int  cx_handle_base_xpath (char const *plugin_instance, /* {{{ */
 474     char const *host,
 475     xmlXPathContextPtr xpath_ctx, const data_set_t *ds,
 476     char *base_xpath, cx_xpath_t *xpath)
 477 {
 478   int total_nodes;
 479   int i;
 480
 481   xmlXPathObjectPtr base_node_obj = NULL;
 482   xmlNodeSetPtr base_nodes = NULL;
 483
 484   value_list_t vl = VALUE_LIST_INIT;
 485
 486   base_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST base_xpath);
 487   if (base_node_obj == NULL)
 488     return -1; /* error is logged already */
 489
 490   base_nodes = base_node_obj->nodesetval;
 491   total_nodes = (base_nodes) ? base_nodes->nodeNr : 0;
 492
 493   if (total_nodes == 0)
 494   {
 495      ERROR ("curl_xml plugin: "
 496               "xpath expression \"%s\" doesn't match any of the nodes. "
 497               "Skipping the xpath block...", base_xpath);
 498      xmlXPathFreeObject (base_node_obj);
 499      return -1;
 500   }
 501
 502   /* If base_xpath returned multiple results, then */
 503   /* Instance in the xpath block is required */
 504   if (total_nodes > 1 && xpath->instance == NULL)
 505   {
 506     ERROR ("curl_xml plugin: "
 507              "InstanceFrom is must in xpath block since the base xpath expression \"%s\" "
 508              "returned multiple results. Skipping the xpath block...", base_xpath);
 509     return -1;
 510   }
 511
 512   /* set the values for the value_list */
 513   vl.values_len = ds->ds_num;
 514   sstrncpy (vl.type, xpath->type, sizeof (vl.type));
 515   sstrncpy (vl.plugin, "curl_xml", sizeof (vl.plugin));
 516   sstrncpy (vl.host, (host != NULL) ? host : hostname_g, sizeof (vl.host));
 517   if (plugin_instance != NULL)
 518     sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
 519
 520   for (i = 0; i < total_nodes; i++)
 521   {
 522     int status;
 523
 524     xpath_ctx->node = base_nodes->nodeTab[i];
 525
 526     status = cx_handle_instance_xpath (xpath_ctx, xpath, &vl,
 527         /* is_table = */ (total_nodes > 1));
 528     if (status != 0)
 529       continue; /* An error has already been reported. */
 530
 531     status = cx_handle_all_value_xpaths (xpath_ctx, xpath, ds, &vl);
 532     if (status != 0)
 533       continue; /* An error has been logged. */
 534   } /* for (i = 0; i < total_nodes; i++) */
 535
 536   /* free up the allocated memory */
 537   xmlXPathFreeObject (base_node_obj);
 538
 539   return (0);
 540 } /* }}} cx_handle_base_xpath */
 541
 542 static int cx_handle_parsed_xml(xmlDocPtr doc, /* {{{ */
 543                        xmlXPathContextPtr xpath_ctx, cx_t *db)
 544 {
 545   llentry_t *le;
 546   const data_set_t *ds;
 547   cx_xpath_t *xpath;
 548   int status=-1;
 549
 550
 551   le = llist_head (db->list);
 552   while (le != NULL)
 553   {
 554     /* get the ds */
 555     xpath = (cx_xpath_t *) le->value;
 556     ds = plugin_get_ds (xpath->type);
 557
 558     if ( (cx_check_type(ds, xpath) == 0) &&
 559          (cx_handle_base_xpath(db->instance, db->host,
 560                                xpath_ctx, ds, le->key, xpath) == 0) )
 561       status = 0; /* we got atleast one success */
 562
 563     le = le->next;
 564   } /* while (le != NULL) */
 565
 566   return status;
 567 } /* }}} cx_handle_parsed_xml */
 568
 569 static int cx_parse_stats_xml(xmlChar* xml, cx_t *db) /* {{{ */
 570 {
 571   int status;
 572   xmlDocPtr doc;
 573   xmlXPathContextPtr xpath_ctx;
 574   size_t i;
 575
 576   /* Load the XML */
 577   doc = xmlParseDoc(xml);
 578   if (doc == NULL)
 579   {
 580     ERROR ("curl_xml plugin: Failed to parse the xml document  - %s", xml);
 581     return (-1);
 582   }
 583
 584   xpath_ctx = xmlXPathNewContext(doc);
 585   if(xpath_ctx == NULL)
 586   {
 587     ERROR ("curl_xml plugin: Failed to create the xml context");
 588     xmlFreeDoc(doc);
 589     return (-1);
 590   }
 591
 592   for (i = 0; i < db->namespaces_num; i++)
 593   {
 594     cx_namespace_t const *ns = db->namespaces + i;
 595     status = xmlXPathRegisterNs (xpath_ctx,
 596         BAD_CAST ns->prefix, BAD_CAST ns->url);
 597     if (status != 0)
 598     {
 599       ERROR ("curl_xml plugin: "
 600           "unable to register NS with prefix=\"%s\" and href=\"%s\"\n",
 601           ns->prefix, ns->url);
 602       xmlXPathFreeContext(xpath_ctx);
 603       xmlFreeDoc (doc);
 604       return (status);
 605     }
 606   }
 607
 608   status = cx_handle_parsed_xml (doc, xpath_ctx, db);
 609   /* Cleanup */
 610   xmlXPathFreeContext(xpath_ctx);
 611   xmlFreeDoc(doc);
 612   return status;
 613 } /* }}} cx_parse_stats_xml */
 614
 615 static int cx_curl_perform (cx_t *db, CURL *curl) /* {{{ */
 616 {
 617   int status;
 618   long rc;
 619   char *ptr;
 620   char *url;
 621   url = db->url;
 622
 623   db->buffer_fill = 0;
 624   status = curl_easy_perform (curl);
 625   if (status != CURLE_OK)
 626   {
 627     ERROR ("curl_xml plugin: curl_easy_perform failed with status %i: %s (%s)",
 628            status, db->curl_errbuf, url);
 629     return (-1);
 630   }
 631
 632   curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &url);
 633   curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &rc);
 634
 635   /* The response code is zero if a non-HTTP transport was used. */
 636   if ((rc != 0) && (rc != 200))
 637   {
 638     ERROR ("curl_xml plugin: curl_easy_perform failed with response code %ld (%s)",
 639            rc, url);
 640     return (-1);
 641   }
 642
 643   ptr = db->buffer;
 644
 645   status = cx_parse_stats_xml(BAD_CAST ptr, db);
 646   db->buffer_fill = 0;
 647
 648   return status;
 649 } /* }}} int cx_curl_perform */
 650
 651 static int cx_read (user_data_t *ud) /* {{{ */
 652 {
 653   cx_t *db;
 654
 655   if ((ud == NULL) || (ud->data == NULL))
 656   {
 657     ERROR ("curl_xml plugin: cx_read: Invalid user data.");
 658     return (-1);
 659   }
 660
 661   db = (cx_t *) ud->data;
 662
 663   return cx_curl_perform (db, db->curl);
 664 } /* }}} int cx_read */
 665
 666 /* Configuration handling functions {{{ */
 667
 668 static int cx_config_add_values (const char *name, cx_xpath_t *xpath, /* {{{ */
 669                                       oconfig_item_t *ci)
 670 {
 671   int i;
 672
 673   if (ci->values_num < 1)
 674   {
 675     WARNING ("curl_xml plugin: `ValuesFrom' needs at least one argument.");
 676     return (-1);
 677   }
 678
 679   for (i = 0; i < ci->values_num; i++)
 680     if (ci->values[i].type != OCONFIG_TYPE_STRING)
 681     {
 682       WARNING ("curl_xml plugin: `ValuesFrom' needs only string argument.");
 683       return (-1);
 684     }
 685
 686   sfree (xpath->values);
 687
 688   xpath->values_len = 0;
 689   xpath->values = malloc (sizeof (cx_values_t) * ci->values_num);
 690   if (xpath->values == NULL)
 691     return (-1);
 692   xpath->values_len = (size_t) ci->values_num;
 693
 694   /* populate cx_values_t structure */
 695   for (i = 0; i < ci->values_num; i++)
 696   {
 697     xpath->values[i].path_len = sizeof (ci->values[i].value.string);
 698     sstrncpy (xpath->values[i].path, ci->values[i].value.string, sizeof (xpath->values[i].path));
 699   }
 700
 701   return (0);
 702 } /* }}} cx_config_add_values */
 703
 704 static int cx_config_add_xpath (cx_t *db, oconfig_item_t *ci) /* {{{ */
 705 {
 706   cx_xpath_t *xpath;
 707   char *name;
 708   llentry_t *le;
 709   int status;
 710   int i;
 711
 712   xpath = calloc (1, sizeof (*xpath));
 713   if (xpath == NULL)
 714   {
 715     ERROR ("curl_xml plugin: calloc failed.");
 716     return (-1);
 717   }
 718
 719   status = cf_util_get_string (ci, &xpath->path);
 720   if (status != 0)
 721   {
 722     cx_xpath_free (xpath);
 723     return (status);
 724   }
 725
 726   /* error out if xpath->path is an empty string */
 727   if (strlen (xpath->path) == 0)
 728   {
 729     ERROR ("curl_xml plugin: invalid xpath. "
 730            "xpath value can't be an empty string");
 731     cx_xpath_free (xpath);
 732     return (-1);
 733   }
 734
 735   status = 0;
 736   for (i = 0; i < ci->children_num; i++)
 737   {
 738     oconfig_item_t *child = ci->children + i;
 739
 740     if (strcasecmp ("Type", child->key) == 0)
 741       status = cf_util_get_string (child, &xpath->type);
 742     else if (strcasecmp ("InstancePrefix", child->key) == 0)
 743       status = cf_util_get_string (child, &xpath->instance_prefix);
 744     else if (strcasecmp ("InstanceFrom", child->key) == 0)
 745       status = cf_util_get_string (child, &xpath->instance);
 746     else if (strcasecmp ("ValuesFrom", child->key) == 0)
 747       status = cx_config_add_values ("ValuesFrom", xpath, child);
 748     else
 749     {
 750       WARNING ("curl_xml plugin: Option `%s' not allowed here.", child->key);
 751       status = -1;
 752     }
 753
 754     if (status != 0)
 755       break;
 756   } /* for (i = 0; i < ci->children_num; i++) */
 757
 758   if (status != 0)
 759   {
 760     cx_xpath_free (xpath);
 761     return status;
 762   }
 763
 764   if (xpath->type == NULL)
 765   {
 766     WARNING ("curl_xml plugin: `Type' missing in `xpath' block.");
 767     cx_xpath_free (xpath);
 768     return -1;
 769   }
 770
 771   if (db->list == NULL)
 772   {
 773     db->list = llist_create();
 774     if (db->list == NULL)
 775     {
 776       ERROR ("curl_xml plugin: list creation failed.");
 777       cx_xpath_free (xpath);
 778       return (-1);
 779     }
 780   }
 781
 782   name = strdup (xpath->path);
 783   if (name == NULL)
 784   {
 785     ERROR ("curl_xml plugin: strdup failed.");
 786     cx_xpath_free (xpath);
 787     return (-1);
 788   }
 789
 790   le = llentry_create (name, xpath);
 791   if (le == NULL)
 792   {
 793     ERROR ("curl_xml plugin: llentry_create failed.");
 794     cx_xpath_free (xpath);
 795     sfree (name);
 796     return (-1);
 797   }
 798
 799   llist_append (db->list, le);
 800   return (0);
 801 } /* }}} int cx_config_add_xpath */
 802
 803 static int cx_config_add_namespace (cx_t *db, /* {{{ */
 804     oconfig_item_t *ci)
 805 {
 806   cx_namespace_t *ns;
 807
 808   if ((ci->values_num != 2)
 809       || (ci->values[0].type != OCONFIG_TYPE_STRING)
 810       || (ci->values[1].type != OCONFIG_TYPE_STRING))
 811   {
 812     WARNING ("curl_xml plugin: The `Namespace' option "
 813              "needs exactly two string arguments.");
 814     return (EINVAL);
 815   }
 816
 817   ns = realloc (db->namespaces, sizeof (*db->namespaces)
 818       * (db->namespaces_num + 1));
 819   if (ns == NULL)
 820   {
 821     ERROR ("curl_xml plugin: realloc failed.");
 822     return (ENOMEM);
 823   }
 824   db->namespaces = ns;
 825   ns = db->namespaces + db->namespaces_num;
 826   memset (ns, 0, sizeof (*ns));
 827
 828   ns->prefix = strdup (ci->values[0].value.string);
 829   ns->url = strdup (ci->values[1].value.string);
 830
 831   if ((ns->prefix == NULL) || (ns->url == NULL))
 832   {
 833     sfree (ns->prefix);
 834     sfree (ns->url);
 835     ERROR ("curl_xml plugin: strdup failed.");
 836     return (ENOMEM);
 837   }
 838
 839   db->namespaces_num++;
 840   return (0);
 841 } /* }}} int cx_config_add_namespace */
 842
 843 /* Initialize db->curl */
 844 static int cx_init_curl (cx_t *db) /* {{{ */
 845 {
 846   db->curl = curl_easy_init ();
 847   if (db->curl == NULL)
 848   {
 849     ERROR ("curl_xml plugin: curl_easy_init failed.");
 850     return (-1);
 851   }
 852
 853   curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1L);
 854   curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cx_curl_callback);
 855   curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db);
 856   curl_easy_setopt (db->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
 857   curl_easy_setopt (db->curl, CURLOPT_ERRORBUFFER, db->curl_errbuf);
 858   curl_easy_setopt (db->curl, CURLOPT_URL, db->url);
 859   curl_easy_setopt (db->curl, CURLOPT_FOLLOWLOCATION, 1L);
 860   curl_easy_setopt (db->curl, CURLOPT_MAXREDIRS, 50L);
 861
 862   if (db->user != NULL)
 863   {
 864 #ifdef HAVE_CURLOPT_USERNAME
 865     curl_easy_setopt (db->curl, CURLOPT_USERNAME, db->user);
 866     curl_easy_setopt (db->curl, CURLOPT_PASSWORD,
 867         (db->pass == NULL) ? "" : db->pass);
 868 #else
 869     size_t credentials_size;
 870
 871     credentials_size = strlen (db->user) + 2;
 872     if (db->pass != NULL)
 873       credentials_size += strlen (db->pass);
 874
 875     db->credentials = malloc (credentials_size);
 876     if (db->credentials == NULL)
 877     {
 878       ERROR ("curl_xml plugin: malloc failed.");
 879       return (-1);
 880     }
 881
 882     ssnprintf (db->credentials, credentials_size, "%s:%s",
 883                db->user, (db->pass == NULL) ? "" : db->pass);
 884     curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials);
 885 #endif
 886
 887     if (db->digest)
 888       curl_easy_setopt (db->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
 889   }
 890
 891   curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, db->verify_peer ? 1L : 0L);
 892   curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST,
 893                     db->verify_host ? 2L : 0L);
 894   if (db->cacert != NULL)
 895     curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert);
 896   if (db->headers != NULL)
 897     curl_easy_setopt (db->curl, CURLOPT_HTTPHEADER, db->headers);
 898   if (db->post_body != NULL)
 899     curl_easy_setopt (db->curl, CURLOPT_POSTFIELDS, db->post_body);
 900
 901 #ifdef HAVE_CURLOPT_TIMEOUT_MS
 902   if (db->timeout >= 0)
 903     curl_easy_setopt (db->curl, CURLOPT_TIMEOUT_MS, (long) db->timeout);
 904   else
 905     curl_easy_setopt (db->curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
 906 #endif
 907
 908   return (0);
 909 } /* }}} int cx_init_curl */
 910
 911 static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */
 912 {
 913   cx_t *db;
 914   int status = 0;
 915   int i;
 916
 917   if ((ci->values_num != 1)
 918       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 919   {
 920     WARNING ("curl_xml plugin: The `URL' block "
 921              "needs exactly one string argument.");
 922     return (-1);
 923   }
 924
 925   db = calloc (1, sizeof (*db));
 926   if (db == NULL)
 927   {
 928     ERROR ("curl_xml plugin: calloc failed.");
 929     return (-1);
 930   }
 931
 932   db->timeout = -1;
 933
 934   if (strcasecmp ("URL", ci->key) == 0)
 935   {
 936     status = cf_util_get_string (ci, &db->url);
 937     if (status != 0)
 938     {
 939       sfree (db);
 940       return (status);
 941     }
 942   }
 943   else
 944   {
 945     ERROR ("curl_xml plugin: cx_config: "
 946            "Invalid key: %s", ci->key);
 947     cx_free (db);
 948     return (-1);
 949   }
 950
 951   /* Fill the `cx_t' structure.. */
 952   for (i = 0; i < ci->children_num; i++)
 953   {
 954     oconfig_item_t *child = ci->children + i;
 955
 956     if (strcasecmp ("Instance", child->key) == 0)
 957       status = cf_util_get_string (child, &db->instance);
 958     else if (strcasecmp ("Host", child->key) == 0)
 959       status = cf_util_get_string (child, &db->host);
 960     else if (strcasecmp ("User", child->key) == 0)
 961       status = cf_util_get_string (child, &db->user);
 962     else if (strcasecmp ("Password", child->key) == 0)
 963       status = cf_util_get_string (child, &db->pass);
 964     else if (strcasecmp ("Digest", child->key) == 0)
 965       status = cf_util_get_boolean (child, &db->digest);
 966     else if (strcasecmp ("VerifyPeer", child->key) == 0)
 967       status = cf_util_get_boolean (child, &db->verify_peer);
 968     else if (strcasecmp ("VerifyHost", child->key) == 0)
 969       status = cf_util_get_boolean (child, &db->verify_host);
 970     else if (strcasecmp ("CACert", child->key) == 0)
 971       status = cf_util_get_string (child, &db->cacert);
 972     else if (strcasecmp ("xpath", child->key) == 0)
 973       status = cx_config_add_xpath (db, child);
 974     else if (strcasecmp ("Header", child->key) == 0)
 975       status = cx_config_append_string ("Header", &db->headers, child);
 976     else if (strcasecmp ("Post", child->key) == 0)
 977       status = cf_util_get_string (child, &db->post_body);
 978     else if (strcasecmp ("Namespace", child->key) == 0)
 979       status = cx_config_add_namespace (db, child);
 980     else if (strcasecmp ("Timeout", child->key) == 0)
 981       status = cf_util_get_int (child, &db->timeout);
 982     else
 983     {
 984       WARNING ("curl_xml plugin: Option `%s' not allowed here.", child->key);
 985       status = -1;
 986     }
 987
 988     if (status != 0)
 989       break;
 990   }
 991
 992   if (status == 0)
 993   {
 994     if (db->list == NULL)
 995     {
 996       WARNING ("curl_xml plugin: No (valid) `Key' block "
 997                "within `URL' block `%s'.", db->url);
 998       status = -1;
 999     }
1000     if (status == 0)
1001       status = cx_init_curl (db);
1002   }
1003
1004   /* If all went well, register this database for reading */
1005   if (status == 0)
1006   {
1007     user_data_t ud;
1008     char *cb_name;
1009
1010     if (db->instance == NULL)
1011       db->instance = strdup("default");
1012
1013     DEBUG ("curl_xml plugin: Registering new read callback: %s",
1014            db->instance);
1015
1016     memset (&ud, 0, sizeof (ud));
1017     ud.data = (void *) db;
1018     ud.free_func = cx_free;
1019
1020     cb_name = ssnprintf_alloc ("curl_xml-%s-%s", db->instance, db->url);
1021     plugin_register_complex_read (/* group = */ "curl_xml", cb_name, cx_read,
1022                                   /* interval = */ 0, &ud);
1023     sfree (cb_name);
1024   }
1025   else
1026   {
1027     cx_free (db);
1028     return (-1);
1029   }
1030
1031   return (0);
1032 } /* }}} int cx_config_add_url */
1033
1034 /* }}} End of configuration handling functions */
1035
1036 static int cx_config (oconfig_item_t *ci) /* {{{ */
1037 {
1038   int success;
1039   int errors;
1040   int status;
1041   int i;
1042
1043   success = 0;
1044   errors = 0;
1045
1046   for (i = 0; i < ci->children_num; i++)
1047   {
1048     oconfig_item_t *child = ci->children + i;
1049
1050     if (strcasecmp ("URL", child->key) == 0)
1051     {
1052       status = cx_config_add_url (child);
1053       if (status == 0)
1054         success++;
1055       else
1056         errors++;
1057     }
1058     else
1059     {
1060       WARNING ("curl_xml plugin: Option `%s' not allowed here.", child->key);
1061       errors++;
1062     }
1063   }
1064
1065   if ((success == 0) && (errors > 0))
1066   {
1067     ERROR ("curl_xml plugin: All statements failed.");
1068     return (-1);
1069   }
1070
1071   return (0);
1072 } /* }}} int cx_config */
1073
1074 static int cx_init (void) /* {{{ */
1075 {
1076   /* Call this while collectd is still single-threaded to avoid
1077    * initialization issues in libgcrypt. */
1078   curl_global_init (CURL_GLOBAL_SSL);
1079   return (0);
1080 } /* }}} int cx_init */
1081
1082 void module_register (void)
1083 {
1084   plugin_register_complex_config ("curl_xml", cx_config);
1085   plugin_register_init ("curl_xml", cx_init);
1086 } /* void module_register */
1087
1088 /* vim: set sw=2 sts=2 et fdm=marker : */