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