added sound alerts (fixes sni#68)

Author: sni

Changes

@@ -9,6 +9,7 @@ This file documents the revision history for the Monitoring Webinterface Thruk.
           - added init script
           - added event details to logs excel export
           - added site name to excel export (Mark Wilkinson)
+          - added sound alerts
           - internal changes ( removed prototype library )
           - mobile:
               - added performance graph to mobile interface

MANIFEST

@@ -140,6 +140,8 @@ plugins/plugins-available/conf/t/data/4/dir/file3.cfg
 plugins/plugins-available/conf/t/data/4/file1.cfg
 plugins/plugins-available/conf/t/data/4/file2.cfg
 plugins/plugins-available/conf/t/data/5/hosts.cfg
+plugins/plugins-available/conf/t/data/6/servicegroups_iso-8859.cfg
+plugins/plugins-available/conf/t/data/6/servicegroups_utf8.cfg
 plugins/plugins-available/conf/t/model_Objects.t
 plugins/plugins-available/conf/templates/_conf_action_menu.tt
 plugins/plugins-available/conf/templates/_conf_frame.tt
@@ -292,6 +294,10 @@ root/thruk/javascript/jquery-ui/css/smoothness/jquery-ui-1.8.16.custom.css
 root/thruk/javascript/jquery-ui/js/jquery-ui-1.8.16.custom.min.js
 root/thruk/javascript/overlib.js
 root/thruk/javascript/thruk-1.27.js
+root/thruk/media/critical.wav
+root/thruk/media/ok.wav
+root/thruk/media/unknown.wav
+root/thruk/media/warning.wav
 root/thruk/startup.html
 root/thruk/themes
 script/append.make
@@ -391,6 +397,7 @@ templates/_service_command_box.tt
 templates/_service_command_box_full.tt
 templates/_service_status_details_box.tt
 templates/_show_link.tt
+templates/_sounds.tt
 templates/_status_cmd_pane.tt
 templates/_status_detail_table.tt
 templates/_status_filter.tt

THANKS

@@ -25,6 +25,7 @@ Pierre Mavro
 Mark Wilkinson
 
 
+
 STYLES:
 =======
 Nagios Neat Style:
@@ -41,7 +42,7 @@ http://exchange.nagios.org/directory/Addons/Frontends-%28GUIs-and-CLIs%29/Web-In
 
 
 
-ICONS:
+MEDIA:
 ======
 
 Silk Icon Set:
@@ -53,6 +54,10 @@ http://glyphish.com/
 Find Icons
 http://findicons.com/
 
+Alarm Sound
+http://www.freeaudioclips.com
+
+
 
 JAVASCRIPT:
 ===========

cgi.cfg

@@ -176,3 +176,28 @@ notes_url_target=_blank
 #         1 = lock author names (disallow editing)
 
 lock_author_names=1
+
+
+# SOUND OPTIONS
+# These options allow you to specify an optional audio file
+# that should be played in your browser window when there are
+# problems on the network.  The audio files are used only in
+# the status CGI.  Only the sound for the most critical problem
+# will be played.  Order of importance (higher to lower) is as
+# follows: unreachable hosts, down hosts, critical services,
+# warning services, and unknown services. If there are no
+# visible problems, the sound file optionally specified by
+# 'normal_sound' variable will be played.
+#
+# <varname>=<sound_file>
+#
+# Note: All audio files use relative paths from /thruk/cgi-bin/status.cgi
+# and must be accessible by web
+
+host_unreachable_sound=../media/critical.wav
+host_down_sound=../media/critical.wav
+service_critical_sound=../media/critical.wav
+service_warning_sound=../media/warning.wav
+service_unknown_sound=../media/unknown.wav
+#normal_sound=../media/ok.wav
+

lib/Thruk/Controller/Root.pm

@@ -280,6 +280,18 @@ sub begin : Private {
     # additional views on status pages
     $c->stash->{'additional_views'} = $Thruk::Utils::Status::additional_views || {};
 
+    # sound cookie set?
+    $c->stash->{'play_sounds'} = 0;
+    if(defined $c->request->cookie('thruk_sounds')) {
+        my $sound_cookie = $c->request->cookie('thruk_sounds');
+        if(defined $sound_cookie->value and $sound_cookie->value eq 'off') {
+            $c->stash->{'play_sounds'} = 0;
+        }
+        if(defined $sound_cookie->value and $sound_cookie->value eq 'on') {
+            $c->stash->{'play_sounds'} = 1;
+        }
+    }
+
     # make private _ hash keys available
     $Template::Stash::PRIVATE = undef;
 

lib/Thruk/Controller/status.pm

@@ -804,6 +804,9 @@ sub _process_combined_page {
     $c->stash->{'show_host_attempts'} = 1;
     if( $sortoption == 6 and defined $hosts ) { @{ $c->stash->{'hosts'} } = reverse @{ $c->stash->{'hosts'} }; }
 
+    # set audio file to play
+    Thruk::Utils::Status::set_audio_file($c);
+
     return 1;
 }
 

lib/Thruk/Utils/Status.pm

@@ -43,12 +43,13 @@ sub set_default_stash {
     $c->stash->{'servicegroup'}         = $c->{'request'}->{'parameters'}->{'servicegroup'}       || '';
     $c->stash->{'host'}                 = $c->{'request'}->{'parameters'}->{'host'}               || '';
     $c->stash->{'service'}              = $c->{'request'}->{'parameters'}->{'service'}            || '';
-    $c->stash->{'data'}                 = "";
-    $c->stash->{'style'}                = "";
+    $c->stash->{'data'}                 = '';
+    $c->stash->{'style'}                = '';
     $c->stash->{'has_error'}            = 0;
-    $c->stash->{'pager'}                = "";
+    $c->stash->{'pager'}                = '';
     $c->stash->{show_substyle_selector} = 1;
     $c->stash->{imgsize}                = 20;
+    $c->stash->{'audiofile'}            = '';
 
     return;
 }
@@ -455,6 +456,9 @@ sub fill_totals_box {
 
     $c->stash->{'service_stats'} = $service_stats;
 
+    # set audio file to play
+    Thruk::Utils::Status::set_audio_file($c);
+
     return 1;
 }
 
@@ -1596,6 +1600,79 @@ sub convert_time_amount {
     return $value;
 }
 
+##############################################
+
+=head2 set_audio_file
+
+  set_audio_file($c)
+
+set if browser should play a sound file
+
+=cut
+sub set_audio_file {
+    my( $c ) = @_;
+
+    return unless $c->stash->{'play_sounds'};
+
+    if(defined $c->stash->{'host_stats'} and defined $c->stash->{'service_stats'}) {
+        for my $s (qw/unreachable down/) {
+            if($c->stash->{'host_stats'}->{$s} > 0 and defined $c->config->{'cgi_cfg'}->{'host_'.$s.'_sound'}) {
+                $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'host_'.$s.'_sound'};
+                return;
+            }
+        }
+        for my $s (qw/critical warning unknown/) {
+            if($c->stash->{'service_stats'}->{$s} > 0 and defined $c->config->{'cgi_cfg'}->{'service_'.$s.'_sound'}) {
+                $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'service_'.$s.'_sound'};
+                return;
+            }
+        }
+    }
+
+    elsif(defined $c->stash->{'hosts'} and defined $c->stash->{'services'}) {
+        my $worst_host = 0;
+        for my $h (@{$c->stash->{'hosts'}}) {
+            $worst_host = $h->{'state'} if $worst_host < $h->{'state'};
+        }
+        if($worst_host == 2 and defined $c->config->{'cgi_cfg'}->{'host_unreachable_sound'}) {
+            $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'host_unreachable_sound'};
+            return;
+        }
+        if($worst_host == 1 and defined $c->config->{'cgi_cfg'}->{'host_down_sound'}) {
+            $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'host_down_sound'};
+            return;
+        }
+
+        my $worst_service = 0;
+        for my $s (@{$c->stash->{'services'}}) {
+            my $state = $s->{'state'} + 1;
+            $state = $state - 3 if $state == 4;
+            $worst_service = $state if $worst_host < $state;
+        }
+        if($worst_host == 3 and defined $c->config->{'cgi_cfg'}->{'service_critical_sound'}) {
+            $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'service_critical_sound'};
+            return;
+        }
+        if($worst_host == 2 and defined $c->config->{'cgi_cfg'}->{'service_warning_sound'}) {
+            $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'service_warning_sound'};
+            return;
+        }
+        if($worst_host == 1 and defined $c->config->{'cgi_cfg'}->{'service_unknown_sound'}) {
+            $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'service_unknown_sound'};
+            return;
+        }
+    }
+
+    if($c->stash->{'audiofile'} eq '' and defined $c->config->{'cgi_cfg'}->{'normal_sound'}) {
+        $c->stash->{'audiofile'} = $c->config->{'cgi_cfg'}->{'normal_sound'};
+        return;
+    }
+
+    return;
+}
+
+##############################################
+
 =head1 AUTHOR
 
 Sven Nierlein, 2009, <[email protected]>

