Code

Merge pull request #553 from Whissi/issue_553
[collectd.git] / src / curl.c
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 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;
70   CURL *curl;
71   char curl_errbuf[CURL_ERROR_SIZE];
72   char *buffer;
73   size_t buffer_size;
74   size_t buffer_fill;
76   web_match_t *matches;
78   web_page_t *next;
79 }; /* }}} */
81 /*
82  * Global variables;
83  */
84 /* static CURLM *curl = NULL; */
85 static web_page_t *pages_g = NULL;
87 /*
88  * Private functions
89  */
90 static size_t cc_curl_callback (void *buf, /* {{{ */
91     size_t size, size_t nmemb, void *user_data)
92 {
93   web_page_t *wp;
94   size_t len;
96   len = size * nmemb;
97   if (len <= 0)
98     return (len);
100   wp = user_data;
101   if (wp == NULL)
102     return (0);
104   if ((wp->buffer_fill + len) >= wp->buffer_size)
105   {
106     char *temp;
107     size_t temp_size;
109     temp_size = wp->buffer_fill + len + 1;
110     temp = (char *) realloc (wp->buffer, temp_size);
111     if (temp == NULL)
112     {
113       ERROR ("curl plugin: realloc failed.");
114       return (0);
115     }
116     wp->buffer = temp;
117     wp->buffer_size = temp_size;
118   }
120   memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
121   wp->buffer_fill += len;
122   wp->buffer[wp->buffer_fill] = 0;
124   return (len);
125 } /* }}} size_t cc_curl_callback */
127 static void cc_web_match_free (web_match_t *wm) /* {{{ */
129   if (wm == NULL)
130     return;
132   sfree (wm->regex);
133   sfree (wm->type);
134   sfree (wm->instance);
135   match_destroy (wm->match);
136   cc_web_match_free (wm->next);
137   sfree (wm);
138 } /* }}} void cc_web_match_free */
140 static void cc_web_page_free (web_page_t *wp) /* {{{ */
142   if (wp == NULL)
143     return;
145   if (wp->curl != NULL)
146     curl_easy_cleanup (wp->curl);
147   wp->curl = NULL;
149   sfree (wp->instance);
151   sfree (wp->url);
152   sfree (wp->user);
153   sfree (wp->pass);
154   sfree (wp->credentials);
155   sfree (wp->cacert);
156   sfree (wp->post_body);
157   curl_slist_free_all (wp->headers);
159   sfree (wp->buffer);
161   cc_web_match_free (wp->matches);
162   cc_web_page_free (wp->next);
163   sfree (wp);
164 } /* }}} void cc_web_page_free */
166 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
167     oconfig_item_t *ci)
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   *dest = curl_slist_append(*dest, ci->values[0].value.string);
176   if (*dest == NULL)
177     return (-1);
179   return (0);
180 } /* }}} int cc_config_append_string */
182 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
183     oconfig_item_t *ci)
185   int dstype;
187   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
188   {
189     WARNING ("curl plugin: `DSType' needs exactly one string argument.");
190     return (-1);
191   }
193   if (strncasecmp ("Gauge", ci->values[0].value.string,
194         strlen ("Gauge")) == 0)
195   {
196     dstype = UTILS_MATCH_DS_TYPE_GAUGE;
197     if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
198       dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
199     else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
200       dstype |= UTILS_MATCH_CF_GAUGE_MIN;
201     else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
202       dstype |= UTILS_MATCH_CF_GAUGE_MAX;
203     else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
204       dstype |= UTILS_MATCH_CF_GAUGE_LAST;
205     else
206       dstype = 0;
207   }
208   else if (strncasecmp ("Counter", ci->values[0].value.string,
209         strlen ("Counter")) == 0)
210   {
211     dstype = UTILS_MATCH_DS_TYPE_COUNTER;
212     if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
213       dstype |= UTILS_MATCH_CF_COUNTER_SET;
214     else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
215       dstype |= UTILS_MATCH_CF_COUNTER_ADD;
216     else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
217       dstype |= UTILS_MATCH_CF_COUNTER_INC;
218     else
219       dstype = 0;
220   }
221 else if (strncasecmp ("Derive", ci->values[0].value.string,
222         strlen ("Derive")) == 0)
223   {
224     dstype = UTILS_MATCH_DS_TYPE_DERIVE;
225     if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
226       dstype |= UTILS_MATCH_CF_DERIVE_SET;
227     else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
228       dstype |= UTILS_MATCH_CF_DERIVE_ADD;
229     else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
230       dstype |= UTILS_MATCH_CF_DERIVE_INC;
231     else
232       dstype = 0;
233   }
234 else if (strncasecmp ("Absolute", ci->values[0].value.string,
235         strlen ("Absolute")) == 0)
236   {
237     dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
238     if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
239       dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
240     else
241       dstype = 0;
242   }
244   else
245   {
246     dstype = 0;
247   }
249   if (dstype == 0)
250   {
251     WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
252         ci->values[0].value.string);
253     return (-1);
254   }
256   *dstype_ret = dstype;
257   return (0);
258 } /* }}} int cc_config_add_match_dstype */
260 static int cc_config_add_match (web_page_t *page, /* {{{ */
261     oconfig_item_t *ci)
263   web_match_t *match;
264   int status;
265   int i;
267   if (ci->values_num != 0)
268   {
269     WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
270   }
272   match = (web_match_t *) malloc (sizeof (*match));
273   if (match == NULL)
274   {
275     ERROR ("curl plugin: malloc failed.");
276     return (-1);
277   }
278   memset (match, 0, sizeof (*match));
280   status = 0;
281   for (i = 0; i < ci->children_num; i++)
282   {
283     oconfig_item_t *child = ci->children + i;
285     if (strcasecmp ("Regex", child->key) == 0)
286       status = cf_util_get_string (child, &match->regex);
287     else if (strcasecmp ("ExcludeRegex", child->key) == 0)
288       status = cf_util_get_string (child, &match->exclude_regex);
289     else if (strcasecmp ("DSType", child->key) == 0)
290       status = cc_config_add_match_dstype (&match->dstype, child);
291     else if (strcasecmp ("Type", child->key) == 0)
292       status = cf_util_get_string (child, &match->type);
293     else if (strcasecmp ("Instance", child->key) == 0)
294       status = cf_util_get_string (child, &match->instance);
295     else
296     {
297       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
298       status = -1;
299     }
301     if (status != 0)
302       break;
303   } /* for (i = 0; i < ci->children_num; i++) */
305   while (status == 0)
306   {
307     if (match->regex == NULL)
308     {
309       WARNING ("curl plugin: `Regex' missing in `Match' block.");
310       status = -1;
311     }
313     if (match->type == NULL)
314     {
315       WARNING ("curl plugin: `Type' missing in `Match' block.");
316       status = -1;
317     }
319     if (match->dstype == 0)
320     {
321       WARNING ("curl plugin: `DSType' missing in `Match' block.");
322       status = -1;
323     }
325     break;
326   } /* while (status == 0) */
328   if (status != 0)
329     return (status);
331   match->match = match_create_simple (match->regex, match->exclude_regex,
332       match->dstype);
333   if (match->match == NULL)
334   {
335     ERROR ("curl plugin: tail_match_add_match_simple failed.");
336     cc_web_match_free (match);
337     return (-1);
338   }
339   else
340   {
341     web_match_t *prev;
343     prev = page->matches;
344     while ((prev != NULL) && (prev->next != NULL))
345       prev = prev->next;
347     if (prev == NULL)
348       page->matches = match;
349     else
350       prev->next = match;
351   }
353   return (0);
354 } /* }}} int cc_config_add_match */
356 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
358   wp->curl = curl_easy_init ();
359   if (wp->curl == NULL)
360   {
361     ERROR ("curl plugin: curl_easy_init failed.");
362     return (-1);
363   }
365   curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
366   curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
367   curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
368   curl_easy_setopt (wp->curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
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     
393     if (wp->digest)
394     {
395       curl_easy_setopt (wp->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
396       curl_easy_setopt (wp->curl, CURLOPT_USERNAME, wp->user);
397       curl_easy_setopt (wp->curl, CURLOPT_PASSWORD, wp->pass);
398     }
399   }
401   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
402   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
403       wp->verify_host ? 2L : 0L);
404   if (wp->cacert != NULL)
405     curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
406   if (wp->headers != NULL)
407     curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
408   if (wp->post_body != NULL)
409     curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
411   return (0);
412 } /* }}} int cc_page_init_curl */
414 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
416   web_page_t *page;
417   int status;
418   int i;
420   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
421   {
422     WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
423     return (-1);
424   }
426   page = (web_page_t *) malloc (sizeof (*page));
427   if (page == NULL)
428   {
429     ERROR ("curl plugin: malloc failed.");
430     return (-1);
431   }
432   memset (page, 0, sizeof (*page));
433   page->url = NULL;
434   page->user = NULL;
435   page->pass = NULL;
436   page->digest = 0;
437   page->verify_peer = 1;
438   page->verify_host = 1;
439   page->response_time = 0;
440   page->response_code = 0;
442   page->instance = strdup (ci->values[0].value.string);
443   if (page->instance == NULL)
444   {
445     ERROR ("curl plugin: strdup failed.");
446     sfree (page);
447     return (-1);
448   }
450   /* Process all children */
451   status = 0;
452   for (i = 0; i < ci->children_num; i++)
453   {
454     oconfig_item_t *child = ci->children + i;
456     if (strcasecmp ("URL", child->key) == 0)
457       status = cf_util_get_string (child, &page->url);
458     else if (strcasecmp ("User", child->key) == 0)
459       status = cf_util_get_string (child, &page->user);
460     else if (strcasecmp ("Password", child->key) == 0)
461       status = cf_util_get_string (child, &page->pass);
462     else if (strcasecmp ("Digest", child->key) == 0)
463       status = cf_util_get_boolean (child, &page->digest);
464     else if (strcasecmp ("VerifyPeer", child->key) == 0)
465       status = cf_util_get_boolean (child, &page->verify_peer);
466     else if (strcasecmp ("VerifyHost", child->key) == 0)
467       status = cf_util_get_boolean (child, &page->verify_host);
468     else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
469       status = cf_util_get_boolean (child, &page->response_time);
470     else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
471       status = cf_util_get_boolean (child, &page->response_code);
472     else if (strcasecmp ("CACert", child->key) == 0)
473       status = cf_util_get_string (child, &page->cacert);
474     else if (strcasecmp ("Match", child->key) == 0)
475       /* Be liberal with failing matches => don't set `status'. */
476       cc_config_add_match (page, child);
477     else if (strcasecmp ("Header", child->key) == 0)
478       status = cc_config_append_string ("Header", &page->headers, child);
479     else if (strcasecmp ("Post", child->key) == 0)
480       status = cf_util_get_string (child, &page->post_body);
481     else
482     {
483       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
484       status = -1;
485     }
487     if (status != 0)
488       break;
489   } /* for (i = 0; i < ci->children_num; i++) */
491   /* Additionial sanity checks and libCURL initialization. */
492   while (status == 0)
493   {
494     if (page->url == NULL)
495     {
496       WARNING ("curl plugin: `URL' missing in `Page' block.");
497       status = -1;
498     }
500     if (page->matches == NULL && !page->response_time && !page->response_code)
501     {
502       assert (page->instance != NULL);
503       WARNING ("curl plugin: No (valid) `Match' block "
504           "or MeasureResponseTime or MeasureResponseCode within "
505           "`Page' block `%s'.", page->instance);
506       status = -1;
507     }
509     if (status == 0)
510       status = cc_page_init_curl (page);
512     break;
513   } /* while (status == 0) */
515   if (status != 0)
516   {
517     cc_web_page_free (page);
518     return (status);
519   }
521   /* Add the new page to the linked list */
522   if (pages_g == NULL)
523     pages_g = page;
524   else
525   {
526     web_page_t *prev;
528     prev = pages_g;
529     while ((prev != NULL) && (prev->next != NULL))
530       prev = prev->next;
531     prev->next = page;
532   }
534   return (0);
535 } /* }}} int cc_config_add_page */
537 static int cc_config (oconfig_item_t *ci) /* {{{ */
539   int success;
540   int errors;
541   int status;
542   int i;
544   success = 0;
545   errors = 0;
547   for (i = 0; i < ci->children_num; i++)
548   {
549     oconfig_item_t *child = ci->children + i;
551     if (strcasecmp ("Page", child->key) == 0)
552     {
553       status = cc_config_add_page (child);
554       if (status == 0)
555         success++;
556       else
557         errors++;
558     }
559     else
560     {
561       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
562       errors++;
563     }
564   }
566   if ((success == 0) && (errors > 0))
567   {
568     ERROR ("curl plugin: All statements failed.");
569     return (-1);
570   }
572   return (0);
573 } /* }}} int cc_config */
575 static int cc_init (void) /* {{{ */
577   if (pages_g == NULL)
578   {
579     INFO ("curl plugin: No pages have been defined.");
580     return (-1);
581   }
582   return (0);
583 } /* }}} int cc_init */
585 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
586     const cu_match_value_t *mv)
588   value_t values[1];
589   value_list_t vl = VALUE_LIST_INIT;
591   values[0] = mv->value;
593   vl.values = values;
594   vl.values_len = 1;
595   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
596   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
597   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
598   sstrncpy (vl.type, wm->type, sizeof (vl.type));
599   if (wm->instance != NULL)
600     sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
602   plugin_dispatch_values (&vl);
603 } /* }}} void cc_submit */
605 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
607   value_t values[1];
608   value_list_t vl = VALUE_LIST_INIT;
610   values[0].gauge = code;
612   vl.values = values;
613   vl.values_len = 1;
614   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
615   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
616   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
617   sstrncpy (vl.type, "response_code", sizeof (vl.type));
619   plugin_dispatch_values (&vl);
620 } /* }}} void cc_submit_response_code */
622 static void cc_submit_response_time (const web_page_t *wp, /* {{{ */
623     cdtime_t response_time)
625   value_t values[1];
626   value_list_t vl = VALUE_LIST_INIT;
628   values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
630   vl.values = values;
631   vl.values_len = 1;
632   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
633   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
634   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
635   sstrncpy (vl.type, "response_time", sizeof (vl.type));
637   plugin_dispatch_values (&vl);
638 } /* }}} void cc_submit_response_time */
640 static int cc_read_page (web_page_t *wp) /* {{{ */
642   web_match_t *wm;
643   int status;
644   cdtime_t start = 0;
646   if (wp->response_time)
647     start = cdtime ();
649   wp->buffer_fill = 0;
650   status = curl_easy_perform (wp->curl);
651   if (status != CURLE_OK)
652   {
653     ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
654         status, wp->curl_errbuf);
655     return (-1);
656   }
658   if (wp->response_time)
659     cc_submit_response_time (wp, cdtime() - start);
661   if(wp->response_code)
662   {
663     long response_code = 0;
664     status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
665     if(status != CURLE_OK) {
666       ERROR ("curl plugin: Fetching response code failed with staus %i: %s",
667         status, wp->curl_errbuf);
668     } else {
669       cc_submit_response_code(wp, response_code);
670     }
671   }
673   for (wm = wp->matches; wm != NULL; wm = wm->next)
674   {
675     cu_match_value_t *mv;
677     status = match_apply (wm->match, wp->buffer);
678     if (status != 0)
679     {
680       WARNING ("curl plugin: match_apply failed.");
681       continue;
682     }
684     mv = match_get_user_data (wm->match);
685     if (mv == NULL)
686     {
687       WARNING ("curl plugin: match_get_user_data returned NULL.");
688       continue;
689     }
691     cc_submit (wp, wm, mv);
692   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
694   return (0);
695 } /* }}} int cc_read_page */
697 static int cc_read (void) /* {{{ */
699   web_page_t *wp;
701   for (wp = pages_g; wp != NULL; wp = wp->next)
702     cc_read_page (wp);
704   return (0);
705 } /* }}} int cc_read */
707 static int cc_shutdown (void) /* {{{ */
709   cc_web_page_free (pages_g);
710   pages_g = NULL;
712   return (0);
713 } /* }}} int cc_shutdown */
715 void module_register (void)
717   plugin_register_complex_config ("curl", cc_config);
718   plugin_register_init ("curl", cc_init);
719   plugin_register_read ("curl", cc_read);
720   plugin_register_shutdown ("curl", cc_shutdown);
721 } /* void module_register */
723 /* vim: set sw=2 sts=2 et fdm=marker : */