/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set shiftwidth=2 tabstop=2 autoindent cindent expandtab: */ /* Copyright 2012 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 CanvasGraphics, combineUrl, createScratchCanvas, error, ErrorFont, Font, FontLoader, globalScope, info, isArrayBuffer, loadJpegStream, MessageHandler, PDFJS, PDFObjects, Promise, StatTimer, warn, WorkerMessageHandler, PasswordResponses, Util */ 'use strict'; /** * The maximum allowed image size in total pixels e.g. width * height. Images * above this value will not be drawn. Use -1 for no limit. * @var {Number} */ PDFJS.maxImageSize = PDFJS.maxImageSize === undefined ? -1 : PDFJS.maxImageSize; /** * This is the main entry point for loading a PDF and interacting with it. * NOTE: If a URL is used to fetch the PDF data a standard XMLHttpRequest(XHR) * is used, which means it must follow the same origin rules that any XHR does * e.g. No cross domain requests without CORS. * * @param {string|TypedAray|object} source Can be an url to where a PDF is * located, a typed array (Uint8Array) already populated with data or * and parameter object with the following possible fields: * - url - The URL of the PDF. * - data - A typed array with PDF data. * - httpHeaders - Basic authentication headers. * - password - For decrypting password-protected PDFs. * * @param {object} pdfDataRangeTransport is optional. It is used if you want * to manually serve range requests for data in the PDF. See viewer.js for * an example of pdfDataRangeTransport's interface. * * @param {function} passwordCallback is optional. It is used to request a * password if wrong or no password was provided. The callback receives two * parameters: function that needs to be called with new password and reason * (see {PasswordResponses}). * * @return {Promise} A promise that is resolved with {PDFDocumentProxy} object. */ PDFJS.getDocument = function getDocument(source, pdfDataRangeTransport, passwordCallback, progressCallback) { var workerInitializedPromise, workerReadyPromise, transport; if (typeof source === 'string') { source = { url: source }; } else if (isArrayBuffer(source)) { source = { data: source }; } else if (typeof source !== 'object') { error('Invalid parameter in getDocument, need either Uint8Array, ' + 'string or a parameter object'); } if (!source.url && !source.data) error('Invalid parameter array, need either .data or .url'); // copy/use all keys as is except 'url' -- full path is required var params = {}; for (var key in source) { if (key === 'url' && typeof window !== 'undefined') { params[key] = combineUrl(window.location.href, source[key]); continue; } params[key] = source[key]; } workerInitializedPromise = new PDFJS.Promise(); workerReadyPromise = new PDFJS.Promise(); transport = new WorkerTransport(workerInitializedPromise, workerReadyPromise, pdfDataRangeTransport, progressCallback); workerInitializedPromise.then(function transportInitialized() { transport.passwordCallback = passwordCallback; transport.fetchDocument(params); }); return workerReadyPromise; }; /** * Proxy to a PDFDocument in the worker thread. Also, contains commonly used * properties that can be read synchronously. */ var PDFDocumentProxy = (function PDFDocumentProxyClosure() { function PDFDocumentProxy(pdfInfo, transport) { this.pdfInfo = pdfInfo; this.transport = transport; } PDFDocumentProxy.prototype = { /** * @return {number} Total number of pages the PDF contains. */ get numPages() { return this.pdfInfo.numPages; }, /** * @return {string} A unique ID to identify a PDF. Not guaranteed to be * unique. */ get fingerprint() { return this.pdfInfo.fingerprint; }, /** * @return {boolean} true if embedded document fonts are in use. Will be * set during rendering of the pages. */ get embeddedFontsUsed() { return this.transport.embeddedFontsUsed; }, /** * @param {number} The page number to get. The first page is 1. * @return {Promise} A promise that is resolved with a {PDFPageProxy} * object. */ getPage: function PDFDocumentProxy_getPage(number) { return this.transport.getPage(number); }, /** * @return {Promise} A promise that is resolved with a lookup table for * mapping named destinations to reference numbers. */ getDestinations: function PDFDocumentProxy_getDestinations() { return this.transport.getDestinations(); }, /** * @return {Promise} A promise that is resolved with an array of all the * JavaScript strings in the name tree. */ getJavaScript: function PDFDocumentProxy_getDestinations() { var promise = new PDFJS.Promise(); var js = this.pdfInfo.javaScript; promise.resolve(js); return promise; }, /** * @return {Promise} A promise that is resolved with an {array} that is a * tree outline (if it has one) of the PDF. The tree is in the format of: * [ * { * title: string, * bold: boolean, * italic: boolean, * color: rgb array, * dest: dest obj, * items: array of more items like this * }, * ... * ]. */ getOutline: function PDFDocumentProxy_getOutline() { var promise = new PDFJS.Promise(); var outline = this.pdfInfo.outline; promise.resolve(outline); return promise; }, /** * @return {Promise} A promise that is resolved with an {object} that has * info and metadata properties. Info is an {object} filled with anything * available in the information dictionary and similarly metadata is a * {Metadata} object with information from the metadata section of the PDF. */ getMetadata: function PDFDocumentProxy_getMetadata() { var promise = new PDFJS.Promise(); var info = this.pdfInfo.info; var metadata = this.pdfInfo.metadata; promise.resolve({ info: info, metadata: metadata ? new PDFJS.Metadata(metadata) : null }); return promise; }, isEncrypted: function PDFDocumentProxy_isEncrypted() { var promise = new PDFJS.Promise(); promise.resolve(this.pdfInfo.encrypted); return promise; }, /** * @return {Promise} A promise that is resolved with a TypedArray that has * the raw data from the PDF. */ getData: function PDFDocumentProxy_getData() { var promise = new PDFJS.Promise(); this.transport.getData(promise); return promise; }, /** * @return {Promise} A promise that is resolved when the document's data * is loaded */ dataLoaded: function PDFDocumentProxy_dataLoaded() { return this.transport.dataLoaded(); }, destroy: function PDFDocumentProxy_destroy() { this.transport.destroy(); } }; return PDFDocumentProxy; })(); var PDFPageProxy = (function PDFPageProxyClosure() { function PDFPageProxy(pageInfo, transport) { this.pageInfo = pageInfo; this.transport = transport; this.stats = new StatTimer(); this.stats.enabled = !!globalScope.PDFJS.enableStats; this.commonObjs = transport.commonObjs; this.objs = new PDFObjects(); this.renderInProgress = false; this.cleanupAfterRender = false; this.renderTasks = []; } PDFPageProxy.prototype = { /** * @return {number} Page number of the page. First page is 1. */ get pageNumber() { return this.pageInfo.pageIndex + 1; }, /** * @return {number} The number of degrees the page is rotated clockwise. */ get rotate() { return this.pageInfo.rotate; }, /** * @return {object} The reference that points to this page. It has 'num' and * 'gen' properties. */ get ref() { return this.pageInfo.ref; }, /** * @return {array} An array of the visible portion of the PDF page in the * user space units - [x1, y1, x2, y2]. */ get view() { return this.pageInfo.view; }, /** * @param {number} scale The desired scale of the viewport. * @param {number} rotate Degrees to rotate the viewport. If omitted this * defaults to the page rotation. * @return {PageViewport} Contains 'width' and 'height' properties along * with transforms required for rendering. */ getViewport: function PDFPageProxy_getViewport(scale, rotate) { if (arguments.length < 2) rotate = this.rotate; return new PDFJS.PageViewport(this.view, scale, rotate, 0, 0); }, /** * @return {Promise} A promise that is resolved with an {array} of the * annotation objects. */ getAnnotations: function PDFPageProxy_getAnnotations() { if (this.annotationsPromise) return this.annotationsPromise; var promise = new PDFJS.Promise(); this.annotationsPromise = promise; this.transport.getAnnotations(this.pageInfo.pageIndex); return promise; }, /** * Begins the process of rendering a page to the desired context. * @param {object} params A parameter object that supports: * { * canvasContext(required): A 2D context of a DOM Canvas object., * textLayer(optional): An object that has beginLayout, endLayout, and * appendText functions., * imageLayer(optional): An object that has beginLayout, endLayout and * appendImage functions., * continueCallback(optional): A function that will be called each time * the rendering is paused. To continue * rendering call the function that is the * first argument to the callback. * }. * @return {RenderTask} An extended promise that is resolved when the page * finishes rendering (see RenderTask). */ render: function PDFPageProxy_render(params) { this.renderInProgress = true; var stats = this.stats; stats.time('Overall'); // If there is no displayReadyPromise yet, then the operatorList was never // requested before. Make the request and create the promise. if (!this.displayReadyPromise) { this.displayReadyPromise = new Promise(); this.destroyed = false; this.operatorList = { fnArray: [], argsArray: [], lastChunk: false }; this.stats.time('Page Request'); this.transport.messageHandler.send('RenderPageRequest', { pageIndex: this.pageNumber - 1 }); } var internalRenderTask = new InternalRenderTask(complete, params, this.objs, this.commonObjs, this.operatorList, this.pageNumber); this.renderTasks.push(internalRenderTask); var renderTask = new RenderTask(internalRenderTask); var self = this; this.displayReadyPromise.then( function pageDisplayReadyPromise(transparency) { if (self.destroyed) { complete(); return; } stats.time('Rendering'); internalRenderTask.initalizeGraphics(transparency); internalRenderTask.operatorListChanged(); }, function pageDisplayReadPromiseError(reason) { complete(reason); } ); function complete(error) { var i = self.renderTasks.indexOf(internalRenderTask); if (i >= 0) { self.renderTasks.splice(i, 1); } if (self.renderTasks.length === 0 && (self.destroyed || self.cleanupAfterRender)) { self._destroy(); } if (error) { renderTask.reject(error); } else { renderTask.resolve(); } stats.timeEnd('Rendering'); stats.timeEnd('Overall'); } return renderTask; }, /** * @return {Promise} That is resolved with the a {string} that is the text * content from the page. */ getTextContent: function PDFPageProxy_getTextContent() { var promise = new PDFJS.Promise(); this.transport.messageHandler.send('GetTextContent', { pageIndex: this.pageNumber - 1 }, function textContentCallback(textContent) { promise.resolve(textContent); } ); return promise; }, /** * Stub for future feature. */ getOperationList: function PDFPageProxy_getOperationList() { var promise = new PDFJS.Promise(); var operationList = { // not implemented dependencyFontsID: null, operatorList: null }; promise.resolve(operationList); return promise; }, /** * Destroys resources allocated by the page. */ destroy: function PDFPageProxy_destroy() { this.destroyed = true; if (this.renderTasks.length === 0) { this._destroy(); } }, /** * For internal use only. Does the actual cleanup. */ _destroy: function PDFPageProxy__destroy() { delete this.operatorList; delete this.displayReadyPromise; this.objs.clear(); }, /** * For internal use only. */ _startRenderPage: function PDFPageProxy_startRenderPage(transparency) { this.displayReadyPromise.resolve(transparency); }, /** * For internal use only. */ _renderPageChunk: function PDFPageProxy_renderPageChunk(operatorListChunk) { // Add the new chunk to the current operator list. Util.concatenateToArray(this.operatorList.fnArray, operatorListChunk.fnArray); Util.concatenateToArray(this.operatorList.argsArray, operatorListChunk.argsArray); this.operatorList.lastChunk = operatorListChunk.lastChunk; // Notify all the rendering tasks there are more operators to be consumed. for (var i = 0; i < this.renderTasks.length; i++) { this.renderTasks[i].operatorListChanged(); } } }; return PDFPageProxy; })(); /** * For internal use only. */ var WorkerTransport = (function WorkerTransportClosure() { function WorkerTransport(workerInitializedPromise, workerReadyPromise, pdfDataRangeTransport, progressCallback) { this.pdfDataRangeTransport = pdfDataRangeTransport; this.workerReadyPromise = workerReadyPromise; this.progressCallback = progressCallback; this.commonObjs = new PDFObjects(); this.pageCache = []; this.pagePromises = []; this.embeddedFontsUsed = false; this.passwordCallback = null; // If worker support isn't disabled explicit and the browser has worker // support, create a new web worker and test if it/the browser fullfills // all requirements to run parts of pdf.js in a web worker. // Right now, the requirement is, that an Uint8Array is still an Uint8Array // as it arrives on the worker. Chrome added this with version 15. if (!globalScope.PDFJS.disableWorker && typeof Worker !== 'undefined') { var workerSrc = PDFJS.workerSrc; if (typeof workerSrc === 'undefined') { error('No PDFJS.workerSrc specified'); } try { // Some versions of FF can't create a worker on localhost, see: // https://bugzilla.mozilla.org/show_bug.cgi?id=683280 var worker = new Worker(workerSrc); var messageHandler = new MessageHandler('main', worker); this.messageHandler = messageHandler; messageHandler.on('test', function transportTest(supportTypedArray) { if (supportTypedArray) { this.worker = worker; this.setupMessageHandler(messageHandler); } else { globalScope.PDFJS.disableWorker = true; this.setupFakeWorker(); } workerInitializedPromise.resolve(); }.bind(this)); var testObj = new Uint8Array(1); // Some versions of Opera throw a DATA_CLONE_ERR on // serializing the typed array. messageHandler.send('test', testObj); return; } catch (e) { info('The worker has been disabled.'); } } // Either workers are disabled, not supported or have thrown an exception. // Thus, we fallback to a faked worker. globalScope.PDFJS.disableWorker = true; this.setupFakeWorker(); workerInitializedPromise.resolve(); } WorkerTransport.prototype = { destroy: function WorkerTransport_destroy() { this.pageCache = []; this.pagePromises = []; var self = this; this.messageHandler.send('Terminate', null, function () { if (self.worker) { self.worker.terminate(); } }); }, setupFakeWorker: function WorkerTransport_setupFakeWorker() { warn('Setting up fake worker.'); // If we don't use a worker, just post/sendMessage to the main thread. var fakeWorker = { postMessage: function WorkerTransport_postMessage(obj) { fakeWorker.onmessage({data: obj}); }, terminate: function WorkerTransport_terminate() {} }; var messageHandler = new MessageHandler('main', fakeWorker); this.setupMessageHandler(messageHandler); // If the main thread is our worker, setup the handling for the messages // the main thread sends to it self. WorkerMessageHandler.setup(messageHandler); }, setupMessageHandler: function WorkerTransport_setupMessageHandler(messageHandler) { this.messageHandler = messageHandler; function updatePassword(password) { messageHandler.send('UpdatePassword', password); } var pdfDataRangeTransport = this.pdfDataRangeTransport; if (pdfDataRangeTransport) { pdfDataRangeTransport.addRangeListener(function(begin, chunk) { messageHandler.send('OnDataRange', { begin: begin, chunk: chunk }); }); pdfDataRangeTransport.addProgressListener(function(loaded) { messageHandler.send('OnDataProgress', { loaded: loaded }); }); messageHandler.on('RequestDataRange', function transportDataRange(data) { pdfDataRangeTransport.requestDataRange(data.begin, data.end); }, this); } messageHandler.on('GetDoc', function transportDoc(data) { var pdfInfo = data.pdfInfo; var pdfDocument = new PDFDocumentProxy(pdfInfo, this); this.pdfDocument = pdfDocument; this.workerReadyPromise.resolve(pdfDocument); }, this); messageHandler.on('NeedPassword', function transportPassword(data) { if (this.passwordCallback) { return this.passwordCallback(updatePassword, PasswordResponses.NEED_PASSWORD); } this.workerReadyPromise.reject(data.exception.message, data.exception); }, this); messageHandler.on('IncorrectPassword', function transportBadPass(data) { if (this.passwordCallback) { return this.passwordCallback(updatePassword, PasswordResponses.INCORRECT_PASSWORD); } this.workerReadyPromise.reject(data.exception.message, data.exception); }, this); messageHandler.on('InvalidPDF', function transportInvalidPDF(data) { this.workerReadyPromise.reject(data.exception.name, data.exception); }, this); messageHandler.on('MissingPDF', function transportMissingPDF(data) { this.workerReadyPromise.reject(data.exception.message, data.exception); }, this); messageHandler.on('UnknownError', function transportUnknownError(data) { this.workerReadyPromise.reject(data.exception.message, data.exception); }, this); messageHandler.on('GetPage', function transportPage(data) { var pageInfo = data.pageInfo; var page = new PDFPageProxy(pageInfo, this); this.pageCache[pageInfo.pageIndex] = page; var promise = this.pagePromises[pageInfo.pageIndex]; promise.resolve(page); }, this); messageHandler.on('GetAnnotations', function transportAnnotations(data) { var annotations = data.annotations; var promise = this.pageCache[data.pageIndex].annotationsPromise; promise.resolve(annotations); }, this); messageHandler.on('StartRenderPage', function transportRender(data) { var page = this.pageCache[data.pageIndex]; page.stats.timeEnd('Page Request'); page._startRenderPage(data.transparency); }, this); messageHandler.on('RenderPageChunk', function transportRender(data) { var page = this.pageCache[data.pageIndex]; page._renderPageChunk(data.operatorList); }, this); messageHandler.on('commonobj', function transportObj(data) { var id = data[0]; var type = data[1]; if (this.commonObjs.hasData(id)) return; switch (type) { case 'Font': var exportedData = data[2]; var font; if ('error' in exportedData) { var error = exportedData.error; warn('Error during font loading: ' + error); this.commonObjs.resolve(id, error); break; } else { font = new Font(exportedData); } FontLoader.bind( [font], function fontReady(fontObjs) { this.commonObjs.resolve(id, font); }.bind(this) ); break; default: error('Got unknown common object type ' + type); } }, this); messageHandler.on('obj', function transportObj(data) { var id = data[0]; var pageIndex = data[1]; var type = data[2]; var pageProxy = this.pageCache[pageIndex]; if (pageProxy.objs.hasData(id)) return; switch (type) { case 'JpegStream': var imageData = data[3]; loadJpegStream(id, imageData, pageProxy.objs); break; case 'Image': var imageData = data[3]; pageProxy.objs.resolve(id, imageData); // heuristics that will allow not to store large data var MAX_IMAGE_SIZE_TO_STORE = 8000000; if ('data' in imageData && imageData.data.length > MAX_IMAGE_SIZE_TO_STORE) { pageProxy.cleanupAfterRender = true; } break; default: error('Got unknown object type ' + type); } }, this); messageHandler.on('DocProgress', function transportDocProgress(data) { if (this.progressCallback) { this.progressCallback({ loaded: data.loaded, total: data.total }); } }, this); messageHandler.on('DocError', function transportDocError(data) { this.workerReadyPromise.reject(data); }, this); messageHandler.on('PageError', function transportError(data) { var page = this.pageCache[data.pageNum - 1]; if (page.displayReadyPromise) page.displayReadyPromise.reject(data.error); else error(data.error); }, this); messageHandler.on('JpegDecode', function(data, promise) { var imageData = data[0]; var components = data[1]; if (components != 3 && components != 1) error('Only 3 component or 1 component can be returned'); var img = new Image(); img.onload = (function messageHandler_onloadClosure() { var width = img.width; var height = img.height; var size = width * height; var rgbaLength = size * 4; var buf = new Uint8Array(size * components); var tmpCanvas = createScratchCanvas(width, height); var tmpCtx = tmpCanvas.getContext('2d'); tmpCtx.drawImage(img, 0, 0); var data = tmpCtx.getImageData(0, 0, width, height).data; if (components == 3) { for (var i = 0, j = 0; i < rgbaLength; i += 4, j += 3) { buf[j] = data[i]; buf[j + 1] = data[i + 1]; buf[j + 2] = data[i + 2]; } } else if (components == 1) { for (var i = 0, j = 0; i < rgbaLength; i += 4, j++) { buf[j] = data[i]; } } promise.resolve({ data: buf, width: width, height: height}); }).bind(this); var src = 'data:image/jpeg;base64,' + window.btoa(imageData); img.src = src; }); }, fetchDocument: function WorkerTransport_fetchDocument(source) { source.disableAutoFetch = PDFJS.disableAutoFetch; source.chunkedViewerLoading = !!this.pdfDataRangeTransport; this.messageHandler.send('GetDocRequest', { source: source, disableRange: PDFJS.disableRange, maxImageSize: PDFJS.maxImageSize }); }, getData: function WorkerTransport_getData(promise) { this.messageHandler.send('GetData', null, function(data) { promise.resolve(data); }); }, dataLoaded: function WorkerTransport_dataLoaded() { var promise = new PDFJS.Promise(); this.messageHandler.send('DataLoaded', null, function(args) { promise.resolve(args); }); return promise; }, getPage: function WorkerTransport_getPage(pageNumber, promise) { var pageIndex = pageNumber - 1; if (pageIndex in this.pagePromises) return this.pagePromises[pageIndex]; var promise = new PDFJS.Promise('Page ' + pageNumber); this.pagePromises[pageIndex] = promise; this.messageHandler.send('GetPageRequest', { pageIndex: pageIndex }); return promise; }, getAnnotations: function WorkerTransport_getAnnotations(pageIndex) { this.messageHandler.send('GetAnnotationsRequest', { pageIndex: pageIndex }); }, getDestinations: function WorkerTransport_getDestinations() { var promise = new PDFJS.Promise(); this.messageHandler.send('GetDestinations', null, function transportDestinations(destinations) { promise.resolve(destinations); } ); return promise; } }; return WorkerTransport; })(); /** * RenderTask is basically a promise but adds a cancel function to terminate it. */ var RenderTask = (function RenderTaskClosure() { function RenderTask(internalRenderTask) { this.internalRenderTask = internalRenderTask; Promise.call(this); } RenderTask.prototype = Object.create(Promise.prototype); /** * Cancel the rendering task. If the task is curently rendering it will not be * cancelled until graphics pauses with a timeout. The promise that this * object extends will resolved when cancelled. */ RenderTask.prototype.cancel = function RenderTask_cancel() { this.internalRenderTask.cancel(); }; return RenderTask; })(); var InternalRenderTask = (function InternalRenderTaskClosure() { function InternalRenderTask(callback, params, objs, commonObjs, operatorList, pageNumber) { this.callback = callback; this.params = params; this.objs = objs; this.commonObjs = commonObjs; this.operatorListIdx = null; this.operatorList = operatorList; this.pageNumber = pageNumber; this.running = false; this.graphicsReadyCallback = null; this.graphicsReady = false; this.cancelled = false; } InternalRenderTask.prototype = { initalizeGraphics: function InternalRenderTask_initalizeGraphics(transparency) { if (this.cancelled) { return; } if (PDFJS.pdfBug && 'StepperManager' in globalScope && globalScope.StepperManager.enabled) { this.stepper = globalScope.StepperManager.create(this.pageNumber - 1); this.stepper.init(this.operatorList); this.stepper.nextBreakPoint = this.stepper.getNextBreakPoint(); } var params = this.params; this.gfx = new CanvasGraphics(params.canvasContext, this.commonObjs, this.objs, params.textLayer, params.imageLayer); this.gfx.beginDrawing(params.viewport, transparency); this.operatorListIdx = 0; this.graphicsReady = true; if (this.graphicsReadyCallback) { this.graphicsReadyCallback(); } }, cancel: function InternalRenderTask_cancel() { this.running = false; this.cancelled = true; this.callback(); }, operatorListChanged: function InternalRenderTask_operatorListChanged() { if (!this.graphicsReady) { if (!this.graphicsReadyCallback) { this.graphicsReadyCallback = this._continue.bind(this); } return; } if (this.stepper) { this.stepper.updateOperatorList(this.operatorList); } if (this.running) { return; } this._continue(); }, _continue: function InternalRenderTask__continue() { this.running = true; if (this.cancelled) { return; } if (this.params.continueCallback) { this.params.continueCallback(this._next.bind(this)); } else { this._next(); } }, _next: function InternalRenderTask__next() { if (this.cancelled) { return; } this.operatorListIdx = this.gfx.executeOperatorList(this.operatorList, this.operatorListIdx, this._continue.bind(this), this.stepper); if (this.operatorListIdx === this.operatorList.fnArray.length) { this.running = false; if (this.operatorList.lastChunk) { this.gfx.endDrawing(); this.callback(); } } } }; return InternalRenderTask; })();