2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.datamodel.PDBEntry;
24 import jalview.gui.UserDefinedColours;
25 import jalview.schemes.ColourSchemeLoader;
26 import jalview.schemes.ColourSchemes;
27 import jalview.schemes.UserColourScheme;
28 import jalview.structure.StructureImportSettings;
29 import jalview.urls.IdOrgSettings;
30 import jalview.util.ColorUtils;
31 import jalview.util.Platform;
32 import jalview.ws.sifts.SiftsSettings;
34 import java.awt.Color;
35 import java.io.BufferedReader;
37 import java.io.FileInputStream;
38 import java.io.FileOutputStream;
39 import java.io.InputStream;
40 import java.io.InputStreamReader;
41 import java.text.DateFormat;
42 import java.text.SimpleDateFormat;
43 import java.util.Collections;
44 import java.util.Date;
45 import java.util.Enumeration;
46 import java.util.Locale;
47 import java.util.Properties;
48 import java.util.StringTokenizer;
49 import java.util.TreeSet;
51 import org.apache.log4j.ConsoleAppender;
52 import org.apache.log4j.Level;
53 import org.apache.log4j.Logger;
54 import org.apache.log4j.SimpleLayout;
57 * Stores and retrieves Jalview Application Properties Lists and fields within
58 * list entries are separated by '|' symbols unless otherwise stated (|) clauses
59 * are alternative values for a tag. <br>
61 * Current properties include:
64 * logs.Axis.Level - one of the stringified Levels for log4j controlling the
65 * logging level for axis (used for web services) <br>
67 * <li>logs.Castor.Level - one of the stringified Levels for log4j controlling
68 * the logging level for castor (used for serialization) <br>
70 * <li>logs.Jalview.Level - Cache.log stringified level. <br>
72 * <li>SCREEN_WIDTH</li>
73 * <li>SCREEN_HEIGHT</li>
74 * <li>SCREEN_Y=285</li>
75 * <li>SCREEN_X=371</li>
76 * <li>SHOW_FULLSCREEN boolean</li>
77 * <li>FONT_NAME java font name for alignment text display</li>
78 * <li>FONT_SIZE size of displayed alignment text</li>
79 * <li>FONT_STYLE style of font displayed (sequence labels are always
81 * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
82 * <li>LAST_DIRECTORY last directory for browsing alignment</li>
83 * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
84 * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
85 * <li>SHOW_IDENTITY show percentage identity annotation</li>
86 * <li>SHOW_QUALITY show alignment quality annotation</li>
87 * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
88 * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
89 * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
90 * LABEL_AND_SEQUENCE</li>
91 * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
92 * sequence annotations</li>
93 * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
95 * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
96 * <li>DEFAULT_FILE_FORMAT file format used to save</li>
97 * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
98 * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
99 * <li>VERSION the version of the jalview build</li>
100 * <li>BUILD_DATE date of this build</li>
101 * <li>LATEST_VERSION the latest jalview version advertised on the
102 * www.jalview.org</li>
103 * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
105 * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
106 * suffix to file</li>
107 * <li>RECENT_URL list of recently retrieved URLs</li>
108 * <li>RECENT_FILE list of recently opened files</li>
109 * <li>USE_PROXY flag for whether a http proxy is to be used</li>
110 * <li>PROXY_SERVER the proxy</li>
111 * <li>PROXY_PORT</li>
112 * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
114 * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
116 * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
117 * collecting usage statistics</li>
118 * <li>SHOW_OVERVIEW boolean for overview window display</li>
119 * <li>ANTI_ALIAS boolean for smooth fonts</li>
120 * <li>RIGHT_ALIGN_IDS boolean</li>
121 * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
122 * <li>PAD_GAPS boolean</li>
123 * <li>ID_ITALICS boolean</li>
124 * <li>SHOW_JV_SUFFIX</li>
125 * <li>WRAP_ALIGNMENT</li>
126 * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
128 * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
129 * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
131 * <li>STORED_LINKS list of name|url pairs which user has entered but are not
133 * <li>DEFAULT_LINK name of single url to be used when user double clicks a
134 * sequence id (must be in SEQUENCE_LINKS or STORED_LINKS)
135 * <li>GROUP_LINKS list of name|URL[|<separator>] tuples - see
136 * jalview.utils.GroupURLLink for more info</li>
137 * <li>DEFAULT_BROWSER for unix</li>
138 * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
140 * <li>VERSION_CHECK (true) check for the latest release version from
141 * www.jalview.org (or the alias given by the www.jalview.org property)</li>
142 * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
144 * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
146 * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
147 * displayed as '.'</li>
148 * <li>SORT_BY_TREE (false) sort the current alignment view according to the
149 * order of a newly displayed tree</li>
150 * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from
151 * sequence ID strings before attempting retrieval from any datasource</li>
152 * <li>SHOW_GROUP_CONSENSUS (false) Show consensus annotation for groups in the
154 * <li>SHOW_GROUP_CONSERVATION (false) Show conservation annotation for groups
155 * in the alignment.</li>
156 * <li>SHOW_CONSENSUS_HISTOGRAM (false) Show consensus annotation row's
158 * <li>SHOW_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
160 * <li>NORMALISE_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
161 * logo normalised to row height rather than histogram height.</li>
162 * <li>FOLLOW_SELECTIONS (true) Controls whether a new alignment view should
163 * respond to selections made in other alignments containing the same sequences.
165 * <li>JWS2HOSTURLS comma-separated list of URLs to try for JABAWS services</li>
166 * <li>SHOW_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
167 * warning dialog box is displayed.</li>
168 * <li>ANNOTATIONCOLOUR_MIN (orange) Shade used for minimum value of annotation
169 * when shading by annotation</li>
170 * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation
171 * when shading by annotation</li>
172 * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP
173 * requests to be redirected to a mirror of http://www.jalview.org</li>
174 * <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported
175 * alignment figure to accommodate even the longest sequence ID or annotation
177 * <li>FIGURE_FIXEDIDWIDTH Specifies the width to use for the left-hand column
178 * when exporting an alignment as a figure (setting FIGURE_AUTOIDWIDTH to true
179 * will override this).</li>
180 * <li>STRUCT_FROM_PDB (false) derive secondary structure annotation from PDB
182 * <li>USE_RNAVIEW (false) use RNAViewer to derive secondary structure</li>
183 * <li>ADD_SS_ANN (false) add secondary structure annotation to alignment
185 * <li>ADD_TEMPFACT_ANN (false) add Temperature Factor annotation to alignment
187 * <li>STRUCTURE_DISPLAY choose from JMOL (default) or CHIMERA for 3D structure
189 * <li>CHIMERA_PATH specify full path to Chimera program (if non-standard)</li>
190 * <li>ID_ORG_HOSTURL location of jalview service providing identifiers.org urls
194 * Deprecated settings:
197 * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
198 * startup (JWS1 services only)</li>
199 * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
200 * (JWS1 services only)</li>
201 * <li>SHOW_JWS1_SERVICES (true) enable or disable the original Jalview 2
202 * services in the desktop GUI</li>
203 * <li>ENABLE_RSBS_EDITOR (false for 2.7 release) enable or disable RSBS editing
204 * panel in web service preferences</li>
208 * @version $Revision$
213 * property giving log4j level for CASTOR loggers
215 public static final String CASTORLOGLEVEL = "logs.Castor.level";
218 * property giving log4j level for AXIS loggers
220 public static final String AXISLOGLEVEL = "logs.Axis.level";
223 * property giving log4j level for Jalview Log
225 public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
230 public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
231 .getProperty("user.home") + File.separatorChar
232 + ".sifts_downloads" + File.separatorChar;
234 private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
236 private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
239 * Identifiers.org download settings
241 private static final String ID_ORG_FILE = System.getProperty("user.home")
242 + File.separatorChar + ".identifiers.org.ids.json";
245 * Allowed values are PDB or mmCIF
247 private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
250 private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
254 * a date formatter using a fixed (rather than the user's) locale;
255 * this ensures that date properties can be written and re-read successfully
256 * even if the user changes their locale setting
258 private static final DateFormat date_format = SimpleDateFormat
259 .getDateTimeInstance(SimpleDateFormat.MEDIUM,
260 SimpleDateFormat.MEDIUM, Locale.UK);
263 * Initialises the Jalview Application Log
265 public static Logger log;
267 /** Jalview Properties */
268 public static Properties applicationProperties = new Properties()
270 // override results in properties output in alphabetical order
272 public synchronized Enumeration<Object> keys()
274 return Collections.enumeration(new TreeSet<>(super.keySet()));
278 /** Default file is ~/.jalview_properties */
279 static String propertiesFile;
281 private static boolean propsAreReadOnly = Platform.isJS();
283 private final static String JS_PROPERTY_PREFIX = "jalview_";
285 public static void initLogger()
293 // TODO: redirect stdout and stderr here in order to grab the output of
296 ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
298 ap.setName("JalviewLogger");
299 org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
301 Logger laxis = Logger.getLogger("org.apache.axis");
302 Logger lcastor = Logger.getLogger("org.exolab.castor");
303 jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
305 laxis.setLevel(Level.toLevel(
306 Cache.getDefault("logs.Axis.Level", Level.INFO.toString())));
307 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
308 Level.INFO.toString())));
309 lcastor = Logger.getLogger("org.exolab.castor.xml");
310 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
311 Level.INFO.toString())));
312 // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
313 // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
314 // Level.INFO.toString())));
315 jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
316 .getDefault("logs.Jalview.level", Level.INFO.toString())));
317 // laxis.addAppender(ap);
318 // lcastor.addAppender(ap);
319 // jalview.bin.Cache.log.addAppender(ap);
320 // Tell the user that debug is enabled
321 jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
322 } catch (Exception ex)
324 System.err.println("Problems initializing the log4j system\n");
325 ex.printStackTrace(System.err);
330 * Loads properties from the given properties file. Any existing properties
333 public static void loadProperties(String propsFile)
335 propertiesFile = propsFile;
336 if (propsFile == null && !propsAreReadOnly)
338 propertiesFile = System.getProperty("user.home") + File.separatorChar
339 + ".jalview_properties";
343 // don't corrupt the file we've been given.
344 propsAreReadOnly = true;
347 if (propertiesFile == null)
349 Platform.readInfoProperties(JS_PROPERTY_PREFIX,
350 applicationProperties);
359 fis = new java.net.URL(propertiesFile).openStream();
361 "Loading jalview properties from : " + propertiesFile);
363 "Disabling Jalview writing to user's local properties file.");
364 propsAreReadOnly = true;
366 } catch (Exception ex)
372 fis = new FileInputStream(propertiesFile);
374 applicationProperties.clear();
375 applicationProperties.load(fis);
377 // remove any old build properties
379 deleteBuildProperties();
381 } catch (Exception ex)
383 System.out.println("Error reading properties file: " + ex);
386 if (getDefault("USE_PROXY", false))
388 String proxyServer = getDefault("PROXY_SERVER", ""),
389 proxyPort = getDefault("PROXY_PORT", "8080");
391 System.out.println("Using proxyServer: " + proxyServer
392 + " proxyPort: " + proxyPort);
394 System.setProperty("http.proxyHost", proxyServer);
395 System.setProperty("http.proxyPort", proxyPort);
398 // LOAD THE AUTHORS FROM THE authors.props file
399 String authorDetails = (Platform.isJS() ? null
400 : "jar:".concat(Cache.class.getProtectionDomain()
401 .getCodeSource().getLocation().toString()
402 .concat("!/authors.props")));
406 if (authorDetails != null)
408 java.net.URL localJarFileURL = new java.net.URL(authorDetails);
409 InputStream in = localJarFileURL.openStream();
410 applicationProperties.load(in);
413 } catch (Exception ex)
415 System.out.println("Error reading author details: " + ex);
416 authorDetails = null;
418 if (authorDetails == null)
420 applicationProperties.remove("AUTHORS");
421 applicationProperties.remove("AUTHORFNAMES");
422 applicationProperties.remove("YEAR");
425 // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
426 // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
427 // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
428 String buildDetails = (Platform.isJS() ? null
429 : "jar:".concat(Cache.class.getProtectionDomain()
430 .getCodeSource().getLocation().toString()
431 .concat("!/.build_properties")));
432 if (buildDetails != null)
436 java.net.URL localJarFileURL = new java.net.URL(buildDetails);
437 InputStream in = localJarFileURL.openStream();
438 applicationProperties.load(in);
440 } catch (Exception ex)
442 System.out.println("Error reading build details: " + ex);
446 if (buildDetails == null)
448 applicationProperties.remove("VERSION");
450 String jnlpVersion = System.getProperty("jalview.version");
451 String codeVersion = getProperty("VERSION");
452 String codeInstallation = getProperty("INSTALLATION");
453 if (codeVersion == null)
455 // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
456 codeVersion = "Test";
457 jnlpVersion = "Test";
458 codeInstallation = "";
462 codeInstallation = " (" + codeInstallation + ")";
464 new BuildDetails(codeVersion, null, codeInstallation);
467 .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
469 SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
470 .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
472 SiftsSettings.setFailSafePIDThreshold(
473 jalview.bin.Cache.getDefault("sifts_fail_safe_pid_threshold",
474 DEFAULT_FAIL_SAFE_PID_THRESHOLD));
476 SiftsSettings.setCacheThresholdInDays(
477 jalview.bin.Cache.getDefault("sifts_cache_threshold_in_days",
478 DEFAULT_CACHE_THRESHOLD_IN_DAYS));
480 IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
481 "http://www.jalview.org/services/identifiers"));
482 IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
485 .println("Jalview Version: " + codeVersion + codeInstallation);
487 StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
488 .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
489 StructureImportSettings
490 .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
491 // StructureImportSettings
492 // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
493 // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
494 // jnlpVersion will be null if we're using InstallAnywhere
495 // Dont do this check if running in headless mode
496 if (jnlpVersion == null && getDefault("VERSION_CHECK", true)
497 && (System.getProperty("java.awt.headless") == null || System
498 .getProperty("java.awt.headless").equals("false")))
501 class VersionChecker extends Thread
506 String orgtimeout = System
507 .getProperty("sun.net.client.defaultConnectTimeout");
508 if (orgtimeout == null)
511 System.out.println("# INFO: Setting default net timeout to "
512 + orgtimeout + " seconds.");
514 String remoteVersion = null;
517 System.setProperty("sun.net.client.defaultConnectTimeout",
519 java.net.URL url = new java.net.URL(Cache
520 .getDefault("www.jalview.org", "http://www.jalview.org")
521 + "/webstart/jalview.jnlp");
522 BufferedReader in = new BufferedReader(
523 new InputStreamReader(url.openStream()));
525 while ((line = in.readLine()) != null)
527 if (line.indexOf("jalview.version") == -1)
532 line = line.substring(line.indexOf("value=") + 7);
533 line = line.substring(0, line.lastIndexOf("\""));
534 remoteVersion = line;
537 } catch (Exception ex)
540 "Non-fatal exception when checking version at www.jalview.org :");
541 System.out.println(ex);
542 remoteVersion = getProperty("VERSION");
544 System.setProperty("sun.net.client.defaultConnectTimeout",
547 setProperty("LATEST_VERSION", remoteVersion);
551 VersionChecker vc = new VersionChecker();
556 if (jnlpVersion != null)
558 setProperty("LATEST_VERSION", jnlpVersion);
562 applicationProperties.remove("LATEST_VERSION");
566 setProperty("VERSION", codeVersion);
568 // LOAD USERDEFINED COLOURS
570 .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
571 jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
576 private static void deleteBuildProperties()
578 applicationProperties.remove("LATEST_VERSION");
579 applicationProperties.remove("VERSION");
580 applicationProperties.remove("AUTHORS");
581 applicationProperties.remove("AUTHORFNAMES");
582 applicationProperties.remove("YEAR");
583 applicationProperties.remove("BUILD_DATE");
584 applicationProperties.remove("INSTALLATION");
588 * Gets Jalview application property of given key. Returns null if key not
594 * @return Property value
596 public static String getProperty(String key)
598 String prop = applicationProperties.getProperty(key);
599 if (prop == null && Platform.isJS())
601 prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
602 + "_" + JS_PROPERTY_PREFIX + key);
608 * These methods are used when checking if the saved preference is different
609 * to the default setting
612 public static boolean getDefault(String property, boolean def)
614 String string = getProperty(property);
617 def = Boolean.valueOf(string).booleanValue();
623 public static int getDefault(String property, int def)
625 String string = getProperty(property);
630 def = Integer.parseInt(string);
631 } catch (NumberFormatException e)
633 System.out.println("Error parsing int property '" + property
634 + "' with value '" + string + "'");
642 * Answers the value of the given property, or the supplied default value if
643 * the property is not set
645 public static String getDefault(String property, String def)
647 String value = getProperty(property);
648 return value == null ? def : value;
652 * Stores property in the file "HOME_DIR/.jalview_properties"
657 * String value of property
659 * @return previous value of property (or null)
661 public static Object setProperty(String key, String obj)
663 Object oldValue = null;
666 oldValue = applicationProperties.setProperty(key, obj);
667 if (!propsAreReadOnly)
669 FileOutputStream out = new FileOutputStream(propertiesFile);
670 applicationProperties.store(out, "---JalviewX Properties File---");
673 } catch (Exception ex)
676 "Error setting property: " + key + " " + obj + "\n" + ex);
682 * remove the specified property from the jalview properties file
686 public static void removeProperty(String string)
688 applicationProperties.remove(string);
693 * save the properties to the jalview properties path
695 public static void saveProperties()
697 if (!propsAreReadOnly)
701 FileOutputStream out = new FileOutputStream(propertiesFile);
702 applicationProperties.store(out, "---JalviewX Properties File---");
704 } catch (Exception ex)
706 System.out.println("Error saving properties: " + ex);
712 * internal vamsas class discovery state
714 private static int vamsasJarsArePresent = -1;
717 * Searches for vamsas client classes on class path.
719 * @return true if vamsas client is present on classpath
721 public static boolean vamsasJarsPresent()
723 if (vamsasJarsArePresent == -1)
727 if (jalview.jbgui.GDesktop.class.getClassLoader()
728 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
730 jalview.bin.Cache.log.debug(
731 "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
732 vamsasJarsArePresent = 1;
733 Logger lvclient = Logger.getLogger("uk.ac.vamsas");
734 lvclient.setLevel(Level.toLevel(Cache
735 .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
737 lvclient.addAppender(log.getAppender("JalviewLogger"));
738 // Tell the user that debug is enabled
739 lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
741 } catch (Exception e)
743 vamsasJarsArePresent = 0;
744 jalview.bin.Cache.log.debug("Vamsas Classes are not present");
747 return (vamsasJarsArePresent > 0);
751 * internal vamsas class discovery state
753 private static int groovyJarsArePresent = -1;
756 * Searches for vamsas client classes on class path.
758 * @return true if vamsas client is present on classpath
760 public static boolean groovyJarsPresent()
762 if (groovyJarsArePresent == -1)
766 if (Cache.class.getClassLoader()
767 .loadClass("groovy.lang.GroovyObject") != null)
769 jalview.bin.Cache.log.debug(
770 "Found Groovy (groovy.lang.GroovyObject can be loaded)");
771 groovyJarsArePresent = 1;
772 Logger lgclient = Logger.getLogger("groovy");
773 lgclient.setLevel(Level.toLevel(Cache
774 .getDefault("logs.Groovy.Level", Level.INFO.toString())));
776 lgclient.addAppender(log.getAppender("JalviewLogger"));
777 // Tell the user that debug is enabled
778 lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
782 groovyJarsArePresent = 0;
783 jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
784 } catch (Exception e)
786 groovyJarsArePresent = 0;
787 jalview.bin.Cache.log.debug("Groovy Classes are not present");
790 return (groovyJarsArePresent > 0);
794 * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
797 protected static Object tracker = null;
799 protected static Class trackerfocus = null;
801 protected static Class jgoogleanalyticstracker = null;
804 * Initialise the google tracker if it is not done already.
806 public static void initGoogleTracker()
810 if (jgoogleanalyticstracker == null)
812 // try to get the tracker class
815 jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
816 "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
817 trackerfocus = Cache.class.getClassLoader()
818 .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
819 } catch (Exception e)
822 "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
824 jgoogleanalyticstracker = null;
829 // now initialise tracker
830 Exception re = null, ex = null;
832 String vrs = "No Version Accessible";
835 // Google analytics tracking code for Library Finder
836 tracker = jgoogleanalyticstracker
837 .getConstructor(new Class[]
838 { String.class, String.class, String.class })
839 .newInstance(new Object[]
841 (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
842 + jalview.bin.Cache.getDefault("BUILD_DATE",
845 jgoogleanalyticstracker
846 .getMethod("trackAsynchronously", new Class[]
848 .invoke(tracker, new Object[]
849 { trackerfocus.getConstructor(new Class[] { String.class })
850 .newInstance(new Object[]
851 { "Application Started." }) });
852 } catch (RuntimeException e)
855 } catch (Exception e)
862 if (re != null || ex != null || err != null)
868 log.debug("Caught runtime exception in googletracker init:",
874 "Failed to initialise GoogleTracker for Jalview Desktop with version "
881 "Whilst initing GoogleTracker for Jalview Desktop version "
891 "Debug: Caught runtime exception in googletracker init:"
893 re.printStackTrace();
898 "Warning: Failed to initialise GoogleTracker for Jalview Desktop with version "
900 ex.printStackTrace();
906 "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
908 err.printStackTrace();
914 log.debug("Successfully initialised tracker.");
920 * get the user's default colour if available
926 public static Color getDefaultColour(String property, Color defcolour)
928 String colprop = getProperty(property);
933 Color col = ColorUtils.parseColourString(colprop);
936 log.warn("Couldn't parse '" + colprop + "' as a colour for "
939 return (col == null) ? defcolour : col;
943 * store a colour as a Jalview user default property
948 public static void setColourProperty(String property, Color colour)
950 setProperty(property, jalview.util.Format.getHexString(colour));
954 * Stores a formatted date in a jalview property, using a fixed locale.
956 * @param propertyName
958 * @return the formatted date string
960 public static String setDateProperty(String propertyName, Date date)
962 String formatted = date_format.format(date);
963 setProperty(propertyName, formatted);
968 * Reads a date stored in a Jalview property, parses it (using a fixed locale
969 * format) and returns as a Date, or null if parsing fails
971 * @param propertyName
975 public static Date getDateProperty(String propertyName)
977 String val = getProperty(propertyName);
982 return date_format.parse(val);
983 } catch (Exception ex)
985 System.err.println("Invalid or corrupt date in property '"
986 + propertyName + "' : value was '" + val + "'");
993 * get and parse a property as an integer. send any parsing problems to
997 * @return null or Integer
999 public static Integer getIntegerProperty(String property)
1001 String val = getProperty(property);
1002 if (val != null && (val = val.trim()).length() > 0)
1006 return Integer.valueOf(val);
1007 } catch (NumberFormatException x)
1009 System.err.println("Invalid integer in property '" + property
1010 + "' (value was '" + val + "')");
1017 * Set the specified value, or remove it if null or empty. Does not save the
1023 public static void setOrRemove(String propName, String value)
1025 if (propName == null)
1029 if (value == null || value.trim().length() < 1)
1031 Cache.applicationProperties.remove(propName);
1035 Cache.applicationProperties.setProperty(propName, value);
1040 * Loads in user colour schemes from files.
1043 * a '|'-delimited list of file paths
1045 public static void initUserColourSchemes(String files)
1047 if (files == null || files.length() == 0)
1052 // In case colours can't be loaded, we'll remove them
1053 // from the default list here.
1054 StringBuffer coloursFound = new StringBuffer();
1055 StringTokenizer st = new StringTokenizer(files, "|");
1056 while (st.hasMoreElements())
1058 String file = st.nextToken();
1061 UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1064 if (coloursFound.length() > 0)
1066 coloursFound.append("|");
1068 coloursFound.append(file);
1069 ColourSchemes.getInstance().registerColourScheme(ucs);
1071 } catch (Exception ex)
1073 System.out.println("Error loading User ColourFile\n" + ex);
1076 if (!files.equals(coloursFound.toString()))
1078 if (coloursFound.toString().length() > 1)
1080 setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1081 coloursFound.toString());
1085 applicationProperties
1086 .remove(UserDefinedColours.USER_DEFINED_COLOURS);