X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcurl_xml.c;h=75f5cc33d946e74cfb3d77f006d4babfaadb6513;hb=56c7b21899e44b57b5031a21ca3652b30f4fc1aa;hp=219c5349d4cd46953340d18ecbc94033b132567d;hpb=1d333244875057dc44f91f0eb28a36a49e239fa7;p=collectd.git diff --git a/src/curl_xml.c b/src/curl_xml.c index 219c5349..75f5cc33 100644 --- a/src/curl_xml.c +++ b/src/curl_xml.c @@ -1,6 +1,6 @@ /** * collectd - src/curl_xml.c - * Copyright (C) 2009 Amit Gupta + * Copyright (C) 2009,2010 Amit Gupta * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the @@ -23,7 +23,7 @@ #include "common.h" #include "plugin.h" #include "configfile.h" -#include "utils_avltree.h" +#include "utils_llist.h" #include #include @@ -32,9 +32,10 @@ #include #define CX_DEFAULT_HOST "localhost" -#define CX_KEY_MAGIC 0x43484b59UL /* CHKY */ -#define CX_IS_KEY(key) (key)->magic == CX_KEY_MAGIC +/* + * Private data structures + */ struct cx_values_s /* {{{ */ { char path[DATA_MAX_NAME_LEN]; @@ -66,8 +67,8 @@ struct cx_s /* {{{ */ char *user; char *pass; char *credentials; - int verify_peer; - int verify_host; + _Bool verify_peer; + _Bool verify_host; char *cacert; CURL *curl; @@ -76,22 +77,13 @@ struct cx_s /* {{{ */ size_t buffer_size; size_t buffer_fill; - c_avl_tree_t *tree; /* tree of xpath blocks */ + llist_t *list; /* list of xpath blocks */ }; typedef struct cx_s cx_t; /* }}} */ -static int cx_read (user_data_t *ud); -static int cx_curl_perform (cx_t *db, CURL *curl); -static int cx_parse_stats_xml (xmlChar *ptr, cx_t *db); -static int cx_submit_statistics(xmlDocPtr doc, xmlXPathContextPtr xpath_ctx, - cx_t *db); -static int cx_submit_xpath_values (char *plugin_instance, xmlXPathContextPtr xpath_ctx, - char *base_xpath, cx_xpath_t *xpath); -static int cx_if_not_text_node (xmlNodePtr node); -static xmlXPathObjectPtr cx_evaluate_xpath (xmlXPathContextPtr xpath_ctx, - xmlChar *expr); -static int cx_check_type (cx_xpath_t *xpath); - +/* + * Private functions + */ static size_t cx_curl_callback (void *buf, /* {{{ */ size_t size, size_t nmemb, void *user_data) { @@ -144,25 +136,26 @@ static void cx_xpath_free (cx_xpath_t *xpath) /* {{{ */ sfree (xpath); } /* }}} void cx_xpath_free */ -static void cx_tree_free (c_avl_tree_t *tree) /* {{{ */ +static void cx_list_free (llist_t *list) /* {{{ */ { - char *name; - void *value; + llentry_t *le; - while (c_avl_pick (tree, (void *) &name, (void *) &value) == 0) + le = llist_head (list); + while (le != NULL) { - cx_xpath_t *key = (cx_xpath_t *)value; + llentry_t *le_next; - if (CX_IS_KEY(key)) - cx_xpath_free (key); - else - cx_tree_free ((c_avl_tree_t *)value); + le_next = le->next; - sfree (name); + sfree (le->key); + cx_xpath_free (le->value); + + le = le_next; } - c_avl_destroy (tree); -} /* }}} void cx_tree_free */ + llist_destroy (list); + list = NULL; +} /* }}} void cx_list_free */ static void cx_free (void *arg) /* {{{ */ { @@ -179,9 +172,8 @@ static void cx_free (void *arg) /* {{{ */ curl_easy_cleanup (db->curl); db->curl = NULL; - if (db->tree != NULL) - cx_tree_free (db->tree); - db->tree = NULL; + if (db->list != NULL) + cx_list_free (db->list); sfree (db->buffer); sfree (db->instance); @@ -196,95 +188,457 @@ static void cx_free (void *arg) /* {{{ */ sfree (db); } /* }}} void cx_free */ -/* Configuration handling functions {{{ */ +static int cx_check_type (const data_set_t *ds, cx_xpath_t *xpath) /* {{{ */ +{ + if (!ds) + { + WARNING ("curl_xml plugin: DataSet `%s' not defined.", xpath->type); + return (-1); + } -static int cx_config_add_values (const char *name, cx_xpath_t *xpath, /* {{{ */ - oconfig_item_t *ci) + if (ds->ds_num != xpath->values_len) + { + WARNING ("curl_xml plugin: DataSet `%s' requires %i values, but config talks about %i", + xpath->type, ds->ds_num, xpath->values_len); + return (-1); + } + + return (0); +} /* }}} cx_check_type */ + +static xmlXPathObjectPtr cx_evaluate_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */ + xmlChar *expr) +{ + xmlXPathObjectPtr xpath_obj; + + /* XXX: When to free this? */ + xpath_obj = xmlXPathEvalExpression(BAD_CAST expr, xpath_ctx); + if (xpath_obj == NULL) + { + WARNING ("curl_xml plugin: " + "Error unable to evaluate xpath expression \"%s\". Skipping...", expr); + return NULL; + } + + return xpath_obj; +} /* }}} cx_evaluate_xpath */ + +static int cx_if_not_text_node (xmlNodePtr node) /* {{{ */ +{ + if (node->type == XML_TEXT_NODE || node->type == XML_ATTRIBUTE_NODE) + return (0); + + WARNING ("curl_xml plugin: " + "Node \"%s\" doesn't seem to be a text node. Skipping...", node->name); + return -1; +} /* }}} cx_if_not_text_node */ + +static int cx_handle_single_value_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */ + cx_xpath_t *xpath, + const data_set_t *ds, value_list_t *vl, int index) +{ + xmlXPathObjectPtr values_node_obj; + xmlNodeSetPtr values_node; + int tmp_size; + char *node_value; + + values_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->values[index].path); + if (values_node_obj == NULL) + return (-1); /* Error already logged. */ + + values_node = values_node_obj->nodesetval; + tmp_size = (values_node) ? values_node->nodeNr : 0; + + if (tmp_size == 0) + { + WARNING ("curl_xml plugin: " + "relative xpath expression \"%s\" doesn't match any of the nodes. " + "Skipping...", xpath->values[index].path); + xmlXPathFreeObject (values_node_obj); + return (-1); + } + + if (tmp_size > 1) + { + WARNING ("curl_xml plugin: " + "relative xpath expression \"%s\" is expected to return " + "only one node. Skipping...", xpath->values[index].path); + xmlXPathFreeObject (values_node_obj); + return (-1); + } + + /* ignoring the element if other than textnode/attribute*/ + if (cx_if_not_text_node(values_node->nodeTab[0])) + { + WARNING ("curl_xml plugin: " + "relative xpath expression \"%s\" is expected to return " + "only text/attribute node which is not the case. Skipping...", + xpath->values[index].path); + xmlXPathFreeObject (values_node_obj); + return (-1); + } + + node_value = (char *) xmlNodeGetContent(values_node->nodeTab[0]); + switch (ds->ds[index].type) + { + case DS_TYPE_COUNTER: + vl->values[index].counter = (counter_t) strtoull (node_value, + /* endptr = */ NULL, /* base = */ 0); + break; + case DS_TYPE_DERIVE: + vl->values[index].derive = (derive_t) strtoll (node_value, + /* endptr = */ NULL, /* base = */ 0); + break; + case DS_TYPE_ABSOLUTE: + vl->values[index].absolute = (absolute_t) strtoull (node_value, + /* endptr = */ NULL, /* base = */ 0); + break; + case DS_TYPE_GAUGE: + vl->values[index].gauge = (gauge_t) strtod (node_value, + /* endptr = */ NULL); + } + + /* free up object */ + xmlXPathFreeObject (values_node_obj); + + /* We have reached here which means that + * we have got something to work */ + return (0); +} /* }}} int cx_handle_single_value_xpath */ + +static int cx_handle_all_value_xpaths (xmlXPathContextPtr xpath_ctx, /* {{{ */ + cx_xpath_t *xpath, + const data_set_t *ds, value_list_t *vl) { + value_t values[xpath->values_len]; + int status; int i; - if (ci->values_num < 1) + assert (xpath->values_len > 0); + assert (xpath->values_len == vl->values_len); + assert (xpath->values_len == ds->ds_num); + vl->values = values; + + for (i = 0; i < xpath->values_len; i++) { - WARNING ("curl_xml plugin: `Values' needs at least one argument."); + status = cx_handle_single_value_xpath (xpath_ctx, xpath, ds, vl, i); + if (status != 0) + return (-1); /* An error has been printed. */ + } /* for (i = 0; i < xpath->values_len; i++) */ + + plugin_dispatch_values (vl); + vl->values = NULL; + + return (0); +} /* }}} int cx_handle_all_value_xpaths */ + +static int cx_handle_instance_xpath (xmlXPathContextPtr xpath_ctx, /* {{{ */ + cx_xpath_t *xpath, value_list_t *vl, + _Bool is_table) +{ + xmlXPathObjectPtr instance_node_obj = NULL; + xmlNodeSetPtr instance_node = NULL; + + memset (vl->type_instance, 0, sizeof (vl->type_instance)); + + /* If the base xpath returns more than one block, the result is assumed to be + * a table. The `Instnce' option is not optional in this case. Check for the + * condition and inform the user. */ + if (is_table && (vl->type_instance == NULL)) + { + WARNING ("curl_xml plugin: " + "Base-XPath %s is a table (more than one result was returned), " + "but no instance-XPath has been defined.", + xpath->path); return (-1); } - for (i = 0; i < ci->values_num; i++) - if (ci->values[i].type != OCONFIG_TYPE_STRING) + /* instance has to be an xpath expression */ + if (xpath->instance != NULL) + { + int tmp_size; + + instance_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->instance); + if (instance_node_obj == NULL) + return (-1); /* error is logged already */ + + instance_node = instance_node_obj->nodesetval; + tmp_size = (instance_node) ? instance_node->nodeNr : 0; + + if (tmp_size <= 0) { - WARNING ("curl_xml plugin: `Values' needs only string argument."); + WARNING ("curl_xml plugin: " + "relative xpath expression for 'InstanceFrom' \"%s\" doesn't match " + "any of the nodes. Skipping the node.", xpath->instance); + xmlXPathFreeObject (instance_node_obj); return (-1); } - sfree (xpath->values); + if (tmp_size > 1) + { + WARNING ("curl_xml plugin: " + "relative xpath expression for 'InstanceFrom' \"%s\" is expected " + "to return only one text node. Skipping the node.", xpath->instance); + xmlXPathFreeObject (instance_node_obj); + return (-1); + } - xpath->values_len = 0; - xpath->values = (cx_values_t *) malloc (sizeof (cx_values_t) * ci->values_num); - if (xpath->values == NULL) - return (-1); - xpath->values_len = ci->values_num; + /* ignoring the element if other than textnode/attribute */ + if (cx_if_not_text_node(instance_node->nodeTab[0])) + { + WARNING ("curl_xml plugin: " + "relative xpath expression \"%s\" is expected to return only text node " + "which is not the case. Skipping the node.", xpath->instance); + xmlXPathFreeObject (instance_node_obj); + return (-1); + } + } /* if (xpath->instance != NULL) */ - /* populate cx_values_t structure */ - for (i = 0; i < ci->values_num; i++) + if (xpath->instance_prefix != NULL) { - xpath->values[i].path_len = sizeof (ci->values[i].value.string); - sstrncpy (xpath->values[i].path, ci->values[i].value.string, sizeof (xpath->values[i].path)); + if (instance_node != NULL) + ssnprintf (vl->type_instance, sizeof (vl->type_instance),"%s%s", + xpath->instance_prefix, (char *) xmlNodeGetContent(instance_node->nodeTab[0])); + else + sstrncpy (vl->type_instance, xpath->instance_prefix, + sizeof (vl->type_instance)); + } + else + { + /* If instance_prefix and instance_node are NULL, then + * don't set the type_instance */ + if (instance_node != NULL) + sstrncpy (vl->type_instance, (char *) xmlNodeGetContent(instance_node->nodeTab[0]), + sizeof (vl->type_instance)); } + /* Free `instance_node_obj' this late, because `instance_node' points to + * somewhere inside this structure. */ + xmlXPathFreeObject (instance_node_obj); + + return (0); +} /* }}} int cx_handle_instance_xpath */ + +static int cx_handle_base_xpath (char const *plugin_instance, /* {{{ */ + char const *host, + xmlXPathContextPtr xpath_ctx, const data_set_t *ds, + char *base_xpath, cx_xpath_t *xpath) +{ + int total_nodes; + int i; + + xmlXPathObjectPtr base_node_obj = NULL; + xmlNodeSetPtr base_nodes = NULL; + + value_list_t vl = VALUE_LIST_INIT; + + base_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST base_xpath); + if (base_node_obj == NULL) + return -1; /* error is logged already */ + + base_nodes = base_node_obj->nodesetval; + total_nodes = (base_nodes) ? base_nodes->nodeNr : 0; + + if (total_nodes == 0) + { + ERROR ("curl_xml plugin: " + "xpath expression \"%s\" doesn't match any of the nodes. " + "Skipping the xpath block...", base_xpath); + xmlXPathFreeObject (base_node_obj); + return -1; + } + + /* If base_xpath returned multiple results, then */ + /* Instance in the xpath block is required */ + if (total_nodes > 1 && xpath->instance == NULL) + { + ERROR ("curl_xml plugin: " + "InstanceFrom is must in xpath block since the base xpath expression \"%s\" " + "returned multiple results. Skipping the xpath block...", base_xpath); + return -1; + } + + /* set the values for the value_list */ + vl.values_len = ds->ds_num; + sstrncpy (vl.type, xpath->type, sizeof (vl.type)); + sstrncpy (vl.plugin, "curl_xml", sizeof (vl.plugin)); + sstrncpy (vl.host, (host != NULL) ? host : hostname_g, sizeof (vl.host)); + if (plugin_instance != NULL) + sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance)); + + for (i = 0; i < total_nodes; i++) + { + int status; + + xpath_ctx->node = base_nodes->nodeTab[i]; + + status = cx_handle_instance_xpath (xpath_ctx, xpath, &vl, + /* is_table = */ (total_nodes > 1)); + if (status != 0) + continue; /* An error has already been reported. */ + + status = cx_handle_all_value_xpaths (xpath_ctx, xpath, ds, &vl); + if (status != 0) + continue; /* An error has been logged. */ + } /* for (i = 0; i < total_nodes; i++) */ + + /* free up the allocated memory */ + xmlXPathFreeObject (base_node_obj); + return (0); -} /* }}} cx_config_add_values */ +} /* }}} cx_handle_base_xpath */ -static int cx_config_add_string (const char *name, char **dest, /* {{{ */ - oconfig_item_t *ci) +static int cx_handle_parsed_xml(xmlDocPtr doc, /* {{{ */ + xmlXPathContextPtr xpath_ctx, cx_t *db) { - if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)) + llentry_t *le; + const data_set_t *ds; + cx_xpath_t *xpath; + int status=-1; + + + le = llist_head (db->list); + while (le != NULL) { - WARNING ("curl_xml plugin: `%s' needs exactly one string argument.", name); + /* get the ds */ + xpath = (cx_xpath_t *) le->value; + ds = plugin_get_ds (xpath->type); + + if ( (cx_check_type(ds, xpath) == 0) && + (cx_handle_base_xpath(db->instance, db->host, + xpath_ctx, ds, le->key, xpath) == 0) ) + status = 0; /* we got atleast one success */ + + le = le->next; + } /* while (le != NULL) */ + + return status; +} /* }}} cx_handle_parsed_xml */ + +static int cx_parse_stats_xml(xmlChar* xml, cx_t *db) /* {{{ */ +{ + int status; + xmlDocPtr doc; + xmlXPathContextPtr xpath_ctx; + + /* Load the XML */ + doc = xmlParseDoc(xml); + if (doc == NULL) + { + ERROR ("curl_xml plugin: Failed to parse the xml document - %s", xml); return (-1); } - sfree (*dest); - *dest = strdup (ci->values[0].value.string); - if (*dest == NULL) + xpath_ctx = xmlXPathNewContext(doc); + if(xpath_ctx == NULL) + { + ERROR ("curl_xml plugin: Failed to create the xml context"); + xmlFreeDoc(doc); return (-1); + } - return (0); -} /* }}} int cx_config_add_string */ + status = cx_handle_parsed_xml (doc, xpath_ctx, db); + /* Cleanup */ + xmlXPathFreeContext(xpath_ctx); + xmlFreeDoc(doc); + return status; +} /* }}} cx_parse_stats_xml */ -static int cx_config_set_boolean (const char *name, int *dest, /* {{{ */ - oconfig_item_t *ci) +static int cx_curl_perform (cx_t *db, CURL *curl) /* {{{ */ { - if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN)) + int status; + long rc; + char *ptr; + char *url; + + db->buffer_fill = 0; + status = curl_easy_perform (curl); + if (status != CURLE_OK) { - WARNING ("curl_xml plugin: `%s' needs exactly one boolean argument.", name); + ERROR ("curl_xml plugin: curl_easy_perform failed with status %i: %s (%s)", + status, db->curl_errbuf, url); return (-1); } - *dest = ci->values[0].value.boolean ? 1 : 0; + curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &url); + curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &rc); - return (0); -} /* }}} int cx_config_set_boolean */ + /* The response code is zero if a non-HTTP transport was used. */ + if ((rc != 0) && (rc != 200)) + { + ERROR ("curl_xml plugin: curl_easy_perform failed with response code %ld (%s)", + rc, url); + return (-1); + } -static c_avl_tree_t *cx_avl_create(void) /* {{{ */ + ptr = db->buffer; + + status = cx_parse_stats_xml(BAD_CAST ptr, db); + db->buffer_fill = 0; + + return status; +} /* }}} int cx_curl_perform */ + +static int cx_read (user_data_t *ud) /* {{{ */ { - return c_avl_create ((int (*) (const void *, const void *)) strcmp); -} /* }}} cx_avl_create */ + cx_t *db; -static int cx_config_add_xpath (cx_t *db, /* {{{ */ - oconfig_item_t *ci) + if ((ud == NULL) || (ud->data == NULL)) + { + ERROR ("curl_xml plugin: cx_read: Invalid user data."); + return (-1); + } + + db = (cx_t *) ud->data; + + return cx_curl_perform (db, db->curl); +} /* }}} int cx_read */ + +/* Configuration handling functions {{{ */ + +static int cx_config_add_values (const char *name, cx_xpath_t *xpath, /* {{{ */ + oconfig_item_t *ci) { - cx_xpath_t *xpath; - int status; int i; - if ((ci->values_num != 1) - || (ci->values[0].type != OCONFIG_TYPE_STRING)) + if (ci->values_num < 1) { - WARNING ("curl_xml plugin: The `xpath' block " - "needs exactly one string argument."); + WARNING ("curl_xml plugin: `ValuesFrom' needs at least one argument."); return (-1); } + for (i = 0; i < ci->values_num; i++) + if (ci->values[i].type != OCONFIG_TYPE_STRING) + { + WARNING ("curl_xml plugin: `ValuesFrom' needs only string argument."); + return (-1); + } + + sfree (xpath->values); + + xpath->values_len = 0; + xpath->values = (cx_values_t *) malloc (sizeof (cx_values_t) * ci->values_num); + if (xpath->values == NULL) + return (-1); + xpath->values_len = ci->values_num; + + /* populate cx_values_t structure */ + for (i = 0; i < ci->values_num; i++) + { + xpath->values[i].path_len = sizeof (ci->values[i].value.string); + sstrncpy (xpath->values[i].path, ci->values[i].value.string, sizeof (xpath->values[i].path)); + } + + return (0); +} /* }}} cx_config_add_values */ + +static int cx_config_add_xpath (cx_t *db, /* {{{ */ + oconfig_item_t *ci) +{ + cx_xpath_t *xpath; + int status; + int i; + xpath = (cx_xpath_t *) malloc (sizeof (*xpath)); if (xpath == NULL) { @@ -292,21 +646,19 @@ static int cx_config_add_xpath (cx_t *db, /* {{{ */ return (-1); } memset (xpath, 0, sizeof (*xpath)); - xpath->magic = CX_KEY_MAGIC; - if (strcasecmp ("xpath", ci->key) == 0) + status = cf_util_get_string (ci, &xpath->path); + if (status != 0) { - status = cx_config_add_string ("xpath", &xpath->path, ci); - if (status != 0) - { - sfree (xpath); - return (status); - } + sfree (xpath); + return (status); } - else + + /* error out if xpath->path is an empty string */ + if (*xpath->path == 0) { - ERROR ("curl_xml plugin: cx_config: " - "Invalid key: %s", ci->key); + ERROR ("curl_xml plugin: invalid xpath. " + "xpath value can't be an empty string"); return (-1); } @@ -316,13 +668,13 @@ static int cx_config_add_xpath (cx_t *db, /* {{{ */ oconfig_item_t *child = ci->children + i; if (strcasecmp ("Type", child->key) == 0) - status = cx_config_add_string ("Type", &xpath->type, child); + status = cf_util_get_string (child, &xpath->type); else if (strcasecmp ("InstancePrefix", child->key) == 0) - status = cx_config_add_string ("InstancePrefix", &xpath->instance_prefix, child); - else if (strcasecmp ("Instance", child->key) == 0) - status = cx_config_add_string ("Instance", &xpath->instance, child); - else if (strcasecmp ("Values", child->key) == 0) - status = cx_config_add_values ("Values", xpath, child); + status = cf_util_get_string (child, &xpath->instance_prefix); + else if (strcasecmp ("InstanceFrom", child->key) == 0) + status = cf_util_get_string (child, &xpath->instance); + else if (strcasecmp ("ValuesFrom", child->key) == 0) + status = cx_config_add_values ("ValuesFrom", xpath, child); else { WARNING ("curl_xml plugin: Option `%s' not allowed here.", child->key); @@ -333,40 +685,48 @@ static int cx_config_add_xpath (cx_t *db, /* {{{ */ break; } /* for (i = 0; i < ci->children_num; i++) */ - while (status == 0) + if (status == 0 && xpath->type == NULL) { - if (xpath->type == NULL) - { - WARNING ("curl_xml plugin: `Type' missing in `xpath' block."); - status = -1; - } - - break; - } /* while (status == 0) */ + WARNING ("curl_xml plugin: `Type' missing in `xpath' block."); + status = -1; + } if (status == 0) { char *name; - c_avl_tree_t *tree; + llentry_t *le; - if (db->tree == NULL) - db->tree = cx_avl_create(); + if (db->list == NULL) + { + db->list = llist_create(); + if (db->list == NULL) + { + ERROR ("curl_xml plugin: list creation failed."); + return (-1); + } + } - tree = db->tree; - name = xpath->path; + name = strdup(xpath->path); + if (name == NULL) + { + ERROR ("curl_xml plugin: strdup failed."); + return (-1); + } - if (*name) - c_avl_insert (tree, strdup(name), xpath); - else + le = llentry_create (name, xpath); + if (le == NULL) { - ERROR ("curl_xml plugin: invalid key: %s", xpath->path); - status = -1; + ERROR ("curl_xml plugin: llentry_create failed."); + return (-1); } + + llist_append (db->list, le); } return (status); } /* }}} int cx_config_add_xpath */ +/* Initialize db->curl */ static int cx_init_curl (cx_t *db) /* {{{ */ { db->curl = curl_easy_init (); @@ -376,6 +736,7 @@ static int cx_init_curl (cx_t *db) /* {{{ */ return (-1); } + curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1L); curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cx_curl_callback); curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db); curl_easy_setopt (db->curl, CURLOPT_USERAGENT, @@ -403,9 +764,9 @@ static int cx_init_curl (cx_t *db) /* {{{ */ curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials); } - curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, db->verify_peer); + curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, db->verify_peer ? 1L : 0L); curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST, - db->verify_host ? 2 : 0); + db->verify_host ? 2L : 0L); if (db->cacert != NULL) curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert); @@ -436,7 +797,7 @@ static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */ if (strcasecmp ("URL", ci->key) == 0) { - status = cx_config_add_string ("URL", &db->url, ci); + status = cf_util_get_string (ci, &db->url); if (status != 0) { sfree (db); @@ -456,19 +817,19 @@ static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */ oconfig_item_t *child = ci->children + i; if (strcasecmp ("Instance", child->key) == 0) - status = cx_config_add_string ("Instance", &db->instance, child); + status = cf_util_get_string (child, &db->instance); else if (strcasecmp ("Host", child->key) == 0) - status = cx_config_add_string ("Host", &db->host, child); + status = cf_util_get_string (child, &db->host); else if (strcasecmp ("User", child->key) == 0) - status = cx_config_add_string ("User", &db->user, child); + status = cf_util_get_string (child, &db->user); else if (strcasecmp ("Password", child->key) == 0) - status = cx_config_add_string ("Password", &db->pass, child); + status = cf_util_get_string (child, &db->pass); else if (strcasecmp ("VerifyPeer", child->key) == 0) - status = cx_config_set_boolean ("VerifyPeer", &db->verify_peer, child); + status = cf_util_get_boolean (child, &db->verify_peer); else if (strcasecmp ("VerifyHost", child->key) == 0) - status = cx_config_set_boolean ("VerifyHost", &db->verify_host, child); + status = cf_util_get_boolean (child, &db->verify_host); else if (strcasecmp ("CACert", child->key) == 0) - status = cx_config_add_string ("CACert", &db->cacert, child); + status = cf_util_get_string (child, &db->cacert); else if (strcasecmp ("xpath", child->key) == 0) status = cx_config_add_xpath (db, child); else @@ -483,7 +844,7 @@ static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */ if (status == 0) { - if (db->tree == NULL) + if (db->list == NULL) { WARNING ("curl_xml plugin: No (valid) `Key' block " "within `URL' block `%s'.", db->url); @@ -512,7 +873,7 @@ static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */ ssnprintf (cb_name, sizeof (cb_name), "curl_xml-%s-%s", db->instance, db->url); - plugin_register_complex_read (cb_name, cx_read, + plugin_register_complex_read (/* group = */ NULL, cb_name, cx_read, /* interval = */ NULL, &ud); } else @@ -524,6 +885,8 @@ static int cx_config_add_url (oconfig_item_t *ci) /* {{{ */ return (0); } /* }}} int cx_config_add_url */ +/* }}} End of configuration handling functions */ + static int cx_config (oconfig_item_t *ci) /* {{{ */ { int success; @@ -562,360 +925,6 @@ static int cx_config (oconfig_item_t *ci) /* {{{ */ return (0); } /* }}} int cx_config */ -/* }}} End of configuration handling functions */ - -static int cx_read (user_data_t *ud) /* {{{ */ -{ - cx_t *db; - - if ((ud == NULL) || (ud->data == NULL)) - { - ERROR ("curl_xml plugin: cx_read: Invalid user data."); - return (-1); - } - - db = (cx_t *) ud->data; - - return cx_curl_perform (db, db->curl); -} /* }}} int cx_read */ - -static int cx_curl_perform (cx_t *db, CURL *curl) /* {{{ */ -{ - int status; - long rc; - char *ptr; - char *url; - - db->buffer_fill = 0; - status = curl_easy_perform (curl); - - curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &url); - curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &rc); - - if (rc != 200) - { - ERROR ("curl_xml plugin: curl_easy_perform failed with response code %ld (%s)", - rc, url); - return (-1); - } - - if (status != 0) - { - ERROR ("curl_xml plugin: curl_easy_perform failed with status %i: %s (%s)", - status, db->curl_errbuf, url); - return (-1); - } - - ptr = db->buffer; - - status = cx_parse_stats_xml(BAD_CAST ptr, db); - db->buffer_fill = 0; - - return status; -} /* }}} int cx_curl_perform */ - -static int cx_parse_stats_xml(xmlChar* xml, cx_t *db) /* {{{ */ -{ - int status; - xmlDocPtr doc; - xmlXPathContextPtr xpath_ctx; - - /* Load the XML */ - doc = xmlParseDoc(xml); - if (doc == NULL) - { - ERROR ("curl_xml plugin: Failed to parse the xml document - %s", xml); - return (-1); - } - - xpath_ctx = xmlXPathNewContext(doc); - if(xpath_ctx == NULL) - { - ERROR ("curl_xml plugin: Failed to create the xml context"); - xmlFreeDoc(doc); - return (-1); - } - - status = cx_submit_statistics (doc, xpath_ctx, db); - /* Cleanup */ - xmlXPathFreeContext(xpath_ctx); - xmlFreeDoc(doc); - return status; -} /* }}} cx_parse_stats_xml */ - -static int cx_submit_statistics(xmlDocPtr doc, /* {{{ */ - xmlXPathContextPtr xpath_ctx, cx_t *db) -{ - c_avl_iterator_t *iter; - char *key; - cx_xpath_t *value; - int status=-1; - - iter = c_avl_get_iterator (db->tree); - while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0) - { - if (cx_check_type(value) == -1) - continue; - - if (cx_submit_xpath_values(db->instance, xpath_ctx, key, value) == 0) - status = 0; /* we got atleast one success */ - } /* while (c_avl_iterator_next) */ - - return status; -} /* }}} cx_submit_statistics */ - -static int cx_check_type (cx_xpath_t *xpath) /* {{{ */ -{ - const data_set_t *ds; - - ds = plugin_get_ds (xpath->type); - if (!ds) - { - WARNING ("curl_xml plugin: DataSet `%s' not defined.", xpath->type); - return (-1); - } - - if (ds->ds_num != xpath->values_len) - { - WARNING ("curl_xml plugin: DataSet `%s' requires %i values, but config talks about %i", - xpath->type, ds->ds_num, xpath->values_len); - return (-1); - } - - return (0); -} /* }}} cx_check_type */ - -static xmlXPathObjectPtr /* {{{ */ - cx_evaluate_xpath (xmlXPathContextPtr xpath_ctx, xmlChar *expr) -{ - xmlXPathObjectPtr xpath_obj; - - // XXX: When to free this? - xpath_obj = xmlXPathEvalExpression(BAD_CAST expr, xpath_ctx); - if (xpath_obj == NULL) - { - WARNING ("curl_xml plugin: " - "Error unable to evaluate xpath expression \"%s\". Skipping...", expr); - return NULL; - } - - return xpath_obj; -} /* }}} cx_evaluate_xpath */ - -static int cx_if_not_text_node (xmlNodePtr node) /* {{{ */ -{ - if (node->type == XML_TEXT_NODE || node->type == XML_ATTRIBUTE_NODE) - return (0); - - WARNING ("curl_xml plugin: " - "Node \"%s\" doesn't seem to be a text node. Skipping...", node->name); - return -1; -} /* }}} cx_if_not_text_node */ - -static int /* {{{ */ -cx_submit_xpath_values (char *plugin_instance, - xmlXPathContextPtr xpath_ctx, - char *base_xpath, cx_xpath_t *xpath) -{ - int i; - int j; - int total_nodes; - int tmp_size; - int status=-1; - char *node_value; - - xmlXPathObjectPtr base_node_obj = NULL; - xmlXPathObjectPtr instance_node_obj = NULL; - xmlXPathObjectPtr values_node_obj = NULL; - xmlNodeSetPtr base_nodes = NULL; - xmlNodeSetPtr instance_node = NULL; - xmlNodeSetPtr values_node = NULL; - - value_list_t vl = VALUE_LIST_INIT; - const data_set_t *ds; - - base_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST base_xpath); - if (base_node_obj == NULL) - return -1; /* error is logged already */ - - base_nodes = base_node_obj->nodesetval; - total_nodes = (base_nodes) ? base_nodes->nodeNr : 0; - - if (total_nodes == 0) - { - ERROR ("curl_xml plugin: " - "xpath expression \"%s\" doesn't match any of the node. Skipping...", base_xpath); - xmlXPathFreeObject (base_node_obj); - return -1; - } - - /* If base_xpath returned multiple results, then */ - /* Instance in the xpath block is required */ - if (total_nodes > 1 && xpath->instance == NULL) - { - ERROR ("curl_xml plugin: " - "Instance is must in xpath block since the base xpath expression \"%s\" " - "returned multiple results. Skipping the xpath block...", base_xpath); - return -1; - } - - /* set the values for the value_list */ - ds = plugin_get_ds (xpath->type); - vl.values_len = ds->ds_num; - sstrncpy (vl.type, xpath->type, sizeof (vl.type)); - sstrncpy (vl.plugin, "curl_xml", sizeof (vl.plugin)); - sstrncpy (vl.host, hostname_g, sizeof (vl.host)); - if (plugin_instance != NULL) - sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance)); - - for (i = 0; i < total_nodes; i++) - { - xpath_ctx->node = base_nodes->nodeTab[i]; - - /* instance has to be an xpath expression */ - if (xpath->instance != NULL) - { - instance_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->instance); - if (instance_node_obj == NULL) - continue; /* error is logged already */ - - instance_node = instance_node_obj->nodesetval; - tmp_size = (instance_node) ? instance_node->nodeNr : 0; - - if ( (tmp_size == 0) && (total_nodes > 1) ) - { - WARNING ("curl_xml plugin: " - "relative xpath expression for 'Instance' \"%s\" doesn't match " - "any of the nodes. Skipping the node - %s", - xpath->instance, base_nodes->nodeTab[i]->name); - xmlXPathFreeObject (instance_node_obj); - continue; - } - - if (tmp_size > 1) - { - WARNING ("curl_xml plugin: " - "relative xpath expression for 'Instance' \"%s\" is expected " - "to return only one text node. Skipping the node - %s", - xpath->instance, base_nodes->nodeTab[i]->name); - xmlXPathFreeObject (instance_node_obj); - continue; - } - - // ignoring the element if other than textnode/attribute - if (cx_if_not_text_node(instance_node->nodeTab[0])) - { - WARNING ("curl_xml plugin: " - "relative xpath expression \"%s\" is expected to return only text node " - "which is not the case. Skipping the node - %s", - xpath->instance, base_nodes->nodeTab[i]->name); - xmlXPathFreeObject (instance_node_obj); - continue; - } - } - - for (j = 0; j < xpath->values_len; j++) - { - values_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->values[j].path); - values_node = values_node_obj->nodesetval; - tmp_size = (values_node) ? values_node->nodeNr : 0; - - if (tmp_size == 0) - { - WARNING ("curl_xml plugin: " - "relative xpath expression \"%s\" doesn't match any of the nodes. " - "Skipping...", xpath->values[j].path); - xmlXPathFreeObject (values_node_obj); - continue; - } - - if (tmp_size > 1) - { - WARNING ("curl_xml plugin: " - "relative xpath expression \"%s\" is expected to return " - "only one node. Skipping...", xpath->values[j].path); - xmlXPathFreeObject (values_node_obj); - continue; - } - - /* ignoring the element if other than textnode/attribute*/ - if (cx_if_not_text_node(values_node->nodeTab[0])) - { - WARNING ("curl_xml plugin: " - "relative xpath expression \"%s\" is expected to return " - "only text/attribute node which is not the case. Skipping...", - xpath->values[j].path); - xmlXPathFreeObject (values_node_obj); - continue; - } - - vl.values = (value_t *) malloc (sizeof (value_t) * vl.values_len); - if (vl.values == NULL) - { - ERROR ("curl_xml plugin: malloc failed."); - xmlXPathFreeObject (base_node_obj); - xmlXPathFreeObject (instance_node_obj); - xmlXPathFreeObject (values_node_obj); - return (-1); - } - - node_value = (char *) xmlNodeGetContent(values_node->nodeTab[0]); - switch (ds->ds[j].type) - { - case DS_TYPE_COUNTER: - vl.values[j].counter = atoi(node_value); - break; - case DS_TYPE_DERIVE: - vl.values[j].derive = atoi(node_value); - break; - case DS_TYPE_ABSOLUTE: - vl.values[j].absolute = atoi(node_value); - break; - case DS_TYPE_GAUGE: - vl.values[j].absolute = atoi(node_value); - } - - if (xpath->instance_prefix != NULL) - { - if (instance_node != NULL) - ssnprintf (vl.type_instance, sizeof (vl.type_instance),"%s-%s", - xpath->instance_prefix, (char *) xmlNodeGetContent(instance_node->nodeTab[0])); - else - sstrncpy (vl.type_instance, xpath->instance_prefix, - sizeof (vl.type_instance)); - } - else - { - /* If instance_prefix and instance_node are NULL , then */ - /* don't set the type_instance */ - if (instance_node != NULL) - sstrncpy (vl.type_instance, (char *) xmlNodeGetContent(instance_node->nodeTab[0]), - sizeof (vl.type_instance)); - } - - /* free up object */ - xmlXPathFreeObject (values_node_obj); - - /* We have reached here which means that */ - /* we have got something to work */ - status = 0; - } - - /* submit the values */ - if (vl.values) - plugin_dispatch_values (&vl); - - sfree(vl.values); - if (instance_node_obj != NULL) - xmlXPathFreeObject (instance_node_obj); - } - - /* free up the allocated memory */ - xmlXPathFreeObject (base_node_obj); - - return status; -} /* }}} cx_submit_xpath_values */ - void module_register (void) { plugin_register_complex_config ("curl_xml", cx_config);