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