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