bookreader 1.0.1

data/vendor/assets/javascripts/plugins/plugin.chapters.js

@@ -0,0 +1,197 @@
+/**
+ * Plugin for chapter markers in BookReader. Fetches from openlibrary.org
+ * Could be forked, or extended to alter behavior
+ */
+
+jQuery.extend(BookReader.defaultOptions, {
+    olHost: 'https://openlibrary.org',
+    enableChaptersPlugin: true,
+    bookId: '',
+});
+
+// Extend the constructor to add search properties
+BookReader.prototype.setup = (function (super_) {
+    return function (options) {
+        super_.call(this, options);
+
+        this.olHost = options.olHost;
+        this.enableChaptersPlugin = options.enableChaptersPlugin;
+        this.bookId = options.bookId;
+    };
+})(BookReader.prototype.setup);
+
+
+// Extend br.init to call Open Library for TOC
+BookReader.prototype.init = (function(super_) {
+  return function() {
+    super_.call(this);
+
+    if (this.enableChaptersPlugin && this.ui !== 'embed') {
+      this.getOpenLibraryRecord(this.gotOpenLibraryRecord);
+    }
+  }
+})(BookReader.prototype.init);
+
+
+BookReader.prototype.addChapter = function(chapterTitle, pageNumber, pageIndex) {
+    var uiStringPage = 'Page'; // i18n
+    var self = this;
+
+    var percentThrough = BookReader.util.cssPercentage(pageIndex, this.getNumLeafs() - 1);
+
+    $('<div>'
+        + '<div>'
+        +   'Chapter: '
+        +    chapterTitle
+        +    ' | '
+        +    uiStringPage
+        +    ' '
+        +    pageNumber
+        +   '</div>'
+        + '</div>'
+    )
+    .addClass('BRchapter')
+    .css({
+        left: percentThrough,
+    })
+    .appendTo(this.$('.BRnavline'))
+    .data({'self': this, 'pageIndex': pageIndex })
+    .bt({
+        contentSelector: '$(this).find("> div")',
+        trigger: 'hover',
+        closeWhenOthersOpen: true,
+        cssStyles: {
+            padding: '12px 14px',
+            backgroundColor: '#fff',
+            border: '4px solid rgb(216,216,216)',
+            color: 'rgb(52,52,52)'
+        },
+        shrinkToFit: false,
+        width: '230px',
+        padding: 0,
+        spikeGirth: 0,
+        spikeLength: 0,
+        overlap: '0px',
+        overlay: false,
+        killTitle: false,
+        offsetParent: null,
+        positions: ['top'],
+        fill: 'white',
+        windowMargin: 10,
+        strokeWidth: 0,
+        cornerRadius: 0,
+        centerPointX: 0,
+        centerPointY: 0,
+        shadow: false
+    })
+    .hover(
+        function() {
+            // remove hover effect from other markers then turn on just for this
+            self.$('.BRsearch,.BRchapter').removeClass('front');
+            $(this).addClass('front');
+        },
+        function() {
+            $(this).removeClass('front');
+        }
+    )
+    .bind('click', function() {
+        self.jumpToIndex($(this).data('pageIndex'));
+    });
+};
+
+/*
+ * Remove all chapters.
+ */
+BookReader.prototype.removeChapters = function() {
+    this.$('.BRnavpos .BRchapter').remove();
+};
+
+/*
+ * Update the table of contents based on array of TOC entries.
+ */
+BookReader.prototype.updateTOC = function(tocEntries) {
+    this.removeChapters();
+    for (var i = 0; i < tocEntries.length; i++) {
+        this.addChapterFromEntry(tocEntries[i]);
+    }
+};
+
+/*
+ *   Example table of contents entry - this format is defined by Open Library
+ *   {
+ *       "pagenum": "17",
+ *       "level": 1,
+ *       "label": "CHAPTER I",
+ *       "type": {"key": "/type/toc_item"},
+ *       "title": "THE COUNTRY AND THE MISSION"
+ *   }
+ */
+BookReader.prototype.addChapterFromEntry = function(tocEntryObject) {
+    var pageIndex = this.getPageIndex(tocEntryObject['pagenum']);
+    // Only add if we know where it is
+    if (pageIndex) {
+        this.addChapter(tocEntryObject['title'], tocEntryObject['pagenum'], pageIndex);
+    }
+    this.$('.BRchapter').each(function(){
+        $(this).hover(function(){
+            $(this).addClass('front');
+        },function(){
+            $(this).removeClass('front');
+        });
+    });
+    this.$('.BRsearch').each(function(){
+        $(this).hover(function(){
+            $(this).addClass('front');
+        },function(){
+            $(this).removeClass('front');
+        });
+    });
+};
+
+// getOpenLibraryRecord
+//
+// The bookreader is designed to call openlibrary API and constructs the
+// "Return book" button using the response.
+//
+// This makes a call to OL API and calls the given callback function with the
+// response from the API.
+BookReader.prototype.getOpenLibraryRecord = function(callback) {
+  // Try looking up by ocaid first, then by source_record
+  var self = this; // closure
+  var jsonURL = self.olHost + '/query.json?type=/type/edition&*=&ocaid=' + self.bookId;
+  $.ajax({
+    url: jsonURL,
+    success: function(data) {
+      if (data && data.length > 0) {
+        callback(self, data[0]);
+      } else {
+        // try sourceid
+        jsonURL = self.olHost + '/query.json?type=/type/edition&*=&source_records=ia:' + self.bookId;
+        $.ajax({
+          url: jsonURL,
+          success: function(data) {
+            if (data && data.length > 0) {
+              callback(self, data[0]);
+            }
+          },
+          dataType: 'jsonp'
+        });
+      }
+    },
+    dataType: 'jsonp'
+  });
+}
+
+/*
+ * Update based on received record from Open Library.
+ * Open Library record is used for extra metadata, and also for lending
+ */
+BookReader.prototype.gotOpenLibraryRecord = function(self, olObject) {
+  // $$$ could refactor this so that 'this' is available
+  if (olObject) {
+    if (olObject.table_of_contents) {
+      // XXX check here that TOC is valid
+      self.updateTOC(olObject.table_of_contents);
+    }
+  }
+}

