src/target_replace.c

   1 /**
   2  * collectd - src/target_replace.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 #include "common.h"
  29 #include "filter_chain.h"
  30 #include "utils_subst.h"
  31
  32 #include <regex.h>
  33
  34 struct tr_action_s;
  35 typedef struct tr_action_s tr_action_t;
  36 struct tr_action_s
  37 {
  38   regex_t re;
  39   char *replacement;
  40   int may_be_empty;
  41
  42   tr_action_t *next;
  43 };
  44
  45 struct tr_data_s
  46 {
  47   tr_action_t *host;
  48   tr_action_t *plugin;
  49   tr_action_t *plugin_instance;
  50   /* tr_action_t *type; */
  51   tr_action_t *type_instance;
  52 };
  53 typedef struct tr_data_s tr_data_t;
  54
  55 static char *tr_strdup (const char *orig) /* {{{ */
  56 {
  57   size_t sz;
  58   char *dest;
  59
  60   if (orig == NULL)
  61     return (NULL);
  62
  63   sz = strlen (orig) + 1;
  64   dest = malloc (sz);
  65   if (dest == NULL)
  66     return (NULL);
  67
  68   memcpy (dest, orig, sz);
  69
  70   return (dest);
  71 } /* }}} char *tr_strdup */
  72
  73 static void tr_action_destroy (tr_action_t *act) /* {{{ */
  74 {
  75   if (act == NULL)
  76     return;
  77
  78   regfree (&act->re);
  79   sfree (act->replacement);
  80
  81   if (act->next != NULL)
  82     tr_action_destroy (act->next);
  83
  84   sfree (act);
  85 } /* }}} void tr_action_destroy */
  86
  87 static int tr_config_add_action (tr_action_t **dest, /* {{{ */
  88     const oconfig_item_t *ci, int may_be_empty)
  89 {
  90   tr_action_t *act;
  91   int status;
  92
  93   if (dest == NULL)
  94     return (-EINVAL);
  95
  96   if ((ci->values_num != 2)
  97       || (ci->values[0].type != OCONFIG_TYPE_STRING)
  98       || (ci->values[1].type != OCONFIG_TYPE_STRING))
  99   {
 100     ERROR ("Target `replace': The `%s' option requires exactly two string "
 101         "arguments.", ci->key);
 102     return (-1);
 103   }
 104
 105   act = calloc (1, sizeof (*act));
 106   if (act == NULL)
 107   {
 108     ERROR ("tr_config_add_action: calloc failed.");
 109     return (-ENOMEM);
 110   }
 111
 112   act->replacement = NULL;
 113   act->may_be_empty = may_be_empty;
 114
 115   status = regcomp (&act->re, ci->values[0].value.string, REG_EXTENDED);
 116   if (status != 0)
 117   {
 118     char errbuf[1024] = "";
 119
 120     /* regerror assures null termination. */
 121     regerror (status, &act->re, errbuf, sizeof (errbuf));
 122     ERROR ("Target `replace': Compiling the regular expression `%s' "
 123         "failed: %s.",
 124         ci->values[0].value.string, errbuf);
 125     sfree (act);
 126     return (-EINVAL);
 127   }
 128
 129   act->replacement = tr_strdup (ci->values[1].value.string);
 130   if (act->replacement == NULL)
 131   {
 132     ERROR ("tr_config_add_action: tr_strdup failed.");
 133     regfree (&act->re);
 134     sfree (act);
 135     return (-ENOMEM);
 136   }
 137
 138   /* Insert action at end of list. */
 139   if (*dest == NULL)
 140     *dest = act;
 141   else
 142   {
 143     tr_action_t *prev;
 144
 145     prev = *dest;
 146     while (prev->next != NULL)
 147       prev = prev->next;
 148
 149     prev->next = act;
 150   }
 151
 152   return (0);
 153 } /* }}} int tr_config_add_action */
 154
 155 static int tr_action_invoke (tr_action_t *act_head, /* {{{ */
 156     char *buffer_in, size_t buffer_in_size, int may_be_empty)
 157 {
 158   tr_action_t *act;
 159   int status;
 160   char buffer[DATA_MAX_NAME_LEN];
 161   regmatch_t matches[8] = { [0] = { 0 } };
 162
 163   if (act_head == NULL)
 164     return (-EINVAL);
 165
 166   sstrncpy (buffer, buffer_in, sizeof (buffer));
 167
 168   DEBUG ("target_replace plugin: tr_action_invoke: <- buffer = %s;", buffer);
 169
 170   for (act = act_head; act != NULL; act = act->next)
 171   {
 172     char temp[DATA_MAX_NAME_LEN];
 173     char *subst_status;
 174
 175     status = regexec (&act->re, buffer,
 176         STATIC_ARRAY_SIZE (matches), matches,
 177         /* flags = */ 0);
 178     if (status == REG_NOMATCH)
 179       continue;
 180     else if (status != 0)
 181     {
 182       char errbuf[1024] = "";
 183
 184       regerror (status, &act->re, errbuf, sizeof (errbuf));
 185       ERROR ("Target `replace': Executing a regular expression failed: %s.",
 186           errbuf);
 187       continue;
 188     }
 189
 190     subst_status = subst (temp, sizeof (temp), buffer,
 191         (size_t) matches[0].rm_so, (size_t) matches[0].rm_eo, act->replacement);
 192     if (subst_status == NULL)
 193     {
 194       ERROR ("Target `replace': subst (buffer = %s, start = %zu, end = %zu, "
 195           "replacement = %s) failed.",
 196           buffer, (size_t) matches[0].rm_so, (size_t) matches[0].rm_eo,
 197           act->replacement);
 198       continue;
 199     }
 200     sstrncpy (buffer, temp, sizeof (buffer));
 201
 202     DEBUG ("target_replace plugin: tr_action_invoke: -- buffer = %s;", buffer);
 203   } /* for (act = act_head; act != NULL; act = act->next) */
 204
 205   if ((may_be_empty == 0) && (buffer[0] == 0))
 206   {
 207     WARNING ("Target `replace': Replacement resulted in an empty string, "
 208         "which is not allowed for this buffer (`host' or `plugin').");
 209     return (0);
 210   }
 211
 212   DEBUG ("target_replace plugin: tr_action_invoke: -> buffer = %s;", buffer);
 213   sstrncpy (buffer_in, buffer, buffer_in_size);
 214
 215   return (0);
 216 } /* }}} int tr_action_invoke */
 217
 218 static int tr_destroy (void **user_data) /* {{{ */
 219 {
 220   tr_data_t *data;
 221
 222   if (user_data == NULL)
 223     return (-EINVAL);
 224
 225   data = *user_data;
 226   if (data == NULL)
 227     return (0);
 228
 229   tr_action_destroy (data->host);
 230   tr_action_destroy (data->plugin);
 231   tr_action_destroy (data->plugin_instance);
 232   /* tr_action_destroy (data->type); */
 233   tr_action_destroy (data->type_instance);
 234   sfree (data);
 235
 236   return (0);
 237 } /* }}} int tr_destroy */
 238
 239 static int tr_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
 240 {
 241   tr_data_t *data;
 242   int status;
 243   int i;
 244
 245   data = calloc (1, sizeof (*data));
 246   if (data == NULL)
 247   {
 248     ERROR ("tr_create: calloc failed.");
 249     return (-ENOMEM);
 250   }
 251
 252   data->host = NULL;
 253   data->plugin = NULL;
 254   data->plugin_instance = NULL;
 255   /* data->type = NULL; */
 256   data->type_instance = NULL;
 257
 258   status = 0;
 259   for (i = 0; i < ci->children_num; i++)
 260   {
 261     oconfig_item_t *child = ci->children + i;
 262
 263     if ((strcasecmp ("Host", child->key) == 0)
 264         || (strcasecmp ("Hostname", child->key) == 0))
 265       status = tr_config_add_action (&data->host, child,
 266           /* may be empty = */ 0);
 267     else if (strcasecmp ("Plugin", child->key) == 0)
 268       status = tr_config_add_action (&data->plugin, child,
 269           /* may be empty = */ 0);
 270     else if (strcasecmp ("PluginInstance", child->key) == 0)
 271       status = tr_config_add_action (&data->plugin_instance, child,
 272           /* may be empty = */ 1);
 273 #if 0
 274     else if (strcasecmp ("Type", child->key) == 0)
 275       status = tr_config_add_action (&data->type, child,
 276           /* may be empty = */ 0);
 277 #endif
 278     else if (strcasecmp ("TypeInstance", child->key) == 0)
 279       status = tr_config_add_action (&data->type_instance, child,
 280           /* may be empty = */ 1);
 281     else
 282     {
 283       ERROR ("Target `replace': The `%s' configuration option is not understood "
 284           "and will be ignored.", child->key);
 285       status = 0;
 286     }
 287
 288     if (status != 0)
 289       break;
 290   }
 291
 292   /* Additional sanity-checking */
 293   while (status == 0)
 294   {
 295     if ((data->host == NULL)
 296         && (data->plugin == NULL)
 297         && (data->plugin_instance == NULL)
 298         /* && (data->type == NULL) */
 299         && (data->type_instance == NULL))
 300     {
 301       ERROR ("Target `replace': You need to set at least one of `Host', "
 302           "`Plugin', `PluginInstance' or `TypeInstance'.");
 303       status = -1;
 304     }
 305
 306     break;
 307   }
 308
 309   if (status != 0)
 310   {
 311     tr_destroy ((void *) &data);
 312     return (status);
 313   }
 314
 315   *user_data = data;
 316   return (0);
 317 } /* }}} int tr_create */
 318
 319 static int tr_invoke (const data_set_t *ds, value_list_t *vl, /* {{{ */
 320     notification_meta_t __attribute__((unused)) **meta, void **user_data)
 321 {
 322   tr_data_t *data;
 323
 324   if ((ds == NULL) || (vl == NULL) || (user_data == NULL))
 325     return (-EINVAL);
 326
 327   data = *user_data;
 328   if (data == NULL)
 329   {
 330     ERROR ("Target `replace': Invoke: `data' is NULL.");
 331     return (-EINVAL);
 332   }
 333
 334 #define HANDLE_FIELD(f,e) \
 335   if (data->f != NULL) \
 336     tr_action_invoke (data->f, vl->f, sizeof (vl->f), e)
 337   HANDLE_FIELD (host, 0);
 338   HANDLE_FIELD (plugin, 0);
 339   HANDLE_FIELD (plugin_instance, 1);
 340   /* HANDLE_FIELD (type); */
 341   HANDLE_FIELD (type_instance, 1);
 342
 343   return (FC_TARGET_CONTINUE);
 344 } /* }}} int tr_invoke */
 345
 346 void module_register (void)
 347 {
 348         target_proc_t tproc = { 0 };
 349
 350         tproc.create  = tr_create;
 351         tproc.destroy = tr_destroy;
 352         tproc.invoke  = tr_invoke;
 353         fc_register_target ("replace", tproc);
 354 } /* module_register */
 355
 356 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */
 357