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