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 {
331 cc_web_match_free (match);
332 return (status);
333 }
335 match->match = match_create_simple (match->regex, match->exclude_regex,
336 match->dstype);
337 if (match->match == NULL)
338 {
339 ERROR ("curl plugin: tail_match_add_match_simple failed.");
340 cc_web_match_free (match);
341 return (-1);
342 }
343 else
344 {
345 web_match_t *prev;
347 prev = page->matches;
348 while ((prev != NULL) && (prev->next != NULL))
349 prev = prev->next;
351 if (prev == NULL)
352 page->matches = match;
353 else
354 prev->next = match;
355 }
357 return (0);
358 } /* }}} int cc_config_add_match */
360 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
361 {
362 wp->curl = curl_easy_init ();
363 if (wp->curl == NULL)
364 {
365 ERROR ("curl plugin: curl_easy_init failed.");
366 return (-1);
367 }
369 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
370 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
371 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
372 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
373 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
374 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
375 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
376 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
378 if (wp->user != NULL)
379 {
380 #ifdef HAVE_CURLOPT_USERNAME
381 curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
382 curl_easy_setopt (wp->curl, CURLOPT_PASSWORD,
383 (wp->pass == NULL) ? "" : wp->pass);
384 #else
385 size_t credentials_size;
387 credentials_size = strlen (wp->user) + 2;
388 if (wp->pass != NULL)
389 credentials_size += strlen (wp->pass);
391 wp->credentials = (char *) malloc (credentials_size);
392 if (wp->credentials == NULL)
393 {
394 ERROR ("curl plugin: malloc failed.");
395 return (-1);
396 }
398 ssnprintf (wp->credentials, credentials_size, "%s:%s",
399 wp->user, (wp->pass == NULL) ? "" : wp->pass);
400 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
401 #endif
403 if (wp->digest)
404 curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
405 }
407 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
408 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
409 wp->verify_host ? 2L : 0L);
410 if (wp->cacert != NULL)
411 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
412 if (wp->headers != NULL)
413 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
414 if (wp->post_body != NULL)
415 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
417 #ifdef HAVE_CURLOPT_TIMEOUT_MS
418 if (wp->timeout >= 0)
419 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) wp->timeout);
420 else
421 curl_easy_setopt (wp->curl, CURLOPT_TIMEOUT_MS, (long) CDTIME_T_TO_MS(plugin_get_interval()));
422 #endif
424 return (0);
425 } /* }}} int cc_page_init_curl */
427 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
428 {
429 web_page_t *page;
430 int status;
431 int i;
433 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
434 {
435 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
436 return (-1);
437 }
439 page = (web_page_t *) malloc (sizeof (*page));
440 if (page == NULL)
441 {
442 ERROR ("curl plugin: malloc failed.");
443 return (-1);
444 }
445 memset (page, 0, sizeof (*page));
446 page->url = NULL;
447 page->user = NULL;
448 page->pass = NULL;
449 page->digest = 0;
450 page->verify_peer = 1;
451 page->verify_host = 1;
452 page->response_time = 0;
453 page->response_code = 0;
454 page->timeout = -1;
456 page->instance = strdup (ci->values[0].value.string);
457 if (page->instance == NULL)
458 {
459 ERROR ("curl plugin: strdup failed.");
460 sfree (page);
461 return (-1);
462 }
464 /* Process all children */
465 status = 0;
466 for (i = 0; i < ci->children_num; i++)
467 {
468 oconfig_item_t *child = ci->children + i;
470 if (strcasecmp ("URL", child->key) == 0)
471 status = cf_util_get_string (child, &page->url);
472 else if (strcasecmp ("User", child->key) == 0)
473 status = cf_util_get_string (child, &page->user);
474 else if (strcasecmp ("Password", child->key) == 0)
475 status = cf_util_get_string (child, &page->pass);
476 else if (strcasecmp ("Digest", child->key) == 0)
477 status = cf_util_get_boolean (child, &page->digest);
478 else if (strcasecmp ("VerifyPeer", child->key) == 0)
479 status = cf_util_get_boolean (child, &page->verify_peer);
480 else if (strcasecmp ("VerifyHost", child->key) == 0)
481 status = cf_util_get_boolean (child, &page->verify_host);
482 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
483 status = cf_util_get_boolean (child, &page->response_time);
484 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
485 status = cf_util_get_boolean (child, &page->response_code);
486 else if (strcasecmp ("CACert", child->key) == 0)
487 status = cf_util_get_string (child, &page->cacert);
488 else if (strcasecmp ("Match", child->key) == 0)
489 /* Be liberal with failing matches => don't set `status'. */
490 cc_config_add_match (page, child);
491 else if (strcasecmp ("Header", child->key) == 0)
492 status = cc_config_append_string ("Header", &page->headers, child);
493 else if (strcasecmp ("Post", child->key) == 0)
494 status = cf_util_get_string (child, &page->post_body);
495 else if (strcasecmp ("Timeout", child->key) == 0)
496 status = cf_util_get_int (child, &page->timeout);
497 else
498 {
499 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
500 status = -1;
501 }
503 if (status != 0)
504 break;
505 } /* for (i = 0; i < ci->children_num; i++) */
507 /* Additionial sanity checks and libCURL initialization. */
508 while (status == 0)
509 {
510 if (page->url == NULL)
511 {
512 WARNING ("curl plugin: `URL' missing in `Page' block.");
513 status = -1;
514 }
516 if (page->matches == NULL && !page->response_time && !page->response_code)
517 {
518 assert (page->instance != NULL);
519 WARNING ("curl plugin: No (valid) `Match' block "
520 "or MeasureResponseTime or MeasureResponseCode within "
521 "`Page' block `%s'.", page->instance);
522 status = -1;
523 }
525 if (status == 0)
526 status = cc_page_init_curl (page);
528 break;
529 } /* while (status == 0) */
531 if (status != 0)
532 {
533 cc_web_page_free (page);
534 return (status);
535 }
537 /* Add the new page to the linked list */
538 if (pages_g == NULL)
539 pages_g = page;
540 else
541 {
542 web_page_t *prev;
544 prev = pages_g;
545 while ((prev != NULL) && (prev->next != NULL))
546 prev = prev->next;
547 prev->next = page;
548 }
550 return (0);
551 } /* }}} int cc_config_add_page */
553 static int cc_config (oconfig_item_t *ci) /* {{{ */
554 {
555 int success;
556 int errors;
557 int status;
558 int i;
560 success = 0;
561 errors = 0;
563 for (i = 0; i < ci->children_num; i++)
564 {
565 oconfig_item_t *child = ci->children + i;
567 if (strcasecmp ("Page", child->key) == 0)
568 {
569 status = cc_config_add_page (child);
570 if (status == 0)
571 success++;
572 else
573 errors++;
574 }
575 else
576 {
577 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
578 errors++;
579 }
580 }
582 if ((success == 0) && (errors > 0))
583 {
584 ERROR ("curl plugin: All statements failed.");
585 return (-1);
586 }
588 return (0);
589 } /* }}} int cc_config */
591 static int cc_init (void) /* {{{ */
592 {
593 if (pages_g == NULL)
594 {
595 INFO ("curl plugin: No pages have been defined.");
596 return (-1);
597 }
598 curl_global_init (CURL_GLOBAL_SSL);
599 return (0);
600 } /* }}} int cc_init */
602 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
603 const cu_match_value_t *mv)
604 {
605 value_t values[1];
606 value_list_t vl = VALUE_LIST_INIT;
608 values[0] = mv->value;
610 vl.values = values;
611 vl.values_len = 1;
612 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
613 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
614 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
615 sstrncpy (vl.type, wm->type, sizeof (vl.type));
616 if (wm->instance != NULL)
617 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
619 plugin_dispatch_values (&vl);
620 } /* }}} void cc_submit */
622 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
623 {
624 value_t values[1];
625 value_list_t vl = VALUE_LIST_INIT;
627 values[0].gauge = code;
629 vl.values = values;
630 vl.values_len = 1;
631 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
632 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
633 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
634 sstrncpy (vl.type, "response_code", sizeof (vl.type));
636 plugin_dispatch_values (&vl);
637 } /* }}} void cc_submit_response_code */
639 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
640 cdtime_t response_time)
641 {
642 value_t values[1];
643 value_list_t vl = VALUE_LIST_INIT;
645 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
647 vl.values = values;
648 vl.values_len = 1;
649 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
650 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
651 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
652 sstrncpy (vl.type, "response_time", sizeof (vl.type));
654 plugin_dispatch_values (&vl);
655 } /* }}} void cc_submit_response_time */
657 static int cc_read_page (web_page_t *wp) /* {{{ */
658 {
659 web_match_t *wm;
660 int status;
661 cdtime_t start = 0;
663 if (wp->response_time)
664 start = cdtime ();
666 wp->buffer_fill = 0;
667 status = curl_easy_perform (wp->curl);
668 if (status != CURLE_OK)
669 {
670 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
671 status, wp->curl_errbuf);
672 return (-1);
673 }
675 if (wp->response_time)
676 cc_submit_response_time (wp, cdtime() - start);
678 if(wp->response_code)
679 {
680 long response_code = 0;
681 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
682 if(status != CURLE_OK) {
683 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
684 status, wp->curl_errbuf);
685 } else {
686 cc_submit_response_code(wp, response_code);
687 }
688 }
690 for (wm = wp->matches; wm != NULL; wm = wm->next)
691 {
692 cu_match_value_t *mv;
694 status = match_apply (wm->match, wp->buffer);
695 if (status != 0)
696 {
697 WARNING ("curl plugin: match_apply failed.");
698 continue;
699 }
701 mv = match_get_user_data (wm->match);
702 if (mv == NULL)
703 {
704 WARNING ("curl plugin: match_get_user_data returned NULL.");
705 continue;
706 }
708 cc_submit (wp, wm, mv);
709 match_value_reset (mv);
710 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
712 return (0);
713 } /* }}} int cc_read_page */
715 static int cc_read (void) /* {{{ */
716 {
717 web_page_t *wp;
719 for (wp = pages_g; wp != NULL; wp = wp->next)
720 cc_read_page (wp);
722 return (0);
723 } /* }}} int cc_read */
725 static int cc_shutdown (void) /* {{{ */
726 {
727 cc_web_page_free (pages_g);
728 pages_g = NULL;
730 return (0);
731 } /* }}} int cc_shutdown */
733 void module_register (void)
734 {
735 plugin_register_complex_config ("curl", cc_config);
736 plugin_register_init ("curl", cc_init);
737 plugin_register_read ("curl", cc_read);
738 plugin_register_shutdown ("curl", cc_shutdown);
739 } /* void module_register */
741 /* vim: set sw=2 sts=2 et fdm=marker : */