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    * property giving log4j level for CASTOR loggers
 214    */
 215   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 216
 217   /**
 218    * property giving log4j level for AXIS loggers
 219    */
 220   public static final String AXISLOGLEVEL = "logs.Axis.level";
 221
 222   /**
 223    * property giving log4j level for Jalview Log
 224    */
 225   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 226
 227   /**
 228    * Sifts settings
 229    */
 230   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 231           .getProperty("user.home") + File.separatorChar
 232           + ".sifts_downloads" + File.separatorChar;
 233
 234   private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
 235
 236   private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
 237
 238   /**
 239    * Identifiers.org download settings
 240    */
 241   private static final String ID_ORG_FILE = System.getProperty("user.home")
 242           + File.separatorChar + ".identifiers.org.ids.json";
 243
 244   /**
 245    * Allowed values are PDB or mmCIF
 246    */
 247   private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
 248           .toString();
 249
 250   private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
 251           .toString();
 252
 253   /*
 254    * a date formatter using a fixed (rather than the user's) locale;
 255    * this ensures that date properties can be written and re-read successfully
 256    * even if the user changes their locale setting
 257    */
 258   private static final DateFormat date_format = SimpleDateFormat
 259           .getDateTimeInstance(SimpleDateFormat.MEDIUM,
 260                   SimpleDateFormat.MEDIUM, Locale.UK);
 261
 262   /**
 263    * Initialises the Jalview Application Log
 264    */
 265   public static Logger log;
 266
 267   /** Jalview Properties */
 268   public static Properties applicationProperties = new Properties()
 269   {
 270     // override results in properties output in alphabetical order
 271     @Override
 272     public synchronized Enumeration<Object> keys()
 273     {
 274       return Collections.enumeration(new TreeSet<>(super.keySet()));
 275     }
 276   };
 277
 278   /** Default file is ~/.jalview_properties */
 279   static String propertiesFile;
 280
 281   private static boolean propsAreReadOnly = Platform.isJS();
 282
 283   private final static String JS_PROPERTY_PREFIX = "jalview_";
 284
 285   public static void initLogger()
 286   {
 287     if (log != null)
 288     {
 289       return;
 290     }
 291     try
 292     {
 293       // TODO: redirect stdout and stderr here in order to grab the output of
 294       // the log
 295
 296       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 297               "System.err");
 298       ap.setName("JalviewLogger");
 299       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 300       // log output
 301       Logger laxis = Logger.getLogger("org.apache.axis");
 302       Logger lcastor = Logger.getLogger("org.exolab.castor");
 303       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 304
 305       laxis.setLevel(Level.toLevel(
 306               Cache.getDefault("logs.Axis.Level", Level.INFO.toString())));
 307       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 308               Level.INFO.toString())));
 309       lcastor = Logger.getLogger("org.exolab.castor.xml");
 310       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 311               Level.INFO.toString())));
 312       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 313       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 314       // Level.INFO.toString())));
 315       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
 316               .getDefault("logs.Jalview.level", Level.INFO.toString())));
 317       // laxis.addAppender(ap);
 318       // lcastor.addAppender(ap);
 319       // jalview.bin.Cache.log.addAppender(ap);
 320       // Tell the user that debug is enabled
 321       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 322     } catch (Exception ex)
 323     {
 324       System.err.println("Problems initializing the log4j system\n");
 325       ex.printStackTrace(System.err);
 326     }
 327   }
 328
 329   /**
 330    * Loads properties from the given properties file. Any existing properties
 331    * are first cleared.
 332    */
 333   public static void loadProperties(String propsFile)
 334   {
 335     propertiesFile = propsFile;
 336     if (propsFile == null && !propsAreReadOnly)
 337     {
 338       propertiesFile = System.getProperty("user.home") + File.separatorChar
 339               + ".jalview_properties";
 340     }
 341     else
 342     {
 343       // don't corrupt the file we've been given.
 344       propsAreReadOnly = true;
 345     }
 346
 347     if (propertiesFile == null)
 348     { // BH 2019
 349       Platform.readInfoProperties(JS_PROPERTY_PREFIX,
 350               applicationProperties);
 351     }
 352     else
 353     {
 354       try
 355       {
 356         InputStream fis;
 357         try
 358         {
 359           fis = new java.net.URL(propertiesFile).openStream();
 360           System.out.println(
 361                   "Loading jalview properties from : " + propertiesFile);
 362           System.out.println(
 363                   "Disabling Jalview writing to user's local properties file.");
 364           propsAreReadOnly = true;
 365
 366         } catch (Exception ex)
 367         {
 368           fis = null;
 369         }
 370         if (fis == null)
 371         {
 372           fis = new FileInputStream(propertiesFile);
 373         }
 374         applicationProperties.clear();
 375         applicationProperties.load(fis);
 376
 377         // remove any old build properties
 378
 379         deleteBuildProperties();
 380         fis.close();
 381       } catch (Exception ex)
 382       {
 383         System.out.println("Error reading properties file: " + ex);
 384       }
 385     }
 386     if (getDefault("USE_PROXY", false))
 387     {
 388       String proxyServer = getDefault("PROXY_SERVER", ""),
 389               proxyPort = getDefault("PROXY_PORT", "8080");
 390
 391       System.out.println("Using proxyServer: " + proxyServer
 392               + " proxyPort: " + proxyPort);
 393
 394       System.setProperty("http.proxyHost", proxyServer);
 395       System.setProperty("http.proxyPort", proxyPort);
 396     }
 397
 398     // LOAD THE AUTHORS FROM THE authors.props file
 399     String authorDetails = resolveResourceURLFor("authors.props");
 400
 401     try
 402     {
 403       if (authorDetails != null)
 404       {
 405         java.net.URL localJarFileURL = new java.net.URL(authorDetails);
 406         InputStream in = localJarFileURL.openStream();
 407         applicationProperties.load(in);
 408         in.close();
 409       }
 410     } catch (Exception ex)
 411     {
 412       System.out.println("Error reading author details: " + ex);
 413       authorDetails = null;
 414     }
 415     if (authorDetails == null)
 416     {
 417         applicationProperties.remove("AUTHORS");
 418         applicationProperties.remove("AUTHORFNAMES");
 419         applicationProperties.remove("YEAR");
 420     }
 421
 422     loadBuildProperties(false);
 423
 424     SiftsSettings
 425             .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
 426
 427     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
 428             .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 429
 430     SiftsSettings.setFailSafePIDThreshold(
 431             jalview.bin.Cache.getDefault("sifts_fail_safe_pid_threshold",
 432                     DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 433
 434     SiftsSettings.setCacheThresholdInDays(
 435             jalview.bin.Cache.getDefault("sifts_cache_threshold_in_days",
 436                     DEFAULT_CACHE_THRESHOLD_IN_DAYS));
 437
 438     IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
 439             "http://www.jalview.org/services/identifiers"));
 440     IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
 441
 442     StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
 443             .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
 444     StructureImportSettings
 445             .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
 446     // StructureImportSettings
 447     // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
 448     // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
 449
 450     String jnlpVersion = System.getProperty("jalview.version");
 451
 452     // jnlpVersion will be null if a latest version check for the channel needs to
 453     // be done
 454     // Dont do this check if running in headless mode
 455
 456     if (jnlpVersion == null && getDefault("VERSION_CHECK", true)
 457             && (System.getProperty("java.awt.headless") == null || System
 458                     .getProperty("java.awt.headless").equals("false")))
 459     {
 460       new Thread()
 461       {
 462         @Override
 463         public void run()
 464         {
 465           String orgtimeout = System
 466                   .getProperty("sun.net.client.defaultConnectTimeout");
 467           if (orgtimeout == null)
 468           {
 469             orgtimeout = "30";
 470             System.out.println("# INFO: Setting default net timeout to "
 471                     + orgtimeout + " seconds.");
 472           }
 473           String remoteVersion = null;
 474           try
 475           {
 476             System.setProperty("sun.net.client.defaultConnectTimeout",
 477                     "5000");
 478             java.net.URL url = new java.net.URL(Cache
 479                     .getDefault("www.jalview.org", "http://www.jalview.org")
 480                     + "/webstart/jalview.jnlp");
 481             BufferedReader in = new BufferedReader(
 482                     new InputStreamReader(url.openStream()));
 483             String line = null;
 484             while ((line = in.readLine()) != null)
 485             {
 486               if (line.indexOf("jalview.version") == -1)
 487               {
 488                 continue;
 489               }
 490
 491               line = line.substring(line.indexOf("value=") + 7);
 492               line = line.substring(0, line.lastIndexOf("\""));
 493               remoteVersion = line;
 494               break;
 495             }
 496           } catch (Exception ex)
 497           {
 498             System.out.println(
 499                     "Non-fatal exception when checking version at www.jalview.org :");
 500             System.out.println(ex);
 501             remoteVersion = getProperty("VERSION");
 502           }
 503           System.setProperty("sun.net.client.defaultConnectTimeout",
 504                   orgtimeout);
 505
 506           setProperty("LATEST_VERSION", remoteVersion);
 507         }
 508       }.start();
 509     }
 510     else
 511     {
 512       if (jnlpVersion != null)
 513       {
 514         setProperty("LATEST_VERSION", jnlpVersion);
 515       }
 516       else
 517       {
 518         applicationProperties.remove("LATEST_VERSION");
 519       }
 520     }
 521
 522     // LOAD USERDEFINED COLOURS
 523     Cache.initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 524     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 525             false);
 526   }
 527
 528   /**
 529    * construct a resource URL for the given absolute resource pathname
 530    *
 531    * @param resourcePath
 532    * @return
 533    */
 534   private static String resolveResourceURLFor(String resourcePath)
 535   {
 536     String url = null;
 537     if (Platform.isJS() || !Cache.class.getProtectionDomain()
 538             .getCodeSource().getLocation().toString().endsWith(".jar"))
 539     {
 540       try
 541       {
 542         url = Cache.class.getResource(resourcePath).toString();
 543       } catch (Exception ex)
 544       {
 545
 546       }
 547     }
 548     else
 549     {
 550       url = "jar:".concat(Cache.class.getProtectionDomain().getCodeSource()
 551               .getLocation().toString().concat("!" + resourcePath));
 552     }
 553     return url;
 554   }
 555
 556   public static void loadBuildProperties(boolean reportVersion)
 557   {
 558     String codeInstallation = getProperty("INSTALLATION");
 559     boolean printV = codeInstallation == null;
 560
 561     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 562     try
 563     {
 564       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 565               .getCodeSource().getLocation().toString()
 566               .concat("!/.build_properties"));
 567
 568       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 569
 570       InputStream in = localJarFileURL.openStream();
 571       applicationProperties.load(in);
 572       in.close();
 573     } catch (Exception ex)
 574     {
 575       System.out.println("Error reading build details: " + ex);
 576       applicationProperties.remove("VERSION");
 577     }
 578     String codeVersion = getProperty("VERSION");
 579     codeInstallation = getProperty("INSTALLATION");
 580
 581     if (codeVersion == null)
 582     {
 583       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 584       codeVersion = "Test";
 585       codeInstallation = "";
 586     }
 587     else
 588     {
 589       codeInstallation = " (" + codeInstallation + ")";
 590     }
 591     setProperty("VERSION", codeVersion);
 592     new BuildDetails(codeVersion, null, codeInstallation);
 593     if (printV && reportVersion)
 594     {
 595       System.out
 596             .println("Jalview Version: " + codeVersion + codeInstallation);
 597     }
 598   }
 599
 600   private static void deleteBuildProperties()
 601   {
 602     applicationProperties.remove("LATEST_VERSION");
 603     applicationProperties.remove("VERSION");
 604     applicationProperties.remove("AUTHORS");
 605     applicationProperties.remove("AUTHORFNAMES");
 606     applicationProperties.remove("YEAR");
 607     applicationProperties.remove("BUILD_DATE");
 608     applicationProperties.remove("INSTALLATION");
 609   }
 610
 611   /**
 612    * Gets Jalview application property of given key. Returns null if key not
 613    * found
 614    *
 615    * @param key
 616    *          Name of property
 617    *
 618    * @return Property value
 619    */
 620   public static String getProperty(String key)
 621   {
 622     String prop = applicationProperties.getProperty(key);
 623     if (prop == null && Platform.isJS())
 624     {
 625       prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
 626               + "_" + JS_PROPERTY_PREFIX + key);
 627     }
 628     return prop;
 629   }
 630
 631   /**
 632    * These methods are used when checking if the saved preference is different
 633    * to the default setting
 634    */
 635
 636   public static boolean getDefault(String property, boolean def)
 637   {
 638     String string = getProperty(property);
 639     if (string != null)
 640     {
 641       def = Boolean.valueOf(string).booleanValue();
 642     }
 643
 644     return def;
 645   }
 646
 647   public static int getDefault(String property, int def)
 648   {
 649     String string = getProperty(property);
 650     if (string != null)
 651     {
 652       try
 653       {
 654         def = Integer.parseInt(string);
 655       } catch (NumberFormatException e)
 656       {
 657         System.out.println("Error parsing int property '" + property
 658                 + "' with value '" + string + "'");
 659       }
 660     }
 661
 662     return def;
 663   }
 664
 665   /**
 666    * Answers the value of the given property, or the supplied default value if
 667    * the property is not set
 668    */
 669   public static String getDefault(String property, String def)
 670   {
 671     String value = getProperty(property);
 672     return value == null ? def : value;
 673   }
 674
 675   /**
 676    * Stores property in the file "HOME_DIR/.jalview_properties"
 677    *
 678    * @param key
 679    *          Name of object
 680    * @param obj
 681    *          String value of property
 682    *
 683    * @return previous value of property (or null)
 684    */
 685   public static Object setProperty(String key, String obj)
 686   {
 687     Object oldValue = null;
 688     try
 689     {
 690       oldValue = applicationProperties.setProperty(key, obj);
 691       if (propertiesFile != null && !propsAreReadOnly)
 692       {
 693         FileOutputStream out = new FileOutputStream(propertiesFile);
 694         applicationProperties.store(out, "---JalviewX Properties File---");
 695         out.close();
 696       }
 697     } catch (Exception ex)
 698     {
 699       System.out.println(
 700               "Error setting property: " + key + " " + obj + "\n" + ex);
 701     }
 702     return oldValue;
 703   }
 704
 705   /**
 706    * remove the specified property from the jalview properties file
 707    *
 708    * @param string
 709    */
 710   public static void removeProperty(String string)
 711   {
 712     applicationProperties.remove(string);
 713     saveProperties();
 714   }
 715
 716   /**
 717    * save the properties to the jalview properties path
 718    */
 719   public static void saveProperties()
 720   {
 721     if (!propsAreReadOnly)
 722     {
 723       try
 724       {
 725         FileOutputStream out = new FileOutputStream(propertiesFile);
 726         applicationProperties.store(out, "---JalviewX Properties File---");
 727         out.close();
 728       } catch (Exception ex)
 729       {
 730         System.out.println("Error saving properties: " + ex);
 731       }
 732     }
 733   }
 734
 735   /**
 736    * internal vamsas class discovery state
 737    */
 738   private static int vamsasJarsArePresent = -1;
 739
 740   /**
 741    * Searches for vamsas client classes on class path.
 742    *
 743    * @return true if vamsas client is present on classpath
 744    */
 745   public static boolean vamsasJarsPresent()
 746   {
 747     if (vamsasJarsArePresent == -1)
 748     {
 749       try
 750       {
 751         if (jalview.jbgui.GDesktop.class.getClassLoader()
 752                 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
 753         {
 754           jalview.bin.Cache.log.debug(
 755                   "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 756           vamsasJarsArePresent = 1;
 757           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 758           lvclient.setLevel(Level.toLevel(Cache
 759                   .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
 760
 761           lvclient.addAppender(log.getAppender("JalviewLogger"));
 762           // Tell the user that debug is enabled
 763           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 764         }
 765       } catch (Exception e)
 766       {
 767         vamsasJarsArePresent = 0;
 768         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 769       }
 770     }
 771     return (vamsasJarsArePresent > 0);
 772   }
 773
 774   /**
 775    * internal vamsas class discovery state
 776    */
 777   private static int groovyJarsArePresent = -1;
 778
 779   /**
 780    * Searches for vamsas client classes on class path.
 781    *
 782    * @return true if vamsas client is present on classpath
 783    */
 784   public static boolean groovyJarsPresent()
 785   {
 786     if (groovyJarsArePresent == -1)
 787     {
 788       try
 789       {
 790         if (Cache.class.getClassLoader()
 791                 .loadClass("groovy.lang.GroovyObject") != null)
 792         {
 793           jalview.bin.Cache.log.debug(
 794                   "Found Groovy (groovy.lang.GroovyObject can be loaded)");
 795           groovyJarsArePresent = 1;
 796           Logger lgclient = Logger.getLogger("groovy");
 797           lgclient.setLevel(Level.toLevel(Cache
 798                   .getDefault("logs.Groovy.Level", Level.INFO.toString())));
 799
 800           lgclient.addAppender(log.getAppender("JalviewLogger"));
 801           // Tell the user that debug is enabled
 802           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 803         }
 804       } catch (Error e)
 805       {
 806         groovyJarsArePresent = 0;
 807         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 808       } catch (Exception e)
 809       {
 810         groovyJarsArePresent = 0;
 811         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 812       }
 813     }
 814     return (groovyJarsArePresent > 0);
 815   }
 816
 817   /**
 818    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 819    * enabled.
 820    */
 821   protected static Object tracker = null;
 822
 823   protected static Class trackerfocus = null;
 824
 825   protected static Class jgoogleanalyticstracker = null;
 826
 827   /**
 828    * Initialise the google tracker if it is not done already.
 829    */
 830   public static void initGoogleTracker()
 831   {
 832     if (tracker == null)
 833     {
 834       if (jgoogleanalyticstracker == null)
 835       {
 836         // try to get the tracker class
 837         try
 838         {
 839           jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
 840                   "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 841           trackerfocus = Cache.class.getClassLoader()
 842                   .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
 843         } catch (Exception e)
 844         {
 845           log.debug(
 846                   "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 847           tracker = null;
 848           jgoogleanalyticstracker = null;
 849           trackerfocus = null;
 850           return;
 851         }
 852       }
 853       // now initialise tracker
 854       Exception re = null, ex = null;
 855       Error err = null;
 856       String vrs = "No Version Accessible";
 857       try
 858       {
 859         // Google analytics tracking code for Library Finder
 860         tracker = jgoogleanalyticstracker
 861                 .getConstructor(new Class[]
 862                 { String.class, String.class, String.class })
 863                 .newInstance(new Object[]
 864                 { "Jalview Desktop",
 865                     (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
 866                             + jalview.bin.Cache.getDefault("BUILD_DATE",
 867                                     "unknown")),
 868                     "UA-9060947-1" });
 869         jgoogleanalyticstracker
 870                 .getMethod("trackAsynchronously", new Class[]
 871                 { trackerfocus })
 872                 .invoke(tracker, new Object[]
 873                 { trackerfocus.getConstructor(new Class[] { String.class })
 874                         .newInstance(new Object[]
 875                         { "Application Started." }) });
 876       } catch (RuntimeException e)
 877       {
 878         re = e;
 879       } catch (Exception e)
 880       {
 881         ex = e;
 882       } catch (Error e)
 883       {
 884         err = e;
 885       }
 886       if (re != null || ex != null || err != null)
 887       {
 888         if (log != null)
 889         {
 890           if (re != null)
 891           {
 892             log.debug("Caught runtime exception in googletracker init:",
 893                     re);
 894           }
 895           if (ex != null)
 896           {
 897             log.warn(
 898                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 899                             + vrs,
 900                     ex);
 901           }
 902           if (err != null)
 903           {
 904             log.error(
 905                     "Whilst initing GoogleTracker for Jalview Desktop version "
 906                             + vrs,
 907                     err);
 908           }
 909         }
 910         else
 911         {
 912           if (re != null)
 913           {
 914             System.err.println(
 915                     "Debug: Caught runtime exception in googletracker init:"
 916                             + vrs);
 917             re.printStackTrace();
 918           }
 919           if (ex != null)
 920           {
 921             System.err.println(
 922                     "Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 923                             + vrs);
 924             ex.printStackTrace();
 925           }
 926
 927           if (err != null)
 928           {
 929             System.err.println(
 930                     "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 931                             + vrs);
 932             err.printStackTrace();
 933           }
 934         }
 935       }
 936       else
 937       {
 938         log.debug("Successfully initialised tracker.");
 939       }
 940     }
 941   }
 942
 943   /**
 944    * get the user's default colour if available
 945    *
 946    * @param property
 947    * @param defcolour
 948    * @return
 949    */
 950   public static Color getDefaultColour(String property, Color defcolour)
 951   {
 952     String colprop = getProperty(property);
 953     if (colprop == null)
 954     {
 955       return defcolour;
 956     }
 957     Color col = ColorUtils.parseColourString(colprop);
 958     if (col == null)
 959     {
 960       log.warn("Couldn't parse '" + colprop + "' as a colour for "
 961               + property);
 962     }
 963     return (col == null) ? defcolour : col;
 964   }
 965
 966   /**
 967    * store a colour as a Jalview user default property
 968    *
 969    * @param property
 970    * @param colour
 971    */
 972   public static void setColourProperty(String property, Color colour)
 973   {
 974     setProperty(property, jalview.util.Format.getHexString(colour));
 975   }
 976
 977   /**
 978    * Stores a formatted date in a jalview property, using a fixed locale.
 979    *
 980    * @param propertyName
 981    * @param date
 982    * @return the formatted date string
 983    */
 984   public static String setDateProperty(String propertyName, Date date)
 985   {
 986     String formatted = date_format.format(date);
 987     setProperty(propertyName, formatted);
 988     return formatted;
 989   }
 990
 991   /**
 992    * Reads a date stored in a Jalview property, parses it (using a fixed locale
 993    * format) and returns as a Date, or null if parsing fails
 994    *
 995    * @param propertyName
 996    * @return
 997    *
 998    */
 999   public static Date getDateProperty(String propertyName)
1000   {
1001     String val = getProperty(propertyName);
1002     if (val != null)
1003     {
1004       try
1005       {
1006         return date_format.parse(val);
1007       } catch (Exception ex)
1008       {
1009         System.err.println("Invalid or corrupt date in property '"
1010                 + propertyName + "' : value was '" + val + "'");
1011       }
1012     }
1013     return null;
1014   }
1015
1016   /**
1017    * get and parse a property as an integer. send any parsing problems to
1018    * System.err
1019    *
1020    * @param property
1021    * @return null or Integer
1022    */
1023   public static Integer getIntegerProperty(String property)
1024   {
1025     String val = getProperty(property);
1026     if (val != null && (val = val.trim()).length() > 0)
1027     {
1028       try
1029       {
1030         return Integer.valueOf(val);
1031       } catch (NumberFormatException x)
1032       {
1033         System.err.println("Invalid integer in property '" + property
1034                 + "' (value was '" + val + "')");
1035       }
1036     }
1037     return null;
1038   }
1039
1040   /**
1041    * Set the specified value, or remove it if null or empty. Does not save the
1042    * properties file.
1043    *
1044    * @param propName
1045    * @param value
1046    */
1047   public static void setOrRemove(String propName, String value)
1048   {
1049     if (propName == null)
1050     {
1051       return;
1052     }
1053     if (value == null || value.trim().length() < 1)
1054     {
1055       Cache.applicationProperties.remove(propName);
1056     }
1057     else
1058     {
1059       Cache.applicationProperties.setProperty(propName, value);
1060     }
1061   }
1062
1063   /**
1064    * Loads in user colour schemes from files.
1065    *
1066    * @param files
1067    *          a '|'-delimited list of file paths
1068    */
1069   public static void initUserColourSchemes(String files)
1070   {
1071     if (files == null || files.length() == 0)
1072     {
1073       return;
1074     }
1075
1076     // In case colours can't be loaded, we'll remove them
1077     // from the default list here.
1078     StringBuffer coloursFound = new StringBuffer();
1079     StringTokenizer st = new StringTokenizer(files, "|");
1080     while (st.hasMoreElements())
1081     {
1082       String file = st.nextToken();
1083       try
1084       {
1085         UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1086         if (ucs != null)
1087         {
1088           if (coloursFound.length() > 0)
1089           {
1090             coloursFound.append("|");
1091           }
1092           coloursFound.append(file);
1093           ColourSchemes.getInstance().registerColourScheme(ucs);
1094         }
1095       } catch (Exception ex)
1096       {
1097         System.out.println("Error loading User ColourFile\n" + ex);
1098       }
1099     }
1100     if (!files.equals(coloursFound.toString()))
1101     {
1102       if (coloursFound.toString().length() > 1)
1103       {
1104         setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1105                 coloursFound.toString());
1106       }
1107       else
1108       {
1109         applicationProperties
1110                 .remove(UserDefinedColours.USER_DEFINED_COLOURS);
1111       }
1112     }
1113   }
1114
1115   /**
1116    *
1117    * @return Jalview version, build details and JVM platform version for console
1118    */
1119   public static String getVersionDetailsForConsole()
1120   {
1121     return "Jalview Version: "
1122             + jalview.bin.Cache.getDefault("VERSION", "TEST")
1123             + "\n" + "Jalview Installation: "
1124             + jalview.bin.Cache.getDefault("INSTALLATION",
1125                     "unknown")
1126             + "\n" + "Build Date: "
1127             + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown")
1128             + "\n" + "Java version: "
1129             + System.getProperty("java.version") + "\n"
1130             + System.getProperty("os.arch") + " "
1131             + System.getProperty("os.name") + " "
1132             + System.getProperty("os.version")
1133             + (jalview.bin.Cache.getDefault("VERSION", "TEST")
1134                     .equals("DEVELOPMENT")
1135                                                                 ? "\nGetdown appdir: " + System.getProperty("getdownappdir") + "\nJava path: "
1136                                     + System.getProperty(
1137                                             "java.home")
1138                                     + File.separator + "bin"
1139                                     + File.separator + "java"
1140                                                                 : "");
1141   }
1142
1143   /**
1144    *
1145    * @return build details as reported in splashscreen
1146    */
1147   public static String getBuildDetailsForSplash()
1148   {
1149     // consider returning more human friendly info
1150     // eg 'built from Source' or update channel
1151     return jalview.bin.Cache.getDefault("INSTALLATION", "unknown");
1152   }
1153 }