@internetarchive/bookreader 5.0.0-12-fixsorting-8 → 5.0.0-120

package/src/BookReader/Navbar/Navbar.js

@@ -1,9 +1,11 @@
+// @ts-check
 /** @typedef {import("../../BookReader.js").default} BookReader */
 
 import 'jquery-ui/ui/widget.js';
 import 'jquery-ui/ui/widgets/mouse.js';
 import 'jquery-ui/ui/widgets/slider.js';
 import { EVENTS } from '../events.js';
+import { throttle } from '../utils.js';
 
 export class Navbar {
   /**
@@ -21,16 +23,23 @@ export class Navbar {
 
     /** @type {Object} controls will be switch over "this.maximumControls" */
     this.minimumControls = [
-      'viewmode'
+      'toggle_slider', 'viewmode',
     ];
     /** @type {Object} controls will be switch over "this.minimumControls" */
     this.maximumControls = [
-      'book_left', 'book_right', 'zoom_in', 'zoom_out', 'onepg', 'twopg', 'thumb'
+      'BRnavpos', 'book_left', 'book_right', 'zoom_in', 'zoom_out', 'onepg', 'twopg', 'thumb',
     ];
+
+    this.updateNavIndexThrottled = throttle(this.updateNavIndex.bind(this), 250, false);
   }
 
