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.ColourSchemes;
  26 import jalview.schemes.UserColourScheme;
  27 import jalview.structure.StructureImportSettings;
  28 import jalview.urls.IdOrgSettings;
  29 import jalview.util.ColorUtils;
  30 import jalview.ws.dbsources.das.api.DasSourceRegistryI;
  31 import jalview.ws.dbsources.das.datamodel.DasSourceRegistry;
  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 italic)</li>
  80  * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
  81  * <li>LAST_DIRECTORY last directory for browsing alignment</li>
  82  * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
  83  * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
  84  * <li>SHOW_IDENTITY show percentage identity annotation</li>
  85  * <li>SHOW_QUALITY show alignment quality annotation</li>
  86  * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
  87  * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
  88  * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
  89  * LABEL_AND_SEQUENCE</li>
  90  * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
  91  * sequence annotations</li>
  92  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  93  * annotation row</li>
  94  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
  95  * <li>DEFAULT_FILE_FORMAT file format used to save</li>
  96  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
  97  * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
  98  * <li>VERSION the version of the jalview build</li>
  99  * <li>BUILD_DATE date of this build</li>
 100  * <li>LATEST_VERSION the latest jalview version advertised on the
 101  * www.jalview.org</li>
 102  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
 103  * descriptions</li>
 104  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
 105  * suffix to file</li>
 106  * <li>RECENT_URL list of recently retrieved URLs</li>
 107  * <li>RECENT_FILE list of recently opened files</li>
 108  * <li>USE_PROXY flag for whether a http proxy is to be used</li>
 109  * <li>PROXY_SERVER the proxy</li>
 110  * <li>PROXY_PORT</li>
 111  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
 112  * service</li>
 113  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
 114  * service</li>
 115  * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
 116  * collecting usage statistics</li>
 117  * <li>DAS_LOCAL_SOURCE list of local das sources</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>DAS_REGISTRY_URL the registry to query</li>
 138  * <li>DEFAULT_BROWSER for unix</li>
 139  * <li>DAS_ACTIVE_SOURCE list of active sources</li>
 140  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
 141  * (false)</li>
 142  * <li>VERSION_CHECK (true) check for the latest release version from
 143  * www.jalview.org (or the alias given by the www.jalview.org property)</li>
 144  * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
 145  * ID tooltip</li>
 146  * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
 147  * ID tooltip</li>
 148  * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
 149  * displayed as '.'</li>
 150  * <li>SORT_BY_TREE (false) sort the current alignment view according to the
 151  * order of a newly displayed tree</li>
 152  * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from
 153  * sequence ID strings before attempting retrieval from any datasource</li>
 154  * <li>SHOW_GROUP_CONSENSUS (false) Show consensus annotation for groups in the
 155  * alignment.</li>
 156  * <li>SHOW_GROUP_CONSERVATION (false) Show conservation annotation for groups
 157  * in the alignment.</li>
 158  * <li>SHOW_CONSENSUS_HISTOGRAM (false) Show consensus annotation row's
 159  * histogram.</li>
 160  * <li>SHOW_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
 161  * logo.</li>
 162  * <li>NORMALISE_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
 163  * logo normalised to row height rather than histogram height.</li>
 164  * <li>FOLLOW_SELECTIONS (true) Controls whether a new alignment view should
 165  * respond to selections made in other alignments containing the same sequences.
 166  * </li>
 167  * <li>JWS2HOSTURLS comma-separated list of URLs to try for JABAWS services</li>
 168  * <li>SHOW_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
 169  * warning dialog box is displayed.</li>
 170  * <li>ANNOTATIONCOLOUR_MIN (orange) Shade used for minimum value of annotation
 171  * when shading by annotation</li>
 172  * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation
 173  * when shading by annotation</li>
 174  * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP
 175  * requests to be redirected to a mirror of http://www.jalview.org</li>
 176  * <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported
 177  * alignment figure to accommodate even the longest sequence ID or annotation
 178  * label.</li>
 179  * <li>FIGURE_FIXEDIDWIDTH Specifies the width to use for the left-hand column
 180  * when exporting an alignment as a figure (setting FIGURE_AUTOIDWIDTH to true
 181  * will override this).</li>
 182  * <li>STRUCT_FROM_PDB (false) derive secondary structure annotation from PDB
 183  * record</li>
 184  * <li>USE_RNAVIEW (false) use RNAViewer to derive secondary structure</li>
 185  * <li>ADD_SS_ANN (false) add secondary structure annotation to alignment
 186  * display</li>
 187  * <li>ADD_TEMPFACT_ANN (false) add Temperature Factor annotation to alignment
 188  * display</li>
 189  * <li>STRUCTURE_DISPLAY choose from JMOL (default) or CHIMERA for 3D structure
 190  * display</li>
 191  * <li>CHIMERA_PATH specify full path to Chimera program (if non-standard)</li>
 192  * <li>ID_ORG_HOSTURL location of jalview service providing identifiers.org urls
 193  * </li>
 194  *
 195  * </ul>
 196  * Deprecated settings:
 197  * <ul>
 198  * *
 199  * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
 200  * startup (JWS1 services only)</li>
 201  * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
 202  * (JWS1 services only)</li>
 203  * <li>SHOW_JWS1_SERVICES (true) enable or disable the original Jalview 2
 204  * services in the desktop GUI</li>
 205  * <li>ENABLE_RSBS_EDITOR (false for 2.7 release) enable or disable RSBS editing
 206  * panel in web service preferences</li>
 207  * </ul>
 208  *
 209  * @author $author$
 210  * @version $Revision$
 211  */
 212 public class Cache
 213 {
 214   /**
 215    * property giving log4j level for CASTOR loggers
 216    */
 217   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 218
 219   /**
 220    * property giving log4j level for AXIS loggers
 221    */
 222   public static final String AXISLOGLEVEL = "logs.Axis.level";
 223
 224   /**
 225    * property giving log4j level for Jalview Log
 226    */
 227   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 228
 229   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 230
 231   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 232
 233   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 234
 235   /**
 236    * Sifts settings
 237    */
 238   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 239           .getProperty("user.home")
 240           + 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<Object>(super.keySet()));
 284     }
 285   };
 286
 287   /** Default file is ~/.jalview_properties */
 288   static String propertiesFile;
 289
 290   private static boolean propsAreReadOnly = false;
 291
 292   public static void initLogger()
 293   {
 294     if (log != null)
 295     {
 296       return;
 297     }
 298     try
 299     {
 300       // TODO: redirect stdout and stderr here in order to grab the output of
 301       // the log
 302
 303       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 304               "System.err");
 305       ap.setName("JalviewLogger");
 306       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 307       // log output
 308       Logger laxis = Logger.getLogger("org.apache.axis");
 309       Logger lcastor = Logger.getLogger("org.exolab.castor");
 310       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 311
 312       laxis.setLevel(Level.toLevel(Cache.getDefault("logs.Axis.Level",
 313               Level.INFO.toString())));
 314       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 315               Level.INFO.toString())));
 316       lcastor = Logger.getLogger("org.exolab.castor.xml");
 317       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 318               Level.INFO.toString())));
 319       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 320       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 321       // Level.INFO.toString())));
 322       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache.getDefault(
 323               "logs.Jalview.level", Level.INFO.toString())));
 324       // laxis.addAppender(ap);
 325       // lcastor.addAppender(ap);
 326       // jalview.bin.Cache.log.addAppender(ap);
 327       // Tell the user that debug is enabled
 328       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 329     } catch (Exception ex)
 330     {
 331       System.err.println("Problems initializing the log4j system\n");
 332       ex.printStackTrace(System.err);
 333     }
 334   }
 335
 336   /** Called when Jalview is started */
 337   public static void loadProperties(String propsFile)
 338   {
 339     propertiesFile = propsFile;
 340     if (propsFile == null)
 341     {
 342       propertiesFile = System.getProperty("user.home") + File.separatorChar
 343               + ".jalview_properties";
 344     }
 345     else
 346     {
 347       // don't corrupt the file we've been given.
 348       propsAreReadOnly = true;
 349     }
 350
 351     try
 352     {
 353       InputStream fis;
 354       try
 355       {
 356         fis = new java.net.URL(propertiesFile).openStream();
 357         System.out.println("Loading jalview properties from : "
 358                 + propertiesFile);
 359         System.out
 360                 .println("Disabling Jalview writing to user's local properties file.");
 361         propsAreReadOnly = true;
 362
 363       } catch (Exception ex)
 364       {
 365         fis = null;
 366       }
 367       if (fis == null)
 368       {
 369         fis = new FileInputStream(propertiesFile);
 370       }
 371       applicationProperties.load(fis);
 372
 373       // remove any old build properties
 374
 375       deleteBuildProperties();
 376       fis.close();
 377     } catch (Exception ex)
 378     {
 379       System.out.println("Error reading properties file: " + ex);
 380     }
 381
 382     if (getDefault("USE_PROXY", false))
 383     {
 384       String proxyServer = getDefault("PROXY_SERVER", ""), proxyPort = getDefault(
 385               "PROXY_PORT", "8080");
 386
 387       System.out.println("Using proxyServer: " + proxyServer
 388               + " proxyPort: " + proxyPort);
 389
 390       System.setProperty("http.proxyHost", proxyServer);
 391       System.setProperty("http.proxyPort", proxyPort);
 392     }
 393
 394     // LOAD THE AUTHORS FROM THE authors.props file
 395     try
 396     {
 397       String authorDetails = "jar:".concat(Cache.class
 398               .getProtectionDomain().getCodeSource().getLocation()
 399               .toString().concat("!/authors.props"));
 400
 401       java.net.URL localJarFileURL = new java.net.URL(authorDetails);
 402
 403       InputStream in = localJarFileURL.openStream();
 404       applicationProperties.load(in);
 405       in.close();
 406     } catch (Exception ex)
 407     {
 408       System.out.println("Error reading author details: " + ex);
 409       applicationProperties.remove("AUTHORS");
 410       applicationProperties.remove("AUTHORFNAMES");
 411       applicationProperties.remove("YEAR");
 412     }
 413
 414     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 415     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 416     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 417     try
 418     {
 419       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 420               .getCodeSource().getLocation().toString()
 421               .concat("!/.build_properties"));
 422
 423       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 424
 425       InputStream in = localJarFileURL.openStream();
 426       applicationProperties.load(in);
 427       in.close();
 428     } catch (Exception ex)
 429     {
 430       System.out.println("Error reading build details: " + ex);
 431       applicationProperties.remove("VERSION");
 432     }
 433
 434     String jnlpVersion = System.getProperty("jalview.version");
 435     String codeVersion = getProperty("VERSION");
 436     String codeInstallation = getProperty("INSTALLATION");
 437     if (codeVersion == null)
 438     {
 439       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 440       codeVersion = "Test";
 441       jnlpVersion = "Test";
 442       codeInstallation = "";
 443     }
 444     else
 445     {
 446       codeInstallation = " (" + codeInstallation + ")";
 447     }
 448     new BuildDetails(codeVersion, null, codeInstallation);
 449
 450     SiftsSettings
 451             .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
 452
 453     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache.getDefault(
 454             "sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 455
 456     SiftsSettings.setFailSafePIDThreshold(jalview.bin.Cache.getDefault(
 457             "sifts_fail_safe_pid_threshold",
 458             DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 459
 460     SiftsSettings.setCacheThresholdInDays(jalview.bin.Cache.getDefault(
 461             "sifts_cache_threshold_in_days",
 462             DEFAULT_CACHE_THRESHOLD_IN_DAYS));
 463
 464     IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
 465             "http://www.jalview.org/services/identifiers"));
 466     IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
 467
 468     System.out
 469             .println("Jalview Version: " + codeVersion + codeInstallation);
 470
 471     StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
 472             .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
 473     StructureImportSettings
 474             .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
 475     // StructureImportSettings
 476     // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
 477     // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
 478     // jnlpVersion will be null if we're using InstallAnywhere
 479     // Dont do this check if running in headless mode
 480     if (jnlpVersion == null
 481             && getDefault("VERSION_CHECK", true)
 482             && (System.getProperty("java.awt.headless") == null || System
 483                     .getProperty("java.awt.headless").equals("false")))
 484     {
 485
 486       class VersionChecker extends Thread
 487       {
 488         @Override
 489         public void run()
 490         {
 491           String orgtimeout = System
 492                   .getProperty("sun.net.client.defaultConnectTimeout");
 493           if (orgtimeout == null)
 494           {
 495             orgtimeout = "30";
 496             System.out.println("# INFO: Setting default net timeout to "
 497                     + orgtimeout + " seconds.");
 498           }
 499           String remoteVersion = null;
 500           try
 501           {
 502             System.setProperty("sun.net.client.defaultConnectTimeout",
 503                     "5000");
 504             java.net.URL url = new java.net.URL(Cache.getDefault(
 505                     "www.jalview.org", "http://www.jalview.org")
 506                     + "/webstart/jalview.jnlp");
 507             BufferedReader in = new BufferedReader(new InputStreamReader(
 508                     url.openStream()));
 509             String line = null;
 510             while ((line = in.readLine()) != null)
 511             {
 512               if (line.indexOf("jalview.version") == -1)
 513               {
 514                 continue;
 515               }
 516
 517               line = line.substring(line.indexOf("value=") + 7);
 518               line = line.substring(0, line.lastIndexOf("\""));
 519               remoteVersion = line;
 520               break;
 521             }
 522           } catch (Exception ex)
 523           {
 524             System.out
 525                     .println("Non-fatal exception when checking version at www.jalview.org :");
 526             System.out.println(ex);
 527             remoteVersion = getProperty("VERSION");
 528           }
 529           System.setProperty("sun.net.client.defaultConnectTimeout",
 530                   orgtimeout);
 531
 532           setProperty("LATEST_VERSION", remoteVersion);
 533         }
 534       }
 535
 536       VersionChecker vc = new VersionChecker();
 537       vc.start();
 538     }
 539     else
 540     {
 541       if (jnlpVersion != null)
 542       {
 543         setProperty("LATEST_VERSION", jnlpVersion);
 544       }
 545       else
 546       {
 547         applicationProperties.remove("LATEST_VERSION");
 548       }
 549     }
 550
 551     setProperty("VERSION", codeVersion);
 552
 553     // LOAD USERDEFINED COLOURS
 554     jalview.bin.Cache
 555             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 556     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 557             false);
 558   }
 559
 560   private static void deleteBuildProperties()
 561   {
 562     applicationProperties.remove("LATEST_VERSION");
 563     applicationProperties.remove("VERSION");
 564     applicationProperties.remove("AUTHORS");
 565     applicationProperties.remove("AUTHORFNAMES");
 566     applicationProperties.remove("YEAR");
 567     applicationProperties.remove("BUILD_DATE");
 568     applicationProperties.remove("INSTALLATION");
 569   }
 570
 571   /**
 572    * Gets Jalview application property of given key. Returns null if key not
 573    * found
 574    *
 575    * @param key
 576    *          Name of property
 577    *
 578    * @return Property value
 579    */
 580   public static String getProperty(String key)
 581   {
 582     return applicationProperties.getProperty(key);
 583   }
 584
 585   /**
 586    * These methods are used when checking if the saved preference is different
 587    * to the default setting
 588    */
 589
 590   public static boolean getDefault(String property, boolean def)
 591   {
 592     String string = getProperty(property);
 593     if (string != null)
 594     {
 595       def = Boolean.valueOf(string).booleanValue();
 596     }
 597
 598     return def;
 599   }
 600
 601   /**
 602    * These methods are used when checking if the saved preference is different
 603    * to the default setting
 604    */
 605   public static String getDefault(String property, String def)
 606   {
 607     String string = getProperty(property);
 608     if (string != null)
 609     {
 610       return string;
 611     }
 612
 613     return def;
 614   }
 615
 616   /**
 617    * Stores property in the file "HOME_DIR/.jalview_properties"
 618    *
 619    * @param key
 620    *          Name of object
 621    * @param obj
 622    *          String value of property
 623    *
 624    * @return String value of property
 625    */
 626   public static String setProperty(String key, String obj)
 627   {
 628
 629     try
 630     {
 631       applicationProperties.setProperty(key, obj);
 632       if (!propsAreReadOnly)
 633       {
 634         FileOutputStream out = new FileOutputStream(propertiesFile);
 635         applicationProperties.store(out, "---JalviewX Properties File---");
 636         out.close();
 637       }
 638     } catch (Exception ex)
 639     {
 640       System.out.println("Error setting property: " + key + " " + obj
 641               + "\n" + ex);
 642     }
 643     return obj;
 644   }
 645
 646   /**
 647    * remove the specified property from the jalview properties file
 648    *
 649    * @param string
 650    */
 651   public static void removeProperty(String string)
 652   {
 653     applicationProperties.remove(string);
 654     saveProperties();
 655   }
 656
 657   /**
 658    * save the properties to the jalview properties path
 659    */
 660   public static void saveProperties()
 661   {
 662     if (!propsAreReadOnly)
 663     {
 664       try
 665       {
 666         FileOutputStream out = new FileOutputStream(propertiesFile);
 667         applicationProperties.store(out, "---JalviewX Properties File---");
 668         out.close();
 669       } catch (Exception ex)
 670       {
 671         System.out.println("Error saving properties: " + ex);
 672       }
 673     }
 674   }
 675
 676   /**
 677    * internal vamsas class discovery state
 678    */
 679   private static int vamsasJarsArePresent = -1;
 680
 681   /**
 682    * Searches for vamsas client classes on class path.
 683    *
 684    * @return true if vamsas client is present on classpath
 685    */
 686   public static boolean vamsasJarsPresent()
 687   {
 688     if (vamsasJarsArePresent == -1)
 689     {
 690       try
 691       {
 692         if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
 693                 "uk.ac.vamsas.client.VorbaId") != null)
 694         {
 695           jalview.bin.Cache.log
 696                   .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 697           vamsasJarsArePresent = 1;
 698           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 699           lvclient.setLevel(Level.toLevel(Cache.getDefault(
 700                   "logs.Vamsas.Level", Level.INFO.toString())));
 701
 702           lvclient.addAppender(log.getAppender("JalviewLogger"));
 703           // Tell the user that debug is enabled
 704           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 705         }
 706       } catch (Exception e)
 707       {
 708         vamsasJarsArePresent = 0;
 709         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 710       }
 711     }
 712     return (vamsasJarsArePresent > 0);
 713   }
 714
 715   /**
 716    * internal vamsas class discovery state
 717    */
 718   private static int groovyJarsArePresent = -1;
 719
 720   /**
 721    * Searches for vamsas client classes on class path.
 722    *
 723    * @return true if vamsas client is present on classpath
 724    */
 725   public static boolean groovyJarsPresent()
 726   {
 727     if (groovyJarsArePresent == -1)
 728     {
 729       try
 730       {
 731         if (Cache.class.getClassLoader().loadClass(
 732                 "groovy.lang.GroovyObject") != null)
 733         {
 734           jalview.bin.Cache.log
 735                   .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
 736           groovyJarsArePresent = 1;
 737           Logger lgclient = Logger.getLogger("groovy");
 738           lgclient.setLevel(Level.toLevel(Cache.getDefault(
 739                   "logs.Groovy.Level", Level.INFO.toString())));
 740
 741           lgclient.addAppender(log.getAppender("JalviewLogger"));
 742           // Tell the user that debug is enabled
 743           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 744         }
 745       } catch (Error e)
 746       {
 747         groovyJarsArePresent = 0;
 748         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 749       } catch (Exception e)
 750       {
 751         groovyJarsArePresent = 0;
 752         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 753       }
 754     }
 755     return (groovyJarsArePresent > 0);
 756   }
 757
 758   /**
 759    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 760    * enabled.
 761    */
 762   protected static Object tracker = null;
 763
 764   protected static Class trackerfocus = null;
 765
 766   protected static Class jgoogleanalyticstracker = null;
 767
 768   /**
 769    * Initialise the google tracker if it is not done already.
 770    */
 771   public static void initGoogleTracker()
 772   {
 773     if (tracker == null)
 774     {
 775       if (jgoogleanalyticstracker == null)
 776       {
 777         // try to get the tracker class
 778         try
 779         {
 780           jgoogleanalyticstracker = Cache.class
 781                   .getClassLoader()
 782                   .loadClass(
 783                           "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 784           trackerfocus = Cache.class.getClassLoader().loadClass(
 785                   "com.boxysystems.jgoogleanalytics.FocusPoint");
 786         } catch (Exception e)
 787         {
 788           log.debug("com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 789           tracker = null;
 790           jgoogleanalyticstracker = null;
 791           trackerfocus = null;
 792           return;
 793         }
 794       }
 795       // now initialise tracker
 796       Exception re = null, ex = null;
 797       Error err = null;
 798       String vrs = "No Version Accessible";
 799       try
 800       {
 801         // Google analytics tracking code for Library Finder
 802         tracker = jgoogleanalyticstracker.getConstructor(
 803                 new Class[] { String.class, String.class, String.class })
 804                 .newInstance(
 805                         new Object[] {
 806                             "Jalview Desktop",
 807                             (vrs = jalview.bin.Cache.getProperty("VERSION")
 808                                     + "_"
 809                                     + jalview.bin.Cache.getDefault(
 810                                             "BUILD_DATE", "unknown")),
 811                             "UA-9060947-1" });
 812         jgoogleanalyticstracker.getMethod("trackAsynchronously",
 813                 new Class[] { trackerfocus }).invoke(
 814                 tracker,
 815                 new Object[] { trackerfocus.getConstructor(
 816                         new Class[] { String.class }).newInstance(
 817                         new Object[] { "Application Started." }) });
 818       } catch (RuntimeException e)
 819       {
 820         re = e;
 821       } catch (Exception e)
 822       {
 823         ex = e;
 824       } catch (Error e)
 825       {
 826         err = e;
 827       }
 828       if (re != null || ex != null || err != null)
 829       {
 830         if (log != null)
 831         {
 832           if (re != null)
 833           {
 834             log.debug("Caught runtime exception in googletracker init:", re);
 835           }
 836           if (ex != null)
 837           {
 838             log.warn(
 839                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 840                             + vrs, ex);
 841           }
 842           if (err != null)
 843           {
 844             log.error(
 845                     "Whilst initing GoogleTracker for Jalview Desktop version "
 846                             + vrs, err);
 847           }
 848         }
 849         else
 850         {
 851           if (re != null)
 852           {
 853             System.err
 854                     .println("Debug: Caught runtime exception in googletracker init:"
 855                             + vrs);
 856             re.printStackTrace();
 857           }
 858           if (ex != null)
 859           {
 860             System.err
 861                     .println("Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 862                             + vrs);
 863             ex.printStackTrace();
 864           }
 865
 866           if (err != null)
 867           {
 868             System.err
 869                     .println("ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 870                             + vrs);
 871             err.printStackTrace();
 872           }
 873         }
 874       }
 875       else
 876       {
 877         log.debug("Successfully initialised tracker.");
 878       }
 879     }
 880   }
 881
 882   /**
 883    * get the user's default colour if available
 884    *
 885    * @param property
 886    * @param defcolour
 887    * @return
 888    */
 889   public static Color getDefaultColour(String property, Color defcolour)
 890   {
 891     String colprop = getProperty(property);
 892     if (colprop == null)
 893     {
 894       return defcolour;
 895     }
 896     Color col = ColorUtils.parseColourString(colprop);
 897     if (col == null)
 898     {
 899       log.warn("Couldn't parse '" + colprop + "' as a colour for "
 900               + property);
 901     }
 902     return (col == null) ? defcolour : col;
 903   }
 904
 905   /**
 906    * store a colour as a Jalview user default property
 907    *
 908    * @param property
 909    * @param colour
 910    */
 911   public static void setColourProperty(String property, Color colour)
 912   {
 913     setProperty(property, jalview.util.Format.getHexString(colour));
 914   }
 915
 916   /**
 917    * Stores a formatted date in a jalview property, using a fixed locale.
 918    *
 919    * @param propertyName
 920    * @param date
 921    * @return the formatted date string
 922    */
 923   public static String setDateProperty(String propertyName, Date date)
 924   {
 925     String formatted = date_format.format(date);
 926     setProperty(propertyName, formatted);
 927     return formatted;
 928   }
 929
 930   /**
 931    * Reads a date stored in a Jalview property, parses it (using a fixed locale
 932    * format) and returns as a Date, or null if parsing fails
 933    *
 934    * @param propertyName
 935    * @return
 936    *
 937    */
 938   public static Date getDateProperty(String propertyName)
 939   {
 940     String val = getProperty(propertyName);
 941     if (val != null)
 942     {
 943       try
 944       {
 945         return date_format.parse(val);
 946       } catch (Exception ex)
 947       {
 948         System.err.println("Invalid or corrupt date in property '"
 949                 + propertyName + "' : value was '" + val + "'");
 950       }
 951     }
 952     return null;
 953   }
 954
 955   /**
 956    * get and parse a property as an integer. send any parsing problems to
 957    * System.err
 958    *
 959    * @param property
 960    * @return null or Integer
 961    */
 962   public static Integer getIntegerProperty(String property)
 963   {
 964     String val = getProperty(property);
 965     if (val != null && (val = val.trim()).length() > 0)
 966     {
 967       try
 968       {
 969         return Integer.valueOf(val);
 970       } catch (NumberFormatException x)
 971       {
 972         System.err.println("Invalid integer in property '" + property
 973                 + "' (value was '" + val + "')");
 974       }
 975     }
 976     return null;
 977   }
 978
 979   private static DasSourceRegistryI sourceRegistry = null;
 980
 981   /**
 982    * initialise and ..
 983    *
 984    * @return instance of the das source registry
 985    */
 986   public static DasSourceRegistryI getDasSourceRegistry()
 987   {
 988     if (sourceRegistry == null)
 989     {
 990       sourceRegistry = new DasSourceRegistry();
 991     }
 992     return sourceRegistry;
 993   }
 994
 995   /**
 996    * Set the specified value, or remove it if null or empty. Does not save the
 997    * properties file.
 998    *
 999    * @param propName
1000    * @param value
1001    */
1002   public static void setOrRemove(String propName, String value)
1003   {
1004     if (propName == null)
1005     {
1006       return;
1007     }
1008     if (value == null || value.trim().length() < 1)
1009     {
1010       Cache.applicationProperties.remove(propName);
1011     }
1012     else
1013     {
1014       Cache.applicationProperties.setProperty(propName, value);
1015     }
1016   }
1017
1018   /**
1019    * Loads in user colour schemes from files.
1020    *
1021    * @param files
1022    *          a '|'-delimited list of file paths
1023    */
1024   public static void initUserColourSchemes(String files)
1025   {
1026     if (files == null || files.length() == 0)
1027     {
1028       return;
1029     }
1030
1031     // In case colours can't be loaded, we'll remove them
1032     // from the default list here.
1033     StringBuffer coloursFound = new StringBuffer();
1034     StringTokenizer st = new StringTokenizer(files, "|");
1035     while (st.hasMoreElements())
1036     {
1037       String file = st.nextToken();
1038       try
1039       {
1040         UserColourScheme ucs = ColourSchemes.loadColourScheme(file);
1041         if (ucs != null)
1042         {
1043           if (coloursFound.length() > 0)
1044           {
1045             coloursFound.append("|");
1046           }
1047           coloursFound.append(file);
1048           ColourSchemes.getInstance().registerColourScheme(ucs);
1049         }
1050       } catch (Exception ex)
1051       {
1052         System.out.println("Error loading User ColourFile\n" + ex);
1053       }
1054     }
1055     if (!files.equals(coloursFound.toString()))
1056     {
1057       if (coloursFound.toString().length() > 1)
1058       {
1059         setProperty(UserDefinedColours.USER_DEFINED_COLOURS, coloursFound.toString());
1060       }
1061       else
1062       {
1063         applicationProperties.remove(UserDefinedColours.USER_DEFINED_COLOURS);
1064       }
1065     }
1066   }
1067 }