Add logging that ICC profile to be set to the image is invalid

introfog · iText-CI · commit 2845f72b27d3 · 2021-02-22T18:06:56.000Z
DEVSIX-5045

Autoported commit.
Original commit hash: [aa44e3692]
diff --git a/itext.tests/itext.io.tests/itext/io/image/JpegImageHelperTest.cs b/itext.tests/itext.io.tests/itext/io/image/JpegImageHelperTest.cs
@@ -0,0 +1,64 @@
+/*
+This file is part of the iText (R) project.
+Copyright (c) 1998-2021 iText Group NV
+Authors: iText Software.
+
+This program is offered under a commercial and under the AGPL license.
+For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+AGPL licensing:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+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 <https://www.gnu.org/licenses/>.
+*/
+using System;
+using System.IO;
+using iText.IO.Util;
+using iText.Test;
+using iText.Test.Attributes;
+
+namespace iText.IO.Image {
+    public class JpegImageHelperTest : ExtendedITextTest {
+        public static readonly String SOURCE_FOLDER = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
+            .CurrentContext.TestDirectory) + "/resources/itext/io/image/";
+
+        [NUnit.Framework.Test]
+        [LogMessage(iText.IO.LogMessageConstant.DURING_CONSTRUCTION_OF_ICC_PROFILE_ERROR_OCCURRED, LogLevel = LogLevelConstants
+            .ERROR)]
+        public virtual void AttemptToSetInvalidIccProfileToImageTest() {
+            using (FileStream fis = new FileStream(SOURCE_FOLDER + "WP_20140410_001.jpg", FileMode.Open, FileAccess.Read
+                )) {
+                ImageData img = ImageDataFactory.CreateJpeg(StreamUtil.InputStreamToArray(fis));
+                int size = 100;
+                // Instantiate new byte[size][] instead new byte[size][size] necessary for autoporting
+                byte[][] icc = new byte[size][];
+                for (int i = 0; i < size; i++) {
+                    icc[i] = new byte[size];
+                    for (int j = 0; j < size; j++) {
+                        icc[i][j] = (byte)j;
+                    }
+                }
+                NUnit.Framework.Assert.DoesNotThrow(() => JpegImageHelper.AttemptToSetIccProfileToImage(icc, img));
+            }
+        }
+
+        [NUnit.Framework.Test]
+        public virtual void AttemptToSetNullIccProfileToImageTest() {
+            using (FileStream fis = new FileStream(SOURCE_FOLDER + "WP_20140410_001.jpg", FileMode.Open, FileAccess.Read
+                )) {
+                byte[][] icc = new byte[][] { null, null };
+                ImageData img = ImageDataFactory.CreateJpeg(StreamUtil.InputStreamToArray(fis));
+                NUnit.Framework.Assert.DoesNotThrow(() => JpegImageHelper.AttemptToSetIccProfileToImage(icc, img));
+            }
+        }
+    }
+}
diff --git a/itext.tests/itext.io.tests/itext/io/image/JpegTest.cs b/itext.tests/itext.io.tests/itext/io/image/JpegTest.cs
@@ -47,12 +47,12 @@ source product.
 
 namespace iText.IO.Image {
     public class JpegTest : ExtendedITextTest {
-        public static readonly String sourceFolder = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
+        public static readonly String SOURCE_FOLDER = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
             .CurrentContext.TestDirectory) + "/resources/itext/io/image/";
 
         [NUnit.Framework.Test]
         public virtual void OpenJpeg1() {
-            using (FileStream fis = new FileStream(sourceFolder + "WP_20140410_001.jpg", FileMode.Open, FileAccess.Read
+            using (FileStream fis = new FileStream(SOURCE_FOLDER + "WP_20140410_001.jpg", FileMode.Open, FileAccess.Read
                 )) {
                 // Test this a more specific entry point
                 ImageData img = ImageDataFactory.CreateJpeg(StreamUtil.InputStreamToArray(fis));
@@ -65,15 +65,15 @@ public virtual void OpenJpeg1() {
         [NUnit.Framework.Test]
         public virtual void OpenJpeg2() {
             // Test this a more specific entry point
-            ImageData img = ImageDataFactory.CreateJpeg(UrlUtil.ToURL(sourceFolder + "WP_20140410_001_gray.jpg"));
+            ImageData img = ImageDataFactory.CreateJpeg(UrlUtil.ToURL(SOURCE_FOLDER + "WP_20140410_001_gray.jpg"));
             NUnit.Framework.Assert.AreEqual(2592, img.GetWidth(), 0);
             NUnit.Framework.Assert.AreEqual(1456, img.GetHeight(), 0);
             NUnit.Framework.Assert.AreEqual(8, img.GetBpc());
         }
 
         [NUnit.Framework.Test]
         public virtual void OpenJpeg3() {
-            using (FileStream fis = new FileStream(sourceFolder + "WP_20140410_001_monochrome.jpg", FileMode.Open, FileAccess.Read
+            using (FileStream fis = new FileStream(SOURCE_FOLDER + "WP_20140410_001_monochrome.jpg", FileMode.Open, FileAccess.Read
                 )) {
                 // Test this a more specific entry point
                 ImageData img = ImageDataFactory.Create(StreamUtil.InputStreamToArray(fis));
@@ -85,23 +85,23 @@ public virtual void OpenJpeg3() {
 
         [NUnit.Framework.Test]
         public virtual void OpenJpeg4() {
-            ImageData img = ImageDataFactory.Create(sourceFolder + "WP_20140410_001_negate.jpg");
+            ImageData img = ImageDataFactory.Create(SOURCE_FOLDER + "WP_20140410_001_negate.jpg");
             NUnit.Framework.Assert.AreEqual(2592, img.GetWidth(), 0);
             NUnit.Framework.Assert.AreEqual(1456, img.GetHeight(), 0);
             NUnit.Framework.Assert.AreEqual(8, img.GetBpc());
         }
 
         [NUnit.Framework.Test]
         public virtual void OpenJpeg5() {
-            ImageData img = ImageDataFactory.Create(sourceFolder + "WP_20140410_001_year1900.jpg");
+            ImageData img = ImageDataFactory.Create(SOURCE_FOLDER + "WP_20140410_001_year1900.jpg");
             NUnit.Framework.Assert.AreEqual(2592, img.GetWidth(), 0);
             NUnit.Framework.Assert.AreEqual(1456, img.GetHeight(), 0);
             NUnit.Framework.Assert.AreEqual(8, img.GetBpc());
         }
 
         [NUnit.Framework.Test]
         public virtual void OpenJpeg6() {
-            ImageData img = ImageDataFactory.Create(sourceFolder + "WP_20140410_001_year1980.jpg");
+            ImageData img = ImageDataFactory.Create(SOURCE_FOLDER + "WP_20140410_001_year1980.jpg");
             NUnit.Framework.Assert.AreEqual(2592, img.GetWidth(), 0);
             NUnit.Framework.Assert.AreEqual(1456, img.GetHeight(), 0);
             NUnit.Framework.Assert.AreEqual(8, img.GetBpc());
diff --git a/itext/itext.io/itext/io/LogMessageConstant.cs b/itext/itext.io/itext/io/LogMessageConstant.cs
@@ -116,6 +116,8 @@ public sealed class LogMessageConstant {
 
         public const String DOCUMENT_SERIALIZATION_EXCEPTION_RAISED = "Unhandled exception while serialization";
 
+        public const String DURING_CONSTRUCTION_OF_ICC_PROFILE_ERROR_OCCURRED = "During the construction of the ICC profile, the {0} error with message \"{1}\" occurred, the ICC profile will not be installed in the image.";
+
         public const String ELEMENT_DOES_NOT_FIT_AREA = "Element does not fit current area. {0}";
 
         public const String ELEMENT_WAS_FORCE_PLACED_KEEP_WITH_NEXT_WILL_BE_IGNORED = "Element was placed in a forced way. Keep with next property will be ignored";
diff --git a/itext/itext.io/itext/io/image/JpegImageHelper.cs b/itext/itext.io/itext/io/image/JpegImageHelper.cs
@@ -50,6 +50,8 @@ source product.
 
 namespace iText.IO.Image {
     internal class JpegImageHelper {
+        private static readonly ILog LOGGER = LogManager.GetLogger(typeof(JpegImageHelper));
+
         /// <summary>This is a type of marker.</summary>
         private const int NOT_A_MARKER = -1;
 
@@ -130,6 +132,31 @@ public static void ProcessImage(ImageData image) {
             UpdateAttributes(image);
         }
 
+        internal static void AttemptToSetIccProfileToImage(byte[][] icc, ImageData image) {
+            if (icc != null) {
+                int total = 0;
+                foreach (byte[] value in icc) {
+                    if (value == null) {
+                        return;
+                    }
+                    total += value.Length - 14;
+                }
+                byte[] ficc = new byte[total];
+                total = 0;
+                foreach (byte[] bytes in icc) {
+                    Array.Copy(bytes, 14, ficc, total, bytes.Length - 14);
+                    total += bytes.Length - 14;
+                }
+                try {
+                    image.SetProfile(IccProfile.GetInstance(ficc, image.GetColorSpace()));
+                }
+                catch (Exception e) {
+                    LOGGER.Error(MessageFormatUtil.Format(iText.IO.LogMessageConstant.DURING_CONSTRUCTION_OF_ICC_PROFILE_ERROR_OCCURRED
+                        , e.GetType().Name, e.Message));
+                }
+            }
+        }
+
         private static void UpdateAttributes(ImageData image) {
             image.filter = "DCTDecode";
             if (image.GetColorTransform() == 0) {
@@ -295,8 +322,7 @@ private static void ProcessParameters(Stream jpegStream, String errorID, ImageDa
                                 dx = (unitsx == 2 ? (int)(dx * 2.54f + 0.5f) : dx);
                                 // make sure this is consistent with JFIF data
                                 if (image.GetDpiX() != 0 && image.GetDpiX() != dx) {
-                                    ILog logger = LogManager.GetLogger(typeof(JpegImageHelper));
-                                    logger.Debug(MessageFormatUtil.Format("Inconsistent metadata (dpiX: {0} vs {1})", image.GetDpiX(), dx));
+                                    LOGGER.Debug(MessageFormatUtil.Format("Inconsistent metadata (dpiX: {0} vs {1})", image.GetDpiX(), dx));
                                 }
                                 else {
                                     image.SetDpi(dx, image.GetDpiY());
@@ -306,8 +332,7 @@ private static void ProcessParameters(Stream jpegStream, String errorID, ImageDa
                                 dy = (unitsy == 2 ? (int)(dy * 2.54f + 0.5f) : dy);
                                 // make sure this is consistent with JFIF data
                                 if (image.GetDpiY() != 0 && image.GetDpiY() != dy) {
-                                    ILog logger = LogManager.GetLogger(typeof(JpegImageHelper));
-                                    logger.Debug(MessageFormatUtil.Format("Inconsistent metadata (dpiY: {0} vs {1})", image.GetDpiY(), dy));
+                                    LOGGER.Debug(MessageFormatUtil.Format("Inconsistent metadata (dpiY: {0} vs {1})", image.GetDpiY(), dy));
                                 }
                                 else {
                                     image.SetDpi(image.GetDpiX(), dx);
@@ -342,30 +367,9 @@ private static void ProcessParameters(Stream jpegStream, String errorID, ImageDa
                     }
                 }
             }
-            if (icc != null) {
-                int total = 0;
-                for (int k = 0; k < icc.Length; ++k) {
-                    if (icc[k] == null) {
-                        icc = null;
-                        return;
-                    }
-                    total += icc[k].Length - 14;
-                }
-                byte[] ficc = new byte[total];
-                total = 0;
-                for (int k = 0; k < icc.Length; ++k) {
-                    Array.Copy(icc[k], 14, ficc, total, icc[k].Length - 14);
-                    total += icc[k].Length - 14;
-                }
-                try {
-                    image.SetProfile(IccProfile.GetInstance(ficc, image.GetColorSpace()));
-                }
-                catch (ArgumentException) {
-                }
-            }
+            AttemptToSetIccProfileToImage(icc, image);
         }
 
-        // ignore ICC profile if it's invalid.
         /// <summary>Reads a short from the <c>InputStream</c>.</summary>
         /// <param name="jpegStream">the <c>InputStream</c></param>
         /// <returns>an int</returns>
diff --git a/port-hash b/port-hash
@@ -1 +1 @@
-3380a3db4a6a60be0ec2e9286231067407346fa6
+aa44e369232f6929d6515d44cf60c5ac35c1d10e

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-3380a3db4a6a60be0ec2e9286231067407346fa6`
	`1`	`+aa44e369232f6929d6515d44cf60c5ac35c1d10e`