curl plugin: Remove the curl-only auxiliary configuration functions.
[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
30 #include <curl/curl.h>
31
32 /*
33  * Data types
34  */
35 struct web_match_s;
36 typedef struct web_match_s web_match_t;
37 struct web_match_s /* {{{ */
38 {
39   char *regex;
40   char *exclude_regex;
41   int dstype;
42   char *type;
43   char *instance;
44
45   cu_match_t *match;
46
47   web_match_t *next;
48 }; /* }}} */
49
50 struct web_page_s;
51 typedef struct web_page_s web_page_t;
52 struct web_page_s /* {{{ */
53 {
54   char *instance;
55
56   char *url;
57   char *user;
58   char *pass;
59   char *credentials;
60   _Bool verify_peer;
61   _Bool verify_host;
62   char *cacert;
63   struct curl_slist *headers;
64   char *post_body;
65   _Bool response_time;
66   _Bool response_code;
67
68   CURL *curl;
69   char curl_errbuf[CURL_ERROR_SIZE];
70   char *buffer;
71   size_t buffer_size;
72   size_t buffer_fill;
73
74   web_match_t *matches;
75
76   web_page_t *next;
77 }; /* }}} */
78
79 /*
80  * Global variables;
81  */
82 /* static CURLM *curl = NULL; */
83 static web_page_t *pages_g = NULL;
84
85 /*
86  * Private functions
87  */
88 static size_t cc_curl_callback (void *buf, /* {{{ */
89     size_t size, size_t nmemb, void *user_data)
90 {
91   web_page_t *wp;
92   size_t len;
93
94   len = size * nmemb;
95   if (len <= 0)
96     return (len);
97
98   wp = user_data;
99   if (wp == NULL)
100     return (0);
101
102   if ((wp->buffer_fill + len) >= wp->buffer_size)
103   {
104     char *temp;
105     size_t temp_size;
106
107     temp_size = wp->buffer_fill + len + 1;
108     temp = (char *) realloc (wp->buffer, temp_size);
109     if (temp == NULL)
110     {
111       ERROR ("curl plugin: realloc failed.");
112       return (0);
113     }
114     wp->buffer = temp;
115     wp->buffer_size = temp_size;
116   }
117
118   memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
119   wp->buffer_fill += len;
120   wp->buffer[wp->buffer_fill] = 0;
121
122   return (len);
123 } /* }}} size_t cc_curl_callback */
124
125 static void cc_web_match_free (web_match_t *wm) /* {{{ */
126 {
127   if (wm == NULL)
128     return;
129
130   sfree (wm->regex);
131   sfree (wm->type);
132   sfree (wm->instance);
133   match_destroy (wm->match);
134   cc_web_match_free (wm->next);
135   sfree (wm);
136 } /* }}} void cc_web_match_free */
137
138 static void cc_web_page_free (web_page_t *wp) /* {{{ */
139 {
140   if (wp == NULL)
141     return;
142
143   if (wp->curl != NULL)
144     curl_easy_cleanup (wp->curl);
145   wp->curl = NULL;
146
147   sfree (wp->instance);
148
149   sfree (wp->url);
150   sfree (wp->user);
151   sfree (wp->pass);
152   sfree (wp->credentials);
153   sfree (wp->cacert);
154   sfree (wp->post_body);
155   curl_slist_free_all (wp->headers);
156
157   sfree (wp->buffer);
158
159   cc_web_match_free (wp->matches);
160   cc_web_page_free (wp->next);
161   sfree (wp);
162 } /* }}} void cc_web_page_free */
163
164 static int cc_config_append_string (const char *name, struct curl_slist **dest, /* {{{ */
165     oconfig_item_t *ci)
166 {
167   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
168   {
169     WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
170     return (-1);
171   }
172
173   *dest = curl_slist_append(*dest, ci->values[0].value.string);
174   if (*dest == NULL)
175     return (-1);
176
177   return (0);
178 } /* }}} int cc_config_append_string */
179
180 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
181     oconfig_item_t *ci)
182 {
183   int dstype;
184
185   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
186   {
187     WARNING ("curl plugin: `DSType' needs exactly one string argument.");
188     return (-1);
189   }
190
191   if (strncasecmp ("Gauge", ci->values[0].value.string,
192         strlen ("Gauge")) == 0)
193   {
194     dstype = UTILS_MATCH_DS_TYPE_GAUGE;
195     if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
196       dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
197     else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
198       dstype |= UTILS_MATCH_CF_GAUGE_MIN;
199     else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
200       dstype |= UTILS_MATCH_CF_GAUGE_MAX;
201     else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
202       dstype |= UTILS_MATCH_CF_GAUGE_LAST;
203     else
204       dstype = 0;
205   }
206   else if (strncasecmp ("Counter", ci->values[0].value.string,
207         strlen ("Counter")) == 0)
208   {
209     dstype = UTILS_MATCH_DS_TYPE_COUNTER;
210     if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
211       dstype |= UTILS_MATCH_CF_COUNTER_SET;
212     else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
213       dstype |= UTILS_MATCH_CF_COUNTER_ADD;
214     else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
215       dstype |= UTILS_MATCH_CF_COUNTER_INC;
216     else
217       dstype = 0;
218   }
219 else if (strncasecmp ("Derive", ci->values[0].value.string,
220         strlen ("Derive")) == 0)
221   {
222     dstype = UTILS_MATCH_DS_TYPE_DERIVE;
223     if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
224       dstype |= UTILS_MATCH_CF_DERIVE_SET;
225     else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
226       dstype |= UTILS_MATCH_CF_DERIVE_ADD;
227     else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
228       dstype |= UTILS_MATCH_CF_DERIVE_INC;
229     else
230       dstype = 0;
231   }
232 else if (strncasecmp ("Absolute", ci->values[0].value.string,
233         strlen ("Absolute")) == 0)
234   {
235     dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
236     if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
237       dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
238     else
239       dstype = 0;
240   }
241
242   else
243   {
244     dstype = 0;
245   }
246
247   if (dstype == 0)
248   {
249     WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
250         ci->values[0].value.string);
251     return (-1);
252   }
253
254   *dstype_ret = dstype;
255   return (0);
256 } /* }}} int cc_config_add_match_dstype */
257
258 static int cc_config_add_match (web_page_t *page, /* {{{ */
259     oconfig_item_t *ci)
260 {
261   web_match_t *match;
262   int status;
263   int i;
264
265   if (ci->values_num != 0)
266   {
267     WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
268   }
269
270   match = (web_match_t *) malloc (sizeof (*match));
271   if (match == NULL)
272   {
273     ERROR ("curl plugin: malloc failed.");
274     return (-1);
275   }
276   memset (match, 0, sizeof (*match));
277
278   status = 0;
279   for (i = 0; i < ci->children_num; i++)
280   {
281     oconfig_item_t *child = ci->children + i;
282
283     if (strcasecmp ("Regex", child->key) == 0)
284       status = cf_util_get_string (child, &match->regex);
285     else if (strcasecmp ("ExcludeRegex", child->key) == 0)
286       status = cf_util_get_string (child, &match->exclude_regex);
287     else if (strcasecmp ("DSType", child->key) == 0)
288       status = cc_config_add_match_dstype (&match->dstype, child);
289     else if (strcasecmp ("Type", child->key) == 0)
290       status = cf_util_get_string (child, &match->type);
291     else if (strcasecmp ("Instance", child->key) == 0)
292       status = cf_util_get_string (child, &match->instance);
293     else
294     {
295       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
296       status = -1;
297     }
298
299     if (status != 0)
300       break;
301   } /* for (i = 0; i < ci->children_num; i++) */
302
303   while (status == 0)
304   {
305     if (match->regex == NULL)
306     {
307       WARNING ("curl plugin: `Regex' missing in `Match' block.");
308       status = -1;
309     }
310
311     if (match->type == NULL)
312     {
313       WARNING ("curl plugin: `Type' missing in `Match' block.");
314       status = -1;
315     }
316
317     if (match->dstype == 0)
318     {
319       WARNING ("curl plugin: `DSType' missing in `Match' block.");
320       status = -1;
321     }
322
323     break;
324   } /* while (status == 0) */
325
326   if (status != 0)
327     return (status);
328
329   match->match = match_create_simple (match->regex, match->exclude_regex,
330       match->dstype);
331   if (match->match == NULL)
332   {
333     ERROR ("curl plugin: tail_match_add_match_simple failed.");
334     cc_web_match_free (match);
335     return (-1);
336   }
337   else
338   {
339     web_match_t *prev;
340
341     prev = page->matches;
342     while ((prev != NULL) && (prev->next != NULL))
343       prev = prev->next;
344
345     if (prev == NULL)
346       page->matches = match;
347     else
348       prev->next = match;
349   }
350
351   return (0);
352 } /* }}} int cc_config_add_match */
353
354 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
355 {
356   wp->curl = curl_easy_init ();
357   if (wp->curl == NULL)
358   {
359     ERROR ("curl plugin: curl_easy_init failed.");
360     return (-1);
361   }
362
363   curl_easy_setopt (wp->curl, CURLOPT_NOSIGNAL, 1L);
364   curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
365   curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
366   curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
367       PACKAGE_NAME"/"PACKAGE_VERSION);
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   sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
589
590   plugin_dispatch_values (&vl);
591 } /* }}} void cc_submit */
592
593 static void cc_submit_response_code (const web_page_t *wp, long code) /* {{{ */
594 {
595   value_t values[1];
596   value_list_t vl = VALUE_LIST_INIT;
597
598   values[0].gauge = code;
599
600   vl.values = values;
601   vl.values_len = 1;
602   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
603   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
604   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
605   sstrncpy (vl.type, "response_code", sizeof (vl.type));
606
607   plugin_dispatch_values (&vl);
608 } /* }}} void cc_submit_response_code */
609
610 static void cc_submit_response_time (const web_page_t *wp, double seconds) /* {{{ */
611 {
612   value_t values[1];
613   value_list_t vl = VALUE_LIST_INIT;
614
615   values[0].gauge = seconds;
616
617   vl.values = values;
618   vl.values_len = 1;
619   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
620   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
621   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
622   sstrncpy (vl.type, "response_time", sizeof (vl.type));
623
624   plugin_dispatch_values (&vl);
625 } /* }}} void cc_submit_response_time */
626
627 static int cc_read_page (web_page_t *wp) /* {{{ */
628 {
629   web_match_t *wm;
630   int status;
631   struct timeval start, end;
632
633   if (wp->response_time)
634     gettimeofday (&start, NULL);
635
636   wp->buffer_fill = 0;
637   status = curl_easy_perform (wp->curl);
638   if (status != CURLE_OK)
639   {
640     ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
641         status, wp->curl_errbuf);
642     return (-1);
643   }
644
645   if(wp->response_code)
646   {
647     long response_code = 0;
648     status = curl_easy_getinfo(wp->curl, CURLINFO_RESPONSE_CODE, &response_code);
649     if(status != CURLE_OK) {
650       ERROR ("curl plugin: curl_easy_getinfo failed with staus %i: %s",
651         status, wp->curl_errbuf);
652       return (-1); // TODO: do we need to return in here? this is nonfatal error
653     }
654     cc_submit_response_code(wp, response_code);
655   }
656
657   if (wp->response_time)
658   {
659     double secs = 0;
660     gettimeofday (&end, NULL);
661     secs += end.tv_sec - start.tv_sec;
662     secs += (end.tv_usec - start.tv_usec) / 1000000.0;
663     cc_submit_response_time (wp, secs);
664   }
665
666   for (wm = wp->matches; wm != NULL; wm = wm->next)
667   {
668     cu_match_value_t *mv;
669
670     status = match_apply (wm->match, wp->buffer);
671     if (status != 0)
672     {
673       WARNING ("curl plugin: match_apply failed.");
674       continue;
675     }
676
677     mv = match_get_user_data (wm->match);
678     if (mv == NULL)
679     {
680       WARNING ("curl plugin: match_get_user_data returned NULL.");
681       continue;
682     }
683
684     cc_submit (wp, wm, mv);
685   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
686
687   return (0);
688 } /* }}} int cc_read_page */
689
690 static int cc_read (void) /* {{{ */
691 {
692   web_page_t *wp;
693
694   for (wp = pages_g; wp != NULL; wp = wp->next)
695     cc_read_page (wp);
696
697   return (0);
698 } /* }}} int cc_read */
699
700 static int cc_shutdown (void) /* {{{ */
701 {
702   cc_web_page_free (pages_g);
703   pages_g = NULL;
704
705   return (0);
706 } /* }}} int cc_shutdown */
707
708 void module_register (void)
709 {
710   plugin_register_complex_config ("curl", cc_config);
711   plugin_register_init ("curl", cc_init);
712   plugin_register_read ("curl", cc_read);
713   plugin_register_shutdown ("curl", cc_shutdown);
714 } /* void module_register */
715
716 /* vim: set sw=2 sts=2 et fdm=marker : */