src/utils_format_json.c

   1 /**
   2  * collectd - src/utils_format_json.c
   3  * Copyright (C) 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 "plugin.h"
  24 #include "common.h"
  25
  26 #include "utils_format_json.h"
  27
  28 static int escape_string (char *buffer, size_t buffer_size, /* {{{ */
  29     const char *string)
  30 {
  31   size_t src_pos;
  32   size_t dst_pos;
  33
  34   if ((buffer == NULL) || (string == NULL))
  35     return (-EINVAL);
  36
  37   if (buffer_size < 3)
  38     return (-ENOMEM);
  39
  40   dst_pos = 0;
  41
  42 #define BUFFER_ADD(c) do { \
  43   if (dst_pos >= (buffer_size - 1)) { \
  44     buffer[buffer_size - 1] = 0; \
  45     return (-ENOMEM); \
  46   } \
  47   buffer[dst_pos] = (c); \
  48   dst_pos++; \
  49 } while (0)
  50
  51   /* Escape special characters */
  52   BUFFER_ADD ('"');
  53   for (src_pos = 0; string[src_pos] != 0; src_pos++)
  54   {
  55     if ((string[src_pos] == '"')
  56         || (string[src_pos] == '\\'))
  57     {
  58       BUFFER_ADD ('\\');
  59       BUFFER_ADD (string[src_pos]);
  60     }
  61     else if (string[src_pos] <= 0x001F)
  62       BUFFER_ADD ('?');
  63     else
  64       BUFFER_ADD (string[src_pos]);
  65   } /* for */
  66   BUFFER_ADD ('"');
  67   buffer[dst_pos] = 0;
  68
  69 #undef BUFFER_ADD
  70
  71   return (0);
  72 } /* }}} int buffer_add_string */
  73
  74 static int values_to_json (char *buffer, size_t buffer_size, /* {{{ */
  75                 const data_set_t *ds, const value_list_t *vl)
  76 {
  77   size_t offset = 0;
  78   int i;
  79
  80   memset (buffer, 0, buffer_size);
  81
  82 #define BUFFER_ADD(...) do { \
  83   int status; \
  84   status = ssnprintf (buffer + offset, buffer_size - offset, \
  85       __VA_ARGS__); \
  86   if (status < 1) \
  87     return (-1); \
  88   else if (((size_t) status) >= (buffer_size - offset)) \
  89     return (-ENOMEM); \
  90   else \
  91   offset += ((size_t) status); \
  92 } while (0)
  93
  94   BUFFER_ADD ("[");
  95   for (i = 0; i < ds->ds_num; i++)
  96   {
  97     if (i > 0)
  98       BUFFER_ADD (",");
  99
 100     if (ds->ds[i].type == DS_TYPE_GAUGE)
 101       BUFFER_ADD ("%g", vl->values[i].gauge);
 102     else if (ds->ds[i].type == DS_TYPE_COUNTER)
 103       BUFFER_ADD ("%llu", vl->values[i].counter);
 104     else if (ds->ds[i].type == DS_TYPE_DERIVE)
 105       BUFFER_ADD ("%"PRIi64, vl->values[i].derive);
 106     else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
 107       BUFFER_ADD ("%"PRIu64, vl->values[i].absolute);
 108     else
 109     {
 110       ERROR ("format_json: Unknown data source type: %i",
 111           ds->ds[i].type);
 112       return (-1);
 113     }
 114   } /* for ds->ds_num */
 115   BUFFER_ADD ("]");
 116
 117 #undef BUFFER_ADD
 118
 119   return (0);
 120 } /* }}} int values_to_json */
 121
 122 static int value_list_to_json (char *buffer, size_t buffer_size, /* {{{ */
 123                 const data_set_t *ds, const value_list_t *vl)
 124 {
 125   char temp[512];
 126   size_t offset = 0;
 127   int status;
 128
 129   memset (buffer, 0, buffer_size);
 130
 131 #define BUFFER_ADD(...) do { \
 132   status = ssnprintf (buffer + offset, buffer_size - offset, \
 133       __VA_ARGS__); \
 134   if (status < 1) \
 135     return (-1); \
 136   else if (((size_t) status) >= (buffer_size - offset)) \
 137     return (-ENOMEM); \
 138   else \
 139     offset += ((size_t) status); \
 140 } while (0)
 141
 142   /* All value lists have a leading comma. The first one will be replaced with
 143    * a square bracket in `format_json_finalize'. */
 144   BUFFER_ADD (",{");
 145
 146   status = values_to_json (temp, sizeof (temp), ds, vl);
 147   if (status != 0)
 148     return (status);
 149   BUFFER_ADD ("\"values\":%s", temp);
 150
 151   BUFFER_ADD (",\"time\":%lu", (unsigned long) vl->time);
 152   BUFFER_ADD (",\"interval\":%i", vl->interval);
 153
 154 #define BUFFER_ADD_KEYVAL(key, value) do { \
 155   status = escape_string (temp, sizeof (temp), (value)); \
 156   if (status != 0) \
 157     return (status); \
 158   BUFFER_ADD (",\"%s\":%s", (key), temp); \
 159 } while (0)
 160
 161   BUFFER_ADD_KEYVAL ("host", vl->host);
 162   BUFFER_ADD_KEYVAL ("plugin", vl->plugin);
 163   BUFFER_ADD_KEYVAL ("plugin_instance", vl->plugin_instance);
 164   BUFFER_ADD_KEYVAL ("type", vl->type);
 165   BUFFER_ADD_KEYVAL ("type_instance", vl->type_instance);
 166
 167   BUFFER_ADD ("}");
 168
 169 #undef BUFFER_ADD_KEYVAL
 170 #undef BUFFER_ADD
 171
 172   return (0);
 173 } /* }}} int value_list_to_json */
 174
 175 static int format_json_value_list_nocheck (char *buffer, /* {{{ */
 176     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 177     const data_set_t *ds, const value_list_t *vl,
 178     size_t temp_size)
 179 {
 180   char temp[temp_size];
 181   int status;
 182
 183   status = value_list_to_json (temp, sizeof (temp), ds, vl);
 184   if (status != 0)
 185     return (status);
 186   temp_size = strlen (temp);
 187
 188   memcpy (buffer + (*ret_buffer_fill), temp, temp_size + 1);
 189   (*ret_buffer_fill) += temp_size;
 190   (*ret_buffer_free) -= temp_size;
 191
 192   return (0);
 193 } /* }}} int format_json_value_list_nocheck */
 194
 195 int format_json_initialize (char *buffer, /* {{{ */
 196     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 197 {
 198   size_t buffer_fill;
 199   size_t buffer_free;
 200
 201   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 202     return (-EINVAL);
 203
 204   buffer_fill = *ret_buffer_fill;
 205   buffer_free = *ret_buffer_free;
 206
 207   buffer_free = buffer_fill + buffer_free;
 208   buffer_fill = 0;
 209
 210   if (buffer_free < 3)
 211     return (-ENOMEM);
 212
 213   memset (buffer, 0, buffer_free);
 214   *ret_buffer_fill = buffer_fill;
 215   *ret_buffer_free = buffer_free;
 216
 217   return (0);
 218 } /* }}} int format_json_initialize */
 219
 220 int format_json_finalize (char *buffer, /* {{{ */
 221     size_t *ret_buffer_fill, size_t *ret_buffer_free)
 222 {
 223   size_t pos;
 224
 225   if ((buffer == NULL) || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL))
 226     return (-EINVAL);
 227
 228   if (*ret_buffer_free < 2)
 229     return (-ENOMEM);
 230
 231   /* Replace the leading comma added in `value_list_to_json' with a square
 232    * bracket. */
 233   if (buffer[0] != ',')
 234     return (-EINVAL);
 235   buffer[0] = '[';
 236
 237   pos = *ret_buffer_fill;
 238   buffer[pos] = ']';
 239   buffer[pos+1] = 0;
 240
 241   (*ret_buffer_fill)++;
 242   (*ret_buffer_free)--;
 243
 244   return (0);
 245 } /* }}} int format_json_finalize */
 246
 247 int format_json_value_list (char *buffer, /* {{{ */
 248     size_t *ret_buffer_fill, size_t *ret_buffer_free,
 249     const data_set_t *ds, const value_list_t *vl)
 250 {
 251   if ((buffer == NULL)
 252       || (ret_buffer_fill == NULL) || (ret_buffer_free == NULL)
 253       || (ds == NULL) || (vl == NULL))
 254     return (-EINVAL);
 255
 256   if (*ret_buffer_free < 3)
 257     return (-ENOMEM);
 258
 259   return (format_json_value_list_nocheck (buffer,
 260         ret_buffer_fill, ret_buffer_free, ds, vl,
 261         (*ret_buffer_free) - 2));
 262 } /* }}} int format_json_value_list */
 263
 264 /* vim: set sw=2 sts=2 et fdm=marker : */