src/jalview/bin/Cache.java

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