Support universal ToUnicode CMaps

DEVSIX-6147

Author: introfog

font-asian/src/main/resources/com/itextpdf/io/font/cmap/toUnicode/Adobe-CNS1-UCS2

@@ -279,6 +279,7 @@ public final class KernelExceptionMessageConstant {
     public static final String ONLY_BMP_CAN_BE_WRAPPED_IN_WMF = "Only BMP can be wrapped in WMF.";
     public static final String OPERATOR_EI_NOT_FOUND_AFTER_END_OF_IMAGE_DATA = "Operator EI not found after the end "
             + "of image data.";
+    public static final String ORDERING_SHOULD_BE_DETERMINED = "Ordering should be determined for CIDFont of Type0 font.";
     public static final String PAGE_CANNOT_BE_ADDED_TO_DOCUMENT_BECAUSE_IT_BELONGS_TO_ANOTHER_DOCUMENT =
             "The passed page belongs to document {0} (page {1} of the document) and therefore cannot be added "
                     + "to this document ({2}).";

font-asian/src/main/resources/com/itextpdf/io/font/cmap/toUnicode/Adobe-GB1-UCS2

@@ -25,6 +25,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.font.FontCache;
 import com.itextpdf.io.font.PdfEncodings;
 import com.itextpdf.io.font.cmap.CMapLocationFromBytes;
+import com.itextpdf.io.font.cmap.CMapLocationResource;
 import com.itextpdf.io.font.cmap.CMapParser;
 import com.itextpdf.io.font.cmap.CMapToUnicode;
 import com.itextpdf.io.font.cmap.CMapUniCid;
@@ -40,6 +41,8 @@ This file is part of the iText (R) project.
 import java.security.SecureRandom;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Set;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -48,6 +51,13 @@ public class FontUtil {
 
     private static final HashMap<String, CMapToUnicode> uniMaps = new HashMap<>();
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(FontUtil.class);
+
+    private static final String UNIVERSAL_CMAP_DIR = "toUnicode/";
+
+    private static final Set<String> UNIVERSAL_CMAP_ORDERINGS = new HashSet<>(Arrays.asList(
+            "CNS1", "GB1", "Japan1", "Korea1", "KR"));
+
     private FontUtil() {}
 
     public static String addRandomSubsetPrefixForFontName(final String fontName) {
@@ -70,8 +80,7 @@ static CMapToUnicode processToUnicode(PdfObject toUnicode) {
                 cMapToUnicode = new CMapToUnicode();
                 CMapParser.parseCid("", cMapToUnicode, lb);
             } catch (Exception e) {
-                Logger logger = LoggerFactory.getLogger(CMapToUnicode.class);
-                logger.error(IoLogMessageConstant.UNKNOWN_ERROR_WHILE_PROCESSING_CMAP);
+                LOGGER.error(IoLogMessageConstant.UNKNOWN_ERROR_WHILE_PROCESSING_CMAP, e);
                 cMapToUnicode = CMapToUnicode.EmptyCMapToUnicodeMap;
             }
         } else if (PdfName.IdentityH.equals(toUnicode)) {
@@ -80,6 +89,21 @@ static CMapToUnicode processToUnicode(PdfObject toUnicode) {
         return cMapToUnicode;
     }
 
+    static CMapToUnicode parseUniversalToUnicodeCMap(String ordering) {
+        if (!UNIVERSAL_CMAP_ORDERINGS.contains(ordering)) {
+            return null;
+        }
+        String cmapRelPath = UNIVERSAL_CMAP_DIR + "Adobe-" + ordering + "-UCS2";
+        CMapToUnicode cMapToUnicode = new CMapToUnicode();
+        try {
+            CMapParser.parseCid(cmapRelPath, cMapToUnicode, new CMapLocationResource());
+        } catch (Exception e) {
+            LOGGER.error(IoLogMessageConstant.UNKNOWN_ERROR_WHILE_PROCESSING_CMAP, e);
+            return null;
+        }
+        return cMapToUnicode;
+    }
+
     static CMapToUnicode getToUnicodeFromUniMap(String uniMap) {
         if (uniMap == null)
             return null;

font-asian/src/main/resources/com/itextpdf/io/font/cmap/toUnicode/Adobe-Japan1-UCS2

@@ -142,13 +142,24 @@ public class PdfType0Font extends PdfFont {
         newFont = false;
         PdfDictionary cidFont = fontDictionary.getAsArray(PdfName.DescendantFonts).getAsDictionary(0);
         PdfObject cmap = fontDictionary.get(PdfName.Encoding);
+
+        String ordering = getOrdering(cidFont);
+        if(ordering == null) {
+            throw new PdfException(KernelExceptionMessageConstant.ORDERING_SHOULD_BE_DETERMINED);
+        }
+        CMapToUnicode toUnicodeCMap;
         PdfObject toUnicode = fontDictionary.get(PdfName.ToUnicode);
-        CMapToUnicode toUnicodeCMap = FontUtil.processToUnicode(toUnicode);
+        if (toUnicode == null) {
+            toUnicodeCMap = FontUtil.parseUniversalToUnicodeCMap(ordering);
+        } else {
+            toUnicodeCMap = FontUtil.processToUnicode(toUnicode);
+        }
+
         if (cmap.isName() && (PdfEncodings.IDENTITY_H.equals(((PdfName) cmap).getValue()) ||
                 PdfEncodings.IDENTITY_V.equals(((PdfName) cmap).getValue()))) {
+
             if (toUnicodeCMap == null) {
-                String uniMap = getUniMapFromOrdering(getOrdering(cidFont),
-                        PdfEncodings.IDENTITY_H.equals(((PdfName) cmap).getValue()));
+                String uniMap = getUniMapFromOrdering(ordering, PdfEncodings.IDENTITY_H.equals(((PdfName) cmap).getValue()));
                 toUnicodeCMap = FontUtil.getToUnicodeFromUniMap(uniMap);
                 if (toUnicodeCMap == null) {
                     toUnicodeCMap = FontUtil.getToUnicodeFromUniMap(PdfEncodings.IDENTITY_H);
@@ -162,7 +173,7 @@ public class PdfType0Font extends PdfFont {
             embedded = ((IDocFontProgram) fontProgram).getFontFile() != null;
         } else {
             String cidFontName = cidFont.getAsName(PdfName.BaseFont).getValue();
-            String uniMap = getUniMapFromOrdering(getOrdering(cidFont), true);
+            String uniMap = getUniMapFromOrdering(ordering, true);
             if (uniMap != null && uniMap.startsWith("Uni") && CidFontProperties.isCidFont(cidFontName, uniMap)) {
                 try {
                     fontProgram = FontProgramFactory.createFont(cidFontName);

font-asian/src/main/resources/com/itextpdf/io/font/cmap/toUnicode/Adobe-KR-UCS2

@@ -0,0 +1,40 @@
+package com.itextpdf.kernel.font;
+
+import com.itextpdf.io.font.cmap.CMapToUnicode;
+import com.itextpdf.io.logs.IoLogMessageConstant;
+import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.pdf.PdfDocument;
+import com.itextpdf.kernel.pdf.PdfStream;
+import com.itextpdf.kernel.pdf.PdfWriter;
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.LogLevelConstants;
+import com.itextpdf.test.annotations.LogMessage;
+import com.itextpdf.test.annotations.LogMessages;
+import com.itextpdf.test.annotations.type.UnitTest;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(UnitTest.class)
+public class FontUtilTest extends ExtendedITextTest {
+    @Test
+    public void parseUniversalNotExistedCMapTest() {
+        Assert.assertNull(FontUtil.parseUniversalToUnicodeCMap("NotExisted"));
+    }
+
+    @Test
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = IoLogMessageConstant.UNKNOWN_ERROR_WHILE_PROCESSING_CMAP, logLevel = LogLevelConstants.ERROR)
+    })
+    public void processInvalidToUnicodeTest() {
+        PdfStream toUnicode = new PdfStream();
+        try (PdfDocument pdfDocument = new PdfDocument(new PdfWriter(new ByteArrayOutputStream()))) {
+            toUnicode.makeIndirect(pdfDocument);
+            toUnicode.flush();
+            final CMapToUnicode cmap = FontUtil.processToUnicode(toUnicode);
+            Assert.assertNotNull(cmap);
+            Assert.assertFalse(cmap.hasByteMappings());
+        }
+    }
+}

font-asian/src/main/resources/com/itextpdf/io/font/cmap/toUnicode/Adobe-Korea1-UCS2

@@ -28,6 +28,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.font.otf.Glyph;
 import com.itextpdf.kernel.exceptions.KernelExceptionMessageConstant;
 import com.itextpdf.kernel.exceptions.PdfException;
+import com.itextpdf.kernel.pdf.PdfArray;
 import com.itextpdf.kernel.pdf.PdfDictionary;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfName;
@@ -128,4 +129,18 @@ public void getUniMapFromOrderingTest() {
         Assert.assertEquals("Identity-H", PdfType0Font.getUniMapFromOrdering("Identity", true));
         Assert.assertEquals("Identity-V", PdfType0Font.getUniMapFromOrdering("Identity", false));
     }
+
+    @Test
+    public void descendantCidFontWithoutOrderingTest() {
+        PdfDictionary fontDict = new PdfDictionary();
+        PdfArray descendantFonts = new PdfArray();
+        PdfDictionary descendantFont = new PdfDictionary();
+        descendantFont.put(PdfName.CIDSystemInfo, new PdfDictionary());
+        descendantFonts.add(descendantFont);
+        fontDict.put(PdfName.DescendantFonts, descendantFonts);
+
+
+        Exception e = Assert.assertThrows(PdfException.class, () -> new PdfType0Font(fontDict));
+        Assert.assertEquals(KernelExceptionMessageConstant.ORDERING_SHOULD_BE_DETERMINED, e.getMessage());
+    }
 }