Merge pull request #1053 from brenns10/master

Add sound, sticky options to notify plugin

Author: jcb91

src/jupyter_contrib_nbextensions/nbextensions/notify/notify.js

@@ -8,9 +8,19 @@ Add this file to $(ipython locate)/nbextensions/
 
 */
 
-define(["require"], function (require) {
+define([
+  "jquery",
+  "base/js/namespace",
+  "require",
+], function ($, Jupyter, require) {
   "use strict";
 
+  var params = {
+    sticky: false,
+    play_sound: false
+  };
+  var audio_file = "./notify.mp3";
+
   var current_time = function() {
     return new Date().getTime() / 1000;
   };
@@ -54,7 +64,7 @@ define(["require"], function (require) {
 
   var add_permissions_button = function () {
     if ($("#permissions-button").length === 0) {
-      IPython.toolbar.add_buttons_group([
+      Jupyter.toolbar.add_buttons_group([
         {
           'label'   : 'Grant Notification Permissions',
           'icon'    : 'fa-check',
@@ -92,10 +102,35 @@ define(["require"], function (require) {
     }
   };
 
+  var play_notification_sound = function(opts) {
+    /**
+     * NB: the Web Notification API specifies a mechanism for playing sound
+     * with notifications. As of 2017-08-22, it is unsupported in all browsers.
+     * This is a workaround. It should be updated to an implementation like
+     * this when browser support is available:
+     *
+     *   opts["sound"] = require.toUrl(audio_file);
+     */
+    try {
+      var audio = new Audio(require.toUrl(audio_file));
+      audio.play();
+    } catch(e) {
+      console.log('HTML5 Audio not supported in browser.');
+    }
+  };
+
   var notify = function () {
     var elapsed_time = current_time() - start_time;
     if (enabled && !first_start && !busy_kernel && elapsed_time >= min_time) {
-      var n = new Notification(IPython.notebook.notebook_name, {body: "Kernel is now idle\n(ran for " + Math.round(elapsed_time) + " secs)"});
+      var opts = {
+        body: "Kernel is now idle\n(ran for " + Math.round(elapsed_time) + " secs)",
+        icon: Jupyter.notebook.base_url + "static/base/images/favicon.ico",
+        requireInteraction: params.sticky
+      };
+      if (params.play_sound) {
+        play_notification_sound(opts);
+      }
+      var n = new Notification(Jupyter.notebook.notebook_name, opts);
       n.onclick = function(event){ window.focus(); }
     }
     if (first_start) {
@@ -104,24 +139,24 @@ define(["require"], function (require) {
   };
 
   var load_state = function () {
-    if (!IPython.notebook) return;
+    if (!Jupyter.notebook) return;
 
-    if ("notify_time" in IPython.notebook.metadata) {
-      min_time = IPython.notebook.metadata.notify_time;
+    if ("notify_time" in Jupyter.notebook.metadata) {
+      min_time = Jupyter.notebook.metadata.notify_time;
       enabled = true;
     }
   };
 
   var save_state = function () {
     if (enabled) {
-      if (IPython.notebook.metadata.notify_time !== min_time) {
-        IPython.notebook.metadata.notify_time = min_time;
-        IPython.notebook.set_dirty();
+      if (Jupyter.notebook.metadata.notify_time !== min_time) {
+        Jupyter.notebook.metadata.notify_time = min_time;
+        Jupyter.notebook.set_dirty();
       }
     } else {
-      if (IPython.notebook.metadata.hasOwnProperty('notify_time')) {
-        delete IPython.notebook.metadata.notify_time;
-        IPython.notebook.set_dirty();
+      if (Jupyter.notebook.metadata.hasOwnProperty('notify_time')) {
+        delete Jupyter.notebook.metadata.notify_time;
+        Jupyter.notebook.set_dirty();
       }
     }
   };
@@ -139,24 +174,27 @@ define(["require"], function (require) {
   };
 
   var setup_notifier = function () {
-    $([IPython.events]).on('kernel_starting.Kernel',function () {
+    $([Jupyter.events]).on('kernel_starting.Kernel',function () {
       first_start = true;  // reset first_start status when restarting the kernel
     });
 
-    $([IPython.events]).on('kernel_busy.Kernel',function () {
+    $([Jupyter.events]).on('kernel_busy.Kernel',function () {
       busy_kernel = true;
       start_time = current_time();  // reset the timer
     });
 
-    $([IPython.events]).on('kernel_idle.Kernel',function () {
+    $([Jupyter.events]).on('kernel_idle.Kernel',function () {
       busy_kernel = false;  // Used to make sure that kernel doesn't go busy again within the timeout set below.
       setTimeout(notify, 500);
     });
   };
 
   var load_ipython_extension = function () {
-    ensure_permission();
-    setup_notifier();
+    return Jupyter.notebook.config.loaded.then(function() {
+      $.extend(true, params, Jupyter.notebook.config.data.notify);
+      ensure_permission();
+      setup_notifier();
+    });
   };
 
   return {

src/jupyter_contrib_nbextensions/nbextensions/notify/notify.mp3

@@ -7,3 +7,12 @@ Link: readme.md
 Icon: notification.png
 Main: notify.js
 Compatibility: 4.x, 5.x
+Parameters:
+- name: notify.sticky
+  description: Require interactions on notifications to dismiss them. (Chrome only)
+  input_type: checkbox
+  default: false
+- name: notify.play_sound
+  description: Play notification sound.
+  input_type: checkbox
+  default: false

src/jupyter_contrib_nbextensions/nbextensions/notify/notify.yaml

@@ -16,12 +16,24 @@ trigger a notification (e.g. if selecting 5, a notification will only be shown
 if the kernel was busy for more than 5 seconds). The selection is saved in the
 notebook's metadata and restored when the notebook is re-opened.
 
+You may configure the plugin so that notifications require manual dismissal
+before disappearing. Browser support is limited, see
+[here](https://developer.mozilla.org/en-US/docs/Web/API/notification/requireInteraction)
+to check if your browser supports this. You may also configure the plugin so
+that notifications play a sound.
+
 ![notification](notification.png "notification")
 
 
 ## Original Source
 This extension originally comes from [@sjpfenniger](https://github.com/sjpfenninger)'s [GitHub repository](https://github.com/sjpfenninger/ipython-extensions).
 
+## Credits
+
+This extension contains sounds created by RSilveira_88 on fresound.org, licensed
+under the CC-BY 3.0 License. Modifications by morrisjim. You may find the
+modified version [here](http://freesound.org/people/morrisjm/sounds/268756/) and
+the original [here](http://freesound.org/people/RSilveira_88/sounds/216306/).
 
 ## License
 
@@ -33,4 +45,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.