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 verplant.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 verify_peer;
62 _Bool verify_host;
63 char *cacert;
64 struct curl_slist *headers;
65 char *post_body;
66 _Bool response_time;
67 _Bool response_code;
69 CURL *curl;
70 char curl_errbuf[CURL_ERROR_SIZE];
71 char *buffer;
72 size_t buffer_size;
73 size_t buffer_fill;
75 web_match_t *matches;
77 web_page_t *next;
78 }; /* }}} */
80 /*
81 * Global variables;
82 */
83 /* static CURLM *curl = NULL; */
84 static web_page_t *pages_g = NULL;
86 /*
87 * Private functions
88 */
89 static size_t cc_curl_callback (void *buf, /* {{{ */
90 size_t size, size_t nmemb, void *user_data)
91 {
92 web_page_t *wp;
93 size_t len;
95 len = size * nmemb;
96 if (len <= 0)
97 return (len);
99 wp = user_data;
100 if (wp == NULL)
101 return (0);
103 if ((wp->buffer_fill + len) >= wp->buffer_size)
104 {
105 char *temp;
106 size_t temp_size;
108 temp_size = wp->buffer_fill + len + 1;
109 temp = (char *) realloc (wp->buffer, temp_size);
110 if (temp == NULL)
111 {
112 ERROR ("curl plugin: realloc failed.");
113 return (0);
114 }
115 wp->buffer = temp;
116 wp->buffer_size = temp_size;
117 }
119 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
120 wp->buffer_fill += len;
121 wp->buffer[wp->buffer_fill] = 0;
123 return (len);
124 } /* }}} size_t cc_curl_callback */
126 static void cc_web_match_free (web_match_t *wm) /* {{{ */
127 {
128 if (wm == NULL)
129 return;
131 sfree (wm->regex);
132 sfree (wm->type);
133 sfree (wm->instance);
134 match_destroy (wm->match);
135 cc_web_match_free (wm->next);
136 sfree (wm);
137 } /* }}} void cc_web_match_free */
139 static void cc_web_page_free (web_page_t *wp) /* {{{ */
140 {
141 if (wp == NULL)
142 return;
144 if (wp->curl != NULL)
145 curl_easy_cleanup (wp->curl);
146 wp->curl = NULL;
148 sfree (wp->instance);
150 sfree (wp->url);
151 sfree (wp->user);
152 sfree (wp->pass);
153 sfree (wp->credentials);
154 sfree (wp->cacert);
155 sfree (wp->post_body);
156 curl_slist_free_all (wp->headers);
158 sfree (wp->buffer);
160 cc_web_match_free (wp->matches);
161 cc_web_page_free (wp->next);
162 sfree (wp);
163 } /* }}} void cc_web_page_free */
165 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
166 oconfig_item_t *ci)
167 {
168 struct curl_slist *temp = NULL;
169 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
170 {
171 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
172 return (-1);
173 }
175 temp = curl_slist_append(*dest, ci->values[0].value.string);
176 if (temp == NULL)
177 return (-1);
179 *dest = temp;
181 return (0);
182 } /* }}} int cc_config_append_string */
184 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
185 oconfig_item_t *ci)
186 {
187 int dstype;
189 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
190 {
191 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
192 return (-1);
193 }
195 if (strncasecmp ("Gauge", ci->values[0].value.string,
196 strlen ("Gauge")) == 0)
197 {
198 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
199 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
200 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
201 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
202 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
203 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
204 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
205 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
206 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
207 else
208 dstype = 0;
209 }
210 else if (strncasecmp ("Counter", ci->values[0].value.string,
211 strlen ("Counter")) == 0)
212 {
213 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
214 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
215 dstype |= UTILS_MATCH_CF_COUNTER_SET;
216 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
217 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
218 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
219 dstype |= UTILS_MATCH_CF_COUNTER_INC;
220 else
221 dstype = 0;
222 }
223 else if (strncasecmp ("Derive", ci->values[0].value.string,
224 strlen ("Derive")) == 0)
225 {
226 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
227 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
228 dstype |= UTILS_MATCH_CF_DERIVE_SET;
229 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
230 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
231 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
232 dstype |= UTILS_MATCH_CF_DERIVE_INC;
233 else
234 dstype = 0;
235 }
236 else if (strncasecmp ("Absolute", ci->values[0].value.string,
237 strlen ("Absolute")) == 0)
238 {
239 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
240 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
241 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
242 else
243 dstype = 0;
244 }
246 else
247 {
248 dstype = 0;
249 }
251 if (dstype == 0)
252 {
253 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
254 ci->values[0].value.string);
255 return (-1);
256 }
258 *dstype_ret = dstype;
259 return (0);
260 } /* }}} int cc_config_add_match_dstype */
262 static int cc_config_add_match (web_page_t *page, /* {{{ */
263 oconfig_item_t *ci)
264 {
265 web_match_t *match;
266 int status;
267 int i;
269 if (ci->values_num != 0)
270 {
271 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
272 }
274 match = (web_match_t *) malloc (sizeof (*match));
275 if (match == NULL)
276 {
277 ERROR ("curl plugin: malloc failed.");
278 return (-1);
279 }
280 memset (match, 0, sizeof (*match));
282 status = 0;
283 for (i = 0; i < ci->children_num; i++)
284 {
285 oconfig_item_t *child = ci->children + i;
287 if (strcasecmp ("Regex", child->key) == 0)
288 status = cf_util_get_string (child, &match->regex);
289 else if (strcasecmp ("ExcludeRegex", child->key) == 0)
290 status = cf_util_get_string (child, &match->exclude_regex);
291 else if (strcasecmp ("DSType", child->key) == 0)
292 status = cc_config_add_match_dstype (&match->dstype, child);
293 else if (strcasecmp ("Type", child->key) == 0)
294 status = cf_util_get_string (child, &match->type);
295 else if (strcasecmp ("Instance", child->key) == 0)
296 status = cf_util_get_string (child, &match->instance);
297 else
298 {
299 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
300 status = -1;
301 }
303 if (status != 0)
304 break;
305 } /* for (i = 0; i < ci->children_num; i++) */
307 while (status == 0)
308 {
309 if (match->regex == NULL)
310 {
311 WARNING ("curl plugin: `Regex' missing in `Match' block.");
312 status = -1;
313 }
315 if (match->type == NULL)
316 {
317 WARNING ("curl plugin: `Type' missing in `Match' block.");
318 status = -1;
319 }
321 if (match->dstype == 0)
322 {
323 WARNING ("curl plugin: `DSType' missing in `Match' block.");
324 status = -1;
325 }
327 break;
328 } /* while (status == 0) */
330 if (status != 0)
331 {
332 cc_web_match_free (match);
333 return (status);
334 }
336 match->match = match_create_simple (match->regex, match->exclude_regex,
337 match->dstype);
338 if (match->match == NULL)
339 {
340 ERROR ("curl plugin: tail_match_add_match_simple failed.");
341 cc_web_match_free (match);
342 return (-1);
343 }
344 else
345 {
346 web_match_t *prev;
348 prev = page->matches;
349 while ((prev != NULL) && (prev->next != NULL))
350 prev = prev->next;
352 if (prev == NULL)
353 page->matches = match;
354 else
355 prev->next = match;
356 }
358 return (0);
359 } /* }}} int cc_config_add_match */
361 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
362 {
363 wp->curl = curl_easy_init ();
364 if (wp->curl == NULL)
365 {
366 ERROR ("curl plugin: curl_easy_init failed.");
367 return (-1);
368 }
370 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
371 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
372 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
373 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
374 PACKAGE_NAME"/"PACKAGE_VERSION);
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 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 }
400 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
401 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
402 wp->verify_host ? 2L : 0L);
403 if (wp->cacert != NULL)
404 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
405 if (wp->headers != NULL)
406 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
407 if (wp->post_body != NULL)
408 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
410 return (0);
411 } /* }}} int cc_page_init_curl */
413 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
414 {
415 web_page_t *page;
416 int status;
417 int i;
419 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
420 {
421 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
422 return (-1);
423 }
425 page = (web_page_t *) malloc (sizeof (*page));
426 if (page == NULL)
427 {
428 ERROR ("curl plugin: malloc failed.");
429 return (-1);
430 }
431 memset (page, 0, sizeof (*page));
432 page->url = NULL;
433 page->user = NULL;
434 page->pass = NULL;
435 page->verify_peer = 1;
436 page->verify_host = 1;
437 page->response_time = 0;
438 page->response_code = 0;
440 page->instance = strdup (ci->values[0].value.string);
441 if (page->instance == NULL)
442 {
443 ERROR ("curl plugin: strdup failed.");
444 sfree (page);
445 return (-1);
446 }
448 /* Process all children */
449 status = 0;
450 for (i = 0; i < ci->children_num; i++)
451 {
452 oconfig_item_t *child = ci->children + i;
454 if (strcasecmp ("URL", child->key) == 0)
455 status = cf_util_get_string (child, &page->url);
456 else if (strcasecmp ("User", child->key) == 0)
457 status = cf_util_get_string (child, &page->user);
458 else if (strcasecmp ("Password", child->key) == 0)
459 status = cf_util_get_string (child, &page->pass);
460 else if (strcasecmp ("VerifyPeer", child->key) == 0)
461 status = cf_util_get_boolean (child, &page->verify_peer);
462 else if (strcasecmp ("VerifyHost", child->key) == 0)
463 status = cf_util_get_boolean (child, &page->verify_host);
464 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
465 status = cf_util_get_boolean (child, &page->response_time);
466 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
467 status = cf_util_get_boolean (child, &page->response_code);
468 else if (strcasecmp ("CACert", child->key) == 0)
469 status = cf_util_get_string (child, &page->cacert);
470 else if (strcasecmp ("Match", child->key) == 0)
471 /* Be liberal with failing matches => don't set `status'. */
472 cc_config_add_match (page, child);
473 else if (strcasecmp ("Header", child->key) == 0)
474 status = cc_config_append_string ("Header", &page->headers, child);
475 else if (strcasecmp ("Post", child->key) == 0)
476 status = cf_util_get_string (child, &page->post_body);
477 else
478 {
479 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
480 status = -1;
481 }
483 if (status != 0)
484 break;
485 } /* for (i = 0; i < ci->children_num; i++) */
487 /* Additionial sanity checks and libCURL initialization. */
488 while (status == 0)
489 {
490 if (page->url == NULL)
491 {
492 WARNING ("curl plugin: `URL' missing in `Page' block.");
493 status = -1;
494 }
496 if (page->matches == NULL && !page->response_time && !page->response_code)
497 {
498 assert (page->instance != NULL);
499 WARNING ("curl plugin: No (valid) `Match' block "
500 "or MeasureResponseTime or MeasureResponseCode within "
501 "`Page' block `%s'.", page->instance);
502 status = -1;
503 }
505 if (status == 0)
506 status = cc_page_init_curl (page);
508 break;
509 } /* while (status == 0) */
511 if (status != 0)
512 {
513 cc_web_page_free (page);
514 return (status);
515 }
517 /* Add the new page to the linked list */
518 if (pages_g == NULL)
519 pages_g = page;
520 else
521 {
522 web_page_t *prev;
524 prev = pages_g;
525 while ((prev != NULL) && (prev->next != NULL))
526 prev = prev->next;
527 prev->next = page;
528 }
530 return (0);
531 } /* }}} int cc_config_add_page */
533 static int cc_config (oconfig_item_t *ci) /* {{{ */
534 {
535 int success;
536 int errors;
537 int status;
538 int i;
540 success = 0;
541 errors = 0;
543 for (i = 0; i < ci->children_num; i++)
544 {
545 oconfig_item_t *child = ci->children + i;
547 if (strcasecmp ("Page", child->key) == 0)
548 {
549 status = cc_config_add_page (child);
550 if (status == 0)
551 success++;
552 else
553 errors++;
554 }
555 else
556 {
557 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
558 errors++;
559 }
560 }
562 if ((success == 0) && (errors > 0))
563 {
564 ERROR ("curl plugin: All statements failed.");
565 return (-1);
566 }
568 return (0);
569 } /* }}} int cc_config */
571 static int cc_init (void) /* {{{ */
572 {
573 if (pages_g == NULL)
574 {
575 INFO ("curl plugin: No pages have been defined.");
576 return (-1);
577 }
578 curl_global_init (CURL_GLOBAL_SSL);
579 return (0);
580 } /* }}} int cc_init */
582 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
583 const cu_match_value_t *mv)
584 {
585 value_t values[1];
586 value_list_t vl = VALUE_LIST_INIT;
588 values[0] = mv->value;
590 vl.values = values;
591 vl.values_len = 1;
592 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
593 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
594 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
595 sstrncpy (vl.type, wm->type, sizeof (vl.type));
596 if (wm->instance != NULL)
597 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
599 plugin_dispatch_values (&vl);
600 } /* }}} void cc_submit */
602 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
603 {
604 value_t values[1];
605 value_list_t vl = VALUE_LIST_INIT;
607 values[0].gauge = code;
609 vl.values = values;
610 vl.values_len = 1;
611 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
612 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
613 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
614 sstrncpy (vl.type, "response_code", sizeof (vl.type));
616 plugin_dispatch_values (&vl);
617 } /* }}} void cc_submit_response_code */
619 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
620 cdtime_t response_time)
621 {
622 value_t values[1];
623 value_list_t vl = VALUE_LIST_INIT;
625 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
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_time", sizeof (vl.type));
634 plugin_dispatch_values (&vl);
635 } /* }}} void cc_submit_response_time */
637 static int cc_read_page (web_page_t *wp) /* {{{ */
638 {
639 web_match_t *wm;
640 int status;
641 cdtime_t start = 0;
643 if (wp->response_time)
644 start = cdtime ();
646 wp->buffer_fill = 0;
647 status = curl_easy_perform (wp->curl);
648 if (status != CURLE_OK)
649 {
650 ERROR ("curl plugin: curl_easy_perform failed with status %i: %s",
651 status, wp->curl_errbuf);
652 return (-1);
653 }
655 if (wp->response_time)
656 cc_submit_response_time (wp, cdtime() - start);
658 if(wp->response_code)
659 {
660 long response_code = 0;
661 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
662 if(status != CURLE_OK) {
663 ERROR ("curl plugin: Fetching response code failed with status %i: %s",
664 status, wp->curl_errbuf);
665 } else {
666 cc_submit_response_code(wp, response_code);
667 }
668 }
670 for (wm = wp->matches; wm != NULL; wm = wm->next)
671 {
672 cu_match_value_t *mv;
674 status = match_apply (wm->match, wp->buffer);
675 if (status != 0)
676 {
677 WARNING ("curl plugin: match_apply failed.");
678 continue;
679 }
681 mv = match_get_user_data (wm->match);
682 if (mv == NULL)
683 {
684 WARNING ("curl plugin: match_get_user_data returned NULL.");
685 continue;
686 }
688 cc_submit (wp, wm, mv);
689 match_value_reset (mv);
690 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
692 return (0);
693 } /* }}} int cc_read_page */
695 static int cc_read (void) /* {{{ */
696 {
697 web_page_t *wp;
699 for (wp = pages_g; wp != NULL; wp = wp->next)
700 cc_read_page (wp);
702 return (0);
703 } /* }}} int cc_read */
705 static int cc_shutdown (void) /* {{{ */
706 {
707 cc_web_page_free (pages_g);
708 pages_g = NULL;
710 return (0);
711 } /* }}} int cc_shutdown */
713 void module_register (void)
714 {
715 plugin_register_complex_config ("curl", cc_config);
716 plugin_register_init ("curl", cc_init);
717 plugin_register_read ("curl", cc_read);
718 plugin_register_shutdown ("curl", cc_shutdown);
719 } /* void module_register */
721 /* vim: set sw=2 sts=2 et fdm=marker : */