Merge pull request LibrePDF#55 from albfernandez/read_version_from_ma…

…nifest

Read version from MANIFEST

fixes LibrePDF#54

openpdf/src/main/java/com/lowagie/text/Document.java

@@ -108,7 +108,7 @@ public class Document implements DocListener {
     /**
      * @since	2.1.6
      */
-    private static final String RELEASE = "1.0.6-SNAPSHOT";
+    private static final String RELEASE = VersionBean.VERSION.getImplementationVersion();
     private static final String OPENPDF_VERSION = OPENPDF + " " + RELEASE;
 
 	/**

openpdf/src/main/java/com/lowagie/text/VersionBean.java

@@ -0,0 +1,249 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2013, Red Hat, Inc. and individual contributors
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package com.lowagie.text;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.JarURLConnection;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLConnection;
+import java.security.CodeSource;
+import java.security.ProtectionDomain;
+import java.text.MessageFormat;
+import java.util.jar.Attributes;
+import java.util.jar.JarFile;
+import java.util.jar.JarInputStream;
+import java.util.jar.Manifest;
+
+
+/**
+ * Vendor and version information for A4J project
+ *
+ * @author [email protected] (latest modification by $Author$)
+ * @version $Revision$ $Date$
+ */
+final class VersionBean {
+    public static final Version VERSION = new Version();
+
+    /**
+     * Class for incapsulate version info.
+     *
+     * @author [email protected] (latest modification by $Author$)
+     * @version $Revision$ $Date$
+     */
+    public static class Version {
+        private static final String UNKNOWN = "";
+        private String implementationVendor = UNKNOWN;
+        // TODO nick - default value for manifest file absense - review
+        private String implementationVersion = "1.0.0";
+        private String bundleVersion = "1.0.0";
+        private String implementationTitle = UNKNOWN;
+        private String scmTimestamp = UNKNOWN;
+        private String fullVersionString = UNKNOWN;
+        private boolean containsDataFromManifest = false;
+
+        public Version() {
+            initialize();
+        }
+
+        private String getAttributeValueOrDefault(Attributes attributes, String name) {
+            String value = attributes.getValue(name);
+            if (value == null) {
+                value = UNKNOWN;
+            }
+
+            return value;
+        }
+
+        private void initialize() {
+            Manifest manifest = null;
+            try {
+                manifest = readManifest();
+                if (manifest != null) {
+                    initializePropertiesFromManifest(manifest);
+                    initializeDerivativeProperties();
+                }
+            } catch (Exception e) {
+            }
+
+
+        }
+
+        private void initializePropertiesFromManifest(Manifest manifest) {
+            containsDataFromManifest = true;
+
+            Attributes attributes = manifest.getMainAttributes();
+            implementationVendor = getAttributeValueOrDefault(attributes, "Implementation-Vendor");
+            implementationVersion = getAttributeValueOrDefault(attributes, "Implementation-Version");
+            bundleVersion = getAttributeValueOrDefault(attributes, "Bundle-Version");
+            implementationTitle = getAttributeValueOrDefault(attributes, "Implementation-Title");
+            scmTimestamp = getAttributeValueOrDefault(attributes, "SCM-Timestamp");
+
+            if (isEmpty(implementationVersion) && !isEmpty(bundleVersion)) {
+            	implementationVersion = bundleVersion;
+            }
+        }
+        private boolean isEmpty(String value) {
+        	return value == null || value.length() == 0;
+        }
+
+        private void initializeDerivativeProperties() {
+            fullVersionString = MessageFormat.format("{0}", implementationVersion);
+        }
+
+        private Manifest readManifest() {
+            ProtectionDomain domain = VersionBean.class.getProtectionDomain();
+            if (domain != null) {
+                CodeSource codeSource = domain.getCodeSource();
+                if (codeSource != null) {
+                    URL url = codeSource.getLocation();
+                    if (url != null) {
+                        InputStream manifestStream = null;
+                        try {
+                            URL manifestFileUrl;
+                            if ("vfs".equals(url.getProtocol())) {
+                                String manifestFile = String.format("%s/%s", url.toExternalForm(), JarFile.MANIFEST_NAME);
+                                manifestFileUrl = new URL(manifestFile);
+                            } else {
+                                manifestFileUrl = new URL(url, JarFile.MANIFEST_NAME);
+                            }
+                            manifestStream = urlToStream(manifestFileUrl);
+                            return new Manifest(manifestStream);
+                        } catch (MalformedURLException e1) {
+
+                        } catch (IOException e) {
+
+                        } finally {
+                            if (manifestStream != null) {
+                                try {
+                                    manifestStream.close();
+                                } catch (IOException e) {
+                                }
+                            }
+                        }
+
+                        JarInputStream jis = null;
+                        try {
+                            URLConnection urlConnection = url.openConnection();
+                            urlConnection.setUseCaches(false);
+
+                            if (urlConnection instanceof JarURLConnection) {
+                                JarURLConnection jarUrlConnection = (JarURLConnection) urlConnection;
+                                return jarUrlConnection.getManifest();
+                            } else {
+                                jis = new JarInputStream(urlConnection.getInputStream());
+                                return jis.getManifest();
+                            }
+                        } catch (IOException e) {
+                        } finally {
+                            if (jis != null) {
+                                try {
+                                    jis.close();
+                                } catch (IOException e) {
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+            return null;
+        }
+
+
+        /**
+         * Returns {@link InputStream} corresponding to argument {@link URL} but with caching disabled
+         *
+         * @param url {@link URL} of the resource
+         * @return {@link InputStream} instance or <code>null</code>
+         * @throws IOException
+         */
+        private static InputStream urlToStream(URL url) throws IOException {
+            if (url != null) {
+                URLConnection connection = url.openConnection();
+
+                try {
+                    connection.setUseCaches(false);
+                } catch (IllegalArgumentException e) {
+                }
+
+                return connection.getInputStream();
+            } else {
+                return null;
+            }
+        }
+        boolean containsDataFromManifest() {
+            return containsDataFromManifest;
+        }
+
+        public String getVersion() {
+            return fullVersionString;
+        }
+
+        public String getImplementationTitle() {
+            return implementationTitle;
+        }
+
+        public String getImplementationVendor() {
+            return implementationVendor;
+        }
+
+        public String getImplementationVersion() {
+            return implementationVersion;
+        }
+
+        public String getScmTimestamp() {
+            return scmTimestamp;
+        }
+
+        @Override
+        public String toString() {
+            if (this.containsDataFromManifest()) {
+                return getImplementationTitle() + " by " + getImplementationVendor() + ", version " + getVersion();
+            } else {
+                return getVersion();
+            }
+        }
+    }
+
+    public String getVendor() {
+        return VERSION.getImplementationVendor();
+    }
+
+    public String getTitle() {
+        return VERSION.getImplementationTitle();
+    }
+
+    public String getTimestamp() {
+        return VERSION.getScmTimestamp();
+    }
+
+    public Version getVersion() {
+        return VERSION;
+    }
+
+    @Override
+    public String toString() {
+        return VERSION.toString();
+    }
+}

openpdf/src/test/java/com/lowagie/text/DocumentTest.java

@@ -4,10 +4,6 @@
 import java.io.BufferedReader;
 import java.io.InputStreamReader;
 import java.io.InputStream;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
-import java.nio.file.Paths;
-import java.util.List;
 
 import org.junit.Assert;
 import org.junit.Test;
@@ -19,8 +15,10 @@ public void testThatVersionIsCorrect() throws IOException {
         // Given
         String versionFromPom = getProjectVersion();
         String versionInCode = Document.getVersion();
+        // maven-bundle-plugin transforms 1.0.5-SNAPSHOT to 1.0.5.SNAPSHOT
+        String versionFromPomNormalized = versionFromPom.replace('-', '.');
         // Then
-        Assert.assertTrue("Version number in code (" + versionInCode + ") is not the same as pom (" + versionFromPom + ").", versionInCode.endsWith(versionFromPom));
+        Assert.assertTrue("Version number in code (" + versionInCode + ") is not the same as pom (" + versionFromPom + ").", versionInCode.endsWith(versionFromPomNormalized));
     }
 
     private String getProjectVersion() {