plugins/plugins-available/dashboard/templates/status_dashboard.tt

@@ -21,6 +21,8 @@
 <link rel='stylesheet' type='text/css' href='[% url_prefix %]thruk/plugins/dashboard/thruk/stylesheets/dashboard.css' />
 [% END %]
 [% PROCESS _header.tt extra_header => dashboard_header %]
+[% PROCESS _message.tt %]
+[% PROCESS _sounds.tt %]
 
     <table border="0" width="100%" cellspacing="0" cellpadding="0" id="top_pane"[% IF hidetop == 1 %]style="visibility:hidden; display:none;"[% END %]>
       <tr>

plugins/plugins-available/minemap/templates/minemap.tt

@@ -1,6 +1,7 @@
 [% USE date %]
 [% PROCESS _header.tt %]
 [% PROCESS _message.tt %]
+[% PROCESS _sounds.tt %]
 
     <table border="0" width="100%" cellspacing="0" cellpadding="0" id="top_pane"[% IF hidetop == 1 %]style="visibility:hidden; display:none;"[% END %]>
       <tr>

root/thruk/javascript/all_in_one-1.27.js

@@ -151,6 +151,15 @@ function prefSubmit(url, current_theme) {
   }
 }
 
+/* save settings in a cookie */
+function prefSubmitSound(url, value) {
+  var now         = new Date();
+  var expires     = new Date(now.getTime() + (10*365*86400*1000)); // let the cookie expire in 10 years
+  document.cookie = "thruk_sounds="+value+"; path="+url_prefix+"thruk; expires=" + expires.toGMTString() + ";";
+  window.status   = "thruk preferences saved";
+  reloadPage();
+}
+
 /* page refresh rate */
 function setRefreshRate(rate) {
   curRefreshVal = rate;

root/thruk/javascript/thruk-1.27.js

@@ -134,6 +134,15 @@ function prefSubmit(url, current_theme) {
   }
 }
 
