@internetarchive/bookreader 5.0.0-38 → 5.0.0-39

package/stat/plugins/plugin.vendor-fullscreen.js

@@ -1,247 +0,0 @@
-/* global BookReader */
-
-/**
- * Toggles browser's native fullscreen mode if available device is not mobile
- */
-if (!isMobile()) {
-  const EVENT_NAMESPACE = '.bookreader_vendor-fullscreen';
-
-  jQuery.extend(BookReader.defaultOptions, {
-    /** @type {boolean} */
-    enableVendorFullscreenPlugin: true
-  });
-
-  /** @override */
-  BookReader.prototype.setup = (function(super_) {
-    return function(options) {
-      super_.call(this, options);
-
-      this.isVendorFullscreenActive = false;
-    };
-  })(BookReader.prototype.setup);
-
-  /** @override */
-  BookReader.prototype.getInitialMode = (function(super_) {
-    return function(params) {
-      let nextMode = super_.call(this, params);
-      if (this.isVendorFullscreenActive) {
-        nextMode = this.constMode1up;
-      }
-      return nextMode;
-    };
-  })(BookReader.prototype.getInitialMode);
-
-  /** @override */
-  BookReader.prototype.init = (function(super_) {
-    return function() {
-      super_.call(this);
-
-      if (!fullscreenAllowed()) {
-        return;
-      }
-      // In fullscreen mode the colorbox and overlay need to be inside the fullscreen element to display properly.
-      bindFullscreenChangeListener(this, (e) => {
-        e.data.resize();
-        e.data.updateBrClasses();
-        const cboxOverlay = $('#cboxOverlay');
-        const cbox = $('#colorbox');
-        if (isFullscreenActive()) {
-          // In full screen mode, the colorbox and overlay need
-          // to be children of the fullscreen element to display properly.
-          const $fullscreen = $(getFullscreenElement());
-          $fullscreen.append(cboxOverlay).append(cbox);
-        } else {
-          // In non-fullscreen mode, the colorbox and overlay need
-          // to be children of the main document body.
-          $(document.body).append(cboxOverlay).append(cbox);
-        }
-      });
-    };
-  })(BookReader.prototype.init);
-
-  /**
-   * Start fullscreen mode
-   */
-  BookReader.prototype.enterFullWindow = function() {
-    this.refs.$brContainer.css('opacity', 0);
-
-    const windowWidth = $(window).width();
-    if (windowWidth <= this.onePageMinBreakpoint) {
-      this.switchMode(this.constMode1up);
-    }
-
-    this.isVendorFullscreenActive = true;
-    this.updateBrClasses();
-
-    this.resize();
-    this.jumpToIndex(this.currentIndex());
-
-    this.refs.$brContainer.animate({ opacity: 1 }, 400, 'linear');
-
-    $(document).on(`keyup.${EVENT_NAMESPACE}`, e => {
-      if (e.keyCode === 27) this.exitFullScreen();
-    });
-  };
-
-  /**
-   * Exit from fullscreen mode
-   */
-  BookReader.prototype.exitFullWindow = function() {
-    this.refs.$brContainer.css('opacity', 0);
-
-    $(document).off('keyup' + EVENT_NAMESPACE);
-
-    this.isFullscreenActive = false;
-    this.updateBrClasses();
-
-    this.resize();
-    this.refs.$brContainer.animate({ opacity: 1 }, 400, 'linear');
-  };
-
-  /**
-   * Returns true if fullscreen mode is enabled
-   *
-   * @returns {boolean}
-   */
-  BookReader.prototype.isFullscreen = function() {
-    return isFullscreenActive() || this.isVendorFullscreenActive;
-  };
-
-  /**
-   * Toggle screen
-   */
-  BookReader.prototype.toggleFullscreen = function() {
-    if (this.isFullscreen()) {
-      if (fullscreenAllowed()) {
-        exitFullscreen();
-      } else {
-        this.exitFullWindow();
-      }
-    } else {
-      if (fullscreenAllowed()) {
-        requestFullscreen(this.refs.$br[0]);
-      } else {
-        this.enterFullWindow();
-      }
-    }
-  };
-
-  /** @deprecated */
-  BookReader.util.isMobile = isMobile;
-
-  /** @deprecated */
-  BookReader.util.getFullscreenElement = getFullscreenElement;
-
-  /** @deprecated */
-  BookReader.util.bindFullscreenChangeListener = bindFullscreenChangeListener;
-
-  /** @deprecated */
-  BookReader.util.fullscreenAllowed = fullscreenAllowed;
-
-  /** @deprecated */
-  BookReader.util.requestFullscreen = requestFullscreen;
-
-  /** @deprecated */
-  BookReader.util.exitFullscreen = exitFullscreen;
-
-  /** @deprecated */
-  BookReader.util.isFullscreenActive = isFullscreenActive;
-}
-
-
-/**
- * Returns the DOM element being used for fullscreen.
- *
- * @returns {HTMLElement}
- * @see https://developer.mozilla.org/en-US/docs/Web/API/DocumentOrShadowRoot/fullscreenElement
- */
-export function getFullscreenElement() {
-  return document.fullscreenElement ||
-    document.webkitFullscreenElement ||
-    document.mozFullScreenElement ||
-    document.msFullscreenElement;
-}
-
-/**
- * Returns true if the document is in fullscreen mode.
- *
- * @returns {boolean}
- */
-export function isFullscreenActive() {
-  const fullscreenElement = getFullscreenElement();
-  return fullscreenElement !== null && fullscreenElement !== undefined;
-}
-
-/**
- * Exits fullscreen mode.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/exitFullscreen
- */
-export function exitFullscreen() {
-  if (document.exitFullscreen) {
-    document.exitFullscreen();
-  } else if (document.webkitExitFullscreen) {
-    document.webkitExitFullscreen();
-  } else if (document.mozCancelFullScreen) {
-    document.mozCancelFullScreen();
-  } else if (document.msExitFullscreen) {
-    document.msExitFullscreen();
-  }
-}
-
-/**
- * Requests fullscreen mode for the given element
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullscreen
- */
-export function requestFullscreen(element) {
-  if (element.requestFullscreen) {
-    element.requestFullscreen();
-  } else if (element.webkitRequestFullscreen) {
-    element.webkitRequestFullscreen();
-  } else if (element.mozRequestFullScreen) {
-    element.mozRequestFullScreen();
-  } else if (element.msRequestFullscreen) {
-    element.msRequestFullscreen();
-  }
-}
-
-/**
- * Returns true if fullscreen mode is allowed on this device and document.
- *
- * @returns {boolean}
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/fullscreenEnabled
- */
-export function fullscreenAllowed() {
-  return (document.fullscreenEnabled ||
-    document.webkitFullscreenEnabled ||
-    document.mozFullScreenEnabled ||
-    document.msFullScreenEnabled);
-}
-
-/**
- * jQuery-style binding to a fullscreenchange event.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/fullscreenchange_event
- */
-export function bindFullscreenChangeListener(
-  data, fullscreenchangeListener
-) {
-  const event = 'fullscreenchange ';
-  const vendor_prefixes = [
-    'webkit',
-    'moz',
-    'ms'
-  ];
-  const all_events = (event + vendor_prefixes.join(event) + event).trim();
-  $(document).on(all_events, data, fullscreenchangeListener);
-}
-
-/**
- * Returns true if current device is mobile
- *
- * @returns {boolean}
- */
-export function isMobile() {
-  return (typeof window.orientation !== 'undefined') || (navigator.userAgent.indexOf('IEMobile') !== -1);
-}

