Browse Source

Merge pull request #5971 from yurydelendik/refact-hist-link

Extracts PDFLinkService and PDFHistory APIs
Jonas Jenwald 10 years ago
parent
commit
189ef974b1
  1. 17
      web/interfaces.js
  2. 52
      web/pdf_history.js
  3. 293
      web/pdf_link_service.js
  4. 12
      web/pdf_viewer.component.js
  5. 11
      web/pdf_viewer.js
  6. 15
      web/ui_utils.js
  7. 1
      web/viewer.html
  8. 330
      web/viewer.js

17
web/interfaces.js

@ -51,6 +51,23 @@ IPDFLinkService.prototype = {
* @param {string} action * @param {string} action
*/ */
executeNamedAction: function (action) {}, executeNamedAction: function (action) {},
/**
* @param {number} pageNum - page number.
* @param {Object} pageRef - reference to the page.
*/
cachePageRef: function (pageNum, pageRef) {},
};
/**
* @interface
*/
function IPDFHistory() {}
IPDFHistory.prototype = {
forward: function () {},
back: function () {},
push: function (params) {},
updateNextHashParam: function (hash) {},
}; };
/** /**

52
web/pdf_history.js

@ -17,15 +17,21 @@
'use strict'; 'use strict';
var PDFHistory = { var PDFHistory = (function () {
initialized: false, function PDFHistory(options) {
initialDestination: null, this.linkService = options.linkService;
this.initialized = false;
this.initialDestination = null;
this.initialBookmark = null;
}
PDFHistory.prototype = {
/** /**
* @param {string} fingerprint * @param {string} fingerprint
* @param {IPDFLinkService} linkService * @param {IPDFLinkService} linkService
*/ */
initialize: function pdfHistoryInitialize(fingerprint, linkService) { initialize: function pdfHistoryInitialize(fingerprint) {
this.initialized = true; this.initialized = true;
this.reInitialized = false; this.reInitialized = false;
this.allowHashChange = true; this.allowHashChange = true;
@ -41,7 +47,6 @@ var PDFHistory = {
this.nextHashParam = ''; this.nextHashParam = '';
this.fingerprint = fingerprint; this.fingerprint = fingerprint;
this.linkService = linkService;
this.currentUid = this.uid = 0; this.currentUid = this.uid = 0;
this.current = {}; this.current = {};
@ -52,7 +57,7 @@ var PDFHistory = {
if (state.target.dest) { if (state.target.dest) {
this.initialDestination = state.target.dest; this.initialDestination = state.target.dest;
} else { } else {
linkService.setHash(state.target.hash); this.initialBookmark = state.target.hash;
} }
this.currentUid = state.uid; this.currentUid = state.uid;
this.uid = state.uid + 1; this.uid = state.uid + 1;
@ -65,7 +70,7 @@ var PDFHistory = {
// is opened in the web viewer. // is opened in the web viewer.
this.reInitialized = true; this.reInitialized = true;
} }
this._pushOrReplaceState({ fingerprint: this.fingerprint }, true); this._pushOrReplaceState({fingerprint: this.fingerprint}, true);
} }
var self = this; var self = this;
@ -88,8 +93,8 @@ var PDFHistory = {
if (self.uid === 0) { if (self.uid === 0) {
var previousParams = (self.previousHash && self.currentBookmark && var previousParams = (self.previousHash && self.currentBookmark &&
self.previousHash !== self.currentBookmark) ? self.previousHash !== self.currentBookmark) ?
{ hash: self.currentBookmark, page: self.currentPage } : {hash: self.currentBookmark, page: self.currentPage} :
{ page: 1 }; {page: 1};
self.historyUnlocked = false; self.historyUnlocked = false;
self.allowHashChange = false; self.allowHashChange = false;
window.history.back(); window.history.back();
@ -97,7 +102,7 @@ var PDFHistory = {
window.history.forward(); window.history.forward();
self.historyUnlocked = true; self.historyUnlocked = true;
} }
self._pushToHistory({ hash: self.previousHash }, false, true); self._pushToHistory({hash: self.previousHash}, false, true);
self._updatePreviousBookmark(); self._updatePreviousBookmark();
} }
}, false); }, false);
@ -112,14 +117,16 @@ var PDFHistory = {
} }
// Remove the event listener when navigating away from the document, // Remove the event listener when navigating away from the document,
// since 'beforeunload' prevents Firefox from caching the document. // since 'beforeunload' prevents Firefox from caching the document.
window.removeEventListener('beforeunload', pdfHistoryBeforeUnload, false); window.removeEventListener('beforeunload', pdfHistoryBeforeUnload,
false);
} }
window.addEventListener('beforeunload', pdfHistoryBeforeUnload, false); window.addEventListener('beforeunload', pdfHistoryBeforeUnload, false);
window.addEventListener('pageshow', function pdfHistoryPageShow(evt) { window.addEventListener('pageshow', function pdfHistoryPageShow(evt) {
// If the entire viewer (including the PDF file) is cached in the browser, // If the entire viewer (including the PDF file) is cached in
// we need to reattach the 'beforeunload' event listener since // the browser, we need to reattach the 'beforeunload' event listener
// the 'DOMContentLoaded' event is not fired on 'pageshow'. // since the 'DOMContentLoaded' event is not fired on 'pageshow'.
window.addEventListener('beforeunload', pdfHistoryBeforeUnload, false); window.addEventListener('beforeunload', pdfHistoryBeforeUnload, false);
}, false); }, false);
@ -266,10 +273,12 @@ var PDFHistory = {
} }
if (this.uid > 0 && !(this.previousBookmark && this.previousPage)) { if (this.uid > 0 && !(this.previousBookmark && this.previousPage)) {
// Prevent the history from getting stuck in the current state, // Prevent the history from getting stuck in the current state,
// effectively preventing the user from going back/forward in the history. // effectively preventing the user from going back/forward in
// the history.
// //
// This happens if the current position in the document didn't change when // This happens if the current position in the document didn't change
// the history was previously updated. The reasons for this are either: // when the history was previously updated. The reasons for this are
// either:
// 1. The current zoom value is such that the document does not need to, // 1. The current zoom value is such that the document does not need to,
// or cannot, be scrolled to display the destination. // or cannot, be scrolled to display the destination.
// 2. The previous destination is broken, and doesn't actally point to a // 2. The previous destination is broken, and doesn't actally point to a
@ -289,7 +298,7 @@ var PDFHistory = {
} else { } else {
return null; return null;
} }
var params = { hash: this.currentBookmark, page: this.currentPage }; var params = {hash: this.currentBookmark, page: this.currentPage};
if (this.isViewerInPresentationMode) { if (this.isViewerInPresentationMode) {
params.hash = null; params.hash = null;
} }
@ -297,7 +306,7 @@ var PDFHistory = {
}, },
_stateObj: function pdfHistory_stateObj(params) { _stateObj: function pdfHistory_stateObj(params) {
return { fingerprint: this.fingerprint, uid: this.uid, target: params }; return {fingerprint: this.fingerprint, uid: this.uid, target: params};
}, },
_pushToHistory: function pdfHistory_pushToHistory(params, _pushToHistory: function pdfHistory_pushToHistory(params,
@ -379,4 +388,7 @@ var PDFHistory = {
} }
} }
} }
}; };
return PDFHistory;
})();

