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