@internetarchive/bookreader 5.0.0-88-alpha.7 → 5.0.0-88-alpha.9

package/dist/esm/plugins/search/plugin.search.js

@@ -0,0 +1,499 @@
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+// @ts-check
+/* global BookReader */
+/**
+ * Plugin for Archive.org book search
+ * 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 { poll } from '../../BookReader/utils.js';
+import { renderBoxesInPageContainerLayer } from '../../BookReader/PageContainer.js';
+import SearchView from './view.js';
+import { marshallSearchResults } from './utils.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',
+  bookId: '',
+  subPrefix: '',
+  bookPath: '',
+  enableSearch: true,
+  searchInsideProtocol: 'https',
+  searchInsideUrl: '/fulltext/inside.php',
+  searchInsidePreTag: '{{{',
+  searchInsidePostTag: '}}}',
+  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.enableSearch) {
+      this.searchView = new SearchView({
+        br: this,
+        searchCancelledCallback: () => {
+          this._cancelSearch();
+          this.trigger('SearchCanceled', {
+            term: this.searchTerm,
+            instance: this
+          });
+        }
+      });
+    } else {
+      this.searchView = null;
+    }
+  };
+}(BookReader.prototype.setup);
+
+/** @override */
+BookReader.prototype.init = function (super_) {
+  return function () {
+    super_.call(this);
+    if (!this.enableSearch) return;
+    this.searchView.init();
+    if (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 () {
+    var $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) {
+    var pageContainer = super_.call(this, index);
+    if (this.enableSearch && pageContainer.page && index in this._searchBoxesByIndex) {
+      var pageIndex = pageContainer.page.index;
+      var boxes = this._searchBoxesByIndex[pageIndex];
+      renderBoxesInPageContainerLayer('searchHiliteLayer', boxes, pageContainer.page, pageContainer.$container[0], boxes.map(b => "match-index-".concat(b.matchIndex)));
+    }
+    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 = /*#__PURE__*/_asyncToGenerator(function* () {
+  var term = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  var overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  /** @type {SearchOptions} */
+  var 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) */
+  };
+  var 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, ' ');
+  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
+  var serverPath = this.server.replace(/:.+/, '');
+  var baseUrl = "".concat(this.options.searchInsideProtocol, "://").concat(serverPath).concat(this.searchInsideUrl, "?");
+
+  // Remove subPrefix from end of path
+  var path = this.bookPath;
+  var subPrefixWithSlash = "/".concat(this.subPrefix);
+  if (this.bookPath.length - this.bookPath.lastIndexOf(subPrefixWithSlash) == subPrefixWithSlash.length) {
+    path = this.bookPath.substr(0, this.bookPath.length - subPrefixWithSlash.length);
+  }
+  var urlParams = {
+    item_id: this.bookId,
+    doc: this.subPrefix,
+    path,
+    q: term,
+    pre_tag: this.options.searchInsidePreTag,
+    post_tag: this.options.searchInsidePostTag
+  };
+
+  // NOTE that the API does not expect / (slashes) to be encoded. (%2F) won't work
+  var paramStr = $.param(urlParams).replace(/%2F/g, '/');
+  var url = "".concat(baseUrl).concat(paramStr);
+  var callSearchResultsCallback = searchInsideResults => {
+    if (this.searchCancelled) {
+      return;
+    }
+    var responseHasError = searchInsideResults.error || !searchInsideResults.matches.length;
+    var hasCustomError = typeof options.error === 'function';
+    var hasCustomSuccess = typeof options.success === 'function';
+    if (responseHasError) {
+      console.error('Search Inside Response Error', searchInsideResults.error || 'matches.length == 0');
+      hasCustomError ? options.error.call(this, searchInsideResults, options) : this.BRSearchCallbackError(searchInsideResults, options);
+    } else {
+      hasCustomSuccess ? options.success.call(this, searchInsideResults, options) : this.BRSearchCallback(searchInsideResults, options);
+    }
+  };
+  this.trigger('SearchStarted', {
+    term: this.searchTerm,
+    instance: this
+  });
+  callSearchResultsCallback(yield $.ajax({
+    url: url,
+    cache: true,
+    xhrFields: {
+      withCredentials: this.protected
+    },
+    beforeSend: xhr => {
+      this.searchXHR = xhr;
+    }
+  }));
+});
+
+/**
+ * cancels AJAX Call
+ * emits custom event
+ */
+BookReader.prototype._cancelSearch = function () {
+  var _this$searchXHR;
+  (_this$searchXHR = this.searchXHR) === null || _this$searchXHR === void 0 || _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
+    });
+  }
+};
+
+/**
+  * @typedef {object} SearchInsideMatchBox
+  * @property {number} page
+  * @property {number} r
+  * @property {number} l
+  * @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} html (computed field) The html-escaped raw html to display in the UI.
+ * @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
+ * @param {SearchInsideResults} results
+ * @param {object} options
+ * @param {boolean} options.goToFirstResult
+ */
+BookReader.prototype.BRSearchCallback = function (results, options) {
+  marshallSearchResults(results, pageNum => this.book.getPageNum(this.book.leafNumToIndex(pageNum)), this.options.searchInsidePreTag, this.options.searchInsidePostTag);
+  this.searchResults = results || [];
+  this.updateSearchHilites();
+  this.removeProgressPopup();
+  if (options.goToFirstResult) {
+    this._searchPluginGoToResult(0);
+  }
+  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;
+  var basePayload = {
+    term: this.searchTerm,
+    instance: this
+  };
+  if (results.error) {
+    var 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 () {
+  var _this$searchResults;
+  /** @type {SearchInsideMatch[]} */
+  var matches = ((_this$searchResults = this.searchResults) === null || _this$searchResults === void 0 ? void 0 : _this$searchResults.matches) || [];
+  /** @type { {[pageIndex: number]: SearchInsideMatchBox[]} } */
+  var boxesByIndex = {};
+
+  // Clear any existing svg layers
+  this.removeSearchHilites();
+
+  // Group by pageIndex
+  for (var match of matches) {
+    for (var box of match.par[0].boxes) {
+      var pageIndex = this.book.leafNumToIndex(box.page);
+      var pageBoxes = boxesByIndex[pageIndex] || (boxesByIndex[pageIndex] = []);
+      pageBoxes.push(box);
+    }
+  }
+
+  // update any already created pages
+  for (var [pageIndexString, boxes] of Object.entries(boxesByIndex)) {
+    var _pageIndex = parseFloat(pageIndexString);
+    var page = this.book.getPage(_pageIndex);
+    var pageContainers = this.getActivePageContainerElementsForIndex(_pageIndex);
+    for (var container of pageContainers) {
+      renderBoxesInPageContainerLayer('searchHiliteLayer', boxes, page, container, boxes.map(b => "match-index-".concat(b.matchIndex)));
+    }
+  }
+  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 {number} matchIndex
+ */
+BookReader.prototype._searchPluginGoToResult = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator(function* (matchIndex) {
+    var _this$searchResults2;
+    var match = (_this$searchResults2 = this.searchResults) === null || _this$searchResults2 === void 0 ? void 0 : _this$searchResults2.matches[matchIndex];
+    var book = this.book;
+    var pageIndex = book.leafNumToIndex(match.par[0].page);
+    var page = book.getPage(pageIndex);
+    var onNearbyPage = Math.abs(this.currentIndex() - pageIndex) < 3;
+    var makeUnviewableAtEnd = false;
+    if (!page.isViewable) {
+      var resp = yield fetch('/services/bookreader/request_page?' + new URLSearchParams({
+        id: this.options.bookId,
+        subprefix: this.options.subPrefix,
+        leafNum: page.leafNum
+      })).then(r => r.json());
+      for (var 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;
+      }
+
+      // Trigger an update of book
+      this._modes.mode1Up.mode1UpLit.updatePages();
+      if (this.activeMode == this._modes.mode1Up) {
+        yield this._modes.mode1Up.mode1UpLit.updateComplete;
+      }
+    }
+    /* this updates the URL */
+    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
+    var $boxes = yield poll(() => $("rect.match-index-".concat(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
+      yield new Promise(resolve => setTimeout(resolve, 100));
+      $boxes.removeAttr("style");
+    }
+  });
+  return function (_x) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+
+/**
+ * Removes all search pins
+ */
+BookReader.prototype.removeSearchResults = function () {
+  var suppressFragmentChange = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 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 () {
+  var results = this.searchResults;
+  var 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 => {
+      var pageIndex = this.book.leafNumToIndex(box.page);
+      if (jQuery.inArray(pageIndex, visiblePages) >= 0) {
+        return true;
+      }
+    });
+  });
+  return false;
+};

package/dist/esm/plugins/search/utils.js

@@ -0,0 +1,42 @@
+import { escapeHTML, escapeRegExp } from '../../BookReader/utils.js';
+
+/**
+ * @param {string} match
+ * @param {string} preTag
+ * @param {string} postTag
+ * @returns {string}
+ */
+export function renderMatch(match, preTag, postTag) {
+  // Search results are returned as a text blob with the hits wrapped in
+  // triple mustaches. Hits occasionally include text beyond the search
+  // term, so everything within the staches is captured and wrapped.
+  var preTagRe = escapeRegExp(escapeHTML(preTag));
+  var postTagRe = escapeRegExp(escapeHTML(postTag));
+  // [^] matches any character, including line breaks
+  var regex = new RegExp("".concat(preTagRe, "([^]+?)").concat(postTagRe), 'g');
+  return escapeHTML(match).replace(regex, '<mark>$1</mark>')
+  // Fix trailing hyphens. This over-corrects but is net useful.
+  .replace(/(\b)- /g, '$1');
+}
+
+/**
+ * Attach some fields to search inside results
+ * @param {SearchInsideResults} results
+ * @param {(pageNum: LeafNum) => PageNumString} displayPageNumberFn
+ * @param {string} preTag
+ * @param {string} postTag
+ */
+export function marshallSearchResults(results, displayPageNumberFn, preTag, postTag) {
+  // Attach matchIndex to a few things to make it easier to identify
+  // an active/selected match
+  for (var [index, match] of results.matches.entries()) {
+    match.matchIndex = index;
+    match.displayPageNumber = displayPageNumberFn(match.par[0].page);
+    match.html = renderMatch(match.text, preTag, postTag);
+    for (var par of match.par) {
+      for (var box of par.boxes) {
+        box.matchIndex = index;
+      }
+    }
+  }
+}