Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix font name escaping and convert js string to pdf name object #3149

Merged
merged 3 commits into from
Apr 29, 2021
Merged

Fix font name escaping and convert js string to pdf name object #3149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a1bbd6
Fix font name escaping and convert js string to pdf name object
zhangshine Apr 29, 2021
17cf729
Merge branch 'master' into master
zhangshine Apr 29, 2021
43da42e
Merge branch 'master' into master
zhangshine Apr 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions src/jspdf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { RGBColor } from "./libs/rgbcolor.js";
import { btoa } from "./libs/AtobBtoa.js";
import { console } from "./libs/console.js";
import { PDFSecurity } from "./libs/pdfsecurity.js";

import { toPDFName } from "./libs/pdfname.js";
/**
* jsPDF's Internal PubSub Implementation.
* Backward compatible rewritten on 2014 by
Expand Down Expand Up @@ -1997,26 +1997,18 @@ function jsPDF(options) {
});

var putFont = function(font) {
var pdfEscapeWithNeededParanthesis = function(text, flags) {
var addParanthesis = text.indexOf(" ") !== -1; // no space in string
return addParanthesis
? "(" + pdfEscape(text, flags) + ")"
: pdfEscape(text, flags);
};

events.publish("putFont", {
font: font,
out: out,
newObject: newObject,
putStream: putStream,
pdfEscapeWithNeededParanthesis: pdfEscapeWithNeededParanthesis
});

if (font.isAlreadyPutted !== true) {
font.objectNumber = newObject();
out("<<");
out("/Type /Font");
out("/BaseFont /" + pdfEscapeWithNeededParanthesis(font.postScriptName));
out("/BaseFont /" + toPDFName(font.postScriptName));
out("/Subtype /Type1");
if (typeof font.encoding === "string") {
out("/Encoding /" + font.encoding);
Expand Down
46 changes: 46 additions & 0 deletions src/libs/pdfname.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/**
* Convert string to `PDF Name Object`.
* Detail: PDF Reference 1.3 - Chapter 3.2.4 Name Object
* @param str
*/
function toPDFName(str) {
// eslint-disable-next-line no-control-regex
if(/[^\u0000-\u00ff]/.test(str)){ // non ascii string
throw new Error('Invalid PDF Name Object: ' + str + ', Only accept ASCII characters.');
}
var result = "",
strLength = str.length;
for (var i = 0; i < strLength; i++) {
var charCode = str.charCodeAt(i);
if (
charCode < 0x21 ||
charCode === 0x23 /* # */ ||
charCode === 0x25 /* % */ ||
charCode === 0x28 /* ( */ ||
charCode === 0x29 /* ) */ ||
charCode === 0x2f /* / */ ||
charCode === 0x3c /* < */ ||
charCode === 0x3e /* > */ ||
charCode === 0x5b /* [ */ ||
charCode === 0x5d /* ] */ ||
charCode === 0x7b /* { */ ||
charCode === 0x7d /* } */ ||
charCode > 0x7e
) {
// Char CharCode hexStr paddingHexStr Result
// "\t" 9 9 09 #09
// " " 32 20 20 #20
// "©" 169 a9 a9 #a9
var hexStr = charCode.toString(16),
paddingHexStr = ("0" + hexStr).slice(-2);

result += "#" + paddingHexStr;
} else {
// Other ASCII printable characters between 0x21 <= X <= 0x7e
result += str[i];
}
}
return result;
}

export { toPDFName };
17 changes: 8 additions & 9 deletions src/modules/utf8.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { jsPDF } from "../jspdf.js";
import { toPDFName } from "../libs/pdfname.js";