293
web/pdf_link_service.js

@ -0,0 +1,293 @@
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set shiftwidth=2 tabstop=2 autoindent cindent expandtab: */
/* Copyright 2015 Mozilla Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* globals PDFViewer, PDFHistory, Promise, parseQueryString */
'use strict';
/**
* Performs navigation functions inside PDF, such as opening specified page,
* or destination.
* @class
* @implements {IPDFLinkService}
*/
var PDFLinkService = (function () {
/**
* @constructs PDFLinkService
*/
function PDFLinkService() {
this.baseUrl = null;
this.pdfDocument = null;
this.pdfViewer = null;
this.pdfHistory = null;
this._pagesRefCache = null;
}
PDFLinkService.prototype = {
setDocument: function PDFLinkService_setDocument(pdfDocument, baseUrl) {
this.baseUrl = baseUrl;
this.pdfDocument = pdfDocument;
this._pagesRefCache = Object.create(null);
},
setViewer: function PDFLinkService_setViewer(pdfViewer) {
this.pdfViewer = pdfViewer;
},
setHistory: function PDFLinkService_setHistory(pdfHistory) {
this.pdfHistory = pdfHistory;
},
/**
* @returns {number}
*/
get pagesCount() {
return this.pdfDocument.numPages;
},
/**
* @returns {number}
*/
get page() {
return this.pdfViewer.currentPageNumber;
},
/**
* @param {number} value
*/
set page(value) {
this.pdfViewer.currentPageNumber = value;
},
/**
* @param dest - The PDF destination object.
*/
navigateTo: function PDFLinkService_navigateTo(dest) {
var destString = '';
var self = this;
var goToDestination = function(destRef) {
// dest array looks like that: <page-ref> </XYZ|FitXXX> <args..>
var pageNumber = destRef instanceof Object ?
self._pagesRefCache[destRef.num + ' ' + destRef.gen + ' R'] :
(destRef + 1);
if (pageNumber) {
if (pageNumber > self.pagesCount) {
pageNumber = self.pagesCount;
}
self.pdfViewer.scrollPageIntoView(pageNumber, dest);
// Update the browsing history.
self.pdfHistory.push({
dest: dest,
hash: destString,
page: pageNumber
});
} else {
self.pdfDocument.getPageIndex(destRef).then(function (pageIndex) {
var pageNum = pageIndex + 1;
var cacheKey = destRef.num + ' ' + destRef.gen + ' R';
self._pagesRefCache[cacheKey] = pageNum;
goToDestination(destRef);
});
}
};
var destinationPromise;
if (typeof dest === 'string') {
destString = dest;
destinationPromise = this.pdfDocument.getDestination(dest);
} else {
destinationPromise = Promise.resolve(dest);
}
destinationPromise.then(function(destination) {
dest = destination;
if (!(destination instanceof Array)) {
return; // invalid destination
}
goToDestination(destination[0]);
});
},
/**
* @param dest - The PDF destination object.
* @returns {string} The hyperlink to the PDF object.
*/
getDestinationHash: function PDFLinkService_getDestinationHash(dest) {
if (typeof dest === 'string') {
return this.getAnchorUrl('#' + escape(dest));
}
if (dest instanceof Array) {
var destRef = dest[0]; // see navigateTo method for dest format
var pageNumber = destRef instanceof Object ?
this._pagesRefCache[destRef.num + ' ' + destRef.gen + ' R'] :
(destRef + 1);
if (pageNumber) {
var pdfOpenParams = this.getAnchorUrl('#page=' + pageNumber);
var destKind = dest[1];
if (typeof destKind === 'object' && 'name' in destKind &&
destKind.name === 'XYZ') {
var scale = (dest[4] || this.pdfViewer.currentScaleValue);
var scaleNumber = parseFloat(scale);
if (scaleNumber) {
scale = scaleNumber * 100;
}
pdfOpenParams += '&zoom=' + scale;
if (dest[2] || dest[3]) {
pdfOpenParams += ',' + (dest[2] || 0) + ',' + (dest[3] || 0);
}
}
return pdfOpenParams;
}
}
return '';
},
/**
* Prefix the full url on anchor links to make sure that links are resolved
* relative to the current URL instead of the one defined in <base href>.
* @param {String} anchor The anchor hash, including the #.
* @returns {string} The hyperlink to the PDF object.
*/
getAnchorUrl: function PDFLinkService_getAnchorUrl(anchor) {
return (this.baseUrl || '') + anchor;
},
/**
* @param {string} hash
*/
setHash: function PDFLinkService_setHash(hash) {
if (hash.indexOf('=') >= 0) {
var params = parseQueryString(hash);
// borrowing syntax from "Parameters for Opening PDF Files"
if ('nameddest' in params) {
this.pdfHistory.updateNextHashParam(params.nameddest);
this.navigateTo(params.nameddest);
return;
}
var pageNumber, dest;
if ('page' in params) {
pageNumber = (params.page | 0) || 1;
}
if ('zoom' in params) {
// Build the destination array.
var zoomArgs = params.zoom.split(','); // scale,left,top
var zoomArg = zoomArgs[0];
var zoomArgNumber = parseFloat(zoomArg);
if (zoomArg.indexOf('Fit') === -1) {
// If the zoomArg is a number, it has to get divided by 100. If it's
// a string, it should stay as it is.
dest = [null, { name: 'XYZ' },
zoomArgs.length > 1 ? (zoomArgs[1] | 0) : null,
zoomArgs.length > 2 ? (zoomArgs[2] | 0) : null,
(zoomArgNumber ? zoomArgNumber / 100 : zoomArg)];
} else {
if (zoomArg === 'Fit' || zoomArg === 'FitB') {
dest = [null, { name: zoomArg }];
} else if ((zoomArg === 'FitH' || zoomArg === 'FitBH') ||
(zoomArg === 'FitV' || zoomArg === 'FitBV')) {
dest = [null, { name: zoomArg },
zoomArgs.length > 1 ? (zoomArgs[1] | 0) : null];
} else if (zoomArg === 'FitR') {
if (zoomArgs.length !== 5) {
console.error('pdfViewSetHash: ' +
'Not enough parameters for \'FitR\'.');
} else {
dest = [null, { name: zoomArg },
(zoomArgs[1] | 0), (zoomArgs[2] | 0),
(zoomArgs[3] | 0), (zoomArgs[4] | 0)];
}
} else {
console.error('pdfViewSetHash: \'' + zoomArg +
'\' is not a valid zoom value.');
}
}
}
if (dest) {
this.pdfViewer.scrollPageIntoView(pageNumber || this.page, dest);
} else if (pageNumber) {
this.page = pageNumber; // simple page
}
if ('pagemode' in params) {
if (params.pagemode === 'thumbs' || params.pagemode === 'bookmarks' ||
params.pagemode === 'attachments') {
this.switchSidebarView((params.pagemode === 'bookmarks' ?
'outline' : params.pagemode), true);
} else if (params.pagemode === 'none' && this.sidebarOpen) {
document.getElementById('sidebarToggle').click();
}
}
} else if (/^\d+$/.test(hash)) { // page number
this.page = hash;
} else { // named destination
this.pdfHistory.updateNextHashParam(unescape(hash));
this.navigateTo(unescape(hash));
}
},
/**
* @param {string} action
*/
executeNamedAction: function PDFLinkService_executeNamedAction(action) {
// See PDF reference, table 8.45 - Named action
switch (action) {
case 'GoBack':
this.pdfHistory.back();
break;
case 'GoForward':
this.pdfHistory.forward();
break;
case 'NextPage':
this.page++;
break;
case 'PrevPage':
this.page--;
break;
case 'LastPage':
this.page = this.pagesCount;
break;
case 'FirstPage':
this.page = 1;
break;
default:
break; // No action according to spec
}
var event = document.createEvent('CustomEvent');
event.initCustomEvent('namedaction', true, true, {
action: action
});
this.pdfViewer.container.dispatchEvent(event);
},
/**
* @param {number} pageNum - page number.
* @param {Object} pageRef - reference to the page.
*/
cachePageRef: function PDFLinkService_cachePageRef(pageNum, pageRef) {
var refStr = pageRef.num + ' ' + pageRef.gen + ' R';
this._pagesRefCache[refStr] = pageNum;
}
};
return PDFLinkService;
})();

