From 1aa5817131d0562b898f537d21feb9c7fe2da133 Mon Sep 17 00:00:00 2001 From: Aleksander Machniak Date: Wed, 16 Mar 2016 13:12:06 +0100 Subject: [PATCH] Refactor desktop notifications - Remove webkitNotifications support, clean up the code - Unify look and behaviour of notifications in Mail and in Settings --- CHANGELOG | 1 + plugins/newmail_notifier/composer.json | 4 +- plugins/newmail_notifier/newmail_notifier.js | 88 +++++-------------- plugins/newmail_notifier/newmail_notifier.php | 10 +-- 4 files changed, 31 insertions(+), 72 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 1af37e743..95c79ffb9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -26,6 +26,7 @@ CHANGELOG Roundcube Webmail - Hide DSN option in Preferences when smtp_server is not used (#1490666) - Fix handling of body parameter in mail compose request - Protect download urls against CSRF using unique request tokens (#1490642) +- newmail_notifier: Refactor desktop notifications RELEASE 1.2-beta ---------------- diff --git a/plugins/newmail_notifier/composer.json b/plugins/newmail_notifier/composer.json index 1bca39c1f..17ae4e97b 100644 --- a/plugins/newmail_notifier/composer.json +++ b/plugins/newmail_notifier/composer.json @@ -1,9 +1,9 @@ { "name": "roundcube/newmail_notifier", "type": "roundcube-plugin", - "description": "Supports three methods of notification: 1. Basic - focus browser window and change favicon 2. Sound - play wav file 3. Desktop - display desktop notification (using webkitNotifications feature, supported by Chrome and Firefox with 'HTML5 Notifications' plugin).", + "description": "Supports three methods of notification: 1. Basic - focus browser window and change favicon 2. Sound - play wav file 3. Desktop - display desktop notification (using HTML5 Notification API feature).", "license": "GPLv3+", - "version": "0.7", + "version": "0.8", "authors": [ { "name": "Aleksander Machniak", diff --git a/plugins/newmail_notifier/newmail_notifier.js b/plugins/newmail_notifier/newmail_notifier.js index 4b71c222c..5e95284cc 100644 --- a/plugins/newmail_notifier/newmail_notifier.js +++ b/plugins/newmail_notifier/newmail_notifier.js @@ -6,7 +6,7 @@ * @licstart The following is the entire license notice for the * JavaScript code in this file. * - * Copyright (c) 2013, The Roundcube Dev Team + * Copyright (c) 2013-2016, The Roundcube Dev Team * * The JavaScript code in this page is free software: you can redistribute it * and/or modify it under the terms of the GNU General Public License @@ -106,77 +106,46 @@ function newmail_notifier_sound() } // Desktop notification -// - Require Chrome or Firefox latest version (22+) / 21.0 or older with a plugin -function newmail_notifier_desktop(body) +// - Require window.Notification API support (Chrome 22+ or Firefox 22+) +function newmail_notifier_desktop(body, disabled_callback) { var timeout = rcmail.env.newmail_notifier_timeout || 10, - icon = rcmail.assets_path('plugins/newmail_notifier/mail.png'); - - - // As of 17 June 2013, Chrome/Chromium does not implement Notification.permission correctly that - // it gives 'undefined' until an object has been created: - // https://code.google.com/p/chromium/issues/detail?id=163226 - try { - if (Notification.permission == 'granted' || Notification.permission == undefined) { - var popup = new Notification(rcmail.get_label('title', 'newmail_notifier'), { + icon = rcmail.assets_path('plugins/newmail_notifier/mail.png'), + success_callback = function() { + var popup = new window.Notification(rcmail.get_label('title', 'newmail_notifier'), { dir: "auto", lang: "", body: body, tag: "newmail_notifier", icon: icon }); - popup.onclick = function() { - this.close(); - } + popup.onclick = function() { this.close(); }; setTimeout(function() { popup.close(); }, timeout * 1000); - if (popup.permission == 'granted') return true; - } + }; + + try { + window.Notification.requestPermission(function(perm) { + if (perm == 'granted') + success_callback(); + else if (perm == 'denied' && disabled_callback) + disabled_callback(); + }); + + return true; } catch (e) { - var dn = window.webkitNotifications; - - if (dn && !dn.checkPermission()) { - if (rcmail.newmail_popup) - rcmail.newmail_popup.cancel(); - var popup = window.webkitNotifications.createNotification(icon, - rcmail.get_label('title', 'newmail_notifier'), body); - popup.onclick = function() { - this.cancel(); - } - popup.show(); - setTimeout(function() { popup.cancel(); }, timeout * 1000); - rcmail.newmail_popup = popup; - return true; - } + return false; } - return false; } function newmail_notifier_test_desktop() { - var txt = rcmail.get_label('testbody', 'newmail_notifier'); + var status = newmail_notifier_desktop(rcmail.get_label('testbody', 'newmail_notifier'), function() { + rcmail.display_message(rcmail.get_label('desktopdisabled', 'newmail_notifier'), 'error'); + }); - // W3C draft implementation (with fix for Chrome/Chromium) - try { - var testNotification = new window.Notification(txt, {tag: "newmail_notifier"}); // Try to show a test message - if (Notification.permission !== 'granted' || (testNotification.permission && testNotification.permission !== 'granted')) - newmail_notifier_desktop_authorize(); - } - // webkit implementation - catch (e) { - var dn = window.webkitNotifications; - if (dn) { - if (!dn.checkPermission()) - newmail_notifier_desktop(txt); - else - dn.requestPermission(function() { - if (!newmail_notifier_desktop(txt)) - rcmail.display_message(rcmail.get_label('desktopdisabled', 'newmail_notifier'), 'error'); - }); - } - else - // Everything fails, means the browser has no support - rcmail.display_message(rcmail.get_label('desktopunsupported', 'newmail_notifier'), 'error'); + if (!status) { + rcmail.display_message(rcmail.get_label('desktopunsupported', 'newmail_notifier'), 'error'); } } @@ -189,12 +158,3 @@ function newmail_notifier_test_sound() { newmail_notifier_sound(); } - -function newmail_notifier_desktop_authorize() { - Notification.requestPermission(function(perm) { - if (perm == 'denied') - rcmail.display_message(rcmail.get_label('desktopdisabled', 'newmail_notifier'), 'error'); - if (perm == 'granted') - newmail_notifier_test_desktop(); // Test again, which should show test message - }); -} diff --git a/plugins/newmail_notifier/newmail_notifier.php b/plugins/newmail_notifier/newmail_notifier.php index efac69116..ca7953329 100644 --- a/plugins/newmail_notifier/newmail_notifier.php +++ b/plugins/newmail_notifier/newmail_notifier.php @@ -4,16 +4,14 @@ * New Mail Notifier plugin * * Supports three methods of notification: - * 1. Basic - focus browser window and change favicon - * 2. Sound - play wav file - * 3. Desktop - display desktop notification (using webkitNotifications feature, - * supported by Chrome and Firefox with 'HTML5 Notifications' plugin) + * 1. Basic - focus browser window and change favicon + * 2. Sound - play wav file + * 3. Desktop - display desktop notification (using window.Notification API) * * @version @package_version@ * @author Aleksander Machniak * - * - * Copyright (C) 2011, Kolab Systems AG + * Copyright (C) 2011-2016, 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 as published by