src/utils_cmd_putnotif.c

   1 /**
   2  * collectd - src/utils_cmd_putnotif.c
   3  * Copyright (C) 2008       Florian octo 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 octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31
  32 #include "utils_cmd_putnotif.h"
  33 #include "utils_parse_option.h"
  34
  35 #define print_to_socket(fh, ...)                                               \
  36   do {                                                                         \
  37     if (fprintf(fh, __VA_ARGS__) < 0) {                                        \
  38       char errbuf[1024];                                                       \
  39       WARNING("handle_putnotif: failed to write to socket #%i: %s",            \
  40               fileno(fh), sstrerror(errno, errbuf, sizeof(errbuf)));           \
  41       return -1;                                                               \
  42     }                                                                          \
  43     fflush(fh);                                                                \
  44   } while (0)
  45
  46 static int set_option_severity(notification_t *n, const char *value) {
  47   if (strcasecmp(value, "Failure") == 0)
  48     n->severity = NOTIF_FAILURE;
  49   else if (strcasecmp(value, "Warning") == 0)
  50     n->severity = NOTIF_WARNING;
  51   else if (strcasecmp(value, "Okay") == 0)
  52     n->severity = NOTIF_OKAY;
  53   else
  54     return (-1);
  55
  56   return (0);
  57 } /* int set_option_severity */
  58
  59 static int set_option_time(notification_t *n, const char *value) {
  60   char *endptr = NULL;
  61   double tmp;
  62
  63   errno = 0;
  64   tmp = strtod(value, &endptr);
  65   if ((errno != 0)         /* Overflow */
  66       || (endptr == value) /* Invalid string */
  67       || (endptr == NULL)  /* This should not happen */
  68       || (*endptr != 0))   /* Trailing chars */
  69     return (-1);
  70
  71   n->time = DOUBLE_TO_CDTIME_T(tmp);
  72
  73   return (0);
  74 } /* int set_option_time */
  75
  76 static int set_option(notification_t *n, const char *option,
  77                       const char *value) {
  78   if ((n == NULL) || (option == NULL) || (value == NULL))
  79     return (-1);
  80
  81   DEBUG("utils_cmd_putnotif: set_option (option = %s, value = %s);", option,
  82         value);
  83
  84   /* Add a meta option in the form: <type>:<key> */
  85   if (option[0] != '\0' && option[1] == ':') {
  86     /* Refuse empty key */
  87     if (option[2] == '\0')
  88       return (1);
  89
  90     if (option[0] == 's')
  91       return plugin_notification_meta_add_string(n, option + 2, value);
  92     else
  93       return (1);
  94   }
  95
  96   if (strcasecmp("severity", option) == 0)
  97     return (set_option_severity(n, value));
  98   else if (strcasecmp("time", option) == 0)
  99     return (set_option_time(n, value));
 100   else if (strcasecmp("message", option) == 0)
 101     sstrncpy(n->message, value, sizeof(n->message));
 102   else if (strcasecmp("host", option) == 0)
 103     sstrncpy(n->host, value, sizeof(n->host));
 104   else if (strcasecmp("plugin", option) == 0)
 105     sstrncpy(n->plugin, value, sizeof(n->plugin));
 106   else if (strcasecmp("plugin_instance", option) == 0)
 107     sstrncpy(n->plugin_instance, value, sizeof(n->plugin_instance));
 108   else if (strcasecmp("type", option) == 0)
 109     sstrncpy(n->type, value, sizeof(n->type));
 110   else if (strcasecmp("type_instance", option) == 0)
 111     sstrncpy(n->type_instance, value, sizeof(n->type_instance));
 112   else
 113     return (1);
 114
 115   return (0);
 116 } /* int set_option */
 117
 118 int handle_putnotif(FILE *fh, char *buffer) {
 119   char *command;
 120   notification_t n = {0};
 121   int status;
 122
 123   if ((fh == NULL) || (buffer == NULL))
 124     return (-1);
 125
 126   DEBUG("utils_cmd_putnotif: handle_putnotif (fh = %p, buffer = %s);",
 127         (void *)fh, buffer);
 128
 129   command = NULL;
 130   status = parse_string(&buffer, &command);
 131   if (status != 0) {
 132     print_to_socket(fh, "-1 Cannot parse command.\n");
 133     return (-1);
 134   }
 135   assert(command != NULL);
 136
 137   if (strcasecmp("PUTNOTIF", command) != 0) {
 138     print_to_socket(fh, "-1 Unexpected command: `%s'.\n", command);
 139     return (-1);
 140   }
 141
 142   status = 0;
 143   while (*buffer != 0) {
 144     char *key;
 145     char *value;
 146
 147     status = parse_option(&buffer, &key, &value);
 148     if (status != 0) {
 149       print_to_socket(fh, "-1 Malformed option.\n");
 150       break;
 151     }
 152
 153     status = set_option(&n, key, value);
 154     if (status != 0) {
 155       print_to_socket(fh, "-1 Error parsing option `%s'\n", key);
 156       break;
 157     }
 158   } /* for (i) */
 159
 160   /* Check for required fields and complain if anything is missing. */
 161   if ((status == 0) && (n.severity == 0)) {
 162     print_to_socket(fh, "-1 Option `severity' missing.\n");
 163     status = -1;
 164   }
 165   if ((status == 0) && (n.time == 0)) {
 166     print_to_socket(fh, "-1 Option `time' missing.\n");
 167     status = -1;
 168   }
 169   if ((status == 0) && (strlen(n.message) == 0)) {
 170     print_to_socket(fh, "-1 No message or message of length 0 given.\n");
 171     status = -1;
 172   }
 173
 174   /* If status is still zero the notification is fine and we can finally
 175    * dispatch it. */
 176   if (status == 0) {
 177     plugin_dispatch_notification(&n);
 178     print_to_socket(fh, "0 Success\n");
 179   }
 180
 181   return (0);
 182 } /* int handle_putnotif */