Code

collectd-exec(5): Document the removed backwards compatibility code.
[collectd.git] / 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  **/
23 #include "collectd.h"
24 #include "common.h"
25 #include "plugin.h"
27 #include <auth-client.h>
28 #include <libesmtp.h>
30 #define MAXSTRING               256
32 static const char *config_keys[] =
33 {
34   "SMTPServer",
35   "SMTPPort",
36   "SMTPUser",
37   "SMTPPassword",
38   "From",
39   "Recipient",
40   "Subject"
41 };
42 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
44 static char **recipients;
45 static int recipients_len = 0;
47 static smtp_session_t session;
48 static smtp_message_t message;
49 static auth_context_t authctx = NULL;
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 *email_from = NULL;
56 static char *email_subject = NULL;
58 #define DEFAULT_SMTP_HOST       "localhost"
59 #define DEFAULT_SMTP_FROM       "root@localhost"
60 #define DEFAULT_SMTP_SUBJECT    "Collectd notify: %s@%s"
62 /* Callback to get username and password */
63 static int authinteract (auth_client_request_t request, char **result,
64     int fields, void __attribute__((unused)) *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 } /* int authinteract */
79 /* Callback to print the recipient status */
80 static void print_recipient_status (smtp_recipient_t recipient,
81     const char *mailbox, void __attribute__((unused)) *arg)
82 {
83   const smtp_status_t *status;
85   status = smtp_recipient_status (recipient);
86   if (status->text[strlen(status->text) - 2] == '\r')
87     status->text[strlen(status->text) - 2] = 0;
88   INFO ("notify_email: notify sent to %s: %d %s", mailbox, status->code,
89       status->text);
90 } /* void print_recipient_status */
92 /* Callback to monitor SMTP activity */
93 static void monitor_cb (const char *buf, int buflen, int writing,
94     void __attribute__((unused)) *arg)
95 {
96   char log_str[MAXSTRING];
98   sstrncpy (log_str, buf, sizeof (log_str));
99   if (buflen > 2)
100     log_str[buflen - 2] = 0; /* replace \n with \0 */
102   if (writing == SMTP_CB_HEADERS) {
103     DEBUG ("notify_email plugin: SMTP --- H: %s", log_str);
104     return;
105   }
106   DEBUG (writing
107       ? "notify_email plugin: SMTP >>> C: %s"
108       : "notify_email plugin: SMTP <<< S: %s",
109       log_str);
110 } /* void monitor_cb */
112 static int notify_email_init (void)
114   char server[MAXSTRING];
116   auth_client_init();
117   if (!(session = smtp_create_session ())) {
118     ERROR ("notify_email plugin: cannot create SMTP session");
119     return (-1);
120   }
122   smtp_set_monitorcb (session, monitor_cb, NULL, 1);
123   smtp_set_hostname (session, hostname_g);
124   ssnprintf(server, sizeof (server), "%s:%i",
125       (smtp_host == NULL) ? DEFAULT_SMTP_HOST : smtp_host,
126       smtp_port);
127   smtp_set_server (session, server);
129   if (smtp_user && smtp_password) {
130     authctx = auth_create_context ();
131     auth_set_mechanism_flags (authctx, AUTH_PLUGIN_PLAIN, 0);
132     auth_set_interact_cb (authctx, authinteract, NULL);
133   }
135   if ( !smtp_auth_set_context (session, authctx)) {
136     ERROR ("notify_email plugin: cannot set SMTP auth context");
137     return (-1);   
138   }
140   return (0);
141 } /* int notify_email_init */
143 static int notify_email_shutdown (void)
145   smtp_destroy_session (session);
146   auth_destroy_context (authctx);
147   auth_client_exit();
148   return (0);
149 } /* int notify_email_shutdown */
151 static int notify_email_config (const char *key, const char *value)
153   if (strcasecmp (key, "Recipient") == 0)
154   {
155     char **tmp;
157     tmp = (char **) realloc ((void *) recipients, (recipients_len + 1) * sizeof (char *));
158     if (tmp == NULL) {
159       ERROR ("notify_email: realloc failed.");
160       return (-1);
161     }
163     recipients = tmp;
164     recipients[recipients_len] = strdup (value);
165     if (recipients[recipients_len] == NULL) {
166       ERROR ("notify_email: strdup failed.");
167       return (-1);
168     }
169     recipients_len++;
170   }
171   else if (0 == strcasecmp (key, "SMTPServer")) {
172     sfree (smtp_host);
173     smtp_host = strdup (value);
174   }
175   else if (0 == strcasecmp (key, "SMTPPort")) {
176     int port_tmp = atoi (value);
177     if (port_tmp < 1 || port_tmp > 65535)
178     {
179       WARNING ("notify_email plugin: Invalid SMTP port: %i", port_tmp);
180       return (1);
181     }
182     smtp_port = port_tmp;
183   }
184   else if (0 == strcasecmp (key, "SMTPUser")) {
185     sfree (smtp_user);
186     smtp_user = strdup (value);
187   }
188   else if (0 == strcasecmp (key, "SMTPPassword")) {
189     sfree (smtp_password);
190     smtp_password = strdup (value);
191   }
192   else if (0 == strcasecmp (key, "From")) {
193     sfree (email_from);
194     email_from = strdup (value);
195   }
196   else if (0 == strcasecmp (key, "Subject")) {
197     sfree (email_subject);
198     email_subject = strdup (value);
199   }
200   else {
201     return -1;
202   }
203   return 0;
204 } /* int notify_email_config (const char *, const char *) */
206 static int notify_email_notification (const notification_t *n,
207     user_data_t __attribute__((unused)) *user_data)
209   smtp_recipient_t recipient;
211   struct tm timestamp_tm;
212   char timestamp_str[64];
214   char severity[32];
215   char subject[MAXSTRING];
217   char buf[4096] = "";
218   int  buf_len = sizeof (buf);
219   int i;
221   ssnprintf (severity, sizeof (severity), "%s",
222       (n->severity == NOTIF_FAILURE) ? "FAILURE"
223       : ((n->severity == NOTIF_WARNING) ? "WARNING"
224         : ((n->severity == NOTIF_OKAY) ? "OKAY" : "UNKNOWN")));
226   ssnprintf (subject, sizeof (subject),
227       (email_subject == NULL) ? DEFAULT_SMTP_SUBJECT : email_subject,
228       severity, n->host);
230   localtime_r (&n->time, &timestamp_tm);
231   strftime (timestamp_str, sizeof (timestamp_str), "%Y-%m-%d %H:%M:%S",
232       &timestamp_tm);
233   timestamp_str[sizeof (timestamp_str) - 1] = '\0';
235   /* Let's make RFC822 message text with \r\n EOLs */
236   ssnprintf (buf, buf_len,
237       "MIME-Version: 1.0\r\n"
238       "Content-Type: text/plain;\r\n"
239       "Content-Transfer-Encoding: 8bit\r\n"
240       "Subject: %s\r\n"
241       "\r\n"
242       "%s - %s@%s\r\n"
243       "\r\n"
244       "Message: %s",
245       subject,
246       timestamp_str,
247       severity,
248       n->host,
249       n->message);
251   if (!(message = smtp_add_message (session))) {
252     ERROR ("notify_email plugin: cannot set SMTP message");
253     return (-1);   
254   }
255   smtp_set_reverse_path (message, email_from);
256   smtp_set_header (message, "To", NULL, NULL);
257   smtp_set_message_str (message, buf);
259   for (i = 0; i < recipients_len; i++)
260     recipient = smtp_add_recipient (message, recipients[i]);
262   /* Initiate a connection to the SMTP server and transfer the message. */
263   if (!smtp_start_session (session)) {
264     char buf[MAXSTRING];
265     ERROR ("notify_email plugin: SMTP server problem: %s",
266         smtp_strerror (smtp_errno (), buf, sizeof buf));
267     return (-1);
268   } else {
269     const smtp_status_t *status;
270     /* Report on the success or otherwise of the mail transfer. */
271     status = smtp_message_transfer_status (message);
272     DEBUG ("notify_email plugin: SMTP server report: %d %s",
273         status->code, (status->text != NULL) ? status->text : "\n");
274     smtp_enumerate_recipients (message, print_recipient_status, NULL);
275   }
277   return (0);
278 } /* int notify_email_notification */
280 void module_register (void)
282   plugin_register_init ("notify_email", notify_email_init);
283   plugin_register_shutdown ("notify_email", notify_email_shutdown);
284   plugin_register_config ("notify_email", notify_email_config,
285       config_keys, config_keys_num);
286   plugin_register_notification ("notify_email", notify_email_notification,
287       /* user_data = */ NULL);
288 } /* void module_register (void) */
290 /* vim: set sw=2 sts=2 ts=8 et : */