apply version 2.7 copyright
[jalview.git] / src / jalview / bin / Cache.java
index a73481e..d2f400d 100755 (executable)
@@ -1,24 +1,26 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * 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 General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview 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 General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.bin;
 
+import java.awt.Color;
 import java.io.*;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
 import java.util.*;
 
 import org.apache.log4j.*;
@@ -40,9 +42,6 @@ import org.biojava.dasobert.dasregistry.Das1Source;
  * </li>
  * <li>logs.Jalview.Level - Cache.log stringified level. <br>
  * </li>
- * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
- * startup</li>
- * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.</li>
  * <li>SCREEN_WIDTH</li>
  * <li>SCREEN_HEIGHT</li>
  * <li>SCREEN_Y=285</li>
@@ -82,8 +81,8 @@ import org.biojava.dasobert.dasregistry.Das1Source;
  * service</li>
  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
  * service</li>
- * <li>USAGESTATS (true) Enable google analytics tracker for collecting usage
- * statistics</li>
+ * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
+ * collecting usage statistics</li>
  * <li>DAS_LOCAL_SOURCE list of local das sources</li>
  * <li>SHOW_OVERVIEW boolean for overview window display</li>
  * <li>ANTI_ALIAS boolean for smooth fonts</li>
@@ -98,11 +97,15 @@ import org.biojava.dasobert.dasregistry.Das1Source;
  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
  * $SEQUENCE_ID$</li>
+ * <li>GROUP_LINKS list of name|URL[|&lt;separator&gt;] tuples - see
+ * jalview.utils.GroupURLLink for more info</li>
  * <li>DAS_REGISTRY_URL the registry to query</li>
  * <li>DEFAULT_BROWSER for unix</li>
  * <li>DAS_ACTIVE_SOURCE list of active sources</li>
  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
  * (false)</li>
+ * <li>VERSION_CHECK (true) check for the latest release version from
+ * www.jalview.org (or the alias given by the www.jalview.org property)</li>
  * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
  * ID tooltip</li>
  * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
@@ -111,11 +114,35 @@ import org.biojava.dasobert.dasregistry.Das1Source;
  * displayed as '.'</li>
  * <li>SORT_BY_TREE (false) sort the current alignment view according to the
  * order of a newly displayed tree</li>
+ * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from
+ * sequence ID strings before attempting retrieval from any datasource</li>
+ * <li>SHOW_GROUP_CONSENSUS (false) Show consensus annotation for groups in the
+ * alignment.</li>
+ * <li>SHOW_GROUP_CONSERVATION (false) Show conservation annotation for groups
+ * in the alignment.</li>
+ * <li>SHOW_CONSENSUS_HISTOGRAM (false) Show consensus annotation row's
+ * histogram.</li>
+ * <li>SHOW_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
+ * logo.</li>
+ * <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_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
+ * warning dialog box is displayed.</li>
+ * <li>ANNOTATIONCOLOUR_MIN (orange) Shade used for minimum value of annotation when shading by annotation</li>
+ * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation when shading by annotation</li>
+ * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP requests to be redirected to a mirror of http://www.jalview.org</li>
  * 
  * <li></li>
  * 
  * </ul>
- * 
+ * Deprecated settings:
+ * <ul>
+ *  * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
+ * startup (JWS1 services only)</li>
+ * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints. (JWS1 services only)</li>
+ * <li>SHOW_JWS1_SERVICES (true) enable or disable the original Jalview 2 services in the desktop GUI
+ * </ul>
  * @author $author$
  * @version $Revision$
  */
@@ -153,10 +180,19 @@ public class Cache
   /** Default file is ~/.jalview_properties */
   static String propertiesFile;
 
