collectd.conf(5): Updated the “GetSnapshot” entry.
[collectd.git] / src / curl.c
1 /**
2  * collectd - src/curl.c
3  * Copyright (C) 2006-2009  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  **/
21
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "configfile.h"
26 #include "utils_match.h"
27
28 #include <curl/curl.h>
29
30 /*
31  * Data types
32  */
33 struct web_match_s;
34 typedef struct web_match_s web_match_t;
35 struct web_match_s /* {{{ */
36 {
37   char *regex;
38   int dstype;
39   char *type;
40   char *instance;
41
42   cu_match_t *match;
43
44   web_match_t *next;
45 }; /* }}} */
46
47 struct web_page_s;
48 typedef struct web_page_s web_page_t;
49 struct web_page_s /* {{{ */
50 {
51   char *instance;
52
53   char *url;
54   char *user;
55   char *pass;
56   char *credentials;
57   int   verify_peer;
58   int   verify_host;
59   char *cacert;
60   int   response_time;
61
62   CURL *curl;
63   char curl_errbuf[CURL_ERROR_SIZE];
64   char *buffer;
65   size_t buffer_size;
66   size_t buffer_fill;
67
68   web_match_t *matches;
69
70   web_page_t *next;
71 }; /* }}} */
72
73 /*
74  * Global variables;
75  */
76 /* static CURLM *curl = NULL; */
77 static web_page_t *pages_g = NULL;
78
79 /*
80  * Private functions
81  */
82 static size_t cc_curl_callback (void *buf, /* {{{ */
83     size_t size, size_t nmemb, void *user_data)
84 {
85   web_page_t *wp;
86   size_t len;
87   
88   len = size * nmemb;
89   if (len <= 0)
90     return (len);
91
92   wp = user_data;
93   if (wp == NULL)
94     return (0);
95
96   if ((wp->buffer_fill + len) >= wp->buffer_size)
97   {
98     char *temp;
99     size_t temp_size;
100
101     temp_size = wp->buffer_fill + len + 1;
102     temp = (char *) realloc (wp->buffer, temp_size);
103     if (temp == NULL)
104     {
105       ERROR ("curl plugin: realloc failed.");
106       return (0);
107     }
108     wp->buffer = temp;
109     wp->buffer_size = temp_size;
110   }
111
112   memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
113   wp->buffer_fill += len;
114   wp->buffer[wp->buffer_fill] = 0;
115
116   return (len);
117 } /* }}} size_t cc_curl_callback */
118
119 static void cc_web_match_free (web_match_t *wm) /* {{{ */
120 {
121   if (wm == NULL)
122     return;
123
124   sfree (wm->regex);
125   sfree (wm->type);
126   sfree (wm->instance);
127   match_destroy (wm->match);
128   cc_web_match_free (wm->next);
129   sfree (wm);
130 } /* }}} void cc_web_match_free */
131
132 static void cc_web_page_free (web_page_t *wp) /* {{{ */
133 {
134   if (wp == NULL)
135     return;
136
137   if (wp->curl != NULL)
138     curl_easy_cleanup (wp->curl);
139   wp->curl = NULL;
140
141   sfree (wp->instance);
142
143   sfree (wp->url);
144   sfree (wp->user);
145   sfree (wp->pass);
146   sfree (wp->credentials);
147   sfree (wp->cacert);
148
149   sfree (wp->buffer);
150
151   cc_web_match_free (wp->matches);
152   cc_web_page_free (wp->next);
153   sfree (wp);
154 } /* }}} void cc_web_page_free */
155
156 static int cc_config_add_string (const char *name, char **dest, /* {{{ */
157     oconfig_item_t *ci)
158 {
159   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
160   {
161     WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
162     return (-1);
163   }
164
165   sfree (*dest);
166   *dest = strdup (ci->values[0].value.string);
167   if (*dest == NULL)
168     return (-1);
169
170   return (0);
171 } /* }}} int cc_config_add_string */
172
173 static int cc_config_set_boolean (const char *name, int *dest, /* {{{ */
174     oconfig_item_t *ci)
175 {
176   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
177   {
178     WARNING ("curl plugin: `%s' needs exactly one boolean argument.", name);
179     return (-1);
180   }
181
182   *dest = ci->values[0].value.boolean ? 1 : 0;
183
184   return (0);
185 } /* }}} int cc_config_set_boolean */
186
187 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
188     oconfig_item_t *ci)
189 {
190   int dstype;
191
192   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
193   {
194     WARNING ("curl plugin: `DSType' needs exactly one string argument.");
195     return (-1);
196   }
197
198   if (strncasecmp ("Gauge", ci->values[0].value.string,
199         strlen ("Gauge")) == 0)
200   {
201     dstype = UTILS_MATCH_DS_TYPE_GAUGE;
202     if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
203       dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
204     else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
205       dstype |= UTILS_MATCH_CF_GAUGE_MIN;
206     else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
207       dstype |= UTILS_MATCH_CF_GAUGE_MAX;
208     else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
209       dstype |= UTILS_MATCH_CF_GAUGE_LAST;
210     else
211       dstype = 0;
212   }
213   else if (strncasecmp ("Counter", ci->values[0].value.string,
214         strlen ("Counter")) == 0)
215   {
216     dstype = UTILS_MATCH_DS_TYPE_COUNTER;
217     if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
218       dstype |= UTILS_MATCH_CF_COUNTER_SET;
219     else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
220       dstype |= UTILS_MATCH_CF_COUNTER_ADD;
221     else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
222       dstype |= UTILS_MATCH_CF_COUNTER_INC;
223     else
224       dstype = 0;
225   }
226 else if (strncasecmp ("Derive", ci->values[0].value.string,
227         strlen ("Derive")) == 0)
228   {
229     dstype = UTILS_MATCH_DS_TYPE_DERIVE;
230     if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
231       dstype |= UTILS_MATCH_CF_DERIVE_SET;
232     else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
233       dstype |= UTILS_MATCH_CF_DERIVE_ADD;
234     else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
235       dstype |= UTILS_MATCH_CF_DERIVE_INC;
236     else
237       dstype = 0;
238   }
239 else if (strncasecmp ("Absolute", ci->values[0].value.string,
240         strlen ("Absolute")) == 0)
241   {
242     dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
243     if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
244       dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
245     else
246       dstype = 0;
247   }
248
249   else
250   {
251     dstype = 0;
252   }
253
254   if (dstype == 0)
255   {
256     WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
257         ci->values[0].value.string);
258     return (-1);
259   }
260
261   *dstype_ret = dstype;
262   return (0);
263 } /* }}} int cc_config_add_match_dstype */
264
265 static int cc_config_add_match (web_page_t *page, /* {{{ */
266     oconfig_item_t *ci)
267 {
268   web_match_t *match;
269   int status;
270   int i;
271
272   if (ci->values_num != 0)
273   {
274     WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
275   }
276
277   match = (web_match_t *) malloc (sizeof (*match));
278   if (match == NULL)
279   {
280     ERROR ("curl plugin: malloc failed.");
281     return (-1);
282   }
283   memset (match, 0, sizeof (*match));
284
285   status = 0;
286   for (i = 0; i < ci->children_num; i++)
287   {
288     oconfig_item_t *child = ci->children + i;
289
290     if (strcasecmp ("Regex", child->key) == 0)
291       status = cc_config_add_string ("Regex", &match->regex, child);
292     else if (strcasecmp ("DSType", child->key) == 0)
293       status = cc_config_add_match_dstype (&match->dstype, child);
294     else if (strcasecmp ("Type", child->key) == 0)
295       status = cc_config_add_string ("Type", &match->type, child);
296     else if (strcasecmp ("Instance", child->key) == 0)
297       status = cc_config_add_string ("Instance", &match->instance, child);
298     else
299     {
300       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
301       status = -1;
302     }
303
304     if (status != 0)
305       break;
306   } /* for (i = 0; i < ci->children_num; i++) */
307
308   while (status == 0)
309   {
310     if (match->regex == NULL)
311     {
312       WARNING ("curl plugin: `Regex' missing in `Match' block.");
313       status = -1;
314     }
315
316     if (match->type == NULL)
317     {
318       WARNING ("curl plugin: `Type' missing in `Match' block.");
319       status = -1;
320     }
321
322     if (match->dstype == 0)
323     {
324       WARNING ("curl plugin: `DSType' missing in `Match' block.");
325       status = -1;
326     }
327
328     break;
329   } /* while (status == 0) */
330
331   if (status != 0)
332     return (status);
333
334   match->match = match_create_simple (match->regex, 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;
344
345     prev = page->matches;
346     while ((prev != NULL) && (prev->next != NULL))
347       prev = prev->next;
348
349     if (prev == NULL)
350       page->matches = match;
351     else
352       prev->next = match;
353   }
354
355   return (0);
356 } /* }}} int cc_config_add_match */
357
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   }
366
367   curl_easy_setopt (wp->curl, CURLOPT_WRITEFUNCTION, cc_curl_callback);
368   curl_easy_setopt (wp->curl, CURLOPT_WRITEDATA, wp);
369   curl_easy_setopt (wp->curl, CURLOPT_USERAGENT,
370       PACKAGE_NAME"/"PACKAGE_VERSION);
371   curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
372   curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
373   curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1);
374
375   if (wp->user != NULL)
376   {
377     size_t credentials_size;
378
379     credentials_size = strlen (wp->user) + 2;
380     if (wp->pass != NULL)
381       credentials_size += strlen (wp->pass);
382
383     wp->credentials = (char *) malloc (credentials_size);
384     if (wp->credentials == NULL)
385     {
386       ERROR ("curl plugin: malloc failed.");
387       return (-1);
388     }
389
390     ssnprintf (wp->credentials, credentials_size, "%s:%s",
391         wp->user, (wp->pass == NULL) ? "" : wp->pass);
392     curl_easy_setopt (wp->curl, CURLOPT_USERPWD, wp->credentials);
393   }
394
395   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYPEER, wp->verify_peer);
396   curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
397       wp->verify_host ? 2 : 0);
398   if (wp->cacert != NULL)
399     curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
400
401   return (0);
402 } /* }}} int cc_page_init_curl */
403
404 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
405 {
406   web_page_t *page;
407   int status;
408   int i;
409
410   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
411   {
412     WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
413     return (-1);
414   }
415
416   page = (web_page_t *) malloc (sizeof (*page));
417   if (page == NULL)
418   {
419     ERROR ("curl plugin: malloc failed.");
420     return (-1);
421   }
422   memset (page, 0, sizeof (*page));
423   page->url = NULL;
424   page->user = NULL;
425   page->pass = NULL;
426   page->verify_peer = 1;
427   page->verify_host = 1;
428   page->response_time = 0;
429
430   page->instance = strdup (ci->values[0].value.string);
431   if (page->instance == NULL)
432   {
433     ERROR ("curl plugin: strdup failed.");
434     sfree (page);
435     return (-1);
436   }
437
438   /* Process all children */
439   status = 0;
440   for (i = 0; i < ci->children_num; i++)
441   {
442     oconfig_item_t *child = ci->children + i;
443
444     if (strcasecmp ("URL", child->key) == 0)
445       status = cc_config_add_string ("URL", &page->url, child);
446     else if (strcasecmp ("User", child->key) == 0)
447       status = cc_config_add_string ("User", &page->user, child);
448     else if (strcasecmp ("Password", child->key) == 0)
449       status = cc_config_add_string ("Password", &page->pass, child);
450     else if (strcasecmp ("VerifyPeer", child->key) == 0)
451       status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
452     else if (strcasecmp ("VerifyHost", child->key) == 0)
453       status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
454     else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
455       status = cc_config_set_boolean (child->key, &page->response_time, child);
456     else if (strcasecmp ("CACert", child->key) == 0)
457       status = cc_config_add_string ("CACert", &page->cacert, child);
458     else if (strcasecmp ("Match", child->key) == 0)
459       /* Be liberal with failing matches => don't set `status'. */
460       cc_config_add_match (page, child);
461     else
462     {
463       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
464       status = -1;
465     }
466
467     if (status != 0)
468       break;
469   } /* for (i = 0; i < ci->children_num; i++) */
470
471   /* Additionial sanity checks and libCURL initialization. */
472   while (status == 0)
473   {
474     if (page->url == NULL)
475     {
476       WARNING ("curl plugin: `URL' missing in `Page' block.");
477       status = -1;
478     }
479
480     if (page->matches == NULL && !page->response_time)
481     {
482       assert (page->instance != NULL);
483       WARNING ("curl plugin: No (valid) `Match' block "
484           "or MeasureResponseTime within `Page' block `%s'.", page->instance);
485       status = -1;
486     }
487
488     if (status == 0)
489       status = cc_page_init_curl (page);
490
491     break;
492   } /* while (status == 0) */
493
494   if (status != 0)
495   {
496     cc_web_page_free (page);
497     return (status);
498   }
499
500   /* Add the new page to the linked list */
501   if (pages_g == NULL)
502     pages_g = page;
503   else
504   {
505     web_page_t *prev;
506
507     prev = pages_g;
508     while ((prev != NULL) && (prev->next != NULL))
509       prev = prev->next;
510     prev->next = page;
511   }
512
513   return (0);
514 } /* }}} int cc_config_add_page */
515
516 static int cc_config (oconfig_item_t *ci) /* {{{ */
517 {
518   int success;
519   int errors;
520   int status;
521   int i;
522
523   success = 0;
524   errors = 0;
525
526   for (i = 0; i < ci->children_num; i++)
527   {
528     oconfig_item_t *child = ci->children + i;
529
530     if (strcasecmp ("Page", child->key) == 0)
531     {
532       status = cc_config_add_page (child);
533       if (status == 0)
534         success++;
535       else
536         errors++;
537     }
538     else
539     {
540       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
541       errors++;
542     }
543   }
544
545   if ((success == 0) && (errors > 0))
546   {
547     ERROR ("curl plugin: All statements failed.");
548     return (-1);
549   }
550
551   return (0);
552 } /* }}} int cc_config */
553
554 static int cc_init (void) /* {{{ */
555 {
556   if (pages_g == NULL)
557   {
558     INFO ("curl plugin: No pages have been defined.");
559     return (-1);
560   }
561   return (0);
562 } /* }}} int cc_init */
563
564 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
565     const cu_match_value_t *mv)
566 {
567   value_t values[1];
568   value_list_t vl = VALUE_LIST_INIT;
569
570   values[0] = mv->value;
571
572   vl.values = values;
573   vl.values_len = 1;
574   vl.time = time (NULL);
575   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
576   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
577   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
578   sstrncpy (vl.type, wm->type, sizeof (vl.type));
579   sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
580
581   plugin_dispatch_values (&vl);
582 } /* }}} void cc_submit */
583
584 static void cc_submit_response_time (const web_page_t *wp, double seconds) /* {{{ */
585 {
586   value_t values[1];
587   value_list_t vl = VALUE_LIST_INIT;
588
589   values[0].gauge = seconds;
590
591   vl.values = values;
592   vl.values_len = 1;
593   vl.time = time (NULL);
594   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
595   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
596   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
597   sstrncpy (vl.type, "response_time", sizeof (vl.type));
598
599   plugin_dispatch_values (&vl);
600 } /* }}} void cc_submit_response_time */
601
602 static int cc_read_page (web_page_t *wp) /* {{{ */
603 {
604   web_match_t *wm;
605   int status;
606   struct timeval start, end;
607
608   if (wp->response_time)
609     gettimeofday (&start, NULL);
610
611   wp->buffer_fill = 0;
612   status = curl_easy_perform (wp->curl);
613   if (status != 0)
614   {
615     ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
616         status, wp->curl_errbuf);
617     return (-1);
618   }
619
620   if (wp->response_time)
621   {
622     double secs = 0;
623     gettimeofday (&end, NULL);
624     secs += end.tv_sec - start.tv_sec;
625     secs += (end.tv_usec - start.tv_usec) / 1000000.0;
626     cc_submit_response_time (wp, secs);
627   }
628
629   for (wm = wp->matches; wm != NULL; wm = wm->next)
630   {
631     cu_match_value_t *mv;
632
633     status = match_apply (wm->match, wp->buffer);
634     if (status != 0)
635     {
636       WARNING ("curl plugin: match_apply failed.");
637       continue;
638     }
639
640     mv = match_get_user_data (wm->match);
641     if (mv == NULL)
642     {
643       WARNING ("curl plugin: match_get_user_data returned NULL.");
644       continue;
645     }
646
647     cc_submit (wp, wm, mv);
648   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
649
650   return (0);
651 } /* }}} int cc_read_page */
652
653 static int cc_read (void) /* {{{ */
654 {
655   web_page_t *wp;
656
657   for (wp = pages_g; wp != NULL; wp = wp->next)
658     cc_read_page (wp);
659
660   return (0);
661 } /* }}} int cc_read */
662
663 static int cc_shutdown (void) /* {{{ */
664 {
665   cc_web_page_free (pages_g);
666   pages_g = NULL;
667
668   return (0);
669 } /* }}} int cc_shutdown */
670
671 void module_register (void)
672 {
673   plugin_register_complex_config ("curl", cc_config);
674   plugin_register_init ("curl", cc_init);
675   plugin_register_read ("curl", cc_read);
676   plugin_register_shutdown ("curl", cc_shutdown);
677 } /* void module_register */
678
679 /* vim: set sw=2 sts=2 et fdm=marker : */