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>DAS_LOCAL_SOURCE list of local das sources</li>
 119  * <li>SHOW_OVERVIEW boolean for overview window display</li>
 120  * <li>ANTI_ALIAS boolean for smooth fonts</li>
 121  * <li>RIGHT_ALIGN_IDS boolean</li>
 122  * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
 123  * <li>PAD_GAPS boolean</li>
 124  * <li>ID_ITALICS boolean</li>
 125  * <li>SHOW_JV_SUFFIX</li>
 126  * <li>WRAP_ALIGNMENT</li>
 127  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
 128  * style check</li>
 129  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
 130  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
 131  * $SEQUENCE_ID$</li>
 132  * <li>STORED_LINKS list of name|url pairs which user has entered but are not
 133  * currently used
 134  * <li>DEFAULT_LINK name of single url to be used when user double clicks a
 135  * sequence id (must be in SEQUENCE_LINKS or STORED_LINKS)
 136  * <li>GROUP_LINKS list of name|URL[|&lt;separator&gt;] tuples - see
 137  * jalview.utils.GroupURLLink for more info</li>
 138  * <li>DAS_REGISTRY_URL the registry to query</li>
 139  * <li>DEFAULT_BROWSER for unix</li>
 140  * <li>DAS_ACTIVE_SOURCE list of active sources</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   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 231
 232   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 233
 234   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 235
 236   /**
 237    * Sifts settings
 238    */
 239   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 240           .getProperty("user.home") + File.separatorChar
 241           + ".sifts_downloads" + File.separatorChar;
 242
 243   private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
 244
 245   private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
 246
 247   /**
 248    * Identifiers.org download settings
 249    */
 250   private static final String ID_ORG_FILE = System.getProperty("user.home")
 251           + File.separatorChar + ".identifiers.org.ids.json";
 252
 253   /**
 254    * Allowed values are PDB or mmCIF
 255    */
 256   private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
 257           .toString();
 258
 259   private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
 260           .toString();
 261
 262   /*
 263    * a date formatter using a fixed (rather than the user's) locale;
 264    * this ensures that date properties can be written and re-read successfully
 265    * even if the user changes their locale setting
 266    */
 267   private static final DateFormat date_format = SimpleDateFormat
 268           .getDateTimeInstance(SimpleDateFormat.MEDIUM,
 269                   SimpleDateFormat.MEDIUM, Locale.UK);
 270
 271   /**
 272    * Initialises the Jalview Application Log
 273    */
 274   public static Logger log;
 275
 276   /** Jalview Properties */
 277   public static Properties applicationProperties = new Properties()
 278   {
 279     // override results in properties output in alphabetical order
 280     @Override
 281     public synchronized Enumeration<Object> keys()
 282     {
 283       return Collections.enumeration(new TreeSet<>(super.keySet()));
 284     }
 285   };
 286
 287   /** Default file is ~/.jalview_properties */
 288   static String propertiesFile;
 289
 290   private static boolean propsAreReadOnly = Platform.isJS();
 291
 292   public static void initLogger()
 293   {
 294     if (log != null)
 295     {
 296       return;
 297     }
 298     try
 299     {
 300       // TODO: redirect stdout and stderr here in order to grab the output of
 301       // the log
 302
 303       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 304               "System.err");
 305       ap.setName("JalviewLogger");
 306       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 307       // log output
 308       Logger laxis = Logger.getLogger("org.apache.axis");
 309       Logger lcastor = Logger.getLogger("org.exolab.castor");
 310       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 311
 312       laxis.setLevel(Level.toLevel(
 313               Cache.getDefault("logs.Axis.Level", Level.INFO.toString())));
 314       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 315               Level.INFO.toString())));
 316       lcastor = Logger.getLogger("org.exolab.castor.xml");
 317       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 318               Level.INFO.toString())));
 319       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 320       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 321       // Level.INFO.toString())));
 322       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
 323               .getDefault("logs.Jalview.level", Level.INFO.toString())));
 324       // laxis.addAppender(ap);
 325       // lcastor.addAppender(ap);
 326       // jalview.bin.Cache.log.addAppender(ap);
 327       // Tell the user that debug is enabled
 328       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 329     } catch (Exception ex)
 330     {
 331       System.err.println("Problems initializing the log4j system\n");
 332       ex.printStackTrace(System.err);
 333     }
 334   }
 335
 336   /**
 337    * Loads properties from the given properties file. Any existing properties
 338    * are first cleared.
 339    */
 340   public static void loadProperties(String propsFile)
 341   {
 342     propertiesFile = propsFile;
 343     if (propsFile == null && !propsAreReadOnly)
 344     {
 345       propertiesFile = System.getProperty("user.home") + File.separatorChar
 346               + ".jalview_properties";
 347     }
 348     else
 349     {
 350       // don't corrupt the file we've been given.
 351       propsAreReadOnly = true;
 352     }
 353
 354     if (propertiesFile != null) {
 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:"
 402             .concat(Cache.class.getProtectionDomain().getCodeSource()
 403                     .getLocation().toString().concat("!/authors.props")));
 404
 405     try
 406     {
 407       if (authorDetails != null) {
 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     System.out.println("Error reading author details: " + ex);
 415         authorDetails = null;
 416     }
 417     if (authorDetails == null)
 418     {
 419         applicationProperties.remove("AUTHORS");
 420         applicationProperties.remove("AUTHORFNAMES");
 421         applicationProperties.remove("YEAR");
 422     }
 423
 424     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 425     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 426     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 427     String buildDetails = (Platform.isJS() ? null :
 428             "jar:".concat(Cache.class.getProtectionDomain()
 429             .getCodeSource().getLocation().toString()
 430             .concat("!/.build_properties")));
 431     if (buildDetails != null)
 432     {
 433             try
 434             {
 435               java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 436               InputStream in = localJarFileURL.openStream();
 437               applicationProperties.load(in);
 438               in.close();
 439             } catch (Exception ex)
 440             {
 441               System.out.println("Error reading build details: " + ex);
 442               buildDetails = null;
 443             }
 444     }
 445     if (buildDetails == null)
 446     {
 447               applicationProperties.remove("VERSION");
 448     }
 449     String jnlpVersion = System.getProperty("jalview.version");
 450     String codeVersion = getProperty("VERSION");
 451     String codeInstallation = getProperty("INSTALLATION");
 452     if (codeVersion == null)
 453     {
 454       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 455       codeVersion = "Test";
 456       jnlpVersion = "Test";
 457       codeInstallation = "";
 458     }
 459     else
 460     {
 461       codeInstallation = " (" + codeInstallation + ")";
 462     }
 463     new BuildDetails(codeVersion, null, codeInstallation);
 464
 465     SiftsSettings
 466             .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
 467
 468     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
 469             .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 470
 471     SiftsSettings.setFailSafePIDThreshold(
 472             jalview.bin.Cache.getDefault("sifts_fail_safe_pid_threshold",
 473                     DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 474
 475     SiftsSettings.setCacheThresholdInDays(
 476             jalview.bin.Cache.getDefault("sifts_cache_threshold_in_days",
 477                     DEFAULT_CACHE_THRESHOLD_IN_DAYS));
 478
 479     IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
 480             "http://www.jalview.org/services/identifiers"));
 481     IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
 482
 483     System.out
 484             .println("Jalview Version: " + codeVersion + codeInstallation);
 485
 486     StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
 487             .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
 488     StructureImportSettings
 489             .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
 490     // StructureImportSettings
 491     // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
 492     // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
 493     // jnlpVersion will be null if we're using InstallAnywhere
 494     // Dont do this check if running in headless mode
 495     if (jnlpVersion == null && getDefault("VERSION_CHECK", true)
 496             && (System.getProperty("java.awt.headless") == null || System
 497                     .getProperty("java.awt.headless").equals("false")))
 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   private static void deleteBuildProperties()
 575   {
 576     applicationProperties.remove("LATEST_VERSION");
 577     applicationProperties.remove("VERSION");
 578     applicationProperties.remove("AUTHORS");
 579     applicationProperties.remove("AUTHORFNAMES");
 580     applicationProperties.remove("YEAR");
 581     applicationProperties.remove("BUILD_DATE");
 582     applicationProperties.remove("INSTALLATION");
 583   }
 584
 585   /**
 586    * Gets Jalview application property of given key. Returns null if key not
 587    * found
 588    *
 589    * @param key
 590    *          Name of property
 591    *
 592    * @return Property value
 593    */
 594   public static String getProperty(String key)
 595   {
 596     return applicationProperties.getProperty(key);
 597   }
 598
 599   /**
 600    * These methods are used when checking if the saved preference is different
 601    * to the default setting
 602    */
 603
 604   public static boolean getDefault(String property, boolean def)
 605   {
 606     String string = getProperty(property);
 607     if (string != null)
 608     {
 609       def = Boolean.valueOf(string).booleanValue();
 610     }
 611
 612     return def;
 613   }
 614
 615   /**
 616    * Answers the value of the given property, or the supplied default value if
 617    * the property is not set
 618    */
 619   public static String getDefault(String property, String def)
 620   {
 621     String value = getProperty(property);
 622     return value == null ? def : value;
 623   }
 624
 625   /**
 626    * Stores property in the file "HOME_DIR/.jalview_properties"
 627    *
 628    * @param key
 629    *          Name of object
 630    * @param obj
 631    *          String value of property
 632    *
 633    * @return previous value of property (or null)
 634    */
 635   public static Object setProperty(String key, String obj)
 636   {
 637     Object oldValue = null;
 638     try
 639     {
 640       oldValue = applicationProperties.setProperty(key, obj);
 641       if (!propsAreReadOnly)
 642       {
 643         FileOutputStream out = new FileOutputStream(propertiesFile);
 644         applicationProperties.store(out, "---JalviewX Properties File---");
 645         out.close();
 646       }
 647     } catch (Exception ex)
 648     {
 649       System.out.println(
 650               "Error setting property: " + key + " " + obj + "\n" + ex);
 651     }
 652     return oldValue;
 653   }
 654
 655   /**
 656    * remove the specified property from the jalview properties file
 657    *
 658    * @param string
 659    */
 660   public static void removeProperty(String string)
 661   {
 662     applicationProperties.remove(string);
 663     saveProperties();
 664   }
 665
 666   /**
 667    * save the properties to the jalview properties path
 668    */
 669   public static void saveProperties()
 670   {
 671     if (!propsAreReadOnly)
 672     {
 673       try
 674       {
 675         FileOutputStream out = new FileOutputStream(propertiesFile);
 676         applicationProperties.store(out, "---JalviewX Properties File---");
 677         out.close();
 678       } catch (Exception ex)
 679       {
 680         System.out.println("Error saving properties: " + ex);
 681       }
 682     }
 683   }
 684
 685   /**
 686    * internal vamsas class discovery state
 687    */
 688   private static int vamsasJarsArePresent = -1;
 689
 690   /**
 691    * Searches for vamsas client classes on class path.
 692    *
 693    * @return true if vamsas client is present on classpath
 694    */
 695   public static boolean vamsasJarsPresent()
 696   {
 697     if (vamsasJarsArePresent == -1)
 698     {
 699       try
 700       {
 701         if (jalview.jbgui.GDesktop.class.getClassLoader()
 702                 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
 703         {
 704           jalview.bin.Cache.log.debug(
 705                   "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 706           vamsasJarsArePresent = 1;
 707           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 708           lvclient.setLevel(Level.toLevel(Cache
 709                   .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
 710
 711           lvclient.addAppender(log.getAppender("JalviewLogger"));
 712           // Tell the user that debug is enabled
 713           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 714         }
 715       } catch (Exception e)
 716       {
 717         vamsasJarsArePresent = 0;
 718         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 719       }
 720     }
 721     return (vamsasJarsArePresent > 0);
 722   }
 723
 724   /**
 725    * internal vamsas class discovery state
 726    */
 727   private static int groovyJarsArePresent = -1;
 728
 729   /**
 730    * Searches for vamsas client classes on class path.
 731    *
 732    * @return true if vamsas client is present on classpath
 733    */
 734   public static boolean groovyJarsPresent()
 735   {
 736     if (groovyJarsArePresent == -1)
 737     {
 738       try
 739       {
 740         if (Cache.class.getClassLoader()
 741                 .loadClass("groovy.lang.GroovyObject") != null)
 742         {
 743           jalview.bin.Cache.log.debug(
 744                   "Found Groovy (groovy.lang.GroovyObject can be loaded)");
 745           groovyJarsArePresent = 1;
 746           Logger lgclient = Logger.getLogger("groovy");
 747           lgclient.setLevel(Level.toLevel(Cache
 748                   .getDefault("logs.Groovy.Level", Level.INFO.toString())));
 749
 750           lgclient.addAppender(log.getAppender("JalviewLogger"));
 751           // Tell the user that debug is enabled
 752           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 753         }
 754       } catch (Error e)
 755       {
 756         groovyJarsArePresent = 0;
 757         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 758       } catch (Exception e)
 759       {
 760         groovyJarsArePresent = 0;
 761         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 762       }
 763     }
 764     return (groovyJarsArePresent > 0);
 765   }
 766
 767   /**
 768    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 769    * enabled.
 770    */
 771   protected static Object tracker = null;
 772
 773   protected static Class trackerfocus = null;
 774
 775   protected static Class jgoogleanalyticstracker = null;
 776
 777   /**
 778    * Initialise the google tracker if it is not done already.
 779    */
 780   public static void initGoogleTracker()
 781   {
 782     if (tracker == null)
 783     {
 784       if (jgoogleanalyticstracker == null)
 785       {
 786         // try to get the tracker class
 787         try
 788         {
 789           jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
 790                   "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 791           trackerfocus = Cache.class.getClassLoader()
 792                   .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
 793         } catch (Exception e)
 794         {
 795           log.debug(
 796                   "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 797           tracker = null;
 798           jgoogleanalyticstracker = null;
 799           trackerfocus = null;
 800           return;
 801         }
 802       }
 803       // now initialise tracker
 804       Exception re = null, ex = null;
 805       Error err = null;
 806       String vrs = "No Version Accessible";
 807       try
 808       {
 809         // Google analytics tracking code for Library Finder
 810         tracker = jgoogleanalyticstracker
 811                 .getConstructor(new Class[]
 812                 { String.class, String.class, String.class })
 813                 .newInstance(new Object[]
 814                 { "Jalview Desktop",
 815                     (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
 816                             + jalview.bin.Cache.getDefault("BUILD_DATE",
 817                                     "unknown")),
 818                     "UA-9060947-1" });
 819         jgoogleanalyticstracker
 820                 .getMethod("trackAsynchronously", new Class[]
 821                 { trackerfocus })
 822                 .invoke(tracker, new Object[]
 823                 { trackerfocus.getConstructor(new Class[] { String.class })
 824                         .newInstance(new Object[]
 825                         { "Application Started." }) });
 826       } catch (RuntimeException e)
 827       {
 828         re = e;
 829       } catch (Exception e)
 830       {
 831         ex = e;
 832       } catch (Error e)
 833       {
 834         err = e;
 835       }
 836       if (re != null || ex != null || err != null)
 837       {
 838         if (log != null)
 839         {
 840           if (re != null)
 841           {
 842             log.debug("Caught runtime exception in googletracker init:",
 843                     re);
 844           }
 845           if (ex != null)
 846           {
 847             log.warn(
 848                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 849                             + vrs,
 850                     ex);
 851           }
 852           if (err != null)
 853           {
 854             log.error(
 855                     "Whilst initing GoogleTracker for Jalview Desktop version "
 856                             + vrs,
 857                     err);
 858           }
 859         }
 860         else
 861         {
 862           if (re != null)
 863           {
 864             System.err.println(
 865                     "Debug: Caught runtime exception in googletracker init:"
 866                             + vrs);
 867             re.printStackTrace();
 868           }
 869           if (ex != null)
 870           {
 871             System.err.println(
 872                     "Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 873                             + vrs);
 874             ex.printStackTrace();
 875           }
 876
 877           if (err != null)
 878           {
 879             System.err.println(
 880                     "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 881                             + vrs);
 882             err.printStackTrace();
 883           }
 884         }
 885       }
 886       else
 887       {
 888         log.debug("Successfully initialised tracker.");
 889       }
 890     }
 891   }
 892
 893   /**
 894    * get the user's default colour if available
 895    *
 896    * @param property
 897    * @param defcolour
 898    * @return
 899    */
 900   public static Color getDefaultColour(String property, Color defcolour)
 901   {
 902     String colprop = getProperty(property);
 903     if (colprop == null)
 904     {
 905       return defcolour;
 906     }
 907     Color col = ColorUtils.parseColourString(colprop);
 908     if (col == null)
 909     {
 910       log.warn("Couldn't parse '" + colprop + "' as a colour for "
 911               + property);
 912     }
 913     return (col == null) ? defcolour : col;
 914   }
 915
 916   /**
 917    * store a colour as a Jalview user default property
 918    *
 919    * @param property
 920    * @param colour
 921    */
 922   public static void setColourProperty(String property, Color colour)
 923   {
 924     setProperty(property, jalview.util.Format.getHexString(colour));
 925   }
 926
 927   /**
 928    * Stores a formatted date in a jalview property, using a fixed locale.
 929    *
 930    * @param propertyName
 931    * @param date
 932    * @return the formatted date string
 933    */
 934   public static String setDateProperty(String propertyName, Date date)
 935   {
 936     String formatted = date_format.format(date);
 937     setProperty(propertyName, formatted);
 938     return formatted;
 939   }
 940
 941   /**
 942    * Reads a date stored in a Jalview property, parses it (using a fixed locale
 943    * format) and returns as a Date, or null if parsing fails
 944    *
 945    * @param propertyName
 946    * @return
 947    *
 948    */
 949   public static Date getDateProperty(String propertyName)
 950   {
 951     String val = getProperty(propertyName);
 952     if (val != null)
 953     {
 954       try
 955       {
 956         return date_format.parse(val);
 957       } catch (Exception ex)
 958       {
 959         System.err.println("Invalid or corrupt date in property '"
 960                 + propertyName + "' : value was '" + val + "'");
 961       }
 962     }
 963     return null;
 964   }
 965
 966   /**
 967    * get and parse a property as an integer. send any parsing problems to
 968    * System.err
 969    *
 970    * @param property
 971    * @return null or Integer
 972    */
 973   public static Integer getIntegerProperty(String property)
 974   {
 975     String val = getProperty(property);
 976     if (val != null && (val = val.trim()).length() > 0)
 977     {
 978       try
 979       {
 980         return Integer.valueOf(val);
 981       } catch (NumberFormatException x)
 982       {
 983         System.err.println("Invalid integer in property '" + property
 984                 + "' (value was '" + val + "')");
 985       }
 986     }
 987     return null;
 988   }
 989
 990   /**
 991    * Set the specified value, or remove it if null or empty. Does not save the
 992    * properties file.
 993    *
 994    * @param propName
 995    * @param value
 996    */
 997   public static void setOrRemove(String propName, String value)
 998   {
 999     if (propName == null)
1000     {
1001       return;
1002     }
1003     if (value == null || value.trim().length() < 1)
1004     {
1005       Cache.applicationProperties.remove(propName);
1006     }
1007     else
1008     {
1009       Cache.applicationProperties.setProperty(propName, value);
1010     }
1011   }
1012
1013   /**
1014    * Loads in user colour schemes from files.
1015    *
1016    * @param files
1017    *          a '|'-delimited list of file paths
1018    */
1019   public static void initUserColourSchemes(String files)
1020   {
1021     if (files == null || files.length() == 0)
1022     {
1023       return;
1024     }
1025
1026     // In case colours can't be loaded, we'll remove them
1027     // from the default list here.
1028     StringBuffer coloursFound = new StringBuffer();
1029     StringTokenizer st = new StringTokenizer(files, "|");
1030     while (st.hasMoreElements())
1031     {
1032       String file = st.nextToken();
1033       try
1034       {
1035         UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1036         if (ucs != null)
1037         {
1038           if (coloursFound.length() > 0)
1039           {
1040             coloursFound.append("|");
1041           }
1042           coloursFound.append(file);
1043           ColourSchemes.getInstance().registerColourScheme(ucs);
1044         }
1045       } catch (Exception ex)
1046       {
1047         System.out.println("Error loading User ColourFile\n" + ex);
1048       }
1049     }
1050     if (!files.equals(coloursFound.toString()))
1051     {
1052       if (coloursFound.toString().length() > 1)
1053       {
1054         setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1055                 coloursFound.toString());
1056       }
1057       else
1058       {
1059         applicationProperties
1060                 .remove(UserDefinedColours.USER_DEFINED_COLOURS);
1061       }
1062     }
1063   }
1064
1065         /**
1066          * Add a known domain that implements access-control-allow-origin:* bh 2018
1067          *
1068          * @param defaultUniprotDomain
1069          */
1070         public static void addJ2SDirectDatabaseCall(String domain)
1071         {
1072
1073                 /**
1074                  * @j2sNative
1075                  *
1076                  *                      J2S.addDirectDatabaseCall(domain);
1077                  */
1078         }
1079 }