@internetarchive/bookreader 5.0.0-54 → 5.0.0-56

package/src/BookReader.js

@@ -31,7 +31,7 @@ import PACKAGE_JSON from '../package.json';
 import * as utils from './BookReader/utils.js';
 import { exposeOverrideable } from './BookReader/utils/classes.js';
 import { Navbar } from './BookReader/Navbar/Navbar.js';
-import { DEFAULT_OPTIONS } from './BookReader/options.js';
+import { DEFAULT_OPTIONS, OptionsParseError } from './BookReader/options.js';
 /** @typedef {import('./BookReader/options.js').BookReaderOptions} BookReaderOptions */
 /** @typedef {import('./BookReader/options.js').ReductionFactor} ReductionFactor */
 /** @typedef {import('./BookReader/BookModel.js').PageIndex} PageIndex */
@@ -452,61 +452,56 @@ BookReader.prototype.readQueryString = function() {
  * Determines the initial mode for starting if a mode is not already
  * present in the params argument
  * @param {object} params
- * @return {number} the mode
+ * @return {1 | 2 | 3} the initial mode
  */
 BookReader.prototype.getInitialMode = function(params) {
-  let nextMode;
-
   // if mobile breakpoint, we always show this.constMode1up mode
-  const ifMobileBreakpoint = () => {
-    // Use params or browser width to set view mode
-    const windowWidth = $(window).width();
-    return windowWidth && windowWidth <= this.onePageMinBreakpoint;
-  };
-  if ('undefined' != typeof(params.mode)) {
-    nextMode = params.mode;
-  } else if ((this.ui == 'full' && this.isFullscreenActive) || ifMobileBreakpoint()) {
-    // In full mode OR device width, we set the default based on width
-    nextMode = this.constMode1up;
+  const windowWidth = $(window).width();
+  const isMobile = windowWidth && windowWidth <= this.onePageMinBreakpoint;
+
+  let initialMode;
+  if (params.mode) {
+    initialMode = params.mode;
+  } else if (isMobile) {
+    initialMode = this.constMode1up;
   } else {
-    nextMode = this.constMode2up;
+    initialMode = this.constMode2up;
   }
 
-  if (!this.canSwitchToMode(nextMode)) {
-    nextMode = this.constMode1up;
+  if (!this.canSwitchToMode(initialMode)) {
+    initialMode = this.constMode1up;
   }
 
   // override defaults mode via `options.defaults` metadata
   if (this.options.defaults) {
-    nextMode = this.overridesBookMode();
+    try {
+      initialMode = _modeStringToNumber(this.options.defaults);
+    } catch (e) {
+      // Can ignore this error
+    }
   }
 
-  return nextMode;
+  return initialMode;
 };
 
 /**
- * Overrides book mode using options.defaults param
- * @return {number} the mode
+ * Converts a mode string to a the mode numeric constant
+ * @param {'mode/1up'|'mode/2up'|'mode/thumb'} modeString
+ * @return {1 | 2 | 3}
  */
-BookReader.prototype.overridesBookMode = function() {
-  let nextMode = 2; // set default 2 (mode/2up)
+export function _modeStringToNumber(modeString) {
+  const MAPPING = {
+    'mode/1up': 1,
+    'mode/2up': 2,
+    'mode/thumb': 3,
+  };
 
-  switch (this.options.defaults) {
-  case 'mode/1up':
-    nextMode = this.constMode1up;
-    break;
-  case 'mode/2up':
-    nextMode = this.constMode2up;
-    break;
-  case 'mode/thumb':
-    nextMode = this.constModeThumb;
-    break;
-  default:
-    break;
+  if (!(modeString in MAPPING)) {
+    throw new OptionsParseError(`Invalid mode string: ${modeString}`);
   }
 
-  return nextMode;
-};
+  return MAPPING[modeString];
+}
 
 /**
  * This is called by the client to initialize BookReader.

package/src/css/_icons.scss

@@ -37,7 +37,7 @@
 }
 
 .icon-fullscreen-exit {
-  background-image: url("icons/fullscreen-exit.svg");
+  background-image: url("icons/fullscreen_exit.svg");
 }
 
 .icon-thumb {

package/src/plugins/url/UrlPlugin.js

@@ -139,11 +139,20 @@ export class UrlPlugin {
     const urlStrPath = this.urlStateToUrlString(this.urlState);
     const concatenatedPath = urlStrPath !== '/' ? urlStrPath : '';
     if (this.urlMode == 'history') {
-      if (window.history && window.history.replaceState) {
+      if (!window.history || !window.history.replaceState) {
+        this.options.urlMode = 'hash';
+      } else {
         const newUrlPath = `${this.urlHistoryBasePath}${concatenatedPath}`.trim().replace(/(\/+)/g, '/');
-        window.history.replaceState({}, null, newUrlPath);
+        try {
+          window.history.replaceState({}, null, newUrlPath);
+        } catch (e) {
+          // DOMException on Chrome when in sandboxed iframe
+          this.urlMode = 'hash';
+        }
       }
-    } else {
+    }
+
+    if (this.urlMode == 'hash') {
       window.location.replace('#' + concatenatedPath);
     }
     this.oldLocationHash = urlStrPath;

package/src/plugins/url/plugin.url.js

@@ -124,7 +124,7 @@ BookReader.prototype.urlStartLocationPolling = function() {
  */
 BookReader.prototype.urlUpdateFragment = function() {
   const allParams = this.paramsFromCurrent();
-  const { urlMode, urlTrackIndex0, urlTrackedParams } = this.options;
+  const { urlTrackIndex0, urlTrackedParams } = this.options;
 
   if (!urlTrackIndex0
       && (typeof(allParams.index) !== 'undefined')
@@ -140,29 +140,36 @@ BookReader.prototype.urlUpdateFragment = function() {
     return validParams;
   }, {});
 
-  const newFragment = this.fragmentFromParams(params, urlMode);
+  const newFragment = this.fragmentFromParams(params, this.options.urlMode);
   const currFragment = this.urlReadFragment();
   const currQueryString = this.getLocationSearch();
-  const newQueryString = this.queryStringFromParams(params, currQueryString, urlMode);
+  const newQueryString = this.queryStringFromParams(params, currQueryString, this.options.urlMode);
   if (currFragment === newFragment && currQueryString === newQueryString) {
     return;
   }
 
-  if (urlMode === 'history') {
-    if (window.history && window.history.replaceState) {
+  if (this.options.urlMode === 'history') {
+    if (!window.history || !window.history.replaceState) {
+      this.options.urlMode = 'hash';
+    } else {
       const baseWithoutSlash = this.options.urlHistoryBasePath.replace(/\/+$/, '');
       const newFragmentWithSlash = newFragment === '' ? '' : `/${newFragment}`;
 
       const newUrlPath = `${baseWithoutSlash}${newFragmentWithSlash}${newQueryString}`;
-      window.history.replaceState({}, null, newUrlPath);
-      this.oldLocationHash = newFragment + newQueryString;
-
+      try {
+        window.history.replaceState({}, null, newUrlPath);
+        this.oldLocationHash = newFragment + newQueryString;
+      } catch (e) {
+        // DOMException on Chrome when in sandboxed iframe
+        this.options.urlMode = 'hash';
+      }
     }
-  } else {
+  }
+
+  if (this.options.urlMode === 'hash')  {
     const newQueryStringSearch = this.urlParamsFiltersOnlySearch(this.readQueryString());
     window.location.replace('#' + newFragment + newQueryStringSearch);
     this.oldLocationHash = newFragment + newQueryStringSearch;
-
   }
 };
 

package/src/util/docCookies.js

@@ -9,6 +9,22 @@
  *  http://www.gnu.org/licenses/gpl-3.0-standalone.html
  */
 
+/**
+ * Check to see if the browser has cookies enabled.
+ * Accessing document.cookies errors if eg iframe with sandbox enabled.
+ * @returns {boolean}
+ */
+export function areCookiesBlocked(doc = document) {
+  try {
+    doc.cookie;
+    return false;
+  } catch (e) {
+    return true;
+  }
+}
+
+const COOKIES_BLOCKED = areCookiesBlocked();
+
 /**
  * Get specific key's value stored in cookie
  *
@@ -17,7 +33,7 @@
  * @returns {string|null}
  */
 export function getItem(sKey) {
-  if (!sKey) return null;
+  if (COOKIES_BLOCKED || !sKey) return null;
 
   return decodeURIComponent(
     // eslint-disable-next-line no-useless-escape
@@ -34,9 +50,11 @@ export function getItem(sKey) {
  * @param {string} [sDomain] domain name
  * @param {boolean} [bSecure]
  *
- * @returns {true}
+ * @returns {boolean}
  */
 export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+  if (COOKIES_BLOCKED) return false;
+
   document.cookie = encodeURIComponent(sKey) + '=' + encodeURIComponent(sValue)
   + (vEnd ? `; expires=${vEnd.toUTCString()}` : '')
   + (sDomain ? `; domain=${sDomain}` : '')
@@ -56,6 +74,7 @@ export function setItem(sKey, sValue, vEnd, sPath, sDomain, bSecure) {
  * @returns {boolean}
  */
 export function removeItem(sKey, sPath, sDomain) {
+  if (COOKIES_BLOCKED) return false;
   // eslint-disable-next-line
   if (!hasItem(sKey)) return false;
 

package/tests/jest/BookReader.test.js

@@ -1,5 +1,5 @@
 
-import BookReader from '@/src/BookReader.js';
+import BookReader, {_modeStringToNumber} from '@/src/BookReader.js';
 import '@/src/plugins/plugin.resume.js';
 import '@/src/plugins/url/plugin.url.js';
 
@@ -279,35 +279,12 @@ describe('nextReduce', () => {
       expect(nextReduce(2, 'auto', SAMPLE_FACTORS).reduce).toBe(0.5);
     });
   });
+});
 
-  describe('Override book page mode using options.default param', () => {
-    test('replace current mode with options.default is set mode/1up', () => {
-      br.options.defaults = 'mode/1up';
-
-      const nextModeNumber = br.overridesBookMode();
-      expect(nextModeNumber).toBe(1);
-    });
-
-    test('replace current mode with options.default is set mode/2up', () => {
-      br.options.defaults = 'mode/2up';
-
-      const nextModeNumber = br.overridesBookMode();
-      expect(nextModeNumber).toBe(2);
-    });
-
-    test('replace current mode with options.default is set mode/thumb', () => {
-      br.options.defaults = 'mode/thumb';
-
-      const nextModeNumber = br.overridesBookMode();
-      expect(nextModeNumber).toBe(3);
-    });
-
-    test('test if options.default is NOT set', () => {
-      br.options.defaults = null;
-
-      // use mode/2up as default when no options.default metadata found
-      const nextModeNumber = br.overridesBookMode();
-      expect(nextModeNumber).toBe(2);
-    });
+describe('_modeStringToNumber', () => {
+  test('Returns correct number', () => {
+    expect(_modeStringToNumber('mode/1up')).toBe(1);
+    expect(_modeStringToNumber('mode/2up')).toBe(2);
+    expect(_modeStringToNumber('mode/thumb')).toBe(3);
   });
 });

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

@@ -114,6 +114,26 @@ describe('Plugin: URL controller', () => {
     expect(window.history.replaceState).toHaveBeenCalled();
   });
 
+  test('switches to hashMode if replaceState errors', () => {
+    window.history.replaceState = jest.fn(() => {
+      throw new Error('foo');
+    });
+    BookReader.prototype.currentIndex = jest.fn(() => 1);
+    BookReader.prototype.urlReadFragment = jest.fn(() => '');
+    BookReader.prototype.paramsFromCurrent = jest.fn(() => ({
+      index: 1,
+      mode: 2,
+      view: 'theater'
+    }));
+    BookReader.prototype.search = jest.fn();
+    br.options.urlMode = 'history';
+    br.init();
+    br.urlUpdateFragment();
+
+    expect(window.history.replaceState).toHaveBeenCalled();
+    expect(br.options.urlMode).toEqual('hash');
+  });
+
   test('does not update URL when search in query string', () => {
     window.history.replaceState = jest.fn();
     BookReader.prototype.currentIndex = jest.fn(() => 1);

package/tests/jest/util/docCookies.test.js

@@ -13,3 +13,12 @@ describe('Helper function: set and get cookie item', () => {
     expect(docCookies.getItem('test-cookie')).toEqual('jack-sparow');
   });
 });
+
+describe('isCookiesBlocked', () => {
+  test('return true if cookies are blocked', () => {
+    expect(docCookies.areCookiesBlocked({ get cookie() { throw new Error(); }})).toBeTruthy();
+  });
+  test('return false if cookies are not blocked', () => {
+    expect(docCookies.areCookiesBlocked({ cookie: 'blah' })).toBeFalsy();
+  });
+});