12
web/pdf_viewer.component.js

@ -15,9 +15,9 @@
* limitations under the License. * limitations under the License.
*/ */
/*jshint globalstrict: false */ /*jshint globalstrict: false */
/* globals PDFJS, PDFViewer, PDFPageView, TextLayerBuilder, /* globals PDFJS, PDFViewer, PDFPageView, TextLayerBuilder, PDFLinkService,
DefaultTextLayerFactory, AnnotationsLayerBuilder, DefaultTextLayerFactory, AnnotationsLayerBuilder, PDFHistory,
DefaultAnnotationsLayerFactory */ DefaultAnnotationsLayerFactory, getFileName */
// Initializing PDFJS global object (if still undefined) // Initializing PDFJS global object (if still undefined)
if (typeof PDFJS === 'undefined') { if (typeof PDFJS === 'undefined') {
@ -28,12 +28,18 @@ if (typeof PDFJS === 'undefined') {
'use strict'; 'use strict';
//#include ui_utils.js //#include ui_utils.js
//#include pdf_link_service.js
//#include pdf_viewer.js //#include pdf_viewer.js
//#include pdf_history.js
PDFJS.PDFViewer = PDFViewer; PDFJS.PDFViewer = PDFViewer;
PDFJS.PDFPageView = PDFPageView; PDFJS.PDFPageView = PDFPageView;
PDFJS.PDFLinkService = PDFLinkService;
PDFJS.TextLayerBuilder = TextLayerBuilder; PDFJS.TextLayerBuilder = TextLayerBuilder;
PDFJS.DefaultTextLayerFactory = DefaultTextLayerFactory; PDFJS.DefaultTextLayerFactory = DefaultTextLayerFactory;
PDFJS.AnnotationsLayerBuilder = AnnotationsLayerBuilder; PDFJS.AnnotationsLayerBuilder = AnnotationsLayerBuilder;
PDFJS.DefaultAnnotationsLayerFactory = DefaultAnnotationsLayerFactory; PDFJS.DefaultAnnotationsLayerFactory = DefaultAnnotationsLayerFactory;
PDFJS.PDFHistory = PDFHistory;
PDFJS.getFileName = getFileName;
}).call((typeof window === 'undefined') ? this : window); }).call((typeof window === 'undefined') ? this : window);

