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