2 * collectd - src/curl.c
3 * Copyright (C) 2006-2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
26 #include "utils_match.h"
28 #include <curl/curl.h>
34 typedef struct web_match_s web_match_t;
35 struct web_match_s /* {{{ */
48 typedef struct web_page_s web_page_t;
49 struct web_page_s /* {{{ */
62 char curl_errbuf[CURL_ERROR_SIZE];
75 /* static CURLM *curl = NULL; */
76 static web_page_t *pages_g = NULL;
81 static size_t cc_curl_callback (void *buf, /* {{{ */
82 size_t size, size_t nmemb, void *user_data)
95 if ((wp->buffer_fill + len) >= wp->buffer_size)
100 temp_size = wp->buffer_fill + len + 1;
101 temp = (char *) realloc (wp->buffer, temp_size);
104 ERROR ("curl plugin: realloc failed.");
108 wp->buffer_size = temp_size;
111 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
112 wp->buffer_fill += len;
113 wp->buffer[wp->buffer_fill] = 0;
116 } /* }}} size_t cc_curl_callback */
118 static void cc_web_match_free (web_match_t *wm) /* {{{ */
125 sfree (wm->instance);
126 match_destroy (wm->match);
127 cc_web_match_free (wm->next);
129 } /* }}} void cc_web_match_free */
131 static void cc_web_page_free (web_page_t *wp) /* {{{ */
136 if (wp->curl != NULL)
137 curl_easy_cleanup (wp->curl);
140 sfree (wp->instance);
145 sfree (wp->credentials);
150 cc_web_match_free (wp->matches);
151 cc_web_page_free (wp->next);
153 } /* }}} void cc_web_page_free */
155 static int cc_config_add_string (const char *name, char **dest, /* {{{ */
158 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
160 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
165 *dest = strdup (ci->values[0].value.string);
170 } /* }}} int cc_config_add_string */
172 static int cc_config_set_boolean (const char *name, int *dest, /* {{{ */
175 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
177 WARNING ("curl plugin: `%s' needs exactly one boolean argument.", name);
181 *dest = ci->values[0].value.boolean ? 1 : 0;
184 } /* }}} int cc_config_set_boolean */
186 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
193 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
197 if (strncasecmp ("Gauge", ci->values[0].value.string,
198 strlen ("Gauge")) == 0)
200 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
201 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
202 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
203 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
204 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
205 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
206 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
207 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
208 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
212 else if (strncasecmp ("Counter", ci->values[0].value.string,
213 strlen ("Counter")) == 0)
215 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
216 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
217 dstype |= UTILS_MATCH_CF_COUNTER_SET;
218 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
219 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
220 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
221 dstype |= UTILS_MATCH_CF_COUNTER_INC;
232 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
233 ci->values[0].value.string);
237 *dstype_ret = dstype;
239 } /* }}} int cc_config_add_match_dstype */
241 static int cc_config_add_match (web_page_t *page, /* {{{ */
248 if (ci->values_num != 0)
250 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
253 match = (web_match_t *) malloc (sizeof (*match));
256 ERROR ("curl plugin: malloc failed.");
259 memset (match, 0, sizeof (*match));
262 for (i = 0; i < ci->children_num; i++)
264 oconfig_item_t *child = ci->children + i;
266 if (strcasecmp ("Regex", child->key) == 0)
267 status = cc_config_add_string ("Regex", &match->regex, child);
268 else if (strcasecmp ("DSType", child->key) == 0)
269 status = cc_config_add_match_dstype (&match->dstype, child);
270 else if (strcasecmp ("Type", child->key) == 0)
271 status = cc_config_add_string ("Type", &match->type, child);
272 else if (strcasecmp ("Instance", child->key) == 0)
273 status = cc_config_add_string ("Instance", &match->instance, child);
276 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
282 } /* for (i = 0; i < ci->children_num; i++) */
286 if (match->regex == NULL)
288 WARNING ("curl plugin: `Regex' missing in `Match' block.");
292 if (match->type == NULL)
294 WARNING ("curl plugin: `Type' missing in `Match' block.");
298 if (match->dstype == 0)
300 WARNING ("curl plugin: `DSType' missing in `Match' block.");
305 } /* while (status == 0) */
310 match->match = match_create_simple (match->regex, match->dstype);
311 if (match->match == NULL)
313 ERROR ("curl plugin: tail_match_add_match_simple failed.");
314 cc_web_match_free (match);
321 prev = page->matches;
322 while ((prev != NULL) && (prev->next != NULL))
326 page->matches = match;
332 } /* }}} int cc_config_add_match */
334 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
336 wp->curl = curl_easy_init ();
337 if (wp->curl == NULL)
339 ERROR ("curl plugin: curl_easy_init failed.");
343 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
344 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
345 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
346 PACKAGE_NAME"/"PACKAGE_VERSION);
347 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
348 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
349 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1);
351 if (wp->user != NULL)
353 size_t credentials_size;
355 credentials_size = strlen (wp->user) + 2;
356 if (wp->pass != NULL)
357 credentials_size += strlen (wp->pass);
359 wp->credentials = (char *) malloc (credentials_size);
360 if (wp->credentials == NULL)
362 ERROR ("curl plugin: malloc failed.");
366 ssnprintf (wp->credentials, credentials_size, "%s:%s",
367 wp->user, (wp->pass == NULL) ? "" : wp->pass);
368 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
371 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, wp->verify_peer);
372 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
373 wp->verify_host ? 2 : 0);
374 if (wp->cacert != NULL)
375 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
378 } /* }}} int cc_page_init_curl */
380 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
386 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
388 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
392 page = (web_page_t *) malloc (sizeof (*page));
395 ERROR ("curl plugin: malloc failed.");
398 memset (page, 0, sizeof (*page));
402 page->verify_peer = 1;
403 page->verify_host = 1;
405 page->instance = strdup (ci->values[0].value.string);
406 if (page->instance == NULL)
408 ERROR ("curl plugin: strdup failed.");
413 /* Process all children */
415 for (i = 0; i < ci->children_num; i++)
417 oconfig_item_t *child = ci->children + i;
419 if (strcasecmp ("URL", child->key) == 0)
420 status = cc_config_add_string ("URL", &page->url, child);
421 else if (strcasecmp ("User", child->key) == 0)
422 status = cc_config_add_string ("User", &page->user, child);
423 else if (strcasecmp ("Password", child->key) == 0)
424 status = cc_config_add_string ("Password", &page->pass, child);
425 else if (strcasecmp ("VerifyPeer", child->key) == 0)
426 status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
427 else if (strcasecmp ("VerifyHost", child->key) == 0)
428 status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
429 else if (strcasecmp ("CACert", child->key) == 0)
430 status = cc_config_add_string ("CACert", &page->cacert, child);
431 else if (strcasecmp ("Match", child->key) == 0)
432 /* Be liberal with failing matches => don't set `status'. */
433 cc_config_add_match (page, child);
436 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
442 } /* for (i = 0; i < ci->children_num; i++) */
444 /* Additionial sanity checks and libCURL initialization. */
447 if (page->url == NULL)
449 WARNING ("curl plugin: `URL' missing in `Page' block.");
453 if (page->matches == NULL)
455 assert (page->instance != NULL);
456 WARNING ("curl plugin: No (valid) `Match' block "
457 "within `Page' block `%s'.", page->instance);
462 status = cc_page_init_curl (page);
465 } /* while (status == 0) */
469 cc_web_page_free (page);
473 /* Add the new page to the linked list */
481 while ((prev != NULL) && (prev->next != NULL))
487 } /* }}} int cc_config_add_page */
489 static int cc_config (oconfig_item_t *ci) /* {{{ */
499 for (i = 0; i < ci->children_num; i++)
501 oconfig_item_t *child = ci->children + i;
503 if (strcasecmp ("Page", child->key) == 0)
505 status = cc_config_add_page (child);
513 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
518 if ((success == 0) && (errors > 0))
520 ERROR ("curl plugin: All statements failed.");
525 } /* }}} int cc_config */
527 static int cc_init (void) /* {{{ */
531 INFO ("curl plugin: No pages have been defined.");
535 } /* }}} int cc_init */
537 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
538 const cu_match_value_t *mv)
541 value_list_t vl = VALUE_LIST_INIT;
543 values[0] = mv->value;
547 vl.time = time (NULL);
548 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
549 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
550 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
551 sstrncpy (vl.type, wm->type, sizeof (vl.type));
552 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
554 plugin_dispatch_values (&vl);
555 } /* }}} void cc_submit */
557 static int cc_read_page (web_page_t *wp) /* {{{ */
563 status = curl_easy_perform (wp->curl);
566 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
567 status, wp->curl_errbuf);
571 for (wm = wp->matches; wm != NULL; wm = wm->next)
573 cu_match_value_t *mv;
575 status = match_apply (wm->match, wp->buffer);
578 WARNING ("curl plugin: match_apply failed.");
582 mv = match_get_user_data (wm->match);
585 WARNING ("curl plugin: match_get_user_data returned NULL.");
589 cc_submit (wp, wm, mv);
590 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
593 } /* }}} int cc_read_page */
595 static int cc_read (void) /* {{{ */
599 for (wp = pages_g; wp != NULL; wp = wp->next)
603 } /* }}} int cc_read */
605 static int cc_shutdown (void) /* {{{ */
607 cc_web_page_free (pages_g);
611 } /* }}} int cc_shutdown */
613 void module_register (void)
615 plugin_register_complex_config ("curl", cc_config);
616 plugin_register_init ("curl", cc_init);
617 plugin_register_read ("curl", cc_read);
618 plugin_register_shutdown ("curl", cc_shutdown);
619 } /* void module_register */
621 /* vim: set sw=2 sts=2 et fdm=marker : */