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