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 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
171 {
172 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
173 return (-1);
174 }
176 *dest = curl_slist_append(*dest, ci->values[0].value.string);
177 if (*dest == NULL)
178 return (-1);
180 return (0);
181 } /* }}} int cc_config_append_string */
183 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
184 oconfig_item_t *ci)
185 {
186 int dstype;
188 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
189 {
190 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
191 return (-1);
192 }
194 if (strncasecmp ("Gauge", ci->values[0].value.string,
195 strlen ("Gauge")) == 0)
196 {
197 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
198 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
199 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
200 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
201 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
202 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
203 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
204 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
205 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
206 else
207 dstype = 0;
208 }
209 else if (strncasecmp ("Counter", ci->values[0].value.string,
210 strlen ("Counter")) == 0)
211 {
212 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
213 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
214 dstype |= UTILS_MATCH_CF_COUNTER_SET;
215 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
216 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
217 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
218 dstype |= UTILS_MATCH_CF_COUNTER_INC;
219 else
220 dstype = 0;
221 }
222 else if (strncasecmp ("Derive", ci->values[0].value.string,
223 strlen ("Derive")) == 0)
224 {
225 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
226 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
227 dstype |= UTILS_MATCH_CF_DERIVE_SET;
228 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
229 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
230 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
231 dstype |= UTILS_MATCH_CF_DERIVE_INC;
232 else
233 dstype = 0;
234 }
235 else if (strncasecmp ("Absolute", ci->values[0].value.string,
236 strlen ("Absolute")) == 0)
237 {
238 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
239 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
240 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
241 else
242 dstype = 0;
243 }
245 else
246 {
247 dstype = 0;
248 }
250 if (dstype == 0)
251 {
252 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
253 ci->values[0].value.string);
254 return (-1);
255 }
257 *dstype_ret = dstype;
258 return (0);
259 } /* }}} int cc_config_add_match_dstype */
261 static int cc_config_add_match (web_page_t *page, /* {{{ */
262 oconfig_item_t *ci)
263 {
264 web_match_t *match;
265 int status;
266 int i;
268 if (ci->values_num != 0)
269 {
270 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
271 }
273 match = (web_match_t *) malloc (sizeof (*match));
274 if (match == NULL)
275 {
276 ERROR ("curl plugin: malloc failed.");
277 return (-1);
278 }
279 memset (match, 0, sizeof (*match));
281 status = 0;
282 for (i = 0; i < ci->children_num; i++)
283 {
284 oconfig_item_t *child = ci->children + i;
286 if (strcasecmp ("Regex", child->key) == 0)
287 status = cf_util_get_string (child, &match->regex);
288 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
289 status = cf_util_get_string (child, &match->exclude_regex);
290 else if (strcasecmp ("DSType", child->key) == 0)
291 status = cc_config_add_match_dstype (&match->dstype, child);
292 else if (strcasecmp ("Type", child->key) == 0)
293 status = cf_util_get_string (child, &match->type);
294 else if (strcasecmp ("Instance", child->key) == 0)
295 status = cf_util_get_string (child, &match->instance);
296 else
297 {
298 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
299 status = -1;
300 }
302 if (status != 0)
303 break;
304 } /* for (i = 0; i < ci->children_num; i++) */
306 while (status == 0)
307 {
308 if (match->regex == NULL)
309 {
310 WARNING ("curl plugin: `Regex' missing in `Match' block.");
311 status = -1;
312 }
314 if (match->type == NULL)
315 {
316 WARNING ("curl plugin: `Type' missing in `Match' block.");
317 status = -1;
318 }
320 if (match->dstype == 0)
321 {
322 WARNING ("curl plugin: `DSType' missing in `Match' block.");
323 status = -1;
324 }
326 break;
327 } /* while (status == 0) */
329 if (status != 0)
330 return (status);
332 match->match = match_create_simple (match->regex, match->exclude_regex,
333 match->dstype);
334 if (match->match == NULL)
335 {
336 ERROR ("curl plugin: tail_match_add_match_simple failed.");
337 cc_web_match_free (match);
338 return (-1);
339 }
340 else
341 {
342 web_match_t *prev;
344 prev = page->matches;
345 while ((prev != NULL) && (prev->next != NULL))
346 prev = prev->next;
348 if (prev == NULL)
349 page->matches = match;
350 else
351 prev->next = match;
352 }
354 return (0);
355 } /* }}} int cc_config_add_match */
357 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
358 {
359 wp->curl = curl_easy_init ();
360 if (wp->curl == NULL)
361 {
362 ERROR ("curl plugin: curl_easy_init failed.");
363 return (-1);
364 }
366 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
367 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
368 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
369 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
370 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
371 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
372 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
373 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
375 if (wp->user != NULL)
376 {
377 #ifdef HAVE_CURLOPT_USERNAME
378 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
379 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
380 (wp->pass == NULL) ? "" : wp->pass);
381 #else
382 size_t credentials_size;
384 credentials_size = strlen (wp->user) + 2;
385 if (wp->pass != NULL)
386 credentials_size += strlen (wp->pass);
388 wp->credentials = (char *) malloc (credentials_size);
389 if (wp->credentials == NULL)
390 {
391 ERROR ("curl plugin: malloc failed.");
392 return (-1);
393 }
395 ssnprintf (wp->credentials, credentials_size, "%s:%s",
396 wp->user, (wp->pass == NULL) ? "" : wp->pass);
397 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
398 #endif
400 if (wp->digest)
401 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
402 }
404 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
405 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
406 wp->verify_host ? 2L : 0L);
407 if (wp->cacert != NULL)
408 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
409 if (wp->headers != NULL)
410 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
411 if (wp->post_body != NULL)
412 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
414 #ifdef HAVE_CURLOPT_TIMEOUT_MS
415 if (wp->timeout >= 0)
416 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
417 else
418 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS,
419 CDTIME_T_TO_MS(plugin_get_interval()));
420 #endif
422 return (0);
423 } /* }}} int cc_page_init_curl */
425 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
426 {
427 web_page_t *page;
428 int status;
429 int i;
431 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
432 {
433 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
434 return (-1);
435 }
437 page = (web_page_t *) malloc (sizeof (*page));
438 if (page == NULL)
439 {
440 ERROR ("curl plugin: malloc failed.");
441 return (-1);
442 }
443 memset (page, 0, sizeof (*page));
444 page->url = NULL;
445 page->user = NULL;
446 page->pass = NULL;
447 page->digest = 0;
448 page->verify_peer = 1;
449 page->verify_host = 1;
450 page->response_time = 0;
451 page->response_code = 0;
452 page->timeout = -1;
454 page->instance = strdup (ci->values[0].value.string);
455 if (page->instance == NULL)
456 {
457 ERROR ("curl plugin: strdup failed.");
458 sfree (page);
459 return (-1);
460 }
462 /* Process all children */
463 status = 0;
464 for (i = 0; i < ci->children_num; i++)
465 {
466 oconfig_item_t *child = ci->children + i;
468 if (strcasecmp ("URL", child->key) == 0)
469 status = cf_util_get_string (child, &page->url);
470 else if (strcasecmp ("User", child->key) == 0)
471 status = cf_util_get_string (child, &page->user);
472 else if (strcasecmp ("Password", child->key) == 0)
473 status = cf_util_get_string (child, &page->pass);
474 else if (strcasecmp ("Digest", child->key) == 0)
475 status = cf_util_get_boolean (child, &page->digest);
476 else if (strcasecmp ("VerifyPeer", child->key) == 0)
477 status = cf_util_get_boolean (child, &page->verify_peer);
478 else if (strcasecmp ("VerifyHost", child->key) == 0)
479 status = cf_util_get_boolean (child, &page->verify_host);
480 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
481 status = cf_util_get_boolean (child, &page->response_time);
482 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
483 status = cf_util_get_boolean (child, &page->response_code);
484 else if (strcasecmp ("CACert", child->key) == 0)
485 status = cf_util_get_string (child, &page->cacert);
486 else if (strcasecmp ("Match", child->key) == 0)
487 /* Be liberal with failing matches => don't set `status'. */
488 cc_config_add_match (page, child);
489 else if (strcasecmp ("Header", child->key) == 0)
490 status = cc_config_append_string ("Header", &page->headers, child);
491 else if (strcasecmp ("Post", child->key) == 0)
492 status = cf_util_get_string (child, &page->post_body);
493 else if (strcasecmp ("Timeout", child->key) == 0)
494 status = cf_util_get_int (child, &page->timeout);
495 else
496 {
497 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
498 status = -1;
499 }
501 if (status != 0)
502 break;
503 } /* for (i = 0; i < ci->children_num; i++) */
505 /* Additionial sanity checks and libCURL initialization. */
506 while (status == 0)
507 {
508 if (page->url == NULL)
509 {
510 WARNING ("curl plugin: `URL' missing in `Page' block.");
511 status = -1;
512 }
514 if (page->matches == NULL && !page->response_time && !page->response_code)
515 {
516 assert (page->instance != NULL);
517 WARNING ("curl plugin: No (valid) `Match' block "
518 "or MeasureResponseTime or MeasureResponseCode within "
519 "`Page' block `%s'.", page->instance);
520 status = -1;
521 }
523 if (status == 0)
524 status = cc_page_init_curl (page);
526 break;
527 } /* while (status == 0) */
529 if (status != 0)
530 {
531 cc_web_page_free (page);
532 return (status);
533 }
535 /* Add the new page to the linked list */
536 if (pages_g == NULL)
537 pages_g = page;
538 else
539 {
540 web_page_t *prev;
542 prev = pages_g;
543 while ((prev != NULL) && (prev->next != NULL))
544 prev = prev->next;
545 prev->next = page;
546 }
548 return (0);
549 } /* }}} int cc_config_add_page */
551 static int cc_config (oconfig_item_t *ci) /* {{{ */
552 {
553 int success;
554 int errors;
555 int status;
556 int i;
558 success = 0;
559 errors = 0;
561 for (i = 0; i < ci->children_num; i++)
562 {
563 oconfig_item_t *child = ci->children + i;
565 if (strcasecmp ("Page", child->key) == 0)
566 {
567 status = cc_config_add_page (child);
568 if (status == 0)
569 success++;
570 else
571 errors++;
572 }
573 else
574 {
575 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
576 errors++;
577 }
578 }
580 if ((success == 0) && (errors > 0))
581 {
582 ERROR ("curl plugin: All statements failed.");
583 return (-1);
584 }
586 return (0);
587 } /* }}} int cc_config */
589 static int cc_init (void) /* {{{ */
590 {
591 if (pages_g == NULL)
592 {
593 INFO ("curl plugin: No pages have been defined.");
594 return (-1);
595 }
596 curl_global_init (CURL_GLOBAL_SSL);
597 return (0);
598 } /* }}} int cc_init */
600 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
601 const cu_match_value_t *mv)
602 {
603 value_t values[1];
604 value_list_t vl = VALUE_LIST_INIT;
606 values[0] = mv->value;
608 vl.values = values;
609 vl.values_len = 1;
610 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
611 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
612 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
613 sstrncpy (vl.type, wm->type, sizeof (vl.type));
614 if (wm->instance != NULL)
615 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
617 plugin_dispatch_values (&vl);
618 } /* }}} void cc_submit */
620 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
621 {
622 value_t values[1];
623 value_list_t vl = VALUE_LIST_INIT;
625 values[0].gauge = code;
627 vl.values = values;
628 vl.values_len = 1;
629 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
630 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
631 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
632 sstrncpy (vl.type, "response_code", sizeof (vl.type));
634 plugin_dispatch_values (&vl);
635 } /* }}} void cc_submit_response_code */
637 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
638 cdtime_t response_time)
639 {
640 value_t values[1];
641 value_list_t vl = VALUE_LIST_INIT;
643 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
645 vl.values = values;
646 vl.values_len = 1;
647 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
648 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
649 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
650 sstrncpy (vl.type, "response_time", sizeof (vl.type));
652 plugin_dispatch_values (&vl);
653 } /* }}} void cc_submit_response_time */
655 static int cc_read_page (web_page_t *wp) /* {{{ */
656 {
657 web_match_t *wm;
658 int status;
659 cdtime_t start = 0;
661 if (wp->response_time)
662 start = cdtime ();
664 wp->buffer_fill = 0;
665 status = curl_easy_perform (wp->curl);
666 if (status != CURLE_OK)
667 {
668 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
669 status, wp->curl_errbuf);
670 return (-1);
671 }
673 if (wp->response_time)
674 cc_submit_response_time (wp, cdtime() - start);
676 if(wp->response_code)
677 {
678 long response_code = 0;
679 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
680 if(status != CURLE_OK) {
681 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
682 status, wp->curl_errbuf);
683 } else {
684 cc_submit_response_code(wp, response_code);
685 }
686 }
688 for (wm = wp->matches; wm != NULL; wm = wm->next)
689 {
690 cu_match_value_t *mv;
692 status = match_apply (wm->match, wp->buffer);
693 if (status != 0)
694 {
695 WARNING ("curl plugin: match_apply failed.");
696 continue;
697 }
699 mv = match_get_user_data (wm->match);
700 if (mv == NULL)
701 {
702 WARNING ("curl plugin: match_get_user_data returned NULL.");
703 continue;
704 }
706 cc_submit (wp, wm, mv);
707 match_value_reset (mv);
708 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
710 return (0);
711 } /* }}} int cc_read_page */
713 static int cc_read (void) /* {{{ */
714 {
715 web_page_t *wp;
717 for (wp = pages_g; wp != NULL; wp = wp->next)
718 cc_read_page (wp);
720 return (0);
721 } /* }}} int cc_read */
723 static int cc_shutdown (void) /* {{{ */
724 {
725 cc_web_page_free (pages_g);
726 pages_g = NULL;
728 return (0);
729 } /* }}} int cc_shutdown */
731 void module_register (void)
732 {
733 plugin_register_complex_config ("curl", cc_config);
734 plugin_register_init ("curl", cc_init);
735 plugin_register_read ("curl", cc_read);
736 plugin_register_shutdown ("curl", cc_shutdown);
737 } /* void module_register */
739 /* vim: set sw=2 sts=2 et fdm=marker : */