src/notify_email.c

   1 /**
   2  * collectd - src/notify_email.c
   3  * Copyright (C) 2008  Oleg King
   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; either version 2 of the License, or (at your
   8  * option) any later version.
   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  *   Oleg King <king2 at kaluga.ru>
  21  **/
  22
  23 #include "collectd.h"
  24 #include "common.h"
  25 #include "plugin.h"
  26
  27 #include <auth-client.h>
  28 #include <libesmtp.h>
  29
  30 #define MAXSTRING               256
  31
  32 static const char *config_keys[] =
  33 {
  34   "SMTPHost",
  35   "SMTPPort",
  36   "SMTPUser",
  37   "SMTPPassword",
  38   "SMTPFrom",
  39   "SMTPSubject",
  40   "EmailTo"
  41 };
  42 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  43
  44 static char **emails;
  45 static int emails_len = 0;
  46
  47 static smtp_session_t session;
  48 static smtp_message_t message;
  49 static auth_context_t authctx = NULL;
  50
  51 static int smtp_port = 25;
  52 static char *smtp_host = NULL;
  53 static char *smtp_user = NULL;
  54 static char *smtp_password = NULL;
  55 static char *smtp_from = NULL;
  56 static char *smtp_subject = NULL;
  57
  58 #define DEFAULT_SMTP_HOST       "localhost"
  59 #define DEFAULT_SMTP_FROM       "root@localhost"
  60 #define DEFAULT_SMTP_SUBJECT    "Collectd notify: %s@%s"
  61
  62
  63 /* Callback to get username and password */
  64 static int authinteract (auth_client_request_t request, char **result, int fields, void *arg)
  65 {
  66   int i;
  67   for (i = 0; i < fields; i++)
  68   {
  69     if (request[i].flags & AUTH_USER)
  70       result[i] = smtp_user;
  71     else if (request[i].flags & AUTH_PASS)
  72       result[i] = smtp_password;
  73     else
  74       return 0;
  75   }
  76   return 1;
  77 }
  78
  79 /* Callback to print the recipient status */
  80 static void print_recipient_status (smtp_recipient_t recipient, const char *mailbox, void *arg)
  81 {
  82   const smtp_status_t *status;
  83
  84   status = smtp_recipient_status (recipient);
  85   if (status->text[strlen(status->text) - 2] == '\r')
  86     status->text[strlen(status->text) - 2] = 0;
  87   INFO ("notify_email: notify sent to %s: %d %s", mailbox, status->code, status->text);
  88 }
  89
  90 /* Callback to monitor SMTP activity */
  91 static void monitor_cb (const char *buf, int buflen, int writing, void *arg)
  92 {
  93   char log_str[MAXSTRING];
  94
  95   strncpy(log_str, buf, buflen);
  96   if (buflen > 2)
  97     log_str[buflen - 2] = 0; /* replace \n with \0 */
  98
  99   if (writing == SMTP_CB_HEADERS) {
 100     DEBUG ("SMTP --- H: %s", log_str);
 101     return;
 102   }
 103   DEBUG (writing ? "SMTP >>> C: %s" : "SMTP <<< S: %s", log_str);
 104 }
 105
 106 static int notify_email_init()
 107 {
 108   char server[MAXSTRING];
 109
 110   auth_client_init();
 111   if ( !(session = smtp_create_session()) ) {
 112     ERROR ("notify_email plugin: cannot create SMTP session");
 113     return (-1);
 114   }
 115
 116   smtp_set_monitorcb (session, monitor_cb, NULL, 1);
 117   smtp_set_hostname (session, hostname_g);
 118   sprintf(server, "%s:%i", smtp_host == NULL ? DEFAULT_SMTP_HOST : smtp_host, smtp_port);
 119   smtp_set_server (session, server);
 120
 121   if (smtp_user && smtp_password) {
 122     authctx = auth_create_context ();
 123     auth_set_mechanism_flags (authctx, AUTH_PLUGIN_PLAIN, 0);
 124     auth_set_interact_cb (authctx, authinteract, NULL);
 125   }
 126
 127   if ( !smtp_auth_set_context (session, authctx)) {
 128     ERROR ("notify_email plugin: cannot set SMTP auth context");
 129     return (-1);
 130   }
 131
 132   return (0);
 133 }
 134
 135
 136 static int notify_email_shutdown()
 137 {
 138   smtp_destroy_session (session);
 139   auth_destroy_context (authctx);
 140   auth_client_exit();
 141   return (0);
 142 }
 143
 144
 145 static int notify_email_config (const char *key, const char *value)
 146 {
 147   if (strcasecmp (key, "EmailTo") == 0)
 148   {
 149     char **tmp;
 150
 151     tmp = (char **) realloc ((void *) emails, (emails_len + 1) * sizeof (char *));
 152     if (tmp == NULL) {
 153       ERROR ("notify_email: realloc failed.");
 154       return (-1);
 155     }
 156
 157     emails = tmp;
 158     emails[emails_len] = strdup (value);
 159     if (emails[emails_len] == NULL) {
 160       ERROR ("notify_email: strdup failed.");
 161       return (-1);
 162     }
 163     emails_len++;
 164   }
 165   else if (0 == strcasecmp (key, "SMTPHost")) {
 166     sfree (smtp_host);
 167     smtp_host = strdup (value);
 168   }
 169   else if (0 == strcasecmp (key, "SMTPPort")) {
 170     int port_tmp = atoi (value);
 171     if (port_tmp < 1 || port_tmp > 65535)
 172     {
 173       WARNING ("notify_email plugin: Invalid SMTP port: %i", port_tmp);
 174       return (1);
 175     }
 176     smtp_port = port_tmp;
 177   }
 178   else if (0 == strcasecmp (key, "SMTPUser")) {
 179     sfree (smtp_user);
 180     smtp_user = strdup (value);
 181   }
 182   else if (0 == strcasecmp (key, "SMTPPassword")) {
 183     sfree (smtp_password);
 184     smtp_password = strdup (value);
 185   }
 186   else if (0 == strcasecmp (key, "SMTPFrom")) {
 187     sfree (smtp_from);
 188     smtp_from = strdup (value);
 189   }
 190   else if (0 == strcasecmp (key, "SMTPSubject")) {
 191     sfree (smtp_subject);
 192     smtp_subject = strdup (value);
 193   }
 194   else {
 195     return -1;
 196   }
 197   return 0;
 198 } /* int notify_email_config (const char *, const char *) */
 199
 200
 201 static int notify_email_notification (const notification_t *n)
 202 {
 203   smtp_recipient_t recipient;
 204
 205   struct tm timestamp_tm;
 206   char timestamp_str[64];
 207
 208   char severity[MAXSTRING];
 209   char subject[MAXSTRING];
 210
 211   char buf[4096] = "";
 212   int  buf_len = sizeof (buf);
 213   int i;
 214
 215   sprintf (severity, "%s",
 216       (n->severity == NOTIF_FAILURE) ? "FAILURE"
 217       : ((n->severity == NOTIF_WARNING) ? "WARNING"
 218         : ((n->severity == NOTIF_OKAY) ? "OKAY" : "UNKNOWN")));
 219
 220   sprintf (subject, smtp_subject == NULL ? DEFAULT_SMTP_SUBJECT : smtp_subject, severity, n->host);
 221
 222   localtime_r (&n->time, &timestamp_tm);
 223   strftime (timestamp_str, sizeof (timestamp_str), "%Y-%m-%d %H:%M:%S", &timestamp_tm);
 224   timestamp_str[sizeof (timestamp_str) - 1] = '\0';
 225
 226   /* Let's make RFC822 message text with \r\n EOLs */
 227   snprintf (buf, buf_len,
 228       "MIME-Version: 1.0\r\n"
 229       "Content-Type: text/plain;\r\n"
 230       "Content-Transfer-Encoding: 8bit\r\n"
 231       "Subject: %s\r\n"
 232       "\r\n"
 233       "%s - %s@%s\r\n"
 234       "\r\n"
 235       "Message: %s",
 236       subject,
 237       timestamp_str,
 238       severity,
 239       n->host,
 240       n->message);
 241
 242   if ( !(message = smtp_add_message (session))) {
 243     ERROR ("notify_email plugin: cannot set SMTP message");
 244     return (-1);
 245   }
 246   smtp_set_reverse_path (message, smtp_from);
 247   smtp_set_header (message, "To", NULL, NULL);
 248   smtp_set_message_str (message, buf);
 249
 250   for (i = 0; i < emails_len; i++)
 251     recipient = smtp_add_recipient (message, emails[i]);
 252
 253   /* Initiate a connection to the SMTP server and transfer the message. */
 254   if (!smtp_start_session (session)) {
 255     char buf[MAXSTRING];
 256     ERROR ("SMTP server problem: %s", smtp_strerror (smtp_errno (), buf, sizeof buf));
 257     return (-1);
 258   } else {
 259     const smtp_status_t *status;
 260     /* Report on the success or otherwise of the mail transfer. */
 261     status = smtp_message_transfer_status (message);
 262     DEBUG ("SMTP server report: %d %s", status->code, (status->text != NULL) ? status->text : "\n");
 263     smtp_enumerate_recipients (message, print_recipient_status, NULL);
 264   }
 265
 266   return (0);
 267 } /* int notify_email_notification */
 268
 269 void module_register (void)
 270 {
 271   plugin_register_init ("notify_email", notify_email_init);
 272   plugin_register_shutdown ("notify_email", notify_email_shutdown);
 273   plugin_register_config ("notify_email", notify_email_config,
 274       config_keys, config_keys_num);
 275   plugin_register_notification ("notify_email", notify_email_notification);
 276 } /* void module_register (void) */