@internetarchive/bookreader 5.0.0-11-multiple-files → 5.0.0-110

package/src/plugins/search/view.js

@@ -1,75 +1,33 @@
+// @ts-check
+/** @typedef {import('@/src/BookReader.js').default} BookReader */
+
 class SearchView {
   /**
    * @param {object} params
-   *   @param {string} params.selector A selector for the element that the search tray will be rendered in
-   *   @param {string} params.query An existing query string
-   *   @param {object} params.br The BookReader instance
+   * @param {BookReader} params.br The BookReader instance
+   * @param {function} params.searchCancelledCallback callback when a user wants to cancel search
    *
    * @event BookReader:SearchResultsCleared - when the search results nav gets cleared
    * @event BookReader:ToggleSearchMenu - when search results menu should toggle
    */
-  constructor(params) {
-    if (!params.selector) {
-      console.warn('BookReader::Search - SearchView must be passed a valid CSS selector');
-      return;
-    }
-
-    this.br = params.br;
-
-    // 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.
-    this.matcher = new RegExp('{{{(.+?)}}}', 'g');
+  constructor({ br, searchCancelledCallback = () => {} }) {
+    /** @type {BookReader} */
+    this.br = br;
     this.matches = [];
-    this.cacheDOMElements(params.selector);
+    this.cacheDOMElements();
+    this.cancelSearch = searchCancelledCallback;
+  }
+
+  init() {
     this.bindEvents();
   }
 
-  /**
-   * @param {string} selector A selector for the element that the search tray will be rendered in
-   */
-  cacheDOMElements(selector) {
+  cacheDOMElements() {
     this.dom = {};
-
-    // The parent search tray in mobile menu
-    this.dom.searchTray = this.renderSearchTray(selector);
-    // Container for rendered search results
-    this.dom.results = this.dom.searchTray.querySelector('[data-id="results"]');
-    // Element used to display number of results
-    this.dom.resultsCount = this.dom.searchTray.querySelector('[data-id="results_count"]');
-    // Search input within the mobile search tray
-    this.dom.searchField = this.dom.searchTray.querySelector('[name="query"]');
-    // Waiting indicator displayed while waiting for a search request
-    this.dom.searchPending = this.dom.searchTray.querySelector('[data-id="searchPending"]');
-    // The element added to the mobile menu that is animated into view when
-    // the "search" nav item is clicked
-    this.dom.mobileSearch = this.buildMobileDrawer();
     // Search input within the top toolbar. Will be removed once the mobile menu is replaced.
     this.dom.toolbarSearch = this.buildToolbarSearch();
   }
 
-  /**
-   * @param {boolean} bool
-   */
-  toggleSearchTray(bool = this.dom.searchTray.classList.contains('hidden')) {
-    this.dom.searchTray.classList.toggle('hidden', !bool);
-  }
-
-  /**
-   * @param {boolean} bool
-   */
-  toggleResultsCount(bool) {
-    this.dom.resultsCount.classList.toggle('visible', bool);
-  }
-
-  /**
-   * @param {SearchInsideResults} results
-   */
-  updateResultsCount(results) {
-    this.dom.resultsCount.innerText = `(${results} result${results != 1 ? 's' : ''})`;
-    this.toggleResultsCount(true);
-  }
-
   /**
    * @param {string} query
    */
@@ -78,7 +36,6 @@ class SearchView {
   }
 
   emptyMatches() {
-    this.dom.results.innerHTML = '';
     this.matches = [];
   }
 
@@ -86,52 +43,24 @@ class SearchView {
     this.br.$('.BRnavpos .BRsearch').remove();
   }
 
-  clearSearchFieldAndResults() {
-    this.br.removeSearchResults();
-    this.toggleResultsCount(false);
+  clearSearchFieldAndResults(dispatchEventWhenComplete = true) {
+    this.br.plugins.search.removeSearchResults();
     this.removeResultPins();
     this.emptyMatches();
     this.setQuery('');
     this.teardownSearchNavigation();
-    this.br.trigger('SearchResultsCleared');
+    if (dispatchEventWhenComplete) {
+      this.br.trigger('SearchResultsCleared');
+    }
   }
 
   toggleSidebar() {
     this.br.trigger('ToggleSearchMenu');
   }
-  /**
-   * @param {string} selector The ID attribute to be used for the search tray
-   */
-  renderSearchTray(selector) {
-    const searchTray = document.createElement('div');
-    searchTray.setAttribute('id', selector.replace(/^#/, ''));
-    searchTray.innerHTML = `
-      <header>
-        <div>
-          <h3>Search inside</h3>
-          <p data-id="results_count"></p>
-        </div>
-        <a href="#" class="close"></a>
-      </header>
-      <form action="" method="get">
-        <fieldset>
-          <input name="all_files" id="all_files" type="checkbox" />
-          <label class="checkbox" for="all_files">Search all files</label>
-          <input type="search" name="query" placeholder="Enter a search term" />
-        </fieldset>
-      </form>
-      <div data-id="searchPending" id="search_pending">
-        <p>Your search results will appear below</p>
-        <div class="loader tc mt20"></div>
-      </div>
-      <ul data-id="results"></ul>
-    `;
-    return searchTray;
-  }
 
   renderSearchNavigation() {
     const selector = 'BRsearch-navigation';
-    $('.BRnav').before(`
+    $('.BRnav.BRnavMain').before(`
       <div class="${selector}">
         <button class="toggle-sidebar">
           <h4>
@@ -215,17 +144,19 @@ class SearchView {
       const start = pool.slice(0, pool.length / 2);
       const end = pool.slice(pool.length / 2);
       return closestTo((comparisonFn(start, end, comparator) ? start : end), comparator);
-    }
+    };
 
     const closestPage = closestTo(matchPages, currentPage);
     return this.matches.indexOf(this.matches.find((m) => m.par[0].page === closestPage));
   }
 
   updateResultsPosition() {
+    if (!this.dom.searchNavigation) return;
     this.dom.searchNavigation.find('[data-id=resultsCount]').text(this.resultsPosition());
   }
 
   updateSearchNavigationButtons() {
+    if (!this.dom.searchNavigation) return;
     this.dom.searchNavigation.find('.prev').attr('disabled', !this.currentMatchIndex);
     this.dom.searchNavigation.find('.next').attr('disabled', this.currentMatchIndex + 1 === this.matches.length);
   }
@@ -272,19 +203,6 @@ class SearchView {
     this.updateSearchNavigationButtons();
   }
 
-  /**
-   * @param {array} matches
-   */
-  renderMatches(matches) {
-    const items = matches.map((match) => `
-      <li data-page="${match.par[0].page}" data-page-index="${this.br.leafNumToIndex(match.par[0].page)}">
-        <h4>Page ${match.par[0].page}</h4>
-        <p>${match.text.replace(this.matcher, '<mark>$1</mark>')}</p>
-      </li>
-    `);
-    this.dom.results.innerHTML = items.join('');
-  }
-
   /**
    * @param {boolean} bool
    */
@@ -293,23 +211,6 @@ class SearchView {
     this.br.refs.$BRfooter.find('.BRsearch').css({ visibility: pinsVisibleState });
   }
 
-  buildMobileDrawer() {
-    const mobileSearch = document.createElement('li');
-    mobileSearch.innerHTML = `
-      <span>
-        <span class="DrawerIconWrapper">
-          <img class="DrawerIcon" src="${this.br.imagesBaseURL}icon_search_button.svg" />
-        </span>
-        Search
-      </span>
-      <div data-id="search_slot">
-      </div>
-    `;
-    mobileSearch.querySelector('[data-id="search_slot"]').appendChild(this.dom.searchTray);
-    mobileSearch.classList.add('BRmobileMenu__search');
-    return mobileSearch;
-  }
-
   buildToolbarSearch() {
     const toolbarSearch = document.createElement('span');
     toolbarSearch.classList.add('BRtoolbarSection', 'BRtoolbarSectionSearch');
@@ -317,7 +218,7 @@ class SearchView {
       <form class="BRbooksearch desktop">
         <input type="search" name="query" class="BRsearchInput" value="" placeholder="Search inside"/>
         <button type="submit" class="BRsearchSubmit">
-          <img src="${this.br.imagesBaseURL}icon_search_button.svg" />
+          <img src="${this.br.options.imagesBaseURL}icon_search_button.svg" />
         </button>
       </form>
     `;
@@ -329,25 +230,20 @@ class SearchView {
    */
   renderPins(matches) {
     matches.forEach((match) => {
-      const queryString = match.text;
-      const pageIndex = this.br.leafNumToIndex(match.par[0].page);
-      const pageNumber = this.br.getPageNum(pageIndex);
+      const pageIndex = this.br.book.leafNumToIndex(match.par[0].page);
       const uiStringSearch = "Search result"; // i18n
-      const uiStringPage = "Page"; // i18n
-
-      const percentThrough = this.br.constructor.util.cssPercentage(pageIndex, this.br.getNumLeafs() - 1);
-
-      const queryStringWithB = queryString.replace(this.matcher, '<b>$1</b>');
-
-      let queryStringWithBTruncated = '';
-
-      if (queryString.length > 100) {
-        queryStringWithBTruncated = queryString
-          .replace(/^(.{100}[^\s]*).*/, "$1")
-          .replace(this.matcher, '<b>$1</b>')
-                + '...';
+      const percentThrough = this.br.constructor.util.cssPercentage(pageIndex, this.br.book.getNumLeafs() - 1);
+
+      let html = match.html;
+      if (html.length > 200) {
+        const start = Math.max(0, html.indexOf('<mark>') - 100);
+        if (start != 0) {
+          html = '…' + match.html
+            .substring(start)
+            // Make sure at word boundary though
+            .replace(/^\S+/, '');
+        }
       }
-
       // draw marker
       $('<div>')
         .addClass('BRsearch')
@@ -357,56 +253,56 @@ class SearchView {
         .attr('title', uiStringSearch)
         .append(`
           <div class="BRquery">
-            <div>${queryStringWithBTruncated || queryStringWithB}</div>
-            <div>${uiStringPage} ${pageNumber}</div>
+            <main>${html}</main>
+            <footer>Page ${match.displayPageNumber}</footer>
           </div>
         `)
-        .data({ pageIndex })
         .appendTo(this.br.$('.BRnavline'))
-        .hover(
-          (event) => {
-            // remove from other markers then turn on just for this
-            // XXX should be done when nav slider moves
-            const marker = event.currentTarget;
-            const tooltip = marker.querySelector('.BRquery');
-            const tooltipOffset = tooltip.getBoundingClientRect();
-            const targetOffset = marker.getBoundingClientRect();
-            const boxSizeAdjust = parseInt(getComputedStyle(tooltip).paddingLeft) * 2;
-            if (tooltipOffset.x - boxSizeAdjust < 0) {
-              tooltip.style.setProperty('transform', `translateX(-${targetOffset.left - boxSizeAdjust}px)`);
-            }
-            $('.BRsearch,.BRchapter').removeClass('front');
-            $(event.target).addClass('front');
-          },
-          (event) => $(event.target).removeClass('front'))
-        .click(function (event) {
-          // closures are nested and deep, using an arrow function breaks references.
-          // Todo: update to arrow function & clean up closures
-          // to remove `bind` dependency
-          this.br._searchPluginGoToResult(+$(event.target).data('pageIndex'));
-          this.br.updateSearchHilites();
-        }.bind(this));
+        .on("mouseenter", (event) => {
+          // remove from other markers then turn on just for this
+          // XXX should be done when nav slider moves
+          const marker = event.currentTarget;
+          const tooltip = marker.querySelector('.BRquery');
+          const tooltipOffset = tooltip.getBoundingClientRect();
+          const targetOffset = marker.getBoundingClientRect();
+          const boxSizeAdjust = parseInt(getComputedStyle(tooltip).paddingLeft) * 2;
+          if (tooltipOffset.x - boxSizeAdjust < 0) {
+            tooltip.style.setProperty('transform', `translateX(-${targetOffset.left - boxSizeAdjust}px)`);
+          }
+          $('.BRsearch,.BRchapter').removeClass('front');
+          $(event.target).addClass('front');
+        })
+        .on("mouseleave", (event) => $(event.target).removeClass('front'))
+        .on("click", () => { this.br.plugins.search.jumpToMatch(match.matchIndex); });
     });
   }
 
   /**
-   * @param {boolean} bool
+   * @param {boolean} show
    */
-  toggleSearchPending(bool) {
-    this.dom.searchPending.classList.toggle('visible', bool);
-    if (bool) {
-      this.br.showProgressPopup("Search results will appear below...");
+  toggleSearchPending(show = false) {
+    if (show) {
+      this.br.showProgressPopup("Search results will appear below...", () => this.progressPopupClosed());
     }
     else {
       this.br.removeProgressPopup();
     }
   }
 
-  renderErrorModal() {
+  /**
+   * Primary callback when user cancels search popup
+   */
+  progressPopupClosed() {
+    this.toggleSearchPending();
+    this.cancelSearch();
+  }
+
+  renderErrorModal(textIsProcessing = false) {
+    const errorDetails = `${!textIsProcessing ? 'The text may still be processing. ' : ''}Please try again.`;
     this.renderModalMessage(`
       Sorry, there was an error with your search.
       <br />
-      The text may still be processing.
+      ${errorDetails}
     `);
     this.delayModalRemovalFor(4000);
   }
@@ -445,14 +341,6 @@ class SearchView {
     setTimeout(this.br.removeProgressPopup.bind(this.br), timeoutMS);
   }
 
-  openMobileMenu() {
-    this.br.refs.$mmenu.data('mmenu').open();
-  }
-
-  closeMobileMenu() {
-    this.br.refs.$mmenu.data('mmenu').close();
-  }
-
   /**
    * @param {Event} e
    */
@@ -461,7 +349,6 @@ class SearchView {
     const query = e.target.querySelector('[name="query"]').value;
     if (!query.length) { return false; }
     this.br.search(query);
-    this.dom.searchField.blur();
     this.emptyMatches();
     this.toggleSearchPending(true);
     return false;
@@ -479,9 +366,7 @@ class SearchView {
     this.teardownSearchNavigation();
     this.renderSearchNavigation();
     this.bindSearchNavigationEvents();
-    this.renderMatches(results.matches);
     this.renderPins(results.matches);
-    this.updateResultsCount(results.matches.length);
     this.toggleSearchPending(false);
     if (options.goToFirstResult) {
       $(document).one('BookReader:pageChanged', () => {
@@ -492,27 +377,23 @@ class SearchView {
     }
   }
 
-  /**
-   * @param {Event} e
-   */
-  handleNavToggledCallback(e) {
-    const is_visible = this.br.navigationIsVisible();
-    this.togglePinsFor(is_visible);
-    this.toggleSearchTray(is_visible ? !!this.dom.results.querySelector('li') : false);
-  }
-
   handleSearchStarted() {
     this.emptyMatches();
-    this.br.removeSearchHilites();
+    this.br.plugins.search.removeSearchHilites();
     this.removeResultPins();
     this.toggleSearchPending(true);
     this.teardownSearchNavigation();
-    this.setQuery(this.br.searchTerm);
+    this.setQuery(this.br.plugins.search.searchTerm);
   }
 
-  handleSearchCallbackError() {
+  /**
+   * Event listener for: `BookReader:SearchCallbackError`
+   * @param {CustomEvent} event
+   */
+  handleSearchCallbackError(event = {}) {
     this.toggleSearchPending(false);
-    this.renderErrorModal();
+    const isIndexed = event?.detail?.props?.results?.indexed;
+    this.renderErrorModal(isIndexed);
   }
 
   handleSearchCallbackBookNotIndexed() {
@@ -528,26 +409,14 @@ class SearchView {
   bindEvents() {
     const namespace = 'BookReader:';
 
+    window.addEventListener(`${namespace}SearchCallbackError`, this.handleSearchCallbackError.bind(this));
     $(document).on(`${namespace}SearchCallback`, this.handleSearchCallback.bind(this))
-      .on(`${namespace}navToggled`, this.handleNavToggledCallback.bind(this))
       .on(`${namespace}SearchStarted`, this.handleSearchStarted.bind(this))
-      .on(`${namespace}SearchCallbackError`, this.handleSearchCallbackError.bind(this))
       .on(`${namespace}SearchCallbackBookNotIndexed`, this.handleSearchCallbackBookNotIndexed.bind(this))
       .on(`${namespace}SearchCallbackEmpty`, this.handleSearchCallbackEmpty.bind(this))
       .on(`${namespace}pageChanged`, this.updateSearchNavigation.bind(this));
 
-    this.dom.searchTray.addEventListener('submit', this.submitHandler.bind(this));
     this.dom.toolbarSearch.querySelector('form').addEventListener('submit', this.submitHandler.bind(this));
-    this.dom.searchField.addEventListener('search', () => {
-      if (this.dom.searchField.value) { return; }
-      this.clearSearchFieldAndResults();
-    });
-
-    $(this.dom.results).on('click', 'li', (e) => {
-      this.br._searchPluginGoToResult(+e.currentTarget.dataset.pageIndex);
-      this.br.updateSearchHilites();
-      this.closeMobileMenu();
-    });
   }
 }
 

package/src/plugins/translate/TranslationManager.js

@@ -0,0 +1,164 @@
+// @ts-check
+import { Cache } from '../../util/cache.js';
+import { BatchTranslator } from '@internetarchive/bergamot-translator/translator.js';
+import { toISO6391, toNativeName } from '../tts/utils.js';
+
+export class TranslationManager {
+  /** @type {Cache<{index: string, response: string}>} */
+  alreadyTranslated = new Cache(100);
+
+  /**
+  * @typedef {Object} genericModelInfo
+  * @property {string} name
+  * @property {number} size
+  * @property {number} estimatedCompressedSize
+  * @property {any} [qualityModel]
+  * @property {string} [expectedSha256Hash]
+  * @property {string} [modelType]
+  */
+  /**
+  * @type { {[langPair: string] : {model: genericModelInfo, lex: genericModelInfo, vocab: genericModelInfo, quality?: genericModelInfo}} }
+  */
+  modelRegistry = {};
+
+  /** @type {Record<key, {promise: Promise<string>, resolve: function, reject: function}>} */
+  currentlyTranslating = {}
+
+  /** @type {Record<string, string>[]} */
+  fromLanguages = [];
+  /** @type {Record<string, string>[]} */
+  toLanguages = [];
+
+  /** @type {boolean} */
+  active = false;
+
+  publicPath = '';
+
+  constructor() {
+    //TODO Should default to the book language as the first element
+    const enModel = {code: "en", name: "English (en)", type: "prod"};
+    this.fromLanguages.push(enModel);
+    this.toLanguages.push(enModel);
+  }
+
+
+  async initWorker() {
+    if (this.initPromise) return this.initPromise;
+    this.initPromise = new Promise((resolve, reject) => {
+      this._initResolve = resolve;
+      this._initReject = reject;
+    });
+    const registryUrl = "https://cors.archive.org/cors/mozilla-translate-models/firefox_models/";
+    const registryJson = await fetch(registryUrl + "registry.json").then(r => r.json());
+    for (const language of Object.values(registryJson)) {
+      for (const file of Object.values(language)) {
+        file.name = registryUrl + file.name;
+      }
+    }
+
+    /** @type {BatchTranslator} */
+    // Arbitrary setting for number of workers, 1 is already quite fast
+    // batchSize from 8 -> 4 for improved performance
+    this.translator = new BatchTranslator({
+      registryUrl: `data:application/json,${encodeURIComponent(JSON.stringify(registryJson))}`,
+      workers: 2,
+      batchSize: 4,
+      workerUrl: this.publicPath + '/translator-worker.js',
+    });
+
+    const modelType = await this.translator.backing.registry;
+    const arr = {}; // unsure if we need to keep track of the files
+    for (const obj of Object.values(modelType)) {
+      const firstLang = obj['from'];
+      const secondLang = obj['to'];
+      const fromModelType = obj['files'];
+      arr[`${firstLang}${secondLang}`] = fromModelType;
+      // Assuming that all of the languages loaded from the registryUrl inside @internetarchive/bergamot-translator/translator.js are prod
+      // List of dev models found here https://github.com/mozilla/firefox-translations-models/tree/main/models/base
+      // There are also differences between the model types in the repo above here: https://github.com/mozilla/firefox-translations-models?tab=readme-ov-file#firefox-translations-models
+      if (firstLang !== "en") {
+        const name = `${toNativeName(firstLang)} (${toISO6391(firstLang)})`;
+        this.fromLanguages.push({code: firstLang, name: name, type: "prod"});
+      }
+      if (secondLang !== "en") {
+        const name = `${toNativeName(secondLang)} (${toISO6391(secondLang)})`;
+        this.toLanguages.push({code: secondLang, name: name, type: "prod"});
+      }
+    }
+    this._initResolve([this.modelRegistry]);
+    return this.initPromise;
+  }
+
+  /**
+   * Targets the page and paragraph of a text layer to create a translation from the "fromLang" to the "toLang". Tries to force order in translation by using the pageIndex (+1000 if the current page is not visible) and paragraphIndex
+   * @param {string} fromLang
+   * @param {string} toLang
+   * @param {string} pageIndex
+   * @param {number} paragraphIndex
+   * @param {string} text
+   * @param {number} priority
+   * @return {Promise<string>} translated text
+   */
+
+  getTranslation = async (fromLang, toLang, pageIndex, paragraphIndex, text, priority) => {
+    this.active = true;
+    if (fromLang == toLang || !fromLang || !toLang) {
+      return;
+    }
+    const key = `${fromLang}${toLang}-${pageIndex}:${paragraphIndex}`;
+    const cachedEntry = this.alreadyTranslated.entries.find(x => x.index == key);
+
+    if (cachedEntry) {
+      return cachedEntry.response;
+    }
+
+    if (key in this.currentlyTranslating) {
+      return this.currentlyTranslating[key].promise;
+    }
+
+    let _resolve = null;
+    let _reject = null;
+    const promise = new Promise((res, rej) => {
+      _resolve = res;
+      _reject = rej;
+    });
+
+    this.currentlyTranslating[key] = {
+      promise,
+      resolve: _resolve,
+      reject: _reject,
+    };
+
+    if (!text) {
+      this.currentlyTranslating[key].reject("No text was provided");
+      return promise;
+    }
+    this.translator.translate({
+      to: toLang,
+      from: fromLang,
+      text: text,
+      html: false,
+      priority: priority,
+    }).then((resp) => {
+      const response = resp;
+      this.currentlyTranslating[key].resolve(response.target.text);
+      this.alreadyTranslated.add({index: key, response: response.target.text});
+      delete this.currentlyTranslating[key];
+    });
+
+    return promise;
+  }
+
+  /**
+   * Checks and updates the status of a model that is currently being retreived from IA
+   * @param {string} fromLanguage
+   * @param {string} toLanguage
+   * @returns {Promise<boolean>}
+   */
+  getTranslationModel = async(fromLanguage, toLanguage) => {
+    return this.translator.backing.getTranslationModel({from: fromLanguage, to: toLanguage})
+      .catch((err) => {
+        console.error(`An error occurred while trying to retreive the ${fromLanguage}-${toLanguage} model`);
+      });
+  }
+}