+  private static boolean propsAreReadOnly=false;
+
   public static void initLogger()
   {
+    if (log != null)
+    {
+      return;
+    }
     try
     {
+      // TODO: redirect stdout and stderr here in order to grab the output of
+      // the log
+
       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
               "System.err");
       ap.setName("JalviewLogger");
@@ -198,11 +234,31 @@ public class Cache
     {
       propertiesFile = System.getProperty("user.home") + File.separatorChar
               + ".jalview_properties";
+    } else {
+      // don't corrupt the file we've been given.
+      propsAreReadOnly = true;
     }
 
     try
     {
-      FileInputStream fis = new FileInputStream(propertiesFile);
+      InputStream fis;
+      try
+      {
+        fis = new java.net.URL(propertiesFile).openStream();
+        System.out.println("Loading jalview properties from : "
+                + propertiesFile);
+        System.out
+                .println("Disabling Jalview writing to user's local properties file.");
+        propsAreReadOnly = true;
+
+      } catch (Exception ex)
+      {
+        fis = null;
+      }
+      if (fis == null)
+      {
+        fis = new FileInputStream(propertiesFile);
+      }
       applicationProperties.load(fis);
       applicationProperties.remove("LATEST_VERSION");
       applicationProperties.remove("VERSION");
@@ -217,9 +273,7 @@ public class Cache
       System.out.println("Using proxyServer: "
               + getDefault("PROXY_SERVER", null) + " proxyPort: "
               + getDefault("PROXY_PORT", null));
-      System
-              .setProperty("http.proxyHost", getDefault("PROXY_SERVER",
-                      null));
+      System.setProperty("http.proxyHost", getDefault("PROXY_SERVER", null));
       System.setProperty("http.proxyPort", getDefault("PROXY_PORT", null));
     }
 
@@ -229,8 +283,8 @@ public class Cache
     try
     {
       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
-              .getCodeSource().getLocation().toString().concat(
-                      "!/.build_properties"));
+              .getCodeSource().getLocation().toString()
+              .concat("!/.build_properties"));
 
       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 
@@ -258,6 +312,7 @@ public class Cache
     // jnlpVersion will be null if we're using InstallAnywhere
     // Dont do this check if running in headless mode
     if (jnlpVersion == null
+            && getDefault("VERSION_CHECK", true)
             && (System.getProperty("java.awt.headless") == null || System
                     .getProperty("java.awt.headless").equals("false")))
     {
@@ -280,7 +335,7 @@ public class Cache
             System.setProperty("sun.net.client.defaultConnectTimeout",
                     "5000");
             java.net.URL url = new java.net.URL(
-                    "http://www.jalview.org/webstart/jalview.jnlp");
+                    Cache.getDefault("www.jalview.org", "http://www.jalview.org")+"/webstart/jalview.jnlp");
             BufferedReader in = new BufferedReader(new InputStreamReader(
                     url.openStream()));
             String line = null;
@@ -391,12 +446,16 @@ public class Cache
    */
   public static String setProperty(String key, String obj)
   {
+
     try
     {
-      FileOutputStream out = new FileOutputStream(propertiesFile);
       applicationProperties.setProperty(key, obj);
-      applicationProperties.store(out, "---JalviewX Properties File---");
-      out.close();
+      if (!propsAreReadOnly)
+      {
+        FileOutputStream out = new FileOutputStream(propertiesFile);
+        applicationProperties.store(out, "---JalviewX Properties File---");
+        out.close();
+      }
     } catch (Exception ex)
     {
       System.out.println("Error setting property: " + key + " " + obj
@@ -405,16 +464,33 @@ public class Cache
     return obj;
   }
 
+  /**
+   * remove the specified property from the jalview properties file
+   * 
+   * @param string
+   */
+  public static void removeProperty(String string)
+  {
+    applicationProperties.remove(string);
+    saveProperties();
+  }
+
+  /**
+   * save the properties to the jalview properties path
+   */
   public static void saveProperties()
   {
-    try
+    if (!propsAreReadOnly)
     {
-      FileOutputStream out = new FileOutputStream(propertiesFile);
-      applicationProperties.store(out, "---JalviewX Properties File---");
-      out.close();
-    } catch (Exception ex)
-    {
-      System.out.println("Error saving properties: " + ex);
+      try
+      {
+        FileOutputStream out = new FileOutputStream(propertiesFile);
+        applicationProperties.store(out, "---JalviewX Properties File---");
+        out.close();
+      } catch (Exception ex)
+      {
+        System.out.println("Error saving properties: " + ex);
+      }
     }
   }
 
@@ -487,6 +563,10 @@ public class Cache
           // Tell the user that debug is enabled
           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
         }
+      } catch (Error e)
+      {
+        groovyJarsArePresent = 0;
+        jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
       } catch (Exception e)
       {
         groovyJarsArePresent = 0;
@@ -537,10 +617,13 @@ public class Cache
   }
 
   /**
-   * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not enabled.
+   * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
+   * enabled.
    */
   protected static Object tracker = null;
+
   protected static Class trackerfocus = null;
