Introduce a new util class for getting client info

This replaces the old ui.core.util.Info class, and allows access
to the version information without going through the config
system.

Change-Id: I4b372b62f6fd5adcfa21f0793ec73df7bf2633b6
Reviewed-on: http://gerrit.dmdirc.com/3120
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/logger/ProgramError.java

@@ -23,7 +23,7 @@
 package com.dmdirc.logger;
 
 import com.dmdirc.config.IdentityManager;
-import com.dmdirc.ui.core.util.Info;
+import com.dmdirc.util.ClientInfo;
 import com.dmdirc.util.io.Downloader;
 
 import java.io.File;
@@ -40,7 +40,6 @@ import java.util.Arrays;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.Semaphore;
@@ -335,17 +334,17 @@ public final class ProgramError implements Serializable {
                 .setLevel(getSentryLevel())
                 .setServerName("")
                 .setTimestamp(firstDate)
-                .addTag("version", getVersion())
-                .addTag("version.major", getVersion().replaceAll("-.*", ""))
-                .addTag("os.name", System.getProperty("os.name", "unknown"))
-                .addTag("os.version", System.getProperty("os.version", "unknown"))
-                .addTag("os.arch", System.getProperty("os.arch", "unknown"))
-                .addTag("encoding", System.getProperty("file.encoding", "unknown"))
-                .addTag("locale", Locale.getDefault().toString())
-                .addTag("jvm.name", System.getProperty("java.vm.name", "unknown"))
-                .addTag("jvm.vendor", System.getProperty("java.vm.vendor", "unknown"))
-                .addTag("jvm.version", System.getProperty("java.version", "unknown"))
-                .addTag("jvm.version.major", System.getProperty("java.version", "unknown").replaceAll("_.*", ""));
+                .addTag("version", ClientInfo.getVersion())
+                .addTag("version.major", ClientInfo.getMajorVersion())
+                .addTag("os.name", ClientInfo.getOperatingSystemName())
+                .addTag("os.version", ClientInfo.getOperatingSystemVersion())
+                .addTag("os.arch", ClientInfo.getOperatingSystemArchitecture())
+                .addTag("encoding", ClientInfo.getSystemFileEncoding())
+                .addTag("locale", ClientInfo.getSystemDefaultLocale())
+                .addTag("jvm.name", ClientInfo.getJavaName())
+                .addTag("jvm.vendor", ClientInfo.getJavaVendor())
+                .addTag("jvm.version", ClientInfo.getJavaVersion())
+                .addTag("jvm.version.major", ClientInfo.getJavaMajorVersion());
 
         if (exception != null) {
             eventBuilder.addSentryInterface(new ExceptionInterface(exception));
@@ -605,9 +604,4 @@ public final class ProgramError implements Serializable {
         }
     }
 
-    private String getVersion() {
-        return IdentityManager.getIdentityManager().getGlobalConfiguration()
-                .getOption("version", "version");
-    }
-
 }

src/com/dmdirc/ui/core/util/Info.java

@@ -23,13 +23,17 @@
 package com.dmdirc.ui.core.util;
 
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.util.ClientInfo;
 
 import java.lang.management.ManagementFactory;
 import java.util.Locale;
 
 /**
  * Retrives various pieces of information about DMDirc.
+ *
+ * @deprecated Use methods in {@link ClientInfo} instead.
  */
