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