From 8f35ee81b6f626be5b16c330fa47a85e4d720209 Mon Sep 17 00:00:00 2001
From: alec <alec@208e9e7b-5314-0410-a742-e7e81cd9613c>
Date: Thu, 19 May 2011 09:54:09 +0000
Subject: - Removed focus_on_new_message option, added newmail_notify plugin

git-svn-id: https://svn.roundcube.net/trunk@4788 208e9e7b-5314-0410-a742-e7e81cd9613c
---
 plugins/newmail_notifier/config.inc.php.dist    |   9 ++
 plugins/newmail_notifier/favicon.ico            | Bin 0 -> 1734 bytes
 plugins/newmail_notifier/localization/en_US.inc |   6 +
 plugins/newmail_notifier/localization/pl_PL.inc |   6 +
 plugins/newmail_notifier/newmail_notifier.js    |  64 +++++++++++
 plugins/newmail_notifier/newmail_notifier.php   | 145 ++++++++++++++++++++++++
 plugins/newmail_notifier/sound.wav              | Bin 0 -> 10444 bytes
 7 files changed, 230 insertions(+)
 create mode 100644 plugins/newmail_notifier/config.inc.php.dist
 create mode 100644 plugins/newmail_notifier/favicon.ico
 create mode 100644 plugins/newmail_notifier/localization/en_US.inc
 create mode 100644 plugins/newmail_notifier/localization/pl_PL.inc
 create mode 100644 plugins/newmail_notifier/newmail_notifier.js
 create mode 100644 plugins/newmail_notifier/newmail_notifier.php
 create mode 100644 plugins/newmail_notifier/sound.wav

(limited to 'plugins')

