Move, add pattern color tests to kernel repository, add Logger to PdfCanvasProcessor, add LogMessageConstant class for kernel module

DEVSIX-3727

Author: AlexanderRasolko

kernel/src/main/java/com/itextpdf/kernel/KernelLogMessageConstant.java

@@ -0,0 +1,58 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2020 iText Group NV
+    Authors: Bruno Lowagie, Paulo Soares, et al.
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License version 3
+    as published by the Free Software Foundation with the addition of the
+    following permission added to Section 15 as permitted in Section 7(a):
+    FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+    ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
+    OF THIRD PARTY RIGHTS
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+    or FITNESS FOR A PARTICULAR PURPOSE.
+    See the GNU Affero General Public License for more details.
+    You should have received a copy of the GNU Affero General Public License
+    along with this program; if not, see http://www.gnu.org/licenses or write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA, 02110-1301 USA, or download the license from the following URL:
+    http://itextpdf.com/terms-of-use/
+
+    The interactive user interfaces in modified source and object code versions
+    of this program must display Appropriate Legal Notices, as required under
+    Section 5 of the GNU Affero General Public License.
+
+    In accordance with Section 7(b) of the GNU Affero General Public License,
+    a covered work must retain the producer line in every PDF that is created
+    or manipulated using iText.
+
+    You can be released from the requirements of the license by purchasing
+    a commercial license. Buying such a license is mandatory as soon as you
+    develop commercial activities involving the iText software without
+    disclosing the source code of your own applications.
+    These activities include: offering paid services to customers as an ASP,
+    serving PDFs on the fly in a web application, shipping iText with a closed
+    source product.
+
+    For more information, please contact iText Software Corp. at this
+    address: [email protected]
+ */
+
+package com.itextpdf.kernel;
+
+/**
+ * Class that bundles all the error message templates as constants.
+ */
+public final class KernelLogMessageConstant {
+
+    private KernelLogMessageConstant() {
+
+        //Private constructor will prevent the instantiation of this class directly
+    }
+
+    /** The Constant UNABLE_TO_PARSE_COLOR_WITHIN_COLORSPACE */
+    public static final String UNABLE_TO_PARSE_COLOR_WITHIN_COLORSPACE = "Unable to parse color {0} within {1} color space";
+}

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/parser/PdfCanvasProcessor.java

@@ -48,6 +48,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.source.RandomAccessFileOrArray;
 import com.itextpdf.io.source.RandomAccessSourceFactory;
 import com.itextpdf.io.util.MessageFormatUtil;
+import com.itextpdf.kernel.KernelLogMessageConstant;
 import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.colors.CalGray;
 import com.itextpdf.kernel.colors.CalRgb;
@@ -91,6 +92,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.colorspace.PdfColorSpace;
 import com.itextpdf.kernel.pdf.colorspace.PdfPattern;
 import com.itextpdf.kernel.pdf.colorspace.PdfSpecialCs;
+
+import java.util.Objects;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -1027,6 +1030,11 @@ else if (PdfName.Pattern.equals(csType)) {
                 }
             }
         }
+
+        Logger logger = LoggerFactory.getLogger(PdfCanvasProcessor.class);
+        logger.warn(MessageFormatUtil.format(KernelLogMessageConstant.UNABLE_TO_PARSE_COLOR_WITHIN_COLORSPACE,
+                Arrays.toString((Object[])operands.toArray()), pdfColorSpace.getPdfObject()));
+
         return null;
     }
 

kernel/src/test/java/com/itextpdf/kernel/pdf/canvas/parser/PdfCanvasProcessorTest.java

@@ -44,6 +44,9 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.source.ByteArrayOutputStream;
+import com.itextpdf.kernel.KernelLogMessageConstant;
+import com.itextpdf.kernel.PdfException;
+import com.itextpdf.kernel.colors.Color;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfPage;
 import com.itextpdf.kernel.pdf.PdfReader;
