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