-  controlFor(controlName) {
-    const option = this.br.options.controls[controlName];
+  /**
+   * @param {string} controlName
+   * @param {Object} optionOverrides
+   */
+  controlFor(controlName, optionOverrides = null) {
+    const brOption = this.br.options.controls[controlName];
+    const option = Object.assign({},brOption, optionOverrides);
     if (!option.visible) { return ''; }
     if (option.template) {
       return `<li>${option.template(this.br)}</li>`;
@@ -38,7 +47,7 @@ export class Navbar {
     return `<li>
       <button class="BRicon ${option.className}" title="${option.label}">
         <div class="icon icon-${option.iconClassName}"></div>
-        <span class="tooltip">${option.label}</span>
+        <span class="BRtooltip">${option.label}</span>
       </button>
     </li>`;
   }
@@ -46,6 +55,7 @@ export class Navbar {
   /** @private */
   _renderControls() {
     return [
+      'toggleSlider',
       'bookLeft',
       'bookRight',
       'onePage',
@@ -112,11 +122,68 @@ export class Navbar {
       this.updateViewModeButton(
         $button,
         currentViewModeButton.className,
-        currentViewModeButton.title
+        currentViewModeButton.title,
       );
     });
   }
 
+  bindControlClickHandlers() {
+    const jIcons = this.$nav.find('.BRicon');
+
+    // Map of jIcon class -> click handler
+    const navigationControls = {
+      toggle_slider: () => {
+        this.br.toggleSlider();
+      },
+      book_left: this.br.left.bind(this.br),
+      book_right: this.br.right.bind(this.br),
+      book_top: this.br.first.bind(this.br),
+      book_bottom: this.br.last.bind(this.br),
+      book_leftmost: this.br.leftmost.bind(this.br),
+      book_rightmost: this.br.rightmost.bind(this.br),
+      onepg: () => {
+        this.br.switchMode('1up');
+      },
+      thumb: () => {
+        this.br.switchMode('thumb');
+      },
+      twopg: () => {
+        this.br.switchMode('2up');
+      },
+      zoom_in: () => {
+        this.br.trigger(EVENTS.stop);
+        this.br.zoom(1);
+        this.br.trigger(EVENTS.zoomIn);
+      },
+      zoom_out: () => {
+        this.br.trigger(EVENTS.stop);
+        this.br.zoom(-1);
+        this.br.trigger(EVENTS.zoomOut);
+      },
+      full: () => {
+        if (this.br.ui == 'embed') {
+          const url = this.br.$('.BRembedreturn a').attr('href');
+          window.open(url);
+        } else {
+          this.br.toggleFullscreen();
+        }
+      },
+    };
+
+    // custom event for auto-loan-renew in ia-book-actions
+    // - to know if user is actively reading
+    this.$nav.find('nav.BRcontrols li button').on('click', () => {
+      this.br.trigger(EVENTS.userAction);
+    });
+
+    for (const control in navigationControls) {
+      jIcons.filter(`.${control}`).on('click.bindNavigationHandlers', () => {
+        navigationControls[control]();
+        return false;
+      });
+    }
+  }
+
   /**
    * Toggle viewmode button to change page view
    */
@@ -127,7 +194,7 @@ export class Navbar {
       .removeClass()
       .addClass(`icon icon-${iconClass}`)
       .end()
-      .find('.tooltip')
+      .find('.BRtooltip')
       .text(tooltipText);
   }
 
@@ -135,44 +202,44 @@ export class Navbar {
    * Switch navbar controls on mobile and desktop
    */
   switchNavbarControls() {
+    // `$root` is null when `showNavbar` is off
+    if (!this.$root) return;
     // we don't want navbar controls switching with liner-notes
     if (this.br.options.bookType !== 'linerNotes') {
       if (this.br.refs.$brContainer.prop('clientWidth') < 640) {
-        this.showMinimumNavbarControls();
+        this.showMobileControls();
       } else {
-        this.showMaximumNavbarControls();
+        this.showDesktopControls();
       }
     }
   }
 
   /**
-   * Switch Book Navbar controls to minimised
-   * NOTE: only `this.minimumControls` and `this.maximumControls` switch on resize
+   * Switch Book controls to mobile mode
+   * NOTE: `this.minimumControls`, `this.maximumControls`, and .BRnavMobile switch on resize
    */
-  showMinimumNavbarControls() {
+  showMobileControls() {
     this.minimumControls.forEach((control) => {
-      const element = document.querySelector(`.controls .${control}`);
-      if (element) element.classList.remove('hide');
+      this.$root.find(`.BRnavMain .controls .${control}`).removeClass('hide');
     });
     this.maximumControls.forEach((control) => {
-      const element = document.querySelector(`.controls .${control}`);
-      if (element) element.classList.add('hide');
+      this.$root.find(`.BRnavMain .controls .${control}`).addClass('hide');
     });
+    this.$root.find('.BRnavMobile').removeClass('hide');
   }
 
   /**
-   * Switch Book Navbar controls to maximized
-   * NOTE: only `this.minimumControls` and `this.maximumControls` switch on resize
+   * Switch Book controls to desktop mode
+   * NOTE: `this.minimumControls`, `this.maximumControls`, and .BRnavMobile switch on resize
    */
-  showMaximumNavbarControls() {
+  showDesktopControls() {
     this.maximumControls.forEach((control) => {
-      const element = document.querySelector(`.controls .${control}`);
-      if (element) element.classList.remove('hide');
+      this.$root.find(`.BRnavMain .controls .${control}`).removeClass('hide');
     });
     this.minimumControls.forEach((control) => {
-      const element = document.querySelector(`.controls .${control}`);
-      if (element) element.classList.add('hide');
+      this.$root.find(`.BRnavMain .controls .${control}`).addClass('hide');
     });
+    this.$root.find('.BRnavMobile').addClass('hide');
   }
 
   /**
@@ -191,7 +258,7 @@ export class Navbar {
 
     br.refs.$BRfooter = this.$root = $(`<div class="BRfooter"></div>`);
     br.refs.$BRnav = this.$nav = $(
-      `<div class="BRnav BRnavDesktop">
+      `<div class="BRnav BRnavMobile docked">
           ${title ? `<div class="BRnavTitle">${title}</div>` : ''}
           <nav class="BRcontrols">
             <ul class="controls">
@@ -200,7 +267,24 @@ export class Navbar {
                   <div class="BRpager"></div>
                   <div class="BRnavline"></div>
                 </div>
-                <p><span class='BRcurrentpage'></span></p>
+              </li>
+              ${this.controlFor('bookLeft', {visible: true})}
+              ${this.controlFor('bookRight', {visible: true})}
+            </ul>
+          </nav>
+        </div>
+        <div class="BRnav BRnavMain">
+          ${title ? `<div class="BRnavTitle">${title}</div>` : ''}
+          <nav class="BRcontrols">
+            <ul class="controls">
+              <li class="scrubber">
+                <p>
+                  <span class="BRcurrentpage"></span>
+                </p>
+                <div class="BRnavpos hide">
+                  <div class="BRpager"></div>
+                  <div class="BRnavline"></div>
+                </div>
               </li>
               ${this._renderControls()}
             </ul>
@@ -210,63 +294,95 @@ export class Navbar {
     this.$root.append(this.$nav);
     br.refs.$br.append(this.$root);
 
-    const $slider = this.$root.find('.BRpager').slider({
+    this.br.on(EVENTS.beforePageChanged, (ev, { ariaLive }) => {
+      if (ariaLive) {
+        // So screen readers read out change
+        this.$root.find('.BRcurrentpage').attr('role', 'status');
+      } else {
+        this.$root.find('.BRcurrentpage').removeAttr('role');
+      }
+    });
+    this.br.on(EVENTS.pageChanged, (ev, { index }) => this.updateNavIndexThrottled(index));
+    br.options.controls.viewmode.visible && this._bindViewModeButton();
+    this.updateNavPageNum(br.currentIndex());
+
+    /** @type {JQuery} sliders */
+    const $sliders = this.$root.find('.BRpager').slider({
       animate: true,
       min: 0,
-      max: br.getNumLeafs() - 1,
+      max: Math.max(0, br.book.getNumLeafs() - 1),
       value: br.currentIndex(),
-      range: "min"
+      range: "min",
     });
 
-    $slider.on('slide', (event, ui) => {
-      this.updateNavPageNum(ui.value);
-      return true;
+    // The jQuery UI slider handles the keyboard shortcuts on the slider's
+    // handle, so need the aria labels there.
+    $sliders.find('.ui-slider-handle').attr({
+      'role': 'slider',
+      'aria-label': 'Page navigation slider',
+      'aria-valuemin': 0,
+      'aria-valuemax': Math.max(0, br.book.getNumLeafs() - 1),
     });
 
-    $slider.on('slidechange', (event, ui) => {
+    // Ignore up/down arrow keys and page up/down keys, since they're confusingly different
+    // between slider movement and page movement. Down decreases slider value, which would move
+    // the scroll _up_ in 1up.
+    $sliders.find('.ui-slider-handle').off('keydown').on('keydown', (event) => {
+      switch (event.keyCode || event.which) {
+      case $.ui.keyCode.LEFT:
+      case $.ui.keyCode.RIGHT:
+        // Forward along to the default handler
+        if (isRTL) {
+          // Swap left/right for RTL
+          if (event.keyCode === $.ui.keyCode.LEFT) {
+            event.keyCode = $.ui.keyCode.RIGHT;
+          } else {
+            event.keyCode = $.ui.keyCode.LEFT;
+          }
+        }
+        $.ui.slider.prototype._handleEvents.keydown.call($(event.target).parent().data('ui-slider'), event);
+        event.stopPropagation();
+        break;
+      default:
+        return;
+      }
+    });
+
+    $sliders.on('slide', (event, ui) => {
+      if (this.br.mode === this.br.constMode2up) {
+        // in 2up, need to go to nearest page that is left page
+        const movingForward = ui.value > br.currentIndex();
+        const newPage = this.br.book.getPage(ui.value);
+        if (isRTL ? newPage.pageSide === 'L' : newPage.pageSide === 'R') {
+          ui.value += movingForward ? 1 : -1;
+          ui.value = Math.max(0, Math.min(ui.value, br.book.getNumLeafs() - 1));
+        }
+      }
       this.updateNavPageNum(ui.value);
+    });
+
+    $sliders.on('slidechange', (event, ui) => {
       // recursion prevention for jumpToIndex
-      if ($slider.data('swallowchange')) {
-        $slider.data('swallowchange', false);
-      } else {
-        br.jumpToIndex(ui.value);
+      if ($(event.target).data('swallowchange')) {
+        $(event.target).data('swallowchange', false);
+        return;
       }
-      return true;
-    });
 
-    br.options.controls.viewmode.visible && this._bindViewModeButton();
-    this.updateNavPageNum(br.currentIndex());
+      if (this.br.mode === this.br.constMode2up) {
+        // in 2up, need to go to nearest page that is left page
+        const movingForward = ui.value > br.currentIndex();
+        const newPage = this.br.book.getPage(ui.value);
+        if (isRTL ? newPage.pageSide === 'L' : newPage.pageSide === 'R') {
+          ui.value += movingForward ? 1 : -1;
+          ui.value = Math.max(0, Math.min(ui.value, br.book.getNumLeafs() - 1));
+        }
+      }
 
-    return this.$nav;
-  }
+      // Don't want this to be aria-live since the slider already announces the value
+      this.br.jumpToIndex(ui.value, {ariaLive: false});
+    });
 
-  /**
-   * Initialize the navigation bar when embedded
-   */
-  initEmbed() {
-    const { br } = this;
-    // IA-specific
-    const thisLink = (window.location + '')
-      .replace('?ui=embed','')
-      .replace('/stream/', '/details/')
-      .replace('#', '/');
-    const logoHtml = br.showLogo ? `<a class="logo" href="${br.logoURL}" target="_blank"></a>` : '';
-
-    br.refs.$BRfooter = this.$root = $('<div class="BRfooter"></div>');
-    br.refs.$BRnav = this.$nav = $(
-      `<div class="BRnav BRnavEmbed">
-          ${logoHtml}
-          <span class="BRembedreturn">
-             <a href="${thisLink}" target="_blank">${br.bookTitle}</a>
-          </span>
-          <span class="BRtoolbarbuttons">
-            <button class="BRicon book_left"></button>
-            <button class="BRicon book_right"></button>
-            <button class="BRicon full"></button>
-          </span>
-      </div>`);
-    this.$root.append(this.$nav);
-    br.refs.$br.append(this.$root);
+    return this.$nav;
   }
 
   /**
@@ -276,17 +392,16 @@ export class Navbar {
   */
   getNavPageNumString(index) {
     const { br } = this;
-    // Accessible index starts at 0 (alas) so we add 1 to make human
-    const pageNum = br.getPageNum(index);
-    const pageType = br.getPageProp(index, 'pageType');
-    const numLeafs = br.getNumLeafs();
+    const pageNum = br.book.getPageNum(index);
+    const pageType = br.book.getPageProp(index, 'pageType');
+    const numLeafs = br.book.getNumLeafs();
 
     if (!this.maxPageNum) {
       // Calculate Max page num (used for pagination display)
       let maxPageNum = 0;
       let pageNumVal;
       for (let i = 0; i < numLeafs; i++) {
-        pageNumVal = br.getPageNum(i);
+        pageNumVal = parseFloat(br.book.getPageNum(i));
         if (!isNaN(pageNumVal) && pageNumVal > maxPageNum) {
           maxPageNum = pageNumVal;
         }
@@ -295,6 +410,7 @@ export class Navbar {
     }
 
     return getNavPageNumHtml(index, numLeafs, pageNum, pageType, this.maxPageNum);
+
   }
 
   /**
@@ -303,6 +419,10 @@ export class Navbar {
    */
   updateNavPageNum(index) {
     this.$root.find('.BRcurrentpage').html(this.getNavPageNumString(index));
+    this.$root.find('.ui-slider-handle').attr({
+      'aria-valuenow': index,
+      'aria-valuetext': this.getNavPageNumString(index),
+    });
   }
 
   /**
@@ -313,27 +433,27 @@ export class Navbar {
     // We want to update the value, but normally moving the slider
     // triggers jumpToIndex which triggers this method
     index = index !== undefined ? index : this.br.currentIndex();
-    this.$root.find('.BRpager').data('swallowchange', true).slider('value', index);
+    this.$root.find('.BRpager').data('swallowchange', true);
+    this.$root.find('.BRpager').slider('value', index);
+    this.updateNavPageNum(index);
   }
 }
 
 /**
  * Renders the html for the page string
- * @param {number} index
- * @param {number} numLeafs
+ * @param {PageIndex} index 0-indexed page index (0..numLeafs-1)
+ * @param {number} numLeafs total number of leaves
  * @param {number|string} pageNum
- * @param {*} pageType @deprecated
+ * @param {*} pageType - Deprecated
  * @param {number} maxPageNum
- * @return {string}
+ * @return {string} e.g. "Page 14 (3/39)"
  */
 export function getNavPageNumHtml(index, numLeafs, pageNum, pageType, maxPageNum) {
   const pageIsAsserted = pageNum[0] != 'n';
 
   if (!pageIsAsserted) {
-    const pageIndex = index + 1;
-    return `(${pageIndex} of ${numLeafs})`; // Page (8 of 10)
+    pageNum = '—';
   }
-
-  const bookLengthLabel = maxPageNum ? ` of ${maxPageNum}` : '';
-  return `${pageNum}${bookLengthLabel}`;
+  const lastIndex = Math.max(0, numLeafs - 1);
+  return `Page ${pageNum} (${index}/${lastIndex})`;
 }

package/src/BookReader/PageContainer.js

@@ -2,6 +2,8 @@
 /** @typedef {import('./BookModel.js').PageModel} PageModel */
 /** @typedef {import('./ImageCache.js').ImageCache} ImageCache */
 
+import { sleep } from './utils.js';
+
 
 export class PageContainer {
   /**
@@ -9,16 +11,17 @@ export class PageContainer {
    * @param {object} opts
    * @param {boolean} opts.isProtected Whether we're in a protected book
    * @param {ImageCache} opts.imageCache
-   * @param {string} opts.loadingImage
    */
-  constructor(page, {isProtected, imageCache, loadingImage}) {
+  constructor(page, {isProtected, imageCache}) {
     this.page = page;
     this.imageCache = imageCache;
-    this.loadingImage = loadingImage;
     this.$container = $('<div />', {
       'class': `BRpagecontainer ${page ? `pagediv${page.index}` : 'BRemptypage'}`,
       css: { position: 'absolute' },
-    }).attr('data-side', page?.pageSide);
+    })
+      .attr('data-side', page?.pageSide)
+      .attr('data-index', page?.index)
+      .attr('data-page-num', page?.getPageNum());
 
     if (isProtected) {
       this.$container.append($('<div class="BRscreen" />'));
@@ -43,33 +46,127 @@ export class PageContainer {
       return;
     }
 
-    const alreadyLoaded = this.imageCache.imageLoaded(this.page.index, reduce);
-    const nextBestLoadedReduce = !alreadyLoaded && this.imageCache.getBestLoadedReduce(this.page.index, reduce);
+    const finalReduce = this.imageCache.getFinalReduce(this.page.index, reduce);
+    const newImageURI = this.page.getURI(finalReduce, 0);
 
-    // Add the actual, highres image
-    this.$img?.remove();
-    this.$img = this.imageCache
-      .image(this.page.index, reduce)
-      .prependTo(this.$container);
+    // Note: These must be computed _before_ we call .image()
+    const alreadyLoaded = this.imageCache.imageLoaded(this.page.index, finalReduce);
+    const nextBestLoadedReduce = this.imageCache.getBestLoadedReduce(this.page.index, reduce);
 
-    const backgroundLayers = [];
-    if (!alreadyLoaded) {
-      this.$container.addClass('BRpageloading');
-      backgroundLayers.push(`url("${this.loadingImage}") center/20px no-repeat`);
+    // Avoid removing/re-adding the image if it's already there
+    // This can be called quite a bit, so we need to be fast
+    if (this.$img?.data('src') == newImageURI) {
+      return this;
     }
-    if (nextBestLoadedReduce) {
-      backgroundLayers.push(`url("${this.page.getURI(nextBestLoadedReduce, 0)}") center/100% no-repeat`);
+
+    let $oldImg = this.$img;
+    this.$img = this.imageCache.image(this.page.index, finalReduce);
+    if ($oldImg) {
+      this.$img.insertAfter($oldImg);
+    } else {
+      this.$img.prependTo(this.$container);
     }
 
     if (!alreadyLoaded) {
-      this.$img
-        .css('background', backgroundLayers.join(','))
-        .one('loadend', async (ev) => {
-          $(ev.target).css({ 'background': '' });
-          $(ev.target).parent().removeClass('BRpageloading');
-        });
+      this.$container.addClass('BRpageloading');
     }
 
+    if (!alreadyLoaded && nextBestLoadedReduce) {
+      // If we have a slightly lower quality image loaded, use that as the background
+      // while the higher res one loads
+      const nextBestUri = this.page.getURI(nextBestLoadedReduce, 0);
+      if ($oldImg) {
+        if ($oldImg.data('src') == nextBestUri) {
+          // Do nothing! It's already showing the right thing
+        } else {
+          // We have a different src, need to update the src
+          this.imageCache.image(this.page.index, nextBestLoadedReduce, $oldImg[0]);
+        }
+      } else {
+        // We don't have an old <img>, so we need to create a new one
+        $oldImg = this.imageCache.image(this.page.index, nextBestLoadedReduce);
+        $oldImg.prependTo(this.$container);
+      }
+    }
+
+    this.$img
+      .one('load', async (ev) => {
+        this.$container.removeClass('BRpageloading');
+        // `load` can fire a little early, so wait a spell before removing the old image
+        // to avoid flicker
+        await sleep(100);
+        $oldImg?.remove();
+      });
+
     return this;
   }
 }
+
+
+/**
+ * @param {PageModel} page
+ * @param {string} className
+ */
+export function createSVGPageLayer(page, className) {
+  const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
+  svg.setAttribute("xmlns", "http://www.w3.org/2000/svg");
+  svg.setAttribute("viewBox", `0 0 ${page.width} ${page.height}`);
+  svg.setAttribute('class', `BRPageLayer ${className}`);
+  svg.setAttribute('preserveAspectRatio', 'none');
+  return svg;
+}
+
+/**
+ * @param {PageModel} page
+ * @param {string} className
+ */
+export function createDIVPageLayer(page, className) {
+  const div = document.createElement("div");
+  div.style.width = `${page.width}px`;
+  div.style.height = `${page.height}px`;
+  div.setAttribute('class', `BRPageLayer ${className}`);
+  return div;
+}
+
+/**
+ * @param {{ l: number, r: number, b: number, t: number }} box
+ */
+export function boxToSVGRect({ l: left, r: right, b: bottom, t: top }) {
+  const rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+  rect.setAttribute("x", left.toString());
+  rect.setAttribute("y", top.toString());
+  rect.setAttribute("width", (right - left).toString());
+  rect.setAttribute("height", (bottom - top).toString());
+
+  // Some style; corner radius 4px. Can't set this in CSS yet
+  rect.setAttribute("rx", "4");
+  rect.setAttribute("ry", "4");
+  return rect;
+}
+
+/**
+ * @param {string} layerClass
+ * @param {Array<{ l: number, r: number, b: number, t: number }>} boxes
+ * @param {PageModel} page
+ * @param {HTMLElement} containerEl
+ * @param {string[]} [rectClasses] CSS classes to add to the rects
+ */
+export function renderBoxesInPageContainerLayer(layerClass, boxes, page, containerEl, rectClasses = null) {
+  const mountedSvg = containerEl.querySelector(`.${layerClass}`);
+  // Create the layer if it's not there
+  const svg = mountedSvg || createSVGPageLayer(page, layerClass);
+  if (!mountedSvg) {
+    // Insert after the image if the image is already loaded.
+    const imgEl = containerEl.querySelector('.BRpageimage');
+    if (imgEl) $(svg).insertAfter(imgEl);
+    else $(svg).prependTo(containerEl);
+  }
+
+  for (const [i, box] of boxes.entries()) {
+    const rect = boxToSVGRect(box);
+    if (rectClasses) {
+      rect.setAttribute('class', rectClasses[i]);
+    }
+    svg.appendChild(rect);
+  }
+}

package/src/BookReader/ReduceSet.js

@@ -7,7 +7,7 @@
 /** @type {ReduceSet} */
 export const IntegerReduceSet = {
   floor: Math.floor,
-  decr(n) { return n - 1; }
+  decr(n) { return n - 1; },
 };
 
 /** @type {ReduceSet} */
@@ -17,7 +17,7 @@ export const Pow2ReduceSet = {
   },
   decr(n) {
     return 2 ** (Math.log2(n) - 1);
-  }
+  },
 };
 
 export const NAMED_REDUCE_SETS = {