+/* save settings in a cookie */
+function prefSubmitSound(url, value) {
+  var now         = new Date();
+  var expires     = new Date(now.getTime() + (10*365*86400*1000)); // let the cookie expire in 10 years
+  document.cookie = "thruk_sounds="+value+"; path="+url_prefix+"thruk; expires=" + expires.toGMTString() + ";";
+  window.status   = "thruk preferences saved";
+  reloadPage();
+}
+
 /* page refresh rate */
 function setRefreshRate(rate) {
   curRefreshVal = rate;

root/thruk/media/critical.wav

@@ -14,6 +14,7 @@ Getopt::Long::Configure('bundling');
 GetOptions (
    "h|help"             => \$options->{'help'},
    "v|verbose"          => \$options->{'verbose'},
+   "V|version"          => \$options->{'version'},
    "r|remote-url=s"     => \$options->{'remoteurl'},
      "local"            => \$options->{'local'},
    "c|credential=s"     => \$options->{'credential'},
@@ -24,6 +25,7 @@ GetOptions (
    "<>"                 => sub { $options->{'url'} = "".shift },
 ) or pod2usage( { -verbose => 2, -message => 'error in options' } );
 
+if($options->{'version'}) { require Thruk; print "Thruk Version $Thruk::VERSION\n"; exit 0; }
 pod2usage( { -verbose => 2, -exit => 1 } ) if $options->{'help'};
 pod2usage( { -verbose => 2, -exit => 1 } ) if !$options->{'action'} and !$options->{'url'} and !$options->{'listbackends'};
 

root/thruk/media/ok.wav

@@ -7,12 +7,13 @@ plan skip_all => 'Author test. Set $ENV{TEST_AUTHOR} to a true value to run.' un
 
 my $cmds = [
   "grep -nr 'TODO' lib/. templates/. plugins/plugins-available/. root/.",
-  "grep -nr Dumper lib/ plugins/plugins-available/ | grep STDERR | grep use",
+  "grep -nr 'print STDERR Dumper' lib/ plugins/plugins-available/",
 ];
 
 # find all TODOs
 for my $cmd (@{$cmds}) {
   open(my $ph, '-|', $cmd.' 2>&1') or die('cmd '.$cmd.' failed: '.$!);
+  ok($ph, 'cmd started');
   while(<$ph>) {
     my $line = $_;
     chomp($line);
@@ -22,15 +23,13 @@ for my $cmd (@{$cmds}) {
        or $line =~ m|Unicode/Encoding\.pm|mx
        or $line =~ m|/excanvas.js|mx
        or $line =~ m|jquery\.mobile\-.*.js|mx
-       or $line =~ m|:\d+:\#|mx
     ) {
       next;
     }
 
     fail($line);
   }
   close($ph);
-  ok($? == 0, 'cmd '.$cmd.' exited with: '.$?);
 }
 
 

root/thruk/media/unknown.wav

@@ -114,9 +114,9 @@
     <table class="pref_pane" border=1 width="450">
       <tr>
         <td>
-          <table>
+          <table width="430">
             <tr>
-              <th>Theme:</th>
+              <th width="100">Theme:</th>
               <td>
                 <select name="theme" id="pref_theme">
                   [% FOR t = themes %]
@@ -126,6 +126,12 @@
                 <input type="button" name="submit" value="change" onClick="prefSubmit('[% escape_html(c.request.uri) %]', '[% theme %]')">
               </td>
             </tr>
+            <tr>
+              <th>Sounds:</th>
+              <td>
+                <input type="button" name="submit" value="[% IF play_sounds %]sound is on[% ELSE %]sound is off[% END %]" onClick="prefSubmitSound('[% escape_html(c.request.uri) %]', '[% IF play_sounds %]off[% ELSE %]on[% END %]')">
+              </td>
+            </tr>
             <tr>
               <th>Page Refresh:</th>
               <td nowrap>

root/thruk/media/warning.wav

@@ -0,0 +1,3 @@
+[% IF audiofile %]
+<object height="0" width="0" data="[% audiofile %]" ></object>
+[% END %]

script/thruk

@@ -1,6 +1,7 @@
 [% USE date %]
 [% PROCESS _header.tt %]
 [% PROCESS _message.tt %]
+[% PROCESS _sounds.tt %]
 [% authorized_for_read_only = 0 %][% IF c.check_user_roles_wrapper('authorized_for_read_only') %][% authorized_for_read_only = 1 %][% END %]
 
 [% UNLESS authorized_for_read_only %]

t/92_todo.t

@@ -1,6 +1,7 @@
 [% USE date %]
 [% PROCESS _header.tt %]
 [% PROCESS _message.tt %]
+[% PROCESS _sounds.tt %]
 [% authorized_for_read_only = 0 %][% IF c.check_user_roles_wrapper('authorized_for_read_only') %][% authorized_for_read_only = 1 %][% END %]
 
 [% UNLESS authorized_for_read_only %]

templates/_header.tt

@@ -1,4 +1,5 @@
 [% PROCESS _header.tt %]
+[% PROCESS _sounds.tt %]
 
     <table border="0" width="100%" cellspacing="0" cellpadding="0" id="top_pane"[% IF hidetop == 1 %]style="visibility:hidden; display:none;"[% END %]>
       <tr>

templates/_sounds.tt

@@ -1,6 +1,7 @@
 [% USE date %]
 [% PROCESS _header.tt %]
 [% PROCESS _message.tt %]
+[% PROCESS _sounds.tt %]
 [% authorized_for_read_only = 0 %][% IF c.check_user_roles_wrapper('authorized_for_read_only') %][% authorized_for_read_only = 1 %][% END %]
 
 [% UNLESS authorized_for_read_only %]

templates/status_combined.tt

@@ -1,4 +1,5 @@
 [% PROCESS _header.tt %]
+[% PROCESS _sounds.tt %]
 
     <table border="0" width="100%" cellspacing="0" cellpadding="0" id="top_pane"[% IF hidetop == 1 %]style="visibility:hidden; display:none;"[% END %]>
       <tr>

templates/status_detail.tt

@@ -1,4 +1,5 @@
 [% PROCESS _header.tt %]
+[% PROCESS _sounds.tt %]
 
     <table border="0" width="100%" cellspacing="0" cellpadding="0" id="top_pane"[% IF hidetop == 1 %]style="visibility:hidden; display:none;"[% END %]>
       <tr>