b354682dd6
Currently for explicit destinations, compared to named destinations, we manually try to build a hash that often times is a quite poor representation of the *actual* destination. (Currently this only, kind of, works for `\XYZ` destinations.) For PDF files using explicit destinations, this can make it difficult/impossible to obtain a link to a specific section of the document through the URL. Note that in practice most PDF files, especially newer ones, use named destinations and these are thus unnaffected by this patch. This patch also fixes an existing issue in `PDFLinkService_getDestinationHash`, where a named destination consisting of only a number would not be handled correctly. With the added, and already existing, type checks in place for destinations, I really don't think that this patch exposes any "sensitive" internal destination code not already accessible through normal hash parameters. *Please note:* Just trying to improve the algorithm that generates the hash is unfortunately not possible in general, since there are a number of cases where it will simply never work well. - First of all, note that `getDestinationHash` currently relies on the `_pagesRefCache`, hence it's possible that the hash returned is empty during e.g. ranged/streamed loading of a PDF file. - Second of all, the currently computed hash is actually dependent on the document rotation. With named destinations, the fetched internal destination array is rotational invariant (as it should be), but this will not hold in general for the hash. We can easily avoid this issue by using a stringified destination array. - Third of all, note that according to the PDF specification[1], `GoToR` destinations may actually contain explicit destination arrays. Since we cannot really construct a hash in `annotation.js`, we currently have no good way to support those. Even though this case seems *very* rare in practice (I've not actually seen such a PDF file), it's in the specification, and this patch allows us to support that for "free". --- [1] http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/PDF32000_2008.pdf#G11.1951685
414 lines
14 KiB
JavaScript
414 lines
14 KiB
JavaScript
/* globals expect, it, describe, Dict, Name, Annotation, AnnotationBorderStyle,
|
|
AnnotationBorderStyleType, AnnotationType, AnnotationFlag, PDFJS,
|
|
beforeEach, afterEach, stringToBytes, AnnotationFactory, Ref,
|
|
beforeAll, afterAll */
|
|
|
|
'use strict';
|
|
|
|
describe('Annotation layer', function() {
|
|
function XrefMock(queue) {
|
|
this.queue = queue || [];
|
|
}
|
|
XrefMock.prototype = {
|
|
fetchIfRef: function() {
|
|
return this.queue.shift();
|
|
}
|
|
};
|
|
|
|
describe('Annotation', function() {
|
|
it('should set and get flags', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setFlags(13);
|
|
|
|
expect(annotation.hasFlag(AnnotationFlag.INVISIBLE)).toEqual(true);
|
|
expect(annotation.hasFlag(AnnotationFlag.NOZOOM)).toEqual(true);
|
|
expect(annotation.hasFlag(AnnotationFlag.PRINT)).toEqual(true);
|
|
expect(annotation.hasFlag(AnnotationFlag.READONLY)).toEqual(false);
|
|
});
|
|
|
|
it('should be viewable and not printable by default', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
|
|
expect(annotation.viewable).toEqual(true);
|
|
expect(annotation.printable).toEqual(false);
|
|
});
|
|
|
|
it('should set and get a valid rectangle', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setRectangle([117, 694, 164.298, 720]);
|
|
|
|
expect(annotation.rectangle).toEqual([117, 694, 164.298, 720]);
|
|
});
|
|
|
|
it('should not set and get an invalid rectangle', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setRectangle([117, 694, 164.298]);
|
|
|
|
expect(annotation.rectangle).toEqual([0, 0, 0, 0]);
|
|
});
|
|
|
|
it('should reject a color if it is not an array', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor('red');
|
|
|
|
expect(annotation.color).toEqual(new Uint8Array([0, 0, 0]));
|
|
});
|
|
|
|
it('should set and get a transparent color', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor([]);
|
|
|
|
expect(annotation.color).toEqual(null);
|
|
});
|
|
|
|
it('should set and get a grayscale color', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor([0.4]);
|
|
|
|
expect(annotation.color).toEqual(new Uint8Array([102, 102, 102]));
|
|
});
|
|
|
|
it('should set and get an RGB color', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor([0, 0, 1]);
|
|
|
|
expect(annotation.color).toEqual(new Uint8Array([0, 0, 255]));
|
|
});
|
|
|
|
it('should set and get a CMYK color', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor([0.1, 0.92, 0.84, 0.02]);
|
|
|
|
expect(annotation.color).toEqual(new Uint8Array([233, 59, 47]));
|
|
});
|
|
|
|
it('should not set and get an invalid color', function() {
|
|
var dict = new Dict();
|
|
dict.set('Subtype', '');
|
|
var annotation = new Annotation({ dict: dict, ref: 0 });
|
|
annotation.setColor([0.4, 0.6]);
|
|
|
|
expect(annotation.color).toEqual(new Uint8Array([0, 0, 0]));
|
|
});
|
|
});
|
|
|
|
describe('AnnotationBorderStyle', function() {
|
|
it('should set and get a valid width', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setWidth(3);
|
|
|
|
expect(borderStyle.width).toEqual(3);
|
|
});
|
|
|
|
it('should not set and get an invalid width', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setWidth('three');
|
|
|
|
expect(borderStyle.width).toEqual(1);
|
|
});
|
|
|
|
it('should set and get a valid style', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setStyle(Name.get('D'));
|
|
|
|
expect(borderStyle.style).toEqual(AnnotationBorderStyleType.DASHED);
|
|
});
|
|
|
|
it('should not set and get an invalid style', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setStyle('Dashed');
|
|
|
|
expect(borderStyle.style).toEqual(AnnotationBorderStyleType.SOLID);
|
|
});
|
|
|
|
it('should set and get a valid dash array', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setDashArray([1, 2, 3]);
|
|
|
|
expect(borderStyle.dashArray).toEqual([1, 2, 3]);
|
|
});
|
|
|
|
it('should not set and get an invalid dash array', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setDashArray([0, 0]);
|
|
|
|
expect(borderStyle.dashArray).toEqual([3]);
|
|
});
|
|
|
|
it('should set and get a valid horizontal corner radius', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setHorizontalCornerRadius(3);
|
|
|
|
expect(borderStyle.horizontalCornerRadius).toEqual(3);
|
|
});
|
|
|
|
it('should not set and get an invalid horizontal corner radius',
|
|
function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setHorizontalCornerRadius('three');
|
|
|
|
expect(borderStyle.horizontalCornerRadius).toEqual(0);
|
|
});
|
|
|
|
it('should set and get a valid vertical corner radius', function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setVerticalCornerRadius(3);
|
|
|
|
expect(borderStyle.verticalCornerRadius).toEqual(3);
|
|
});
|
|
|
|
it('should not set and get an invalid horizontal corner radius',
|
|
function() {
|
|
var borderStyle = new AnnotationBorderStyle();
|
|
borderStyle.setVerticalCornerRadius('three');
|
|
|
|
expect(borderStyle.verticalCornerRadius).toEqual(0);
|
|
});
|
|
});
|
|
|
|
describe('LinkAnnotation', function() {
|
|
var annotationFactory;
|
|
|
|
beforeAll(function (done) {
|
|
annotationFactory = new AnnotationFactory();
|
|
done();
|
|
});
|
|
|
|
afterAll(function () {
|
|
annotationFactory = null;
|
|
});
|
|
|
|
it('should correctly parse a URI action', function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('URI'));
|
|
actionDict.set('URI', 'http://www.ctan.org/tex-archive/info/lshort');
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(820, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toEqual('http://www.ctan.org/tex-archive/info/lshort');
|
|
expect(data.dest).toBeUndefined();
|
|
});
|
|
|
|
it('should correctly parse a URI action, where the URI entry ' +
|
|
'is missing a protocol', function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('URI'));
|
|
actionDict.set('URI', 'www.hmrc.gov.uk');
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(353, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toEqual('http://www.hmrc.gov.uk');
|
|
expect(data.dest).toBeUndefined();
|
|
});
|
|
|
|
it('should correctly parse a GoTo action', function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('GoTo'));
|
|
actionDict.set('D', 'page.157');
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(798, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toBeUndefined();
|
|
expect(data.dest).toEqual('page.157');
|
|
});
|
|
|
|
it('should correctly parse a GoToR action, where the FileSpec entry ' +
|
|
'is a string containing a relative URL', function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('GoToR'));
|
|
actionDict.set('F', '../../0013/001346/134685E.pdf');
|
|
actionDict.set('D', '4.3');
|
|
actionDict.set('NewWindow', true);
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(489, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toBeUndefined(); // ../../0013/001346/134685E.pdf#4.3
|
|
expect(data.dest).toBeUndefined();
|
|
expect(data.newWindow).toEqual(true);
|
|
});
|
|
|
|
it('should correctly parse a GoToR action, with named destination',
|
|
function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('GoToR'));
|
|
actionDict.set('F', 'http://www.example.com/test.pdf');
|
|
actionDict.set('D', '15');
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(495, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toEqual('http://www.example.com/test.pdf#nameddest=15');
|
|
expect(data.dest).toBeUndefined();
|
|
expect(data.newWindow).toBeFalsy();
|
|
});
|
|
|
|
it('should correctly parse a GoToR action, with explicit destination array',
|
|
function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('GoToR'));
|
|
actionDict.set('F', 'http://www.example.com/test.pdf');
|
|
actionDict.set('D', [14, Name.get('XYZ'), null, 298.043, null]);
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(489, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toEqual('http://www.example.com/test.pdf#' +
|
|
'[14,{"name":"XYZ"},null,298.043,null]');
|
|
expect(data.dest).toBeUndefined();
|
|
expect(data.newWindow).toBeFalsy();
|
|
});
|
|
|
|
it('should correctly parse a Named action', function() {
|
|
var actionDict = new Dict();
|
|
actionDict.set('Type', Name.get('Action'));
|
|
actionDict.set('S', Name.get('Named'));
|
|
actionDict.set('N', Name.get('GoToPage'));
|
|
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('A', actionDict);
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(12, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toBeUndefined();
|
|
expect(data.action).toEqual('GoToPage');
|
|
});
|
|
|
|
it('should correctly parse a simple Dest', function() {
|
|
var annotationDict = new Dict();
|
|
annotationDict.set('Type', Name.get('Annot'));
|
|
annotationDict.set('Subtype', Name.get('Link'));
|
|
annotationDict.set('Dest', Name.get('LI0'));
|
|
|
|
var xrefMock = new XrefMock([annotationDict]);
|
|
var annotationRef = new Ref(583, 0);
|
|
|
|
var annotation = annotationFactory.create(xrefMock, annotationRef);
|
|
var data = annotation.data;
|
|
expect(data.annotationType).toEqual(AnnotationType.LINK);
|
|
|
|
expect(data.url).toBeUndefined();
|
|
expect(data.dest).toEqual('LI0');
|
|
});
|
|
});
|
|
|
|
describe('FileAttachmentAnnotation', function() {
|
|
var loadingTask;
|
|
var annotations;
|
|
|
|
beforeEach(function(done) {
|
|
var pdfUrl = new URL('../pdfs/annotation-fileattachment.pdf',
|
|
window.location).href;
|
|
loadingTask = PDFJS.getDocument(pdfUrl);
|
|
loadingTask.promise.then(function(pdfDocument) {
|
|
return pdfDocument.getPage(1).then(function(pdfPage) {
|
|
return pdfPage.getAnnotations().then(function (pdfAnnotations) {
|
|
annotations = pdfAnnotations;
|
|
done();
|
|
});
|
|
});
|
|
}).catch(function (reason) {
|
|
done.fail(reason);
|
|
});
|
|
});
|
|
|
|
afterEach(function() {
|
|
loadingTask.destroy();
|
|
});
|
|
|
|
it('should correctly parse a file attachment', function() {
|
|
var annotation = annotations[0];
|
|
expect(annotation.file.filename).toEqual('Test.txt');
|
|
expect(annotation.file.content).toEqual(stringToBytes('Test attachment'));
|
|
});
|
|
});
|
|
});
|