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 **/
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "configfile.h"
26 #include "utils_match.h"
28 #include <curl/curl.h>
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;
42 cu_match_t *match;
44 web_match_t *next;
45 }; /* }}} */
47 struct web_page_s;
48 typedef struct web_page_s web_page_t;
49 struct web_page_s /* {{{ */
50 {
51 char *instance;
53 char *url;
54 char *user;
55 char *pass;
56 char *credentials;
57 int verify_peer;
58 int verify_host;
59 char *cacert;
61 CURL *curl;
62 char curl_errbuf[CURL_ERROR_SIZE];
63 char *buffer;
64 size_t buffer_size;
65 size_t buffer_fill;
67 web_match_t *matches;
69 web_page_t *next;
70 }; /* }}} */
72 /*
73 * Global variables;
74 */
75 /* static CURLM *curl = NULL; */
76 static web_page_t *pages_g = NULL;
78 /*
79 * Private functions
80 */
81 static size_t cc_curl_callback (void *buf, /* {{{ */
82 size_t size, size_t nmemb, void *user_data)
83 {
84 web_page_t *wp;
85 size_t len;
87 len = size * nmemb;
88 if (len <= 0)
89 return (len);
91 wp = user_data;
92 if (wp == NULL)
93 return (0);
95 if ((wp->buffer_fill + len) >= wp->buffer_size)
96 {
97 char *temp;
98 size_t temp_size;
100 temp_size = wp->buffer_fill + len + 1;
101 temp = (char *) realloc (wp->buffer, temp_size);
102 if (temp == NULL)
103 {
104 ERROR ("curl plugin: realloc failed.");
105 return (0);
106 }
107 wp->buffer = temp;
108 wp->buffer_size = temp_size;
109 }
111 memcpy (wp->buffer + wp->buffer_fill, (char *) buf, len);
112 wp->buffer_fill += len;
113 wp->buffer[wp->buffer_fill] = 0;
115 return (len);
116 } /* }}} size_t cc_curl_callback */
118 static void cc_web_match_free (web_match_t *wm) /* {{{ */
119 {
120 if (wm == NULL)
121 return;
123 sfree (wm->regex);
124 sfree (wm->type);
125 sfree (wm->instance);
126 match_destroy (wm->match);
127 cc_web_match_free (wm->next);
128 sfree (wm);
129 } /* }}} void cc_web_match_free */
131 static void cc_web_page_free (web_page_t *wp) /* {{{ */
132 {
133 if (wp == NULL)
134 return;
136 if (wp->curl != NULL)
137 curl_easy_cleanup (wp->curl);
138 wp->curl = NULL;
140 sfree (wp->instance);
142 sfree (wp->url);
143 sfree (wp->user);
144 sfree (wp->pass);
145 sfree (wp->credentials);
146 sfree (wp->cacert);
148 sfree (wp->buffer);
150 cc_web_match_free (wp->matches);
151 cc_web_page_free (wp->next);
152 sfree (wp);
153 } /* }}} void cc_web_page_free */
155 static int cc_config_add_string (const char *name, char **dest, /* {{{ */
156 oconfig_item_t *ci)
157 {
158 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
159 {
160 WARNING ("curl plugin: `%s' needs exactly one string argument.", name);
161 return (-1);
162 }
164 sfree (*dest);
165 *dest = strdup (ci->values[0].value.string);
166 if (*dest == NULL)
167 return (-1);
169 return (0);
170 } /* }}} int cc_config_add_string */
172 static int cc_config_set_boolean (const char *name, int *dest, /* {{{ */
173 oconfig_item_t *ci)
174 {
175 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
176 {
177 WARNING ("curl plugin: `%s' needs exactly one boolean argument.", name);
178 return (-1);
179 }
181 *dest = ci->values[0].value.boolean ? 1 : 0;
183 return (0);
184 } /* }}} int cc_config_set_boolean */
186 static int cc_config_add_match_dstype (int *dstype_ret, /* {{{ */
187 oconfig_item_t *ci)
188 {
189 int dstype;
191 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
192 {
193 WARNING ("curl plugin: `DSType' needs exactly one string argument.");
194 return (-1);
195 }
197 if (strncasecmp ("Gauge", ci->values[0].value.string,
198 strlen ("Gauge")) == 0)
199 {
200 dstype = UTILS_MATCH_DS_TYPE_GAUGE;
201 if (strcasecmp ("GaugeAverage", ci->values[0].value.string) == 0)
202 dstype |= UTILS_MATCH_CF_GAUGE_AVERAGE;
203 else if (strcasecmp ("GaugeMin", ci->values[0].value.string) == 0)
204 dstype |= UTILS_MATCH_CF_GAUGE_MIN;
205 else if (strcasecmp ("GaugeMax", ci->values[0].value.string) == 0)
206 dstype |= UTILS_MATCH_CF_GAUGE_MAX;
207 else if (strcasecmp ("GaugeLast", ci->values[0].value.string) == 0)
208 dstype |= UTILS_MATCH_CF_GAUGE_LAST;
209 else
210 dstype = 0;
211 }
212 else if (strncasecmp ("Counter", ci->values[0].value.string,
213 strlen ("Counter")) == 0)
214 {
215 dstype = UTILS_MATCH_DS_TYPE_COUNTER;
216 if (strcasecmp ("CounterSet", ci->values[0].value.string) == 0)
217 dstype |= UTILS_MATCH_CF_COUNTER_SET;
218 else if (strcasecmp ("CounterAdd", ci->values[0].value.string) == 0)
219 dstype |= UTILS_MATCH_CF_COUNTER_ADD;
220 else if (strcasecmp ("CounterInc", ci->values[0].value.string) == 0)
221 dstype |= UTILS_MATCH_CF_COUNTER_INC;
222 else
223 dstype = 0;
224 }
225 else if (strncasecmp ("Derive", ci->values[0].value.string,
226 strlen ("Derive")) == 0)
227 {
228 dstype = UTILS_MATCH_DS_TYPE_DERIVE;
229 if (strcasecmp ("DeriveSet", ci->values[0].value.string) == 0)
230 dstype |= UTILS_MATCH_CF_DERIVE_SET;
231 else if (strcasecmp ("DeriveAdd", ci->values[0].value.string) == 0)
232 dstype |= UTILS_MATCH_CF_DERIVE_ADD;
233 else if (strcasecmp ("DeriveInc", ci->values[0].value.string) == 0)
234 dstype |= UTILS_MATCH_CF_DERIVE_INC;
235 else
236 dstype = 0;
237 }
238 else if (strncasecmp ("Absolute", ci->values[0].value.string,
239 strlen ("Absolute")) == 0)
240 {
241 dstype = UTILS_MATCH_DS_TYPE_ABSOLUTE;
242 if (strcasecmp ("AbsoluteSet", ci->values[0].value.string) == 0) /* Absolute DS is reset-on-read so no sense doin anything else but set */
243 dstype |= UTILS_MATCH_CF_ABSOLUTE_SET;
244 else
245 dstype = 0;
246 }
248 else
249 {
250 dstype = 0;
251 }
253 if (dstype == 0)
254 {
255 WARNING ("curl plugin: `%s' is not a valid argument to `DSType'.",
256 ci->values[0].value.string);
257 return (-1);
258 }
260 *dstype_ret = dstype;
261 return (0);
262 } /* }}} int cc_config_add_match_dstype */
264 static int cc_config_add_match (web_page_t *page, /* {{{ */
265 oconfig_item_t *ci)
266 {
267 web_match_t *match;
268 int status;
269 int i;
271 if (ci->values_num != 0)
272 {
273 WARNING ("curl plugin: Ignoring arguments for the `Match' block.");
274 }
276 match = (web_match_t *) malloc (sizeof (*match));
277 if (match == NULL)
278 {
279 ERROR ("curl plugin: malloc failed.");
280 return (-1);
281 }
282 memset (match, 0, sizeof (*match));
284 status = 0;
285 for (i = 0; i < ci->children_num; i++)
286 {
287 oconfig_item_t *child = ci->children + i;
289 if (strcasecmp ("Regex", child->key) == 0)
290 status = cc_config_add_string ("Regex", &match->regex, child);
291 else if (strcasecmp ("DSType", child->key) == 0)
292 status = cc_config_add_match_dstype (&match->dstype, child);
293 else if (strcasecmp ("Type", child->key) == 0)
294 status = cc_config_add_string ("Type", &match->type, child);
295 else if (strcasecmp ("Instance", child->key) == 0)
296 status = cc_config_add_string ("Instance", &match->instance, child);
297 else
298 {
299 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
300 status = -1;
301 }
303 if (status != 0)
304 break;
305 } /* for (i = 0; i < ci->children_num; i++) */
307 while (status == 0)
308 {
309 if (match->regex == NULL)
310 {
311 WARNING ("curl plugin: `Regex' missing in `Match' block.");
312 status = -1;
313 }
315 if (match->type == NULL)
316 {
317 WARNING ("curl plugin: `Type' missing in `Match' block.");
318 status = -1;
319 }
321 if (match->dstype == 0)
322 {
323 WARNING ("curl plugin: `DSType' missing in `Match' block.");
324 status = -1;
325 }
327 break;
328 } /* while (status == 0) */
330 if (status != 0)
331 return (status);
333 match->match = match_create_simple (match->regex, match->dstype);
334 if (match->match == NULL)
335 {
336 ERROR ("curl plugin: tail_match_add_match_simple failed.");
337 cc_web_match_free (match);
338 return (-1);
339 }
340 else
341 {
342 web_match_t *prev;
344 prev = page->matches;
345 while ((prev != NULL) && (prev->next != NULL))
346 prev = prev->next;
348 if (prev == NULL)
349 page->matches = match;
350 else
351 prev->next = match;
352 }
354 return (0);
355 } /* }}} int cc_config_add_match */
357 static int cc_page_init_curl (web_page_t *wp) /* {{{ */
358 {
359 wp->curl = curl_easy_init ();
360 if (wp->curl == NULL)
361 {
362 ERROR ("curl plugin: curl_easy_init failed.");
363 return (-1);
364 }
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,
369 PACKAGE_NAME"/"PACKAGE_VERSION);
370 curl_easy_setopt (wp->curl, CURLOPT_ERRORBUFFER, wp->curl_errbuf);
371 curl_easy_setopt (wp->curl, CURLOPT_URL, wp->url);
372 curl_easy_setopt (wp->curl, CURLOPT_FOLLOWLOCATION, 1);
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, wp->verify_peer);
395 curl_easy_setopt (wp->curl, CURLOPT_SSL_VERIFYHOST,
396 wp->verify_host ? 2 : 0);
397 if (wp->cacert != NULL)
398 curl_easy_setopt (wp->curl, CURLOPT_CAINFO, wp->cacert);
400 return (0);
401 } /* }}} int cc_page_init_curl */
403 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
404 {
405 web_page_t *page;
406 int status;
407 int i;
409 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
410 {
411 WARNING ("curl plugin: `Page' blocks need exactly one string argument.");
412 return (-1);
413 }
415 page = (web_page_t *) malloc (sizeof (*page));
416 if (page == NULL)
417 {
418 ERROR ("curl plugin: malloc failed.");
419 return (-1);
420 }
421 memset (page, 0, sizeof (*page));
422 page->url = NULL;
423 page->user = NULL;
424 page->pass = NULL;
425 page->verify_peer = 1;
426 page->verify_host = 1;
428 page->instance = strdup (ci->values[0].value.string);
429 if (page->instance == NULL)
430 {
431 ERROR ("curl plugin: strdup failed.");
432 sfree (page);
433 return (-1);
434 }
436 /* Process all children */
437 status = 0;
438 for (i = 0; i < ci->children_num; i++)
439 {
440 oconfig_item_t *child = ci->children + i;
442 if (strcasecmp ("URL", child->key) == 0)
443 status = cc_config_add_string ("URL", &page->url, child);
444 else if (strcasecmp ("User", child->key) == 0)
445 status = cc_config_add_string ("User", &page->user, child);
446 else if (strcasecmp ("Password", child->key) == 0)
447 status = cc_config_add_string ("Password", &page->pass, child);
448 else if (strcasecmp ("VerifyPeer", child->key) == 0)
449 status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
450 else if (strcasecmp ("VerifyHost", child->key) == 0)
451 status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
452 else if (strcasecmp ("CACert", child->key) == 0)
453 status = cc_config_add_string ("CACert", &page->cacert, child);
454 else if (strcasecmp ("Match", child->key) == 0)
455 /* Be liberal with failing matches => don't set `status'. */
456 cc_config_add_match (page, child);
457 else
458 {
459 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
460 status = -1;
461 }
463 if (status != 0)
464 break;
465 } /* for (i = 0; i < ci->children_num; i++) */
467 /* Additionial sanity checks and libCURL initialization. */
468 while (status == 0)
469 {
470 if (page->url == NULL)
471 {
472 WARNING ("curl plugin: `URL' missing in `Page' block.");
473 status = -1;
474 }
476 if (page->matches == NULL)
477 {
478 assert (page->instance != NULL);
479 WARNING ("curl plugin: No (valid) `Match' block "
480 "within `Page' block `%s'.", page->instance);
481 status = -1;
482 }
484 if (status == 0)
485 status = cc_page_init_curl (page);
487 break;
488 } /* while (status == 0) */
490 if (status != 0)
491 {
492 cc_web_page_free (page);
493 return (status);
494 }
496 /* Add the new page to the linked list */
497 if (pages_g == NULL)
498 pages_g = page;
499 else
500 {
501 web_page_t *prev;
503 prev = pages_g;
504 while ((prev != NULL) && (prev->next != NULL))
505 prev = prev->next;
506 prev->next = page;
507 }
509 return (0);
510 } /* }}} int cc_config_add_page */
512 static int cc_config (oconfig_item_t *ci) /* {{{ */
513 {
514 int success;
515 int errors;
516 int status;
517 int i;
519 success = 0;
520 errors = 0;
522 for (i = 0; i < ci->children_num; i++)
523 {
524 oconfig_item_t *child = ci->children + i;
526 if (strcasecmp ("Page", child->key) == 0)
527 {
528 status = cc_config_add_page (child);
529 if (status == 0)
530 success++;
531 else
532 errors++;
533 }
534 else
535 {
536 WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
537 errors++;
538 }
539 }
541 if ((success == 0) && (errors > 0))
542 {
543 ERROR ("curl plugin: All statements failed.");
544 return (-1);
545 }
547 return (0);
548 } /* }}} int cc_config */
550 static int cc_init (void) /* {{{ */
551 {
552 if (pages_g == NULL)
553 {
554 INFO ("curl plugin: No pages have been defined.");
555 return (-1);
556 }
557 return (0);
558 } /* }}} int cc_init */
560 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
561 const cu_match_value_t *mv)
562 {
563 value_t values[1];
564 value_list_t vl = VALUE_LIST_INIT;
566 values[0] = mv->value;
568 vl.values = values;
569 vl.values_len = 1;
570 vl.time = time (NULL);
571 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
572 sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
573 sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
574 sstrncpy (vl.type, wm->type, sizeof (vl.type));
575 sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
577 plugin_dispatch_values (&vl);
578 } /* }}} void cc_submit */
580 static int cc_read_page (web_page_t *wp) /* {{{ */
581 {
582 web_match_t *wm;
583 int status;
585 wp->buffer_fill = 0;
586 status = curl_easy_perform (wp->curl);
587 if (status != 0)
588 {
589 ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
590 status, wp->curl_errbuf);
591 return (-1);
592 }
594 for (wm = wp->matches; wm != NULL; wm = wm->next)
595 {
596 cu_match_value_t *mv;
598 status = match_apply (wm->match, wp->buffer);
599 if (status != 0)
600 {
601 WARNING ("curl plugin: match_apply failed.");
602 continue;
603 }
605 mv = match_get_user_data (wm->match);
606 if (mv == NULL)
607 {
608 WARNING ("curl plugin: match_get_user_data returned NULL.");
609 continue;
610 }
612 cc_submit (wp, wm, mv);
613 } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
615 return (0);
616 } /* }}} int cc_read_page */
618 static int cc_read (void) /* {{{ */
619 {
620 web_page_t *wp;
622 for (wp = pages_g; wp != NULL; wp = wp->next)
623 cc_read_page (wp);
625 return (0);
626 } /* }}} int cc_read */
628 static int cc_shutdown (void) /* {{{ */
629 {
630 cc_web_page_free (pages_g);
631 pages_g = NULL;
633 return (0);
634 } /* }}} int cc_shutdown */
636 void module_register (void)
637 {
638 plugin_register_complex_config ("curl", cc_config);
639 plugin_register_init ("curl", cc_init);
640 plugin_register_read ("curl", cc_read);
641 plugin_register_shutdown ("curl", cc_shutdown);
642 } /* void module_register */
644 /* vim: set sw=2 sts=2 et fdm=marker : */