2 * collectd - src/curl_json.c
3 * Copyright (C) 2009 Doug MacEachern
4 * Copyright (C) 2006-2011 Florian octo Forster
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Doug MacEachern <dougm at hyperic.com>
21 * Florian octo Forster <octo at collectd.org>
27 #include "configfile.h"
28 #include "utils_avltree.h"
30 #include <curl/curl.h>
31 #include <yajl/yajl_parse.h>
32 #if HAVE_YAJL_YAJL_VERSION_H
33 # include <yajl/yajl_version.h>
36 #if defined(YAJL_MAJOR) && (YAJL_MAJOR > 1)
37 # define HAVE_YAJL_V2 1
40 #define CJ_DEFAULT_HOST "localhost"
41 #define CJ_KEY_MAGIC 0x43484b59UL /* CHKY */
42 #define CJ_IS_KEY(key) ((key)->magic == CJ_KEY_MAGIC)
44 #define COUCH_MIN(x,y) ((x) < (y) ? (x) : (y))
47 typedef struct cj_key_s cj_key_t;
48 struct cj_key_s /* {{{ */
71 char curl_errbuf[CURL_ERROR_SIZE];
82 char name[DATA_MAX_NAME_LEN];
83 } state[YAJL_MAX_DEPTH];
85 typedef struct cj_s cj_t; /* }}} */
88 typedef size_t yajl_len_t;
90 typedef unsigned int yajl_len_t;
93 static int cj_read (user_data_t *ud);
94 static int cj_curl_perform (cj_t *db, CURL *curl);
95 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value);
97 static size_t cj_curl_callback (void *buf, /* {{{ */
98 size_t size, size_t nmemb, void *user_data)
113 status = yajl_parse(db->yajl, (unsigned char *) buf, len);
114 if (status == yajl_status_ok)
117 status = yajl_complete_parse(db->yajl);
119 status = yajl_parse_complete(db->yajl);
124 else if (status == yajl_status_insufficient_data)
128 if (status != yajl_status_ok)
131 yajl_get_error(db->yajl, /* verbose = */ 1,
132 /* jsonText = */ (unsigned char *) buf, (unsigned int) len);
133 ERROR ("curl_json plugin: yajl_parse failed: %s", msg);
134 yajl_free_error(db->yajl, msg);
135 return (0); /* abort write callback */
139 } /* }}} size_t cj_curl_callback */
141 static int cj_get_type (cj_key_t *key)
143 const data_set_t *ds;
145 ds = plugin_get_ds (key->type);
147 return -1; /* let plugin_write do the complaining */
149 return ds->ds[0].type; /* XXX support ds->ds_len > 1 */
153 #define CJ_CB_ABORT 0
154 #define CJ_CB_CONTINUE 1
156 /* "number" may not be null terminated, so copy it into a buffer before
158 static int cj_cb_number (void *ctx,
159 const char *number, yajl_len_t number_len)
161 char buffer[number_len + 1];
163 cj_t *db = (cj_t *)ctx;
164 cj_key_t *key = db->state[db->depth].key;
169 if ((key == NULL) || !CJ_IS_KEY (key))
170 return (CJ_CB_CONTINUE);
172 memcpy (buffer, number, number_len);
173 buffer[sizeof (buffer) - 1] = 0;
175 type = cj_get_type (key);
176 status = parse_value (buffer, &vt, type);
179 NOTICE ("curl_json plugin: Unable to parse number: \"%s\"", buffer);
180 return (CJ_CB_CONTINUE);
183 cj_submit (db, key, &vt);
184 return (CJ_CB_CONTINUE);
185 } /* int cj_cb_number */
187 static int cj_cb_map_key (void *ctx, const unsigned char *val,
190 cj_t *db = (cj_t *)ctx;
193 tree = db->state[db->depth-1].tree;
200 name = db->state[db->depth].name;
201 len = COUCH_MIN(len, sizeof (db->state[db->depth].name)-1);
202 sstrncpy (name, (char *)val, len+1);
204 if (c_avl_get (tree, name, (void *) &value) == 0)
205 db->state[db->depth].key = value;
206 else if (c_avl_get (tree, CJ_ANY, (void *) &value) == 0)
207 db->state[db->depth].key = value;
209 db->state[db->depth].key = NULL;
212 return (CJ_CB_CONTINUE);
215 static int cj_cb_string (void *ctx, const unsigned char *val,
218 cj_t *db = (cj_t *)ctx;
221 /* Create a null-terminated version of the string. */
222 memcpy (str, val, len);
225 /* No configuration for this string -> simply return. */
226 if (db->state[db->depth].key == NULL)
227 return (CJ_CB_CONTINUE);
229 if (!CJ_IS_KEY (db->state[db->depth].key))
231 NOTICE ("curl_json plugin: Found string \"%s\", but the configuration "
232 "expects a map here.", str);
233 return (CJ_CB_CONTINUE);
236 /* Handle the string as if it was a number. */
237 return (cj_cb_number (ctx, (const char *) val, len));
238 } /* int cj_cb_string */
240 static int cj_cb_start (void *ctx)
242 cj_t *db = (cj_t *)ctx;
243 if (++db->depth >= YAJL_MAX_DEPTH)
245 ERROR ("curl_json plugin: %s depth exceeds max, aborting.", db->url);
246 return (CJ_CB_ABORT);
248 return (CJ_CB_CONTINUE);
251 static int cj_cb_end (void *ctx)
253 cj_t *db = (cj_t *)ctx;
254 db->state[db->depth].tree = NULL;
256 return (CJ_CB_CONTINUE);
259 static int cj_cb_start_map (void *ctx)
261 return cj_cb_start (ctx);
264 static int cj_cb_end_map (void *ctx)
266 return cj_cb_end (ctx);
269 static int cj_cb_start_array (void * ctx)
271 return cj_cb_start (ctx);
274 static int cj_cb_end_array (void * ctx)
276 return cj_cb_end (ctx);
279 static yajl_callbacks ycallbacks = {
293 /* end yajl callbacks */
295 static void cj_key_free (cj_key_t *key) /* {{{ */
302 sfree (key->instance);
305 } /* }}} void cj_key_free */
307 static void cj_tree_free (c_avl_tree_t *tree) /* {{{ */
312 while (c_avl_pick (tree, (void *) &name, (void *) &value) == 0)
314 cj_key_t *key = (cj_key_t *)value;
319 cj_tree_free ((c_avl_tree_t *)value);
324 c_avl_destroy (tree);
325 } /* }}} void cj_tree_free */
327 static void cj_free (void *arg) /* {{{ */
331 DEBUG ("curl_json plugin: cj_free (arg = %p);", arg);
338 if (db->curl != NULL)
339 curl_easy_cleanup (db->curl);
342 if (db->tree != NULL)
343 cj_tree_free (db->tree);
346 sfree (db->instance);
352 sfree (db->credentials);
356 } /* }}} void cj_free */
358 /* Configuration handling functions {{{ */
360 static c_avl_tree_t *cj_avl_create(void)
362 return c_avl_create ((int (*) (const void *, const void *)) strcmp);
365 static int cj_config_add_key (cj_t *db, /* {{{ */
372 if ((ci->values_num != 1)
373 || (ci->values[0].type != OCONFIG_TYPE_STRING))
375 WARNING ("curl_json plugin: The `Key' block "
376 "needs exactly one string argument.");
380 key = (cj_key_t *) malloc (sizeof (*key));
383 ERROR ("curl_json plugin: malloc failed.");
386 memset (key, 0, sizeof (*key));
387 key->magic = CJ_KEY_MAGIC;
389 if (strcasecmp ("Key", ci->key) == 0)
391 status = cf_util_get_string (ci, &key->path);
400 ERROR ("curl_json plugin: cj_config: "
401 "Invalid key: %s", ci->key);
406 for (i = 0; i < ci->children_num; i++)
408 oconfig_item_t *child = ci->children + i;
410 if (strcasecmp ("Type", child->key) == 0)
411 status = cf_util_get_string (child, &key->type);
412 else if (strcasecmp ("Instance", child->key) == 0)
413 status = cf_util_get_string (child, &key->instance);
416 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
422 } /* for (i = 0; i < ci->children_num; i++) */
426 if (key->type == NULL)
428 WARNING ("curl_json plugin: `Type' missing in `Key' block.");
433 } /* while (status == 0) */
435 /* store path in a tree that will match the json map structure, example:
436 * "httpd/requests/count",
437 * "httpd/requests/current" ->
438 * { "httpd": { "requests": { "count": $key, "current": $key } } }
447 if (db->tree == NULL)
448 db->tree = cj_avl_create();
467 sstrncpy (ent, name, len+1);
469 if (c_avl_get (tree, ent, (void *) &value) != 0)
471 value = cj_avl_create ();
472 c_avl_insert (tree, strdup (ent), value);
481 c_avl_insert (tree, strdup(name), key);
484 ERROR ("curl_json plugin: invalid key: %s", key->path);
490 } /* }}} int cj_config_add_key */
492 static int cj_init_curl (cj_t *db) /* {{{ */
494 db->curl = curl_easy_init ();
495 if (db->curl == NULL)
497 ERROR ("curl_json plugin: curl_easy_init failed.");
501 curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1);
502 curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cj_curl_callback);
503 curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db);
504 curl_easy_setopt (db->curl, CURLOPT_USERAGENT,
505 PACKAGE_NAME"/"PACKAGE_VERSION);
506 curl_easy_setopt (db->curl, CURLOPT_ERRORBUFFER, db->curl_errbuf);
507 curl_easy_setopt (db->curl, CURLOPT_URL, db->url);
509 if (db->user != NULL)
511 size_t credentials_size;
513 credentials_size = strlen (db->user) + 2;
514 if (db->pass != NULL)
515 credentials_size += strlen (db->pass);
517 db->credentials = (char *) malloc (credentials_size);
518 if (db->credentials == NULL)
520 ERROR ("curl_json plugin: malloc failed.");
524 ssnprintf (db->credentials, credentials_size, "%s:%s",
525 db->user, (db->pass == NULL) ? "" : db->pass);
526 curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials);
529 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, (int) db->verify_peer);
530 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST,
531 (int) (db->verify_host ? 2 : 0));
532 if (db->cacert != NULL)
533 curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert);
536 } /* }}} int cj_init_curl */
538 static int cj_config_add_url (oconfig_item_t *ci) /* {{{ */
544 if ((ci->values_num != 1)
545 || (ci->values[0].type != OCONFIG_TYPE_STRING))
547 WARNING ("curl_json plugin: The `URL' block "
548 "needs exactly one string argument.");
552 db = (cj_t *) malloc (sizeof (*db));
555 ERROR ("curl_json plugin: malloc failed.");
558 memset (db, 0, sizeof (*db));
560 if (strcasecmp ("URL", ci->key) == 0)
562 status = cf_util_get_string (ci, &db->url);
571 ERROR ("curl_json plugin: cj_config: "
572 "Invalid key: %s", ci->key);
576 /* Fill the `cj_t' structure.. */
577 for (i = 0; i < ci->children_num; i++)
579 oconfig_item_t *child = ci->children + i;
581 if (strcasecmp ("Instance", child->key) == 0)
582 status = cf_util_get_string (child, &db->instance);
583 else if (strcasecmp ("Host", child->key) == 0)
584 status = cf_util_get_string (child, &db->host);
585 else if (strcasecmp ("User", child->key) == 0)
586 status = cf_util_get_string (child, &db->user);
587 else if (strcasecmp ("Password", child->key) == 0)
588 status = cf_util_get_string (child, &db->pass);
589 else if (strcasecmp ("VerifyPeer", child->key) == 0)
590 status = cf_util_get_boolean (child, &db->verify_peer);
591 else if (strcasecmp ("VerifyHost", child->key) == 0)
592 status = cf_util_get_boolean (child, &db->verify_host);
593 else if (strcasecmp ("CACert", child->key) == 0)
594 status = cf_util_get_string (child, &db->cacert);
595 else if (strcasecmp ("Key", child->key) == 0)
596 status = cj_config_add_key (db, child);
599 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
609 if (db->tree == NULL)
611 WARNING ("curl_json plugin: No (valid) `Key' block "
612 "within `URL' block `%s'.", db->url);
616 status = cj_init_curl (db);
619 /* If all went well, register this database for reading */
623 char cb_name[DATA_MAX_NAME_LEN];
625 if (db->instance == NULL)
626 db->instance = strdup("default");
628 DEBUG ("curl_json plugin: Registering new read callback: %s",
631 memset (&ud, 0, sizeof (ud));
632 ud.data = (void *) db;
633 ud.free_func = cj_free;
635 ssnprintf (cb_name, sizeof (cb_name), "curl_json-%s-%s",
636 db->instance, db->url);
638 plugin_register_complex_read (/* group = */ NULL, cb_name, cj_read,
639 /* interval = */ NULL, &ud);
649 /* }}} int cj_config_add_database */
651 static int cj_config (oconfig_item_t *ci) /* {{{ */
661 for (i = 0; i < ci->children_num; i++)
663 oconfig_item_t *child = ci->children + i;
665 if (strcasecmp ("URL", child->key) == 0)
667 status = cj_config_add_url (child);
675 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
680 if ((success == 0) && (errors > 0))
682 ERROR ("curl_json plugin: All statements failed.");
687 } /* }}} int cj_config */
689 /* }}} End of configuration handling functions */
691 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value) /* {{{ */
693 value_list_t vl = VALUE_LIST_INIT;
699 if ((db->host == NULL)
700 || (strcmp ("", db->host) == 0)
701 || (strcmp (CJ_DEFAULT_HOST, db->host) == 0))
706 if (key->instance == NULL)
707 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
708 db->state[db->depth-1].name, db->state[db->depth].name);
710 sstrncpy (vl.type_instance, key->instance, sizeof (vl.type_instance));
712 sstrncpy (vl.host, host, sizeof (vl.host));
713 sstrncpy (vl.plugin, "curl_json", sizeof (vl.plugin));
714 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
715 sstrncpy (vl.type, key->type, sizeof (vl.type));
717 plugin_dispatch_values (&vl);
718 } /* }}} int cj_submit */
720 static int cj_curl_perform (cj_t *db, CURL *curl) /* {{{ */
725 yajl_handle yprev = db->yajl;
727 db->yajl = yajl_alloc (&ycallbacks,
729 /* alloc funcs = */ NULL,
731 /* alloc funcs = */ NULL, NULL,
733 /* context = */ (void *)db);
734 if (db->yajl == NULL)
736 ERROR ("curl_json plugin: yajl_alloc failed.");
742 curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &url);
744 status = curl_easy_perform (curl);
747 ERROR ("curl_json plugin: curl_easy_perform failed with status %i: %s (%s)",
748 status, db->curl_errbuf, (url != NULL) ? url : "<null>");
749 yajl_free (db->yajl);
754 curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &rc);
756 /* The response code is zero if a non-HTTP transport was used. */
757 if ((rc != 0) && (rc != 200))
759 ERROR ("curl_json plugin: curl_easy_perform failed with "
760 "response code %ld (%s)", rc, url);
761 yajl_free (db->yajl);
767 status = yajl_complete_parse(db->yajl);
769 status = yajl_parse_complete(db->yajl);
771 if (status != yajl_status_ok)
773 unsigned char *errmsg;
775 errmsg = yajl_get_error (db->yajl, /* verbose = */ 0,
776 /* jsonText = */ NULL, /* jsonTextLen = */ 0);
777 ERROR ("curl_json plugin: yajl_parse_complete failed: %s",
779 yajl_free_error (db->yajl, errmsg);
780 yajl_free (db->yajl);
785 yajl_free (db->yajl);
788 } /* }}} int cj_curl_perform */
790 static int cj_read (user_data_t *ud) /* {{{ */
794 if ((ud == NULL) || (ud->data == NULL))
796 ERROR ("curl_json plugin: cj_read: Invalid user data.");
800 db = (cj_t *) ud->data;
803 memset (&db->state, 0, sizeof(db->state));
804 db->state[db->depth].tree = db->tree;
807 return cj_curl_perform (db, db->curl);
808 } /* }}} int cj_read */
810 void module_register (void)
812 plugin_register_complex_config ("curl_json", cj_config);
813 } /* void module_register */
815 /* vim: set sw=2 sts=2 et fdm=marker : */