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