#include "common.h"
#include "plugin.h"
#include "configfile.h"
-#include "utils_avltree.h"
+#include "utils_llist.h"
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <curl/curl.h>
#define CX_DEFAULT_HOST "localhost"
-#define CX_KEY_MAGIC 0x43484b59UL /* CHKY */
-#define CX_IS_KEY(key) (key)->magic == CX_KEY_MAGIC
/*
* Private data structures
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; /* }}} */
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 (le->key);
+ cx_xpath_free (le->value);
- sfree (name);
+ 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) /* {{{ */
{
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);
sfree (db);
} /* }}} void cx_free */
-static int cx_check_type (cx_xpath_t *xpath) /* {{{ */
+static int cx_check_type (const data_set_t *ds, 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;
} /* }}} cx_if_not_text_node */
-static int cx_submit_xpath_values (char *plugin_instance, /* {{{ */
- xmlXPathContextPtr xpath_ctx,
- char *base_xpath, cx_xpath_t *xpath)
+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)
{
- int i;
- int j;
- int total_nodes;
+ xmlXPathObjectPtr values_node_obj;
+ xmlNodeSetPtr values_node;
int tmp_size;
- int status=-1;
char *node_value;
- xmlXPathObjectPtr base_node_obj = NULL;
+ 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;
+
+ 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++)
+ {
+ 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 base_nodes = NULL;
xmlNodeSetPtr instance_node = NULL;
- xmlNodeSetPtr values_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);
+ }
+
+ /* 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) && (is_table) )
+ {
+ 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);
+ }
+
+ 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);
+ }
+
+ /* 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) */
+
+ 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 `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 *plugin_instance, /* {{{ */
+ 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;
- const data_set_t *ds;
base_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST base_xpath);
if (base_node_obj == NULL)
if (total_nodes == 0)
{
ERROR ("curl_xml plugin: "
- "xpath expression \"%s\" doesn't match any of the node. Skipping...", base_xpath);
+ "xpath expression \"%s\" doesn't match any of the nodes. "
+ "Skipping the xpath block...", base_xpath);
xmlXPathFreeObject (base_node_obj);
return -1;
}
if (total_nodes > 1 && xpath->instance == NULL)
{
ERROR ("curl_xml plugin: "
- "Instance is must in xpath block since the base xpath expression \"%s\" "
+ "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 */
- 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));
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;
- }
- } /* if (xpath->instance != NULL) */
-
- for (j = 0; j < xpath->values_len; j++)
- {
- xmlXPathObjectPtr values_node_obj;
-
- values_node_obj = cx_evaluate_xpath (xpath_ctx, BAD_CAST xpath->values[j].path);
- if (values_node_obj == NULL)
- continue; /* 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[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));
- else
- vl.type_instance[0] = 0;
- }
-
- /* free up object */
- xmlXPathFreeObject (values_node_obj);
-
- /* We have reached here which means that
- * we have got something to work */
- status = 0;
- } /* for (j = 0; j < xpath->values_len; j++) */
-
- /* submit the values */
- if (vl.values)
- plugin_dispatch_values (&vl);
-
- sfree(vl.values);
- if (instance_node_obj != NULL)
- xmlXPathFreeObject (instance_node_obj);
- }
+ 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 status;
-} /* }}} cx_submit_xpath_values */
+ return (0);
+} /* }}} cx_handle_base_xpath */
-static int cx_submit_statistics(xmlDocPtr doc, /* {{{ */
+static int cx_handle_parsed_xml(xmlDocPtr doc, /* {{{ */
xmlXPathContextPtr xpath_ctx, cx_t *db)
{
- c_avl_iterator_t *iter;
- char *key;
- cx_xpath_t *value;
+ llentry_t *le;
+ const data_set_t *ds;
+ cx_xpath_t *xpath;
int status=-1;
- iter = c_avl_get_iterator (db->tree);
- while (c_avl_iterator_next (iter, (void *) &key, (void *) &value) == 0)
+
+ le = llist_head (db->list);
+ while (le != NULL)
{
- if (cx_check_type(value) == -1)
- continue;
+ /* get the ds */
+ xpath = (cx_xpath_t *) le->value;
+ ds = plugin_get_ds (xpath->type);
- if (cx_submit_xpath_values(db->instance, xpath_ctx, key, value) == 0)
+ if ( (cx_check_type(ds, xpath) == 0) &&
+ (cx_handle_base_xpath(db->instance, xpath_ctx, ds, le->key, xpath) == 0) )
status = 0; /* we got atleast one success */
- } /* while (c_avl_iterator_next) */
+
+ le = le->next;
+ } /* while (le != NULL) */
return status;
-} /* }}} cx_submit_statistics */
+} /* }}} cx_handle_parsed_xml */
static int cx_parse_stats_xml(xmlChar* xml, cx_t *db) /* {{{ */
{
return (-1);
}
- status = cx_submit_statistics (doc, xpath_ctx, db);
+ status = cx_handle_parsed_xml (doc, xpath_ctx, db);
/* Cleanup */
xmlXPathFreeContext(xpath_ctx);
xmlFreeDoc(doc);
if (ci->values_num < 1)
{
- WARNING ("curl_xml plugin: `Values' needs at least one 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: `Values' needs only string argument.");
+ WARNING ("curl_xml plugin: `ValuesFrom' needs only string argument.");
return (-1);
}
return (0);
} /* }}} cx_config_add_values */
-static c_avl_tree_t *cx_avl_create(void) /* {{{ */
-{
- return c_avl_create ((int (*) (const void *, const void *)) strcmp);
-} /* }}} cx_avl_create */
-
static int cx_config_add_xpath (cx_t *db, /* {{{ */
oconfig_item_t *ci)
{
int status;
int i;
- if ((ci->values_num != 1)
- || (ci->values[0].type != OCONFIG_TYPE_STRING))
- {
- WARNING ("curl_xml plugin: The `xpath' block "
- "needs exactly one string argument.");
- return (-1);
- }
-
xpath = (cx_xpath_t *) malloc (sizeof (*xpath));
if (xpath == NULL)
{
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 = cf_util_get_string (ci, &xpath->path);
- 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);
}
status = cf_util_get_string (child, &xpath->type);
else if (strcasecmp ("InstancePrefix", child->key) == 0)
status = cf_util_get_string (child, &xpath->instance_prefix);
- else if (strcasecmp ("Instance", child->key) == 0)
+ else if (strcasecmp ("InstanceFrom", child->key) == 0)
status = cf_util_get_string (child, &xpath->instance);
- else if (strcasecmp ("Values", child->key) == 0)
- status = cx_config_add_values ("Values", xpath, child);
+ 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);
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);
return (-1);
}
+ curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1);
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,
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);
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);
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
projects / collectd.git / blobdiff