voxforge_sw.js

/*
Copyright 2018 VoxForge

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
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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, see <http://www.gnu.org/licenses/>.
*/
// SavedSubmissions is called from service worker (voxforge_sw.js) 
// from a absolute root (as opposed to relative path) therefore localforage 
// import must be done in calling script
importScripts('assets/static/lib/localforage.js'); // localforage needs to be defined before call to SavedSubmissions

importScripts('assets/static/scripts/common/Submission.js'); 
importScripts('assets/static/scripts/common/SavedSubmissions.js');

var CACHE_NAME = 'voxforge-cache-v0.1';
var PATH = '/assets/static/';

var urlsToCache = [
  PATH + 'lib/jquery.mobile-1.4.5.js',
  PATH + 'lib/jquery-1.12.4.js',
  PATH + 'lib/jszip.js',
  PATH + 'lib/languages.js',
  PATH + 'lib/localforage.js',
  PATH + 'lib/platform.js',
  PATH + 'lib/state-machine.js',
  PATH + 'lib/visualize.js',
  PATH + 'lib/wavesurfer.js',
  PATH + 'lib/webrtc_vad.js',

  PATH + 'scripts/main.js',

  PATH + 'scripts/Audio.js',
  PATH + 'scripts/audio/Debug.js',  
  PATH + 'scripts/audio/AudioWorker.js',
  PATH + 'scripts/audio/Vad.js',  
  PATH + 'scripts/audio/wavEncoder.js',  

  PATH + 'scripts/common/SavedSubmissions.js',   
  PATH + 'scripts/common/Submission.js',

  PATH + 'scripts/Controller.js',
  PATH + 'scripts/controller/location.js',
  
  PATH + 'scripts/Debug.js',
  PATH + 'scripts/Parms.js',
  PATH + 'scripts/Profile.js',
  
  PATH + 'scripts/Prompts.js',
  PATH + 'scripts/prompts/File.js',
    
  PATH + 'scripts/Uploader.js',
  PATH + 'scripts/uploader/UploadMessage.js',
  PATH + 'scripts/uploader/UploadWorker.js',
  PATH + 'scripts/uploader/ZipWorker.js',
  
  PATH + 'scripts/View.js',
  PATH + 'scripts/view/AudioPlayer.js',
  PATH + 'scripts/view/buttons.js',  
  PATH + 'scripts/view/DisplayDefaults.js',
  PATH + 'scripts/view/ProfileView.js',  
  PATH + 'scripts/view/PromptSettings.js',
  PATH + 'scripts/view/Settings.js',
  PATH + 'scripts/view/SubmissionsLog.js',        

  PATH + 'styles/app.css',
  PATH + 'styles/jquery.mobile-1.4.5.css',

  '/favicon.ico',
  '/voxforge_sw.js',
  '/en/manifest.json',
  '/fr/manifest.json',
  '/de/manifest.json',
  
  // need one entry for each language, otherwise will not be able to switch
  // language while offline
  // no .html suffix required, but if make updates, need to wait for changes
  // to propagate in githubPages, because they cache on their server too...
  // if change /en/read, make sure to change manifest file
  '/en/read',
  '/fr/read',
  '/es/read',
  '/de/read',

  // !!!!!! TODO required for offline testing of app; but other languages dont need it... 
  //'/en/read/', // dev - debug with Apache2 and self signed SSL certificate
  // !!!!!
  
  // TODO also cache links to outside websites for definitions, elaboration, etc...

  // cache at least one prompt file for each language
  '/en/prompts/001.html',
  '/fr/prompts/001.html',
  '/es/prompts/001.html',
  '/de/prompts/001.html',
  
  // cache language specific front pages so can switch languages
  // Note: caching only occurs after user goes to read page....
  '/',
  '/fr',
  '/es',
  '/de',
  
  // supporting files so that language specific home pages work
  '/css/main.css',
  '/images/voxforge-logo-2.png',
  '/images/search.jpg',
  '/images/faq-icon.jpg',
  '/images/Gear_icon-72a7cf.png',
];