/**
* @name utf8
Expand Down Expand Up @@ -86,7 +87,6 @@ import { jsPDF } from "../jspdf.js";
var out = options.out;
var newObject = options.newObject;
var putStream = options.putStream;
var pdfEscapeWithNeededParanthesis = options.pdfEscapeWithNeededParanthesis;

if (
font.metadata instanceof jsPDF.API.TTFFont &&
Expand All @@ -112,7 +112,7 @@ import { jsPDF } from "../jspdf.js";
var fontDescriptor = newObject();
out("<<");
out("/Type /FontDescriptor");
out("/FontName /" + pdfEscapeWithNeededParanthesis(font.fontName));
out("/FontName /" + toPDFName(font.fontName));
out("/FontFile2 " + fontTable + " 0 R");
out("/FontBBox " + jsPDF.API.PDFObject.convert(font.metadata.bbox));
out("/Flags " + font.metadata.flags);
Expand All @@ -127,7 +127,7 @@ import { jsPDF } from "../jspdf.js";
var DescendantFont = newObject();
out("<<");
out("/Type /Font");
out("/BaseFont /" + pdfEscapeWithNeededParanthesis(font.fontName));
out("/BaseFont /" + toPDFName(font.fontName));
out("/FontDescriptor " + fontDescriptor + " 0 R");
out("/W " + jsPDF.API.PDFObject.convert(widths));
out("/CIDToGIDMap /Identity");
Expand All @@ -147,7 +147,7 @@ import { jsPDF } from "../jspdf.js";
out("/Type /Font");
out("/Subtype /Type0");
out("/ToUnicode " + cmap + " 0 R");
out("/BaseFont /" + pdfEscapeWithNeededParanthesis(font.fontName));
out("/BaseFont /" + toPDFName(font.fontName));
out("/Encoding /" + font.encoding);
out("/DescendantFonts [" + DescendantFont + " 0 R]");
out(">>");
Expand All @@ -169,7 +169,6 @@ import { jsPDF } from "../jspdf.js";
var out = options.out;
var newObject = options.newObject;
var putStream = options.putStream;
var pdfEscapeWithNeededParanthesis = options.pdfEscapeWithNeededParanthesis;

if (
font.metadata instanceof jsPDF.API.TTFFont &&
Expand Down Expand Up @@ -200,7 +199,7 @@ import { jsPDF } from "../jspdf.js";
out("/FontFile2 " + fontTable + " 0 R");
out("/Flags 96");
out("/FontBBox " + jsPDF.API.PDFObject.convert(font.metadata.bbox));
out("/FontName /" + pdfEscapeWithNeededParanthesis(font.fontName));
out("/FontName /" + toPDFName(font.fontName));
out("/ItalicAngle " + font.metadata.italicAngle);
out("/Ascent " + font.metadata.ascender);
out(">>");
Expand All @@ -215,7 +214,7 @@ import { jsPDF } from "../jspdf.js";
"<</Subtype/TrueType/Type/Font/ToUnicode " +
cmap +
" 0 R/BaseFont/" +
pdfEscapeWithNeededParanthesis(font.fontName) +
toPDFName(font.fontName) +
"/FontDescriptor " +
fontDescriptor +
" 0 R" +
Expand Down Expand Up @@ -281,10 +280,10 @@ import { jsPDF } from "../jspdf.js";
if (Object.prototype.toString.call(text[s]) === '[object Array]') {
cmapConfirm = fonts[key].metadata.cmap.unicode.codeMap[strText[s][0].charCodeAt(0)]; //Make sure the cmap has the corresponding glyph id
} else {

}
//}

} else {
cmapConfirm = fonts[key].metadata.cmap.unicode.codeMap[strText[s].charCodeAt(0)]; //Make sure the cmap has the corresponding glyph id
}*/
Expand Down
52 changes: 52 additions & 0 deletions test/specs/pdfname.spec.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { toPDFName } from "../../src/libs/pdfname.js";

describe("Lib: pdfname", ()=>{
it("ASCII control characters to pdf name", ()=>{
expect(toPDFName("\t")).toBe("#09");
});

it("ASCII printable characters to pdf name", ()=>{
expect(toPDFName(" ")).toBe("#20");
expect(toPDFName("!")).toBe("!");
expect(toPDFName("#")).toBe("#23");
expect(toPDFName("$")).toBe("$");
expect(toPDFName("%")).toBe("#25");
expect(toPDFName("&")).toBe("&");
expect(toPDFName("'")).toBe("'");
expect(toPDFName("(")).toBe("#28");
expect(toPDFName(")")).toBe("#29");
expect(toPDFName("*")).toBe("*");
expect(toPDFName("+")).toBe("+");
expect(toPDFName(",")).toBe(",");
expect(toPDFName("-")).toBe("-");
expect(toPDFName(".")).toBe(".");
expect(toPDFName("/")).toBe("#2f");
expect(toPDFName("0123456789")).toBe("0123456789");
expect(toPDFName(":")).toBe(":");
expect(toPDFName(";")).toBe(";");
expect(toPDFName("<")).toBe("#3c");
expect(toPDFName("=")).toBe("=");
expect(toPDFName(">")).toBe("#3e");
expect(toPDFName("?")).toBe("?");
expect(toPDFName("@")).toBe("@");
expect(toPDFName("ABCDEFGHIJKLMNOPQRSTUVWXYZ")).toBe("ABCDEFGHIJKLMNOPQRSTUVWXYZ");
expect(toPDFName("[")).toBe("#5b");
expect(toPDFName("\\")).toBe("\\");
expect(toPDFName("]")).toBe("#5d");
expect(toPDFName("^")).toBe("^");
expect(toPDFName("_")).toBe("_");
expect(toPDFName("`")).toBe("`");
expect(toPDFName("abcdefghijklmnopqrstuvwxyz")).toBe("abcdefghijklmnopqrstuvwxyz");
expect(toPDFName("{")).toBe("#7b");
expect(toPDFName("|")).toBe("|");
expect(toPDFName("}")).toBe("#7d");
expect(toPDFName("~")).toBe("~");
expect(toPDFName("\u007f")).toBe("#7f");
});

it("The extended ASCII codes to pdf name", ()=>{
expect(toPDFName("©")).toBe("#a9");
expect(toPDFName("®")).toBe("#ae");
expect(toPDFName("ÿ")).toBe("#ff");
});
});