data/vendor/assets/javascripts/plugins/plugin.iframe.js

@@ -0,0 +1,73 @@
+/**
+ * Plugin for two-way communication between a BookReader in an IFrame and the
+ * parent web page
+ */
+(function setUpIframePlugin() {
+    var constMessageTypeFragmentChange = 'bookReaderFragmentChange';
+
+    BookReader.prototype.init = (function(super_) {
+        return function() {
+            super_.call(this);
+            attachEventListeners(this);
+        };
+    })(BookReader.prototype.init);
+
+    /**
+     * Using window.postMessage() and event listeners, the plugin notifies the
+     * parent window when pages change, and the parent window can also
+     * explicitly request a page change by sending its own message.
+     *
+     * @param {BookReader} br
+     * @private
+     */
+    function attachEventListeners(br) {
+        // Not embedded, abort
+        if (!window.parent) {
+            return;
+        }
+
+        br.bind(BookReader.eventNames.fragmentChange, function() {
+            var fragment = br.fragmentFromParams(br.paramsFromCurrent());
+
+            window.parent.postMessage(
+                createWindowMessage(constMessageTypeFragmentChange, {
+                    fragment: fragment
+                }),
+                '*'
+            );
+        });
+
+        window.addEventListener('message', function updatePath(event) {
+            // Not a recognized message type, abort
+            if (
+                !event.data ||
+                event.data.type !== constMessageTypeFragmentChange
+            ) {
+                return;
+            }
+
+            br.updateFromParams(br.paramsFromFragment(event.data.fragment));
+        });
+    }
+
+    /**
+     * Create a message that can be sent to the parent window via
+     * window.postMessage()
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
+     *
+     * @param {String} type
+     * @param {Object} props
+     * @returns {Object}
+     * @private
+     */
+    function createWindowMessage(type, props) {
+        const message = { type };
+
+        Object.keys(props).forEach(function(prop) {
+            message[prop] = props[prop]
+        });
+
+        return message;
+    }
+})();

