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