From 7041c62ccfa4ee2c7a3a0ab4a1ef46f6b6a1a378 Mon Sep 17 00:00:00 2001
From: Calixte Denizet <calixte.denizet@gmail.com>
Date: Fri, 12 Nov 2021 19:41:32 +0100
Subject: [PATCH] Remove non-displayable chars from outline title (#14267)  -
 it aims to fix #14267;  - there is nothing about chars in range [0-1F] in the
 specs but acrobat doesn't display them in any way.

---
 src/shared/util.js       |   8 ++++++--
 test/pdfs/.gitignore     |   1 +
 test/pdfs/issue14267.pdf | Bin 0 -> 4428 bytes
 test/unit/api_spec.js    |  13 +++++++++++++
 test/unit/util_spec.js   |  12 ++++++++++++
 web/base_tree_viewer.js  |   7 ++++++-
 6 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 test/pdfs/issue14267.pdf

diff --git a/src/shared/util.js b/src/shared/util.js
index ba94fec8b..1af94158d 100644
--- a/src/shared/util.js
+++ b/src/shared/util.js
@@ -566,16 +566,20 @@ class AbortException extends BaseException {
   }
 }
 
-const NullCharactersRegExp = /\x00/g;
+const NullCharactersRegExp = /\x00+/g;
+const InvisibleCharactersRegExp = /[\x01-\x1F]/g;
 
 /**
  * @param {string} str
  */
