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