+@Deprecated
 public class Info {
 
     /** Not intended to be instantiated. */

src/com/dmdirc/util/ClientInfo.java

@@ -0,0 +1,220 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.util;
+
+import com.dmdirc.util.io.ConfigFile;
+import com.dmdirc.util.io.InvalidConfigFileException;
+
+import java.io.IOException;
+import java.lang.management.ManagementFactory;
+import java.util.Locale;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Provides static utility methods to access information about the client and its environment.
+ */
+public final class ClientInfo {
+
+    private static final Logger LOG = LoggerFactory.getLogger(ClientInfo.class);
+
+    /** Domain to read version settings from. */
+    private static final String VERSION_DOMAIN = "version";
+    /** Key within the version domain that holds the actual version. */
+    private static final String VERSION_KEY = "version";
+    /** Domain to read updater settings from. */
+    private static final String UPDATER_DOMAIN = "updater";
+    /** Key within the updater domain that holds the channel. */
+    private static final String UPDATER_CHANNEL_KEY = "channel";
+
+    /** Fallback value to use if a system property isn't found. */
+    private static final String PROPERTY_FALLBACK = "unknown";
+
+    /** Lock used to guard access to {@link #versionConfig}. */
+    private static final Object VERSION_CONFIG_LOCK = new Object();
+
+    /** Cached config file containing the client's version information. */
+    private static ConfigFile versionConfig;
+
+    private ClientInfo() {
+        // Shouldn't be initialised.
+    }
+
+    /**
+     * @return The version of the client.
+     */
+    public static String getVersion() {
+        return getVersionConfigSetting(VERSION_DOMAIN, VERSION_KEY);
+    }
+
+    /**
+     * @return The major version of the client.
+     */
+    public static String getMajorVersion() {
+        return getVersion().replaceAll("(-|rc|a|b|m).*", "");
+    }
+
+    /**
+     * @return The channel that this client was built for.
+     */
+    public static String getUpdaterChannel() {
+        return getVersionConfigSetting(UPDATER_DOMAIN, UPDATER_CHANNEL_KEY);
+    }
+
+    /**
+     * @return The name of the operating system the client is running on.
+     */
+    public static String getOperatingSystemName() {
+        return System.getProperty("os.name", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The version of the operating system the client is running on.
+     */
+    public static String getOperatingSystemVersion() {
+        return System.getProperty("os.version", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The name of the architecture that the operating system is built for.
+     */
+    public static String getOperatingSystemArchitecture() {
+        return System.getProperty("os.arch", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The default file encoding used by the system.
+     */
+    public static String getSystemFileEncoding() {
+        return System.getProperty("file.encoding", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The default locale used by the system.
+     */
+    public static String getSystemDefaultLocale() {
+        return Locale.getDefault().toString();
+    }
+
+    /**
+     * @return The name of the JVM running the client.
+     */
+    public static String getJavaName() {
+        return System.getProperty("jvm.name", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The name of the vendor of the JVM running the client.
+     */
+    public static String getJavaVendor() {
+        return System.getProperty("jvm.vendor", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The version of the JVM running the client.
+     */
+    public static String getJavaVersion() {
+        return System.getProperty("jvm.version", PROPERTY_FALLBACK);
+    }
+
+    /**
+     * @return The major version of the JVM running the client.
+     */
+    public static String getJavaMajorVersion() {
+        return getJavaVersion().replaceAll("_.*", "");
+    }
+
+    /**
+     * @return The uptime for the client in milliseconds.
+     */
+    public static long getUptime() {
+        return ManagementFactory.getRuntimeMXBean().getUptime();
+    }
+
+    /**
+     * @return A string containing the DMDirc version and updater channel.
+     */
+    public static String getVersionInformation() {
+        return getVersion() + " (" + getUpdaterChannel() + ")";
+    }
+
+    /**
+     * @return A string containing the JVM name, version, and vendor.
+     */
+    public static String getJavaInformation() {
+        return getJavaName() + " " + getJavaVersion() + " [" + getJavaVendor() + "]";
+    }
+
+    /**
+     * @return A string containing the OS name, version and architecture, and the default file
+     * encoding and locale.
+     */
+    public static String getOperatingSystemInformation() {
+        return getOperatingSystemName() + " "
+                + getOperatingSystemVersion() + " "
+                + getOperatingSystemArchitecture() + "; "
+                + getSystemFileEncoding() + "; "
+                + getSystemDefaultLocale();
+    }
+
+    /**
+     * Retrieves a single setting from the version configuration file bundled with the client.
+     *
+     * @param domain The domain of the setting to retrieve.
+     * @param key The key of the setting to retrieve.
+     * @return The value of the key within the version config, or {@code null} if it doesn't exist.
+     */
+    public static String getVersionConfigSetting(final String domain, final String key) {
+        return getVersionConfig().getKeyDomain(domain).get(key);
+    }
+
+    /**
+     * Utility method to get the config containing the client's version information.
+     *
+     * <p>This will be cached where possible.
+     *
+     * @return The client's bundled version config file.
+     */
+    private static ConfigFile getVersionConfig() {
+        synchronized (VERSION_CONFIG_LOCK) {
+            if (versionConfig == null) {
+                LOG.debug("No previous version config cached, creating a new one...");
+
+                final ConfigFile config = new ConfigFile(
+                        ClientInfo.class.getResourceAsStream("/com/dmdirc/version.config"));
+
+                try {
+                    config.read();
+                } catch (IOException | InvalidConfigFileException ex) {
+                    LOG.error("Unable to read version information", ex);
+                }
+
+                versionConfig = config;
+            }
+        }
+
+        return versionConfig;
+    }
+
+}