+
   protected static Class jgoogleanalyticstracker = null;
 
   /**
@@ -550,20 +633,23 @@ public class Cache
   {
     if (tracker == null)
     {
-      if (jgoogleanalyticstracker==null)
+      if (jgoogleanalyticstracker == null)
       {
         // try to get the tracker class
-        try {
-          jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
-          "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
+        try
+        {
+          jgoogleanalyticstracker = Cache.class
+                  .getClassLoader()
+                  .loadClass(
+                          "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
           trackerfocus = Cache.class.getClassLoader().loadClass(
-          "com.boxysystems.jgoogleanalytics.FocusPoint");
+                  "com.boxysystems.jgoogleanalytics.FocusPoint");
         } catch (Exception e)
         {
           log.debug("com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
           tracker = null;
-          jgoogleanalyticstracker=null;
-          trackerfocus=null;
+          jgoogleanalyticstracker = null;
+          trackerfocus = null;
           return;
         }
       }
@@ -574,14 +660,21 @@ public class Cache
       try
       {
         // Google analytics tracking code for Library Finder
-        tracker = jgoogleanalyticstracker.getConstructor(new Class[] { String.class,String.class,String.class}).newInstance(new Object[] { "Jalview Desktop",
-                (vrs = jalview.bin.Cache.getProperty("VERSION")
-                        + "_"
-                        + jalview.bin.Cache.getDefault("BUILD_DATE",
-                                "unknown")), "UA-9060947-1"});
-        jgoogleanalyticstracker.getMethod("trackAsynchronously", new Class[] { trackerfocus })
-        .invoke(tracker, new Object[] { trackerfocus.getConstructor(
-                new Class[] { String.class}).newInstance(new Object[] { "Application Started." })});
+        tracker = jgoogleanalyticstracker.getConstructor(new Class[]
+        { String.class, String.class, String.class }).newInstance(
+                new Object[]
+                {
+                    "Jalview Desktop",
+                    (vrs = jalview.bin.Cache.getProperty("VERSION")
+                            + "_"
+                            + jalview.bin.Cache.getDefault("BUILD_DATE",
+                                    "unknown")), "UA-9060947-1" });
+        jgoogleanalyticstracker.getMethod("trackAsynchronously",
+                new Class[]
+                { trackerfocus }).invoke(tracker, new Object[]
+        { trackerfocus.getConstructor(new Class[]
+        { String.class }).newInstance(new Object[]
+        { "Application Started." }) });
       } catch (RuntimeException e)
       {
         re = e;
@@ -597,10 +690,7 @@ public class Cache
         if (log != null)
         {
           if (re != null)
-            log
-                    .debug(
-                            "Caught runtime exception in googletracker init:",
-                            re);
+            log.debug("Caught runtime exception in googletracker init:", re);
           if (ex != null)
             log.warn(
                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
@@ -642,4 +732,73 @@ public class Cache
       }
     }
   }
+
+  /**
+   * get the user's default colour if available
+   * @param property
+   * @param defcolour
+   * @return
+   */
+  public static Color getDefaultColour(String property, Color defcolour)
+  {
+    String colprop = getProperty(property);
+    if (colprop==null) {
+      return defcolour;
+    }
+    Color col = jalview.schemes.ColourSchemeProperty.getAWTColorFromName(colprop);
+    if (col==null)
+    {
+      try {
+        col = new jalview.schemes.UserColourScheme(colprop).findColour('A');
+      } catch (Exception ex)
+      {
+        log.warn("Couldn't parse '"+colprop+"' as a colour for "+property);
+        col=null;
+      }
+    }
+    return (col==null) ? defcolour: col;
+  }
+
+  /**
+   * store a colour as a Jalview user default property
+   * @param property
+   * @param colour     
+   */
+  public static void setColourProperty(String property, Color colour)
+  {
+    setProperty(property, jalview.util.Format
+          .getHexString(colour));
+  }
+
+  public static final DateFormat  date_format = SimpleDateFormat.getDateTimeInstance();
+
+  /**
+   * store a date in a jalview property
+   * @param string
+   * @param time
+   */
+  public static void setDateProperty(String property, Date time)
+  {
+    setProperty(property, date_format.format(time));
+  }
+  /**
+   * read a date stored in a jalview property
+   * @param property
+   * @return valid date as stored by setDateProperty, or null
+   * 
+   */
+  public static Date getDateProperty(String property)
+  {
+    String val = getProperty(property);
+    if (val!=null)
+    {
+      try {
+        return date_format.parse(val);
+      } catch (Exception ex)
+      {
+        System.err.println("Invalid or corrupt date in property '"+property+"' : value was '"+val+"'");
+      }
+    }
+    return null;
+  }
 }