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