data/vendor/assets/javascripts/plugins/plugin.mobile_nav.js

@@ -0,0 +1,197 @@
+/**
+ * Adds mobile navigation at responsive breakpoint
+ * NOTE additional script and style tags must be included.
+ *
+ * <script src="../BookReader/mmenu/dist/js/jquery.mmenu.min.js"></script>
+ * <script src="../BookReader/mmenu/dist/addons/navbars/jquery.mmenu.navbars.min.js"></script>
+ * <link rel="stylesheet" href="../BookReader/mmenu/dist/css/jquery.mmenu.css" />
+ * <link rel="stylesheet" href="../BookReader/mmenu/dist/addons/navbars/jquery.mmenu.navbars.css" />
+ */
+
+jQuery.extend(BookReader.defaultOptions, {
+    enableMobileNav: true,
+    mobileNavTitle: 'Internet Archive',
+    mobileNavFullscreenOnly: false,
+});
+
+BookReader.prototype.setup = (function(super_) {
+    return function (options) {
+        super_.call(this, options);
+
+        this.enableMobileNav = options.enableMobileNav;
+        this.mobileNavTitle = options.mobileNavTitle;
+        this.mobileNavFullscreenOnly = options.mobileNavFullscreenOnly;
+
+        this.refs.$mmenu = null;
+    };
+})(BookReader.prototype.setup);
+
+
+// Extend initToolbar
+BookReader.prototype.initToolbar = (function (super_) {
+    return function (mode, ui) {
+        var self = this;
+
+        if (this.enableMobileNav) {
+            var $drawerEl = this.buildMobileDrawerElement();
+            this.refs.$br.append($drawerEl);
+
+            // Render info into mobile info before mmenu
+            this.buildInfoDiv(this.$('.BRmobileInfo'));
+            this.buildShareDiv(this.$('.BRmobileShare'));
+
+            var $mmenuEl = $drawerEl;
+            $mmenuEl.mmenu({
+              navbars: [
+                 { "position": "top" },
+              ],
+              navbar: {
+                add: true,
+                title: this.mobileNavTitle,
+                titleLink: 'panel'
+              },
+              extensions: [ "panelshadow" ],
+            }, {
+              offCanvas: {
+                wrapPageIfNeeded: false,
+                zposition: 'next',
+                pageSelector: this.el,
+              }
+            });
+
+            var $BRpageviewField = $mmenuEl.find('.BRpageviewValue');
+            $mmenuEl.data('mmenu').bind('opened', function() {
+                // Update "Link to this page view" link
+                if ($BRpageviewField.length)
+                    $BRpageviewField.val(window.location.href);
+            });
+
+            // High contrast button
+            $drawerEl.find('.high-contrast-button').click(function() {
+                self.refs.$br.toggleClass('high-contrast');
+            });
+
+            // Bind mobile switch buttons
+            $drawerEl.find('.DrawerLayoutButton.one_page_mode').click(function() {
+                self.switchMode(self.constMode1up);
+            });
+            $drawerEl.find('.DrawerLayoutButton.two_page_mode').click(function() {
+                self.switchMode(self.constMode2up);
+            });
+            $drawerEl.find('.DrawerLayoutButton.thumbnail_mode').click(function() {
+                self.switchMode(self.constModeThumb);
+            });
+
+            if (this.mobileNavFullscreenOnly) {
+                $(document.body).addClass('BRbodyMobileNavEnabledFullscreen');
+            } else {
+                $(document.body).addClass('BRbodyMobileNavEnabled');
+            }
+
+            this.refs.$mmenu = $mmenuEl;
+        }
+
+        // Call the parent method at the end, because it binds events to DOM
+        super_.apply(this, arguments);
+
+
+        if (this.enableMobileNav) {
+            // Need to bind more, console after toolbar is initialized
+            this.$('.BRmobileHamburger').click(function() {
+                if ($mmenuEl.data('mmenu').getInstance().vars.opened) {
+                    $mmenuEl.data('mmenu').close();
+                } else {
+                    $mmenuEl.data('mmenu').open();
+                }
+            })
+        }
+    };
+})(BookReader.prototype.initToolbar);
+
+
+BookReader.prototype.buildToolbarElement = (function (super_) {
+    return function () {
+        var $el = super_.call(this);
+        if (this.enableMobileNav) {
+            var escapedTitle = BookReader.util.escapeHTML(this.bookTitle);
+            $el
+            .addClass('responsive')
+            .prepend($(
+                   "<span class='BRmobileHamburgerWrapper'>"
+                +     "<button class=\"BRmobileHamburger\"></button>"
+                +     "<span class=\"BRtoolbarMobileTitle\" title=\""+escapedTitle+"\">" + this.bookTitle + "</span>"
+                +   "</span>"
+            ));
+        }
+        return $el;
+    };
+})(BookReader.prototype.buildToolbarElement);
+
+/**
+ * This method builds the html for the mobile drawer. It can be decorated to
+ * extend the default drawer.
+ * @return {jqueryElement}
+ */
+BookReader.prototype.buildMobileDrawerElement = function() {
+    var experimentalHtml = '';
+    if (this.enableExperimentalControls) {
+      experimentalHtml += "<div class=\"DrawerSettingsTitle\">Experimental (may not work)</div>"
+        +"        <button class='BRaction default high-contrast-button'>Toggle high contrast</button>";
+    }
+
+    var $el = $(
+      "<nav id=\"BRmobileMenu\" class=\"BRmobileMenu\">"
+      +"  <ul>"
+      +"    <li>"
+      +"      <span>"
+      +"        <span class=\"DrawerIconWrapper \"><img class=\"DrawerIcon\" src=\""+this.imagesBaseURL+"icon_gear.svg\" alt=\"settings-icon\"/></span>"
+      +"        Settings"
+      +"      </span>"
+      +"      <div class=\"DrawerSettingsWrapper\">"
+      +"        <div class=\"DrawerSettingsTitle\">Page Layout</div>"
+      +"        <div class=\"DrawerSettingsLayoutWrapper\">"
+      +"          <button class=\"DrawerLayoutButton one_page_mode\"><img class=\"\" src=\""+this.imagesBaseURL+"icon_one_page.svg\" alt=\"Single Page\"/><br>One Page</button>"
+      +"          <button class=\"DrawerLayoutButton two_page_mode TwoPagesButton\"><img class=\"\" src=\""+this.imagesBaseURL+"icon_two_pages.svg\" alt=\"Two Pages\"/><br>Two Pages</button>"
+      +"          <button class=\"DrawerLayoutButton thumbnail_mode\"><img class=\"\" src=\""+this.imagesBaseURL+"icon_thumbnails.svg\" alt=\"Thumbnails\"/><br>Thumbnails</button>"
+      +"        </div>"
+      +"        <br>"
+      +"        <div class=\"DrawerSettingsTitle\">Zoom</div>"
+      +"        <button class='BRicon zoom_out'></button>"
+      +"        <button class='BRicon zoom_in'></button>"
+      +"        <br style='clear:both'><br><br>"
+      +         experimentalHtml
+      +"      </div>"
+      +"    </li>"
+      +"    <li class='BRmobileMenu__moreInfoRow'>"
+      +"      <span>"
+      +"        <span class=\"DrawerIconWrapper \"><img class=\"DrawerIcon\" src=\""+this.imagesBaseURL+"icon_info.svg\" alt=\"info-icon\"/></span>"
+      +"        About This Book"
+      +"      </span>"
+      +"      <div class=\"BRmobileInfo\"></div>"
+      +"    </li>"
+      +"    <li>"
+      +"      <span>"
+      +"        <span class=\"DrawerIconWrapper \"><img class=\"DrawerIcon\" src=\""+this.imagesBaseURL+"icon_share.svg\" alt=\"info-share\"/></span>"
+      +"        Share This Book"
+      +"      </span>"
+      +"      <div class=\"BRmobileShare\"></div>"
+      +"    </li>"
+      +"  </ul>"
+      +"</nav>"
+    );
+    return $el;
+};
+
+/**
+ * Mmenu moves itself out side of the root BookReader element, so we need to
+ * include it in the scoped $ function.
+ */
+BookReader.prototype.$ = (function (super_) {
+    return function (arg) {
+        var $results = super_.call(this, arg);
+        if (this.refs.$mmenu) {
+            $results = $results.add(this.refs.$mmenu.find(arg));
+        }
+        return $results;
+    };
+})(BookReader.prototype.$);

