2 * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
3 * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 import org.apache.log4j.*;
25 import org.biojava.dasobert.dasregistry.Das1Source;
28 * Stores and retrieves Jalview Application Properties Lists and fields within
29 * list entries are separated by '|' symbols unless otherwise stated (|) clauses
30 * are alternative values for a tag. <br>
32 * Current properties include:
35 * logs.Axis.Level - one of the stringified Levels for log4j controlling the
36 * logging level for axis (used for web services) <br>
38 * <li>logs.Castor.Level - one of the stringified Levels for log4j controlling
39 * the logging level for castor (used for serialization) <br>
41 * <li>logs.Jalview.Level - Cache.log stringified level. <br>
43 * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
45 * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.</li>
46 * <li>SCREEN_WIDTH</li>
47 * <li>SCREEN_HEIGHT</li>
48 * <li>SCREEN_Y=285</li>
49 * <li>SCREEN_X=371</li>
50 * <li>SHOW_FULLSCREEN boolean</li>
51 * <li>FONT_NAME java font name for alignment text display</li>
52 * <li>FONT_SIZE size of displayed alignment text</li>
53 * <li>FONT_STYLE style of font displayed (sequence labels are always italic)</li>
54 * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
55 * <li>LAST_DIRECTORY last directory for browsing alignment</li>
56 * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
57 * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
58 * <li>SHOW_IDENTITY show percentage identity annotation</li>
59 * <li>SHOW_QUALITY show alignment quality annotation</li>
60 * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
61 * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
62 * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
64 * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
65 * <li>DEFAULT_FILE_FORMAT file format used to save</li>
66 * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
67 * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
68 * <li>VERSION the version of the jalview build</li>
69 * <li>BUILD_DATE date of this build</li>
70 * <li>LATEST_VERSION the latest jalview version advertised on the
71 * www.jalview.org</li>
72 * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
74 * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
76 * <li>RECENT_URL list of recently retrieved URLs</li>
77 * <li>RECENT_FILE list of recently opened files</li>
78 * <li>USE_PROXY flag for whether a http proxy is to be used</li>
79 * <li>PROXY_SERVER the proxy</li>
81 * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
83 * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
85 * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for collecting usage
87 * <li>DAS_LOCAL_SOURCE list of local das sources</li>
88 * <li>SHOW_OVERVIEW boolean for overview window display</li>
89 * <li>ANTI_ALIAS boolean for smooth fonts</li>
90 * <li>RIGHT_ALIGN_IDS boolean</li>
91 * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
92 * <li>PAD_GAPS boolean</li>
93 * <li>ID_ITALICS boolean</li>
94 * <li>SHOW_JV_SUFFIX</li>
95 * <li>WRAP_ALIGNMENT</li>
96 * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
98 * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
99 * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
101 * <li>DAS_REGISTRY_URL the registry to query</li>
102 * <li>DEFAULT_BROWSER for unix</li>
103 * <li>DAS_ACTIVE_SOURCE list of active sources</li>
104 * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
106 * <li>VERSION_CHECK (true) check for the latest release version from www.jalview.org</li>
107 * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
109 * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
111 * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
112 * displayed as '.'</li>
113 * <li>SORT_BY_TREE (false) sort the current alignment view according to the
114 * order of a newly displayed tree</li>
115 * <li>DBFETCH_USEPICR (false) use PICR to recover valid DB references from sequence ID strings before attempting retrieval from any datasource</li>
124 * @version $Revision$
129 * property giving log4j level for CASTOR loggers
131 public static final String CASTORLOGLEVEL = "logs.Castor.level";
134 * property giving log4j level for AXIS loggers
136 public static final String AXISLOGLEVEL = "logs.Axis.level";
139 * property giving log4j level for Jalview Log
141 public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
143 public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
145 public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
147 public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
150 * Initialises the Jalview Application Log
152 public static Logger log;
154 /** Jalview Properties */
155 public static Properties applicationProperties = new Properties();
157 /** Default file is ~/.jalview_properties */
158 static String propertiesFile;
160 public static void initLogger()
164 // TODO: redirect stdout and stderr here in order to grab the output of the log
166 ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
168 ap.setName("JalviewLogger");
169 org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
171 Logger laxis = Logger.getLogger("org.apache.axis");
172 Logger lcastor = Logger.getLogger("org.exolab.castor");
173 jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
175 laxis.setLevel(Level.toLevel(Cache.getDefault("logs.Axis.Level",
176 Level.INFO.toString())));
177 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
178 Level.INFO.toString())));
179 lcastor = Logger.getLogger("org.exolab.castor.xml");
180 lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
181 Level.INFO.toString())));
182 // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
183 // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
184 // Level.INFO.toString())));
185 jalview.bin.Cache.log.setLevel(Level.toLevel(Cache.getDefault(
186 "logs.Jalview.level", Level.INFO.toString())));
187 // laxis.addAppender(ap);
188 // lcastor.addAppender(ap);
189 // jalview.bin.Cache.log.addAppender(ap);
190 // Tell the user that debug is enabled
191 jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
192 } catch (Exception ex)
194 System.err.println("Problems initializing the log4j system\n");
195 ex.printStackTrace(System.err);
199 /** Called when Jalview is started */
200 public static void loadProperties(String propsFile)
202 propertiesFile = propsFile;
203 if (propsFile == null)
205 propertiesFile = System.getProperty("user.home") + File.separatorChar
206 + ".jalview_properties";
211 FileInputStream fis = new FileInputStream(propertiesFile);
212 applicationProperties.load(fis);
213 applicationProperties.remove("LATEST_VERSION");
214 applicationProperties.remove("VERSION");
216 } catch (Exception ex)
218 System.out.println("Error reading properties file: " + ex);
221 if (getDefault("USE_PROXY", false))
223 System.out.println("Using proxyServer: "
224 + getDefault("PROXY_SERVER", null) + " proxyPort: "
225 + getDefault("PROXY_PORT", null));
227 .setProperty("http.proxyHost", getDefault("PROXY_SERVER",
229 System.setProperty("http.proxyPort", getDefault("PROXY_PORT", null));
232 // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
233 // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
234 // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
237 String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
238 .getCodeSource().getLocation().toString().concat(
239 "!/.build_properties"));
241 java.net.URL localJarFileURL = new java.net.URL(buildDetails);
243 InputStream in = localJarFileURL.openStream();
244 applicationProperties.load(in);
246 } catch (Exception ex)
248 System.out.println("Error reading build details: " + ex);
249 applicationProperties.remove("VERSION");
252 String jnlpVersion = System.getProperty("jalview.version");
253 String codeVersion = getProperty("VERSION");
255 if (codeVersion == null)
257 // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
258 codeVersion = "Test";
259 jnlpVersion = "Test";
262 System.out.println("Jalview Version: " + codeVersion);
264 // jnlpVersion will be null if we're using InstallAnywhere
265 // Dont do this check if running in headless mode
266 if (jnlpVersion == null
267 && getDefault("VERSION_CHECK",true)
268 && (System.getProperty("java.awt.headless") == null || System
269 .getProperty("java.awt.headless").equals("false")))
272 class VersionChecker extends Thread
276 String orgtimeout = System
277 .getProperty("sun.net.client.defaultConnectTimeout");
278 if (orgtimeout == null)
281 System.out.println("# INFO: Setting default net timeout to "
282 + orgtimeout + " seconds.");
284 String jnlpVersion = null;
287 System.setProperty("sun.net.client.defaultConnectTimeout",
289 java.net.URL url = new java.net.URL(
290 "http://www.jalview.org/webstart/jalview.jnlp");
291 BufferedReader in = new BufferedReader(new InputStreamReader(
294 while ((line = in.readLine()) != null)
296 if (line.indexOf("jalview.version") == -1)
301 line = line.substring(line.indexOf("value=") + 7);
302 line = line.substring(0, line.lastIndexOf("\""));
306 } catch (Exception ex)
309 .println("Non-fatal exceptions when checking version at www.jalview.org :");
310 System.out.println(ex);
311 jnlpVersion = getProperty("VERSION");
313 System.setProperty("sun.net.client.defaultConnectTimeout",
316 setProperty("LATEST_VERSION", jnlpVersion);
320 VersionChecker vc = new VersionChecker();
325 if (jnlpVersion != null)
327 setProperty("LATEST_VERSION", jnlpVersion);
331 applicationProperties.remove("LATEST_VERSION");
335 setProperty("VERSION", codeVersion);
337 // LOAD USERDEFINED COLOURS
338 jalview.gui.UserDefinedColours
339 .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
340 jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
345 * Gets Jalview application property of given key. Returns null if key not
351 * @return Property value
353 public static String getProperty(String key)
355 return applicationProperties.getProperty(key);
359 * These methods are used when checking if the saved preference is different
360 * to the default setting
363 public static boolean getDefault(String property, boolean def)
365 String string = getProperty(property);
368 def = Boolean.valueOf(string).booleanValue();
375 * These methods are used when checking if the saved preference is different
376 * to the default setting
378 public static String getDefault(String property, String def)
380 String string = getProperty(property);
390 * Stores property in the file "HOME_DIR/.jalview_properties"
395 * String value of property
397 * @return String value of property
399 public static String setProperty(String key, String obj)
403 FileOutputStream out = new FileOutputStream(propertiesFile);
404 applicationProperties.setProperty(key, obj);
405 applicationProperties.store(out, "---JalviewX Properties File---");
407 } catch (Exception ex)
409 System.out.println("Error setting property: " + key + " " + obj
415 * remove the specified property from the jalview properties file
418 public static void removeProperty(String string)
420 applicationProperties.remove(string);
424 * save the properties to the jalview properties path
426 public static void saveProperties()
430 FileOutputStream out = new FileOutputStream(propertiesFile);
431 applicationProperties.store(out, "---JalviewX Properties File---");
433 } catch (Exception ex)
435 System.out.println("Error saving properties: " + ex);
440 * internal vamsas class discovery state
442 private static int vamsasJarsArePresent = -1;
445 * Searches for vamsas client classes on class path.
447 * @return true if vamsas client is present on classpath
449 public static boolean vamsasJarsPresent()
451 if (vamsasJarsArePresent == -1)
455 if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
456 "uk.ac.vamsas.client.VorbaId") != null)
458 jalview.bin.Cache.log
459 .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
460 vamsasJarsArePresent = 1;
461 Logger lvclient = Logger.getLogger("uk.ac.vamsas");
462 lvclient.setLevel(Level.toLevel(Cache.getDefault(
463 "logs.Vamsas.Level", Level.INFO.toString())));
465 lvclient.addAppender(log.getAppender("JalviewLogger"));
466 // Tell the user that debug is enabled
467 lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
469 } catch (Exception e)
471 vamsasJarsArePresent = 0;
472 jalview.bin.Cache.log.debug("Vamsas Classes are not present");
475 return (vamsasJarsArePresent > 0);
479 * internal vamsas class discovery state
481 private static int groovyJarsArePresent = -1;
484 * Searches for vamsas client classes on class path.
486 * @return true if vamsas client is present on classpath
488 public static boolean groovyJarsPresent()
490 if (groovyJarsArePresent == -1)
494 if (Cache.class.getClassLoader().loadClass(
495 "groovy.lang.GroovyObject") != null)
497 jalview.bin.Cache.log
498 .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
499 groovyJarsArePresent = 1;
500 Logger lgclient = Logger.getLogger("groovy");
501 lgclient.setLevel(Level.toLevel(Cache.getDefault(
502 "logs.Groovy.Level", Level.INFO.toString())));
504 lgclient.addAppender(log.getAppender("JalviewLogger"));
505 // Tell the user that debug is enabled
506 lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
509 groovyJarsArePresent = 0;
510 jalview.bin.Cache.log.debug("Groovy Classes are not present",e);
513 groovyJarsArePresent = 0;
514 jalview.bin.Cache.log.debug("Groovy Classes are not present");
517 return (groovyJarsArePresent > 0);
520 * generate Das1Sources from the local das source list
522 * @return Vector of Das1Sources
524 public static Vector getLocalDasSources()
526 Vector localSources = new Vector();
527 String local = jalview.bin.Cache.getProperty("DAS_LOCAL_SOURCE");
530 StringTokenizer st = new StringTokenizer(local, "\t");
531 while (st.hasMoreTokens())
533 String token = st.nextToken();
534 int bar = token.indexOf("|");
535 Das1Source source = new Das1Source();
536 source.setUrl(token.substring(bar + 1));
537 if (source.getUrl().startsWith("sequence:"))
539 source.setUrl(source.getUrl().substring(9));
540 // this source also serves sequences as well as features
541 source.setCapabilities(new String[]
542 { "sequence", "features" });
546 // default is that all user added sources serve features
547 source.setCapabilities(new String[]
551 source.setNickname(token.substring(0, bar));
553 localSources.addElement(source);
560 * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not enabled.
562 protected static Object tracker = null;
563 protected static Class trackerfocus = null;
564 protected static Class jgoogleanalyticstracker = null;
567 * Initialise the google tracker if it is not done already.
569 public static void initGoogleTracker()
573 if (jgoogleanalyticstracker==null)
575 // try to get the tracker class
577 jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
578 "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
579 trackerfocus = Cache.class.getClassLoader().loadClass(
580 "com.boxysystems.jgoogleanalytics.FocusPoint");
581 } catch (Exception e)
583 log.debug("com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
585 jgoogleanalyticstracker=null;
590 // now initialise tracker
591 Exception re = null, ex = null;
593 String vrs = "No Version Accessible";
596 // Google analytics tracking code for Library Finder
597 tracker = jgoogleanalyticstracker.getConstructor(new Class[] { String.class,String.class,String.class}).newInstance(new Object[] { "Jalview Desktop",
598 (vrs = jalview.bin.Cache.getProperty("VERSION")
600 + jalview.bin.Cache.getDefault("BUILD_DATE",
601 "unknown")), "UA-9060947-1"});
602 jgoogleanalyticstracker.getMethod("trackAsynchronously", new Class[] { trackerfocus })
603 .invoke(tracker, new Object[] { trackerfocus.getConstructor(
604 new Class[] { String.class}).newInstance(new Object[] { "Application Started." })});
605 } catch (RuntimeException e)
608 } catch (Exception e)
615 if (re != null || ex != null || err != null)
622 "Caught runtime exception in googletracker init:",
626 "Failed to initialise GoogleTracker for Jalview Desktop with version "
630 "Whilst initing GoogleTracker for Jalview Desktop version "
638 .println("Debug: Caught runtime exception in googletracker init:"
640 re.printStackTrace();
645 .println("Warning: Failed to initialise GoogleTracker for Jalview Desktop with version "
647 ex.printStackTrace();
653 .println("ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
655 err.printStackTrace();
661 log.debug("Successfully initialised tracker.");