JAL-1551 spotlessApply
[jalview.git] / src / jalview / bin / Cache.java
index 1a4f341..4891451 100755 (executable)
@@ -24,7 +24,9 @@ import java.awt.Color;
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.PrintWriter;
@@ -34,7 +36,9 @@ import java.net.PasswordAuthentication;
 import java.net.URL;
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.Date;
 import java.util.Enumeration;
@@ -42,7 +46,6 @@ import java.util.Locale;
 import java.util.Properties;
 import java.util.StringTokenizer;
 import java.util.TreeSet;
-import java.util.regex.Pattern;
 
 import javax.swing.LookAndFeel;
 import javax.swing.UIManager;
@@ -50,7 +53,6 @@ import javax.swing.UIManager;
 import jalview.datamodel.PDBEntry;
 import jalview.gui.Preferences;
 import jalview.gui.UserDefinedColours;
-import jalview.log.JLogger;
 import jalview.log.JLoggerLog4j;
 import jalview.schemes.ColourSchemeLoader;
 import jalview.schemes.ColourSchemes;
@@ -59,7 +61,6 @@ import jalview.structure.StructureImportSettings;
 import jalview.urls.IdOrgSettings;
 import jalview.util.ChannelProperties;
 import jalview.util.ColorUtils;
-import jalview.util.Log4j;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.ws.sifts.SiftsSettings;
@@ -173,6 +174,8 @@ import jalview.ws.sifts.SiftsSettings;
  * <li>FOLLOW_SELECTIONS (true) Controls whether a new alignment view should
  * respond to selections made in other alignments containing the same sequences.
  * </li>
+ * <li>SHOW_JWS2_SERVICES (true) when set to false, jalview will not
+ * auto-discover JABAWS services</li>
  * <li>JWS2HOSTURLS comma-separated list of URLs to try for JABAWS services</li>
  * <li>SHOW_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
  * warning dialog box is displayed.</li>
@@ -200,7 +203,13 @@ import jalview.ws.sifts.SiftsSettings;
  * <li>CHIMERA_PATH specify full path to Chimera program (if non-standard)</li>
  * <li>ID_ORG_HOSTURL location of jalview service providing identifiers.org urls
  * </li>
- * 
+ * <li>NONEWS - when set disables Jalview News from automatically appearing</li>
+ * <li>NOHTMLTEMPLATES - when set, the
+ * https://github.com/jalview/exporter-templates/tree/master/biojs repository is
+ * not downloaded automatically</li>
+ * <li>NOIDENTIFIERSSERVICE - when set, jalview won't automatically download
+ * available URL linkouts via www.jalview.org/services/identifiers</li>
+ * <li>
  * </ul>
  * Deprecated settings:
  * <ul>
@@ -276,8 +285,6 @@ public class Cache
 
   public final static String JALVIEW_LOGGER_NAME = "JalviewLogger";
 
