@internetarchive/bookreader 5.0.0-5 → 5.0.0-50-a1

package/src/plugins/search/plugin.search.js

@@ -1,3 +1,4 @@
+// @ts-check
 /* global BookReader */
 /**
  * Plugin for Archive.org book search
@@ -20,8 +21,16 @@
  *   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 { poll } from '../../BookReader/utils.js';
+import { renderBoxesInPageContainerLayer } from '../../BookReader/PageContainer.js';
 import SearchView from './view.js';
+/** @typedef {import('../../BookReader/PageContainer').PageContainer} PageContainer */
+/** @typedef {import('../../BookReader/BookModel').PageIndex} PageIndex */
+/** @typedef {import('../../BookReader/BookModel').LeafNum} LeafNum */
+/** @typedef {import('../../BookReader/BookModel').PageNumString} PageNumString */
 
 jQuery.extend(BookReader.defaultOptions, {
   server: 'ia600609.us.archive.org',
@@ -42,7 +51,6 @@ BookReader.prototype.setup = (function (super_) {
     this.searchResults = null;
     this.searchInsideUrl = options.searchInsideUrl;
     this.enableSearch = options.enableSearch;
-    this.goToFirstResult = false;
 
     // Base server used by some api calls
     this.bookId = options.bookId;
@@ -50,11 +58,14 @@ BookReader.prototype.setup = (function (super_) {
     this.subPrefix = options.subPrefix;
     this.bookPath = options.bookPath;
 
-    if (this.searchView) { return; }
-    this.searchView = new SearchView({
-      br: this,
-      selector: '#BRsearch_tray',
-    });
+    this.searchXHR = null;
+    this._cancelSearch.bind(this);
+    this.cancelSearchRequest.bind(this);
+
+    /** @type { {[pageIndex: number]: SearchInsideMatchBox[]} } */
+    this._searchBoxesByIndex = {};
+
+    this.searchView = undefined;
   };
 })(BookReader.prototype.setup);
 
@@ -62,28 +73,31 @@ BookReader.prototype.setup = (function (super_) {
 BookReader.prototype.init = (function (super_) {
   return function () {
     super_.call(this);
-
+    // give SearchView the most complete bookreader state
+    this.searchView = new SearchView({
+      br: this,
+      searchCancelledCallback: () => {
+        this._cancelSearch();
+        this.trigger('SearchCanceled', { term: this.searchTerm, instance: 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.goToFirstResult, suppressFragmentChange: true }
+        { goToFirstResult: this.options.goToFirstResult, suppressFragmentChange: false }
       );
     }
   };
 })(BookReader.prototype.init);
 
-/** @override */
-BookReader.prototype.buildMobileDrawerElement = (function (super_) {
-  return function () {
-    const $el = super_.call(this);
-    if (!this.enableSearch) { return; }
-    if (this.searchView.dom.mobileSearch) {
-      $el.find('.BRmobileMenu__moreInfoRow').after(this.searchView.dom.mobileSearch);
-    }
-    return $el;
-  };
-})(BookReader.prototype.buildMobileDrawerElement);
-
 /** @override */
 BookReader.prototype.buildToolbarElement = (function (super_) {
   return function () {
@@ -96,6 +110,25 @@ BookReader.prototype.buildToolbarElement = (function (super_) {
   };
 })(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;
+      const boxes = this._searchBoxesByIndex[pageIndex];
+      renderBoxesInPageContainerLayer(
+        'searchHiliteLayer',
+        boxes,
+        pageContainer.page,
+        pageContainer.$container[0],
+        boxes.map(b => `match-index-${b.matchIndex}`),
+      );
+    }
+    return pageContainer;
+  };
+})(BookReader.prototype._createPageContainer);
+
 /**
  * @typedef {object} SearchOptions
  * @property {boolean} goToFirstResult
@@ -110,7 +143,7 @@ BookReader.prototype.buildToolbarElement = (function (super_) {
  * @param {string} term
  * @param {SearchOptions} overrides
  */
-BookReader.prototype.search = function(term = '', overrides = {}) {
+BookReader.prototype.search = async function(term = '', overrides = {}) {
   /** @type {SearchOptions} */
   const defaultOptions = {
     goToFirstResult: false, /* jump to the first result (default=false) */
@@ -122,6 +155,7 @@ BookReader.prototype.search = function(term = '', overrides = {}) {
   };
   const options = jQuery.extend({}, defaultOptions, overrides);
   this.suppressFragmentChange = options.suppressFragmentChange;
+  this.searchCancelled = false;
 
   // strip slashes, since this goes in the url
   this.searchTerm = term.replace(/\//g, ' ');
@@ -157,7 +191,10 @@ BookReader.prototype.search = function(term = '', overrides = {}) {
 
   const url = `${baseUrl}${paramStr}`;
 
-  const processSearchResults = (searchInsideResults) => {
+  const callSearchResultsCallback = (searchInsideResults) => {
+    if (this.searchCancelled) {
+      return;
+    }
     const responseHasError = searchInsideResults.error || !searchInsideResults.matches.length;
     const hasCustomError = typeof options.error === 'function';
     const hasCustomSuccess = typeof options.success === 'function';
@@ -173,11 +210,39 @@ BookReader.prototype.search = function(term = '', overrides = {}) {
     }
   };
 
-  this.trigger('SearchStarted', { term: this.searchTerm });
-  return $.ajax({
+  this.trigger('SearchStarted', { term: this.searchTerm, instance: this });
+  callSearchResultsCallback(await $.ajax({
     url: url,
-    dataType: 'jsonp'
-  }).then(processSearchResults);
+    dataType: 'jsonp',
+    cache: true,
+    beforeSend: xhr => { this.searchXHR = xhr; },
+  }));
+};
+
+/**
+ * cancels AJAX Call
+ * emits custom event
+ */
+BookReader.prototype._cancelSearch = function () {
+  this.searchXHR?.abort();
+  this.searchView.clearSearchFieldAndResults(false);
+  this.searchTerm = '';
+  this.searchXHR = null;
+  this.searchCancelled = true;
+  this.searchResults = [];
+};
+
+/**
+ * External function to cancel search
+ * checks for term & xhr in flight before running
+ */
+BookReader.prototype.cancelSearchRequest = function () {
+  this.searchCancelled = true;
+  if (this.searchXHR !== null) {
+    this._cancelSearch();
+    this.searchView.toggleSearchPending();
+    this.trigger('SearchCanceled', { term: this.searchTerm, instance: this });
+  }
 };
 
 /**
@@ -188,10 +253,13 @@ BookReader.prototype.search = function(term = '', overrides = {}) {
   * @property {number} b
   * @property {number} t
   * @property {HTMLDivElement} [div]
+  * @property {number} matchIndex This is a fake field! not part of the API response. The index of the match that contains this box in total search results matches.
   */
 
 /**
  * @typedef {object} SearchInsideMatch
+ * @property {number} matchIndex This is a fake field! Not part of the API response. It is added by the JS.
+ * @property {string} displayPageNumber (fake field) The page number as it should be displayed in the UI.
  * @property {string} text
  * @property {Array<{ page: number, boxes: SearchInsideMatchBox[] }>} par
  */
@@ -203,23 +271,42 @@ BookReader.prototype.search = function(term = '', overrides = {}) {
  * @property {boolean} indexed
  */
 
+/**
+ * Attach some fields to search inside results
+ * @param {SearchInsideResults} results
+ * @param {(pageNum: LeafNum) => PageNumString} displayPageNumberFn
+ */
+export function marshallSearchResults(results, displayPageNumberFn) {
+  // Attach matchIndex to a few things to make it easier to identify
+  // an active/selected match
+  for (const [index, match] of results.matches.entries()) {
+    match.matchIndex = index;
+    match.displayPageNumber = displayPageNumberFn(match.par[0].page);
+    for (const par of match.par) {
+      for (const box of par.boxes) {
+        box.matchIndex = index;
+      }
+    }
+  }
+}
+
 /**
  * Search Results return handler
- * @callback
  * @param {SearchInsideResults} results
  * @param {object} options
  * @param {boolean} options.goToFirstResult
  */
 BookReader.prototype.BRSearchCallback = function(results, options) {
-  this.searchResults = results;
+  marshallSearchResults(results, pageNum => this.book.getPageNum(this.book.leafNumToIndex(pageNum)));
+  this.searchResults = results || [];
 
   this.updateSearchHilites();
   this.removeProgressPopup();
   if (options.goToFirstResult) {
-    this._searchPluginGoToResult(results.matches[0].par[0].page);
+    this._searchPluginGoToResult(0);
   }
   this.trigger('SearchCallback', { results, options, instance: this });
-}
+};
 
 /**
  * Main search results error handler
@@ -259,95 +346,41 @@ BookReader.prototype._BRSearchCallbackError = function(results) {
  * updates search on-page highlights controller
  */
 BookReader.prototype.updateSearchHilites = function() {
-  if (this.constMode2up == this.mode) {
-    this.updateSearchHilites2UP();
-    return;
+  /** @type {SearchInsideMatch[]} */
+  const matches = this.searchResults?.matches || [];
+  /** @type { {[pageIndex: number]: SearchInsideMatchBox[]} } */
+  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.book.leafNumToIndex(box.page);
+      const pageBoxes = boxesByIndex[pageIndex] || (boxesByIndex[pageIndex] = []);
+      pageBoxes.push(box);
+    }
   }
-  this.updateSearchHilites1UP();
-};
 
-/**
- * update search on-page highlights in 1up mode
- */
-BookReader.prototype.updateSearchHilites1UP = function() {
-  const results = this.searchResults;
-  if (null == results) return;
-  results.matches.forEach(match => {
-    match.par[0].boxes.forEach(box => {
-      const pageIndex = this.leafNumToIndex(box.page);
-      const pageIsInView = jQuery.inArray(pageIndex, this.displayedIndices) >= 0;
-      if (pageIsInView) {
-        if (!box.div) {
-          //create a div for the search highlight, and stash it in the box object
-          box.div = document.createElement('div');
-          $(box.div).prop('className', 'BookReaderSearchHilite').appendTo(this.$(`.pagediv${pageIndex}`));
-        }
-        const page = this._models.book.getPage(pageIndex);
-        const highlight = {
-          width: this._modes.mode1Up.physicalInchesToDisplayPixels((box.r - box.l) / page.ppi),
-          height: this._modes.mode1Up.physicalInchesToDisplayPixels((box.b - box.t) / page.ppi),
-          left: this._modes.mode1Up.physicalInchesToDisplayPixels(box.l / page.ppi),
-          top: this._modes.mode1Up.physicalInchesToDisplayPixels(box.t / page.ppi),
-        };
-        $(box.div).css(highlight);
-      } else {
-        if (box.div) {
-          $(box.div).remove();
-          box.div = null;
-        }
-      }
-    });
-  });
-};
-
-/**
- * update search on-page highlights in 2up mode
- */
-BookReader.prototype.updateSearchHilites2UP = function() {
-  const results = this.searchResults;
+  // update any already created pages
+  for (const [pageIndexString, boxes] of Object.entries(boxesByIndex)) {
+    const pageIndex = parseFloat(pageIndexString);
+    const page = this.book.getPage(pageIndex);
+    const pageContainers = this.getActivePageContainerElementsForIndex(pageIndex);
+    for (const container of pageContainers) {
+      renderBoxesInPageContainerLayer('searchHiliteLayer', boxes, page, container, boxes.map(b => `match-index-${b.matchIndex}`));
+    }
+  }
 
-  if (results === null) return;
-
-  const { matches } = results;
-  matches.forEach((match) => {
-    match.par[0].boxes.forEach(box => {
-      const pageIndex = this.leafNumToIndex(match.par[0].page);
-      const pageIsInView = jQuery.inArray(pageIndex, this.displayedIndices) >= 0;
-      const { isViewable } = this._models.book.getPage(pageIndex);
-
-      if (pageIsInView && isViewable) {
-        if (!box.div) {
-          //create a div for the search highlight, and stash it in the box object
-          box.div = document.createElement('div');
-          $(box.div).addClass('BookReaderSearchHilite')
-            .appendTo(this.refs.$brTwoPageView);
-        }
-        this.setHilightCss2UP(box.div, pageIndex, box.l, box.r, box.t, box.b);
-      } else {
-        // clear stale reference
-        if (box.div) {
-          $(box.div).remove();
-          box.div = null;
-        }
-      }
-    });
-  });
+  this._searchBoxesByIndex = boxesByIndex;
 };
 
 /**
  * remove search highlights
  */
 BookReader.prototype.removeSearchHilites = function() {
-  const results = this.searchResults;
-  if (null == results || !results.matches) { return; }
-  results.matches.forEach(match => {
-    match.par[0].boxes.forEach(box => {
-      if (null != box.div) {
-        $(box.div).remove();
-        box.div = null;
-      }
-    });
-  });
+  $(this.getActivePageContainerElements()).find('.searchHiliteLayer').remove();
 };
 
 /**
@@ -355,11 +388,14 @@ BookReader.prototype.removeSearchHilites = function() {
  * 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
+ * @param {number} matchIndex
  */
-BookReader.prototype._searchPluginGoToResult = async function (pageIndex) {
-  const { book } = this._models;
+BookReader.prototype._searchPluginGoToResult = async function (matchIndex) {
+  const match = this.searchResults?.matches[matchIndex];
+  const book = this.book;
+  const pageIndex = book.leafNumToIndex(match.par[0].page);
   const page = book.getPage(pageIndex);
+  const onNearbyPage = Math.abs(this.currentIndex() - pageIndex) < 3;
   let makeUnviewableAtEnd = false;
   if (!page.isViewable) {
     const resp = await fetch('/services/bookreader/request_page?' + new URLSearchParams({
@@ -380,13 +416,35 @@ BookReader.prototype._searchPluginGoToResult = async function (pageIndex) {
     }
   }
   /* this updates the URL */
-  this.suppressFragmentChange = false;
-  this.jumpToIndex(pageIndex);
+  if (!this._isIndexDisplayed(pageIndex)) {
+    this.suppressFragmentChange = false;
+    this.jumpToIndex(pageIndex);
+  }
 
   // Reset it to unviewable if it wasn't resolved
   if (makeUnviewableAtEnd) {
     book.getPage(pageIndex).makeViewable(false);
   }
+
+  // Scroll/flash in the ui
+  const $boxes = await poll(() => $(`rect.match-index-${match.matchIndex}`), { until: result => result.length > 0 });
+  if ($boxes.length) {
+    $boxes.css('animation', 'none');
+    $boxes[0].scrollIntoView({
+      // Only vertically center the highlight if we're in 1up or in full screen. In
+      // 2up, if we're not fullscreen, the whole body gets scrolled around to try to
+      // center the highlight 🙄 See:
+      // https://stackoverflow.com/questions/11039885/scrollintoview-causing-the-whole-page-to-move/11041376
+      // Note: nearest doesn't quite work great, because the ReadAloud toolbar is now
+      // full-width, and covers up the last line of the highlight.
+      block: this.constMode1up == this.mode || this.isFullscreenActive ? 'center' : 'nearest',
+      inline: 'center',
+      behavior: onNearbyPage ? 'smooth' : 'auto',
+    });
+    // wait for animation to start
+    await new Promise(resolve => setTimeout(resolve, 100));
+    $boxes.removeAttr("style");
+  }
 };
 
 /**
@@ -420,7 +478,7 @@ BookReader.prototype.searchHighlightVisible = function() {
 
   results.matches.some(match => {
     return match.par[0].boxes.some(box => {
-      const pageIndex = this.leafNumToIndex(box.page);
+      const pageIndex = this.book.leafNumToIndex(box.page);
       if (jQuery.inArray(pageIndex, visiblePages) >= 0) {
         return true;
       }