11
web/pdf_viewer.js

@ -215,7 +215,6 @@ var PDFViewer = (function pdfViewer() {
} }
var pagesCount = pdfDocument.numPages; var pagesCount = pdfDocument.numPages;
var pagesRefMap = this.pagesRefMap = {};
var self = this; var self = this;
var resolvePagesPromise; var resolvePagesPromise;
@ -280,6 +279,8 @@ var PDFViewer = (function pdfViewer() {
this._pages.push(pageView); this._pages.push(pageView);
} }
var linkService = this.linkService;
// Fetch all the pages since the viewport is needed before printing // Fetch all the pages since the viewport is needed before printing
// starts to create the correct size canvas. Wait until one page is // starts to create the correct size canvas. Wait until one page is
// rendered so we don't tie up too many resources early on. // rendered so we don't tie up too many resources early on.
@ -292,8 +293,7 @@ var PDFViewer = (function pdfViewer() {
if (!pageView.pdfPage) { if (!pageView.pdfPage) {
pageView.setPdfPage(pdfPage); pageView.setPdfPage(pdfPage);
} }
var refStr = pdfPage.ref.num + ' ' + pdfPage.ref.gen + ' R'; linkService.cachePageRef(pageNum, pdfPage.ref);
pagesRefMap[refStr] = pageNum;
getPagesLeft--; getPagesLeft--;
if (!getPagesLeft) { if (!getPagesLeft) {
resolvePagesPromise(); resolvePagesPromise();
@ -780,6 +780,11 @@ var SimpleLinkService = (function SimpleLinkServiceClosure() {
* @param {string} action * @param {string} action
*/ */
executeNamedAction: function (action) {}, executeNamedAction: function (action) {},
/**
* @param {number} pageNum - page number.
* @param {Object} pageRef - reference to the page.
*/
cachePageRef: function (pageNum, pageRef) {}
}; };
return SimpleLinkService; return SimpleLinkService;
})(); })();

15
web/ui_utils.js

