@internetarchive/bookreader 5.0.0-70-a3 → 5.0.0-72

package/src/BookReader.js

@@ -1788,7 +1788,7 @@ BookReader.prototype.paramsFromFragment = function(fragment) {
   // Index and page
   if ('undefined' != typeof(urlHash['page'])) {
     // page was set -- may not be int
-    params.page = urlHash['page'];
+    params.page = decodeURIComponent(urlHash['page']);
   }
 
   // $$$ process /region
@@ -1820,11 +1820,10 @@ BookReader.prototype.paramsFromFragment = function(fragment) {
  * @return {string}
  */
 BookReader.prototype.fragmentFromParams = function(params, urlMode = 'hash') {
-  const separator = '/';
   const fragments = [];
 
   if ('undefined' != typeof(params.page)) {
-    fragments.push('page', params.page);
+    fragments.push('page', encodeURIComponent(params.page));
   } else {
     if ('undefined' != typeof(params.index)) {
       // Don't have page numbering but we do have the index
@@ -1850,10 +1849,10 @@ BookReader.prototype.fragmentFromParams = function(params, urlMode = 'hash') {
 
   // search
   if (params.search && urlMode === 'hash') {
-    fragments.push('search', params.search);
+    fragments.push('search', utils.encodeURIComponentPlus(params.search));
   }
 
-  return utils.encodeURIComponentPlus(fragments.join(separator)).replace(/%2F/g, '/');
+  return fragments.join('/');
 };
 
 /**

package/src/plugins/tts/AbstractTTSEngine.js

@@ -1,4 +1,5 @@
 import PageChunkIterator from './PageChunkIterator.js';
+import { hasLocalStorage } from './utils.js';
 /** @typedef {import('./utils.js').ISO6391} ISO6391 */
 /** @typedef {import('./PageChunk.js')} PageChunk */
 
@@ -80,6 +81,7 @@ export default class AbstractTTSEngine {
    */
   start(leafIndex, numLeafs) {
     this.playing = true;
+    this.paused = false;
     this.opts.onLoadingStart();
 
     this._chunkIterator = new PageChunkIterator(numLeafs, leafIndex, {
@@ -95,6 +97,7 @@ export default class AbstractTTSEngine {
   stop() {
     if (this.activeSound) this.activeSound.stop();
     this.playing = false;
+    this.paused = true;
     this._chunkIterator = null;
     this.activeSound = null;
     this.events.trigger('stop');
@@ -142,6 +145,10 @@ export default class AbstractTTSEngine {
     // MS Edge fires voices changed randomly very often
     this.events.off('voiceschanged', this.updateBestVoice);
     this.voice = this.getVoices().find(voice => voice.voiceURI === voiceURI);
+    // if the current book has a language set, store the selected voice with the book language as a suffix
+    if (this.opts.bookLanguage && hasLocalStorage()) {
+      localStorage.setItem(`BRtts-voice-${this.opts.bookLanguage}`, this.voice.voiceURI);
+    }
     if (this.activeSound) this.activeSound.setVoice(this.voice);
   }
 
@@ -221,10 +228,12 @@ export default class AbstractTTSEngine {
     // user languages that match the book language
     const matchingUserLangs = userLanguages.filter(lang => lang.startsWith(bookLanguage));
 
-    // Try to find voices that intersect these two sets
-    return AbstractTTSEngine.getMatchingVoice(matchingUserLangs, bookLangVoices) ||
+    // First try to find the last chosen voice from localStorage for the current book language
+    return AbstractTTSEngine.getMatchingStoredVoice(bookLangVoices, bookLanguage)
+        // Try to find voices that intersect these two sets
+        || AbstractTTSEngine.getMatchingVoice(matchingUserLangs, bookLangVoices)
         // no user languages match the books; let's return the best voice for the book language
-        (bookLangVoices.find(v => v.default) || bookLangVoices[0])
+        || (bookLangVoices.find(v => v.default) || bookLangVoices[0])
         // No voices match the book language? let's find a voice in the user's language
         // and ignore book lang
         || AbstractTTSEngine.getMatchingVoice(userLanguages, voices)
@@ -232,6 +241,19 @@ export default class AbstractTTSEngine {
         || (voices.find(v => v.default) || voices[0]);
   }
 
+  /**
+   * @private
+   * Get the voice last selected by the user for the book language from localStorage.
+   * Returns undefined if no voice is stored or found.
+   * @param {SpeechSynthesisVoice[]} voices  browser voices to choose from
+   * @param {ISO6391} bookLanguage  book language to look for
+   * @return {SpeechSynthesisVoice | undefined}
+   */
+  static getMatchingStoredVoice(voices, bookLanguage) {
+    const storedVoice = hasLocalStorage() && localStorage.getItem(`BRtts-voice-${bookLanguage}`);
+    return (storedVoice ? voices.find(v => v.voiceURI === storedVoice) : undefined);
+  }
+
   /**
      * @private
      * Get the best voice that matches one of the BCP47 languages (order by preference)

package/src/plugins/tts/plugin.tts.js

@@ -251,7 +251,7 @@ BookReader.prototype.ttsPlayPause = function() {
     this.ttsToggle();
   } else {
     this.ttsEngine.togglePlayPause();
-    this.ttsUpdateState(this.ttsEngine.paused);
+    this.ttsUpdateState();
   }
 };
 

package/src/plugins/tts/utils.js

@@ -64,3 +64,18 @@ function searchForISO6391(language, columnsToSearch) {
   }
   return null;
 }
+
+/**
+ * Checks whether the current browser supports localStorage or
+ * if the current context has access to it.
+ * @return {boolean}
+ */
+export function hasLocalStorage() {
+  try {
+    return !!window.localStorage;
+  } catch (e) {
+    // Will throw in sandboxed iframe
+    // DOMException: Window.localStorage getter: Forbidden in a sandboxed document without the 'allow-same-origin' flag.
+    return false;
+  }
+}

package/src/plugins/url/UrlPlugin.js

@@ -45,7 +45,7 @@ export class UrlPlugin {
 
     const strPathParams = this.urlSchema
       .filter(s => s.position == 'path')
-      .map(schema => pathParams[schema.name] ? `${schema.name}/${pathParams[schema.name]}` : '')
+      .map(schema => pathParams[schema.name] ? `${schema.name}/${encodeURIComponent(pathParams[schema.name])}` : '')
       .join('/');
 
     // replace consecutive slashes with a single slash + remove trailing slashes
@@ -83,15 +83,13 @@ export class UrlPlugin {
         const hasPropertyKey = doesKeyExists(urlStrSplitSlashObj, schema.name);
         const hasDeprecatedKey = doesKeyExists(schema, 'deprecated_for') && hasPropertyKey;
 
-        if (hasDeprecatedKey) {
-          urlState[schema.deprecated_for] = urlStrSplitSlashObj[schema.name];
+        // Not in the URL
+        if (!hasPropertyKey && !hasDeprecatedKey) {
           return;
         }
 
-        if (hasPropertyKey) {
-          urlState[schema.name] = urlStrSplitSlashObj[schema.name];
-          return;
-        }
+        const urlStateParam = hasDeprecatedKey ? schema.deprecated_for : schema.name;
+        urlState[urlStateParam] = decodeURIComponent(urlStrSplitSlashObj[schema.name]);
       });
 
     // Add searchParams to urlState

package/tests/jest/BookReader/utils/SelectionObserver.test.js

@@ -40,4 +40,18 @@ describe("SelectionObserver", () => {
     observer._onSelectionChange();
     expect(handler.callCount).toBe(2);
   });
+
+  test('Only fires when selection started in selector', () => {
+    const handler = sinon.spy();
+    const observer = new SelectionObserver(".text-layer", handler);
+    const target = document.createElement("div");
+    target.classList.add("text-layer");
+
+    // stub window.getSelection
+    const getSelectionStub = sinon.stub(window, "getSelection");
+    getSelectionStub.returns({ toString: () => "test", anchorNode: document.body });
+    observer._onSelectionChange();
+    expect(handler.callCount).toBe(0);
+    expect(observer.selecting).toBe(false);
+  });
 });

package/tests/jest/plugins/tts/AbstractTTSEngine.test.js

@@ -111,6 +111,26 @@ for (const dummyVoice of [dummyVoiceHyphens, dummyVoiceUnderscores]) {
 
       expect(getBestBookVoice(voices, 'en', ['en-CA', 'en'])).toBe(voices[0]);
     });
+
+    test('choose stored language from localStorage', () => {
+      const voices = [
+        dummyVoice({lang: "en-US", voiceURI: "English US", default: true}),
+        dummyVoice({lang: "en-GB", voiceURI: "English GB"}),
+        dummyVoice({lang: "en-CA", voiceURI: "English CA"}),
+      ];
+      class DummyEngine extends AbstractTTSEngine {
+        getVoices() { return voices; }
+      }
+      const ttsEngine = new DummyEngine({...DUMMY_TTS_ENGINE_OPTS, bookLanguage: 'en'});
+      // simulates setting default voice on tts startup
+      ttsEngine.updateBestVoice();
+      // simulates user choosing a voice that matches the bookLanguage
+      // voice will be stored in localStorage
+      ttsEngine.setVoice(voices[2].voiceURI);
+
+      // expecting the voice to be selected by getMatchingStoredVoice and returned as best voice
+      expect(getBestBookVoice(voices, 'en', [])).toBe(voices[2]);
+    });
   });
 }
 

package/tests/jest/plugins/url/UrlPlugin.test.js

@@ -19,6 +19,10 @@ describe('UrlPlugin tests', () => {
       expect(urlPlugin.urlStateToUrlString(urlStateWithQueries)).toBe(expectedUrlFromStateWithQueries);
     });
 
+    test('encodes page number', () => {
+      expect(urlPlugin.urlStateToUrlString({ page: '12/46' })).toBe(`page/12%2F46`);
+    });
+
     test('urlStateToUrlString with unknown states in schema', () => {
       const urlState = { page: 'n7', mode: '1up' };
       const urlStateWithQueries = { page: 'n7', mode: '1up', q: 'hello', viewer: 'theater', sortBy: 'title_asc' };
@@ -47,6 +51,10 @@ describe('UrlPlugin tests', () => {
       expect(urlPlugin.urlStringToUrlState(url1)).toEqual({page: 'n7', mode: '1up'});
     });
 
+    test('decodes page number', () => {
+      expect(urlPlugin.urlStringToUrlState('/page/12%2F46')).toStrictEqual({ page: '12/46' });
+    });
+
     test('urlStringToUrlState with deprecated_for', () => {
       const url = '/page/n7/mode/2up/search/hello';