Update fingerprint logic

DEVSIX-5712

Author: Egor Martsynkovsky

commons/src/main/java/com/itextpdf/commons/actions/data/ProductData.java

@@ -22,6 +22,8 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.commons.actions.data;
 
+import java.util.Objects;
+
 /**
  * Class is used to describe used product information.
  */
@@ -94,4 +96,31 @@ public int getSinceCopyrightYear() {
     public int getToCopyrightYear() {
         return toCopyrightYear;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        final ProductData other = (ProductData) o;
+        return Objects.equals(publicProductName, other.publicProductName) && Objects
+                .equals(productName, other.productName) &&
+                Objects.equals(version, other.version) && sinceCopyrightYear == other.sinceCopyrightYear
+                && toCopyrightYear == other.toCopyrightYear;
+    }
+
+    @Override
+    public int hashCode() {
+        int result = publicProductName != null ? publicProductName.hashCode() : 0;
+        result += 31 * result + (productName != null ? productName.hashCode() : 0);
+        result += 31 * result + (version != null ? version.hashCode() : 0);
+        result += 31 * result + sinceCopyrightYear;
+        result += 31 * result + toCopyrightYear;
+        return result;
+    }
 }

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

@@ -78,6 +78,7 @@ protected void doAction() {
 
         final Set<String> products = new HashSet<>();
         for (final AbstractProductProcessITextEvent event : events) {
+            pdfDocument.getFingerPrint().registerProduct(event.getProductData());
             if (event.getConfirmationType() == EventConfirmationType.ON_CLOSE) {
                 EventManager.getInstance().onEvent(new ConfirmEvent(pdfDocument.getDocumentIdWrapper(), event));
             }

kernel/src/main/java/com/itextpdf/kernel/actions/events/FlushPdfDocumentEvent.java

@@ -43,10 +43,12 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.kernel.pdf;
 
-import com.itextpdf.kernel.ProductInfo;
+import com.itextpdf.commons.actions.data.ProductData;
 
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
+import java.util.LinkedHashSet;
 import java.util.Set;
 
 /**
@@ -56,34 +58,34 @@ This file is part of the iText (R) project.
  */
 public class FingerPrint {
 
-    private Set<ProductInfo> productInfoSet;
+    private Set<ProductData> productDataSet;
 
     /**
-     * Default constructor. Initializes the productInfoSet.
+     * Default constructor. Initializes the productDataSet.
      */
     public FingerPrint() {
-        this.productInfoSet = new HashSet<>();
+        this.productDataSet = new LinkedHashSet<>();
     }
 
     /**
      * Registers a product to be added to the fingerprint or other debugging info.
      *
-     * @param productInfo ProductInfo to be added
+     * @param productData ProductData to be added
      * @return true if the fingerprint did not already contain the specified element
      */
-    public boolean registerProduct(final ProductInfo productInfo) {
-        int initialSize = productInfoSet.size();
-        productInfoSet.add(productInfo);
-        return initialSize != productInfoSet.size();
+    public boolean registerProduct(final ProductData productData) {
+        int initialSize = productDataSet.size();
+        productDataSet.add(productData);
+        return initialSize != productDataSet.size();
     }
 
     /**
      * Returns the registered products.
      *
      * @return registered products.
      */
-    public Collection<ProductInfo> getProducts() {
-        return this.productInfoSet;
+    public Collection<ProductData> getProducts() {
+        return Collections.unmodifiableSet(new LinkedHashSet<>(this.productDataSet));
     }
 
 }

kernel/src/main/java/com/itextpdf/kernel/pdf/FingerPrint.java

@@ -43,18 +43,18 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.kernel.pdf;
 
-import com.itextpdf.commons.actions.EventManager;
-import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
-import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
-import com.itextpdf.commons.actions.sequence.SequenceId;
-import com.itextpdf.commons.utils.MessageFormatUtil;
+import com.itextpdf.commons.actions.data.ProductData;
 import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.source.ByteUtils;
 import com.itextpdf.io.source.RandomAccessFileOrArray;
+import com.itextpdf.commons.utils.MessageFormatUtil;
 import com.itextpdf.kernel.PdfException;
-import com.itextpdf.kernel.ProductInfo;
+import com.itextpdf.commons.actions.EventManager;
 import com.itextpdf.kernel.actions.data.ITextCoreProductData;
+import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
+import com.itextpdf.commons.actions.confirmations.EventConfirmationType;
 import com.itextpdf.kernel.actions.events.FlushPdfDocumentEvent;
+import com.itextpdf.commons.actions.sequence.SequenceId;
 import com.itextpdf.kernel.actions.events.ITextCoreProductEvent;
 import com.itextpdf.kernel.crypto.BadPasswordException;
 import com.itextpdf.kernel.events.EventDispatcher;
@@ -1812,11 +1812,11 @@ public PdfFont addFont(PdfFont font) {
     /**
      * Registers a product for debugging purposes.
      *
-     * @param productInfo product to be registered.
+     * @param productData product to be registered.
      * @return true if the product hadn't been registered before.
      */
-    public boolean registerProduct(final ProductInfo productInfo) {
-        return this.fingerPrint.registerProduct(productInfo);
+    public boolean registerProduct(final ProductData productData) {
+        return this.fingerPrint.registerProduct(productData);
     }
 
     /**

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfDocument.java

@@ -43,10 +43,10 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.kernel.pdf;
 
+import com.itextpdf.commons.actions.data.ProductData;
 import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.source.ByteUtils;
 import com.itextpdf.commons.utils.MessageFormatUtil;
-import com.itextpdf.kernel.ProductInfo;
 import com.itextpdf.kernel.actions.data.ITextCoreProductData;
 
 import org.slf4j.Logger;
@@ -514,17 +514,14 @@ protected static void writeKeyInfo(PdfDocument document) {
         PdfWriter writer = document.getWriter();
         FingerPrint fingerPrint = document.getFingerPrint();
 
-        //TODO DEVSIX-5712 in the scope of this ticket we will discuss, what information we would write.
-        //String platform = "";
-        //VersionInfo versionInfo = document.getVersionInfo();
-        //String k = versionInfo.getKey();
-        //if (k == null) {
-        //    k = "iText";
-        //}
-        //writer.writeString(MessageFormatUtil.format("%{0}-{1}{2}\n", k, versionInfo.getRelease(), platform));
-
-        for (ProductInfo productInfo : fingerPrint.getProducts() ) {
-            writer.writeString(MessageFormatUtil.format("%{0}\n", productInfo));
+        if (fingerPrint.getProducts().isEmpty()) {
+            writer.writeString(MessageFormatUtil
+                    .format("%iText-{0}-no-registered-products", ITextCoreProductData.getInstance().getVersion()));
+        } else {
+            for (ProductData productData : fingerPrint.getProducts()) {
+                writer.writeString(MessageFormatUtil
+                        .format("%iText-{0}-{1}\n", productData.getPublicProductName(), productData.getVersion()));
+            }
         }
     }
 

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfXrefTable.java

@@ -42,7 +42,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.kernel.pdf;
 
-import com.itextpdf.kernel.ProductInfo;
+import com.itextpdf.commons.actions.data.ProductData;
 import com.itextpdf.test.ExtendedITextTest;
 
 import com.itextpdf.test.annotations.type.IntegrationTest;
@@ -54,28 +54,30 @@ This file is part of the iText (R) project.
 @Category(IntegrationTest.class)
 public class FingerPrintTest extends ExtendedITextTest {
 
-    private ProductInfo productInfo;
-    private ProductInfo productInfo2;
+    private ProductData productData;
+    private ProductData productData2;
+    private ProductData duplicateProductData;
 
     @Before
     public void beforeTest() {
-        this.productInfo = new ProductInfo("pdfProduct", 1, 0, 0, true);
-        this.productInfo2 = new ProductInfo("pdfProduct2", 1, 0, 0, true);
+        this.productData = new ProductData("pdfProduct", "pdfProduct", "7.0.0", 1900, 2000);
+        this.productData2 = new ProductData("pdfProduct2", "pdfProduct2", "7.0.0", 1900, 2000);
+        this.duplicateProductData =new ProductData("pdfProduct", "pdfProduct", "7.0.0", 1900, 2000);
     }
 
     @Test
     public void normalAddTest() {
         FingerPrint fingerPrint = new FingerPrint();
-        Assert.assertTrue(fingerPrint.registerProduct(productInfo));
-        Assert.assertTrue(fingerPrint.registerProduct(productInfo2));
+        Assert.assertTrue(fingerPrint.registerProduct(productData));
+        Assert.assertTrue(fingerPrint.registerProduct(productData2));
         Assert.assertEquals(2, fingerPrint.getProducts().size());
     }
 
     @Test
     public void duplicateTest() {
         FingerPrint fingerPrint = new FingerPrint();
-        fingerPrint.registerProduct(productInfo);
-        Assert.assertFalse(fingerPrint.registerProduct(productInfo));
+        fingerPrint.registerProduct(productData);
+        Assert.assertFalse(fingerPrint.registerProduct(duplicateProductData));
     }
 }