src/jalview/bin/Cache.java

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