Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #10033 from timvandermeij/permissions-api

Browse Source 
[api-minor] Implement a permissions API
This commit is contained in:
Tim van der Meij 2018-09-02 21:38:29 +02:00 committed by GitHub
commit af89ec271d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 840 additions and 812 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
src/core/obj.js
View File

@ -15,9 +15,9 @@
import {
bytesToString, createPromiseCapability, createValidAbsoluteUrl, FormatError,
info, InvalidPDFException, isBool, isString, MissingDataException, shadow,
stringToPDFString, stringToUTF8String, toRomanNumerals, unreachable, warn,
XRefParseException
info, InvalidPDFException, isBool, isNum, isString, MissingDataException,
PermissionFlag, shadow, stringToPDFString, stringToUTF8String,
toRomanNumerals, unreachable, warn, XRefParseException
} from '../shared/util';
import {
Dict, isCmd, isDict, isName, isRef, isRefsEqual, isStream, Ref, RefSet,
@ -177,6 +177,48 @@ class Catalog {
return (root.items.length > 0 ? root.items : null);
}
get permissions() {
let permissions = null;
try {
permissions = this._readPermissions();
} catch (ex) {
if (ex instanceof MissingDataException) {
throw ex;
}
warn('Unable to read permissions.');
}
return shadow(this, 'permissions', permissions);
}
/**
* @private
*/
_readPermissions() {
const encrypt = this.xref.trailer.get('Encrypt');
if (!isDict(encrypt)) {
return null;
}
let flags = encrypt.get('P');
if (!isNum(flags)) {
return null;
}
// PDF integer objects are represented internally in signed 2's complement
// form. Therefore, convert the signed decimal integer to a signed 2's
// complement binary integer so we can use regular bitwise operations on it.
flags += 2 ** 32;
const permissions = [];
for (const key in PermissionFlag) {
const value = PermissionFlag[key];
if (flags & value) {
permissions.push(value);
}
}
return permissions;
}
get numPages() {
const obj = this.toplevelPagesDict.get('Count');
if (!Number.isInteger(obj)) {

4
src/core/worker.js
View File

@ -703,6 +703,10 @@ var WorkerMessageHandler = {
}
);
handler.on('GetPermissions', function(data) {
return pdfManager.ensureCatalog('permissions');
});
handler.on('GetMetadata',
function wphSetupGetMetadata(data) {
return Promise.all([pdfManager.ensureDoc('documentInfo'),

402
src/display/api.js
View File

@ -577,92 +577,100 @@ var PDFDataRangeTransport = (function pdfDataRangeTransportClosure() {
/**
* Proxy to a PDFDocument in the worker thread. Also, contains commonly used
* properties that can be read synchronously.
* @class
* @alias PDFDocumentProxy
*/
var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
function PDFDocumentProxy(pdfInfo, transport, loadingTask) {
this._pdfInfo = pdfInfo;
this.transport = transport;
class PDFDocumentProxy {
constructor(pdfInfo, transport, loadingTask) {
this.loadingTask = loadingTask;
this._pdfInfo = pdfInfo;
this._transport = transport;
}
PDFDocumentProxy.prototype = /** @lends 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.
* @return {string} A (not guaranteed to be) unique ID to identify a PDF.
*/
get fingerprint() {
return this._pdfInfo.fingerprint;
},
}
/**
* @param {number} pageNumber The page number to get. The first page is 1.
* @param {number} pageNumber - The page number to get. The first page is 1.
* @return {Promise} A promise that is resolved with a {@link PDFPageProxy}
* object.
*/
getPage(pageNumber) {
return this.transport.getPage(pageNumber);
},
return this._transport.getPage(pageNumber);
}
/**
* @param {{num: number, gen: number}} ref The page reference. Must have
* the 'num' and 'gen' properties.
* @param {{num: number, gen: number}} ref - The page reference. Must have
* the `num` and `gen` properties.
* @return {Promise} A promise that is resolved with the page index that is
* associated with the reference.
*/
getPageIndex: function PDFDocumentProxy_getPageIndex(ref) {
return this.transport.getPageIndex(ref);
},
getPageIndex(ref) {
return this._transport.getPageIndex(ref);
}
/**
* @return {Promise} A promise that is resolved with a lookup table for
* mapping named destinations to reference numbers.
*
* This can be slow for large documents: use getDestination instead
* This can be slow for large documents. Use `getDestination` instead.
*/
getDestinations: function PDFDocumentProxy_getDestinations() {
return this.transport.getDestinations();
},
getDestinations() {
return this._transport.getDestinations();
}
/**
* @param {string} id - The named destination to get.
* @return {Promise} A promise that is resolved with all information
* of the given named destination.
*/
getDestination: function PDFDocumentProxy_getDestination(id) {
return this.transport.getDestination(id);
},
getDestination(id) {
return this._transport.getDestination(id);
}
/**
* @return {Promise} A promise that is resolved with:
* an Array containing the pageLabels that correspond to the pageIndexes,
* or `null` when no pageLabels are present in the PDF file.
* @return {Promise} A promise that is resolved with an {Array} containing
* the page labels that correspond to the page indexes, or `null` when
* no page labels are present in the PDF file.
*/
getPageLabels: function PDFDocumentProxy_getPageLabels() {
return this.transport.getPageLabels();
},
getPageLabels() {
return this._transport.getPageLabels();
}
/**
* @return {Promise} A promise that is resolved with a {string} containing
* the PageMode name.
* the page mode name.
*/
getPageMode() {
return this.transport.getPageMode();
},
return this._transport.getPageMode();
}
/**
* @return {Promise} A promise that is resolved with a lookup table for
* mapping named attachments to their content.
*/
getAttachments: function PDFDocumentProxy_getAttachments() {
return this.transport.getAttachments();
},
getAttachments() {
return this._transport.getAttachments();
}
/**
* @return {Promise} A promise that is resolved with an {Array} of all the
* JavaScript strings in the name tree, or `null` if no JavaScript exists.
*/
getJavaScript() {
return this.transport.getJavaScript();
},
return this._transport.getJavaScript();
}
/**
* @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:
@ -677,54 +685,70 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
* items: array of more items like this
* },
* ...
* ].
* ]
*/
getOutline: function PDFDocumentProxy_getOutline() {
return this.transport.getOutline();
},
getOutline() {
return this._transport.getOutline();
}
/**
* @return {Promise} A promise that is resolved with an {Array} that contains
* the permission flags for the PDF document, or `null` when
* no permissions are present in the PDF file.
*/
getPermissions() {
return this._transport.getPermissions();
}
/**
* @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.
* `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() {
return this.transport.getMetadata();
},
getMetadata() {
return this._transport.getMetadata();
}
/**
* @return {Promise} A promise that is resolved with a TypedArray that has
* @return {Promise} A promise that is resolved with a {TypedArray} that has
* the raw data from the PDF.
*/
getData: function PDFDocumentProxy_getData() {
return this.transport.getData();
},
getData() {
return this._transport.getData();
}
/**
* @return {Promise} A promise that is resolved when the document's data
* is loaded. It is resolved with an {Object} that contains the length
* is loaded. It is resolved with an {Object} that contains the `length`
* property that indicates size of the PDF data in bytes.
*/
getDownloadInfo: function PDFDocumentProxy_getDownloadInfo() {
return this.transport.downloadInfoCapability.promise;
},
getDownloadInfo() {
return this._transport.downloadInfoCapability.promise;
}
/**
* @return {Promise} A promise this is resolved with current stats about
* @return {Promise} A promise this is resolved with current statistics about
* document structures (see {@link PDFDocumentStats}).
*/
getStats: function PDFDocumentProxy_getStats() {
return this.transport.getStats();
},
getStats() {
return this._transport.getStats();
}
/**
* Cleans up resources allocated by the document, e.g. created @font-face.
* Cleans up resources allocated by the document, e.g. created `@font-face`.
*/
cleanup: function PDFDocumentProxy_cleanup() {
this.transport.startCleanup();
},
cleanup() {
this._transport.startCleanup();
}
/**
* Destroys current document instance and terminates worker.
* Destroys the current document instance and terminates the worker.
*/
destroy: function PDFDocumentProxy_destroy() {
destroy() {
return this.loadingTask.destroy();
},
}
/**
* @return {Object} A subset of the current {DocumentInitParameters},
@ -732,11 +756,9 @@ var PDFDocumentProxy = (function PDFDocumentProxyClosure() {
* may be affected by the `apiCompatibilityParams`.
*/
get loadingParams() {
return this.transport.loadingParams;
},
};
return PDFDocumentProxy;
})();
return this._transport.loadingParams;
}
}
/**
* Page getTextContent parameters.
@ -1616,8 +1638,8 @@ var PDFWorker = (function PDFWorkerClosure() {
* For internal use only.
* @ignore
*/
var WorkerTransport = (function WorkerTransportClosure() {
function WorkerTransport(messageHandler, loadingTask, networkStream, params) {
class WorkerTransport {
constructor(messageHandler, loadingTask, networkStream, params) {
this.messageHandler = messageHandler;
this.loadingTask = loadingTask;
this.commonObjs = new PDFObjects();
@ -1642,8 +1664,8 @@ var WorkerTransport = (function WorkerTransportClosure() {
this.setupMessageHandler();
}
WorkerTransport.prototype = {
destroy: function WorkerTransport_destroy() {
destroy() {
if (this.destroyCapability) {
return this.destroyCapability.promise;
}
@ -1656,7 +1678,7 @@ var WorkerTransport = (function WorkerTransportClosure() {
new Error('Worker was destroyed during onPassword callback'));
}
var waitOn = [];
const waitOn = [];
// We need to wait for all renderings to be completed, e.g.
// timeout/rAF can take a long time.
this.pageCache.forEach(function(page) {
@ -1667,7 +1689,7 @@ var WorkerTransport = (function WorkerTransportClosure() {
this.pageCache = [];
this.pagePromises = [];
// We also need to wait for the worker to finish its long running tasks.
var terminated = this.messageHandler.sendWithPromise('Terminate', null);
const terminated = this.messageHandler.sendWithPromise('Terminate', null);
waitOn.push(terminated);
Promise.all(waitOn).then(() => {
this.fontLoader.clear();
@ -1682,11 +1704,10 @@ var WorkerTransport = (function WorkerTransportClosure() {
this.destroyCapability.resolve();
}, this.destroyCapability.reject);
return this.destroyCapability.promise;
},
}
setupMessageHandler: function WorkerTransport_setupMessageHandler() {
var messageHandler = this.messageHandler;
var loadingTask = this.loadingTask;
setupMessageHandler() {
const { messageHandler, loadingTask, } = this;
messageHandler.on('GetReader', function(data, sink) {
assert(this._networkStream);
@ -1718,21 +1739,19 @@ var WorkerTransport = (function WorkerTransportClosure() {
}, this);
messageHandler.on('ReaderHeadersReady', function(data) {
let headersCapability = createPromiseCapability();
let fullReader = this._fullReader;
const headersCapability = createPromiseCapability();
const fullReader = this._fullReader;
fullReader.headersReady.then(() => {
// If stream or range are disabled, it's our only way to report
// loading progress.
if (!fullReader.isStreamingSupported ||
!fullReader.isRangeSupported) {
if (this._lastProgress) {
let loadingTask = this.loadingTask;
if (loadingTask.onProgress) {
loadingTask.onProgress(this._lastProgress);
}
}
fullReader.onProgress = (evt) => {
let loadingTask = this.loadingTask;
if (loadingTask.onProgress) {
loadingTask.onProgress({
loaded: evt.loaded,
@ -1754,11 +1773,11 @@ var WorkerTransport = (function WorkerTransportClosure() {
messageHandler.on('GetRangeReader', function(data, sink) {
assert(this._networkStream);
let _rangeReader =
const rangeReader =
this._networkStream.getRangeReader(data.begin, data.end);
sink.onPull = () => {
_rangeReader.read().then(function({ value, done, }) {
rangeReader.read().then(function({ value, done, }) {
if (done) {
sink.close();
return;
@ -1771,24 +1790,21 @@ var WorkerTransport = (function WorkerTransportClosure() {
};
sink.onCancel = (reason) => {
_rangeReader.cancel(reason);
rangeReader.cancel(reason);
};
}, this);
messageHandler.on('GetDoc', function transportDoc({ pdfInfo, }) {
messageHandler.on('GetDoc', function({ pdfInfo, }) {
this.numPages = pdfInfo.numPages;
var loadingTask = this.loadingTask;
var pdfDocument = new PDFDocumentProxy(pdfInfo, this, loadingTask);
this.pdfDocument = pdfDocument;
loadingTask._capability.resolve(pdfDocument);
this.pdfDocument = new PDFDocumentProxy(pdfInfo, this, loadingTask);
loadingTask._capability.resolve(this.pdfDocument);
}, this);
messageHandler.on('PasswordRequest',
function transportPasswordRequest(exception) {
messageHandler.on('PasswordRequest', function(exception) {
this._passwordCapability = createPromiseCapability();
if (loadingTask.onPassword) {
var updatePassword = (password) => {
const updatePassword = (password) => {
this._passwordCapability.resolve({
password,
});
@ -1805,80 +1821,76 @@ var WorkerTransport = (function WorkerTransportClosure() {
return this._passwordCapability.promise;
}, this);
messageHandler.on('PasswordException',
function transportPasswordException(exception) {
messageHandler.on('PasswordException', function(exception) {
loadingTask._capability.reject(
new PasswordException(exception.message, exception.code));
}, this);
messageHandler.on('InvalidPDF', function transportInvalidPDF(exception) {
this.loadingTask._capability.reject(
messageHandler.on('InvalidPDF', function(exception) {
loadingTask._capability.reject(
new InvalidPDFException(exception.message));
}, this);
messageHandler.on('MissingPDF', function transportMissingPDF(exception) {
this.loadingTask._capability.reject(
messageHandler.on('MissingPDF', function(exception) {
loadingTask._capability.reject(
new MissingPDFException(exception.message));
}, this);
messageHandler.on('UnexpectedResponse',
function transportUnexpectedResponse(exception) {
this.loadingTask._capability.reject(
messageHandler.on('UnexpectedResponse', function(exception) {
loadingTask._capability.reject(
new UnexpectedResponseException(exception.message, exception.status));
}, this);
messageHandler.on('UnknownError',
function transportUnknownError(exception) {
this.loadingTask._capability.reject(
messageHandler.on('UnknownError', function(exception) {
loadingTask._capability.reject(
new UnknownErrorException(exception.message, exception.details));
}, this);
messageHandler.on('DataLoaded', function transportPage(data) {
messageHandler.on('DataLoaded', function(data) {
this.downloadInfoCapability.resolve(data);
}, this);
messageHandler.on('StartRenderPage', function transportRender(data) {
messageHandler.on('StartRenderPage', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var page = this.pageCache[data.pageIndex];
const page = this.pageCache[data.pageIndex];
page._stats.timeEnd('Page Request');
page._startRenderPage(data.transparency, data.intent);
}, this);
messageHandler.on('RenderPageChunk', function transportRender(data) {
messageHandler.on('RenderPageChunk', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var page = this.pageCache[data.pageIndex];
const page = this.pageCache[data.pageIndex];
page._renderPageChunk(data.operatorList, data.intent);
}, this);
messageHandler.on('commonobj', function transportObj(data) {
messageHandler.on('commonobj', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var id = data[0];
var type = data[1];
const [id, type, exportedData] = data;
if (this.commonObjs.hasData(id)) {
return;
}
switch (type) {
case 'Font':
var exportedData = data[2];
let params = this._params;
const params = this._params;
if ('error' in exportedData) {
var exportedError = exportedData.error;
warn('Error during font loading: ' + exportedError);
const exportedError = exportedData.error;
warn(`Error during font loading: ${exportedError}`);
this.commonObjs.resolve(id, exportedError);
break;
}
var fontRegistry = null;
let fontRegistry = null;
if (params.pdfBug && globalScope.FontInspector &&
globalScope.FontInspector.enabled) {
fontRegistry = {
@ -1887,44 +1899,40 @@ var WorkerTransport = (function WorkerTransportClosure() {
},
};
}
var font = new FontFaceObject(exportedData, {
const font = new FontFaceObject(exportedData, {
isEvalSupported: params.isEvalSupported,
disableFontFace: params.disableFontFace,
ignoreErrors: params.ignoreErrors,
onUnsupportedFeature: this._onUnsupportedFeature.bind(this),
fontRegistry,
});
var fontReady = (fontObjs) => {
const fontReady = (fontObjs) => {
this.commonObjs.resolve(id, font);
};
this.fontLoader.bind([font], fontReady);
break;
case 'FontPath':
this.commonObjs.resolve(id, data[2]);
this.commonObjs.resolve(id, exportedData);
break;
default:
throw new Error(`Got unknown common object type ${type}`);
}
}, this);
messageHandler.on('obj', function transportObj(data) {
messageHandler.on('obj', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var id = data[0];
var pageIndex = data[1];
var type = data[2];
var pageProxy = this.pageCache[pageIndex];
var imageData;
const [id, pageIndex, type, imageData] = data;
const pageProxy = this.pageCache[pageIndex];
if (pageProxy.objs.hasData(id)) {
return;
}
switch (type) {
case 'JpegStream':
imageData = data[3];
return new Promise((resolve, reject) => {
const img = new Image();
img.onload = function() {
@ -1942,11 +1950,10 @@ var WorkerTransport = (function WorkerTransportClosure() {
pageProxy.objs.resolve(id, img);
});
case 'Image':
imageData = data[3];
pageProxy.objs.resolve(id, imageData);
// heuristics that will allow not to store large data
var MAX_IMAGE_SIZE_TO_STORE = 8000000;
// Heuristic that will allow us not to store large data.
const MAX_IMAGE_SIZE_TO_STORE = 8000000;
if (imageData && 'data' in imageData &&
imageData.data.length > MAX_IMAGE_SIZE_TO_STORE) {
pageProxy.cleanupAfterRender = true;
@ -1957,12 +1964,11 @@ var WorkerTransport = (function WorkerTransportClosure() {
}
}, this);
messageHandler.on('DocProgress', function transportDocProgress(data) {
messageHandler.on('DocProgress', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var loadingTask = this.loadingTask;
if (loadingTask.onProgress) {
loadingTask.onProgress({
loaded: data.loaded,
@ -1971,13 +1977,13 @@ var WorkerTransport = (function WorkerTransportClosure() {
}
}, this);
messageHandler.on('PageError', function transportError(data) {
messageHandler.on('PageError', function(data) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
var page = this.pageCache[data.pageNum - 1];
var intentState = page.intentStates[data.intent];
const page = this.pageCache[data.pageNum - 1];
const intentState = page.intentStates[data.intent];
if (intentState.displayReadyCapability) {
intentState.displayReadyCapability.reject(data.error);
@ -1988,7 +1994,7 @@ var WorkerTransport = (function WorkerTransportClosure() {
if (intentState.operatorList) {
// Mark operator list as complete.
intentState.operatorList.lastChunk = true;
for (var i = 0; i < intentState.renderTasks.length; i++) {
for (let i = 0; i < intentState.renderTasks.length; i++) {
intentState.renderTasks[i].operatorListChanged();
}
}
@ -2007,37 +2013,35 @@ var WorkerTransport = (function WorkerTransportClosure() {
return Promise.reject(new Error('"document" is not defined.'));
}
var imageUrl = data[0];
var components = data[1];
const [imageUrl, components] = data;
if (components !== 3 && components !== 1) {
return Promise.reject(
new Error('Only 3 components or 1 component can be returned'));
}
return new Promise(function (resolve, reject) {
var img = new Image();
const img = new Image();
img.onload = function () {
var width = img.width;
var height = img.height;
var size = width * height;
var rgbaLength = size * 4;
var buf = new Uint8ClampedArray(size * components);
var tmpCanvas = document.createElement('canvas');
const width = img.width;
const height = img.height;
const size = width * height;
const rgbaLength = size * 4;
const buf = new Uint8ClampedArray(size * components);
const tmpCanvas = document.createElement('canvas');
tmpCanvas.width = width;
tmpCanvas.height = height;
var tmpCtx = tmpCanvas.getContext('2d');
const tmpCtx = tmpCanvas.getContext('2d');
tmpCtx.drawImage(img, 0, 0);
var data = tmpCtx.getImageData(0, 0, width, height).data;
var i, j;
const data = tmpCtx.getImageData(0, 0, width, height).data;
if (components === 3) {
for (i = 0, j = 0; i < rgbaLength; i += 4, j += 3) {
for (let 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 (i = 0, j = 0; i < rgbaLength; i += 4, j++) {
for (let i = 0, j = 0; i < rgbaLength; i += 4, j++) {
buf[j] = data[i];
}
}
@ -2058,21 +2062,20 @@ var WorkerTransport = (function WorkerTransportClosure() {
name: data.name,
});
}, this);
},
}
_onUnsupportedFeature({ featureId, }) {
if (this.destroyed) {
return; // Ignore any pending requests if the worker was terminated.
}
let loadingTask = this.loadingTask;
if (loadingTask.onUnsupportedFeature) {
loadingTask.onUnsupportedFeature(featureId);
if (this.loadingTask.onUnsupportedFeature) {
this.loadingTask.onUnsupportedFeature(featureId);
}
}
},
getData: function WorkerTransport_getData() {
getData() {
return this.messageHandler.sendWithPromise('GetData', null);
},
}
getPage(pageNumber) {
if (!Number.isInteger(pageNumber) ||
@ -2080,74 +2083,78 @@ var WorkerTransport = (function WorkerTransportClosure() {
return Promise.reject(new Error('Invalid page request'));
}
var pageIndex = pageNumber - 1;
const pageIndex = pageNumber - 1;
if (pageIndex in this.pagePromises) {
return this.pagePromises[pageIndex];
}
var promise = this.messageHandler.sendWithPromise('GetPage', {
const promise = this.messageHandler.sendWithPromise('GetPage', {
pageIndex,
}).then((pageInfo) => {
if (this.destroyed) {
throw new Error('Transport destroyed');
}
let page = new PDFPageProxy(pageIndex, pageInfo, this,
const page = new PDFPageProxy(pageIndex, pageInfo, this,
this._params.pdfBug);
this.pageCache[pageIndex] = page;
return page;
});
this.pagePromises[pageIndex] = promise;
return promise;
},
}
getPageIndex: function WorkerTransport_getPageIndexByRef(ref) {
getPageIndex(ref) {
return this.messageHandler.sendWithPromise('GetPageIndex', {
ref,
}).catch(function(reason) {
return Promise.reject(new Error(reason));
});
},
}
getAnnotations: function WorkerTransport_getAnnotations(pageIndex, intent) {
getAnnotations(pageIndex, intent) {
return this.messageHandler.sendWithPromise('GetAnnotations', {
pageIndex,
intent,
});
},
}
getDestinations: function WorkerTransport_getDestinations() {
getDestinations() {
return this.messageHandler.sendWithPromise('GetDestinations', null);
},
}
getDestination: function WorkerTransport_getDestination(id) {
getDestination(id) {
if (typeof id !== 'string') {
return Promise.reject(new Error('Invalid destination request.'));
}
return this.messageHandler.sendWithPromise('GetDestination', {
id,
});
},
}
getPageLabels: function WorkerTransport_getPageLabels() {
getPageLabels() {
return this.messageHandler.sendWithPromise('GetPageLabels', null);
},
}
getPageMode() {
return this.messageHandler.sendWithPromise('GetPageMode', null);
},
}
getAttachments: function WorkerTransport_getAttachments() {
getAttachments() {
return this.messageHandler.sendWithPromise('GetAttachments', null);
},
}
getJavaScript: function WorkerTransport_getJavaScript() {
getJavaScript() {
return this.messageHandler.sendWithPromise('GetJavaScript', null);
},
}
getOutline: function WorkerTransport_getOutline() {
getOutline() {
return this.messageHandler.sendWithPromise('GetOutline', null);
},
}
getMetadata: function WorkerTransport_getMetadata() {
getPermissions() {
return this.messageHandler.sendWithPromise('GetPermissions', null);
}
getMetadata() {
return this.messageHandler.sendWithPromise('GetMetadata', null).
then((results) => {
return {
@ -2157,16 +2164,16 @@ var WorkerTransport = (function WorkerTransportClosure() {
this._fullReader.filename : null),
};
});
},
}
getStats: function WorkerTransport_getStats() {
getStats() {
return this.messageHandler.sendWithPromise('GetStats', null);
},
}
startCleanup: function WorkerTransport_startCleanup() {
startCleanup() {
this.messageHandler.sendWithPromise('Cleanup', null).then(() => {
for (var i = 0, ii = this.pageCache.length; i < ii; i++) {
var page = this.pageCache[i];
for (let i = 0, ii = this.pageCache.length; i < ii; i++) {
const page = this.pageCache[i];
if (page) {
page.cleanup();
}
@ -2174,21 +2181,18 @@ var WorkerTransport = (function WorkerTransportClosure() {
this.commonObjs.clear();
this.fontLoader.clear();
});
},
}
get loadingParams() {
let params = this._params;
const params = this._params;
return shadow(this, 'loadingParams', {
disableAutoFetch: params.disableAutoFetch,
disableCreateObjectURL: params.disableCreateObjectURL,
disableFontFace: params.disableFontFace,
nativeImageDecoderSupport: params.nativeImageDecoderSupport,
});
},
};
return WorkerTransport;
})();
}
}
/**
* A PDF document and page is built of many objects. E.g. there are objects

13
src/shared/util.js
View File

@ -25,6 +25,18 @@ const NativeImageDecoding = {
DISPLAY: 'display',
};
// Permission flags from Table 22, Section 7.6.3.2 of the PDF specification.
const PermissionFlag = {
PRINT: 0x04,
MODIFY_CONTENTS: 0x08,
COPY: 0x10,
MODIFY_ANNOTATIONS: 0x20,
FILL_INTERACTIVE_FORMS: 0x100,
COPY_FOR_ACCESSIBILITY: 0x200,
ASSEMBLE: 0x400,
PRINT_HIGH_QUALITY: 0x800,
};
var TextRenderingMode = {
FILL: 0,
STROKE: 1,
@ -1014,6 +1026,7 @@ export {
NativeImageDecoding,
PasswordException,
PasswordResponses,
PermissionFlag,
StreamType,
TextRenderingMode,
UnexpectedResponseException,

3
test/pdfs/.gitignore vendored
View File

@ -325,3 +325,6 @@
!transparent.pdf
!xobject-image.pdf
!ccitt_EndOfBlock_false.pdf
!issue9972-1.pdf
!issue9972-2.pdf
!issue9972-3.pdf

BIN
test/pdfs/issue9972-1.pdf Normal file
View File

Binary file not shown.

BIN
test/pdfs/issue9972-2.pdf Normal file
View File

Binary file not shown.

BIN
test/pdfs/issue9972-3.pdf Normal file
View File

Binary file not shown.

238
test/unit/api_spec.js
View File

@ -18,7 +18,8 @@ import {
} from './test_utils';
import {
createPromiseCapability, FontType, InvalidPDFException, MissingPDFException,
OPS, PasswordException, PasswordResponses, StreamType, stringToBytes
OPS, PasswordException, PasswordResponses, PermissionFlag, StreamType,
stringToBytes
} from '../../src/shared/util';
import {
DOMCanvasFactory, RenderingCancelledException, StatTimer
@ -84,9 +85,7 @@ describe('api', function() {
expect(data[1] instanceof PDFDocumentProxy).toEqual(true);
expect(loadingTask).toEqual(data[1].loadingTask);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates pdf doc from URL and aborts before worker initialized',
function(done) {
@ -111,9 +110,7 @@ describe('api', function() {
destroyed.then(function (data) {
expect(true).toEqual(true);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates pdf doc from typed array', function(done) {
var typedArrayPdf;
@ -149,9 +146,7 @@ describe('api', function() {
loadingTask.promise.then(function(data) {
expect(data instanceof PDFDocumentProxy).toEqual(true);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates pdf doc from invalid PDF file', function(done) {
// A severely corrupt PDF file (even Adobe Reader fails to open it).
@ -213,9 +208,7 @@ describe('api', function() {
Promise.all(promises).then(function (data) {
expect(data[2] instanceof PDFDocumentProxy).toEqual(true);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates pdf doc from PDF file protected with only a user password',
function (done) {
@ -257,9 +250,7 @@ describe('api', function() {
});
Promise.all([result1, result2, result3]).then(function () {
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates pdf doc from password protected PDF file and aborts/throws ' +
@ -309,9 +300,7 @@ describe('api', function() {
Promise.all([result1, result2]).then(function () {
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
});
@ -333,9 +322,7 @@ describe('api', function() {
expect(!!worker.port).toEqual(false);
expect(worker.destroyed).toEqual(true);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('worker created or destroyed by getDocument', function (done) {
if (isNodeJS()) {
@ -357,9 +344,7 @@ describe('api', function() {
expect(!!destroyedWorker).toEqual(false);
expect(worker.destroyed).toEqual(true);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('worker created and can be used in getDocument', function (done) {
if (isNodeJS()) {
@ -386,9 +371,7 @@ describe('api', function() {
expect(worker.destroyed).toEqual(false);
worker.destroy();
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('creates more than one worker', function (done) {
if (isNodeJS()) {
@ -408,9 +391,7 @@ describe('api', function() {
worker2.destroy();
worker3.destroy();
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets current workerSrc', function() {
if (isNodeJS()) {
@ -452,9 +433,7 @@ describe('api', function() {
expect(data instanceof PDFPageProxy).toEqual(true);
expect(data.pageIndex).toEqual(0);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets non-existent page', function(done) {
var outOfRangePromise = doc.getPage(100);
@ -480,9 +459,7 @@ describe('api', function() {
Promise.all([outOfRangePromise, nonIntegerPromise, nonNumberPromise]).
then(function () {
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets page index', function(done) {
// reference to second page
@ -491,9 +468,7 @@ describe('api', function() {
promise.then(function(pageIndex) {
expect(pageIndex).toEqual(1);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets invalid page index', function (done) {
var ref = { num: 3, gen: 0, }; // Reference to a font dictionary.
@ -513,9 +488,7 @@ describe('api', function() {
chapter1: [{ gen: 0, num: 17, }, { name: 'XYZ', }, 0, 841.89, null],
});
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets a destination, from /Dests dictionary', function(done) {
var promise = doc.getDestination('chapter1');
@ -523,9 +496,7 @@ describe('api', function() {
expect(data).toEqual([{ gen: 0, num: 17, }, { name: 'XYZ', },
0, 841.89, null]);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets a non-existent destination, from /Dests dictionary',
function(done) {
@ -533,9 +504,7 @@ describe('api', function() {
promise.then(function(data) {
expect(data).toEqual(null);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets destinations, from /Names (NameTree) dictionary', function(done) {
@ -550,9 +519,7 @@ describe('api', function() {
});
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets a destination, from /Names (NameTree) dictionary', function(done) {
var loadingTask = getDocument(buildGetDocumentParams('issue6204.pdf'));
@ -564,9 +531,7 @@ describe('api', function() {
0, 375, null]);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets a non-existent destination, from /Names (NameTree) dictionary',
function(done) {
@ -578,9 +543,7 @@ describe('api', function() {
expect(destination).toEqual(null);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets non-string destination', function(done) {
@ -614,9 +577,7 @@ describe('api', function() {
promise.then(function (data) {
expect(data).toEqual(null);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets page labels', function (done) {
// PageLabels with Roman/Arabic numerals.
@ -657,9 +618,7 @@ describe('api', function() {
loadingTask2.destroy(),
loadingTask3.destroy()
]).then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets default page mode', function(done) {
@ -671,17 +630,13 @@ describe('api', function() {
expect(mode).toEqual('UseNone');
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets non-default page mode', function(done) {
doc.getPageMode().then(function(mode) {
expect(mode).toEqual('UseOutlines');
done();
}).catch(function(reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets non-existent attachments', function(done) {
@ -689,9 +644,7 @@ describe('api', function() {
promise.then(function (data) {
expect(data).toEqual(null);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets attachments', function(done) {
if (isNodeJS()) { // The PDF file used is a linked test-case.
@ -708,9 +661,7 @@ describe('api', function() {
expect(attachment.content.length).toEqual(30098);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets javascript', function(done) {
@ -718,9 +669,7 @@ describe('api', function() {
promise.then(function (data) {
expect(data).toEqual(null);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
// Keep this in sync with the pattern in viewer.js. The pattern is used to
// detect whether or not to automatically start printing.
@ -736,9 +685,7 @@ describe('api', function() {
expect(data).toEqual(['print({});']);
expect(data[0]).toMatch(viewerPrintRegExp);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets javascript with printing instructions (JS action)',
function(done) {
@ -752,9 +699,7 @@ describe('api', function() {
['this.print({bUI:true,bSilent:false,bShrinkToFit:true});']);
expect(data[0]).toMatch(viewerPrintRegExp);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets non-existent outline', function(done) {
var loadingTask = getDocument(buildGetDocumentParams('tracemonkey.pdf'));
@ -766,9 +711,7 @@ describe('api', function() {
expect(outline).toEqual(null);
loadingTask.destroy().then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets outline', function(done) {
var promise = doc.getOutline();
@ -791,9 +734,7 @@ describe('api', function() {
expect(outlineItem.items.length).toEqual(1);
expect(outlineItem.items[0].title).toEqual('Paragraph 1.1');
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets outline containing a url', function(done) {
var loadingTask = getDocument(buildGetDocumentParams('issue3214.pdf'));
@ -818,10 +759,61 @@ describe('api', function() {
loadingTask.destroy().then(done);
});
}).catch(function (reason) {
done.fail(reason);
}).catch(done.fail);
});
it('gets non-existent permissions', function(done) {
doc.getPermissions().then(function(permissions) {
expect(permissions).toEqual(null);
done();
}).catch(done.fail);
});
it('gets permissions', function (done) {
// Editing not allowed.
const loadingTask0 =
getDocument(buildGetDocumentParams('issue9972-1.pdf'));
const promise0 = loadingTask0.promise.then(function(pdfDocument) {
return pdfDocument.getPermissions();
});
// Printing not allowed.
const loadingTask1 =
getDocument(buildGetDocumentParams('issue9972-2.pdf'));
const promise1 = loadingTask1.promise.then(function(pdfDocument) {
return pdfDocument.getPermissions();
});
// Copying not allowed.
const loadingTask2 =
getDocument(buildGetDocumentParams('issue9972-3.pdf'));
const promise2 = loadingTask2.promise.then(function(pdfDocument) {
return pdfDocument.getPermissions();
});
const totalPermissionCount = Object.keys(PermissionFlag).length;
Promise.all([promise0, promise1, promise2]).then(function(permissions) {
expect(permissions[0].length).toEqual(totalPermissionCount - 1);
expect(permissions[0].includes(PermissionFlag.MODIFY_CONTENTS))
.toBeFalsy();
expect(permissions[1].length).toEqual(totalPermissionCount - 2);
expect(permissions[1].includes(PermissionFlag.PRINT)).toBeFalsy();
expect(permissions[1].includes(PermissionFlag.PRINT_HIGH_QUALITY))
.toBeFalsy();
expect(permissions[2].length).toEqual(totalPermissionCount - 1);
expect(permissions[2].includes(PermissionFlag.COPY)).toBeFalsy();
Promise.all([
loadingTask0.destroy(),
loadingTask1.destroy(),
loadingTask2.destroy(),
]).then(done);
}).catch(done.fail);
});
it('gets metadata', function(done) {
var promise = doc.getMetadata();
promise.then(function({ info, metadata, contentDispositionFilename, }) {
@ -837,9 +829,7 @@ describe('api', function() {
expect(contentDispositionFilename).toEqual(null);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets data', function(done) {
var promise = doc.getData();
@ -847,27 +837,21 @@ describe('api', function() {
expect(data instanceof Uint8Array).toEqual(true);
expect(data.length).toEqual(basicApiFileLength);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets download info', function(done) {
var promise = doc.getDownloadInfo();
promise.then(function (data) {
expect(data).toEqual({ length: basicApiFileLength, });
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets document stats', function(done) {
var promise = doc.getStats();
promise.then(function (stats) {
expect(stats).toEqual({ streamTypes: [], fontTypes: [], });
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('checks that fingerprints are unique', function(done) {
@ -892,9 +876,7 @@ describe('api', function() {
loadingTask1.destroy(),
loadingTask2.destroy()
]).then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
describe('Cross-origin', function() {
@ -988,9 +970,7 @@ describe('api', function() {
page = data;
done();
});
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
afterAll(function(done) {
@ -1050,9 +1030,7 @@ describe('api', function() {
Promise.all([defaultPromise, displayPromise, printPromise]).then(
function () {
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets annotations containing relative URLs (bug 766086)',
@ -1112,9 +1090,7 @@ describe('api', function() {
docBaseUrlLoadingTask.destroy(),
invalidDocBaseUrlLoadingTask.destroy()
]).then(done);
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets text content', function (done) {
@ -1136,9 +1112,7 @@ describe('api', function() {
// A simple check that ensures the two `textContent` object match.
expect(JSON.stringify(data[0])).toEqual(JSON.stringify(data[1]));
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets operator list', function(done) {
var promise = page.getOperatorList();
@ -1147,9 +1121,7 @@ describe('api', function() {
expect(!!oplist.argsArray).toEqual(true);
expect(oplist.lastChunk).toEqual(true);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets operatorList with JPEG image (issue 4888)', function(done) {
let loadingTask = getDocument(buildGetDocumentParams('cmykjpeg.pdf'));
@ -1166,9 +1138,7 @@ describe('api', function() {
done();
});
});
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets document stats after parsing page', function(done) {
var promise = page.getOperatorList().then(function () {
@ -1184,9 +1154,7 @@ describe('api', function() {
expect(stats).toEqual({ streamTypes: expectedStreamTypes,
fontTypes: expectedFontTypes, });
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('gets page stats after parsing page, without `pdfBug` set',
@ -1420,9 +1388,7 @@ describe('api', function() {
});
promiseDone.then(function() {
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
});
describe('PDFDataRangeTransport', function () {
@ -1479,9 +1445,7 @@ describe('api', function() {
expect(page.rotate).toEqual(0);
expect(fetches).toBeGreaterThan(2);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
it('should fetch document info and page using range and streaming',
function (done) {
@ -1520,9 +1484,7 @@ describe('api', function() {
expect(page.rotate).toEqual(0);
expect(fetches).toEqual(1);
done();
}).catch(function (reason) {
done.fail(reason);
});
}).catch(done.fail);
});
});
});