//var uploadURL;
self.addEventListener('install', function(event) {
  //event.waitUntil(self.skipWaiting()); // Activate worker immediately

  // Perform install steps
  event.waitUntil(
      caches.open(CACHE_NAME)
      .then(function(cache) {
        console.log('adding files to service worker cache');
        return cache.addAll(urlsToCache);
      })
  );
});

/**
* to cache new requests cumulatively, handle the
* response of the fetch request and then adde it to the cache:
*
// TODO don't need to cache requests that are not listed above...should this be removed?
*/
self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
    .then(function(response) {
        // Cache hit - return response
        if (response) {
          return response;
        }
        return fetch(event.request);
      }
    )
  );
});

self.addEventListener('sync', function(event) {
    if (event.tag == 'voxforgeSync') {
      console.log('voxforgeSync: background sync request received by serviceworker');

      let uploadURL = new URL(location).searchParams.get('uploadURL');
      
      var savedSubmissions = new SavedSubmissions(uploadURL, "serviceworker");
      event.waitUntil(
          savedSubmissions.process()
          .then(function(returnObj) {
              sendMessage(returnObj);
          })
          .catch(function(returnObj) {
              sendMessage(returnObj);
          })
      ); 
  }
});

/**
* 
*/
function sendMessage(returnObj) {
  self.clients.matchAll({includeUncontrolled: true, type: 'window'})
  .then(function(clientList) {
    clientList.forEach(function(client) {
      client.postMessage(returnObj);
    });
  });
}

/*
 * For offline testing and testing separate front and backend servers
 * with self signed certificates:
 * 
 * A. _config.yml
 * 1. change url
 *   prod: #url: "https://voxforge.github.io" # prod - the base hostname & protocol for your site
 *   dev: url: "https://jekyll_voxforge.org" # dev 
 * 
 * you will need to use:
 * 
 *       https://jekyll_voxforge.org/en/read/
 *
 * to directly access read page
 * 
 * 2. add trailing slash to permalinks
 *    #permalink: /:lang/:ref # prod - required for links to work properly on Github
 *    permalink: /:lang/:ref/ # dev - (need to also update voxforge_sw.js and _config.yml: URL; and copy manifest file to en/read and restart jekyll...)
 *
 * (for debugging with Apache2 and self signed SSL certificate)
# note: messes up manifest path, expects manifest.json at https://jekyll_voxforge.org/en/read/manifest.json
# when it should be https://jekyll_voxforge.org/en/manifest.json

# Note: In Jekyll 2, any URL constructed from the permalink: field had a 
# trailing slash (/) added to it automatically. Jekyll 3 no longer adds a
# trailing slash automatically to permalink: URLs
# see: https://jekyllrb.com/docs/upgrading/2-to-3/

 * B. manifest
 * 3. i) temporarily move manifest to dev expected path:
 * app expects manifest.json at:
 *       https://jekyll_voxforge.org/en/read/manifest.json
 * when it should be at (on github)
 *       https://jekyll_voxforge.org/en/manifest.json
 *
 * ii) en/read/manifest.json:
 *  "start_url": "/en/read", # github
 *  "start_url": "/en/read/", # dev 
 * 
 * C. voxforge_sw.js
 * add entry for trailing slash on read me
 *
 *  // !!!!!! Oct 10 - no longer required with local apache server???
 *  // required for offline testing of app on local server
  '/en/read/', // TODO debug with Apache2 and self signed SSL certificate
  // !!!!!
 *
 * D. Fix permissions on submissions folder
 * ~/git/voxforge.github.io/_site/submissions
 * apache user (e.g. www-data ) needs write permissions to submissions folder
 *
 * or change user in /etc/apache2/envvars:
 * # !!!!!!
    #export APACHE_RUN_USER=www-data
    #export APACHE_RUN_GROUP=www-data
    export APACHE_RUN_USER=daddy
    export APACHE_RUN_GROUP=daddy
    # !!!!!!
 * 
 */