@ -179,6 +179,21 @@ function watchScroll(viewAreaElement, callback) {
return state; return state;
} }
/**
* Helper function to parse query string (e.g. ?param1=value&parm2=...).
*/
function parseQueryString(query) {
var parts = query.split('&');
var params = {};
for (var i = 0, ii = parts.length; i < ii; ++i) {
var param = parts[i].split('=');
var key = param[0].toLowerCase();
var value = param.length > 1 ? param[1] : null;
params[decodeURIComponent(key)] = decodeURIComponent(value);
}
return params;
}
/** /**
* Use binary search to find the index of the first item in a given array which * Use binary search to find the index of the first item in a given array which
* passes a given condition. The items are expected to be sorted in the sense * passes a given condition. The items are expected to be sorted in the sense

1
web/viewer.html

@ -68,6 +68,7 @@ http://sourceforge.net/adobe/cmap/wiki/License/
<script src="preferences.js"></script> <script src="preferences.js"></script>
<script src="download_manager.js"></script> <script src="download_manager.js"></script>
<script src="view_history.js"></script> <script src="view_history.js"></script>
<script src="pdf_link_service.js"></script>
<script src="pdf_rendering_queue.js"></script> <script src="pdf_rendering_queue.js"></script>
<script src="pdf_page_view.js"></script> <script src="pdf_page_view.js"></script>
<script src="text_layer_builder.js"></script> <script src="text_layer_builder.js"></script>

330
web/viewer.js

@ -18,11 +18,11 @@
DownloadManager, getFileName, getPDFFileNameFromURL, DownloadManager, getFileName, getPDFFileNameFromURL,
PDFHistory, Preferences, SidebarView, ViewHistory, Stats, PDFHistory, Preferences, SidebarView, ViewHistory, Stats,
PDFThumbnailViewer, URL, noContextMenuHandler, SecondaryToolbar, PDFThumbnailViewer, URL, noContextMenuHandler, SecondaryToolbar,
PasswordPrompt, PDFPresentationMode, HandTool, Promise, PasswordPrompt, PDFPresentationMode, PDFDocumentProperties, HandTool,
PDFDocumentProperties, PDFOutlineView, PDFAttachmentView, Promise, PDFLinkService, PDFOutlineView, PDFAttachmentView,
OverlayManager, PDFFindController, PDFFindBar, getVisibleElements, OverlayManager, PDFFindController, PDFFindBar, getVisibleElements,
watchScroll, PDFViewer, PDFRenderingQueue, PresentationModeState, watchScroll, PDFViewer, PDFRenderingQueue, PresentationModeState,
RenderingStates, DEFAULT_SCALE, UNKNOWN_SCALE, parseQueryString, RenderingStates, DEFAULT_SCALE, UNKNOWN_SCALE,
IGNORE_CURRENT_POSITION_ON_ZOOM: true */ IGNORE_CURRENT_POSITION_ON_ZOOM: true */
'use strict'; 'use strict';
@ -82,6 +82,7 @@ var mozL10n = document.mozL10n || document.webL10n;
//#include view_history.js //#include view_history.js
//#include pdf_find_bar.js //#include pdf_find_bar.js
//#include pdf_find_controller.js //#include pdf_find_controller.js
//#include pdf_link_service.js
//#include pdf_history.js //#include pdf_history.js
//#include secondary_toolbar.js //#include secondary_toolbar.js
//#include pdf_presentation_mode.js //#include pdf_presentation_mode.js
@ -96,6 +97,7 @@ var mozL10n = document.mozL10n || document.webL10n;
var PDFViewerApplication = { var PDFViewerApplication = {
initialBookmark: document.location.hash.substring(1), initialBookmark: document.location.hash.substring(1),
initialDestination: null,
initialized: false, initialized: false,
fellback: false, fellback: false,
pdfDocument: null, pdfDocument: null,
@ -111,6 +113,10 @@ var PDFViewerApplication = {
pdfPresentationMode: null, pdfPresentationMode: null,
/** @type {PDFDocumentProperties} */ /** @type {PDFDocumentProperties} */
pdfDocumentProperties: null, pdfDocumentProperties: null,
/** @type {PDFLinkService} */
pdfLinkService: null,
/** @type {PDFHistory} */
pdfHistory: null,
pageRotation: 0, pageRotation: 0,
updateScaleControls: true, updateScaleControls: true,
isInitialViewSet: false, isInitialViewSet: false,
@ -128,26 +134,35 @@ var PDFViewerApplication = {
pdfRenderingQueue.onIdle = this.cleanup.bind(this); pdfRenderingQueue.onIdle = this.cleanup.bind(this);
this.pdfRenderingQueue = pdfRenderingQueue; this.pdfRenderingQueue = pdfRenderingQueue;
var pdfLinkService = new PDFLinkService();
this.pdfLinkService = pdfLinkService;
var container = document.getElementById('viewerContainer'); var container = document.getElementById('viewerContainer');
var viewer = document.getElementById('viewer'); var viewer = document.getElementById('viewer');
this.pdfViewer = new PDFViewer({ this.pdfViewer = new PDFViewer({
container: container, container: container,
viewer: viewer, viewer: viewer,
renderingQueue: pdfRenderingQueue, renderingQueue: pdfRenderingQueue,
linkService: this linkService: pdfLinkService
}); });
pdfRenderingQueue.setViewer(this.pdfViewer); pdfRenderingQueue.setViewer(this.pdfViewer);
pdfLinkService.setViewer(this.pdfViewer);
var thumbnailContainer = document.getElementById('thumbnailView'); var thumbnailContainer = document.getElementById('thumbnailView');
this.pdfThumbnailViewer = new PDFThumbnailViewer({ this.pdfThumbnailViewer = new PDFThumbnailViewer({
container: thumbnailContainer, container: thumbnailContainer,
renderingQueue: pdfRenderingQueue, renderingQueue: pdfRenderingQueue,
linkService: this linkService: pdfLinkService
}); });
pdfRenderingQueue.setThumbnailViewer(this.pdfThumbnailViewer); pdfRenderingQueue.setThumbnailViewer(this.pdfThumbnailViewer);
Preferences.initialize(); Preferences.initialize();
this.pdfHistory = new PDFHistory({
linkService: pdfLinkService
});
pdfLinkService.setHistory(this.pdfHistory);
this.findController = new PDFFindController({ this.findController = new PDFFindController({
pdfViewer: this.pdfViewer, pdfViewer: this.pdfViewer,
integratedFind: this.supportsIntegratedFind integratedFind: this.supportsIntegratedFind
@ -314,11 +329,11 @@ var PDFViewerApplication = {
}, },
set page(val) { set page(val) {
this.pdfViewer.currentPageNumber = val; this.pdfLinkService.page = val;
}, },
get page() { get page() { // TODO remove
return this.pdfViewer.currentPageNumber; return this.pdfLinkService.page;
}, },
get supportsPrinting() { get supportsPrinting() {
@ -478,6 +493,7 @@ var PDFViewerApplication = {
this.pdfThumbnailViewer.setDocument(null); this.pdfThumbnailViewer.setDocument(null);
this.pdfViewer.setDocument(null); this.pdfViewer.setDocument(null);
this.pdfLinkService.setDocument(null, null);
if (typeof PDFBug !== 'undefined') { if (typeof PDFBug !== 'undefined') {
PDFBug.cleanup(); PDFBug.cleanup();
@ -621,138 +637,6 @@ var PDFViewerApplication = {
//#endif //#endif
}, },
navigateTo: function pdfViewNavigateTo(dest) {
var destString = '';
var self = this;
var goToDestination = function(destRef) {
self.pendingRefStr = null;
// dest array looks like that: <page-ref> </XYZ|FitXXX> <args..>
var pageNumber = destRef instanceof Object ?
self.pagesRefMap[destRef.num + ' ' + destRef.gen + ' R'] :
(destRef + 1);
if (pageNumber) {
if (pageNumber > self.pagesCount) {
pageNumber = self.pagesCount;
}
self.pdfViewer.scrollPageIntoView(pageNumber, dest);
// Update the browsing history.
PDFHistory.push({ dest: dest, hash: destString, page: pageNumber });
} else {
self.pdfDocument.getPageIndex(destRef).then(function (pageIndex) {
var pageNum = pageIndex + 1;
self.pagesRefMap[destRef.num + ' ' + destRef.gen + ' R'] = pageNum;
goToDestination(destRef);
});
}
};
var destinationPromise;
if (typeof dest === 'string') {
destString = dest;
destinationPromise = this.pdfDocument.getDestination(dest);
} else {
destinationPromise = Promise.resolve(dest);
}
destinationPromise.then(function(destination) {
dest = destination;
if (!(destination instanceof Array)) {
return; // invalid destination
}
goToDestination(destination[0]);
});
},
executeNamedAction: function pdfViewExecuteNamedAction(action) {
// See PDF reference, table 8.45 - Named action
switch (action) {
case 'GoToPage':
document.getElementById('pageNumber').focus();
break;
case 'GoBack':
PDFHistory.back();
break;
case 'GoForward':
PDFHistory.forward();
break;
case 'Find':
if (!this.supportsIntegratedFind) {
this.findBar.toggle();
}
break;
case 'NextPage':
this.page++;
break;
case 'PrevPage':
this.page--;
break;
case 'LastPage':
this.page = this.pagesCount;
break;
case 'FirstPage':
this.page = 1;
break;
default:
break; // No action according to spec
}
},
getDestinationHash: function pdfViewGetDestinationHash(dest) {
if (typeof dest === 'string') {
return this.getAnchorUrl('#' + escape(dest));
}
if (dest instanceof Array) {
var destRef = dest[0]; // see navigateTo method for dest format
var pageNumber = destRef instanceof Object ?
this.pagesRefMap[destRef.num + ' ' + destRef.gen + ' R'] :
(destRef + 1);
if (pageNumber) {
var pdfOpenParams = this.getAnchorUrl('#page=' + pageNumber);
var destKind = dest[1];
if (typeof destKind === 'object' && 'name' in destKind &&
destKind.name === 'XYZ') {
var scale = (dest[4] || this.currentScaleValue);
var scaleNumber = parseFloat(scale);
if (scaleNumber) {
scale = scaleNumber * 100;
}
pdfOpenParams += '&zoom=' + scale;
if (dest[2] || dest[3]) {
pdfOpenParams += ',' + (dest[2] || 0) + ',' + (dest[3] || 0);
}
}
return pdfOpenParams;
}
}
return '';
},
/**
* Prefix the full url on anchor links to make sure that links are resolved
* relative to the current URL instead of the one defined in <base href>.
* @param {String} anchor The anchor hash, including the #.
*/
getAnchorUrl: function getAnchorUrl(anchor) {
//#if (GENERIC || B2G)
return anchor;
//#endif
//#if (FIREFOX || MOZCENTRAL)
// return this.url.split('#')[0] + anchor;
//#endif
//#if CHROME
// return location.href.split('#')[0] + anchor;
//#endif
},
/** /**
* Show the error box. * Show the error box.
* @param {String} message A message that is human readable. * @param {String} message A message that is human readable.
@ -876,6 +760,17 @@ var PDFViewerApplication = {
var id = this.documentFingerprint = pdfDocument.fingerprint; var id = this.documentFingerprint = pdfDocument.fingerprint;
var store = this.store = new ViewHistory(id); var store = this.store = new ViewHistory(id);
//#if (GENERIC || B2G)
var baseDocumentUrl = null;
//#endif
//#if (FIREFOX || MOZCENTRAL)
// var baseDocumentUrl = this.url.split('#')[0];
//#endif
//#if CHROME
// var baseDocumentUrl = location.href.split('#')[0];
//#endif
this.pdfLinkService.setDocument(pdfDocument, baseDocumentUrl);
var pdfViewer = this.pdfViewer; var pdfViewer = this.pdfViewer;
pdfViewer.currentScale = scale; pdfViewer.currentScale = scale;
pdfViewer.setDocument(pdfDocument); pdfViewer.setDocument(pdfDocument);
@ -885,7 +780,6 @@ var PDFViewerApplication = {
this.pageRotation = 0; this.pageRotation = 0;
this.isInitialViewSet = false; this.isInitialViewSet = false;
this.pagesRefMap = pdfViewer.pagesRefMap;
this.pdfThumbnailViewer.setDocument(pdfDocument); this.pdfThumbnailViewer.setDocument(pdfDocument);
@ -904,7 +798,9 @@ var PDFViewerApplication = {
if (!self.preferenceShowPreviousViewOnLoad && window.history.state) { if (!self.preferenceShowPreviousViewOnLoad && window.history.state) {
window.history.replaceState(null, ''); window.history.replaceState(null, '');
} }
PDFHistory.initialize(self.documentFingerprint, self); self.pdfHistory.initialize(self.documentFingerprint);
self.initialDestination = self.pdfHistory.initialDestination;
self.initialBookmark = self.pdfHistory.initialBookmark;
} }
store.initializedPromise.then(function resolved() { store.initializedPromise.then(function resolved() {
@ -965,7 +861,7 @@ var PDFViewerApplication = {
self.outline = new PDFOutlineView({ self.outline = new PDFOutlineView({
container: container, container: container,
outline: outline, outline: outline,
linkService: self linkService: self.pdfLinkService
}); });
self.outline.render(); self.outline.render();
document.getElementById('viewOutline').disabled = !outline; document.getElementById('viewOutline').disabled = !outline;
@ -1083,15 +979,15 @@ var PDFViewerApplication = {
document.getElementById('pageNumber').value = document.getElementById('pageNumber').value =
this.pdfViewer.currentPageNumber = 1; this.pdfViewer.currentPageNumber = 1;
if (PDFHistory.initialDestination) { if (this.initialDestination) {
this.navigateTo(PDFHistory.initialDestination); this.pdfLinkService.navigateTo(this.initialDestination);
PDFHistory.initialDestination = null; this.initialDestination = null;
} else if (this.initialBookmark) { } else if (this.initialBookmark) {
this.setHash(this.initialBookmark); this.pdfLinkService.setHash(this.initialBookmark);
PDFHistory.push({ hash: this.initialBookmark }, !!this.initialBookmark); this.pdfHistory.push({ hash: this.initialBookmark }, true);
this.initialBookmark = null; this.initialBookmark = null;
} else if (storedHash) { } else if (storedHash) {
this.setHash(storedHash); this.pdfLinkService.setHash(storedHash);
} else if (scale) { } else if (scale) {
this.setScale(scale, true); this.setScale(scale, true);
this.page = 1; this.page = 1;
@ -1116,84 +1012,6 @@ var PDFViewerApplication = {
this.pdfRenderingQueue.renderHighestPriority(); this.pdfRenderingQueue.renderHighestPriority();
}, },
setHash: function pdfViewSetHash(hash) {
if (!this.isInitialViewSet) {
this.initialBookmark = hash;
return;
}
if (!hash) {
return;
}
if (hash.indexOf('=') >= 0) {
var params = this.parseQueryString(hash);
// borrowing syntax from "Parameters for Opening PDF Files"
if ('nameddest' in params) {
PDFHistory.updateNextHashParam(params.nameddest);
this.navigateTo(params.nameddest);
return;
}
var pageNumber, dest;
if ('page' in params) {
pageNumber = (params.page | 0) || 1;
}
if ('zoom' in params) {
// Build the destination array.
var zoomArgs = params.zoom.split(','); // scale,left,top
var zoomArg = zoomArgs[0];
var zoomArgNumber = parseFloat(zoomArg);
if (zoomArg.indexOf('Fit') === -1) {
// If the zoomArg is a number, it has to get divided by 100. If it's
// a string, it should stay as it is.
dest = [null, { name: 'XYZ' },
zoomArgs.length > 1 ? (zoomArgs[1] | 0) : null,
zoomArgs.length > 2 ? (zoomArgs[2] | 0) : null,
(zoomArgNumber ? zoomArgNumber / 100 : zoomArg)];
} else {
if (zoomArg === 'Fit' || zoomArg === 'FitB') {
dest = [null, { name: zoomArg }];
} else if ((zoomArg === 'FitH' || zoomArg === 'FitBH') ||
(zoomArg === 'FitV' || zoomArg === 'FitBV')) {
dest = [null, { name: zoomArg },
zoomArgs.length > 1 ? (zoomArgs[1] | 0) : null];
} else if (zoomArg === 'FitR') {
if (zoomArgs.length !== 5) {
console.error('pdfViewSetHash: ' +
'Not enough parameters for \'FitR\'.');
} else {
dest = [null, { name: zoomArg },
(zoomArgs[1] | 0), (zoomArgs[2] | 0),
(zoomArgs[3] | 0), (zoomArgs[4] | 0)];
}
} else {
console.error('pdfViewSetHash: \'' + zoomArg +
'\' is not a valid zoom value.');
}
}
}
if (dest) {
this.pdfViewer.scrollPageIntoView(pageNumber || this.page, dest);
} else if (pageNumber) {
this.page = pageNumber; // simple page
}
if ('pagemode' in params) {
if (params.pagemode === 'thumbs' || params.pagemode === 'bookmarks' ||
params.pagemode === 'attachments') {
this.switchSidebarView((params.pagemode === 'bookmarks' ?
'outline' : params.pagemode), true);
} else if (params.pagemode === 'none' && this.sidebarOpen) {
document.getElementById('sidebarToggle').click();
}
}
} else if (/^\d+$/.test(hash)) { // page number
this.page = hash;
} else { // named destination
PDFHistory.updateNextHashParam(unescape(hash));
this.navigateTo(unescape(hash));
}
},
refreshThumbnailViewer: function pdfViewRefreshThumbnailViewer() { refreshThumbnailViewer: function pdfViewRefreshThumbnailViewer() {
var pdfViewer = this.pdfViewer; var pdfViewer = this.pdfViewer;
var thumbnailViewer = this.pdfThumbnailViewer; var thumbnailViewer = this.pdfThumbnailViewer;
@ -1269,19 +1087,6 @@ var PDFViewerApplication = {
} }
}, },
// Helper function to parse query string (e.g. ?param1=value&parm2=...).
parseQueryString: function pdfViewParseQueryString(query) {
var parts = query.split('&');
var params = {};
for (var i = 0, ii = parts.length; i < ii; ++i) {
var param = parts[i].split('=');
var key = param[0].toLowerCase();
var value = param.length > 1 ? param[1] : null;
params[decodeURIComponent(key)] = decodeURIComponent(value);
}
return params;
},
beforePrint: function pdfViewSetupBeforePrint() { beforePrint: function pdfViewSetupBeforePrint() {
if (!this.supportsPrinting) { if (!this.supportsPrinting) {
var printMessage = mozL10n.get('printing_not_supported', null, var printMessage = mozL10n.get('printing_not_supported', null,
@ -1430,7 +1235,7 @@ window.PDFView = PDFViewerApplication; // obsolete name, using it as an alias
// // Run this code outside DOMContentLoaded to make sure that the URL // // Run this code outside DOMContentLoaded to make sure that the URL
// // is rewritten as soon as possible. // // is rewritten as soon as possible.
// var queryString = document.location.search.slice(1); // var queryString = document.location.search.slice(1);
// var params = PDFViewerApplication.parseQueryString(queryString); // var params = parseQueryString(queryString);
// DEFAULT_URL = params.file || ''; // DEFAULT_URL = params.file || '';
// //
// // Example: chrome-extension://.../http://example.com/file.pdf // // Example: chrome-extension://.../http://example.com/file.pdf
@ -1449,7 +1254,7 @@ function webViewerLoad(evt) {
function webViewerInitialized() { function webViewerInitialized() {
//#if (GENERIC || B2G) //#if (GENERIC || B2G)
var queryString = document.location.search.substring(1); var queryString = document.location.search.substring(1);
var params = PDFViewerApplication.parseQueryString(queryString); var params = parseQueryString(queryString);
var file = 'file' in params ? params.file : DEFAULT_URL; var file = 'file' in params ? params.file : DEFAULT_URL;
//#endif //#endif
//#if (FIREFOX || MOZCENTRAL) //#if (FIREFOX || MOZCENTRAL)
@ -1489,7 +1294,7 @@ function webViewerInitialized() {
//#endif //#endif
// Special debugging flags in the hash section of the URL. // Special debugging flags in the hash section of the URL.
var hash = document.location.hash.substring(1); var hash = document.location.hash.substring(1);
var hashParams = PDFViewerApplication.parseQueryString(hash); var hashParams = parseQueryString(hash);
if ('disableworker' in hashParams) { if ('disableworker' in hashParams) {
PDFJS.disableWorker = (hashParams['disableworker'] === 'true'); PDFJS.disableWorker = (hashParams['disableworker'] === 'true');
@ -1785,6 +1590,23 @@ document.addEventListener('textlayerrendered', function (e) {
//#endif //#endif
}, true); }, true);
document.addEventListener('namedaction', function (e) {
// Processing couple of named actions that might be useful.
// See also PDFLinkService.executeNamedAction
var action = e.action;
switch (action) {
case 'GoToPage':
document.getElementById('pageNumber').focus();
break;
case 'Find':
if (!this.supportsIntegratedFind) {
this.findBar.toggle();
}
break;
}
}, true);
window.addEventListener('presentationmodechanged', function (e) { window.addEventListener('presentationmodechanged', function (e) {
var active = e.detail.active; var active = e.detail.active;
var switchInProgress = e.detail.switchInProgress; var switchInProgress = e.detail.switchInProgress;
@ -1817,12 +1639,14 @@ window.addEventListener('updateviewarea', function (evt) {
// unable to write to storage // unable to write to storage
}); });
}); });
var href = PDFViewerApplication.getAnchorUrl(location.pdfOpenParams); var href =
PDFViewerApplication.pdfLinkService.getAnchorUrl(location.pdfOpenParams);
document.getElementById('viewBookmark').href = href; document.getElementById('viewBookmark').href = href;
document.getElementById('secondaryViewBookmark').href = href; document.getElementById('secondaryViewBookmark').href = href;
// Update the current bookmark in the browsing history. // Update the current bookmark in the browsing history.
PDFHistory.updateCurrentBookmark(location.pdfOpenParams, location.pageNumber); PDFViewerApplication.pdfHistory.updateCurrentBookmark(location.pdfOpenParams,
location.pageNumber);
// Show/hide the loading indicator in the page number input element. // Show/hide the loading indicator in the page number input element.
var pageNumberInput = document.getElementById('pageNumber'); var pageNumberInput = document.getElementById('pageNumber');
@ -1852,8 +1676,16 @@ window.addEventListener('resize', function webViewerResize(evt) {
}); });
window.addEventListener('hashchange', function webViewerHashchange(evt) { window.addEventListener('hashchange', function webViewerHashchange(evt) {
if (PDFHistory.isHashChangeUnlocked) { if (PDFViewerApplication.pdfHistory.isHashChangeUnlocked) {
PDFViewerApplication.setHash(document.location.hash.substring(1)); var hash = document.location.hash.substring(1);
if (!hash) {
return;
}
if (!PDFViewerApplication.isInitialViewSet) {
PDFViewerApplication.initialBookmark = hash;
} else {
PDFViewerApplication.pdfLinkService.setHash(hash);
}
} }
}); });
@ -2249,13 +2081,13 @@ window.addEventListener('keydown', function keydown(evt) {
switch (evt.keyCode) { switch (evt.keyCode) {
case 37: // left arrow case 37: // left arrow
if (isViewerInPresentationMode) { if (isViewerInPresentationMode) {
PDFHistory.back(); PDFViewerApplication.pdfHistory.back();
handled = true; handled = true;
} }
break; break;
case 39: // right arrow case 39: // right arrow
if (isViewerInPresentationMode) { if (isViewerInPresentationMode) {
PDFHistory.forward(); PDFViewerApplication.pdfHistory.forward();
handled = true; handled = true;
} }
break; break;

Loading…
Cancel
Save