Add version info to document on creation

This is done to preserve document info in case of license unloading.

DITO-465

Author: IdamkinI

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

@@ -85,15 +85,28 @@ public final class Version {
      * iText Group requests that you retain the iText producer line
      * in every PDF that is created or manipulated using iText.
      */
-    private String producerLine = iTextProductName + " " + release + " \u00a92000-2018 iText Group NV";
+    private static final String producerLine = iTextProductName + " " + release + " \u00a92000-2018 iText Group NV";
 
     /**
-     * The license key.
+     * The version info;
      */
-    private String key = null;
+    private final VersionInfo info;
 
     private boolean expired;
 
+    /**
+     * @depricated Use {@link Version#getInstance()} instead. Will be removed in next major release.
+     */
+    @Deprecated
+    public Version() {
+        this.info = new VersionInfo(iTextProductName, release, producerLine, null);
+    }
+
+    private Version(VersionInfo info, boolean expired) {
+        this.info = info;
+        this.expired = expired;
+    }
+
     /**
      * Gets an instance of the iText version that is currently used.
      * Note that iText Group requests that you retain the iText producer line
@@ -105,19 +118,20 @@ public static Version getInstance() {
                 return version;
             }
         }
-        Version localVersion = new Version();
+        Version localVersion;
+        String key = null;
         try {
             String coreVersion = release;
             String[] info = getLicenseeInfoFromLicenseKey(coreVersion);
             if(info != null){
                 if (info[3] != null && info[3].trim().length() > 0) {
-                    localVersion.key = info[3];
+                    key = info[3];
                 } else {
-                    localVersion.key = "Trial version ";
+                    key = "Trial version ";
                     if (info[5] == null) {
-                        localVersion.key += "unauthorised";
+                        key += "unauthorised";
                     } else {
-                        localVersion.key += info[5];
+                        key += info[5];
                     }
                 }
 
@@ -129,35 +143,35 @@ public static Version getInstance() {
                 }
 
                 if (info[4] != null && info[4].trim().length() > 0) {
-                    localVersion.producerLine = info[4];
+                    localVersion = initVersion(info[4], key, false);
                 } else if (info[2] != null && info[2].trim().length() > 0) {
-                    localVersion.addLicensedPostfix(info[2]);
+                    localVersion = initDefaultLicensedVersion(info[2], key);
                 } else if (info[0] != null && info[0].trim().length() > 0) {
                     // fall back to contact name, if company name is unavailable.
                     // we shouldn't have a licensed version without company name,
                     // but let's account for it anyway
-                    localVersion.addLicensedPostfix(info[0]);
+                    localVersion = initDefaultLicensedVersion(info[0], key);
                 } else {
-                    localVersion.addAGPLPostfix(null);
+                    localVersion = initAGPLVersion(null, key);
                 }
             } else {
-                localVersion.addAGPLPostfix(null);
+                localVersion = initAGPLVersion(null, key);
             }
             //Catch the exception
         } catch(LicenseVersionException lve) {
             //Rethrow license version exceptions
             throw lve;
         }catch(ClassNotFoundException cnfe){
             //License key library not on classpath, switch to AGPL
-            localVersion.addAGPLPostfix(null);
+            localVersion = initAGPLVersion(null, key);
         } catch (Exception e) {
             //Check if an iText5 license is loaded
             if(e.getCause() != null && e.getCause().getMessage().equals(LicenseVersionException.LICENSE_FILE_NOT_LOADED)) {
                 if (isiText5licenseLoaded()) {
                     throw new LicenseVersionException(LicenseVersionException.NO_I_TEXT7_LICENSE_IS_LOADED_BUT_AN_I_TEXT5_LICENSE_IS_LOADED);
                 }
             }
-            localVersion.addAGPLPostfix(e.getCause());
+            localVersion = initAGPLVersion(e.getCause(), key);
         }
         return atomicSetVersion(localVersion);
     }
@@ -186,7 +200,7 @@ public static boolean isExpired() {
      * @return the product name
      */
     public String getProduct() {
-        return iTextProductName;
+        return info.getProduct();
     }
 
     /**
@@ -197,7 +211,7 @@ public String getProduct() {
      * @return the release number
      */
     public String getRelease() {
-        return release;
+        return info.getRelease();
     }
 
     /**
@@ -209,7 +223,7 @@ public String getRelease() {
      * @return iText version
      */
     public String getVersion() {
-        return producerLine;
+        return info.getVersion();
     }
 
     /**
@@ -218,24 +232,38 @@ public String getVersion() {
      * @return a license key.
      */
     public String getKey() {
-        return key;
+        return info.getKey();
     }
 
-    private void addLicensedPostfix(String ownerName) {
-        producerLine += " (" + ownerName;
+    /**
+     * Returns a version info in one class
+     *
+     * @return a version info.
+     */
+    public VersionInfo getInfo() {
+        return info;
+    }
+
+    private static Version initDefaultLicensedVersion(String ownerName, String key) {
+        String producer = producerLine + " (" + ownerName;
         if (! key.toLowerCase().startsWith("trial")) {
-            producerLine += "; licensed version)";
+            producer += "; licensed version)";
         } else {
-            producerLine += "; " + key + ")";
+            producer += "; " + key + ")";
         }
+        return initVersion(producer, key, false);
     }
 
-    private void addAGPLPostfix(Throwable cause) {
-        producerLine += AGPL;
+    private static Version initAGPLVersion(Throwable cause, String key) {
+        String producer = producerLine + AGPL;
 
-        if (cause != null && cause.getMessage() != null && cause.getMessage().contains("expired")) {
-            expired = true;
-        }
+        boolean expired = cause != null && cause.getMessage() != null && cause.getMessage().contains("expired");
+
+        return initVersion(producer, key, expired);
+    }
+
+    private static Version initVersion(String producer, String key, boolean expired) {
+        return new Version(new VersionInfo(iTextProductName, release, producer, key), expired);
     }
 
     private static Class<?> getLicenseKeyClass() throws ClassNotFoundException {

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

@@ -0,0 +1,106 @@
+/*
+
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2018 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;
+
+import java.io.Serializable;
+
+public class VersionInfo implements Serializable {
+
+    private static final long serialVersionUID = 1514128839876564529L;
+
+    private final String productName;
+    private final String releaseNumber;
+    private final String producerLine;
+    private final String licenseKey;
+
+    public VersionInfo(String productName, String releaseNumber, String producerLine, String licenseKey) {
+        this.productName = productName;
+        this.releaseNumber = releaseNumber;
+        this.producerLine = producerLine;
+        this.licenseKey = licenseKey;
+    }
+
+    /**
+     * Gets the product name.
+     * iText Group NV requests that you retain the iText producer line
+     * in every PDF that is created or manipulated using iText.
+     *
+     * @return the product name
+     */
+    public String getProduct() {
+        return productName;
+    }
+
+    /**
+     * Gets the release number.
+     * iText Group NV requests that you retain the iText producer line
+     * in every PDF that is created or manipulated using iText.
+     *
+     * @return the release number
+     */
+    public String getRelease() {
+        return releaseNumber;
+    }
+
+    /**
+     * Returns the iText version as shown in the producer line.
+     * iText is a product developed by iText Group NV.
+     * iText Group requests that you retain the iText producer line
+     * in every PDF that is created or manipulated using iText.
+     *
+     * @return iText version
+     */
+    public String getVersion() {
+        return producerLine;
+    }
+
+    /**
+     * Returns a license key if one was provided, or null if not.
+     *
+     * @return a license key.
+     */
+    public String getKey() {
+        return licenseKey;
+    }
+}

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

@@ -51,6 +51,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.ProductInfo;
 import com.itextpdf.kernel.Version;
+import com.itextpdf.kernel.VersionInfo;
 import com.itextpdf.kernel.counter.EventCounterHandler;
 import com.itextpdf.kernel.counter.event.CoreEvent;
 import com.itextpdf.kernel.crypto.BadPasswordException;
@@ -197,6 +198,7 @@ public class PdfDocument implements IEventDispatcher, Closeable, Serializable {
     private static final AtomicLong lastDocumentId = new AtomicLong();
 
     private long documentId;
+    private VersionInfo versionInfo = Version.getInstance().getInfo();
 
     /**
      * Yet not copied link annotations from the other documents.
@@ -324,7 +326,7 @@ public byte[] getXmpMetadata(boolean createNew) {
             addCustomMetadataExtensions(xmpMeta);
             try {
                 xmpMeta.setProperty(XMPConst.NS_DC, PdfConst.Format, "application/pdf");
-                xmpMeta.setProperty(XMPConst.NS_PDF, PdfConst.Producer, Version.getInstance().getVersion());
+                xmpMeta.setProperty(XMPConst.NS_PDF, PdfConst.Producer, versionInfo.getVersion());
                 setXmpMetadata(xmpMeta);
             } catch (XMPException ignored) {
             }
@@ -1813,19 +1815,12 @@ protected void open(PdfVersion newPdfVersion) {
                     writer.crypto = reader.decrypt;
                 }
                 writer.document = this;
-                String producer = null;
                 if (reader == null) {
                     catalog = new PdfCatalog(this);
                     info = new PdfDocumentInfo(this).addCreationDate();
-                    producer = Version.getInstance().getVersion();
-                } else {
-                    if (info.getPdfObject().containsKey(PdfName.Producer)) {
-                        producer = info.getPdfObject().getAsString(PdfName.Producer).toUnicodeString();
-                    }
-                    producer = addModifiedPostfix(producer);
                 }
+                updateProducerInInfoDictionary();
                 info.addModDate();
-                info.getPdfObject().put(PdfName.Producer, new PdfString(producer));
                 trailer = new PdfDictionary();
                 trailer.put(PdfName.Root, catalog.getPdfObject().getIndirectReference());
                 trailer.put(PdfName.Info, info.getPdfObject().getIndirectReference());
@@ -2003,10 +1998,19 @@ protected List<ICounter> getCounters() {
         return CounterManager.getInstance().getCounters(PdfDocument.class);
     }
 
+    /**
+     * Gets iText version info.
+     *
+     * @return iText version info.
+     */
+    final VersionInfo getVersionInfo() {
+        return versionInfo;
+    }
+
     private void updateProducerInInfoDictionary() {
         String producer = null;
         if (reader == null) {
-            producer = Version.getInstance().getVersion();
+            producer = versionInfo.getVersion();
         } else {
             if (info.getPdfObject().containsKey(PdfName.Producer)) {
                 producer = info.getPdfObject().getAsString(PdfName.Producer).toUnicodeString();
@@ -2290,9 +2294,8 @@ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundE
     }
 
     private String addModifiedPostfix(String producer) {
-        Version version = Version.getInstance();
-        if (producer == null || !version.getVersion().contains(version.getProduct())) {
-            return version.getVersion();
+        if (producer == null || !versionInfo.getVersion().contains(versionInfo.getProduct())) {
+            return versionInfo.getVersion();
         } else {
             int idx = producer.indexOf("; modified using");
             StringBuilder buf;
@@ -2302,7 +2305,7 @@ private String addModifiedPostfix(String producer) {
                 buf = new StringBuilder(producer.substring(0, idx));
             }
             buf.append("; modified using ");
-            buf.append(version.getVersion());
+            buf.append(versionInfo.getVersion());
             return buf.toString();
         }
     }

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

@@ -48,6 +48,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.util.MessageFormatUtil;
 import com.itextpdf.kernel.ProductInfo;
 import com.itextpdf.kernel.Version;
+import com.itextpdf.kernel.VersionInfo;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -404,12 +405,12 @@ protected static void writeKeyInfo(PdfDocument document) {
         FingerPrint fingerPrint = document.getFingerPrint();
 
         String platform = "";
-        Version version = Version.getInstance();
-        String k = version.getKey();
+        VersionInfo versionInfo = document.getVersionInfo();
+        String k = versionInfo.getKey();
         if (k == null) {
             k = "iText";
         }
-        writer.writeString(MessageFormatUtil.format("%{0}-{1}{2}\n", k, version.getRelease(), platform));
+        writer.writeString(MessageFormatUtil.format("%{0}-{1}{2}\n", k, versionInfo.getRelease(), platform));
 
         for (ProductInfo productInfo : fingerPrint.getProducts() ) {
             writer.writeString(MessageFormatUtil.format("%{0}\n", productInfo));