-  public static JLoggerLog4j log;
-
   // save the proxy properties set at startup
   public final static String[] startupProxyProperties = {
       System.getProperty("http.proxyHost"),
@@ -317,64 +324,21 @@ public class Cache
   /** Default file is ~/.jalview_properties */
   static String propertiesFile;
 
-  private static boolean propsAreReadOnly = Platform.isJS();
-
-  private final static String JS_PROPERTY_PREFIX = "jalview_";
+  private static final String fallbackPropertiesFile = ".jalview_properties";
 
-  public final static String LOGGING_TEST_MESSAGE = "Logging to STDERR";
+  private static boolean propsAreReadOnly = Platform.isJS();
 
-  public static JLogger.LogLevel getCachedLogLevel()
+  public static boolean isPropsAreReadOnly()
   {
-    return getCachedLogLevel(JALVIEWLOGLEVEL);
+    return propsAreReadOnly;
   }
 
-  public static JLogger.LogLevel getCachedLogLevel(String key)
+  public static void setPropsAreReadOnly(boolean propsAreReadOnly)
   {
-    return JLogger.toLevel(Cache.getDefault(key, "INFO"));
+    Cache.propsAreReadOnly = propsAreReadOnly;
   }
 
-  public static boolean initLogger()
-  {
-    if (log != null)
-    {
-      return true;
-    }
-    try
-    {
-      JLogger.LogLevel cachedLevel = getCachedLogLevel();
-      if (!Platform.isJS())
-      {
-        Log4j.init(cachedLevel);
-      }
-      // log output
-      // is laxis used? Does getLogger do anything without a Logger object?
-      // Logger laxis = Log4j.getLogger("org.apache.axis", myLevel);
-      JLoggerLog4j.getLogger("org.apache.axis", cachedLevel);
-
-      // The main application logger
-      log = JLoggerLog4j.getLogger(JALVIEW_LOGGER_NAME, cachedLevel);
-    } catch (NoClassDefFoundError e)
-    {
-      System.err.println("Could not initialise the logger framework");
-      e.printStackTrace();
-    }
-
-    // Test message
-    if (log != null)
-    {
-      // Logging test message should got through the logger object
-      if (log.loggerExists())
-        log.debug(LOGGING_TEST_MESSAGE);
-      // Tell the user that debug is enabled
-      Cache.debug(ChannelProperties.getProperty("app_name")
-              + " Debugging Output Follows.");
-      return true;
-    }
-    else
-    {
-      return false;
-    }
-  }
+  private final static String JS_PROPERTY_PREFIX = "jalview_";
 
   /**
    * Loads properties from the given properties file. Any existing properties
@@ -389,7 +353,7 @@ public class Cache
     {
       String channelPrefsFilename = ChannelProperties
               .getProperty("preferences.filename");
-      String releasePrefsFilename = ".jalview_properties";
+      String releasePrefsFilename = fallbackPropertiesFile;
       propertiesFile = System.getProperty("user.home") + File.separatorChar
               + channelPrefsFilename;
       releasePropertiesFile = System.getProperty("user.home")
@@ -486,7 +450,7 @@ public class Cache
     default:
       String message = "Incorrect PROXY_TYPE - should be 'none' (clear proxy properties), 'false' (system settings), 'true' (custom settings): "
               + proxyType;
-      Cache.warn(message);
+      Console.warn(message);
     }
 
     // LOAD THE AUTHORS FROM THE authors.props file
@@ -570,25 +534,29 @@ public class Cache
                     + orgtimeout + " seconds.");
           }
           String remoteVersion = null;
-          try
+          if (remoteBuildPropertiesUrl.startsWith("http"))
           {
-            System.setProperty("sun.net.client.defaultConnectTimeout",
-                    "5000");
-            java.net.URL url = new java.net.URL(remoteBuildPropertiesUrl);
+            try
+            {
+              System.setProperty("sun.net.client.defaultConnectTimeout",
+                      "5000");
 
-            BufferedReader in = new BufferedReader(
-                    new InputStreamReader(url.openStream()));
+              URL url = new URL(remoteBuildPropertiesUrl);
 
-            Properties remoteBuildProperties = new Properties();
-            remoteBuildProperties.load(in);
-            remoteVersion = remoteBuildProperties.getProperty("VERSION");
-          } catch (Exception ex)
-          {
-            System.out
-                    .println("Non-fatal exception when checking version at "
-                            + remoteBuildPropertiesUrl + ":");
-            System.out.println(ex);
-            remoteVersion = getProperty("VERSION");
+              BufferedReader in = new BufferedReader(
+                      new InputStreamReader(url.openStream()));
+
+              Properties remoteBuildProperties = new Properties();
+              remoteBuildProperties.load(in);
+              remoteVersion = remoteBuildProperties.getProperty("VERSION");
+            } catch (Exception ex)
+            {
+              System.out.println(
+                      "Non-fatal exception when checking version at "
+                              + remoteBuildPropertiesUrl + ":");
+              System.out.println(ex);
+              remoteVersion = getProperty("VERSION");
+            }
           }
           System.setProperty("sun.net.client.defaultConnectTimeout",
                   orgtimeout);
@@ -678,6 +646,11 @@ public class Cache
         applicationProperties.put("VERSION",
                 buildProperties.getProperty("VERSION"));
       }
+      if (buildProperties.getProperty("JAVA_COMPILE_VERSION", null) != null)
+      {
+        applicationProperties.put("JAVA_COMPILE_VERSION",
+                buildProperties.getProperty("JAVA_COMPILE_VERSION"));
+      }
     } catch (Exception ex)
     {
       System.out.println("Error reading build details: " + ex);
@@ -859,11 +832,13 @@ public class Cache
         if (jalview.jbgui.GDesktop.class.getClassLoader()
                 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
         {
-          debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
+          Console.debug(
+                  "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
           vamsasJarsArePresent = 1;
           JLoggerLog4j lvclient = JLoggerLog4j.getLogger("uk.ac.vamsas",
-                  getCachedLogLevel("logs.Vamsas.Level"));
-          JLoggerLog4j.addAppender(lvclient, log, JALVIEW_LOGGER_NAME);
+                  Console.getCachedLogLevel("logs.Vamsas.Level"));
+          JLoggerLog4j.addAppender(lvclient, Console.log,
+                  JALVIEW_LOGGER_NAME);
           // Tell the user that debug is enabled
           lvclient.debug(ChannelProperties.getProperty("app_name")
                   + " Vamsas Client Debugging Output Follows.");
@@ -871,7 +846,7 @@ public class Cache
       } catch (Exception e)
       {
         vamsasJarsArePresent = 0;
-        debug("Vamsas Classes are not present");
+        Console.debug("Vamsas Classes are not present");
       }
     }
     return (vamsasJarsArePresent > 0);
@@ -896,11 +871,13 @@ public class Cache
         if (Cache.class.getClassLoader()
                 .loadClass("groovy.lang.GroovyObject") != null)
         {
-          debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
+          Console.debug(
+                  "Found Groovy (groovy.lang.GroovyObject can be loaded)");
           groovyJarsArePresent = 1;
           JLoggerLog4j lgclient = JLoggerLog4j.getLogger("groovy",
-                  getCachedLogLevel("logs.Groovy.Level"));
-          JLoggerLog4j.addAppender(lgclient, log, JALVIEW_LOGGER_NAME);
+                  Console.getCachedLogLevel("logs.Groovy.Level"));
+          JLoggerLog4j.addAppender(lgclient, Console.log,
+                  JALVIEW_LOGGER_NAME);
           // Tell the user that debug is enabled
           lgclient.debug(ChannelProperties.getProperty("app_name")
                   + " Groovy Client Debugging Output Follows.");
@@ -908,11 +885,11 @@ public class Cache
       } catch (Error e)
       {
         groovyJarsArePresent = 0;
-        debug("Groovy Classes are not present", e);
+        Console.debug("Groovy Classes are not present", e);
       } catch (Exception e)
       {
         groovyJarsArePresent = 0;
-        debug("Groovy Classes are not present");
+        Console.debug("Groovy Classes are not present");
       }
     }
     return (groovyJarsArePresent > 0);
@@ -946,7 +923,8 @@ public class Cache
                   .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
         } catch (Exception e)
         {
-          debug("com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
+          Console.debug(
+                  "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
           tracker = null;
           jgoogleanalyticstracker = null;
           trackerfocus = null;
@@ -989,22 +967,27 @@ public class Cache
       {
         if (re != null)
         {
-          debug("Caught runtime exception in googletracker init:", re);
+          Console.debug("Caught runtime exception in googletracker init:",
+                  re);
         }
         if (ex != null)
         {
-          warn("Failed to initialise GoogleTracker for Jalview Desktop with version "
-                  + vrs, ex);
+          Console.warn(
+                  "Failed to initialise GoogleTracker for Jalview Desktop with version "
+                          + vrs,
+                  ex);
         }
         if (err != null)
         {
-          error("Whilst initing GoogleTracker for Jalview Desktop version "
-                  + vrs, err);
+          Console.error(
+                  "Whilst initing GoogleTracker for Jalview Desktop version "
+                          + vrs,
+                  err);
         }
       }
       else
       {
-        debug("Successfully initialised tracker.");
+        Console.debug("Successfully initialised tracker.");
       }
     }
   }
@@ -1026,7 +1009,8 @@ public class Cache
     Color col = ColorUtils.parseColourString(colprop);
     if (col == null)
     {
-      warn("Couldn't parse '" + colprop + "' as a colour for " + property);
+      Console.warn("Couldn't parse '" + colprop + "' as a colour for "
+              + property);
     }
     return (col == null) ? defcolour : col;
   }
@@ -1194,8 +1178,11 @@ public class Cache
     {
       return;
     }
-    String line = prefix + (value != null ? value : defaultValue) + suffix;
-    sb.append(line);
+    if (prefix != null)
+      sb.append(prefix);
+    sb.append(value == null ? defaultValue : value);
+    if (suffix != null)
+      sb.append(suffix);
   }
 
   /**
@@ -1219,6 +1206,7 @@ public class Cache
     sb.append("Java version: ");
     sb.append(System.getProperty("java.version"));
     sb.append("\n");
+    sb.append("Java platform: ");
     sb.append(System.getProperty("os.arch"));
     sb.append(" ");
     sb.append(System.getProperty("os.name"));
@@ -1239,17 +1227,19 @@ public class Cache
     sb.append(" (");
     sb.append(lafClass);
     sb.append(")\n");
-    // Not displayed in release version ( determined by possible version number
-    // regex 9[9.]*9[.-_a9]* )
-    if (Pattern.matches("^\\d[\\d\\.]*\\d[\\.\\-\\w]*$",
-            Cache.getDefault("VERSION", "TEST")))
+    appendIfNotNull(sb, "Channel: ",
+            ChannelProperties.getProperty("channel"), "\n", null);
+    if (Console.isDebugEnabled()
+            || !"release".equals(ChannelProperties.getProperty("channel")))
     {
       appendIfNotNull(sb, "Getdown appdir: ",
-              System.getProperty("getdownappdir"), "\n", null);
+              System.getProperty("getdowninstanceappdir"), "\n", null);
       appendIfNotNull(sb, "Getdown appbase: ",
-              System.getProperty("getdownappbase"), "\n", null);
+              System.getProperty("getdowninstanceappbase"), "\n", null);
       appendIfNotNull(sb, "Java home: ", System.getProperty("java.home"),
               "\n", "unknown");
+      appendIfNotNull(sb, "Preferences file: ", propertiesFile, "\n",
+              "unknown");
     }
     return sb.toString();
   }
@@ -1306,7 +1296,7 @@ public class Cache
                             ? " [" + startupProxyProperties[6] + "]"
                             : "");
 
-    Cache.debug(sb.toString());
+    Console.debug(sb.toString());
   }
 
   public static void setProxyPropertiesFromPreferences()
@@ -1332,7 +1322,7 @@ public class Cache
     case Cache.PROXYTYPE_NONE:
       if (!previousProxyType.equals(proxyType))
       {
-        Cache.info("Setting no proxy settings");
+        Console.info("Setting no proxy settings");
         Cache.setProxyProperties(null, null, null, null, null, null, null,
                 null, null);
       }
@@ -1340,7 +1330,7 @@ public class Cache
     case Cache.PROXYTYPE_CUSTOM:
       // always re-set a custom proxy -- it might have changed, particularly
       // password
-      Cache.info("Setting custom proxy settings");
+      Console.info("Setting custom proxy settings");
       boolean proxyAuthSet = Cache.getDefault("PROXY_AUTH", false);
       Cache.setProxyProperties(Cache.getDefault("PROXY_SERVER", null),
               Cache.getDefault("PROXY_PORT", null),
@@ -1354,7 +1344,7 @@ public class Cache
               proxyAuthSet ? Cache.proxyAuthPassword : null, "localhost");
       break;
     default: // system proxy settings by default
-      Cache.info("Setting system proxy settings");
+      Console.info("Setting system proxy settings");
       Cache.resetProxyProperties();
     }
   }
@@ -1406,8 +1396,10 @@ public class Cache
         char[] displayHttpPw = new char[httpPassword == null ? 0
                 : httpPassword.length];
         Arrays.fill(displayHttpPw, '*');
-        Cache.debug("CACHE Proxy: setting new Authenticator with httpUser='"
-                + httpUser + "' httpPassword='" + displayHttpPw + "'");
+        Console.debug(
+                "CACHE Proxy: setting new Authenticator with httpUser='"
+                        + httpUser + "' httpPassword='" + displayHttpPw
+                        + "'");
         if (!Platform.isJS())
         /* *
          * java.net.Authenticator not implemented in SwingJS yet
@@ -1456,7 +1448,7 @@ public class Cache
                             && getRequestingPort() == Integer
                                     .valueOf(httpPort))
                     {
-                      Cache.debug(
+                      Console.debug(
                               "AUTHENTICATOR returning PasswordAuthentication(\""
                                       + httpUser + "\", '"
                                       + new String(displayHttpPw) + "')");
@@ -1471,7 +1463,7 @@ public class Cache
                     {
                       char[] displayHttpsPw = new char[httpPassword.length];
                       Arrays.fill(displayHttpsPw, '*');
-                      Cache.debug(
+                      Console.debug(
                               "AUTHENTICATOR returning PasswordAuthentication(\""
                                       + httpsUser + "\", '" + displayHttpsPw
                                       + "'");
@@ -1480,15 +1472,15 @@ public class Cache
                     }
                   } catch (NumberFormatException e)
                   {
-                    Cache.error("Problem with proxy port values [http:"
+                    Console.error("Problem with proxy port values [http:"
                             + httpPort + ", https:" + httpsPort + "]");
                   }
-                  Cache.debug(
+                  Console.debug(
                           "AUTHENTICATOR after trying to get PasswordAuthentication");
                 }
               }
               // non proxy request
-              Cache.debug("AUTHENTICATOR returning null");
+              Console.debug("AUTHENTICATOR returning null");
               return null;
             }
           });
@@ -1496,13 +1488,13 @@ public class Cache
 
         // required to re-enable basic authentication (should be okay for a
         // local proxy)
-        Cache.debug(
+        Console.debug(
                 "AUTHENTICATOR setting property 'jdk.http.auth.tunneling.disabledSchemes' to \"\"");
         System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");
       } catch (SecurityException e)
       {
-        Cache.error("Could not set default Authenticator");
-        Cache.debug(getStackTraceString(e));
+        Console.error("Could not set default Authenticator");
+        Console.debug(getStackTraceString(e));
       }
     }
     else
@@ -1520,14 +1512,16 @@ public class Cache
        * 
        */
       {
-        Cache.debug("AUTHENTICATOR setting default Authenticator to null");
+        Console.debug(
+                "AUTHENTICATOR setting default Authenticator to null");
         Authenticator.setDefault(null);
       }
     }
 
     // nonProxyHosts not currently configurable in Preferences
