src/jalview/bin/Cache.java

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