-function removeNullCharacters(str) {
+function removeNullCharacters(str, replaceInvisible = false) {
   if (typeof str !== "string") {
     warn("The argument for removeNullCharacters must be a string.");
     return str;
   }
+  if (replaceInvisible) {
+    str = str.replace(InvisibleCharactersRegExp, " ");
+  }
   return str.replace(NullCharactersRegExp, "");
 }
 
diff --git a/test/pdfs/.gitignore b/test/pdfs/.gitignore
index 2b4476710..a957af612 100644
--- a/test/pdfs/.gitignore
+++ b/test/pdfs/.gitignore
@@ -486,3 +486,4 @@
 !pr12828.pdf
 !secHandler.pdf
 !rc_annotation.pdf
+!issue14267.pdf
\ No newline at end of file
diff --git a/test/pdfs/issue14267.pdf b/test/pdfs/issue14267.pdf
new file mode 100644
index 0000000000000000000000000000000000000000..38d8d844e94dc81152bf8061d1318fcff3642feb
GIT binary patch
literal 4428
zcmeHK-A?016i!y^MRQTwHyEWt3u>MD@gKI5tSBj6v}8emw6xv57~5m;;&@zVA_9-o
z*J!1Eq+a%}>KVsQ3`CV8b?<O8(bzucJLh~eXOwUIbaZIYp3~X>^!M-obSNT71|K{9
zKEh+6c*GS)7Cbyd_++NiBokBQEbdSF72Hs=xVyN^1;PhlpUNvV9Ckz&X(ZM_T-clh
zAJ5eU;bW0qscS?%3*onjB7B$>Qw7n$d8!J*Cmj=!GL-|kQ;Ez*TnV%@@)=<iE=E1#
zn9g^Ez9i)3E`-;1vOqig5L=-Au#f>)=(Lb%bb#LPn9K+g^?nyI+H-r15YGdzv5cMq
zQ<Iu2U_gjwq1X_4!9rC_#fK)dX83#-sFJqJ@iD>+c9yKy{Fsb54NCg2<~a{<ghGM1
zO0q%suRlI@Q4$Th@9Z%d=Lh0Cd3|4q^ZU0K;r&hMMcr4!PJiytC;0?c6wN1THudL&
zF4r9SFxQW97nLUJX3$-bcR4;q2eJ^z?GYm+gdo@JQPXxqPkfK`3Si=5Y8iz1rsvxZ
zs;=&^1G9b+#s1mou!;wFgYLCbxsUPf?QQSY?8)K^Q_u4-VVE%kER5-0ruf{*rr$0=
zYMhanhDDO=Er2vG59CY@x?LS;c~yl?@@1fG+AE9fg>r)DJjb+0@H(d`T>9j*A}v#k
zLM&1-5t*8TA6@GQoQ}s!*R|m$leM0CgO3M(@B+e_cu4@%*M~Sh?9wE@(;IcD$u}r`
z*#-4{YQh(`s!vECKeAjARAQ9<A=Y3J$1nS6iP5lpgi&wMH7HLrsg97+_7P6is~1wH
z!?o>Nb!)R(7xgtg8=z6>$Fi7kHRO4oCSiGEVBoWlSFalO<>L7x8P4<~AB~2ySrYks
zCKDo#s9|$&&#+i54DN7h1deCM#1ha5Zkfh--1L2ddz4KT&q7h-h9R+IS40L69m}vh
zmjfgZ4C3-QiYYe(%d2r4z71Tc#IMhx4H$diR>AeL?xIFlEn2pG3Ox(w1zsK)<*Q|r
zeXhx>&d(JAaG!&0MD8<P&vb3Xz(&T;yX%>*jTqR-_<48zZ*+B5k^?l%pnD5~0wxb-
zjopwn>t&wfXqji$GLPB~QKJ>5i$Fr`fu3|0l26VuwNiyHSbzpS=AaO(c@?Hsr69Jn
zYTXBn()5%U@VBlOs~3q%K{{TGG?m}n$|8++b$snHLcb!ag)iV={``wh#bYR&r78M=
z@HxUi$qT8CpA_wZZLQ_j7HyLU(zaQ$*3AzKeUn7fRVomA0lARb>%x~w*YOVung1Z?
z06=;G4a1=fexVll1+=k<68@hS6=SucKNC|qD?-rtz|wGt@R?Lve?v{H%qm`V7WApq
zzdRH1Qs~<Z;di<~#9%;1M_DXkLzKjyNvT)6oS!H60#Vp0N3b+~$^z={1y;!U9<?pc
zGfijDwwT4aO?VIu`^;le6c7=zkj2a+)OKtdI)XaPHsi<{e$ZJ~`?UpEyR`*_w_d=f
z-TtlB{^~W%zR;r$<3)RG0P`<f?X5ps?XTaoo~}Inw=dMZ5OK$%F70e@|9EoP`4^uO
BmCyhH

literal 0
HcmV?d00001

diff --git a/test/unit/api_spec.js b/test/unit/api_spec.js
index ac5b70041..e66745fc1 100644
--- a/test/unit/api_spec.js
+++ b/test/unit/api_spec.js
@@ -1102,6 +1102,19 @@ describe("api", function () {
       await loadingTask.destroy();
     });
 
+    it("gets outline with non-displayable chars", async function () {
+      const loadingTask = getDocument(buildGetDocumentParams("issue14267.pdf"));
+      const pdfDoc = await loadingTask.promise;
+      const outline = await pdfDoc.getOutline();
+      expect(Array.isArray(outline)).toEqual(true);
+      expect(outline.length).toEqual(1);
+
+      const outlineItem = outline[0];
+      expect(outlineItem.title).toEqual("hello\x11world");
+
+      await loadingTask.destroy();
+    });
+
     it("gets non-existent permissions", async function () {
       const permissions = await pdfDocument.getPermissions();
       expect(permissions).toEqual(null);
diff --git a/test/unit/util_spec.js b/test/unit/util_spec.js
index eb39f2b94..b86d287c4 100644
--- a/test/unit/util_spec.js
+++ b/test/unit/util_spec.js
@@ -185,6 +185,18 @@ describe("util", function () {
       const str = "string\x00With\x00Null\x00Chars";
       expect(removeNullCharacters(str)).toEqual("stringWithNullChars");
     });
+
+    it("should modify string with non-displayable characters", function () {
+      const str = Array.from(Array(32).keys())
+        .map(x => String.fromCharCode(x) + "a")
+        .join("");
+      // \x00 is replaced by an empty string.
+      const expected =
+        "a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a";
+      expect(removeNullCharacters(str, /* replaceInvisible */ true)).toEqual(
+        expected
+      );
+    });
   });
 
   describe("ReadableStream", function () {
diff --git a/web/base_tree_viewer.js b/web/base_tree_viewer.js
index 6e203aea8..7a4f1e030 100644
--- a/web/base_tree_viewer.js
+++ b/web/base_tree_viewer.js
@@ -59,7 +59,12 @@ class BaseTreeViewer {
    * @private
    */
   _normalizeTextContent(str) {
-    return removeNullCharacters(str) || /* en dash = */ "\u2013";
+    // Chars in range [0x01-0x1F] will be replaced with a white space
+    // and 0x00 by "".
+    return (
+      removeNullCharacters(str, /* replaceInvisible */ true) ||
+      /* en dash = */ "\u2013"
+    );
   }
 
   /**