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