src/jalview/bin/Cache.java

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