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 java.awt.Color;
24 import java.io.BufferedReader;
26 import java.io.FileInputStream;
27 import java.io.FileOutputStream;
28 import java.io.InputStream;
29 import java.io.InputStreamReader;
30 import java.io.PrintWriter;
31 import java.io.StringWriter;
32 import java.text.DateFormat;
33 import java.text.SimpleDateFormat;
34 import java.util.Collections;
35 import java.util.Date;
36 import java.util.Enumeration;
37 import java.util.Locale;
38 import java.util.Properties;
39 import java.util.StringTokenizer;
40 import java.util.TreeSet;
41 import java.util.regex.Pattern;
43 import javax.swing.LookAndFeel;
44 import javax.swing.UIManager;
46 import org.apache.log4j.ConsoleAppender;
47 import org.apache.log4j.Level;
48 import org.apache.log4j.Logger;
49 import org.apache.log4j.SimpleLayout;
51 import jalview.datamodel.PDBEntry;
52 import jalview.gui.UserDefinedColours;
53 import jalview.schemes.ColourSchemeLoader;
54 import jalview.schemes.ColourSchemes;
55 import jalview.schemes.UserColourScheme;
56 import jalview.structure.StructureImportSettings;
57 import jalview.urls.IdOrgSettings;
58 import jalview.util.ColorUtils;
59 import jalview.ws.sifts.SiftsSettings;
62 * Stores and retrieves Jalview Application Properties Lists and fields within
63 * list entries are separated by '|' symbols unless otherwise stated (|) clauses
64 * are alternative values for a tag. <br>
66 * Current properties include:
69 * logs.Axis.Level - one of the stringified Levels for log4j controlling the
70 * logging level for axis (used for web services) <br>
72 * <li>logs.Castor.Level - one of the stringified Levels for log4j controlling
73 * the logging level for castor (used for serialization) <br>
75 * <li>logs.Jalview.Level - Cache.log stringified level. <br>
77 * <li>SCREEN_WIDTH</li>
78 * <li>SCREEN_HEIGHT</li>
79 * <li>SCREEN_Y=285</li>
80 * <li>SCREEN_X=371</li>
81 * <li>SHOW_FULLSCREEN boolean</li>
82 * <li>FONT_NAME java font name for alignment text display</li>
83 * <li>FONT_SIZE size of displayed alignment text</li>
84 * <li>FONT_STYLE style of font displayed (sequence labels are always
86 * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
87 * <li>LAST_DIRECTORY last directory for browsing alignment</li>
88 * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
89 * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
90 * <li>SHOW_IDENTITY show percentage identity annotation</li>
91 * <li>SHOW_QUALITY show alignment quality annotation</li>
92 * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
93 * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
94 * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
95 * LABEL_AND_SEQUENCE</li>
96 * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
97 * sequence annotations</li>
98 * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
100 * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
101 * <li>DEFAULT_FILE_FORMAT file format used to save</li>
102 * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
103 * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
104 * <li>VERSION the version of the jalview build</li>
105 * <li>BUILD_DATE date of this build</li>
106 * <li>LATEST_VERSION the latest jalview version advertised on the
107 * www.jalview.org</li>
108 * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
110 * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
111 * suffix to file</li>
112 * <li>RECENT_URL list of recently retrieved URLs</li>
113 * <li>RECENT_FILE list of recently opened files</li>
114 * <li>USE_PROXY flag for whether a http proxy is to be used</li>
115 * <li>PROXY_SERVER the proxy</li>
116 * <li>PROXY_PORT</li>
117 * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
119 * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
121 * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
122 * collecting usage statistics</li>
123 * <li>SHOW_OVERVIEW boolean for overview window display</li>
124 * <li>ANTI_ALIAS boolean for smooth fonts</li>
125 * <li>RIGHT_ALIGN_IDS boolean</li>
126 * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
127 * <li>PAD_GAPS boolean</li>
128 * <li>ID_ITALICS boolean</li>
129 * <li>SHOW_JV_SUFFIX</li>
130 * <li>WRAP_ALIGNMENT</li>
131 * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
133 * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
134 * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
136 * <li>STORED_LINKS list of name|url pairs which user has entered but are not
138 * <li>DEFAULT_LINK name of single url to be used when user double clicks a
139 * sequence id (must be in SEQUENCE_LINKS or STORED_LINKS)
140 * <li>GROUP_LINKS list of name|URL[|<separator>] tuples - see
141 * jalview.utils.GroupURLLink for more info</li>
142 * <li>DEFAULT_BROWSER for unix</li>
143 * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
145 * <li>VERSION_CHECK (true) check for the latest release version from
146 * www.jalview.org (or the alias given by the www.jalview.org property)</li>
147 * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
149 * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
151 * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
152 * displayed as '.'</li>
153 * <li>SORT_BY_TREE (false) sort the current alignment view according to the
154 * order of a newly displayed tree</li>
155 * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from
156 * sequence ID strings before attempting retrieval from any datasource</li>
157 * <li>SHOW_GROUP_CONSENSUS (false) Show consensus annotation for groups in the
159 * <li>SHOW_GROUP_CONSERVATION (false) Show conservation annotation for groups
160 * in the alignment.</li>
161 * <li>SHOW_CONSENSUS_HISTOGRAM (false) Show consensus annotation row's
163 * <li>SHOW_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
165 * <li>NORMALISE_CONSENSUS_LOGO (false) Show consensus annotation row's sequence
166 * logo normalised to row height rather than histogram height.</li>
167 * <li>FOLLOW_SELECTIONS (true) Controls whether a new alignment view should
168 * respond to selections made in other alignments containing the same sequences.
170 * <li>JWS2HOSTURLS comma-separated list of URLs to try for JABAWS services</li>
171 * <li>SHOW_WSDISCOVERY_ERRORS (true) Controls if the web service URL discovery
172 * warning dialog box is displayed.</li>
173 * <li>ANNOTATIONCOLOUR_MIN (orange) Shade used for minimum value of annotation
174 * when shading by annotation</li>
175 * <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation
176 * when shading by annotation</li>
177 * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP
178 * requests to be redirected to a mirror of http://www.jalview.org</li>
179 * <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported
180 * alignment figure to accommodate even the longest sequence ID or annotation
182 * <li>FIGURE_FIXEDIDWIDTH Specifies the width to use for the left-hand column
183 * when exporting an alignment as a figure (setting FIGURE_AUTOIDWIDTH to true
184 * will override this).</li>
185 * <li>STRUCT_FROM_PDB (false) derive secondary structure annotation from PDB
187 * <li>USE_RNAVIEW (false) use RNAViewer to derive secondary structure</li>
188 * <li>ADD_SS_ANN (false) add secondary structure annotation to alignment
190 * <li>ADD_TEMPFACT_ANN (false) add Temperature Factor annotation to alignment
192 * <li>STRUCTURE_DISPLAY choose from JMOL (default) or CHIMERA for 3D structure
194 * <li>CHIMERA_PATH specify full path to Chimera program (if non-standard)</li>
195 * <li>ID_ORG_HOSTURL location of jalview service providing identifiers.org urls
199 * Deprecated settings:
202 * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
203 * startup (JWS1 services only)</li>
204 * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
205 * (JWS1 services only)</li>
206 * <li>SHOW_JWS1_SERVICES (true) enable or disable the original Jalview 2
207 * services in the desktop GUI</li>
208 * <li>ENABLE_RSBS_EDITOR (false for 2.7 release) enable or disable RSBS editing
209 * panel in web service preferences</li>
213 * @version $Revision$
218 * property giving log4j level for CASTOR loggers
220 public static final String CASTORLOGLEVEL = "logs.Castor.level";
223 * property giving log4j level for AXIS loggers
225 public static final String AXISLOGLEVEL = "logs.Axis.level";
228 * property giving log4j level for Jalview Log
230 public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
235 public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
236 .getProperty("user.home") + File.separatorChar
237 + ".sifts_downloads" + File.separatorChar;
239 private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
241 private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
244 * Identifiers.org download settings
246 private static final String ID_ORG_FILE = System.getProperty("user.home")
247 + File.separatorChar + ".identifiers.org.ids.json";
250 * Allowed values are PDB or mmCIF
252 private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
255 private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
259 * a date formatter using a fixed (rather than the user's) locale;
260 * this ensures that date properties can be written and re-read successfully
261 * even if the user changes their locale setting
263 private static final DateFormat date_format = SimpleDateFormat
264 .getDateTimeInstance(SimpleDateFormat.MEDIUM,
265 SimpleDateFormat.MEDIUM, Locale.UK);
268 * Initialises the Jalview Application Log
270 public static Logger log;
272 /** Jalview Properties */
273 public static Properties applicationProperties = new Properties()
275 // override results in properties output in alphabetical order
277 public synchronized Enumeration<Object> keys()
279 return Collections.enumeration(new TreeSet<>(super.keySet()));
283 /** Default file is ~/.jalview_properties */
284 static String propertiesFile;
286 private static boolean propsAreReadOnly = false;
288 public static void initLogger()
296 // TODO: redirect stdout and stderr here in order to grab the output of
299 ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
301 ap.setName("JalviewLogger");
302 org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
304 Logger laxis = Logger.getLogger("org.apache.axis");
305 Logger lcastor = Logger.getLogger("org.exolab.castor");
306 jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
308 laxis.setLevel(Level.toLevel(
309 Cache.getDefault("logs.Axis.Level", Level.INFO.toString())));
310 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
311 Level.INFO.toString())));
312 lcastor = Logger.getLogger("org.exolab.castor.xml");
313 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
314 Level.INFO.toString())));
315 // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
316 // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
317 // Level.INFO.toString())));
318 // we shouldn't need to do this
319 org.apache.log4j.Logger.getRootLogger().setLevel(org.apache.log4j.Level.INFO);
321 jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
322 .getDefault("logs.Jalview.level", Level.INFO.toString())));
323 // laxis.addAppender(ap);
324 // lcastor.addAppender(ap);
325 // jalview.bin.Cache.log.addAppender(ap);
326 // Tell the user that debug is enabled
327 jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
328 } catch (Exception ex)
330 System.err.println("Problems initializing the log4j system\n");
331 ex.printStackTrace(System.err);
336 * Loads properties from the given properties file. Any existing properties
339 public static void loadProperties(String propsFile)
341 propertiesFile = propsFile;
342 if (propsFile == null)
344 propertiesFile = System.getProperty("user.home") + File.separatorChar
345 + ".jalview_properties";
349 // don't corrupt the file we've been given.
350 propsAreReadOnly = true;
358 fis = new java.net.URL(propertiesFile).openStream();
360 "Loading jalview properties from : " + propertiesFile);
362 "Disabling Jalview writing to user's local properties file.");
363 propsAreReadOnly = true;
365 } catch (Exception ex)
371 fis = new FileInputStream(propertiesFile);
373 applicationProperties.clear();
374 applicationProperties.load(fis);
376 // remove any old build properties
378 deleteBuildProperties();
380 } catch (Exception ex)
382 System.out.println("Error reading properties file: " + ex);
385 if (getDefault("USE_PROXY", false))
387 String proxyServer = getDefault("PROXY_SERVER", ""),
388 proxyPort = getDefault("PROXY_PORT", "8080");
390 System.out.println("Using proxyServer: " + proxyServer
391 + " proxyPort: " + proxyPort);
393 System.setProperty("http.proxyHost", proxyServer);
394 System.setProperty("http.proxyPort", proxyPort);
397 // LOAD THE AUTHORS FROM THE authors.props file
400 String authorDetails = "jar:"
401 .concat(Cache.class.getProtectionDomain().getCodeSource()
402 .getLocation().toString().concat("!/authors.props"));
404 java.net.URL localJarFileURL = new java.net.URL(authorDetails);
406 InputStream in = localJarFileURL.openStream();
407 applicationProperties.load(in);
409 } catch (Exception ex)
411 System.out.println("Error reading author details: " + ex);
412 applicationProperties.remove("AUTHORS");
413 applicationProperties.remove("AUTHORFNAMES");
414 applicationProperties.remove("YEAR");
417 loadBuildProperties(false);
420 .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
422 SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
423 .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
425 SiftsSettings.setFailSafePIDThreshold(
426 jalview.bin.Cache.getDefault("sifts_fail_safe_pid_threshold",
427 DEFAULT_FAIL_SAFE_PID_THRESHOLD));
429 SiftsSettings.setCacheThresholdInDays(
430 jalview.bin.Cache.getDefault("sifts_cache_threshold_in_days",
431 DEFAULT_CACHE_THRESHOLD_IN_DAYS));
433 IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
434 "http://www.jalview.org/services/identifiers"));
435 IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
437 StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
438 .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
439 StructureImportSettings
440 .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
441 // StructureImportSettings
442 // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
443 // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
445 String jnlpVersion = System.getProperty("jalview.version");
447 // jnlpVersion will be null if a latest version check for the channel needs
449 // Dont do this check if running in headless mode
451 if (jnlpVersion == null && getDefault("VERSION_CHECK", true)
452 && (System.getProperty("java.awt.headless") == null || System
453 .getProperty("java.awt.headless").equals("false")))
456 class VersionChecker extends Thread
461 String orgtimeout = System
462 .getProperty("sun.net.client.defaultConnectTimeout");
463 if (orgtimeout == null)
466 System.out.println("# INFO: Setting default net timeout to "
467 + orgtimeout + " seconds.");
469 String remoteVersion = null;
472 System.setProperty("sun.net.client.defaultConnectTimeout",
474 java.net.URL url = new java.net.URL(Cache
475 .getDefault("www.jalview.org", "http://www.jalview.org")
476 + "/webstart/jalview.jnlp");
477 BufferedReader in = new BufferedReader(
478 new InputStreamReader(url.openStream()));
480 while ((line = in.readLine()) != null)
482 if (line.indexOf("jalview.version") == -1)
487 line = line.substring(line.indexOf("value=") + 7);
488 line = line.substring(0, line.lastIndexOf("\""));
489 remoteVersion = line;
492 } catch (Exception ex)
495 "Non-fatal exception when checking version at www.jalview.org :");
496 System.out.println(ex);
497 remoteVersion = getProperty("VERSION");
499 System.setProperty("sun.net.client.defaultConnectTimeout",
502 setProperty("LATEST_VERSION", remoteVersion);
506 VersionChecker vc = new VersionChecker();
511 if (jnlpVersion != null)
513 setProperty("LATEST_VERSION", jnlpVersion);
517 applicationProperties.remove("LATEST_VERSION");
521 // LOAD USERDEFINED COLOURS
523 .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
524 jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
528 public static void loadBuildProperties(boolean reportVersion)
530 String codeInstallation = getProperty("INSTALLATION");
531 boolean printV = codeInstallation == null;
533 // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
536 String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
537 .getCodeSource().getLocation().toString()
538 .concat("!/.build_properties"));
540 java.net.URL localJarFileURL = new java.net.URL(buildDetails);
542 InputStream in = localJarFileURL.openStream();
543 applicationProperties.load(in);
545 } catch (Exception ex)
547 System.out.println("Error reading build details: " + ex);
548 applicationProperties.remove("VERSION");
550 String codeVersion = getProperty("VERSION");
551 codeInstallation = getProperty("INSTALLATION");
553 if (codeVersion == null)
555 // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
556 codeVersion = "Test";
557 codeInstallation = "";
561 codeInstallation = " (" + codeInstallation + ")";
563 setProperty("VERSION", codeVersion);
564 new BuildDetails(codeVersion, null, codeInstallation);
565 if (printV && reportVersion)
568 "Jalview Version: " + codeVersion + codeInstallation);
572 private static void deleteBuildProperties()
574 applicationProperties.remove("LATEST_VERSION");
575 applicationProperties.remove("VERSION");
576 applicationProperties.remove("AUTHORS");
577 applicationProperties.remove("AUTHORFNAMES");
578 applicationProperties.remove("YEAR");
579 applicationProperties.remove("BUILD_DATE");
580 applicationProperties.remove("INSTALLATION");
584 * Gets Jalview application property of given key. Returns null if key not
590 * @return Property value
592 public static String getProperty(String key)
594 return applicationProperties.getProperty(key);
598 * These methods are used when checking if the saved preference is different
599 * to the default setting
602 public static boolean getDefault(String property, boolean def)
604 String string = getProperty(property);
607 def = Boolean.valueOf(string).booleanValue();
613 public static int getDefault(String property, int def)
615 String string = getProperty(property);
620 def = Integer.parseInt(string);
621 } catch (NumberFormatException e)
623 System.out.println("Error parsing int property '" + property
624 + "' with value '" + string + "'");
632 * These methods are used when checking if the saved preference is different
633 * to the default setting
635 public static String getDefault(String property, String def)
637 String string = getProperty(property);
647 * Stores property in the file "HOME_DIR/.jalview_properties"
652 * String value of property
654 * @return previous value of property (or null)
656 public static Object setProperty(String key, String obj)
658 Object oldValue = null;
661 oldValue = applicationProperties.setProperty(key, obj);
662 if (propertiesFile != null && !propsAreReadOnly)
664 FileOutputStream out = new FileOutputStream(propertiesFile);
665 applicationProperties.store(out, "---JalviewX Properties File---");
668 } catch (Exception ex)
671 "Error setting property: " + key + " " + obj + "\n" + ex);
677 * remove the specified property from the jalview properties file
681 public static void removeProperty(String string)
683 applicationProperties.remove(string);
688 * save the properties to the jalview properties path
690 public static void saveProperties()
692 if (!propsAreReadOnly)
696 FileOutputStream out = new FileOutputStream(propertiesFile);
697 applicationProperties.store(out, "---JalviewX Properties File---");
699 } catch (Exception ex)
701 System.out.println("Error saving properties: " + ex);
707 * internal vamsas class discovery state
709 private static int vamsasJarsArePresent = -1;
712 * Searches for vamsas client classes on class path.
714 * @return true if vamsas client is present on classpath
716 public static boolean vamsasJarsPresent()
718 if (vamsasJarsArePresent == -1)
722 if (jalview.jbgui.GDesktop.class.getClassLoader()
723 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
725 jalview.bin.Cache.log.debug(
726 "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
727 vamsasJarsArePresent = 1;
728 Logger lvclient = Logger.getLogger("uk.ac.vamsas");
729 lvclient.setLevel(Level.toLevel(Cache
730 .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
732 lvclient.addAppender(log.getAppender("JalviewLogger"));
733 // Tell the user that debug is enabled
734 lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
736 } catch (Exception e)
738 vamsasJarsArePresent = 0;
739 jalview.bin.Cache.log.debug("Vamsas Classes are not present");
742 return (vamsasJarsArePresent > 0);
746 * internal vamsas class discovery state
748 private static int groovyJarsArePresent = -1;
751 * Searches for vamsas client classes on class path.
753 * @return true if vamsas client is present on classpath
755 public static boolean groovyJarsPresent()
757 if (groovyJarsArePresent == -1)
761 if (Cache.class.getClassLoader()
762 .loadClass("groovy.lang.GroovyObject") != null)
764 jalview.bin.Cache.log.debug(
765 "Found Groovy (groovy.lang.GroovyObject can be loaded)");
766 groovyJarsArePresent = 1;
767 Logger lgclient = Logger.getLogger("groovy");
768 lgclient.setLevel(Level.toLevel(Cache
769 .getDefault("logs.Groovy.Level", Level.INFO.toString())));
771 lgclient.addAppender(log.getAppender("JalviewLogger"));
772 // Tell the user that debug is enabled
773 lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
777 groovyJarsArePresent = 0;
778 jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
779 } catch (Exception e)
781 groovyJarsArePresent = 0;
782 jalview.bin.Cache.log.debug("Groovy Classes are not present");
785 return (groovyJarsArePresent > 0);
789 * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
792 protected static Object tracker = null;
794 protected static Class trackerfocus = null;
796 protected static Class jgoogleanalyticstracker = null;
799 * Initialise the google tracker if it is not done already.
801 public static void initGoogleTracker()
805 if (jgoogleanalyticstracker == null)
807 // try to get the tracker class
810 jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
811 "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
812 trackerfocus = Cache.class.getClassLoader()
813 .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
814 } catch (Exception e)
817 "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
819 jgoogleanalyticstracker = null;
824 // now initialise tracker
825 Exception re = null, ex = null;
827 String vrs = "No Version Accessible";
830 // Google analytics tracking code for Library Finder
831 tracker = jgoogleanalyticstracker
832 .getConstructor(new Class[]
833 { String.class, String.class, String.class })
834 .newInstance(new Object[]
836 (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
837 + jalview.bin.Cache.getDefault("BUILD_DATE",
840 jgoogleanalyticstracker
841 .getMethod("trackAsynchronously", new Class[]
843 .invoke(tracker, new Object[]
844 { trackerfocus.getConstructor(new Class[] { String.class })
845 .newInstance(new Object[]
846 { "Application Started." }) });
847 } catch (RuntimeException e)
850 } catch (Exception e)
857 if (re != null || ex != null || err != null)
863 log.debug("Caught runtime exception in googletracker init:",
869 "Failed to initialise GoogleTracker for Jalview Desktop with version "
876 "Whilst initing GoogleTracker for Jalview Desktop version "
886 "Debug: Caught runtime exception in googletracker init:"
888 re.printStackTrace();
893 "Warning: Failed to initialise GoogleTracker for Jalview Desktop with version "
895 ex.printStackTrace();
901 "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
903 err.printStackTrace();
909 log.debug("Successfully initialised tracker.");
915 * get the user's default colour if available
921 public static Color getDefaultColour(String property, Color defcolour)
923 String colprop = getProperty(property);
928 Color col = ColorUtils.parseColourString(colprop);
931 log.warn("Couldn't parse '" + colprop + "' as a colour for "
934 return (col == null) ? defcolour : col;
938 * store a colour as a Jalview user default property
943 public static void setColourProperty(String property, Color colour)
945 setProperty(property, jalview.util.Format.getHexString(colour));
949 * Stores a formatted date in a jalview property, using a fixed locale.
951 * @param propertyName
953 * @return the formatted date string
955 public static String setDateProperty(String propertyName, Date date)
957 String formatted = date_format.format(date);
958 setProperty(propertyName, formatted);
963 * Reads a date stored in a Jalview property, parses it (using a fixed locale
964 * format) and returns as a Date, or null if parsing fails
966 * @param propertyName
970 public static Date getDateProperty(String propertyName)
972 String val = getProperty(propertyName);
977 return date_format.parse(val);
978 } catch (Exception ex)
980 System.err.println("Invalid or corrupt date in property '"
981 + propertyName + "' : value was '" + val + "'");
988 * get and parse a property as an integer. send any parsing problems to
992 * @return null or Integer
994 public static Integer getIntegerProperty(String property)
996 String val = getProperty(property);
997 if (val != null && (val = val.trim()).length() > 0)
1001 return Integer.valueOf(val);
1002 } catch (NumberFormatException x)
1004 System.err.println("Invalid integer in property '" + property
1005 + "' (value was '" + val + "')");
1012 * Set the specified value, or remove it if null or empty. Does not save the
1018 public static void setOrRemove(String propName, String value)
1020 if (propName == null)
1024 if (value == null || value.trim().length() < 1)
1026 Cache.applicationProperties.remove(propName);
1030 Cache.applicationProperties.setProperty(propName, value);
1035 * Loads in user colour schemes from files.
1038 * a '|'-delimited list of file paths
1040 public static void initUserColourSchemes(String files)
1042 if (files == null || files.length() == 0)
1047 // In case colours can't be loaded, we'll remove them
1048 // from the default list here.
1049 StringBuffer coloursFound = new StringBuffer();
1050 StringTokenizer st = new StringTokenizer(files, "|");
1051 while (st.hasMoreElements())
1053 String file = st.nextToken();
1056 UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1059 if (coloursFound.length() > 0)
1061 coloursFound.append("|");
1063 coloursFound.append(file);
1064 ColourSchemes.getInstance().registerColourScheme(ucs);
1066 } catch (Exception ex)
1068 System.out.println("Error loading User ColourFile\n" + ex);
1071 if (!files.equals(coloursFound.toString()))
1073 if (coloursFound.toString().length() > 1)
1075 setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1076 coloursFound.toString());
1080 applicationProperties
1081 .remove(UserDefinedColours.USER_DEFINED_COLOURS);
1087 * Initial logging information helper for various versions output
1091 * @param defaultValue
1093 private static void appendIfNotNull(StringBuilder sb, String prefix,
1094 String value, String suffix, String defaultValue)
1096 if (value == null && defaultValue == null)
1100 String line = prefix + (value != null ? value : defaultValue) + suffix;
1106 * @return Jalview version, build details and JVM platform version for console
1108 public static String getVersionDetailsForConsole()
1110 StringBuilder sb = new StringBuilder();
1111 sb.append("Jalview Version: ");
1112 sb.append(jalview.bin.Cache.getDefault("VERSION", "TEST"));
1114 sb.append("Jalview Installation: ");
1115 sb.append(jalview.bin.Cache.getDefault("INSTALLATION", "unknown"));
1117 sb.append("Build Date: ");
1118 sb.append(jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"));
1120 sb.append("Java version: ");
1121 sb.append(System.getProperty("java.version"));
1123 sb.append(System.getProperty("os.arch"));
1125 sb.append(System.getProperty("os.name"));
1127 sb.append(System.getProperty("os.version"));
1129 appendIfNotNull(sb, "Install4j version: ",
1130 System.getProperty("sys.install4jVersion"), "\n", null);
1131 appendIfNotNull(sb, "Install4j template version: ",
1132 System.getProperty("installer_template_version"), "\n", null);
1133 appendIfNotNull(sb, "Launcher version: ",
1134 System.getProperty("launcher_version"), "\n", null);
1135 LookAndFeel laf = UIManager.getLookAndFeel();
1136 String lafName = laf == null ? "Not obtained" : laf.getName();
1137 String lafClass = laf == null ? "unknown" : laf.getClass().getName();
1138 sb.append("LookAndFeel: ");
1141 sb.append(lafClass);
1143 // Not displayed in release version ( determined by possible version number
1144 // regex 9[9.]*9[.-_a9]* )
1145 if (Pattern.matches("^\\d[\\d\\.]*\\d[\\.\\-\\w]*$",
1146 jalview.bin.Cache.getDefault("VERSION", "TEST")))
1148 appendIfNotNull(sb, "Getdown appdir: ",
1149 System.getProperty("getdownappdir"), "\n", null);
1150 appendIfNotNull(sb, "Java home: ", System.getProperty("java.home"),
1153 return sb.toString();
1158 * @return build details as reported in splashscreen
1160 public static String getBuildDetailsForSplash()
1162 // consider returning more human friendly info
1163 // eg 'built from Source' or update channel
1164 return jalview.bin.Cache.getDefault("INSTALLATION", "unknown");
1167 public static String getStackTraceString(Throwable t)
1169 StringWriter sw = new StringWriter();
1170 PrintWriter pw = new PrintWriter(sw);
1171 t.printStackTrace(pw);
1172 return sw.toString();