@@ -55,6 +58,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.canvas.parser.data.TextRenderInfo;
 import com.itextpdf.kernel.pdf.canvas.parser.listener.IEventListener;
 import com.itextpdf.kernel.pdf.canvas.parser.listener.LocationTextExtractionStrategy;
+import com.itextpdf.kernel.pdf.colorspace.PdfColorSpace;
+import com.itextpdf.kernel.pdf.colorspace.PdfSpecialCs;
 import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.LogMessage;
 import com.itextpdf.test.annotations.LogMessages;
@@ -63,6 +68,8 @@ This file is part of the iText (R) project.
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
 import org.junit.Assert;
 import org.junit.Ignore;
 import org.junit.Rule;
@@ -143,6 +150,82 @@ public void parseCircularReferencesInResourcesTest() throws IOException {
         pdfDocument.close();
     }
 
+    @Test
+    @LogMessages(messages = @LogMessage(messageTemplate = KernelLogMessageConstant.UNABLE_TO_PARSE_COLOR_WITHIN_COLORSPACE))
+    public void patternColorParsingNotValidPdfTest() throws IOException {
+        String inputFile = sourceFolder + "patternColorParsingNotValidPdfTest.pdf";
+        PdfDocument pdfDocument = new PdfDocument(new PdfReader(inputFile));
+
+        for (int i = 1; i <= pdfDocument.getNumberOfPages(); ++i) {
+            PdfPage page = pdfDocument.getPage(i);
+
+            ColorParsingEventListener colorParsingEventListener = new ColorParsingEventListener();
+
+            PdfCanvasProcessor processor = new PdfCanvasProcessor(colorParsingEventListener);
+            processor.processPageContent(page);
+
+            Color renderInfo = colorParsingEventListener.getEncounteredPath().getFillColor();
+
+            Assert.assertNull(renderInfo);
+        }
+    }
+
+    @Test
+    public void patternColorParsingValidPdfTest() throws IOException {
+        String inputFile = sourceFolder + "patternColorParsingValidPdfTest.pdf";
+        PdfDocument pdfDocument = new PdfDocument(new PdfReader(inputFile));
+
+        for (int i = 1; i <= pdfDocument.getNumberOfPages(); ++i) {
+            PdfPage page = pdfDocument.getPage(i);
+
+            ColorParsingEventListener colorParsingEventListener = new ColorParsingEventListener();
+
+            PdfCanvasProcessor processor = new PdfCanvasProcessor(colorParsingEventListener);
+            processor.processPageContent(page);
+
+            PathRenderInfo renderInfo = colorParsingEventListener.getEncounteredPath();
+            PdfColorSpace colorSpace = renderInfo.getGraphicsState().getFillColor().getColorSpace();
+
+            Assert.assertTrue(colorSpace instanceof PdfSpecialCs.Pattern);
+        }
+    }
+
+    private static class ColorParsingEventListener implements IEventListener {
+        private List<IEventData> content = new ArrayList<>();
+        private static final String pathDataExpected = "Path data expected.";
+
+        public void eventOccurred(IEventData data, EventType type) {
+            if (type.equals(EventType.RENDER_PATH)) {
+                PathRenderInfo pathRenderInfo = (PathRenderInfo) data;
+                pathRenderInfo.preserveGraphicsState();
+                content.add(data);
+            }
+        }
+
+        /**
+         * Get the last encountered PathRenderInfo, then clears the internal buffer
+         *
+         * @return the PathRenderInfo object that was encountered when processing the last path rendering operation
+         */
+        PathRenderInfo getEncounteredPath() {
+            if (content.size() == 0) {
+                return null;
+            }
+
+            IEventData eventData = content.get(0);
+            if (!(eventData instanceof PathRenderInfo)) {
+                throw new PdfException(pathDataExpected);
+            }
+            content.clear();
+
+            return (PathRenderInfo) eventData;
+        }
+
+        public Set<EventType> getSupportedEvents() {
+            return null;
+        }
+    }
+
     private static class NoOpEventListener implements IEventListener {
         @Override
         public void eventOccurred(IEventData data, EventType type) {