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
 374   if (wp->user != NULL)
 375   {
 376     size_t credentials_size;
 377
 378     credentials_size = strlen (wp->user) + 2;
 379     if (wp->pass != NULL)
 380       credentials_size += strlen (wp->pass);
 381
 382     wp->credentials = (char *) malloc (credentials_size);
 383     if (wp->credentials == NULL)
 384     {
 385       ERROR ("curl plugin: malloc failed.");
 386       return (-1);
 387     }
 388
 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
 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);
 399
 400   return (0);
 401 } /* }}} int cc_page_init_curl */
 402
 403 static int cc_config_add_page (oconfig_item_t *ci) /* {{{ */
 404 {
 405   web_page_t *page;
 406   int status;
 407   int i;
 408
 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   }
 414
 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;
 427   page->response_time = 0;
 428
 429   page->instance = strdup (ci->values[0].value.string);
 430   if (page->instance == NULL)
 431   {
 432     ERROR ("curl plugin: strdup failed.");
 433     sfree (page);
 434     return (-1);
 435   }
 436
 437   /* Process all children */
 438   status = 0;
 439   for (i = 0; i < ci->children_num; i++)
 440   {
 441     oconfig_item_t *child = ci->children + i;
 442
 443     if (strcasecmp ("URL", child->key) == 0)
 444       status = cc_config_add_string ("URL", &page->url, child);
 445     else if (strcasecmp ("User", child->key) == 0)
 446       status = cc_config_add_string ("User", &page->user, child);
 447     else if (strcasecmp ("Password", child->key) == 0)
 448       status = cc_config_add_string ("Password", &page->pass, child);
 449     else if (strcasecmp ("VerifyPeer", child->key) == 0)
 450       status = cc_config_set_boolean ("VerifyPeer", &page->verify_peer, child);
 451     else if (strcasecmp ("VerifyHost", child->key) == 0)
 452       status = cc_config_set_boolean ("VerifyHost", &page->verify_host, child);
 453     else if (strcasecmp ("MeasureResponseTime", child->key) == 0)
 454       status = cc_config_set_boolean (child->key, &page->response_time, child);
 455     else if (strcasecmp ("CACert", child->key) == 0)
 456       status = cc_config_add_string ("CACert", &page->cacert, child);
 457     else if (strcasecmp ("Match", child->key) == 0)
 458       /* Be liberal with failing matches => don't set `status'. */
 459       cc_config_add_match (page, child);
 460     else
 461     {
 462       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
 463       status = -1;
 464     }
 465
 466     if (status != 0)
 467       break;
 468   } /* for (i = 0; i < ci->children_num; i++) */
 469
 470   /* Additionial sanity checks and libCURL initialization. */
 471   while (status == 0)
 472   {
 473     if (page->url == NULL)
 474     {
 475       WARNING ("curl plugin: `URL' missing in `Page' block.");
 476       status = -1;
 477     }
 478
 479     if (page->matches == NULL && !page->response_time)
 480     {
 481       assert (page->instance != NULL);
 482       WARNING ("curl plugin: No (valid) `Match' block "
 483           "or MeasureResponseTime within `Page' block `%s'.", page->instance);
 484       status = -1;
 485     }
 486
 487     if (status == 0)
 488       status = cc_page_init_curl (page);
 489
 490     break;
 491   } /* while (status == 0) */
 492
 493   if (status != 0)
 494   {
 495     cc_web_page_free (page);
 496     return (status);
 497   }
 498
 499   /* Add the new page to the linked list */
 500   if (pages_g == NULL)
 501     pages_g = page;
 502   else
 503   {
 504     web_page_t *prev;
 505
 506     prev = pages_g;
 507     while ((prev != NULL) && (prev->next != NULL))
 508       prev = prev->next;
 509     prev->next = page;
 510   }
 511
 512   return (0);
 513 } /* }}} int cc_config_add_page */
 514
 515 static int cc_config (oconfig_item_t *ci) /* {{{ */
 516 {
 517   int success;
 518   int errors;
 519   int status;
 520   int i;
 521
 522   success = 0;
 523   errors = 0;
 524
 525   for (i = 0; i < ci->children_num; i++)
 526   {
 527     oconfig_item_t *child = ci->children + i;
 528
 529     if (strcasecmp ("Page", child->key) == 0)
 530     {
 531       status = cc_config_add_page (child);
 532       if (status == 0)
 533         success++;
 534       else
 535         errors++;
 536     }
 537     else
 538     {
 539       WARNING ("curl plugin: Option `%s' not allowed here.", child->key);
 540       errors++;
 541     }
 542   }
 543
 544   if ((success == 0) && (errors > 0))
 545   {
 546     ERROR ("curl plugin: All statements failed.");
 547     return (-1);
 548   }
 549
 550   return (0);
 551 } /* }}} int cc_config */
 552
 553 static int cc_init (void) /* {{{ */
 554 {
 555   if (pages_g == NULL)
 556   {
 557     INFO ("curl plugin: No pages have been defined.");
 558     return (-1);
 559   }
 560   return (0);
 561 } /* }}} int cc_init */
 562
 563 static void cc_submit (const web_page_t *wp, const web_match_t *wm, /* {{{ */
 564     const cu_match_value_t *mv)
 565 {
 566   value_t values[1];
 567   value_list_t vl = VALUE_LIST_INIT;
 568
 569   values[0] = mv->value;
 570
 571   vl.values = values;
 572   vl.values_len = 1;
 573   vl.time = time (NULL);
 574   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 575   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
 576   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
 577   sstrncpy (vl.type, wm->type, sizeof (vl.type));
 578   sstrncpy (vl.type_instance, wm->instance, sizeof (vl.type_instance));
 579
 580   plugin_dispatch_values (&vl);
 581 } /* }}} void cc_submit */
 582
 583 static void cc_submit_response_time (const web_page_t *wp, double seconds) /* {{{ */
 584 {
 585   value_t values[1];
 586   value_list_t vl = VALUE_LIST_INIT;
 587
 588   values[0].gauge = seconds;
 589
 590   vl.values = values;
 591   vl.values_len = 1;
 592   vl.time = time (NULL);
 593   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 594   sstrncpy (vl.plugin, "curl", sizeof (vl.plugin));
 595   sstrncpy (vl.plugin_instance, wp->instance, sizeof (vl.plugin_instance));
 596   sstrncpy (vl.type, "response_time", sizeof (vl.type));
 597
 598   plugin_dispatch_values (&vl);
 599 } /* }}} void cc_submit_response_time */
 600
 601 static int cc_read_page (web_page_t *wp) /* {{{ */
 602 {
 603   web_match_t *wm;
 604   int status;
 605   struct timeval start, end;
 606
 607   if (wp->response_time)
 608     gettimeofday (&start, NULL);
 609
 610   wp->buffer_fill = 0;
 611   status = curl_easy_perform (wp->curl);
 612   if (status != 0)
 613   {
 614     ERROR ("curl plugin: curl_easy_perform failed with staus %i: %s",
 615         status, wp->curl_errbuf);
 616     return (-1);
 617   }
 618
 619   if (wp->response_time)
 620   {
 621     double secs = 0;
 622     gettimeofday (&end, NULL);
 623     secs += end.tv_sec - start.tv_sec;
 624     secs += (end.tv_usec - start.tv_usec) / 1000000.0;
 625     cc_submit_response_time (wp, secs);
 626   }
 627
 628   for (wm = wp->matches; wm != NULL; wm = wm->next)
 629   {
 630     cu_match_value_t *mv;
 631
 632     status = match_apply (wm->match, wp->buffer);
 633     if (status != 0)
 634     {
 635       WARNING ("curl plugin: match_apply failed.");
 636       continue;
 637     }
 638
 639     mv = match_get_user_data (wm->match);
 640     if (mv == NULL)
 641     {
 642       WARNING ("curl plugin: match_get_user_data returned NULL.");
 643       continue;
 644     }
 645
 646     cc_submit (wp, wm, mv);
 647   } /* for (wm = wp->matches; wm != NULL; wm = wm->next) */
 648
 649   return (0);
 650 } /* }}} int cc_read_page */
 651
 652 static int cc_read (void) /* {{{ */
 653 {
 654   web_page_t *wp;
 655
 656   for (wp = pages_g; wp != NULL; wp = wp->next)
 657     cc_read_page (wp);
 658
 659   return (0);
 660 } /* }}} int cc_read */
 661
 662 static int cc_shutdown (void) /* {{{ */
 663 {
 664   cc_web_page_free (pages_g);
 665   pages_g = NULL;
 666
 667   return (0);
 668 } /* }}} int cc_shutdown */
 669
 670 void module_register (void)
 671 {
 672   plugin_register_complex_config ("curl", cc_config);
 673   plugin_register_init ("curl", cc_init);
 674   plugin_register_read ("curl", cc_read);
 675   plugin_register_shutdown ("curl", cc_shutdown);
 676 } /* void module_register */
 677
 678 /* vim: set sw=2 sts=2 et fdm=marker : */