data/vendor/assets/javascripts/plugins/plugin.print.js

@@ -0,0 +1,70 @@
+/**
+ * Adds some print features to bookreader
+ *
+ * To bind it to a button, use code like this:
+ *     jIcons.filter('.print').click(function(e) {
+ *         self.printPage();
+ *       return false;
+ *   });
+ */
+
+jQuery.extend(BookReader.defaultOptions, {
+    imageFormat: 'jp2',
+    subPrefix: '',
+    server: '',
+    zip: '',
+});
+
+// Extend the constructor to add search properties
+BookReader.prototype.setup = (function (super_) {
+    return function (options) {
+        super_.call(this, options);
+
+        this.imageFormat = options.imageFormat;
+        this.subPrefix = options.subPrefix;
+        this.server = options.server;
+        this.zip = options.zip;
+    };
+})(BookReader.prototype.setup);
+
+//______________________________________________________________________________
+BookReader.prototype.printPage = function() {
+    window.open(this.getPrintURI(), 'printpage', 'width=400, height=500, resizable=yes, scrollbars=no, toolbar=no, location=no');
+};
+
+// Get print URI from current indices and mode
+BookReader.prototype.getPrintURI = function() {
+    var indexToPrint;
+    if (this.constMode2up == this.mode) {
+        indexToPrint = this.twoPage.currentIndexL;
+    } else {
+        indexToPrint = this.firstIndex; // $$$ the index in the middle of the viewport would make more sense
+    }
+
+    var options = 'id=' + this.subPrefix + '&server=' + this.server + '&zip=' + this.zip
+        + '&format=' + this.imageFormat + '&file=' + this.getPageFile(indexToPrint)
+        + '&width=' + this._getPageWidth(indexToPrint) + '&height=' + this._getPageHeight(indexToPrint);
+
+    if (this.constMode2up == this.mode) {
+        options += '&file2=' + this.getPageFile(this.twoPage.currentIndexR) + '&width2=' + this._getPageWidth(this.twoPage.currentIndexR);
+        options += '&height2=' + this._getPageHeight(this.twoPage.currentIndexR);
+        options += '&title=' + encodeURIComponent(this.shortTitle(50) + ' - Pages ' + this.getPageNum(this.twoPage.currentIndexL) + ', ' + this.getPageNum(this.twoPage.currentIndexR));
+    } else {
+        options += '&title=' + encodeURIComponent(this.shortTitle(50) + ' - Page ' + this.getPageNum(indexToPrint));
+    }
+
+    return '/bookreader/print.php?' + options;
+};
+
+BookReader.prototype.getPageFile = function(index) {
+  if (index === null) {
+    return '';
+  }
+  var leafStr = '0000';
+  var imgStr = String(index); //String(this._leafMap[index]); // if index != leafNum
+  var re = new RegExp("0{"+imgStr.length+"}$");
+  var insideZipPrefix = this.subPrefix.match('[^/]+$');
+  var file = insideZipPrefix + '_' + this.imageFormat + '/' + insideZipPrefix +
+             '_' + leafStr.replace(re, imgStr) + '.' + this.imageFormat;
+  return file;
+}

