1 /**
2 * collectd - src/curl.c
3 * Copyright (C) 2006-2009 Florian octo Forster
4 * Copyright (C) 2009 Aman Gupta
5 *
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.
9 *
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.
14 *
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
18 *
19 * Authors:
20 * Florian octo Forster <octo at collectd.org>
21 * Aman Gupta <aman at tmm1.net>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
27 #include "configfile.h"
28 #include "utils_match.h"
29 #include "utils_time.h"
31 #include <curl/curl.h>
33 /*
34 * Data types
35 */
36 struct web_match_s;
37 typedef struct web_match_s web_match_t;
38 struct web_match_s /* {{{ */
39 {
40 char *regex;
41 char *exclude_regex;
42 int dstype;
43 char *type;
44 char *instance;
46 cu_match_t *match;
48 web_match_t *next;
49 }; /* }}} */
51 struct web_page_s;
52 typedef struct web_page_s web_page_t;
53 struct web_page_s /* {{{ */
54 {
55 char *instance;
57 char *url;
58 char *user;
59 char *pass;
60 char *credentials;
61 _Bool digest;
62 _Bool verify_peer;
63 _Bool verify_host;
64 char *cacert;
65 struct curl_slist *headers;
66 char *post_body;
67 _Bool response_time;
68 _Bool response_code;
69 int timeout;
71 CURL *curl;
72 char curl_errbuf[CURL_ERROR_SIZE];
73 char *buffer;
74 size_t buffer_size;
75 size_t buffer_fill;
77 web_match_t *matches;
79 web_page_t *next;
80 }; /* }}} */
82 /*
83 * Global variables;
84 */
85 /* static CURLM *curl = NULL; */
86 static web_page_t *pages_g = NULL;
88 /*
89 * Private functions
90 */
91 static size_t cc_curl_callback (void *buf, /* {{{ */
92 size_t size, size_t nmemb, void *user_data)
93 {
94 web_page_t *wp;
95 size_t len;
97 len = size * nmemb;
98 if (len <= 0)
99 return (len);
101 wp = user_data;
102 if (wp == NULL)
103 return (0);
105 if ((wp->buffer_fill + len) >= wp->buffer_size)
106 {
107 char *temp;
108 size_t temp_size;
110 temp_size = wp->buffer_fill + len + 1;
111 temp = (char *) realloc (wp->buffer, temp_size);
112 if (temp == NULL)
113 {
114 ERROR ("curl plugin: realloc failed.");
115 return (0);
116 }
117 wp->buffer = temp;
118 wp->buffer_size = temp_size;
119 }
121 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
122 wp->buffer_fill += len;
123 wp->buffer[wp->buffer_fill] = 0;
125 return (len);
126 } /* }}} size_t cc_curl_callback */
128 static void cc_web_match_free (web_match_t *wm) /* {{{ */
129 {
130 if (wm == NULL)
131 return;
133 sfree (wm->regex);
134 sfree (wm->type);
135 sfree (wm->instance);
136 match_destroy (wm->match);
137 cc_web_match_free (wm->next);
138 sfree (wm);
139 } /* }}} void cc_web_match_free */
141 static void cc_web_page_free (web_page_t *wp) /* {{{ */
142 {
143 if (wp == NULL)
144 return;
146 if (wp->curl != NULL)
147 curl_easy_cleanup (wp->curl);
148 wp->curl = NULL;
150 sfree (wp->instance);
152 sfree (wp->url);
153 sfree (wp->user);
154 sfree (wp->pass);
155 sfree (wp->credentials);
156 sfree (wp->cacert);
157 sfree (wp->post_body);
158 curl_slist_free_all (wp->headers);
160 sfree (wp->buffer);
162 cc_web_match_free (wp->matches);
163 cc_web_page_free (wp->next);
164 sfree (wp);
165 } /* }}} void cc_web_page_free */
167 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
168 oconfig_item_t *ci)
169 {
170 struct curl_slist *temp = NULL;
171 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
172 {
173 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
174 return (-1);
175 }
177 temp = curl_slist_append(*dest, ci->values[0].value.string);
178 if (temp == NULL)
179 return (-1);
181 *dest = temp;
183 return (0);
184 } /* }}} int cc_config_append_string */
186 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
187 oconfig_item_t *ci)
188 {
189 int dstype;
191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
192 {
193 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
194 return (-1);
195 }
197 if (strncasecmp ("Gauge", ci->values[0].value.string,
198 strlen ("Gauge")) == 0)
199 {
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;
209 else
210 dstype = 0;
211 }
212 else if (strncasecmp ("Counter", ci->values[0].value.string,
213 strlen ("Counter")) == 0)
214 {
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;
222 else
223 dstype = 0;
224 }
225 else if (strncasecmp ("Derive", ci->values[0].value.string,
226 strlen ("Derive")) == 0)
227 {
228 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
229 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
230 dstype |= UTILS_MATCH_CF_DERIVE_SET;
231 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
232 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
233 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
234 dstype |= UTILS_MATCH_CF_DERIVE_INC;
235 else
236 dstype = 0;
237 }
238 else if (strncasecmp ("Absolute", ci->values[0].value.string,
239 strlen ("Absolute")) == 0)
240 {
241 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
242 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
243 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
244 else
245 dstype = 0;
246 }
248 else
249 {
250 dstype = 0;
251 }
253 if (dstype == 0)
254 {
255 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
256 ci->values[0].value.string);
257 return (-1);
258 }
260 *dstype_ret = dstype;
261 return (0);
262 } /* }}} int cc_config_add_match_dstype */
264 static int cc_config_add_match (web_page_t *page, /* {{{ */
265 oconfig_item_t *ci)
266 {
267 web_match_t *match;
268 int status;
269 int i;
271 if (ci->values_num != 0)
272 {
273 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
274 }
276 match = calloc (1, sizeof (*match));
277 if (match == NULL)
278 {
279 ERROR ("curl plugin: calloc failed.");
280 return (-1);
281 }
283 status = 0;
284 for (i = 0; i < ci->children_num; i++)
285 {
286 oconfig_item_t *child = ci->children + i;
288 if (strcasecmp ("Regex", child->key) == 0)
289 status = cf_util_get_string (child, &match->regex);
290 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
291 status = cf_util_get_string (child, &match->exclude_regex);
292 else if (strcasecmp ("DSType", child->key) == 0)
293 status = cc_config_add_match_dstype (&match->dstype, child);
294 else if (strcasecmp ("Type", child->key) == 0)
295 status = cf_util_get_string (child, &match->type);
296 else if (strcasecmp ("Instance", child->key) == 0)
297 status = cf_util_get_string (child, &match->instance);
298 else
299 {
300 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
301 status = -1;
302 }
304 if (status != 0)
305 break;
306 } /* for (i = 0; i < ci->children_num; i++) */
308 while (status == 0)
309 {
310 if (match->regex == NULL)
311 {
312 WARNING ("curl plugin: `Regex' missing in `Match' block.");
313 status = -1;
314 }
316 if (match->type == NULL)
317 {
318 WARNING ("curl plugin: `Type' missing in `Match' block.");
319 status = -1;
320 }
322 if (match->dstype == 0)
323 {
324 WARNING ("curl plugin: `DSType' missing in `Match' block.");
325 status = -1;
326 }
328 break;
329 } /* while (status == 0) */
331 if (status != 0)
332 {
333 cc_web_match_free (match);
334 return (status);
335 }
337 match->match = match_create_simple (match->regex, match->exclude_regex,
338 match->dstype);
339 if (match->match == NULL)
340 {
341 ERROR ("curl plugin: tail_match_add_match_simple failed.");
342 cc_web_match_free (match);
343 return (-1);
344 }
345 else
346 {
347 web_match_t *prev;
349 prev = page->matches;
350 while ((prev != NULL) && (prev->next != NULL))
351 prev = prev->next;
353 if (prev == NULL)
354 page->matches = match;
355 else
356 prev->next = match;
357 }
359 return (0);
360 } /* }}} int cc_config_add_match */
362 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
363 {
364 wp->curl = curl_easy_init ();
365 if (wp->curl == NULL)
366 {
367 ERROR ("curl plugin: curl_easy_init failed.");
368 return (-1);
369 }
371 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
372 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
373 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
374 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
375 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
376 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
377 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
378 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
380 if (wp->user != NULL)
381 {
382 #ifdef HAVE_CURLOPT_USERNAME
383 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
384 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
385 (wp->pass == NULL) ? "" : wp->pass);
386 #else
387 size_t credentials_size;
389 credentials_size = strlen (wp->user) + 2;
390 if (wp->pass != NULL)
391 credentials_size += strlen (wp->pass);
393 wp->credentials = malloc (credentials_size);
394 if (wp->credentials == NULL)
395 {
396 ERROR ("curl plugin: malloc failed.");
397 return (-1);
398 }
400 ssnprintf (wp->credentials, credentials_size, "%s:%s",
401 wp->user, (wp->pass == NULL) ? "" : wp->pass);
402 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
403 #endif
405 if (wp->digest)
406 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
407 }
409 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
410 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
411 wp->verify_host ? 2L : 0L);
412 if (wp->cacert != NULL)
413 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
414 if (wp->headers != NULL)
415 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
416 if (wp->post_body != NULL)
417 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
419 #ifdef HAVE_CURLOPT_TIMEOUT_MS
420 if (wp->timeout >= 0)
421 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
422 else
423 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
424 #endif
426 return (0);
427 } /* }}} int cc_page_init_curl */
429 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
430 {
431 web_page_t *page;
432 int status;
433 int i;
435 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
436 {
437 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
438 return (-1);
439 }
441 page = calloc (1, sizeof (*page));
442 if (page == NULL)
443 {
444 ERROR ("curl plugin: calloc failed.");
445 return (-1);
446 }
447 page->url = NULL;
448 page->user = NULL;
449 page->pass = NULL;
450 page->digest = 0;
451 page->verify_peer = 1;
452 page->verify_host = 1;
453 page->response_time = 0;
454 page->response_code = 0;
455 page->timeout = -1;
457 page->instance = strdup (ci->values[0].value.string);
458 if (page->instance == NULL)
459 {
460 ERROR ("curl plugin: strdup failed.");
461 sfree (page);
462 return (-1);
463 }
465 /* Process all children */
466 status = 0;
467 for (i = 0; i < ci->children_num; i++)
468 {
469 oconfig_item_t *child = ci->children + i;
471 if (strcasecmp ("URL", child->key) == 0)
472 status = cf_util_get_string (child, &page->url);
473 else if (strcasecmp ("User", child->key) == 0)
474 status = cf_util_get_string (child, &page->user);
475 else if (strcasecmp ("Password", child->key) == 0)
476 status = cf_util_get_string (child, &page->pass);
477 else if (strcasecmp ("Digest", child->key) == 0)
478 status = cf_util_get_boolean (child, &page->digest);
479 else if (strcasecmp ("VerifyPeer", child->key) == 0)
480 status = cf_util_get_boolean (child, &page->verify_peer);
481 else if (strcasecmp ("VerifyHost", child->key) == 0)
482 status = cf_util_get_boolean (child, &page->verify_host);
483 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
484 status = cf_util_get_boolean (child, &page->response_time);
485 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
486 status = cf_util_get_boolean (child, &page->response_code);
487 else if (strcasecmp ("CACert", child->key) == 0)
488 status = cf_util_get_string (child, &page->cacert);
489 else if (strcasecmp ("Match", child->key) == 0)
490 /* Be liberal with failing matches => don't set `status'. */
491 cc_config_add_match (page, child);
492 else if (strcasecmp ("Header", child->key) == 0)
493 status = cc_config_append_string ("Header", &page->headers, child);
494 else if (strcasecmp ("Post", child->key) == 0)
495 status = cf_util_get_string (child, &page->post_body);
496 else if (strcasecmp ("Timeout", child->key) == 0)
497 status = cf_util_get_int (child, &page->timeout);
498 else
499 {
500 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
501 status = -1;
502 }
504 if (status != 0)
505 break;
506 } /* for (i = 0; i < ci->children_num; i++) */
508 /* Additionial sanity checks and libCURL initialization. */
509 while (status == 0)
510 {
511 if (page->url == NULL)
512 {
513 WARNING ("curl plugin: `URL' missing in `Page' block.");
514 status = -1;
515 }
517 if (page->matches == NULL && !page->response_time && !page->response_code)
518 {
519 assert (page->instance != NULL);
520 WARNING ("curl plugin: No (valid) `Match' block "
521 "or MeasureResponseTime or MeasureResponseCode within "
522 "`Page' block `%s'.", page->instance);
523 status = -1;
524 }
526 if (status == 0)
527 status = cc_page_init_curl (page);
529 break;
530 } /* while (status == 0) */
532 if (status != 0)
533 {
534 cc_web_page_free (page);
535 return (status);
536 }
538 /* Add the new page to the linked list */
539 if (pages_g == NULL)
540 pages_g = page;
541 else
542 {
543 web_page_t *prev;
545 prev = pages_g;
546 while ((prev != NULL) && (prev->next != NULL))
547 prev = prev->next;
548 prev->next = page;
549 }
551 return (0);
552 } /* }}} int cc_config_add_page */
554 static int cc_config (oconfig_item_t *ci) /* {{{ */
555 {
556 int success;
557 int errors;
558 int status;
559 int i;
561 success = 0;
562 errors = 0;
564 for (i = 0; i < ci->children_num; i++)
565 {
566 oconfig_item_t *child = ci->children + i;
568 if (strcasecmp ("Page", child->key) == 0)
569 {
570 status = cc_config_add_page (child);
571 if (status == 0)
572 success++;
573 else
574 errors++;
575 }
576 else
577 {
578 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
579 errors++;
580 }
581 }
583 if ((success == 0) && (errors > 0))
584 {
585 ERROR ("curl plugin: All statements failed.");
586 return (-1);
587 }
589 return (0);
590 } /* }}} int cc_config */
592 static int cc_init (void) /* {{{ */
593 {
594 if (pages_g == NULL)
595 {
596 INFO ("curl plugin: No pages have been defined.");
597 return (-1);
598 }
599 curl_global_init (CURL_GLOBAL_SSL);
600 return (0);
601 } /* }}} int cc_init */
603 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
604 const cu_match_value_t *mv)
605 {
606 value_t values[1];
607 value_list_t vl = VALUE_LIST_INIT;
609 values[0] = mv->value;
611 vl.values = values;
612 vl.values_len = 1;
613 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
614 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
615 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
616 sstrncpy (vl.type, wm->type, sizeof (vl.type));
617 if (wm->instance != NULL)
618 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
620 plugin_dispatch_values (&vl);
621 } /* }}} void cc_submit */
623 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
624 {
625 value_t values[1];
626 value_list_t vl = VALUE_LIST_INIT;
628 values[0].gauge = code;
630 vl.values = values;
631 vl.values_len = 1;
632 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
633 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
634 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
635 sstrncpy (vl.type, "response_code", sizeof (vl.type));
637 plugin_dispatch_values (&vl);
638 } /* }}} void cc_submit_response_code */
640 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
641 cdtime_t response_time)
642 {
643 value_t values[1];
644 value_list_t vl = VALUE_LIST_INIT;
646 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
648 vl.values = values;
649 vl.values_len = 1;
650 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
651 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
652 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
653 sstrncpy (vl.type, "response_time", sizeof (vl.type));
655 plugin_dispatch_values (&vl);
656 } /* }}} void cc_submit_response_time */
658 static int cc_read_page (web_page_t *wp) /* {{{ */
659 {
660 web_match_t *wm;
661 int status;
662 cdtime_t start = 0;
664 if (wp->response_time)
665 start = cdtime ();
667 wp->buffer_fill = 0;
668 status = curl_easy_perform (wp->curl);
669 if (status != CURLE_OK)
670 {
671 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
672 status, wp->curl_errbuf);
673 return (-1);
674 }
676 if (wp->response_time)
677 cc_submit_response_time (wp, cdtime() - start);
679 if(wp->response_code)
680 {
681 long response_code = 0;
682 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
683 if(status != CURLE_OK) {
684 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
685 status, wp->curl_errbuf);
686 } else {
687 cc_submit_response_code(wp, response_code);
688 }
689 }
691 for (wm = wp->matches; wm != NULL; wm = wm->next)
692 {
693 cu_match_value_t *mv;
695 status = match_apply (wm->match, wp->buffer);
696 if (status != 0)
697 {
698 WARNING ("curl plugin: match_apply failed.");
699 continue;
700 }
702 mv = match_get_user_data (wm->match);
703 if (mv == NULL)
704 {
705 WARNING ("curl plugin: match_get_user_data returned NULL.");
706 continue;
707 }
709 cc_submit (wp, wm, mv);
710 match_value_reset (mv);
711 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
713 return (0);
714 } /* }}} int cc_read_page */
716 static int cc_read (void) /* {{{ */
717 {
718 web_page_t *wp;
720 for (wp = pages_g; wp != NULL; wp = wp->next)
721 cc_read_page (wp);
723 return (0);
724 } /* }}} int cc_read */
726 static int cc_shutdown (void) /* {{{ */
727 {
728 cc_web_page_free (pages_g);
729 pages_g = NULL;
731 return (0);
732 } /* }}} int cc_shutdown */
734 void module_register (void)
735 {
736 plugin_register_complex_config ("curl", cc_config);
737 plugin_register_init ("curl", cc_init);
738 plugin_register_read ("curl", cc_read);
739 plugin_register_shutdown ("curl", cc_shutdown);
740 } /* void module_register */
742 /* vim: set sw=2 sts=2 et fdm=marker : */