-    Cache.debug("AUTHENTICATOR setting property 'http.nonProxyHosts' to \""
-            + nonProxyHosts + "\"");
+    Console.debug(
+            "AUTHENTICATOR setting property 'http.nonProxyHosts' to \""
+                    + nonProxyHosts + "\"");
     setOrClearSystemProperty("http.nonProxyHosts", nonProxyHosts);
   }
 
@@ -1553,176 +1547,6 @@ public class Cache
     }
   }
 
-  public static void trace(String message)
-  {
-    if (initLogger())
-    {
-      log.trace(message, null);
-    }
-    else
-    {
-      System.out.println(message);
-    }
-  }
-
-  public static void trace(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.trace(message, t);
-    }
-    else
-    {
-      System.out.println(message);
-      t.printStackTrace();
-    }
-  }
-
-  public static void debug(String message)
-  {
-    if (initLogger())
-    {
-      log.debug(message, null);
-    }
-    else
-    {
-      System.out.println(message);
-    }
-
-  }
-
-  public static void debug(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.debug(message, t);
-    }
-    else
-    {
-      System.out.println(message);
-      t.printStackTrace();
-    }
-
-  }
-
-  public static void info(String message)
-  {
-    if (initLogger())
-    {
-      log.info(message, null);
-    }
-    else
-    {
-      System.out.println(message);
-    }
-
-  }
-
-  public static void info(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.info(message, t);
-    }
-    else
-    {
-      System.out.println(message);
-      t.printStackTrace();
-    }
-
-  }
-
-  public static void warn(String message)
-  {
-    if (initLogger())
-    {
-      log.warn(message, null);
-    }
-    else
-    {
-      System.out.println(message);
-    }
-
-  }
-
-  public static void warn(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.warn(message, t);
-    }
-    else
-    {
-      System.out.println(message);
-      t.printStackTrace();
-    }
-
-  }
-
-  public static void error(String message)
-  {
-    if (initLogger())
-    {
-      log.error(message, null);
-    }
-    else
-    {
-      System.err.println(message);
-    }
-
-  }
-
-  public static void error(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.error(message, t);
-    }
-    else
-    {
-      System.err.println(message);
-      t.printStackTrace(System.err);
-    }
-
-  }
-
-  public static void fatal(String message)
-  {
-    if (initLogger())
-    {
-      log.fatal(message, null);
-    }
-    else
-    {
-      System.err.println(message);
-    }
-
-  }
-
-  public static void fatal(String message, Throwable t)
-  {
-    if (initLogger())
-    {
-      log.fatal(message, t);
-    }
-    else
-    {
-      System.err.println(message);
-      t.printStackTrace(System.err);
-    }
-
-  }
-
-  public static boolean isDebugEnabled()
-  {
-    return log == null ? false : log.isDebugEnabled();
-  }
-
-  public static boolean isTraceEnabled()
-  {
-    return log == null ? false : log.isTraceEnabled();
-  }
-
   /**
    * Getdown appbase methods
    */