package/stat/plugins/search/plugin.search.js

@@ -1,439 +0,0 @@
-/* global BookReader */
-/**
- * Plugin for Archive.org book search
- * NOTE: This script must be loaded AFTER `plugin.mobile_nav.js`
- * as it mutates mobile nav drawer
- *
- * Events fired at various points throughout search processing are published
- * on the document DOM element. These can be subscribed to using jQuery's event
- * binding method `$.fn.on`. All of the events are prefixed with a BookReader
- * namespace. The events are:
- *
- * @event BookReader:SearchStarted - When a search form is submitted, immediately
- *   before an AJAX call is made to request search results
- * @event BookReader:SearchCallback - When the search AJAX call is returned and at
- *   least one result is returned. The event callback receives an object
- *   with the `results`, plugin `options`, and the BookReader `instance`
- * @event BookReader:SearchCallbackError - When the AJAX request returns an error.
- *   Receives the `results` and `instance`
- * @event BookReader:SearchCallbackNotIndexed - When a message is received that
- *   the book has not had OCR text indexed yet. Receives `instance`
- * @event BookReader:SearchCallbackEmpty - When no results found. Receives
- *   `instance`
- * @event BookReader:SearchCanceled - When no results found. Receives
- *   `instance`
- */
-import { renderBoxesInPageContainerLayer } from '../../BookReader/PageContainer.js';
-import SearchView from './view.js';
-/** @typedef {import('../../BookReader/PageContainer').PageContainer} PageContainer */
-/** @typedef {import('../../BookReader/BookModel').PageIndex} PageIndex */
-
-jQuery.extend(BookReader.defaultOptions, {
-  server: 'ia600609.us.archive.org',
-  bookId: '',
-  subPrefix: '',
-  bookPath: '',
-  enableSearch: true,
-  searchInsideUrl: '/fulltext/inside.php',
-  initialSearchTerm: null,
-});
-
-/** @override */
-BookReader.prototype.setup = (function (super_) {
-  return function (options) {
-    super_.call(this, options);
-
-    this.searchTerm = '';
-    this.searchResults = null;
-    this.searchInsideUrl = options.searchInsideUrl;
-    this.enableSearch = options.enableSearch;
-
-    // Base server used by some api calls
-    this.bookId = options.bookId;
-    this.server = options.server;
-    this.subPrefix = options.subPrefix;
-    this.bookPath = options.bookPath;
-
-    this.searchXHR = null;
-    this._cancelSearch.bind(this);
-    this.cancelSearchRequest.bind(this);
-
-    /** @type { {[pageIndex: number]: SearchInsideMatchBox[]} } */
-    this._searchBoxesByIndex = {};
-
-    if (this.searchView) { return; }
-    this.searchView = new SearchView({
-      br: this,
-      searchCancelledCallback: () => {
-        this._cancelSearch();
-        this.trigger('SearchCanceled', { term: this.searchTerm, instance: this });
-      }
-    });
-  };
-})(BookReader.prototype.setup);
-
-/** @override */
-BookReader.prototype.init = (function (super_) {
-  return function () {
-    super_.call(this);
-
-    if (this.options.enableSearch && this.options.initialSearchTerm) {
-      /**
-       * this.search() take two parameter
-       * 1. this.options.initialSearchTerm - search term
-       * 2. {
-       *  goToFirstResult: this.options.goToFirstResult,
-       *  suppressFragmentChange: false // always want to change fragment in URL
-       * }
-       */
-      this.search(
-        this.options.initialSearchTerm,
-        { goToFirstResult: this.options.goToFirstResult, suppressFragmentChange: false }
-      );
-    }
-  };
-})(BookReader.prototype.init);
-
-/** @override */
-BookReader.prototype.buildToolbarElement = (function (super_) {
-  return function () {
-    const $el = super_.call(this);
-    if (!this.enableSearch) { return; }
-    if (this.searchView.dom.toolbarSearch) {
-      $el.find('.BRtoolbarSectionInfo').after(this.searchView.dom.toolbarSearch);
-    }
-    return $el;
-  };
-})(BookReader.prototype.buildToolbarElement);
-
-/** @override */
-BookReader.prototype._createPageContainer = (function (super_) {
-  return function (index) {
-    const pageContainer = super_.call(this, index);
-    if (this.enableSearch && pageContainer.page && index in this._searchBoxesByIndex) {
-      const pageIndex = pageContainer.page.index;
-      renderBoxesInPageContainerLayer('searchHiliteLayer', this._searchBoxesByIndex[pageIndex], pageContainer.page, pageContainer.$container[0]);
-    }
-    return pageContainer;
-  };
-})(BookReader.prototype._createPageContainer);
-
-/**
- * @typedef {object} SearchOptions
- * @property {boolean} goToFirstResult
- * @property {boolean} disablePopup
- * @property {(null|function)} error - @deprecated at v.5.0
- * @property {(null|function)} success - @deprecated at v.5.0
- */
-
-/**
- * Submits search request
- *
- * @param {string} term
- * @param {SearchOptions} overrides
- */
-BookReader.prototype.search = function(term = '', overrides = {}) {
-  /** @type {SearchOptions} */
-  const defaultOptions = {
-    goToFirstResult: false, /* jump to the first result (default=false) */
-    disablePopup: false,    /* don't show the modal progress (default=false) */
-    suppressFragmentChange: false, /* don't change the URL on initial load */
-    error: null,            /* optional error handler (default=null) */
-    success: null,          /* optional success handler (default=null) */
-
-  };
-  const options = jQuery.extend({}, defaultOptions, overrides);
-  this.suppressFragmentChange = options.suppressFragmentChange;
-
-  // strip slashes, since this goes in the url
-  this.searchTerm = term.replace(/\//g, ' ');
-
-  if (!options.suppressFragmentChange) {
-    this.trigger(BookReader.eventNames.fragmentChange);
-  }
-
-  // Add quotes to the term. This is to compenstate for the backends default OR query
-  // term = term.replace(/['"]+/g, '');
-  // term = '"' + term + '"';
-
-  // Remove the port and userdir
-  const serverPath = this.server.replace(/:.+/, '');
-  const baseUrl = `https://${serverPath}${this.searchInsideUrl}?`;
-
-  // Remove subPrefix from end of path
-  let path = this.bookPath;
-  const subPrefixWithSlash = `/${this.subPrefix}`;
-  if (this.bookPath.length - this.bookPath.lastIndexOf(subPrefixWithSlash) == subPrefixWithSlash.length) {
-    path = this.bookPath.substr(0, this.bookPath.length - subPrefixWithSlash.length);
-  }
-
-  const urlParams = {
-    item_id: this.bookId,
-    doc: this.subPrefix,
-    path,
-    q: term,
-  };
-
-  // NOTE that the API does not expect / (slashes) to be encoded. (%2F) won't work
-  const paramStr = $.param(urlParams).replace(/%2F/g, '/');
-
-  const url = `${baseUrl}${paramStr}`;
-
-  const cleanup = () => {
-    this.searchXHR = null;
-    window.BRSearchInProgress = () => {};
-  };
-
-  const processSearchResults = (searchInsideResults) => {
-    if (!this.searchXHR) {
-      return;
-    }
-    const responseHasError = searchInsideResults.error || !searchInsideResults.matches.length;
-    const hasCustomError = typeof options.error === 'function';
-    const hasCustomSuccess = typeof options.success === 'function';
-
-    if (responseHasError) {
-      hasCustomError
-        ? options.error.call(this, searchInsideResults, options)
-        : this.BRSearchCallbackError(searchInsideResults, options);
-    } else {
-      hasCustomSuccess
-        ? options.success.call(this, searchInsideResults, options)
-        : this.BRSearchCallback(searchInsideResults, options);
-    }
-    cleanup();
-  };
-
-  const beforeSend = (xhr) => {
-    this.searchXHR = xhr;
-    window.BRSearchInProgress = processSearchResults;
-  };
-
-  this.trigger('SearchStarted', { term: this.searchTerm, instance: this });
-  return $.ajax({
-    url: url,
-    dataType: 'jsonp',
-    beforeSend,
-    jsonpCallback: 'BRSearchInProgress'
-  }).then(processSearchResults);
-};
-
-/**
- * cancels AJAX Call
- * emits custom event
- */
-BookReader.prototype._cancelSearch = function () {
-  this.searchXHR?.abort();
-  this.searchView.clearSearchFieldAndResults(false);
-  this.searchTerm = '';
-  this.searchXHR = null;
-  this.searchResults = [];
-  window.BRSearchInProgress = () => {};
-};
-
-/**
- * External function to cancel search
- * checks for term & xhr in flight before running
- */
-BookReader.prototype.cancelSearchRequest = function () {
-  if (this.searchXHR !== null) {
-    this._cancelSearch();
-    this.searchView.toggleSearchPending();
-    this.trigger('SearchCanceled', { term: this.searchTerm, instance: this });
-  }
-};
-
-/**
-  * @typedef {object} SearchInsideMatchBox
-  * @property {number} page
-  * @property {number} r
-  * @property {number} l
-  * @property {number} b
-  * @property {number} t
-  * @property {HTMLDivElement} [div]
-  */
-
-/**
- * @typedef {object} SearchInsideMatch
- * @property {string} text
- * @property {Array<{ page: number, boxes: SearchInsideMatchBox[] }>} par
- */
-
-/**
- * @typedef {object} SearchInsideResults
- * @property {string} error
- * @property {SearchInsideMatch[]} matches
- * @property {boolean} indexed
- */
-
-/**
- * Search Results return handler
- * @callback
- * @param {SearchInsideResults} results
- * @param {object} options
- * @param {boolean} options.goToFirstResult
- */
-BookReader.prototype.BRSearchCallback = function(results, options) {
-  this.searchResults = results || [];
-
-  this.updateSearchHilites();
-  this.removeProgressPopup();
-  if (options.goToFirstResult) {
-    const pageIndex = this._models.book.leafNumToIndex(results.matches[0].par[0].page);
-    this._searchPluginGoToResult(pageIndex);
-  }
-  this.trigger('SearchCallback', { results, options, instance: this });
-};
-
-/**
- * Main search results error handler
- * @callback
- * @param {SearchInsideResults} results
- */
-BookReader.prototype.BRSearchCallbackError = function(results) {
-  this._BRSearchCallbackError(results);
-};
-
-/**
- * @private draws search results error
- * @callback
- * @param {SearchInsideResults} results
- * @param {jQuery} $el
- * @param {boolean} fade
- */
-BookReader.prototype._BRSearchCallbackError = function(results) {
-  this.searchResults = results;
-  const basePayload = {
-    term: this.searchTerm,
-    instance: this,
-  };
-  if (results.error) {
-    const payload = Object.assign({}, basePayload, { results });
-    this.trigger('SearchCallbackError', payload);
-  } else if (0 == results.matches.length) {
-    if (false === results.indexed) {
-      this.trigger('SearchCallbackBookNotIndexed', basePayload);
-      return;
-    }
-    this.trigger('SearchCallbackEmpty', basePayload);
-  }
-};
-
-/**
- * updates search on-page highlights controller
- */
-BookReader.prototype.updateSearchHilites = function() {
-  /** @type {SearchInsideMatch[]} */
-  const matches = this.searchResults?.matches || [];
-  /** @type { {[pageIndex: number]: SearchInsideMatch[]} } */
-  const boxesByIndex = {};
-
-  // Clear any existing svg layers
-  this.removeSearchHilites();
-
-  // Group by pageIndex
-  for (const match of matches) {
-    for (const box of match.par[0].boxes) {
-      const pageIndex = this.leafNumToIndex(box.page);
-      const pageMatches = boxesByIndex[pageIndex] || (boxesByIndex[pageIndex] = []);
-      pageMatches.push(box);
-    }
-  }
-
-  // update any already created pages
-  for (const [pageIndexString, boxes] of Object.entries(boxesByIndex)) {
-    const pageIndex = parseFloat(pageIndexString);
-    const page = this._models.book.getPage(pageIndex);
-    const pageContainers = this.getActivePageContainerElementsForIndex(pageIndex);
-    pageContainers.forEach(container => renderBoxesInPageContainerLayer('searchHiliteLayer', boxes, page, container));
-  }
-
-  this._searchBoxesByIndex = boxesByIndex;
-};
-
-/**
- * remove search highlights
- */
-BookReader.prototype.removeSearchHilites = function() {
-  $(this.getActivePageContainerElements()).find('.searchHiliteLayer').remove();
-};
-
-/**
- * @private
- * Goes to the page specified. If the page is not viewable, tries to load the page
- * FIXME Most of this logic is IA specific, and should be less integrated into here
- * or at least more configurable.
- * @param {PageIndex} pageIndex
- */
-BookReader.prototype._searchPluginGoToResult = async function (pageIndex) {
-  const { book } = this._models;
-  const page = book.getPage(pageIndex);
-  let makeUnviewableAtEnd = false;
-  if (!page.isViewable) {
-    const resp = await fetch('/services/bookreader/request_page?' + new URLSearchParams({
-      id: this.options.bookId,
-      subprefix: this.options.subPrefix,
-      leafNum: page.leafNum,
-    })).then(r => r.json());
-
-    for (const leafNum of resp.value) {
-      book.getPage(book.leafNumToIndex(leafNum)).makeViewable();
-    }
-
-    // not able to show page; make the page viewable anyways so that it can
-    // actually open. On IA, it has a fallback to a special error page.
-    if (!resp.value.length) {
-      book.getPage(pageIndex).makeViewable();
-      makeUnviewableAtEnd = true;
-    }
-  }
-  /* this updates the URL */
-  this.suppressFragmentChange = false;
-  this.jumpToIndex(pageIndex);
-
-  // Reset it to unviewable if it wasn't resolved
-  if (makeUnviewableAtEnd) {
-    book.getPage(pageIndex).makeViewable(false);
-  }
-};
-
-/**
- * Removes all search pins
- */
-BookReader.prototype.removeSearchResults = function(suppressFragmentChange = false) {
-  this.removeSearchHilites(); //be sure to set all box.divs to null
-  this.searchTerm = null;
-  this.searchResults = null;
-  if (!suppressFragmentChange) {
-    this.trigger(BookReader.eventNames.fragmentChange);
-  }
-};
-
-/**
- * Returns true if a search highlight is currently being displayed
- * @returns {boolean}
- */
-BookReader.prototype.searchHighlightVisible = function() {
-  const results = this.searchResults;
-  let visiblePages = [];
-  if (null == results) return false;
-
-  if (this.constMode2up == this.mode) {
-    visiblePages = [this.twoPage.currentIndexL, this.twoPage.currentIndexR];
-  } else if (this.constMode1up == this.mode) {
-    visiblePages = [this.currentIndex()];
-  } else {
-    return false;
-  }
-
-  results.matches.some(match => {
-    return match.par[0].boxes.some(box => {
-      const pageIndex = this.leafNumToIndex(box.page);
-      if (jQuery.inArray(pageIndex, visiblePages) >= 0) {
-        return true;
-      }
-    });
-  });
-
-  return false;
-};