src/http.c

   1 /**
   2  * collectd - src/http.c
   3  * Copyright (C) 2007-2009  Florian octo Forster
   4  * Copyright (C) 2009       Doug MacEachern
   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  *   Doug MacEachern <dougm@hyperic.com>
  22  **/
  23
  24 #include "collectd.h"
  25 #include "plugin.h"
  26 #include "common.h"
  27 #include "utils_cache.h"
  28 #include "utils_parse_option.h"
  29
  30 #if HAVE_PTHREAD_H
  31 # include <pthread.h>
  32 #endif
  33
  34 #include <curl/curl.h>
  35
  36 /*
  37  * Private variables
  38  */
  39 static const char *config_keys[] =
  40 {
  41         "URL", "User", "Password"
  42 };
  43 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  44
  45 static char *location   = NULL;
  46
  47 char *user;
  48 char *pass;
  49 char *credentials;
  50
  51 CURL *curl;
  52 char curl_errbuf[CURL_ERROR_SIZE];
  53
  54 #define SEND_BUFFER_SIZE 4096
  55 static char   send_buffer[SEND_BUFFER_SIZE];
  56 static size_t send_buffer_free;
  57 static size_t send_buffer_fill;
  58 static time_t send_buffer_init_time;
  59
  60 static pthread_mutex_t  send_lock = PTHREAD_MUTEX_INITIALIZER;
  61
  62 static int http_init(void) /* {{{ */
  63 {
  64
  65         curl = curl_easy_init ();
  66
  67         if (curl == NULL)
  68         {
  69                 ERROR ("curl plugin: curl_easy_init failed.");
  70                 return (-1);
  71         }
  72
  73         struct curl_slist *headers=NULL;
  74
  75         curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
  76
  77         headers = curl_slist_append(headers, "Accept:  */*");
  78         headers = curl_slist_append(headers, "Content-Type: text/plain");
  79         curl_easy_setopt (curl, CURLOPT_HTTPHEADER, headers);
  80
  81         curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, curl_errbuf);
  82         curl_easy_setopt (curl, CURLOPT_URL, location);
  83
  84         if (user != NULL)
  85         {
  86                 size_t credentials_size;
  87
  88                 credentials_size = strlen (user) + 2;
  89                 if (pass != NULL)
  90                         credentials_size += strlen (pass);
  91
  92                 credentials = (char *) malloc (credentials_size);
  93                 if (credentials == NULL)
  94                 {
  95                         ERROR ("curl plugin: malloc failed.");
  96                         return (-1);
  97                 }
  98
  99                 ssnprintf (credentials, credentials_size, "%s:%s",
 100                                 user, (pass == NULL) ? "" : pass);
 101                 curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
 102                 curl_easy_setopt (curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
 103         }
 104
 105         return (0);
 106 } /* }}} */
 107
 108 static int http_value_list_to_string (char *buffer, /* {{{ */
 109                 size_t buffer_size,
 110                 const data_set_t *ds, const value_list_t *vl)
 111 {
 112         size_t offset = 0;
 113         int status;
 114         int i;
 115
 116         assert (0 == strcmp (ds->type, vl->type));
 117
 118         memset (buffer, 0, buffer_size);
 119
 120 #define BUFFER_ADD(...) do { \
 121         status = ssnprintf (buffer + offset, buffer_size - offset, \
 122                         __VA_ARGS__); \
 123         if (status < 1) \
 124                 return (-1); \
 125         else if (((size_t) status) >= (buffer_size - offset)) \
 126                 return (-1); \
 127         else \
 128                 offset += ((size_t) status); \
 129 } while (0)
 130
 131         BUFFER_ADD ("%lu", (unsigned long) vl->time);
 132
 133         for (i = 0; i < ds->ds_num; i++)
 134 {
 135         if (ds->ds[i].type == DS_TYPE_GAUGE)
 136                 BUFFER_ADD (":%f", vl->values[i].gauge);
 137         else if (ds->ds[i].type == DS_TYPE_COUNTER)
 138                 BUFFER_ADD (":%llu", vl->values[i].counter);
 139         else if (ds->ds[i].type == DS_TYPE_DERIVE)
 140                 BUFFER_ADD (":%"PRIi64, vl->values[i].derive);
 141         else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
 142                 BUFFER_ADD (":%"PRIu64, vl->values[i].absolute);
 143         else
 144         {
 145                 ERROR ("http plugin: Unknown data source type: %i",
 146                                 ds->ds[i].type);
 147                 return (-1);
 148         }
 149 } /* for ds->ds_num */
 150
 151 #undef BUFFER_ADD
 152
 153 return (0);
 154 } /* }}} int http_value_list_to_string */
 155
 156 static int http_config (const char *key, const char *value) /* {{{ */
 157 {
 158         if (strcasecmp ("URL", key) == 0)
 159         {
 160                 if (location != NULL)
 161                         free (location);
 162                 location = strdup (value);
 163                 if (location != NULL)
 164                 {
 165                         int len = strlen (location);
 166                         while ((len > 0) && (location[len - 1] == '/'))
 167                         {
 168                                 len--;
 169                                 location[len] = '\0';
 170                         }
 171                         if (len <= 0)
 172                         {
 173                                 free (location);
 174                                 location = NULL;
 175                         }
 176                 }
 177         }
 178         else if (strcasecmp ("User", key) == 0)
 179         {
 180                 if (user != NULL)
 181                         free (user);
 182                 user = strdup (value);
 183                 if (user != NULL)
 184                 {
 185                         int len = strlen (user);
 186                         while ((len > 0) && (user[len - 1] == '/'))
 187                         {
 188                                 len--;
 189                                 user[len] = '\0';
 190                         }
 191                         if (len <= 0)
 192                         {
 193                                 free (user);
 194                                 user = NULL;
 195                         }
 196                 }
 197         }
 198         else if (strcasecmp ("Password", key) == 0)
 199         {
 200                 if (pass != NULL)
 201                         free (pass);
 202                 pass = strdup (value);
 203                 if (pass != NULL)
 204                 {
 205                         int len = strlen (pass);
 206                         while ((len > 0) && (pass[len - 1] == '/'))
 207                         {
 208                                 len--;
 209                                 pass[len] = '\0';
 210                         }
 211                         if (len <= 0)
 212                         {
 213                                 free (pass);
 214                                 pass = NULL;
 215                         }
 216                 }
 217         }
 218         else
 219         {
 220                 return (-1);
 221         }
 222         return (0);
 223 } /* }}} int http_config */
 224
 225 static void http_init_buffer (void)  /* {{{ */
 226 {
 227         memset (send_buffer, 0, sizeof (send_buffer));
 228         send_buffer_free = sizeof (send_buffer);
 229         send_buffer_fill = 0;
 230         send_buffer_init_time = time (NULL);
 231 } /* }}} http_init_buffer */
 232
 233 static int http_send_buffer (char *buffer) /* {{{ */
 234 {
 235         int status = 0;
 236
 237         curl_easy_setopt (curl, CURLOPT_POSTFIELDS, buffer);
 238         status = curl_easy_perform (curl);
 239         if (status != 0)
 240         {
 241                 ERROR ("http plugin: curl_easy_perform failed with staus %i: %s",
 242                                 status, curl_errbuf);
 243         }
 244         return (status);
 245 } /* }}} http_send_buffer */
 246
 247 static int http_flush_nolock (int timeout) /* {{{ */
 248 {
 249         int status;
 250
 251         DEBUG ("http plugin: http_flush_nolock: timeout = %i; "
 252                         "send_buffer =\n  %s", timeout, send_buffer);
 253
 254         if (timeout > 0)
 255         {
 256                 time_t now;
 257
 258                 now = time (NULL);
 259                 if ((send_buffer_init_time + timeout) > now)
 260                         return (0);
 261         }
 262
 263         status = http_send_buffer (send_buffer);
 264         http_init_buffer ();
 265
 266         return (status);
 267 } /* }}} http_flush_nolock */
 268
 269 static int http_flush (int timeout, /* {{{ */
 270                 const char *identifier __attribute__((unused)),
 271                 user_data_t *user_data __attribute__((unused)))
 272 {
 273         int status;
 274
 275         pthread_mutex_lock (&send_lock);
 276         status = http_flush_nolock (timeout);
 277         pthread_mutex_unlock (&send_lock);
 278
 279         return (status);
 280 } /* }}} int http_flush */
 281
 282 static int http_write_command (const data_set_t *ds, const value_list_t *vl) /* {{{ */
 283 {
 284         char key[10*DATA_MAX_NAME_LEN];
 285         char values[512];
 286         char command[1024];
 287         size_t command_len;
 288
 289         int status;
 290
 291         if (0 != strcmp (ds->type, vl->type)) {
 292                 ERROR ("http plugin: DS type does not match value list type");
 293                 return -1;
 294         }
 295
 296         /* Copy the identifier to `key' and escape it. */
 297         status = FORMAT_VL (key, sizeof (key), vl);
 298         if (status != 0) {
 299                 ERROR ("http plugin: error with format_name");
 300                 return (status);
 301         }
 302         escape_string (key, sizeof (key));
 303
 304         /* Convert the values to an ASCII representation and put that into
 305          * `values'. */
 306         status = http_value_list_to_string (values, sizeof (values), ds, vl);
 307         if (status != 0) {
 308                 ERROR ("http plugin: error with http_value_list_to_string");
 309                 return (status);
 310         }
 311
 312         command_len = (size_t) ssnprintf (command, sizeof (command),
 313                         "PUTVAL %s interval=%i %s\n",
 314                         key, vl->interval, values);
 315         if (command_len >= sizeof (command)) {
 316                 ERROR ("http plugin: Command buffer too small: "
 317                                 "Need %zu bytes.", command_len + 1);
 318                 return (-1);
 319         }
 320
 321         pthread_mutex_lock (&send_lock);
 322
 323         /* Check if we have enough space for this command. */
 324         if (command_len >= send_buffer_free)
 325         {
 326                 status = http_flush_nolock (/* timeout = */ -1);
 327                 if (status != 0)
 328                 {
 329                         pthread_mutex_unlock (&send_lock);
 330                         return status;
 331                 }
 332         }
 333         assert (command_len < send_buffer_free);
 334
 335         /* `command_len + 1' because `command_len' does not include the
 336          * trailing null byte. Neither does `send_buffer_fill'. */
 337         memcpy (send_buffer + send_buffer_fill, command, command_len + 1);
 338         send_buffer_fill += command_len;
 339         send_buffer_free -= command_len;
 340
 341         pthread_mutex_unlock (&send_lock);
 342
 343         return (0);
 344 } /* }}} int http_write_command */
 345
 346 static int http_write (const data_set_t *ds, const value_list_t *vl, /* {{{ */
 347                 user_data_t __attribute__((unused)) *user_data)
 348 {
 349         int status;
 350
 351         status = http_write_command (ds, vl);
 352
 353         return (status);
 354 } /* }}} int http_write */
 355
 356 static int http_shutdown (void) /* {{{ */
 357 {
 358         http_flush_nolock (/* timeout = */ -1);
 359         curl_easy_cleanup(curl);
 360         return (0);
 361 }
 362
 363 void module_register (void) /* {{{ */
 364 {
 365         plugin_register_init("http", http_init);
 366         plugin_register_config ("http", http_config,
 367                         config_keys, config_keys_num);
 368         plugin_register_write ("http", http_write, /* user_data = */ NULL);
 369         plugin_register_flush ("http", http_flush, /* user_data = */ NULL);
 370         plugin_register_shutdown("http", http_shutdown);
 371 } /* }}} void module_register */
 372
 373 /* vim: set fdm=marker sw=8 ts=8 tw=78 et : */