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 = (web_match_t *) malloc (sizeof (*match));
277 if (match == NULL)
278 {
279 ERROR ("curl plugin: malloc failed.");
280 return (-1);
281 }
282 memset (match, 0, sizeof (*match));
284 status = 0;
285 for (i = 0; i < ci->children_num; i++)
286 {
287 oconfig_item_t *child = ci->children + i;
289 if (strcasecmp ("Regex", child->key) == 0)
290 status = cf_util_get_string (child, &match->regex);
291 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
292 status = cf_util_get_string (child, &match->exclude_regex);
293 else if (strcasecmp ("DSType", child->key) == 0)
294 status = cc_config_add_match_dstype (&match->dstype, child);
295 else if (strcasecmp ("Type", child->key) == 0)
296 status = cf_util_get_string (child, &match->type);
297 else if (strcasecmp ("Instance", child->key) == 0)
298 status = cf_util_get_string (child, &match->instance);
299 else
300 {
301 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
302 status = -1;
303 }
305 if (status != 0)
306 break;
307 } /* for (i = 0; i < ci->children_num; i++) */
309 while (status == 0)
310 {
311 if (match->regex == NULL)
312 {
313 WARNING ("curl plugin: `Regex' missing in `Match' block.");
314 status = -1;
315 }
317 if (match->type == NULL)
318 {
319 WARNING ("curl plugin: `Type' missing in `Match' block.");
320 status = -1;
321 }
323 if (match->dstype == 0)
324 {
325 WARNING ("curl plugin: `DSType' missing in `Match' block.");
326 status = -1;
327 }
329 break;
330 } /* while (status == 0) */
332 if (status != 0)
333 {
334 cc_web_match_free (match);
335 return (status);
336 }
338 match->match = match_create_simple (match->regex, match->exclude_regex,
339 match->dstype);
340 if (match->match == NULL)
341 {
342 ERROR ("curl plugin: tail_match_add_match_simple failed.");
343 cc_web_match_free (match);
344 return (-1);
345 }
346 else
347 {
348 web_match_t *prev;
350 prev = page->matches;
351 while ((prev != NULL) && (prev->next != NULL))
352 prev = prev->next;
354 if (prev == NULL)
355 page->matches = match;
356 else
357 prev->next = match;
358 }
360 return (0);
361 } /* }}} int cc_config_add_match */
363 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
364 {
365 wp->curl = curl_easy_init ();
366 if (wp->curl == NULL)
367 {
368 ERROR ("curl plugin: curl_easy_init failed.");
369 return (-1);
370 }
372 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
373 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
374 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
375 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
376 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
377 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
378 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
379 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
381 if (wp->user != NULL)
382 {
383 #ifdef HAVE_CURLOPT_USERNAME
384 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
385 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
386 (wp->pass == NULL) ? "" : wp->pass);
387 #else
388 size_t credentials_size;
390 credentials_size = strlen (wp->user) + 2;
391 if (wp->pass != NULL)
392 credentials_size += strlen (wp->pass);
394 wp->credentials = (char *) malloc (credentials_size);
395 if (wp->credentials == NULL)
396 {
397 ERROR ("curl plugin: malloc failed.");
398 return (-1);
399 }
401 ssnprintf (wp->credentials, credentials_size, "%s:%s",
402 wp->user, (wp->pass == NULL) ? "" : wp->pass);
403 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
404 #endif
406 if (wp->digest)
407 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
408 }
410 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
411 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
412 wp->verify_host ? 2L : 0L);
413 if (wp->cacert != NULL)
414 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
415 if (wp->headers != NULL)
416 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
417 if (wp->post_body != NULL)
418 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
420 #ifdef HAVE_CURLOPT_TIMEOUT_MS
421 if (wp->timeout >= 0)
422 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
423 else
424 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS,
425 CDTIME_T_TO_MS(plugin_get_interval()));
426 #endif
428 return (0);
429 } /* }}} int cc_page_init_curl */
431 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
432 {
433 web_page_t *page;
434 int status;
435 int i;
437 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
438 {
439 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
440 return (-1);
441 }
443 page = (web_page_t *) malloc (sizeof (*page));
444 if (page == NULL)
445 {
446 ERROR ("curl plugin: malloc failed.");
447 return (-1);
448 }
449 memset (page, 0, sizeof (*page));
450 page->url = NULL;
451 page->user = NULL;
452 page->pass = NULL;
453 page->digest = 0;
454 page->verify_peer = 1;
455 page->verify_host = 1;
456 page->response_time = 0;
457 page->response_code = 0;
458 page->timeout = -1;
460 page->instance = strdup (ci->values[0].value.string);
461 if (page->instance == NULL)
462 {
463 ERROR ("curl plugin: strdup failed.");
464 sfree (page);
465 return (-1);
466 }
468 /* Process all children */
469 status = 0;
470 for (i = 0; i < ci->children_num; i++)
471 {
472 oconfig_item_t *child = ci->children + i;
474 if (strcasecmp ("URL", child->key) == 0)
475 status = cf_util_get_string (child, &page->url);
476 else if (strcasecmp ("User", child->key) == 0)
477 status = cf_util_get_string (child, &page->user);
478 else if (strcasecmp ("Password", child->key) == 0)
479 status = cf_util_get_string (child, &page->pass);
480 else if (strcasecmp ("Digest", child->key) == 0)
481 status = cf_util_get_boolean (child, &page->digest);
482 else if (strcasecmp ("VerifyPeer", child->key) == 0)
483 status = cf_util_get_boolean (child, &page->verify_peer);
484 else if (strcasecmp ("VerifyHost", child->key) == 0)
485 status = cf_util_get_boolean (child, &page->verify_host);
486 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
487 status = cf_util_get_boolean (child, &page->response_time);
488 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
489 status = cf_util_get_boolean (child, &page->response_code);
490 else if (strcasecmp ("CACert", child->key) == 0)
491 status = cf_util_get_string (child, &page->cacert);
492 else if (strcasecmp ("Match", child->key) == 0)
493 /* Be liberal with failing matches => don't set `status'. */
494 cc_config_add_match (page, child);
495 else if (strcasecmp ("Header", child->key) == 0)
496 status = cc_config_append_string ("Header", &page->headers, child);
497 else if (strcasecmp ("Post", child->key) == 0)
498 status = cf_util_get_string (child, &page->post_body);
499 else if (strcasecmp ("Timeout", child->key) == 0)
500 status = cf_util_get_int (child, &page->timeout);
501 else
502 {
503 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
504 status = -1;
505 }
507 if (status != 0)
508 break;
509 } /* for (i = 0; i < ci->children_num; i++) */
511 /* Additionial sanity checks and libCURL initialization. */
512 while (status == 0)
513 {
514 if (page->url == NULL)
515 {
516 WARNING ("curl plugin: `URL' missing in `Page' block.");
517 status = -1;
518 }
520 if (page->matches == NULL && !page->response_time && !page->response_code)
521 {
522 assert (page->instance != NULL);
523 WARNING ("curl plugin: No (valid) `Match' block "
524 "or MeasureResponseTime or MeasureResponseCode within "
525 "`Page' block `%s'.", page->instance);
526 status = -1;
527 }
529 if (status == 0)
530 status = cc_page_init_curl (page);
532 break;
533 } /* while (status == 0) */
535 if (status != 0)
536 {
537 cc_web_page_free (page);
538 return (status);
539 }
541 /* Add the new page to the linked list */
542 if (pages_g == NULL)
543 pages_g = page;
544 else
545 {
546 web_page_t *prev;
548 prev = pages_g;
549 while ((prev != NULL) && (prev->next != NULL))
550 prev = prev->next;
551 prev->next = page;
552 }
554 return (0);
555 } /* }}} int cc_config_add_page */
557 static int cc_config (oconfig_item_t *ci) /* {{{ */
558 {
559 int success;
560 int errors;
561 int status;
562 int i;
564 success = 0;
565 errors = 0;
567 for (i = 0; i < ci->children_num; i++)
568 {
569 oconfig_item_t *child = ci->children + i;
571 if (strcasecmp ("Page", child->key) == 0)
572 {
573 status = cc_config_add_page (child);
574 if (status == 0)
575 success++;
576 else
577 errors++;
578 }
579 else
580 {
581 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
582 errors++;
583 }
584 }
586 if ((success == 0) && (errors > 0))
587 {
588 ERROR ("curl plugin: All statements failed.");
589 return (-1);
590 }
592 return (0);
593 } /* }}} int cc_config */
595 static int cc_init (void) /* {{{ */
596 {
597 if (pages_g == NULL)
598 {
599 INFO ("curl plugin: No pages have been defined.");
600 return (-1);
601 }
602 curl_global_init (CURL_GLOBAL_SSL);
603 return (0);
604 } /* }}} int cc_init */
606 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
607 const cu_match_value_t *mv)
608 {
609 value_t values[1];
610 value_list_t vl = VALUE_LIST_INIT;
612 values[0] = mv->value;
614 vl.values = values;
615 vl.values_len = 1;
616 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
617 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
618 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
619 sstrncpy (vl.type, wm->type, sizeof (vl.type));
620 if (wm->instance != NULL)
621 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
623 plugin_dispatch_values (&vl);
624 } /* }}} void cc_submit */
626 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
627 {
628 value_t values[1];
629 value_list_t vl = VALUE_LIST_INIT;
631 values[0].gauge = code;
633 vl.values = values;
634 vl.values_len = 1;
635 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
636 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
637 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
638 sstrncpy (vl.type, "response_code", sizeof (vl.type));
640 plugin_dispatch_values (&vl);
641 } /* }}} void cc_submit_response_code */
643 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
644 cdtime_t response_time)
645 {
646 value_t values[1];
647 value_list_t vl = VALUE_LIST_INIT;
649 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
651 vl.values = values;
652 vl.values_len = 1;
653 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
654 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
655 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
656 sstrncpy (vl.type, "response_time", sizeof (vl.type));
658 plugin_dispatch_values (&vl);
659 } /* }}} void cc_submit_response_time */
661 static int cc_read_page (web_page_t *wp) /* {{{ */
662 {
663 web_match_t *wm;
664 int status;
665 cdtime_t start = 0;
667 if (wp->response_time)
668 start = cdtime ();
670 wp->buffer_fill = 0;
671 status = curl_easy_perform (wp->curl);
672 if (status != CURLE_OK)
673 {
674 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
675 status, wp->curl_errbuf);
676 return (-1);
677 }
679 if (wp->response_time)
680 cc_submit_response_time (wp, cdtime() - start);
682 if(wp->response_code)
683 {
684 long response_code = 0;
685 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
686 if(status != CURLE_OK) {
687 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
688 status, wp->curl_errbuf);
689 } else {
690 cc_submit_response_code(wp, response_code);
691 }
692 }
694 for (wm = wp->matches; wm != NULL; wm = wm->next)
695 {
696 cu_match_value_t *mv;
698 status = match_apply (wm->match, wp->buffer);
699 if (status != 0)
700 {
701 WARNING ("curl plugin: match_apply failed.");
702 continue;
703 }
705 mv = match_get_user_data (wm->match);
706 if (mv == NULL)
707 {
708 WARNING ("curl plugin: match_get_user_data returned NULL.");
709 continue;
710 }
712 cc_submit (wp, wm, mv);
713 match_value_reset (mv);
714 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
716 return (0);
717 } /* }}} int cc_read_page */
719 static int cc_read (void) /* {{{ */
720 {
721 web_page_t *wp;
723 for (wp = pages_g; wp != NULL; wp = wp->next)
724 cc_read_page (wp);
726 return (0);
727 } /* }}} int cc_read */
729 static int cc_shutdown (void) /* {{{ */
730 {
731 cc_web_page_free (pages_g);
732 pages_g = NULL;
734 return (0);
735 } /* }}} int cc_shutdown */
737 void module_register (void)
738 {
739 plugin_register_complex_config ("curl", cc_config);
740 plugin_register_init ("curl", cc_init);
741 plugin_register_read ("curl", cc_read);
742 plugin_register_shutdown ("curl", cc_shutdown);
743 } /* void module_register */
745 /* vim: set sw=2 sts=2 et fdm=marker : */