src/notify_desktop.c

   1 /**
   2  * collectd - src/notify_desktop.c
   3  * Copyright (C) 2008  Sebastian Harl
   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; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Author:
  19  *   Sebastian Harl <sh at tokkee.org>
  20  **/
  21
  22 /*
  23  * This plugin sends desktop notifications to a notification daemon.
  24  */
  25
  26 #include "collectd.h"
  27 #include "common.h"
  28 #include "plugin.h"
  29 #include "configfile.h"
  30
  31 #include <glib.h>
  32 #include <libnotify/notify.h>
  33
  34 #define log_info(...) INFO ("notify_desktop: " __VA_ARGS__)
  35 #define log_warn(...) WARNING ("notify_desktop: " __VA_ARGS__)
  36 #define log_err(...) ERROR ("notify_desktop: " __VA_ARGS__)
  37
  38 #define DEFAULT_TIMEOUT 5000
  39
  40 static int okay_timeout = DEFAULT_TIMEOUT;
  41 static int warn_timeout = DEFAULT_TIMEOUT;
  42 static int fail_timeout = DEFAULT_TIMEOUT;
  43
  44 static int set_timeout (oconfig_item_t *ci, int *timeout)
  45 {
  46         if ((0 != ci->children_num) || (1 != ci->values_num)
  47                         || (OCONFIG_TYPE_NUMBER != ci->values[0].type)) {
  48                 log_err ("%s expects a single number argument.", ci->key);
  49                 return 1;
  50         }
  51
  52         *timeout = (int)ci->values[0].value.number;
  53         if (0 > *timeout)
  54                 *timeout = DEFAULT_TIMEOUT;
  55         return 0;
  56 } /* set_timeout */
  57
  58 static int c_notify_config (oconfig_item_t *ci)
  59 {
  60         int i = 0;
  61
  62         for (i = 0; i < ci->children_num; ++i) {
  63                 oconfig_item_t *c = ci->children + i;
  64
  65                 if (0 == strcasecmp (c->key, "OkayTimeout"))
  66                         set_timeout (c, &okay_timeout);
  67                 else if (0 == strcasecmp (c->key, "WarningTimeout"))
  68                         set_timeout (c, &warn_timeout);
  69                 else if (0 == strcasecmp (c->key, "FailureTimeout"))
  70                         set_timeout (c, &fail_timeout);
  71         }
  72         return 0;
  73 } /* c_notify_config */
  74
  75 static int c_notify (const notification_t *n,
  76                 user_data_t __attribute__((unused)) *user_data)
  77 {
  78         NotifyNotification *notification = NULL;
  79         NotifyUrgency       urgency      = NOTIFY_URGENCY_LOW;
  80         int                 timeout      = okay_timeout;
  81
  82         char summary[1024];
  83
  84         if (NOTIF_WARNING == n->severity) {
  85                 urgency = NOTIFY_URGENCY_NORMAL;
  86                 timeout = warn_timeout;
  87         }
  88         else if (NOTIF_FAILURE == n->severity) {
  89                 urgency = NOTIFY_URGENCY_CRITICAL;
  90                 timeout = fail_timeout;
  91         }
  92
  93         ssnprintf (summary, sizeof (summary), "collectd %s notification",
  94                         (NOTIF_FAILURE == n->severity) ? "FAILURE"
  95                                 : (NOTIF_WARNING == n->severity) ? "WARNING"
  96                                 : (NOTIF_OKAY == n->severity) ? "OKAY" : "UNKNOWN");
  97
  98         notification = notify_notification_new (summary, n->message, NULL, NULL);
  99         if (NULL == notification) {
 100                 log_err ("Failed to create a new notification.");
 101                 return -1;
 102         }
 103
 104         notify_notification_set_urgency (notification, urgency);
 105         notify_notification_set_timeout (notification, timeout);
 106
 107         if (! notify_notification_show (notification, NULL))
 108                 log_err ("Failed to display notification.");
 109
 110         g_object_unref (G_OBJECT (notification));
 111         return 0;
 112 } /* c_notify */
 113
 114 static int c_notify_shutdown (void)
 115 {
 116         plugin_unregister_init ("notify_desktop");
 117         plugin_unregister_notification ("notify_desktop");
 118         plugin_unregister_shutdown ("notify_desktop");
 119
 120         if (notify_is_initted ())
 121                 notify_uninit ();
 122         return 0;
 123 } /* c_notify_shutdown */
 124
 125 static int c_notify_init (void)
 126 {
 127         char *name         = NULL;
 128         char *vendor       = NULL;
 129         char *version      = NULL;
 130         char *spec_version = NULL;
 131
 132         if (! notify_init (PACKAGE_STRING)) {
 133                 log_err ("Failed to initialize libnotify.");
 134                 return -1;
 135         }
 136
 137         if (! notify_get_server_info (&name, &vendor, &version, &spec_version))
 138                 log_warn ("Failed to get the notification server info. "
 139                                 "Check if you have a notification daemon running.");
 140         else {
 141                 log_info ("Found notification daemon: %s (%s) %s (spec version %s)",
 142                                 name, vendor, version, spec_version);
 143                 free (name);
 144                 free (vendor);
 145                 free (version);
 146                 free (spec_version);
 147         }
 148
 149         plugin_register_notification ("notify_desktop", c_notify,
 150                         /* user_data = */ NULL);
 151         plugin_register_shutdown ("notify_desktop", c_notify_shutdown);
 152         return 0;
 153 } /* c_notify_init */
 154
 155 void module_register (void)
 156 {
 157         plugin_register_complex_config ("notify_desktop", c_notify_config);
 158         plugin_register_init ("notify_desktop", c_notify_init);
 159         return;
 160 } /* module_register */
 161
 162 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */
 163