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"
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];
92 char name[DATA_MAX_NAME_LEN];
93 } state[YAJL_MAX_DEPTH];
95 typedef struct cj_s cj_t; /* }}} */
98 typedef size_t yajl_len_t;
100 typedef unsigned int yajl_len_t;
103 static int cj_read (user_data_t *ud);
104 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value);
106 static size_t cj_curl_callback (void *buf, /* {{{ */
107 size_t size, size_t nmemb, void *user_data)
122 status = yajl_parse(db->yajl, (unsigned char *)buf, len);
123 if (status == yajl_status_ok)
126 else if (status == yajl_status_insufficient_data)
130 if (status != yajl_status_ok)
133 yajl_get_error(db->yajl, /* verbose = */ 1,
134 /* jsonText = */ (unsigned char *) buf, (unsigned int) len);
135 ERROR ("curl_json plugin: yajl_parse failed: %s", msg);
136 yajl_free_error(db->yajl, msg);
137 return (0); /* abort write callback */
141 } /* }}} size_t cj_curl_callback */
143 static int cj_get_type (cj_key_t *key)
145 const data_set_t *ds;
147 ds = plugin_get_ds (key->type);
150 static char type[DATA_MAX_NAME_LEN] = "!!!invalid!!!";
152 assert (key->type != NULL);
153 if (strcmp (type, key->type) != 0)
155 ERROR ("curl_json plugin: Unable to look up DS type \"%s\".",
157 sstrncpy (type, key->type, sizeof (type));
162 else if (ds->ds_num > 1)
164 static c_complain_t complaint = C_COMPLAIN_INIT_STATIC;
166 c_complain_once (LOG_WARNING, &complaint,
167 "curl_json plugin: The type \"%s\" has more than one data source. "
168 "This is currently not supported. I will return the type of the "
169 "first data source, but this will likely lead to problems later on.",
173 return ds->ds[0].type;
177 #define CJ_CB_ABORT 0
178 #define CJ_CB_CONTINUE 1
180 /* "number" may not be null terminated, so copy it into a buffer before
182 static int cj_cb_number (void *ctx,
183 const char *number, yajl_len_t number_len)
185 char buffer[number_len + 1];
187 cj_t *db = (cj_t *)ctx;
188 cj_key_t *key = db->state[db->depth].key;
193 if ((key == NULL) || !CJ_IS_KEY (key))
194 return (CJ_CB_CONTINUE);
196 memcpy (buffer, number, number_len);
197 buffer[sizeof (buffer) - 1] = 0;
199 type = cj_get_type (key);
200 status = parse_value (buffer, &vt, type);
203 NOTICE ("curl_json plugin: Unable to parse number: \"%s\"", buffer);
204 return (CJ_CB_CONTINUE);
207 cj_submit (db, key, &vt);
208 return (CJ_CB_CONTINUE);
209 } /* int cj_cb_number */
211 static int cj_cb_map_key (void *ctx, const unsigned char *val,
214 cj_t *db = (cj_t *)ctx;
217 tree = db->state[db->depth-1].tree;
224 name = db->state[db->depth].name;
225 len = COUCH_MIN(len, sizeof (db->state[db->depth].name)-1);
226 sstrncpy (name, (char *)val, len+1);
228 if (c_avl_get (tree, name, (void *) &value) == 0)
229 db->state[db->depth].key = value;
230 else if (c_avl_get (tree, CJ_ANY, (void *) &value) == 0)
231 db->state[db->depth].key = value;
233 db->state[db->depth].key = NULL;
236 return (CJ_CB_CONTINUE);
239 static int cj_cb_string (void *ctx, const unsigned char *val,
242 cj_t *db = (cj_t *)ctx;
245 /* Create a null-terminated version of the string. */
246 memcpy (str, val, len);
249 /* No configuration for this string -> simply return. */
250 if (db->state[db->depth].key == NULL)
251 return (CJ_CB_CONTINUE);
253 if (!CJ_IS_KEY (db->state[db->depth].key))
255 NOTICE ("curl_json plugin: Found string \"%s\", but the configuration "
256 "expects a map here.", str);
257 return (CJ_CB_CONTINUE);
260 /* Handle the string as if it was a number. */
261 return (cj_cb_number (ctx, (const char *) val, len));
262 } /* int cj_cb_string */
264 static int cj_cb_start (void *ctx)
266 cj_t *db = (cj_t *)ctx;
267 if (++db->depth >= YAJL_MAX_DEPTH)
269 ERROR ("curl_json plugin: %s depth exceeds max, aborting.", db->url ? db->url : db->sock);
270 return (CJ_CB_ABORT);
272 return (CJ_CB_CONTINUE);
275 static int cj_cb_end (void *ctx)
277 cj_t *db = (cj_t *)ctx;
278 db->state[db->depth].tree = NULL;
280 return (CJ_CB_CONTINUE);
283 static int cj_cb_start_map (void *ctx)
285 return cj_cb_start (ctx);
288 static int cj_cb_end_map (void *ctx)
290 return cj_cb_end (ctx);
293 static int cj_cb_start_array (void * ctx)
295 return cj_cb_start (ctx);
298 static int cj_cb_end_array (void * ctx)
300 return cj_cb_end (ctx);
303 static yajl_callbacks ycallbacks = {
317 /* end yajl callbacks */
319 static void cj_key_free (cj_key_t *key) /* {{{ */
326 sfree (key->instance);
329 } /* }}} void cj_key_free */
331 static void cj_tree_free (c_avl_tree_t *tree) /* {{{ */
336 while (c_avl_pick (tree, (void *) &name, (void *) &value) == 0)
338 cj_key_t *key = (cj_key_t *)value;
343 cj_tree_free ((c_avl_tree_t *)value);
348 c_avl_destroy (tree);
349 } /* }}} void cj_tree_free */
351 static void cj_free (void *arg) /* {{{ */
355 DEBUG ("curl_json plugin: cj_free (arg = %p);", arg);
362 if (db->curl != NULL)
363 curl_easy_cleanup (db->curl);
366 if (db->tree != NULL)
367 cj_tree_free (db->tree);
370 sfree (db->instance);
376 sfree (db->credentials);
378 sfree (db->post_body);
379 curl_slist_free_all (db->headers);
382 } /* }}} void cj_free */
384 /* Configuration handling functions {{{ */
386 static c_avl_tree_t *cj_avl_create(void)
388 return c_avl_create ((int (*) (const void *, const void *)) strcmp);
391 static int cj_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
394 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
396 WARNING ("curl_json plugin: `%s' needs exactly one string argument.", name);
400 *dest = curl_slist_append(*dest, ci->values[0].value.string);
405 } /* }}} int cj_config_append_string */
407 static int cj_config_add_key (cj_t *db, /* {{{ */
414 if ((ci->values_num != 1)
415 || (ci->values[0].type != OCONFIG_TYPE_STRING))
417 WARNING ("curl_json plugin: The `Key' block "
418 "needs exactly one string argument.");
422 key = (cj_key_t *) malloc (sizeof (*key));
425 ERROR ("curl_json plugin: malloc failed.");
428 memset (key, 0, sizeof (*key));
429 key->magic = CJ_KEY_MAGIC;
431 if (strcasecmp ("Key", ci->key) == 0)
433 status = cf_util_get_string (ci, &key->path);
442 ERROR ("curl_json plugin: cj_config: "
443 "Invalid key: %s", ci->key);
448 for (i = 0; i < ci->children_num; i++)
450 oconfig_item_t *child = ci->children + i;
452 if (strcasecmp ("Type", child->key) == 0)
453 status = cf_util_get_string (child, &key->type);
454 else if (strcasecmp ("Instance", child->key) == 0)
455 status = cf_util_get_string (child, &key->instance);
458 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
464 } /* for (i = 0; i < ci->children_num; i++) */
468 if (key->type == NULL)
470 WARNING ("curl_json plugin: `Type' missing in `Key' block.");
475 } /* while (status == 0) */
477 /* store path in a tree that will match the json map structure, example:
478 * "httpd/requests/count",
479 * "httpd/requests/current" ->
480 * { "httpd": { "requests": { "count": $key, "current": $key } } }
489 if (db->tree == NULL)
490 db->tree = cj_avl_create();
509 sstrncpy (ent, name, len+1);
511 if (c_avl_get (tree, ent, (void *) &value) != 0)
513 value = cj_avl_create ();
514 c_avl_insert (tree, strdup (ent), value);
523 c_avl_insert (tree, strdup(name), key);
526 ERROR ("curl_json plugin: invalid key: %s", key->path);
532 } /* }}} int cj_config_add_key */
534 static int cj_init_curl (cj_t *db) /* {{{ */
536 db->curl = curl_easy_init ();
537 if (db->curl == NULL)
539 ERROR ("curl_json plugin: curl_easy_init failed.");
543 curl_easy_setopt (db->curl, CURLOPT_NOSIGNAL, 1L);
544 curl_easy_setopt (db->curl, CURLOPT_WRITEFUNCTION, cj_curl_callback);
545 curl_easy_setopt (db->curl, CURLOPT_WRITEDATA, db);
546 curl_easy_setopt (db->curl, CURLOPT_USERAGENT,
547 PACKAGE_NAME"/"PACKAGE_VERSION);
548 curl_easy_setopt (db->curl, CURLOPT_ERRORBUFFER, db->curl_errbuf);
549 curl_easy_setopt (db->curl, CURLOPT_URL, db->url);
551 if (db->user != NULL)
553 size_t credentials_size;
555 credentials_size = strlen (db->user) + 2;
556 if (db->pass != NULL)
557 credentials_size += strlen (db->pass);
559 db->credentials = (char *) malloc (credentials_size);
560 if (db->credentials == NULL)
562 ERROR ("curl_json plugin: malloc failed.");
566 ssnprintf (db->credentials, credentials_size, "%s:%s",
567 db->user, (db->pass == NULL) ? "" : db->pass);
568 curl_easy_setopt (db->curl, CURLOPT_USERPWD, db->credentials);
571 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYPEER, (long) db->verify_peer);
572 curl_easy_setopt (db->curl, CURLOPT_SSL_VERIFYHOST,
573 db->verify_host ? 2L : 0L);
574 if (db->cacert != NULL)
575 curl_easy_setopt (db->curl, CURLOPT_CAINFO, db->cacert);
576 if (db->headers != NULL)
577 curl_easy_setopt (db->curl, CURLOPT_HTTPHEADER, db->headers);
578 if (db->post_body != NULL)
579 curl_easy_setopt (db->curl, CURLOPT_POSTFIELDS, db->post_body);
582 } /* }}} int cj_init_curl */
584 static int cj_config_add_url (oconfig_item_t *ci) /* {{{ */
590 if ((ci->values_num != 1)
591 || (ci->values[0].type != OCONFIG_TYPE_STRING))
593 WARNING ("curl_json plugin: The `URL' block "
594 "needs exactly one string argument.");
598 db = (cj_t *) malloc (sizeof (*db));
601 ERROR ("curl_json plugin: malloc failed.");
604 memset (db, 0, sizeof (*db));
606 if (strcasecmp ("URL", ci->key) == 0)
607 status = cf_util_get_string (ci, &db->url);
608 else if (strcasecmp ("Sock", ci->key) == 0)
609 status = cf_util_get_string (ci, &db->sock);
612 ERROR ("curl_json plugin: cj_config: "
613 "Invalid key: %s", ci->key);
622 /* Fill the `cj_t' structure.. */
623 for (i = 0; i < ci->children_num; i++)
625 oconfig_item_t *child = ci->children + i;
627 if (strcasecmp ("Instance", child->key) == 0)
628 status = cf_util_get_string (child, &db->instance);
629 else if (strcasecmp ("Host", child->key) == 0)
630 status = cf_util_get_string (child, &db->host);
631 else if (db->url && strcasecmp ("User", child->key) == 0)
632 status = cf_util_get_string (child, &db->user);
633 else if (db->url && strcasecmp ("Password", child->key) == 0)
634 status = cf_util_get_string (child, &db->pass);
635 else if (db->url && strcasecmp ("VerifyPeer", child->key) == 0)
636 status = cf_util_get_boolean (child, &db->verify_peer);
637 else if (db->url && strcasecmp ("VerifyHost", child->key) == 0)
638 status = cf_util_get_boolean (child, &db->verify_host);
639 else if (db->url && strcasecmp ("CACert", child->key) == 0)
640 status = cf_util_get_string (child, &db->cacert);
641 else if (db->url && strcasecmp ("Header", child->key) == 0)
642 status = cj_config_append_string ("Header", &db->headers, child);
643 else if (db->url && strcasecmp ("Post", child->key) == 0)
644 status = cf_util_get_string (child, &db->post_body);
645 else if (strcasecmp ("Key", child->key) == 0)
646 status = cj_config_add_key (db, child);
649 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
659 if (db->tree == NULL)
661 WARNING ("curl_json plugin: No (valid) `Key' block "
662 "within `%s' block `%s'.", db->url ? "URL" : "Sock", db->url ? db->url : db->sock);
665 if (status == 0 && db->url)
666 status = cj_init_curl (db);
669 /* If all went well, register this database for reading */
673 char cb_name[DATA_MAX_NAME_LEN];
675 if (db->instance == NULL)
676 db->instance = strdup("default");
678 DEBUG ("curl_json plugin: Registering new read callback: %s",
681 memset (&ud, 0, sizeof (ud));
682 ud.data = (void *) db;
683 ud.free_func = cj_free;
685 ssnprintf (cb_name, sizeof (cb_name), "curl_json-%s-%s",
686 db->instance, db->url ? db->url : db->sock);
688 plugin_register_complex_read (/* group = */ NULL, cb_name, cj_read,
689 /* interval = */ NULL, &ud);
699 /* }}} int cj_config_add_database */
701 static int cj_config (oconfig_item_t *ci) /* {{{ */
711 for (i = 0; i < ci->children_num; i++)
713 oconfig_item_t *child = ci->children + i;
715 if (strcasecmp ("Sock", child->key) == 0 || strcasecmp ("URL", child->key) == 0)
717 status = cj_config_add_url (child);
725 WARNING ("curl_json plugin: Option `%s' not allowed here.", child->key);
730 if ((success == 0) && (errors > 0))
732 ERROR ("curl_json plugin: All statements failed.");
737 } /* }}} int cj_config */
739 /* }}} End of configuration handling functions */
741 static void cj_submit (cj_t *db, cj_key_t *key, value_t *value) /* {{{ */
743 value_list_t vl = VALUE_LIST_INIT;
749 if ((db->host == NULL)
750 || (strcmp ("", db->host) == 0)
751 || (strcmp (CJ_DEFAULT_HOST, db->host) == 0))
756 if (key->instance == NULL)
758 if ((db->depth == 0) || (strcmp ("", db->state[db->depth-1].name) == 0))
759 sstrncpy (vl.type_instance, db->state[db->depth].name, sizeof (vl.type_instance));
761 ssnprintf (vl.type_instance, sizeof (vl.type_instance), "%s-%s",
762 db->state[db->depth-1].name, db->state[db->depth].name);
765 sstrncpy (vl.type_instance, key->instance, sizeof (vl.type_instance));
767 sstrncpy (vl.host, host, sizeof (vl.host));
768 sstrncpy (vl.plugin, "curl_json", sizeof (vl.plugin));
769 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
770 sstrncpy (vl.type, key->type, sizeof (vl.type));
772 plugin_dispatch_values (&vl);
773 } /* }}} int cj_submit */
775 static int cj_sock_perform (cj_t *db) /* {{{ */
777 struct sockaddr_un sa_unix = {};
778 sa_unix.sun_family = AF_UNIX;
779 sstrncpy (sa_unix.sun_path, db->sock, sizeof (sa_unix.sun_path));
781 int fd = socket (AF_UNIX, SOCK_STREAM, 0);
784 if (connect (fd, (struct sockaddr *)&sa_unix, sizeof(sa_unix)) < 0)
786 ERROR ("curl_json plugin: connect(%s) failed: %s",
787 (db->sock != NULL) ? db->sock : "<null>", strerror(errno));
794 unsigned char buffer[4096];
795 red = read (fd, buffer, sizeof(buffer));
797 ERROR ("curl_json plugin: read(%s) failed: %s",
798 (db->sock != NULL) ? db->sock : "<null>", strerror(errno));
802 if (!cj_curl_callback (buffer, red, 1, db))
807 } /* }}} int cj_sock_perform */
810 static int cj_curl_perform(cj_t *db) /* {{{ */
816 curl_easy_getinfo(db->curl, CURLINFO_EFFECTIVE_URL, &url);
818 status = curl_easy_perform (db->curl);
819 if (status != CURLE_OK)
821 ERROR ("curl_json plugin: curl_easy_perform failed with status %i: %s (%s)",
822 status, db->curl_errbuf, (url != NULL) ? url : "<null>");
826 curl_easy_getinfo(db->curl, CURLINFO_RESPONSE_CODE, &rc);
828 /* The response code is zero if a non-HTTP transport was used. */
829 if ((rc != 0) && (rc != 200))
831 ERROR ("curl_json plugin: curl_easy_perform failed with "
832 "response code %ld (%s)", rc, url);
836 } /* }}} int cj_curl_perform */
838 static int cj_perform (cj_t *db) /* {{{ */
841 yajl_handle yprev = db->yajl;
843 db->yajl = yajl_alloc (&ycallbacks,
845 /* alloc funcs = */ NULL,
847 /* alloc funcs = */ NULL, NULL,
849 /* context = */ (void *)db);
850 if (db->yajl == NULL)
852 ERROR ("curl_json plugin: yajl_alloc failed.");
857 if (db->url ? cj_curl_perform (db) < 0 : cj_sock_perform (db) < 0)
859 yajl_free (db->yajl);
865 status = yajl_complete_parse(db->yajl);
867 status = yajl_parse_complete(db->yajl);
869 if (status != yajl_status_ok)
871 unsigned char *errmsg;
873 errmsg = yajl_get_error (db->yajl, /* verbose = */ 0,
874 /* jsonText = */ NULL, /* jsonTextLen = */ 0);
875 ERROR ("curl_json plugin: yajl_parse_complete failed: %s",
877 yajl_free_error (db->yajl, errmsg);
878 yajl_free (db->yajl);
883 yajl_free (db->yajl);
886 } /* }}} int cj_perform */
888 static int cj_read (user_data_t *ud) /* {{{ */
892 if ((ud == NULL) || (ud->data == NULL))
894 ERROR ("curl_json plugin: cj_read: Invalid user data.");
898 db = (cj_t *) ud->data;
901 memset (&db->state, 0, sizeof(db->state));
902 db->state[db->depth].tree = db->tree;
905 return cj_perform (db);
906 } /* }}} int cj_read */
908 void module_register (void)
910 plugin_register_complex_config ("curl_json", cj_config);
911 } /* void module_register */
913 /* vim: set sw=2 sts=2 et fdm=marker : */