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