src/jalview/bin/Cache.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import jalview.datamodel.PDBEntry;
  24 import jalview.gui.UserDefinedColours;
  25 import jalview.schemes.ColourSchemeLoader;
  26 import jalview.schemes.ColourSchemes;
  27 import jalview.schemes.UserColourScheme;
  28 import jalview.structure.StructureImportSettings;
  29 import jalview.urls.IdOrgSettings;
  30 import jalview.util.ColorUtils;
  31 import jalview.util.Platform;
  32 import jalview.ws.sifts.SiftsSettings;
  33
  34 import java.awt.Color;
  35 import java.io.BufferedReader;
  36 import java.io.File;
  37 import java.io.FileInputStream;
  38 import java.io.FileOutputStream;
  39 import java.io.InputStream;
  40 import java.io.InputStreamReader;
  41 import java.text.DateFormat;
  42 import java.text.SimpleDateFormat;
  43 import java.util.Collections;
  44 import java.util.Date;
  45 import java.util.Enumeration;
  46 import java.util.Locale;
  47 import java.util.Properties;
  48 import java.util.StringTokenizer;
  49 import java.util.TreeSet;
  50
  51 import org.apache.log4j.ConsoleAppender;
  52 import org.apache.log4j.Level;
  53 import org.apache.log4j.Logger;
  54 import org.apache.log4j.SimpleLayout;
  55
  56 /**
  57  * Stores and retrieves Jalview Application Properties Lists and fields within
  58  * list entries are separated by '|' symbols unless otherwise stated (|) clauses
  59  * are alternative values for a tag. <br>
  60  * <br>
  61  * Current properties include:
  62  * <ul>
  63  * <br>
  64  * logs.Axis.Level - one of the stringified Levels for log4j controlling the
  65  * logging level for axis (used for web services) <br>
  66  * </li>
  67  * <li>logs.Castor.Level - one of the stringified Levels for log4j controlling
  68  * the logging level for castor (used for serialization) <br>
  69  * </li>
  70  * <li>logs.Jalview.Level - Cache.log stringified level. <br>
  71  * </li>
  72  * <li>SCREEN_WIDTH</li>
  73  * <li>SCREEN_HEIGHT</li>
  74  * <li>SCREEN_Y=285</li>
  75  * <li>SCREEN_X=371</li>
  76  * <li>SHOW_FULLSCREEN boolean</li>
  77  * <li>FONT_NAME java font name for alignment text display</li>
  78  * <li>FONT_SIZE size of displayed alignment text</li>
  79  * <li>FONT_STYLE style of font displayed (sequence labels are always
  80  * italic)</li>
  81  * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
  82  * <li>LAST_DIRECTORY last directory for browsing alignment</li>
  83  * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
  84  * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
  85  * <li>SHOW_IDENTITY show percentage identity annotation</li>
  86  * <li>SHOW_QUALITY show alignment quality annotation</li>
  87  * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
  88  * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
  89  * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
  90  * LABEL_AND_SEQUENCE</li>
  91  * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
  92  * sequence annotations</li>
  93  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  94  * annotation row</li>
  95  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
  96  * <li>DEFAULT_FILE_FORMAT file format used to save</li>
  97  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
  98  * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
  99  * <li>VERSION the version of the jalview build</li>
 100  * <li>BUILD_DATE date of this build</li>
 101  * <li>LATEST_VERSION the latest jalview version advertised on the
 102  * www.jalview.org</li>
 103  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
 104  * descriptions</li>
 105  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
 106  * suffix to file</li>
 107  * <li>RECENT_URL list of recently retrieved URLs</li>
 108  * <li>RECENT_FILE list of recently opened files</li>
 109  * <li>USE_PROXY flag for whether a http proxy is to be used</li>
 110  * <li>PROXY_SERVER the proxy</li>
 111  * <li>PROXY_PORT</li>
 112  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
 113  * service</li>
 114  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
 115  * service</li>
 116  * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
 117  * collecting usage statistics</li>
 118  * <li>SHOW_OVERVIEW boolean for overview window display</li>
 119  * <li>ANTI_ALIAS boolean for smooth fonts</li>
 120  * <li>RIGHT_ALIGN_IDS boolean</li>
 121  * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
 122  * <li>PAD_GAPS boolean</li>
 123  * <li>ID_ITALICS boolean</li>
 124  * <li>SHOW_JV_SUFFIX</li>
 125  * <li>WRAP_ALIGNMENT</li>
 126  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
 127  * style check</li>
 128  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
 129  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
 130  * $SEQUENCE_ID$</li>
 131  * <li>STORED_LINKS list of name|url pairs which user has entered but are not
 132  * currently used
 133  * <li>DEFAULT_LINK name of single url to be used when user double clicks a
 134  * sequence id (must be in SEQUENCE_LINKS or STORED_LINKS)
 135  * <li>GROUP_LINKS list of name|URL[|&lt;separator&gt;] tuples - see
 136  * jalview.utils.GroupURLLink for more info</li>
 137  * <li>DEFAULT_BROWSER for unix</li>
 138  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
 139  * (false)</li>
 140  * <li>VERSION_CHECK (true) check for the latest release version from
 141  * www.jalview.org (or the alias given by the www.jalview.org property)</li>
 142  * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
 143  * ID tooltip</li>
 144  * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
 145  * ID tooltip</li>
 146  * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
 147  * displayed as '.'</li>
 148  * <li>SORT_BY_TREE (false) sort the current alignment view according to the
 149  * order of a newly displayed tree</li>
 150  * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from
 151  * sequence ID strings before attempting retrieval from any datasource</li>
 152  * <li>SHOW_GROUP_CONSENSUS (false) Show consensus annotation for groups in the
 153  * alignment.</li>
 154  * <li>SHOW_GROUP_CONSERVATION (false) Show conservation annotation for groups
 155  * in the alignment.</li>
 156  * <li>SHOW_CONSENSUS_HISTOGRAM (false) Show consensus annotation row's
 157  * histogram.</li>
 158  * <li>SHOW_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
 159  * logo.</li>
 160  * <li>NORMALISE_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
 161  * logo normalised to row height rather than histogram height.</li>
 162  * <li>FOLLOW_SELECTIONS (true) Controls whether a new alignment view should
 163  * respond to selections made in other alignments containing the same sequences.
 164  * </li>
 165  * <li>JWS2HOSTURLS comma-separated list of URLs to try for JABAWS services</li>
 166  * <li>SHOW_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
 167  * warning dialog box is displayed.</li>
 168  * <li>ANNOTATIONCOLOUR_MIN (orange) Shade used for minimum value of annotation
 169  * when shading by annotation</li>
 170  * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation
 171  * when shading by annotation</li>
 172  * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP
 173  * requests to be redirected to a mirror of http://www.jalview.org</li>
 174  * <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported
 175  * alignment figure to accommodate even the longest sequence ID or annotation
 176  * label.</li>
 177  * <li>FIGURE_FIXEDIDWIDTH Specifies the width to use for the left-hand column
 178  * when exporting an alignment as a figure (setting FIGURE_AUTOIDWIDTH to true
 179  * will override this).</li>
 180  * <li>STRUCT_FROM_PDB (false) derive secondary structure annotation from PDB
 181  * record</li>
 182  * <li>USE_RNAVIEW (false) use RNAViewer to derive secondary structure</li>
 183  * <li>ADD_SS_ANN (false) add secondary structure annotation to alignment
 184  * display</li>
 185  * <li>ADD_TEMPFACT_ANN (false) add Temperature Factor annotation to alignment
 186  * display</li>
 187  * <li>STRUCTURE_DISPLAY choose from JMOL (default) or CHIMERA for 3D structure
 188  * display</li>
 189  * <li>CHIMERA_PATH specify full path to Chimera program (if non-standard)</li>
 190  * <li>ID_ORG_HOSTURL location of jalview service providing identifiers.org urls
 191  * </li>
 192  *
 193  * </ul>
 194  * Deprecated settings:
 195  * <ul>
 196  * *
 197  * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
 198  * startup (JWS1 services only)</li>
 199  * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
 200  * (JWS1 services only)</li>
 201  * <li>SHOW_JWS1_SERVICES (true) enable or disable the original Jalview 2
 202  * services in the desktop GUI</li>
 203  * <li>ENABLE_RSBS_EDITOR (false for 2.7 release) enable or disable RSBS editing
 204  * panel in web service preferences</li>
 205  * </ul>
 206  *
 207  * @author $author$
 208  * @version $Revision$
 209  */
 210 public class Cache
 211 {
 212
 213   static Cache instance;
 214
 215   /**
 216    * In Java, this will be a static field instance, which will be
 217    * application-specific; in JavaScript it will be an applet-specific instance
 218    * tied to the applet's ThreadGroup.
 219    *
 220    * @return
 221    */
 222   public static Cache getInstance()
 223   {
 224     Jalview j = Jalview.getInstance();
 225     return (j.cache == null ? j.cache = new Cache() : j.cache);
 226   }
 227
 228   /**
 229    * property giving log4j level for CASTOR loggers
 230    */
 231   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 232
 233   /**
 234    * property giving log4j level for AXIS loggers
 235    */
 236   public static final String AXISLOGLEVEL = "logs.Axis.level";
 237
 238   /**
 239    * property giving log4j level for Jalview Log
 240    */
 241   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 242
 243   /**
 244    * Sifts settings
 245    */
 246   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 247           .getProperty("user.home") + File.separatorChar
 248           + ".sifts_downloads" + File.separatorChar;
 249
 250   private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
 251
 252   private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
 253
 254   /**
 255    * Identifiers.org download settings
 256    */
 257   private static final String ID_ORG_FILE = System.getProperty("user.home")
 258           + File.separatorChar + ".identifiers.org.ids.json";
 259
 260   /**
 261    * Allowed values are PDB or mmCIF
 262    */
 263   private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
 264           .toString();
 265
 266   private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
 267           .toString();
 268
 269   /*
 270    * a date formatter using a fixed (rather than the user's) locale;
 271    * this ensures that date properties can be written and re-read successfully
 272    * even if the user changes their locale setting
 273    */
 274   private static final DateFormat date_format = SimpleDateFormat
 275           .getDateTimeInstance(SimpleDateFormat.MEDIUM,
 276                   SimpleDateFormat.MEDIUM, Locale.UK);
 277
 278   /**
 279    * Initialises the Jalview Application Log
 280    */
 281   public static Logger log;
 282
 283   private Cache()
 284   {
 285     // inaccessible
 286   }
 287
 288   /** Jalview Properties */
 289   // BH 2019.05.08 was static
 290   @SuppressWarnings("serial")
 291   private Properties applicationProperties = new Properties()
 292   {
 293     // override results in properties output in alphabetical order
 294     @Override
 295     public synchronized Enumeration<Object> keys()
 296     {
 297       return Collections.enumeration(new TreeSet<>(super.keySet()));
 298     }
 299   };
 300
 301   /** Default file is ~/.jalview_properties */
 302   // BH 2019.05.07 note: Instances of Jalview will share this file.
 303   static String propertiesFile;
 304
 305   /**
 306    * flag to possibly allow properties to be written to a property file
 307    */
 308   private boolean propsAreReadOnly = Platform.isJS();
 309
 310   private final static String JS_PROPERTY_PREFIX = "jalview_";
 311
 312   public static void initLogger()
 313   {
 314     if (log != null)
 315     {
 316       return;
 317     }
 318     try
 319     {
 320       // TODO: redirect stdout and stderr here in order to grab the output of
 321       // the log
 322
 323       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 324               "System.err");
 325       ap.setName("JalviewLogger");
 326       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 327       // log output
 328       Logger laxis = Logger.getLogger("org.apache.axis");
 329       Logger lcastor = Logger.getLogger("org.exolab.castor");
 330       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 331
 332       laxis.setLevel(Level.toLevel(
 333               getDefault("logs.Axis.Level", Level.INFO.toString())));
 334       lcastor.setLevel(Level.toLevel(
 335               getDefault("logs.Castor.Level", Level.INFO.toString())));
 336       lcastor = Logger.getLogger("org.exolab.castor.xml");
 337       lcastor.setLevel(Level.toLevel(
 338               getDefault("logs.Castor.Level", Level.INFO.toString())));
 339       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 340       // lcastor.setLevel(Level.toLevel(getDefault("logs.Castor.Level",
 341       // Level.INFO.toString())));
 342       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
 343               .getDefault("logs.Jalview.level", Level.INFO.toString())));
 344       // laxis.addAppender(ap);
 345       // lcastor.addAppender(ap);
 346       // jalview.bin.Cache.log.addAppender(ap);
 347       // Tell the user that debug is enabled
 348       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 349     } catch (Exception ex)
 350     {
 351       System.err.println("Problems initializing the log4j system\n");
 352       ex.printStackTrace(System.err);
 353     }
 354   }
 355
 356   /**
 357    * Loads properties from the given properties file. Any existing properties
 358    * are first cleared.
 359    */
 360   public static void loadProperties(String propsFile)
 361   {
 362     getInstance().loadPropertiesImpl(propsFile);
 363   }
 364
 365   private void loadPropertiesImpl(String propsFile)
 366   {
 367     propertiesFile = propsFile;
 368     if (!propsAreReadOnly)
 369     {
 370       // Java only
 371       if (propsFile == null)
 372       {
 373         propertiesFile = System.getProperty("user.home")
 374                 + File.separatorChar + ".jalview_properties";
 375       }
 376       else
 377       {
 378         // don't corrupt the file we've been given.
 379         propsAreReadOnly = true;
 380       }
 381     }
 382
 383     if (propertiesFile == null)
 384     { // BH 2019 read properties from the Info object associated with this
 385       // applet
 386       Platform.readInfoProperties(JS_PROPERTY_PREFIX,
 387               applicationProperties);
 388     }
 389     else
 390     {
 391       try
 392       {
 393         InputStream fis;
 394         try
 395         {
 396           fis = new java.net.URL(propertiesFile).openStream();
 397           System.out.println(
 398                   "Loading jalview properties from : " + propertiesFile);
 399           System.out.println(
 400                   "Disabling Jalview writing to user's local properties file.");
 401           propsAreReadOnly = true;
 402
 403         } catch (Exception ex)
 404         {
 405           fis = null;
 406         }
 407         if (fis == null)
 408         {
 409           fis = new FileInputStream(propertiesFile);
 410         }
 411         applicationProperties.clear();
 412         applicationProperties.load(fis);
 413
 414         // remove any old build properties
 415
 416         deleteBuildProperties();
 417         fis.close();
 418       } catch (Exception ex)
 419       {
 420         System.out.println("Error reading properties file: " + ex);
 421       }
 422     }
 423     if (getDefault("USE_PROXY", false))
 424     {
 425       String proxyServer = getDefault("PROXY_SERVER", ""),
 426               proxyPort = getDefault("PROXY_PORT", "8080");
 427
 428       System.out.println("Using proxyServer: " + proxyServer
 429               + " proxyPort: " + proxyPort);
 430
 431       System.setProperty("http.proxyHost", proxyServer);
 432       System.setProperty("http.proxyPort", proxyPort);
 433     }
 434
 435     // LOAD THE AUTHORS FROM THE authors.props file
 436     String authorDetails = (Platform.isJS() ? null
 437             : "jar:".concat(Cache.class.getProtectionDomain()
 438                     .getCodeSource().getLocation().toString()
 439                     .concat("!/authors.props")));
 440
 441     try
 442     {
 443       if (authorDetails != null)
 444       {
 445         java.net.URL localJarFileURL = new java.net.URL(authorDetails);
 446         InputStream in = localJarFileURL.openStream();
 447         applicationProperties.load(in);
 448         in.close();
 449       }
 450     } catch (Exception ex)
 451     {
 452       System.out.println("Error reading author details: " + ex);
 453       authorDetails = null;
 454     }
 455     if (authorDetails == null)
 456     {
 457       applicationProperties.remove("AUTHORS");
 458       applicationProperties.remove("AUTHORFNAMES");
 459       applicationProperties.remove("YEAR");
 460     }
 461
 462     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 463     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 464     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 465     String buildDetails = (Platform.isJS() ? null
 466             : "jar:".concat(Cache.class.getProtectionDomain()
 467                     .getCodeSource().getLocation().toString()
 468                     .concat("!/.build_properties")));
 469     if (buildDetails != null)
 470     {
 471       try
 472       {
 473         java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 474         InputStream in = localJarFileURL.openStream();
 475         applicationProperties.load(in);
 476         in.close();
 477       } catch (Exception ex)
 478       {
 479         System.out.println("Error reading build details: " + ex);
 480         buildDetails = null;
 481       }
 482     }
 483     if (buildDetails == null)
 484     {
 485       applicationProperties.remove("VERSION");
 486     }
 487     String jnlpVersion = System.getProperty("jalview.version");
 488     String codeVersion = getProperty("VERSION");
 489     String codeInstallation = getProperty("INSTALLATION");
 490     if (codeVersion == null)
 491     {
 492       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 493       codeVersion = "Test";
 494       jnlpVersion = "Test";
 495       codeInstallation = "";
 496     }
 497     else
 498     {
 499       codeInstallation = " (" + codeInstallation + ")";
 500     }
 501     new BuildDetails(codeVersion, null, codeInstallation);
 502
 503     SiftsSettings.setMapWithSifts(getDefault("MAP_WITH_SIFTS", false));
 504
 505     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
 506             .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 507
 508     SiftsSettings.setFailSafePIDThreshold(
 509             getDefault("sifts_fail_safe_pid_threshold",
 510                     DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 511
 512     SiftsSettings.setCacheThresholdInDays(
 513             getDefault("sifts_cache_threshold_in_days",
 514                     DEFAULT_CACHE_THRESHOLD_IN_DAYS));
 515
 516     IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
 517             "http://www.jalview.org/services/identifiers"));
 518     IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
 519
 520     System.out
 521             .println("Jalview Version: " + codeVersion + codeInstallation);
 522
 523     StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
 524             .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
 525     StructureImportSettings
 526             .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
 527     // StructureImportSettings
 528     // .setDefaultPDBFileParser(jalview.bin.getDefault(
 529     // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
 530     // jnlpVersion will be null if we're using InstallAnywhere
 531     // Dont do this check if running in headless mode
 532     if (jnlpVersion == null && !Jalview.isHeadlessMode()
 533             && getDefault("VERSION_CHECK", true))
 534     {
 535
 536       class VersionChecker extends Thread
 537       {
 538         @Override
 539         public void run()
 540         {
 541           String orgtimeout = System
 542                   .getProperty("sun.net.client.defaultConnectTimeout");
 543           if (orgtimeout == null)
 544           {
 545             orgtimeout = "30";
 546             System.out.println("# INFO: Setting default net timeout to "
 547                     + orgtimeout + " seconds.");
 548           }
 549           String remoteVersion = null;
 550           try
 551           {
 552             System.setProperty("sun.net.client.defaultConnectTimeout",
 553                     "5000");
 554             java.net.URL url = new java.net.URL(Cache
 555                     .getDefault("www.jalview.org", "http://www.jalview.org")
 556                     + "/webstart/jalview.jnlp");
 557             BufferedReader in = new BufferedReader(
 558                     new InputStreamReader(url.openStream()));
 559             String line = null;
 560             while ((line = in.readLine()) != null)
 561             {
 562               if (line.indexOf("jalview.version") == -1)
 563               {
 564                 continue;
 565               }
 566
 567               line = line.substring(line.indexOf("value=") + 7);
 568               line = line.substring(0, line.lastIndexOf("\""));
 569               remoteVersion = line;
 570               break;
 571             }
 572           } catch (Exception ex)
 573           {
 574             System.out.println(
 575                     "Non-fatal exception when checking version at www.jalview.org :");
 576             System.out.println(ex);
 577             remoteVersion = getProperty("VERSION");
 578           }
 579           System.setProperty("sun.net.client.defaultConnectTimeout",
 580                   orgtimeout);
 581
 582           setProperty("LATEST_VERSION", remoteVersion);
 583         }
 584       }
 585
 586       VersionChecker vc = new VersionChecker();
 587       vc.start();
 588     }
 589     else
 590     {
 591       if (jnlpVersion != null)
 592       {
 593         setProperty("LATEST_VERSION", jnlpVersion);
 594       }
 595       else
 596       {
 597         applicationProperties.remove("LATEST_VERSION");
 598       }
 599     }
 600
 601     setProperty("VERSION", codeVersion);
 602
 603     // LOAD USERDEFINED COLOURS
 604     initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 605   }
 606
 607   private void deleteBuildProperties()
 608   {
 609     applicationProperties.remove("LATEST_VERSION");
 610     applicationProperties.remove("VERSION");
 611     applicationProperties.remove("AUTHORS");
 612     applicationProperties.remove("AUTHORFNAMES");
 613     applicationProperties.remove("YEAR");
 614     applicationProperties.remove("BUILD_DATE");
 615     applicationProperties.remove("INSTALLATION");
 616   }
 617
 618   /**
 619    * Gets Jalview application property of given key. Returns null if key not
 620    * found
 621    *
 622    * @param key
 623    *          Name of property
 624    *
 625    * @return Property value
 626    */
 627   public static String getProperty(String key)
 628   {
 629     return getInstance().getPropertyImpl(key);
 630   }
 631
 632   private String getPropertyImpl(String key)
 633   {
 634     String prop = applicationProperties.getProperty(key);
 635     if (prop == null && Platform.isJS())
 636     {
 637       prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
 638               + "_" + JS_PROPERTY_PREFIX + key);
 639     }
 640     return prop;
 641   }
 642
 643   /**
 644    * These methods are used when checking if the saved preference is different
 645    * to the default setting
 646    */
 647
 648   public static boolean getDefault(String property, boolean def)
 649   {
 650     String string = getProperty(property);
 651     if (string != null)
 652     {
 653       def = Boolean.valueOf(string).booleanValue();
 654     }
 655
 656     return def;
 657   }
 658
 659   public static int getDefault(String property, int def)
 660   {
 661     String string = getProperty(property);
 662     if (string != null)
 663     {
 664       try
 665       {
 666         def = Integer.parseInt(string);
 667       } catch (NumberFormatException e)
 668       {
 669         System.out.println("Error parsing int property '" + property
 670                 + "' with value '" + string + "'");
 671       }
 672     }
 673
 674     return def;
 675   }
 676
 677   /**
 678    * Answers the value of the given property, or the supplied default value if
 679    * the property is not set
 680    */
 681   public static String getDefault(String property, String def)
 682   {
 683     String value = getProperty(property);
 684     return value == null ? def : value;
 685   }
 686
 687   /**
 688    * Stores property in the file "HOME_DIR/.jalview_properties"
 689    *
 690    * @param key
 691    *          Name of object
 692    * @param obj
 693    *          String value of property
 694    *
 695    * @return previous value of property (or null)
 696    */
 697   public static Object setProperty(String key, String obj)
 698   {
 699     return getInstance().setPropertyImpl(key, obj, true);
 700   }
 701
 702   public static void setPropertyNoSave(String key, String obj)
 703   {
 704     getInstance().setPropertyImpl(key, obj, false);
 705   }
 706
 707   private Object setPropertyImpl(String key, String obj, boolean andSave)
 708   {
 709     Object oldValue = null;
 710     try
 711     {
 712       oldValue = applicationProperties.setProperty(key, obj);
 713       if (andSave && !propsAreReadOnly)
 714       {
 715         FileOutputStream out = new FileOutputStream(propertiesFile);
 716         applicationProperties.store(out, "---JalviewX Properties File---");
 717         out.close();
 718       }
 719     } catch (Exception ex)
 720     {
 721       System.out.println(
 722               "Error setting property: " + key + " " + obj + "\n" + ex);
 723     }
 724     return oldValue;
 725   }
 726
 727   /**
 728    * remove the specified property from the jalview properties file
 729    *
 730    * @param key
 731    */
 732   public static void removeProperty(String key)
 733   {
 734     getInstance().removePropertyImpl(key, true);
 735   }
 736
 737   public static void removePropertyNoSave(String key)
 738   {
 739     getInstance().removePropertyImpl(key, false);
 740   }
 741
 742   private void removePropertyImpl(String key, boolean andSave)
 743   {
 744     applicationProperties.remove(key);
 745     if (andSave)
 746     {
 747       savePropertiesImpl();
 748     }
 749   }
 750
 751   public static void saveProperties()
 752   {
 753     getInstance().savePropertiesImpl();
 754   }
 755
 756   /**
 757    * save the properties to the jalview properties path
 758    */
 759   private void savePropertiesImpl()
 760   {
 761     if (!propsAreReadOnly)
 762     {
 763       try
 764       {
 765         FileOutputStream out = new FileOutputStream(propertiesFile);
 766         applicationProperties.store(out, "---JalviewX Properties File---");
 767         out.close();
 768       } catch (Exception ex)
 769       {
 770         System.out.println("Error saving properties: " + ex);
 771       }
 772     }
 773   }
 774
 775   private final static int UNTESTED = -1;
 776
 777   private final static int TRUE = 1;
 778
 779   private final static int FALSE = 0;
 780
 781   /**
 782    * internal vamsas class discovery state
 783    */
 784   private static int vamsasJarsArePresent = (Platform.isJS() ? FALSE
 785           : UNTESTED);
 786
 787   /**
 788    * Searches for vamsas client classes on class path.
 789    *
 790    * @return true if vamsas client is present on classpath
 791    */
 792   public static boolean vamsasJarsPresent()
 793   {
 794     if (vamsasJarsArePresent == UNTESTED)
 795     {
 796       try
 797       {
 798         if (jalview.jbgui.GDesktop.class.getClassLoader()
 799                 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
 800         {
 801           jalview.bin.Cache.log.debug(
 802                   "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 803           vamsasJarsArePresent = TRUE;
 804           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 805           lvclient.setLevel(Level.toLevel(Cache
 806                   .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
 807
 808           lvclient.addAppender(log.getAppender("JalviewLogger"));
 809           // Tell the user that debug is enabled
 810           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 811         }
 812       } catch (Exception e)
 813       {
 814         vamsasJarsArePresent = FALSE;
 815         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 816       }
 817     }
 818     return (vamsasJarsArePresent == TRUE);
 819   }
 820
 821   /**
 822    * internal vamsas class discovery state
 823    */
 824   private static int groovyJarsArePresent = (Platform.isJS() ? FALSE
 825           : UNTESTED);
 826
 827   /**
 828    * Searches for vamsas client classes on class path.
 829    *
 830    * @return true if vamsas client is present on classpath
 831    */
 832   public static boolean groovyJarsPresent()
 833   {
 834     if (groovyJarsArePresent == UNTESTED)
 835     {
 836       try
 837       {
 838         if (Cache.class.getClassLoader()
 839                 .loadClass("groovy.lang.GroovyObject") != null)
 840         {
 841           jalview.bin.Cache.log.debug(
 842                   "Found Groovy (groovy.lang.GroovyObject can be loaded)");
 843           groovyJarsArePresent = TRUE;
 844           Logger lgclient = Logger.getLogger("groovy");
 845           lgclient.setLevel(Level.toLevel(Cache
 846                   .getDefault("logs.Groovy.Level", Level.INFO.toString())));
 847
 848           lgclient.addAppender(log.getAppender("JalviewLogger"));
 849           // Tell the user that debug is enabled
 850           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 851         }
 852       } catch (Error e)
 853       {
 854         groovyJarsArePresent = FALSE;
 855         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 856       } catch (Exception e)
 857       {
 858         groovyJarsArePresent = FALSE;
 859         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 860       }
 861     }
 862     return (groovyJarsArePresent == TRUE);
 863   }
 864
 865   /**
 866    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 867    * enabled.
 868    */
 869   protected static Object tracker = null;
 870
 871   protected static Class<?> trackerfocus = null;
 872
 873   protected static Class<?> jgoogleanalyticstracker = null;
 874
 875   /**
 876    * Initialise the google tracker if it is not done already.
 877    */
 878   public static void initGoogleTracker()
 879   {
 880
 881     // TODO: SwingJS JavaScript tracker?
 882
 883     if (tracker == null)
 884     {
 885       if (jgoogleanalyticstracker == null)
 886       {
 887         // try to get the tracker class
 888         try
 889         {
 890           jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
 891                   "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 892           trackerfocus = Cache.class.getClassLoader()
 893                   .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
 894         } catch (Exception e)
 895         {
 896           log.debug(
 897                   "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 898           tracker = null;
 899           jgoogleanalyticstracker = null;
 900           trackerfocus = null;
 901           return;
 902         }
 903       }
 904       // now initialise tracker
 905       Exception re = null, ex = null;
 906       Error err = null;
 907       String vrs = "No Version Accessible";
 908       try
 909       {
 910         // Google analytics tracking code for Library Finder
 911         tracker = jgoogleanalyticstracker
 912                 .getConstructor(new Class[]
 913                 { String.class, String.class, String.class })
 914                 .newInstance(new Object[]
 915                 { "Jalview Desktop",
 916                     (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
 917                             + getDefault("BUILD_DATE", "unknown")),
 918                     "UA-9060947-1" });
 919         jgoogleanalyticstracker
 920                 .getMethod("trackAsynchronously", new Class[]
 921                 { trackerfocus })
 922                 .invoke(tracker, new Object[]
 923                 { trackerfocus.getConstructor(new Class[] { String.class })
 924                         .newInstance(new Object[]
 925                         { "Application Started." }) });
 926       } catch (RuntimeException e)
 927       {
 928         re = e;
 929       } catch (Exception e)
 930       {
 931         ex = e;
 932       } catch (Error e)
 933       {
 934         err = e;
 935       }
 936       if (re != null || ex != null || err != null)
 937       {
 938         if (log != null)
 939         {
 940           if (re != null)
 941           {
 942             log.debug("Caught runtime exception in googletracker init:",
 943                     re);
 944           }
 945           if (ex != null)
 946           {
 947             log.warn(
 948                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 949                             + vrs,
 950                     ex);
 951           }
 952           if (err != null)
 953           {
 954             log.error(
 955                     "Whilst initing GoogleTracker for Jalview Desktop version "
 956                             + vrs,
 957                     err);
 958           }
 959         }
 960         else
 961         {
 962           if (re != null)
 963           {
 964             System.err.println(
 965                     "Debug: Caught runtime exception in googletracker init:"
 966                             + vrs);
 967             re.printStackTrace();
 968           }
 969           if (ex != null)
 970           {
 971             System.err.println(
 972                     "Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 973                             + vrs);
 974             ex.printStackTrace();
 975           }
 976
 977           if (err != null)
 978           {
 979             System.err.println(
 980                     "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 981                             + vrs);
 982             err.printStackTrace();
 983           }
 984         }
 985       }
 986       else
 987       {
 988         log.debug("Successfully initialised tracker.");
 989       }
 990     }
 991   }
 992
 993   /**
 994    * get the user's default colour if available
 995    *
 996    * @param property
 997    * @param defcolour
 998    * @return
 999    */
1000   public static Color getDefaultColour(String property, Color defcolour)
1001   {
1002     String colprop = getProperty(property);
1003     if (colprop == null)
1004     {
1005       return defcolour;
1006     }
1007     Color col = ColorUtils.parseColourString(colprop);
1008     if (col == null)
1009     {
1010       log.warn("Couldn't parse '" + colprop + "' as a colour for "
1011               + property);
1012     }
1013     return (col == null) ? defcolour : col;
1014   }
1015
1016   /**
1017    * store a colour as a Jalview user default property
1018    *
1019    * @param property
1020    * @param colour
1021    */
1022   public static void setColourProperty(String property, Color colour)
1023   {
1024     setProperty(property, jalview.util.Format.getHexString(colour));
1025   }
1026
1027   /**
1028    * Stores a formatted date in a jalview property, using a fixed locale.
1029    *
1030    * @param propertyName
1031    * @param date
1032    * @return the formatted date string
1033    */
1034   public static String setDateProperty(String propertyName, Date date)
1035   {
1036     String formatted = date_format.format(date);
1037     setProperty(propertyName, formatted);
1038     return formatted;
1039   }
1040
1041   /**
1042    * Reads a date stored in a Jalview property, parses it (using a fixed locale
1043    * format) and returns as a Date, or null if parsing fails
1044    *
1045    * @param propertyName
1046    * @return
1047    *
1048    */
1049   public static Date getDateProperty(String propertyName)
1050   {
1051     String val = getProperty(propertyName);
1052     if (val != null)
1053     {
1054       try
1055       {
1056         return date_format.parse(val);
1057       } catch (Exception ex)
1058       {
1059         System.err.println("Invalid or corrupt date in property '"
1060                 + propertyName + "' : value was '" + val + "'");
1061       }
1062     }
1063     return null;
1064   }
1065
1066   /**
1067    * get and parse a property as an integer. send any parsing problems to
1068    * System.err
1069    *
1070    * @param property
1071    * @return null or Integer
1072    */
1073   public static Integer getIntegerProperty(String property)
1074   {
1075     String val = getProperty(property);
1076     if (val != null && (val = val.trim()).length() > 0)
1077     {
1078       try
1079       {
1080         return Integer.valueOf(val);
1081       } catch (NumberFormatException x)
1082       {
1083         System.err.println("Invalid integer in property '" + property
1084                 + "' (value was '" + val + "')");
1085       }
1086     }
1087     return null;
1088   }
1089
1090   /**
1091    * Set the specified value, or remove it if null or empty. Does not save the
1092    * properties file.
1093    *
1094    * @param propName
1095    * @param value
1096    */
1097   public static void setOrRemove(String propName, String value)
1098   {
1099     if (propName == null)
1100     {
1101       return;
1102     }
1103     if (value == null || value.trim().length() < 1)
1104     {
1105       getInstance().applicationProperties.remove(propName);
1106     }
1107     else
1108     {
1109       getInstance().applicationProperties.setProperty(propName, value);
1110     }
1111   }
1112
1113   /**
1114    * Loads in user colour schemes from files.
1115    *
1116    * @param files
1117    *          a '|'-delimited list of file paths
1118    */
1119   public static void initUserColourSchemes(String files)
1120   {
1121     if (files == null || files.length() == 0)
1122     {
1123       return;
1124     }
1125
1126     // In case colours can't be loaded, we'll remove them
1127     // from the default list here.
1128     StringBuffer coloursFound = new StringBuffer();
1129     StringTokenizer st = new StringTokenizer(files, "|");
1130     while (st.hasMoreElements())
1131     {
1132       String file = st.nextToken();
1133       try
1134       {
1135         UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1136         if (ucs != null)
1137         {
1138           if (coloursFound.length() > 0)
1139           {
1140             coloursFound.append("|");
1141           }
1142           coloursFound.append(file);
1143           ColourSchemes.getInstance().registerColourScheme(ucs);
1144         }
1145       } catch (Exception ex)
1146       {
1147         System.out.println("Error loading User ColourFile\n" + ex);
1148       }
1149     }
1150     if (!files.equals(coloursFound.toString()))
1151     {
1152       if (coloursFound.toString().length() > 1)
1153       {
1154         setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1155                 coloursFound.toString());
1156       }
1157       else
1158       {
1159         getInstance().applicationProperties
1160                 .remove(UserDefinedColours.USER_DEFINED_COLOURS);
1161       }
1162     }
1163   }
1164
1165 }