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 return (status);
330 match->match = match_create_simple (match->regex, match->exclude_regex,
331 match->dstype);
332 if (match->match == NULL)
333 {
334 ERROR ("curl plugin: tail_match_add_match_simple failed.");
335 cc_web_match_free (match);
336 return (-1);
337 }
338 else
339 {
340 web_match_t *prev;
342 prev = page->matches;
343 while ((prev != NULL) && (prev->next != NULL))
344 prev = prev->next;
346 if (prev == NULL)
347 page->matches = match;
348 else
349 prev->next = match;
350 }
352 return (0);
353 } /* }}} int cc_config_add_match */
355 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
356 {
357 wp->curl = curl_easy_init ();
358 if (wp->curl == NULL)
359 {
360 ERROR ("curl plugin: curl_easy_init failed.");
361 return (-1);
362 }
364 curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
365 curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
366 curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
367 curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
368 PACKAGE_NAME"/"PACKAGE_VERSION);
369 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
370 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
371 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
372 curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
374 if (wp->user != NULL)
375 {
376 size_t credentials_size;
378 credentials_size = strlen (wp->user) + 2;
379 if (wp->pass != NULL)
380 credentials_size += strlen (wp->pass);
382 wp->credentials = (char *) malloc (credentials_size);
383 if (wp->credentials == NULL)
384 {
385 ERROR ("curl plugin: malloc failed.");
386 return (-1);
387 }
389 ssnprintf (wp->credentials, credentials_size, "%s:%s",
390 wp->user, (wp->pass == NULL) ? "" : wp->pass);
391 curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
392 }
394 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
395 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
396 wp->verify_host ? 2L : 0L);
397 if (wp->cacert != NULL)
398 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
399 if (wp->headers != NULL)
400 curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
401 if (wp->post_body != NULL)
402 curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
404 return (0);
405 } /* }}} int cc_page_init_curl */
407 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
408 {
409 web_page_t *page;
410 int status;
411 int i;
413 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
414 {
415 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
416 return (-1);
417 }
419 page = (web_page_t *) malloc (sizeof (*page));
420 if (page == NULL)
421 {
422 ERROR ("curl plugin: malloc failed.");
423 return (-1);
424 }
425 memset (page, 0, sizeof (*page));
426 page->url = NULL;
427 page->user = NULL;
428 page->pass = NULL;
429 page->verify_peer = 1;
430 page->verify_host = 1;
431 page->response_time = 0;
432 page->response_code = 0;
434 page->instance = strdup (ci->values[0].value.string);
435 if (page->instance == NULL)
436 {
437 ERROR ("curl plugin: strdup failed.");
438 sfree (page);
439 return (-1);
440 }
442 /* Process all children */
443 status = 0;
444 for (i = 0; i < ci->children_num; i++)
445 {
446 oconfig_item_t *child = ci->children + i;
448 if (strcasecmp ("URL", child->key) == 0)
449 status = cf_util_get_string (child, &page->url);
450 else if (strcasecmp ("User", child->key) == 0)
451 status = cf_util_get_string (child, &page->user);
452 else if (strcasecmp ("Password", child->key) == 0)
453 status = cf_util_get_string (child, &page->pass);
454 else if (strcasecmp ("VerifyPeer", child->key) == 0)
455 status = cf_util_get_boolean (child, &page->verify_peer);
456 else if (strcasecmp ("VerifyHost", child->key) == 0)
457 status = cf_util_get_boolean (child, &page->verify_host);
458 else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
459 status = cf_util_get_boolean (child, &page->response_time);
460 else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
461 status = cf_util_get_boolean (child, &page->response_code);
462 else if (strcasecmp ("CACert", child->key) == 0)
463 status = cf_util_get_string (child, &page->cacert);
464 else if (strcasecmp ("Match", child->key) == 0)
465 /* Be liberal with failing matches => don't set `status'. */
466 cc_config_add_match (page, child);
467 else if (strcasecmp ("Header", child->key) == 0)
468 status = cc_config_append_string ("Header", &page->headers, child);
469 else if (strcasecmp ("Post", child->key) == 0)
470 status = cf_util_get_string (child, &page->post_body);
471 else
472 {
473 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
474 status = -1;
475 }
477 if (status != 0)
478 break;
479 } /* for (i = 0; i < ci->children_num; i++) */
481 /* Additionial sanity checks and libCURL initialization. */
482 while (status == 0)
483 {
484 if (page->url == NULL)
485 {
486 WARNING ("curl plugin: `URL' missing in `Page' block.");
487 status = -1;
488 }
490 if (page->matches == NULL && !page->response_time && !page->response_code)
491 {
492 assert (page->instance != NULL);
493 WARNING ("curl plugin: No (valid) `Match' block "
494 "or MeasureResponseTime or MeasureResponseCode within "
495 "`Page' block `%s'.", page->instance);
496 status = -1;
497 }
499 if (status == 0)
500 status = cc_page_init_curl (page);
502 break;
503 } /* while (status == 0) */
505 if (status != 0)
506 {
507 cc_web_page_free (page);
508 return (status);
509 }
511 /* Add the new page to the linked list */
512 if (pages_g == NULL)
513 pages_g = page;
514 else
515 {
516 web_page_t *prev;
518 prev = pages_g;
519 while ((prev != NULL) && (prev->next != NULL))
520 prev = prev->next;
521 prev->next = page;
522 }
524 return (0);
525 } /* }}} int cc_config_add_page */
527 static int cc_config (oconfig_item_t *ci) /* {{{ */
528 {
529 int success;
530 int errors;
531 int status;
532 int i;
534 success = 0;
535 errors = 0;
537 for (i = 0; i < ci->children_num; i++)
538 {
539 oconfig_item_t *child = ci->children + i;
541 if (strcasecmp ("Page", child->key) == 0)
542 {
543 status = cc_config_add_page (child);
544 if (status == 0)
545 success++;
546 else
547 errors++;
548 }
549 else
550 {
551 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
552 errors++;
553 }
554 }
556 if ((success == 0) && (errors > 0))
557 {
558 ERROR ("curl plugin: All statements failed.");
559 return (-1);
560 }
562 return (0);
563 } /* }}} int cc_config */
565 static int cc_init (void) /* {{{ */
566 {
567 if (pages_g == NULL)
568 {
569 INFO ("curl plugin: No pages have been defined.");
570 return (-1);
571 }
572 return (0);
573 } /* }}} int cc_init */
575 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
576 const cu_match_value_t *mv)
577 {
578 value_t values[1];
579 value_list_t vl = VALUE_LIST_INIT;
581 values[0] = mv->value;
583 vl.values = values;
584 vl.values_len = 1;
585 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
586 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
587 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
588 sstrncpy (vl.type, wm->type, sizeof (vl.type));
589 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
591 plugin_dispatch_values (&vl);
592 } /* }}} void cc_submit */
594 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
595 {
596 value_t values[1];
597 value_list_t vl = VALUE_LIST_INIT;
599 values[0].gauge = code;
601 vl.values = values;
602 vl.values_len = 1;
603 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
604 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
605 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
606 sstrncpy (vl.type, "response_code", sizeof (vl.type));
608 plugin_dispatch_values (&vl);
609 } /* }}} void cc_submit_response_code */
611 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
612 cdtime_t response_time)
613 {
614 value_t values[1];
615 value_list_t vl = VALUE_LIST_INIT;
617 values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
619 vl.values = values;
620 vl.values_len = 1;
621 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
622 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
623 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
624 sstrncpy (vl.type, "response_time", sizeof (vl.type));
626 plugin_dispatch_values (&vl);
627 } /* }}} void cc_submit_response_time */
629 static int cc_read_page (web_page_t *wp) /* {{{ */
630 {
631 web_match_t *wm;
632 int status;
633 cdtime_t start = 0;
635 if (wp->response_time)
636 start = cdtime ();
638 wp->buffer_fill = 0;
639 status = curl_easy_perform (wp->curl);
640 if (status != CURLE_OK)
641 {
642 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
643 status, wp->curl_errbuf);
644 return (-1);
645 }
647 if (wp->response_time)
648 cc_submit_response_time (wp, cdtime() - start);
650 if(wp->response_code)
651 {
652 long response_code = 0;
653 status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
654 if(status != CURLE_OK) {
655 ERROR ("curl plugin: Fetching response code failed with staus %i: %s",
656 status, wp->curl_errbuf);
657 } else {
658 cc_submit_response_code(wp, response_code);
659 }
660 }
662 for (wm = wp->matches; wm != NULL; wm = wm->next)
663 {
664 cu_match_value_t *mv;
666 status = match_apply (wm->match, wp->buffer);
667 if (status != 0)
668 {
669 WARNING ("curl plugin: match_apply failed.");
670 continue;
671 }
673 mv = match_get_user_data (wm->match);
674 if (mv == NULL)
675 {
676 WARNING ("curl plugin: match_get_user_data returned NULL.");
677 continue;
678 }
680 cc_submit (wp, wm, mv);
681 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
683 return (0);
684 } /* }}} int cc_read_page */
686 static int cc_read (void) /* {{{ */
687 {
688 web_page_t *wp;
690 for (wp = pages_g; wp != NULL; wp = wp->next)
691 cc_read_page (wp);
693 return (0);
694 } /* }}} int cc_read */
696 static int cc_shutdown (void) /* {{{ */
697 {
698 cc_web_page_free (pages_g);
699 pages_g = NULL;
701 return (0);
702 } /* }}} int cc_shutdown */
704 void module_register (void)
705 {
706 plugin_register_complex_config ("curl", cc_config);
707 plugin_register_init ("curl", cc_init);
708 plugin_register_read ("curl", cc_read);
709 plugin_register_shutdown ("curl", cc_shutdown);
710 } /* void module_register */
712 /* vim: set sw=2 sts=2 et fdm=marker : */