Merge branch 'collectd-5.4'
[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  **/
23
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"
30
31 #include <curl/curl.h>
32
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;
45
46   cu_match_t *match;
47
48   web_match_t *next;
49 }; /* }}} */
50
51 struct web_page_s;
52 typedef struct web_page_s web_page_t;
53 struct web_page_s /* {{{ */
54 {
55   char *instance;
56
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;
68
69   CURL *curl;
70   char curl_errbuf[CURL_ERROR_SIZE];
71   char *buffer;
72   size_t buffer_size;
73   size_t buffer_fill;
74
75   web_match_t *matches;
76
77   web_page_t *next;
78 }; /* }}} */
79
80 /*
81  * Global variables;
82  */
83 /* static CURLM *curl = NULL; */
84 static web_page_t *pages_g = NULL;
85
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;
94
95   len = size * nmemb;
96   if (len <= 0)
97     return (len);
98
99   wp = user_data;
100   if (wp == NULL)
101     return (0);
102
103   if ((wp->buffer_fill + len) >= wp->buffer_size)
104   {
105     char *temp;
106     size_t temp_size;
107
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   }
118
119   memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
120   wp->buffer_fill += len;
121   wp->buffer[wp->buffer_fill] = 0;
122
123   return (len);
124 } /* }}} size_t cc_curl_callback */
125
126 static void cc_web_match_free (web_match_t *wm) /* {{{ */
127 {
128   if (wm == NULL)
129     return;
130
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 */
138
139 static void cc_web_page_free (web_page_t *wp) /* {{{ */
140 {
141   if (wp == NULL)
142     return;
143
144   if (wp->curl != NULL)
145     curl_easy_cleanup (wp->curl);
146   wp->curl = NULL;
147
148   sfree (wp->instance);
149
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);
157
158   sfree (wp->buffer);
159
160   cc_web_match_free (wp->matches);
161   cc_web_page_free (wp->next);
162   sfree (wp);
163 } /* }}} void cc_web_page_free */
164
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   }
173
174   *dest = curl_slist_append(*dest, ci->values[0].value.string);
175   if (*dest == NULL)
176     return (-1);
177
178   return (0);
179 } /* }}} int cc_config_append_string */
180
181 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
182     oconfig_item_t *ci)
183 {
184   int dstype;
185
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   }
191
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   }
242
243   else
244   {
245     dstype = 0;
246   }
247
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   }
254
255   *dstype_ret = dstype;
256   return (0);
257 } /* }}} int cc_config_add_match_dstype */
258
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;
265
266   if (ci->values_num != 0)
267   {
268     WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
269   }
270
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));
278
279   status = 0;
280   for (i = 0; i < ci->children_num; i++)
281   {
282     oconfig_item_t *child = ci->children + i;
283
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     }
299
300     if (status != 0)
301       break;
302   } /* for (i = 0; i < ci->children_num; i++) */
303
304   while (status == 0)
305   {
306     if (match->regex == NULL)
307     {
308       WARNING ("curl plugin: `Regex' missing in `Match' block.");
309       status = -1;
310     }
311
312     if (match->type == NULL)
313     {
314       WARNING ("curl plugin: `Type' missing in `Match' block.");
315       status = -1;
316     }
317
318     if (match->dstype == 0)
319     {
320       WARNING ("curl plugin: `DSType' missing in `Match' block.");
321       status = -1;
322     }
323
324     break;
325   } /* while (status == 0) */
326
327   if (status != 0)
328     return (status);
329
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;
341
342     prev = page->matches;
343     while ((prev != NULL) && (prev->next != NULL))
344       prev = prev->next;
345
346     if (prev == NULL)
347       page->matches = match;
348     else
349       prev->next = match;
350   }
351
352   return (0);
353 } /* }}} int cc_config_add_match */
354
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   }
363
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, COLLECTD_USERAGENT);
368   curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
369   curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
370   curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1L);
371   curl_easy_setopt (wp->curl, CURLOPT_MAXREDIRS, 50L);
372
373   if (wp->user != NULL)
374   {
375     size_t credentials_size;
376
377     credentials_size = strlen (wp->user) + 2;
378     if (wp->pass != NULL)
379       credentials_size += strlen (wp->pass);
380
381     wp->credentials = (char *) malloc (credentials_size);
382     if (wp->credentials == NULL)
383     {
384       ERROR ("curl plugin: malloc failed.");
385       return (-1);
386     }
387
388     ssnprintf (wp->credentials, credentials_size, "%s:%s",
389         wp->user, (wp->pass == NULL) ? "" : wp->pass);
390     curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
391   }
392
393   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, (long) wp->verify_peer);
394   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
395       wp->verify_host ? 2L : 0L);
396   if (wp->cacert != NULL)
397     curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
398   if (wp->headers != NULL)
399     curl_easy_setopt (wp->curl, CURLOPT_HTTPHEADER, wp->headers);
400   if (wp->post_body != NULL)
401     curl_easy_setopt (wp->curl, CURLOPT_POSTFIELDS, wp->post_body);
402
403   return (0);
404 } /* }}} int cc_page_init_curl */
405
406 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
407 {
408   web_page_t *page;
409   int status;
410   int i;
411
412   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
413   {
414     WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
415     return (-1);
416   }
417
418   page = (web_page_t *) malloc (sizeof (*page));
419   if (page == NULL)
420   {
421     ERROR ("curl plugin: malloc failed.");
422     return (-1);
423   }
424   memset (page, 0, sizeof (*page));
425   page->url = NULL;
426   page->user = NULL;
427   page->pass = NULL;
428   page->verify_peer = 1;
429   page->verify_host = 1;
430   page->response_time = 0;
431   page->response_code = 0;
432
433   page->instance = strdup (ci->values[0].value.string);
434   if (page->instance == NULL)
435   {
436     ERROR ("curl plugin: strdup failed.");
437     sfree (page);
438     return (-1);
439   }
440
441   /* Process all children */
442   status = 0;
443   for (i = 0; i < ci->children_num; i++)
444   {
445     oconfig_item_t *child = ci->children + i;
446
447     if (strcasecmp ("URL", child->key) == 0)
448       status = cf_util_get_string (child, &page->url);
449     else if (strcasecmp ("User", child->key) == 0)
450       status = cf_util_get_string (child, &page->user);
451     else if (strcasecmp ("Password", child->key) == 0)
452       status = cf_util_get_string (child, &page->pass);
453     else if (strcasecmp ("VerifyPeer", child->key) == 0)
454       status = cf_util_get_boolean (child, &page->verify_peer);
455     else if (strcasecmp ("VerifyHost", child->key) == 0)
456       status = cf_util_get_boolean (child, &page->verify_host);
457     else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
458       status = cf_util_get_boolean (child, &page->response_time);
459     else if (strcasecmp ("MeasureResponseCode", child->key) == 0)
460       status = cf_util_get_boolean (child, &page->response_code);
461     else if (strcasecmp ("CACert", child->key) == 0)
462       status = cf_util_get_string (child, &page->cacert);
463     else if (strcasecmp ("Match", child->key) == 0)
464       /* Be liberal with failing matches => don't set `status'. */
465       cc_config_add_match (page, child);
466     else if (strcasecmp ("Header", child->key) == 0)
467       status = cc_config_append_string ("Header", &page->headers, child);
468     else if (strcasecmp ("Post", child->key) == 0)
469       status = cf_util_get_string (child, &page->post_body);
470     else
471     {
472       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
473       status = -1;
474     }
475
476     if (status != 0)
477       break;
478   } /* for (i = 0; i < ci->children_num; i++) */
479
480   /* Additionial sanity checks and libCURL initialization. */
481   while (status == 0)
482   {
483     if (page->url == NULL)
484     {
485       WARNING ("curl plugin: `URL' missing in `Page' block.");
486       status = -1;
487     }
488
489     if (page->matches == NULL && !page->response_time && !page->response_code)
490     {
491       assert (page->instance != NULL);
492       WARNING ("curl plugin: No (valid) `Match' block "
493           "or MeasureResponseTime or MeasureResponseCode within "
494           "`Page' block `%s'.", page->instance);
495       status = -1;
496     }
497
498     if (status == 0)
499       status = cc_page_init_curl (page);
500
501     break;
502   } /* while (status == 0) */
503
504   if (status != 0)
505   {
506     cc_web_page_free (page);
507     return (status);
508   }
509
510   /* Add the new page to the linked list */
511   if (pages_g == NULL)
512     pages_g = page;
513   else
514   {
515     web_page_t *prev;
516
517     prev = pages_g;
518     while ((prev != NULL) && (prev->next != NULL))
519       prev = prev->next;
520     prev->next = page;
521   }
522
523   return (0);
524 } /* }}} int cc_config_add_page */
525
526 static int cc_config (oconfig_item_t *ci) /* {{{ */
527 {
528   int success;
529   int errors;
530   int status;
531   int i;
532
533   success = 0;
534   errors = 0;
535
536   for (i = 0; i < ci->children_num; i++)
537   {
538     oconfig_item_t *child = ci->children + i;
539
540     if (strcasecmp ("Page", child->key) == 0)
541     {
542       status = cc_config_add_page (child);
543       if (status == 0)
544         success++;
545       else
546         errors++;
547     }
548     else
549     {
550       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
551       errors++;
552     }
553   }
554
555   if ((success == 0) && (errors > 0))
556   {
557     ERROR ("curl plugin: All statements failed.");
558     return (-1);
559   }
560
561   return (0);
562 } /* }}} int cc_config */
563
564 static int cc_init (void) /* {{{ */
565 {
566   if (pages_g == NULL)
567   {
568     INFO ("curl plugin: No pages have been defined.");
569     return (-1);
570   }
571   return (0);
572 } /* }}} int cc_init */
573
574 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
575     const cu_match_value_t *mv)
576 {
577   value_t values[1];
578   value_list_t vl = VALUE_LIST_INIT;
579
580   values[0] = mv->value;
581
582   vl.values = values;
583   vl.values_len = 1;
584   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
585   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
586   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
587   sstrncpy (vl.type, wm->type, sizeof (vl.type));
588   if (wm->instance != NULL)
589     sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
590
591   plugin_dispatch_values (&vl);
592 } /* }}} void cc_submit */
593
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;
598
599   values[0].gauge = code;
600
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));
607
608   plugin_dispatch_values (&vl);
609 } /* }}} void cc_submit_response_code */
610
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;
616
617   values[0].gauge = CDTIME_T_TO_DOUBLE (response_time);
618
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));
625
626   plugin_dispatch_values (&vl);
627 } /* }}} void cc_submit_response_time */
628
629 static int cc_read_page (web_page_t *wp) /* {{{ */
630 {
631   web_match_t *wm;
632   int status;
633   cdtime_t start = 0;
634
635   if (wp->response_time)
636     start = cdtime ();
637
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   }
646
647   if (wp->response_time)
648     cc_submit_response_time (wp, cdtime() - start);
649
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   }
661
662   for (wm = wp->matches; wm != NULL; wm = wm->next)
663   {
664     cu_match_value_t *mv;
665
666     status = match_apply (wm->match, wp->buffer);
667     if (status != 0)
668     {
669       WARNING ("curl plugin: match_apply failed.");
670       continue;
671     }
672
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     }
679
680     cc_submit (wp, wm, mv);
681   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
682
683   return (0);
684 } /* }}} int cc_read_page */
685
686 static int cc_read (void) /* {{{ */
687 {
688   web_page_t *wp;
689
690   for (wp = pages_g; wp != NULL; wp = wp->next)
691     cc_read_page (wp);
692
693   return (0);
694 } /* }}} int cc_read */
695
696 static int cc_shutdown (void) /* {{{ */
697 {
698   cc_web_page_free (pages_g);
699   pages_g = NULL;
700
701   return (0);
702 } /* }}} int cc_shutdown */
703
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 */
711
712 /* vim: set sw=2 sts=2 et fdm=marker : */