data/vendor/assets/javascripts/plugins/plugin.resume.js

@@ -0,0 +1,73 @@
+/**
+ * Plugin to remember the current page in a cookie
+ */
+
+jQuery.extend(BookReader.defaultOptions, {
+    enablePageResume: true,
+    /**
+     * @var null|string eg '/', '/details/id'
+     */
+    resumeCookiePath: null,
+});
+
+BookReader.prototype.init = (function(super_) {
+    return function() {
+        super_.call(this);
+        if (this.options.enablePageResume) {
+            this.bind(BookReader.eventNames.fragmentChange, function() {
+                var params = this.paramsFromCurrent();
+                this.updateResumeValue(params.index);
+            }.bind(this));
+        }
+    };
+})(BookReader.prototype.init);
+
+/**
+ * Get's the page resume value, for remembering reader's page
+ * Can be overriden for different implementation
+ * @return {Number|null}
+ */
+BookReader.prototype.getResumeValue = function() {
+    var val = BookReader.docCookies.getItem('br-resume');
+    if (val !== null) return parseInt(val);
+    else return null;
+}
+
+/**
+ * Set's the page resume value, for remembering reader's page
+ * Can be overriden for different implementation
+ * @param {Number} the leaf index
+ */
+BookReader.prototype.updateResumeValue = function(index, cookieName) {
+    var ttl = new Date(+new Date + 12096e5); // 2 weeks
+    var path = this.options.resumeCookiePath || window.location.pathname;
+    cookieName = cookieName || 'br-resume';
+    BookReader.docCookies.setItem(cookieName, index, ttl, path, null, false);
+}
+
+/*\
+|*|  https://developer.mozilla.org/en-US/docs/Web/API/document.cookie
+|*|  https://developer.mozilla.org/User:fusionchess
+|*|  https://github.com/madmurphy/cookies.js
+|*|  This framework is released under the GNU Public License, version 3 or later.
+|*|  http://www.gnu.org/licenses/gpl-3.0-standalone.html
+\*/
+BookReader.docCookies = {
+  getItem: function (sKey) {
+    if (!sKey) { return null; }
+    return decodeURIComponent(document.cookie.replace(new RegExp("(?:(?:^|.*;)\\s*" + encodeURIComponent(sKey).replace(/[\-\.\+\*]/g, "\\$&") + "\\s*\\=\\s*([^;]*).*$)|^.*$"), "$1")) || null;
+  },
+  setItem: function (sKey, sValue, vEnd, sPath, sDomain, bSecure) {
+    var sExpires = "";
+    if (vEnd) {
+      sExpires = "; expires=" + vEnd.toUTCString();
+    }
+    document.cookie = encodeURIComponent(sKey) + "=" + encodeURIComponent(sValue) + sExpires + (sDomain ? "; domain=" + sDomain : "") + (sPath ? "; path=" + sPath : "") + (bSecure ? "; secure" : "");
+    return true;
+  },
+  removeItem: function (sKey, sPath, sDomain) {
+    if (!this.hasItem(sKey)) { return false; }
+    document.cookie = encodeURIComponent(sKey) + "=; expires=Thu, 01 Jan 1970 00:00:00 GMT" + (sDomain ? "; domain=" + sDomain : "") + (sPath ? "; path=" + sPath : "");
+    return true;
+  },
+};