src/target_set.c

   1 /**
   2  * collectd - src/target_set.c
   3  * Copyright (C) 2008       Florian Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "filter_chain.h"
  31
  32 struct ts_data_s
  33 {
  34   char *host;
  35   char *plugin;
  36   char *plugin_instance;
  37   /* char *type; */
  38   char *type_instance;
  39   meta_data_t *meta;
  40 };
  41 typedef struct ts_data_s ts_data_t;
  42
  43 static int ts_util_get_key_and_string_wo_strdup (const oconfig_item_t *ci, char **ret_key, char **ret_string) /* {{{ */
  44 {
  45   if ((ci->values_num != 2)
  46       || (ci->values[0].type != OCONFIG_TYPE_STRING)
  47       || (ci->values[1].type != OCONFIG_TYPE_STRING))
  48   {
  49     ERROR ("ts_util_get_key_and_string_wo_strdup: The %s option requires "
  50         "exactly two string argument.", ci->key);
  51     return (-1);
  52   }
  53
  54   *ret_key = ci->values[0].value.string;
  55   *ret_string = ci->values[1].value.string;
  56
  57   return (0);
  58 } /* }}} int ts_util_get_key_and_string_wo_strdup */
  59
  60 static int ts_config_add_string (char **dest, /* {{{ */
  61     const oconfig_item_t *ci, int may_be_empty)
  62 {
  63   char *tmp = NULL;
  64   int status;
  65
  66   status = cf_util_get_string (ci, &tmp);
  67   if (status != 0)
  68     return (status);
  69
  70   if (!may_be_empty && (strlen (tmp) == 0))
  71   {
  72     ERROR ("Target `set': The `%s' option does not accept empty strings.",
  73         ci->key);
  74     sfree (tmp);
  75     return (-1);
  76   }
  77
  78   *dest = tmp;
  79   return (0);
  80 } /* }}} int ts_config_add_string */
  81
  82 static int ts_config_add_meta (meta_data_t **dest, /* {{{ */
  83     const oconfig_item_t *ci, int may_be_empty)
  84 {
  85   char *key = NULL;
  86   char *string = NULL;
  87   int status;
  88
  89   status = ts_util_get_key_and_string_wo_strdup (ci, &key, &string);
  90   if (status != 0)
  91     return (status);
  92
  93   if (strlen (key) == 0)
  94   {
  95     ERROR ("Target `set': The `%s' option does not accept empty string as first argument.",
  96         ci->key);
  97     return (-1);
  98   }
  99
 100   if (!may_be_empty && (strlen (string) == 0))
 101   {
 102     ERROR ("Target `set': The `%s' option does not accept empty string as second argument.",
 103         ci->key);
 104     return (-1);
 105   }
 106
 107   if ((*dest) == NULL)
 108   {
 109     // Create a new meta_data_t
 110     if ((*dest = meta_data_create()) == NULL)
 111     {
 112       ERROR ("Target `set': failed to create a meta data for `%s'.", ci->key);
 113       return (-1);
 114     }
 115   }
 116
 117   return (meta_data_add_string (*dest, key, string));
 118 } /* }}} int ts_config_add_meta */
 119
 120 static int ts_destroy (void **user_data) /* {{{ */
 121 {
 122   ts_data_t *data;
 123
 124   if (user_data == NULL)
 125     return (-EINVAL);
 126
 127   data = *user_data;
 128   if (data == NULL)
 129     return (0);
 130
 131   free (data->host);
 132   free (data->plugin);
 133   free (data->plugin_instance);
 134   /* free (data->type); */
 135   free (data->type_instance);
 136   meta_data_destroy(data->meta);
 137   free (data);
 138
 139   return (0);
 140 } /* }}} int ts_destroy */
 141
 142 static int ts_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
 143 {
 144   ts_data_t *data;
 145   int status;
 146
 147   data = calloc (1, sizeof (*data));
 148   if (data == NULL)
 149   {
 150     ERROR ("ts_create: calloc failed.");
 151     return (-ENOMEM);
 152   }
 153
 154   data->host = NULL;
 155   data->plugin = NULL;
 156   data->plugin_instance = NULL;
 157   /* data->type = NULL; */
 158   data->type_instance = NULL;
 159   data->meta = NULL;
 160
 161   status = 0;
 162   for (int i = 0; i < ci->children_num; i++)
 163   {
 164     oconfig_item_t *child = ci->children + i;
 165
 166     if ((strcasecmp ("Host", child->key) == 0)
 167         || (strcasecmp ("Hostname", child->key) == 0))
 168       status = ts_config_add_string (&data->host, child,
 169           /* may be empty = */ 0);
 170     else if (strcasecmp ("Plugin", child->key) == 0)
 171       status = ts_config_add_string (&data->plugin, child,
 172           /* may be empty = */ 0);
 173     else if (strcasecmp ("PluginInstance", child->key) == 0)
 174       status = ts_config_add_string (&data->plugin_instance, child,
 175           /* may be empty = */ 1);
 176 #if 0
 177     else if (strcasecmp ("Type", child->key) == 0)
 178       status = ts_config_add_string (&data->type, child,
 179           /* may be empty = */ 0);
 180 #endif
 181     else if (strcasecmp ("TypeInstance", child->key) == 0)
 182       status = ts_config_add_string (&data->type_instance, child,
 183           /* may be empty = */ 1);
 184     else if (strcasecmp ("MetaData", child->key) == 0)
 185       status = ts_config_add_meta (&data->meta, child,
 186           /* may be empty = */ 1);
 187     else
 188     {
 189       ERROR ("Target `set': The `%s' configuration option is not understood "
 190           "and will be ignored.", child->key);
 191       status = 0;
 192     }
 193
 194     if (status != 0)
 195       break;
 196   }
 197
 198   /* Additional sanity-checking */
 199   while (status == 0)
 200   {
 201     if ((data->host == NULL)
 202         && (data->plugin == NULL)
 203         && (data->plugin_instance == NULL)
 204         /* && (data->type == NULL) */
 205         && (data->type_instance == NULL)
 206         && (data->meta == NULL))
 207     {
 208       ERROR ("Target `set': You need to set at least one of `Host', "
 209           "`Plugin', `PluginInstance', `TypeInstance', `MetaData'.");
 210       status = -1;
 211     }
 212
 213     break;
 214   }
 215
 216   if (status != 0)
 217   {
 218     ts_destroy ((void *) &data);
 219     return (status);
 220   }
 221
 222   *user_data = data;
 223   return (0);
 224 } /* }}} int ts_create */
 225
 226 static int ts_invoke (const data_set_t *ds, value_list_t *vl, /* {{{ */
 227     notification_meta_t __attribute__((unused)) **meta, void **user_data)
 228 {
 229   ts_data_t *data;
 230
 231   if ((ds == NULL) || (vl == NULL) || (user_data == NULL))
 232     return (-EINVAL);
 233
 234   data = *user_data;
 235   if (data == NULL)
 236   {
 237     ERROR ("Target `set': Invoke: `data' is NULL.");
 238     return (-EINVAL);
 239   }
 240
 241   if (data->meta != NULL)
 242   {
 243     meta_data_clone_merge(&(vl->meta), data->meta);
 244   }
 245
 246 #define SET_FIELD(f) if (data->f != NULL) { sstrncpy (vl->f, data->f, sizeof (vl->f)); }
 247   SET_FIELD (host);
 248   SET_FIELD (plugin);
 249   SET_FIELD (plugin_instance);
 250   /* SET_FIELD (type); */
 251   SET_FIELD (type_instance);
 252
 253   return (FC_TARGET_CONTINUE);
 254 } /* }}} int ts_invoke */
 255
 256 void module_register (void)
 257 {
 258         target_proc_t tproc = { 0 };
 259
 260         tproc.create  = ts_create;
 261         tproc.destroy = ts_destroy;
 262         tproc.invoke  = ts_invoke;
 263         fc_register_target ("set", tproc);
 264 } /* module_register */
 265
 266 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */
 267