2 * collectd - src/curl_json.c
3 * Copyright (C) 2009 Doug MacEachern
4 * Copyright (C) 2006-2013 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"
29 #include "utils_complain.h"
31 #include <sys/socket.h>
32 #include <sys/types.h>
35 #include <curl/curl.h>
37 #include <yajl/yajl_parse.h>
38 #if HAVE_YAJL_YAJL_VERSION_H
39 # include <yajl/yajl_version.h>
42 #if defined(YAJL_MAJOR) && (YAJL_MAJOR > 1)
43 # define HAVE_YAJL_V2 1
46 #define CJ_DEFAULT_HOST "localhost"
47 #define CJ_KEY_MAGIC 0x43484b59UL /* CHKY */
48 #define CJ_IS_KEY(key) ((key)->magic == CJ_KEY_MAGIC)
50 #define COUCH_MIN(x,y) ((x) < (y) ? (x) : (y))
53 typedef struct cj_key_s cj_key_t;
54 struct cj_key_s /* {{{ */
77 struct curl_slist *headers;
81 char curl_errbuf[CURL_ERROR_SIZE];
94 char name[DATA_MAX_NAME_LEN];
95 } state[YAJL_MAX_DEPTH];
97 typedef struct cj_s cj_t; /* }}} */
100 typedef size_t yajl_len_t;
102 typedef unsigned int yajl_len_t;
105 static int cj_read (user_data_t *ud);
106 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value);
108 static size_t cj_curl_callback (void *buf, /* {{{ */
109 size_t size, size_t nmemb, void *user_data)
124 status = yajl_parse(db->yajl, (unsigned char *)buf, len);
125 if (status == yajl_status_ok)
128 else if (status == yajl_status_insufficient_data)
132 unsigned char *msg = yajl_get_error(db->yajl, /* verbose = */ 1,
133 /* jsonText = */ (unsigned char *) buf, (unsigned int) len);
134 ERROR ("curl_json plugin: yajl_parse failed: %s", msg);
135 yajl_free_error(db->yajl, msg);
136 return (0); /* abort write callback */
137 } /* }}} size_t cj_curl_callback */
139 static int cj_get_type (cj_key_t *key)
141 const data_set_t *ds;
143 ds = plugin_get_ds (key->type);
146 static char type[DATA_MAX_NAME_LEN] = "!!!invalid!!!";
148 assert (key->type != NULL);
149 if (strcmp (type, key->type) != 0)
151 ERROR ("curl_json plugin: Unable to look up DS type \"%s\".",
153 sstrncpy (type, key->type, sizeof (type));
158 else if (ds->ds_num > 1)
160 static c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
162 c_complain_once (LOG_WARNING, &complaint,
163 "curl_json plugin: The type \"%s\" has more than one data source. "
164 "This is currently not supported. I will return the type of the "
165 "first data source, but this will likely lead to problems later on.",
169 return ds->ds[0].type;
172 static int cj_cb_map_key (void *ctx, const unsigned char *val,
175 static void cj_cb_inc_array_index (void *ctx, _Bool update_key)
177 cj_t *db = (cj_t *)ctx;
179 if (!db->state[db->depth].in_array)
182 db->state[db->depth].index++;
186 char name[DATA_MAX_NAME_LEN];
188 ssnprintf (name, sizeof (name), "%d", db->state[db->depth].index - 1);
190 cj_cb_map_key (ctx, (unsigned char *)name, (yajl_len_t) strlen (name));
195 #define CJ_CB_ABORT 0
196 #define CJ_CB_CONTINUE 1
198 static int cj_cb_boolean (void * ctx, int boolVal)
200 cj_cb_inc_array_index (ctx, /* update_key = */ 0);
201 return (CJ_CB_CONTINUE);
204 static int cj_cb_null (void * ctx)
206 cj_cb_inc_array_index (ctx, /* update_key = */ 0);
207 return (CJ_CB_CONTINUE);
210 static int cj_cb_number (void *ctx,
211 const char *number, yajl_len_t number_len)
213 char buffer[number_len + 1];
215 cj_t *db = (cj_t *)ctx;
216 cj_key_t *key = db->state[db->depth].key;
221 /* Create a null-terminated version of the string. */
222 memcpy (buffer, number, number_len);
223 buffer[sizeof (buffer) - 1] = 0;
225 if ((key == NULL) || !CJ_IS_KEY (key)) {
227 NOTICE ("curl_json plugin: Found \"%s\", but the configuration expects"
229 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
230 key = db->state[db->depth].key;
232 return (CJ_CB_CONTINUE);
237 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
240 type = cj_get_type (key);
241 status = parse_value (buffer, &vt, type);
244 NOTICE ("curl_json plugin: Unable to parse number: \"%s\"", buffer);
245 return (CJ_CB_CONTINUE);
248 cj_submit (db, key, &vt);
249 return (CJ_CB_CONTINUE);
250 } /* int cj_cb_number */
252 /* Queries the key-tree of the parent context for "in_name" and, if found,
253 * updates the "key" field of the current context. Otherwise, "key" is set to
255 static int cj_cb_map_key (void *ctx,
256 unsigned char const *in_name, yajl_len_t in_name_len)
258 cj_t *db = (cj_t *)ctx;
261 tree = db->state[db->depth-1].tree;
265 cj_key_t *value = NULL;
269 /* Create a null-terminated version of the name. */
270 name = db->state[db->depth].name;
271 name_len = COUCH_MIN ((size_t) in_name_len,
272 sizeof (db->state[db->depth].name) - 1);
273 memcpy (name, in_name, name_len);
276 if (c_avl_get (tree, name, (void *) &value) == 0) {
277 if (CJ_IS_KEY((cj_key_t*)value)) {
278 db->state[db->depth].key = value;
281 db->state[db->depth].tree = (c_avl_tree_t*) value;
284 else if (c_avl_get (tree, CJ_ANY, (void *) &value) == 0)
285 if (CJ_IS_KEY((cj_key_t*)value)) {
286 db->state[db->depth].key = value;
289 db->state[db->depth].tree = (c_avl_tree_t*) value;
292 db->state[db->depth].key = NULL;
295 return (CJ_CB_CONTINUE);
298 static int cj_cb_string (void *ctx, const unsigned char *val,
301 /* Handle the string as if it was a number. */
302 return (cj_cb_number (ctx, (const char *) val, len));
303 } /* int cj_cb_string */
305 static int cj_cb_start (void *ctx)
307 cj_t *db = (cj_t *)ctx;
308 if (++db->depth >= YAJL_MAX_DEPTH)
310 ERROR ("curl_json plugin: %s depth exceeds max, aborting.",
311 db->url ? db->url : db->sock);
312 return (CJ_CB_ABORT);
314 return (CJ_CB_CONTINUE);
317 static int cj_cb_end (void *ctx)
319 cj_t *db = (cj_t *)ctx;
320 db->state[db->depth].tree = NULL;
322 return (CJ_CB_CONTINUE);
325 static int cj_cb_start_map (void *ctx)
327 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
328 return cj_cb_start (ctx);
331 static int cj_cb_end_map (void *ctx)
333 return cj_cb_end (ctx);
336 static int cj_cb_start_array (void * ctx)
338 cj_t *db = (cj_t *)ctx;
339 cj_cb_inc_array_index (ctx, /* update_key = */ 1);
340 if (db->depth+1 < YAJL_MAX_DEPTH) {
341 db->state[db->depth+1].in_array = 1;
342 db->state[db->depth+1].index = 0;
344 return cj_cb_start (ctx);
347 static int cj_cb_end_array (void * ctx)
349 cj_t *db = (cj_t *)ctx;
350 db->state[db->depth].in_array = 0;
351 return cj_cb_end (ctx);
354 static yajl_callbacks ycallbacks = {
355 cj_cb_null, /* null */
356 cj_cb_boolean, /* boolean */
368 /* end yajl callbacks */
370 static void cj_key_free (cj_key_t *key) /* {{{ */
377 sfree (key->instance);
380 } /* }}} void cj_key_free */
382 static void cj_tree_free (c_avl_tree_t *tree) /* {{{ */
387 while (c_avl_pick (tree, (void *) &name, (void *) &value) == 0)
389 cj_key_t *key = (cj_key_t *)value;
394 cj_tree_free ((c_avl_tree_t *)value);
399 c_avl_destroy (tree);
400 } /* }}} void cj_tree_free */
402 static void cj_free (void *arg) /* {{{ */
406 DEBUG ("curl_json plugin: cj_free (arg = %p);", arg);
413 if (db->curl != NULL)
414 curl_easy_cleanup (db->curl);
417 if (db->tree != NULL)
418 cj_tree_free (db->tree);
421 sfree (db->instance);
429 sfree (db->credentials);
431 sfree (db->post_body);
432 curl_slist_free_all (db->headers);
435 } /* }}} void cj_free */
437 /* Configuration handling functions {{{ */
439 static c_avl_tree_t *cj_avl_create(void)
441 return c_avl_create ((int (*) (const void *, const void *)) strcmp);
444 static int cj_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
447 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
449 WARNING ("curl_json plugin: `%s' needs exactly one string argument.", name);
453 *dest = curl_slist_append(*dest, ci->values[0].value.string);
458 } /* }}} int cj_config_append_string */
460 static int cj_config_add_key (cj_t *db, /* {{{ */
467 if ((ci->values_num != 1)
468 || (ci->values[0].type != OCONFIG_TYPE_STRING))
470 WARNING ("curl_json plugin: The `Key' block "
471 "needs exactly one string argument.");
475 key = (cj_key_t *) malloc (sizeof (*key));
478 ERROR ("curl_json plugin: malloc failed.");
481 memset (key, 0, sizeof (*key));
482 key->magic = CJ_KEY_MAGIC;
484 if (strcasecmp ("Key", ci->key) == 0)
486 status = cf_util_get_string (ci, &key->path);
495 ERROR ("curl_json plugin: cj_config: "
496 "Invalid key: %s", ci->key);
502 for (i = 0; i < ci->children_num; i++)
504 oconfig_item_t *child = ci->children + i;
506 if (strcasecmp ("Type", child->key) == 0)
507 status = cf_util_get_string (child, &key->type);
508 else if (strcasecmp ("Instance", child->key) == 0)
509 status = cf_util_get_string (child, &key->instance);
512 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
518 } /* for (i = 0; i < ci->children_num; i++) */
526 if (key->type == NULL)
528 WARNING ("curl_json plugin: `Type' missing in `Key' block.");
533 /* store path in a tree that will match the json map structure, example:
534 * "httpd/requests/count",
535 * "httpd/requests/current" ->
536 * { "httpd": { "requests": { "count": $key, "current": $key } } }
542 if (db->tree == NULL)
543 db->tree = cj_avl_create();
551 while ((ptr = strchr (name, '/')) != NULL)
561 len = COUCH_MIN(len, sizeof (ent)-1);
562 sstrncpy (ent, name, len+1);
564 if (c_avl_get (tree, ent, (void *) &value) != 0)
566 value = cj_avl_create ();
567 c_avl_insert (tree, strdup (ent), value);
574 if (strlen (name) == 0)
576 ERROR ("curl_json plugin: invalid key: %s", key->path);
581 c_avl_insert (tree, strdup (name), key);
583 } /* }}} int cj_config_add_key */
585 static int cj_init_curl (cj_t *db) /* {{{ */
587 db->curl = curl_easy_init ();
588 if (db->curl == NULL)
590 ERROR ("curl_json plugin: curl_easy_init failed.");
594 curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1L);
595 curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cj_curl_callback);
596 curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db);
597 curl_easy_setopt (db->curl, CURLOPT_USERAGENT,
598 PACKAGE_NAME"/"PACKAGE_VERSION);
599 curl_easy_setopt (db->curl, CURLOPT_ERRORBUFFER, db->curl_errbuf);
600 curl_easy_setopt (db->curl, CURLOPT_URL, db->url);
602 if (db->user != NULL)
604 size_t credentials_size;
606 credentials_size = strlen (db->user) + 2;
607 if (db->pass != NULL)
608 credentials_size += strlen (db->pass);
610 db->credentials = (char *) malloc (credentials_size);
611 if (db->credentials == NULL)
613 ERROR ("curl_json plugin: malloc failed.");
617 ssnprintf (db->credentials, credentials_size, "%s:%s",
618 db->user, (db->pass == NULL) ? "" : db->pass);
619 curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials);
622 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, (long) db->verify_peer);
623 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST,
624 db->verify_host ? 2L : 0L);
625 if (db->cacert != NULL)
626 curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert);
627 if (db->headers != NULL)
628 curl_easy_setopt (db->curl, CURLOPT_HTTPHEADER, db->headers);
629 if (db->post_body != NULL)
630 curl_easy_setopt (db->curl, CURLOPT_POSTFIELDS, db->post_body);
633 } /* }}} int cj_init_curl */
635 static int cj_config_add_url (oconfig_item_t *ci) /* {{{ */
641 if ((ci->values_num != 1)
642 || (ci->values[0].type != OCONFIG_TYPE_STRING))
644 WARNING ("curl_json plugin: The `URL' block "
645 "needs exactly one string argument.");
649 db = (cj_t *) malloc (sizeof (*db));
652 ERROR ("curl_json plugin: malloc failed.");
655 memset (db, 0, sizeof (*db));
657 if (strcasecmp ("URL", ci->key) == 0)
658 status = cf_util_get_string (ci, &db->url);
659 else if (strcasecmp ("Sock", ci->key) == 0)
660 status = cf_util_get_string (ci, &db->sock);
663 ERROR ("curl_json plugin: cj_config: "
664 "Invalid key: %s", ci->key);
674 /* Fill the `cj_t' structure.. */
675 for (i = 0; i < ci->children_num; i++)
677 oconfig_item_t *child = ci->children + i;
679 if (strcasecmp ("Instance", child->key) == 0)
680 status = cf_util_get_string (child, &db->instance);
681 else if (strcasecmp ("Host", child->key) == 0)
682 status = cf_util_get_string (child, &db->host);
683 else if (db->url && strcasecmp ("User", child->key) == 0)
684 status = cf_util_get_string (child, &db->user);
685 else if (db->url && strcasecmp ("Password", child->key) == 0)
686 status = cf_util_get_string (child, &db->pass);
687 else if (db->url && strcasecmp ("VerifyPeer", child->key) == 0)
688 status = cf_util_get_boolean (child, &db->verify_peer);
689 else if (db->url && strcasecmp ("VerifyHost", child->key) == 0)
690 status = cf_util_get_boolean (child, &db->verify_host);
691 else if (db->url && strcasecmp ("CACert", child->key) == 0)
692 status = cf_util_get_string (child, &db->cacert);
693 else if (db->url && strcasecmp ("Header", child->key) == 0)
694 status = cj_config_append_string ("Header", &db->headers, child);
695 else if (db->url && strcasecmp ("Post", child->key) == 0)
696 status = cf_util_get_string (child, &db->post_body);
697 else if (strcasecmp ("Key", child->key) == 0)
698 status = cj_config_add_key (db, child);
701 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
711 if (db->tree == NULL)
713 WARNING ("curl_json plugin: No (valid) `Key' block within `%s' \"`%s'\".",
714 db->url ? "URL" : "Sock", db->url ? db->url : db->sock);
717 if (status == 0 && db->url)
718 status = cj_init_curl (db);
721 /* If all went well, register this database for reading */
727 if (db->instance == NULL)
728 db->instance = strdup("default");
730 DEBUG ("curl_json plugin: Registering new read callback: %s",
733 memset (&ud, 0, sizeof (ud));
734 ud.data = (void *) db;
735 ud.free_func = cj_free;
737 cb_name = ssnprintf_alloc ("curl_json-%s-%s",
738 db->instance, db->url ? db->url : db->sock);
740 plugin_register_complex_read (/* group = */ "curl_json", cb_name, cj_read,
741 /* interval = */ NULL, &ud);
752 /* }}} int cj_config_add_database */
754 static int cj_config (oconfig_item_t *ci) /* {{{ */
764 for (i = 0; i < ci->children_num; i++)
766 oconfig_item_t *child = ci->children + i;
768 if (strcasecmp ("Sock", child->key) == 0
769 || strcasecmp ("URL", child->key) == 0)
771 status = cj_config_add_url (child);
779 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
784 if ((success == 0) && (errors > 0))
786 ERROR ("curl_json plugin: All statements failed.");
791 } /* }}} int cj_config */
793 /* }}} End of configuration handling functions */
795 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value) /* {{{ */
797 value_list_t vl = VALUE_LIST_INIT;
803 if ((db->host == NULL)
804 || (strcmp ("", db->host) == 0)
805 || (strcmp (CJ_DEFAULT_HOST, db->host) == 0))
810 if (key->instance == NULL)
812 if ((db->depth == 0) || (strcmp ("", db->state[db->depth-1].name) == 0))
813 sstrncpy (vl.type_instance, db->state[db->depth].name, sizeof (vl.type_instance));
815 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
816 db->state[db->depth-1].name, db->state[db->depth].name);
819 sstrncpy (vl.type_instance, key->instance, sizeof (vl.type_instance));
821 sstrncpy (vl.host, host, sizeof (vl.host));
822 sstrncpy (vl.plugin, "curl_json", sizeof (vl.plugin));
823 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
824 sstrncpy (vl.type, key->type, sizeof (vl.type));
826 plugin_dispatch_values (&vl);
827 } /* }}} int cj_submit */
829 static int cj_sock_perform (cj_t *db) /* {{{ */
832 struct sockaddr_un sa_unix = {};
833 sa_unix.sun_family = AF_UNIX;
834 sstrncpy (sa_unix.sun_path, db->sock, sizeof (sa_unix.sun_path));
836 int fd = socket (AF_UNIX, SOCK_STREAM, 0);
839 if (connect (fd, (struct sockaddr *)&sa_unix, sizeof(sa_unix)) < 0)
841 ERROR ("curl_json plugin: connect(%s) failed: %s",
842 (db->sock != NULL) ? db->sock : "<null>",
843 sstrerror(errno, errbuf, sizeof (errbuf)));
850 unsigned char buffer[4096];
851 red = read (fd, buffer, sizeof(buffer));
853 ERROR ("curl_json plugin: read(%s) failed: %s",
854 (db->sock != NULL) ? db->sock : "<null>",
855 sstrerror(errno, errbuf, sizeof (errbuf)));
859 if (!cj_curl_callback (buffer, red, 1, db))
864 } /* }}} int cj_sock_perform */
867 static int cj_curl_perform(cj_t *db) /* {{{ */
874 status = curl_easy_perform (db->curl);
875 if (status != CURLE_OK)
877 ERROR ("curl_json plugin: curl_easy_perform failed with status %i: %s (%s)",
878 status, db->curl_errbuf, url);
882 curl_easy_getinfo(db->curl, CURLINFO_EFFECTIVE_URL, &url);
883 curl_easy_getinfo(db->curl, CURLINFO_RESPONSE_CODE, &rc);
885 /* The response code is zero if a non-HTTP transport was used. */
886 if ((rc != 0) && (rc != 200))
888 ERROR ("curl_json plugin: curl_easy_perform failed with "
889 "response code %ld (%s)", rc, url);
893 } /* }}} int cj_curl_perform */
895 static int cj_perform (cj_t *db) /* {{{ */
898 yajl_handle yprev = db->yajl;
900 db->yajl = yajl_alloc (&ycallbacks,
902 /* alloc funcs = */ NULL,
904 /* alloc funcs = */ NULL, NULL,
906 /* context = */ (void *)db);
907 if (db->yajl == NULL)
909 ERROR ("curl_json plugin: yajl_alloc failed.");
915 status = cj_curl_perform (db);
917 status = cj_sock_perform (db);
920 yajl_free (db->yajl);
926 status = yajl_complete_parse(db->yajl);
928 status = yajl_parse_complete(db->yajl);
930 if (status != yajl_status_ok)
932 unsigned char *errmsg;
934 errmsg = yajl_get_error (db->yajl, /* verbose = */ 0,
935 /* jsonText = */ NULL, /* jsonTextLen = */ 0);
936 ERROR ("curl_json plugin: yajl_parse_complete failed: %s",
938 yajl_free_error (db->yajl, errmsg);
939 yajl_free (db->yajl);
944 yajl_free (db->yajl);
947 } /* }}} int cj_perform */
949 static int cj_read (user_data_t *ud) /* {{{ */
953 if ((ud == NULL) || (ud->data == NULL))
955 ERROR ("curl_json plugin: cj_read: Invalid user data.");
959 db = (cj_t *) ud->data;
962 memset (&db->state, 0, sizeof(db->state));
963 db->state[db->depth].tree = db->tree;
966 return cj_perform (db);
967 } /* }}} int cj_read */
969 static int cj_init (void) /* {{{ */
971 /* Call this while collectd is still single-threaded to avoid
972 * initialization issues in libgcrypt. */
973 curl_global_init (CURL_GLOBAL_SSL);
975 } /* }}} int cj_init */
977 void module_register (void)
979 plugin_register_complex_config ("curl_json", cj_config);
980 plugin_register_init ("curl_json", cj_init);
981 } /* void module_register */
983 /* vim: set sw=2 sts=2 et fdm=marker : */