diff --git a/plugins/newmail_notifier/config.inc.php.dist b/plugins/newmail_notifier/config.inc.php.dist
new file mode 100644
index 000000000..21b3d96c2
--- /dev/null
+++ b/plugins/newmail_notifier/config.inc.php.dist
@@ -0,0 +1,9 @@
+<?php
+
+// Enables basic notification
+$rcmail_config['newmail_notifier_basic'] = false;
+
+// Enables sound notification
+$rcmail_config['newmail_notifier_sound'] = false;
+
+?>
diff --git a/plugins/newmail_notifier/favicon.ico b/plugins/newmail_notifier/favicon.ico
new file mode 100644
index 000000000..86e10c1c7
Binary files /dev/null and b/plugins/newmail_notifier/favicon.ico differ
diff --git a/plugins/newmail_notifier/localization/en_US.inc b/plugins/newmail_notifier/localization/en_US.inc
new file mode 100644
index 000000000..fbb5d9aae
--- /dev/null
+++ b/plugins/newmail_notifier/localization/en_US.inc
@@ -0,0 +1,6 @@
+<?php
+
+$labels['basic'] = 'Display notifications on new message';
+$labels['sound'] = 'Play the sound on new message';
+
+?>
diff --git a/plugins/newmail_notifier/localization/pl_PL.inc b/plugins/newmail_notifier/localization/pl_PL.inc
new file mode 100644
index 000000000..5fe37903b
--- /dev/null
+++ b/plugins/newmail_notifier/localization/pl_PL.inc
@@ -0,0 +1,6 @@
+<?php
+
+$labels['basic'] = 'Wyświetlaj powiadomienia o nadejściu nowej wiadomości';
+$labels['sound'] = 'Odtwarzaj dźwięk o nadejściu nowej wiadomości';
+
+?>
diff --git a/plugins/newmail_notifier/newmail_notifier.js b/plugins/newmail_notifier/newmail_notifier.js
new file mode 100644
index 000000000..6e1ae9fbb
--- /dev/null
+++ b/plugins/newmail_notifier/newmail_notifier.js
@@ -0,0 +1,64 @@
+/**
+ * New Mail Notifier plugin script
+ *
+ * @version 0.1
+ * @author Aleksander Machniak <alec@alec.pl>
+ */
+
+if (window.rcmail && rcmail.env.task == 'mail') {
+    rcmail.addEventListener('plugin.newmail_notifier', newmail_notifier_run);
+    rcmail.addEventListener('actionbefore', newmail_notifier_stop);
+    rcmail.addEventListener('init', function() {
+        // bind to messages list select event, so favicon will be reverted on message preview too
+        if (rcmail.message_list)
+            rcmail.message_list.addEventListener('select', newmail_notifier_stop);
+    });
+}
+
+// Executes notification methods
+function newmail_notifier_run(prop)
+{
+    if (prop.basic)
+        newmail_notifier_basic();
+    if (prop.sound)
+        newmail_notifier_sound();
+}
+
+// Stops notification
+function newmail_notifier_stop(prop)
+{
+    // revert original favicon
+    if (rcmail.env.favicon_href && (!prop || prop.action != 'check-recent')) {
+        $('<link rel="shortcut icon" href="'+rcmail.env.favicon_href+'"/>').replaceAll('link[rel="shortcut icon"]');
+        rcmail.env.favicon_href = null;
+    }
+}
+
+// Basic notification: window.focus and favicon change
+function newmail_notifier_basic()
+{
+    window.focus();
+
+    // we cannot simply change a href attribute, we must to replace the link element (at least in FF)
+    var link = $('<link rel="shortcut icon" href="plugins/newmail_notifier/favicon.ico"/>'),
+        oldlink = $('link[rel="shortcut icon"]');
+
+    rcmail.env.favicon_href = oldlink.attr('href');
+    link.replaceAll(oldlink);
+}
+
+// Sound notification
+function newmail_notifier_sound()
+{
+    // HTML5
+    try {
+        var elem = $('<audio src="success.wav" />');
+        elem.get(0).play();
+    }
+    // old method
+    catch (e) {
+        var elem = $('<embed id="sound" src="success.wav" hidden=true autostart=true loop=false />');
+        elem.appendTo($('body'));
+        window.setTimeout("$('#sound').remove()", 5000);
+    }
+}
diff --git a/plugins/newmail_notifier/newmail_notifier.php b/plugins/newmail_notifier/newmail_notifier.php
new file mode 100644
index 000000000..28542f0a4
--- /dev/null
+++ b/plugins/newmail_notifier/newmail_notifier.php
@@ -0,0 +1,145 @@
+<?php
+
+/**
+ * New Mail Notifier plugin
+ *
+ * Supports two methods of notification:
+ * 1. Basic - focus browser window and change favicon
+ * 2. Sound - play wav file
+ *
+ * @version 0.1
+ * @author Aleksander Machniak <alec@alec.pl>
+ *
+ *
+ * Copyright (C) 2011, Kolab Systems AG
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+class newmail_notifier extends rcube_plugin
+{
+    public $task = 'mail|settings';
+
+    private $rc;
+
+    /**
+     * Plugin initialization
+     */
+    function init()
+    {
+        $this->rc = rcmail::get_instance();
+
+        // Preferences hooks
+        if ($this->rc->task == 'settings') {
+            $this->add_hook('preferences_list', array($this, 'prefs_list'));
+            $this->add_hook('preferences_save', array($this, 'prefs_save'));
+        }
+        else { // if ($this->rc->task == 'mail') {
+            $this->add_hook('new_messages', array($this, 'notify'));
+            // add script when not in ajax and not in frame
+            if (is_a($this->rc->output, 'rcube_template') && empty($_REQUEST['_framed'])) {
+                $this->include_script('newmail_notifier.js');
+            }
+        }
+    }
+
+    /**
+     * Handler for user preferences form (preferences_list hook)
+     */
+    function prefs_list($args)
+    {
+        // Load configuration
+        $this->load_config();
+
+        // Check that configuration is not disabled
+        $dont_override  = (array) $this->rc->config->get('dont_override', array());
+        $basic_override = in_array('newmail_notifier_basic', $dont_override);
+        $sound_override = in_array('newmail_notifier_sound', $dont_override);
+
+        if($args['section'] != 'mailbox') {
+            return $args;
+        }
+
+        // Load localization and configuration
+        $this->add_texts('localization/');
+
+        if (!$basic_override) {
+            $field_id = '_newmail_notifier_basic';
+            $input    = new html_checkbox(array('name' => $field_id, 'id' => $field_id, 'value' => 1));
+            $args['blocks']['new_message']['options']['newmail_notifier_basic'] = array(
+                'title' => html::label($field_id, Q($this->gettext('basic'))),
+                'content' => $input->show($this->rc->config->get('newmail_notifier_basic')),
+            );
+        }
+
+        if (!$sound_override) {
+            $field_id = '_newmail_notifier_sound';
+            $input    = new html_checkbox(array('name' => $field_id, 'id' => $field_id, 'value' => 1));
+            $args['blocks']['new_message']['options']['newmail_notifier_sound'] = array(
+                'title' => html::label($field_id, Q($this->gettext('sound'))),
+                'content' => $input->show($this->rc->config->get('newmail_notifier_sound')),
+            );
+        }
+
+        return $args;
+    }
+
+    /**
+     * Handler for user preferences save (preferences_save hook)
+     */
+    function prefs_save($args)
+    {
+        // Load configuration
+        $this->load_config();
+
+        // Check that configuration is not disabled
+        $dont_override  = (array) $this->rc->config->get('dont_override', array());
+        $basic_override = in_array('newmail_notifier_basic', $dont_override);
+        $sound_override = in_array('newmail_notifier_sound', $dont_override);
+
+        if($args['section'] != 'mailbox') {
+            return $args;
+        }
+
+        if (!$basic_override) {
+            $key = 'newmail_notifier_basic';
+            $args['prefs'][$key] = get_input_value('_'.$key, RCUBE_INPUT_POST) ? true : false;
+        }
+        if (!$sound_override) {
+            $key = 'newmail_notifier_sound';
+            $args['prefs'][$key] = get_input_value('_'.$key, RCUBE_INPUT_POST) ? true : false;
+        }
+
+        return $args;
+    }
+
+    /**
+     * Handler for new message action (new_messages hook)
+     */
+    function notify($args)
+    {
+        // Load configuration
+        $this->load_config();
+
+        $basic = $this->rc->config->get('newmail_notifier_basic');
+        $sound = $this->rc->config->get('newmail_notifier_sound');
+
+        if ($basic || $sound) {
+            $this->rc->output->command('plugin.newmail_notifier',
+                array('basic' => $basic, 'sound' => $sound));
+        }
+
+        return $args;
+    }
+}
diff --git a/plugins/newmail_notifier/sound.wav b/plugins/newmail_notifier/sound.wav
new file mode 100644
index 000000000..72d3dd857
Binary files /dev/null and b/plugins/newmail_notifier/sound.wav differ
-- 
cgit v1.2.3