@@ -1795,4 +1619,61 @@ public class Cache
     String appbase = getGetdownAppbase();
     return appbase + "/" + getdownDistDir + "/build_properties";
   }
+
+  private static final Collection<String> bootstrapProperties = new ArrayList<>(
+          Arrays.asList(JALVIEWLOGLEVEL));
+
+  public static Properties bootstrapProperties(String filename)
+  {
+    Properties bootstrapProps = new Properties();
+    File file = null;
+    if (filename != null)
+    {
+      file = new File(filename);
+    }
+    if (file == null || !file.exists())
+    {
+      String channelPrefsFilename = ChannelProperties
+              .getProperty("preferences.filename");
+      String propertiesFilename = System.getProperty("user.home")
+              + File.separatorChar + channelPrefsFilename;
+      file = new File(propertiesFilename);
+    }
+    if (file == null || !file.exists())
+    {
+      String releasePrefsFilename = fallbackPropertiesFile;
+      String releasePropertiesFilename = System.getProperty("user.home")
+              + File.separatorChar + releasePrefsFilename;
+      file = new File(releasePropertiesFilename);
+    }
+
+    if (filename == null || !file.exists())
+    {
+      System.err.println("Could not load bootstrap preferences file '"
+              + filename + "'");
+      return null;
+    }
+
+    try
+    {
+      FileInputStream in = new FileInputStream(file.getAbsoluteFile());
+      Properties props = new Properties();
+      props.load(in);
+      for (String prop : bootstrapProperties)
+      {
+        if (props.containsKey(prop))
+          bootstrapProps.put(prop, props.getProperty(prop));
+      }
+    } catch (FileNotFoundException e)
+    {
+      System.err.println("Could not find bootstrap preferences file '"
+              + file.getAbsolutePath() + "'");
+    } catch (IOException e)
+    {
+      System.err.println(
+              "IOException when loading bootstrap preferences file '"
+                      + file.getAbsolutePath() + "'");
+    }
+    return bootstrapProps;
+  }
 }