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 italic)</li>
  81  * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
  82  * <li>LAST_DIRECTORY last directory for browsing alignment</li>
  83  * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
  84  * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
  85  * <li>SHOW_IDENTITY show percentage identity annotation</li>
  86  * <li>SHOW_QUALITY show alignment quality annotation</li>
  87  * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
  88  * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
  89  * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
  90  * LABEL_AND_SEQUENCE</li>
  91  * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
  92  * sequence annotations</li>
  93  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  94  * annotation row</li>
  95  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
  96  * <li>DEFAULT_FILE_FORMAT file format used to save</li>
  97  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
  98  * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
  99  * <li>VERSION the version of the jalview build</li>
 100  * <li>BUILD_DATE date of this build</li>
 101  * <li>LATEST_VERSION the latest jalview version advertised on the
 102  * www.jalview.org</li>
 103  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
 104  * descriptions</li>
 105  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
 106  * suffix to file</li>
 107  * <li>RECENT_URL list of recently retrieved URLs</li>
 108  * <li>RECENT_FILE list of recently opened files</li>
 109  * <li>USE_PROXY flag for whether a http proxy is to be used</li>
 110  * <li>PROXY_SERVER the proxy</li>
 111  * <li>PROXY_PORT</li>
 112  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
 113  * service</li>
 114  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
 115  * service</li>
 116  * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
 117  * collecting usage statistics</li>
 118  * <li>DAS_LOCAL_SOURCE list of local das sources</li>
 119  * <li>SHOW_OVERVIEW boolean for overview window display</li>
 120  * <li>ANTI_ALIAS boolean for smooth fonts</li>
 121  * <li>RIGHT_ALIGN_IDS boolean</li>
 122  * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
 123  * <li>PAD_GAPS boolean</li>
 124  * <li>ID_ITALICS boolean</li>
 125  * <li>SHOW_JV_SUFFIX</li>
 126  * <li>WRAP_ALIGNMENT</li>
 127  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
 128  * style check</li>
 129  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
 130  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
 131  * $SEQUENCE_ID$</li>
 132  * <li>STORED_LINKS list of name|url pairs which user has entered but are not
 133  * currently used
 134  * <li>DEFAULT_LINK name of single url to be used when user double clicks a
 135  * sequence id (must be in SEQUENCE_LINKS or STORED_LINKS)
 136  * <li>GROUP_LINKS list of name|URL[|&lt;separator&gt;] tuples - see
 137  * jalview.utils.GroupURLLink for more info</li>
 138  * <li>DAS_REGISTRY_URL the registry to query</li>
 139  * <li>DEFAULT_BROWSER for unix</li>
 140  * <li>DAS_ACTIVE_SOURCE list of active sources</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   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 231
 232   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 233
 234   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 235
 236   /**
 237    * Sifts settings
 238    */
 239   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 240           .getProperty("user.home")
 241           + 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(Cache.getDefault("logs.Axis.Level",
 314               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.getDefault(
 324               "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("Loading jalview properties from : "
 359                 + propertiesFile);
 360         System.out
 361                 .println("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", ""), proxyPort = getDefault(
 386               "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:".concat(Cache.class
 399               .getProtectionDomain().getCodeSource().getLocation()
 400               .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.getDefault(
 455             "sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 456
 457     SiftsSettings.setFailSafePIDThreshold(jalview.bin.Cache.getDefault(
 458             "sifts_fail_safe_pid_threshold",
 459             DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 460
 461     SiftsSettings.setCacheThresholdInDays(jalview.bin.Cache.getDefault(
 462             "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
 482             && getDefault("VERSION_CHECK", true)
 483             && (System.getProperty("java.awt.headless") == null || System
 484                     .getProperty("java.awt.headless").equals("false")))
 485     {
 486
 487       class VersionChecker extends Thread
 488       {
 489         @Override
 490         public void run()
 491         {
 492           String orgtimeout = System
 493                   .getProperty("sun.net.client.defaultConnectTimeout");
 494           if (orgtimeout == null)
 495           {
 496             orgtimeout = "30";
 497             System.out.println("# INFO: Setting default net timeout to "
 498                     + orgtimeout + " seconds.");
 499           }
 500           String remoteVersion = null;
 501           try
 502           {
 503             System.setProperty("sun.net.client.defaultConnectTimeout",
 504                     "5000");
 505             java.net.URL url = new java.net.URL(Cache.getDefault(
 506                     "www.jalview.org", "http://www.jalview.org")
 507                     + "/webstart/jalview.jnlp");
 508             BufferedReader in = new BufferedReader(new InputStreamReader(
 509                     url.openStream()));
 510             String line = null;
 511             while ((line = in.readLine()) != null)
 512             {
 513               if (line.indexOf("jalview.version") == -1)
 514               {
 515                 continue;
 516               }
 517
 518               line = line.substring(line.indexOf("value=") + 7);
 519               line = line.substring(0, line.lastIndexOf("\""));
 520               remoteVersion = line;
 521               break;
 522             }
 523           } catch (Exception ex)
 524           {
 525             System.out
 526                     .println("Non-fatal exception when checking version at www.jalview.org :");
 527             System.out.println(ex);
 528             remoteVersion = getProperty("VERSION");
 529           }
 530           System.setProperty("sun.net.client.defaultConnectTimeout",
 531                   orgtimeout);
 532
 533           setProperty("LATEST_VERSION", remoteVersion);
 534         }
 535       }
 536
 537       VersionChecker vc = new VersionChecker();
 538       vc.start();
 539     }
 540     else
 541     {
 542       if (jnlpVersion != null)
 543       {
 544         setProperty("LATEST_VERSION", jnlpVersion);
 545       }
 546       else
 547       {
 548         applicationProperties.remove("LATEST_VERSION");
 549       }
 550     }
 551
 552     setProperty("VERSION", codeVersion);
 553
 554     // LOAD USERDEFINED COLOURS
 555     jalview.bin.Cache
 556             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 557     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 558             false);
 559   }
 560
 561   private static void deleteBuildProperties()
 562   {
 563     applicationProperties.remove("LATEST_VERSION");
 564     applicationProperties.remove("VERSION");
 565     applicationProperties.remove("AUTHORS");
 566     applicationProperties.remove("AUTHORFNAMES");
 567     applicationProperties.remove("YEAR");
 568     applicationProperties.remove("BUILD_DATE");
 569     applicationProperties.remove("INSTALLATION");
 570   }
 571
 572   /**
 573    * Gets Jalview application property of given key. Returns null if key not
 574    * found
 575    *
 576    * @param key
 577    *          Name of property
 578    *
 579    * @return Property value
 580    */
 581   public static String getProperty(String key)
 582   {
 583     return applicationProperties.getProperty(key);
 584   }
 585
 586   /**
 587    * These methods are used when checking if the saved preference is different
 588    * to the default setting
 589    */
 590
 591   public static boolean getDefault(String property, boolean def)
 592   {
 593     String string = getProperty(property);
 594     if (string != null)
 595     {
 596       def = Boolean.valueOf(string).booleanValue();
 597     }
 598
 599     return def;
 600   }
 601
 602   /**
 603    * These methods are used when checking if the saved preference is different
 604    * to the default setting
 605    */
 606   public static String getDefault(String property, String def)
 607   {
 608     String string = getProperty(property);
 609     if (string != null)
 610     {
 611       return string;
 612     }
 613
 614     return def;
 615   }
 616
 617   /**
 618    * Stores property in the file "HOME_DIR/.jalview_properties"
 619    *
 620    * @param key
 621    *          Name of object
 622    * @param obj
 623    *          String value of property
 624    *
 625    * @return String value of property
 626    */
 627   public static String setProperty(String key, String obj)
 628   {
 629
 630     try
 631     {
 632       applicationProperties.setProperty(key, obj);
 633       if (!propsAreReadOnly)
 634       {
 635         FileOutputStream out = new FileOutputStream(propertiesFile);
 636         applicationProperties.store(out, "---JalviewX Properties File---");
 637         out.close();
 638       }
 639     } catch (Exception ex)
 640     {
 641       System.out.println("Error setting property: " + key + " " + obj
 642               + "\n" + ex);
 643     }
 644     return obj;
 645   }
 646
 647   /**
 648    * remove the specified property from the jalview properties file
 649    *
 650    * @param string
 651    */
 652   public static void removeProperty(String string)
 653   {
 654     applicationProperties.remove(string);
 655     saveProperties();
 656   }
 657
 658   /**
 659    * save the properties to the jalview properties path
 660    */
 661   public static void saveProperties()
 662   {
 663     if (!propsAreReadOnly)
 664     {
 665       try
 666       {
 667         FileOutputStream out = new FileOutputStream(propertiesFile);
 668         applicationProperties.store(out, "---JalviewX Properties File---");
 669         out.close();
 670       } catch (Exception ex)
 671       {
 672         System.out.println("Error saving properties: " + ex);
 673       }
 674     }
 675   }
 676
 677   /**
 678    * internal vamsas class discovery state
 679    */
 680   private static int vamsasJarsArePresent = -1;
 681
 682   /**
 683    * Searches for vamsas client classes on class path.
 684    *
 685    * @return true if vamsas client is present on classpath
 686    */
 687   public static boolean vamsasJarsPresent()
 688   {
 689     if (vamsasJarsArePresent == -1)
 690     {
 691       try
 692       {
 693         if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
 694                 "uk.ac.vamsas.client.VorbaId") != null)
 695         {
 696           jalview.bin.Cache.log
 697                   .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 698           vamsasJarsArePresent = 1;
 699           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 700           lvclient.setLevel(Level.toLevel(Cache.getDefault(
 701                   "logs.Vamsas.Level", Level.INFO.toString())));
 702
 703           lvclient.addAppender(log.getAppender("JalviewLogger"));
 704           // Tell the user that debug is enabled
 705           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 706         }
 707       } catch (Exception e)
 708       {
 709         vamsasJarsArePresent = 0;
 710         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 711       }
 712     }
 713     return (vamsasJarsArePresent > 0);
 714   }
 715
 716   /**
 717    * internal vamsas class discovery state
 718    */
 719   private static int groovyJarsArePresent = -1;
 720
 721   /**
 722    * Searches for vamsas client classes on class path.
 723    *
 724    * @return true if vamsas client is present on classpath
 725    */
 726   public static boolean groovyJarsPresent()
 727   {
 728     if (groovyJarsArePresent == -1)
 729     {
 730       try
 731       {
 732         if (Cache.class.getClassLoader().loadClass(
 733                 "groovy.lang.GroovyObject") != null)
 734         {
 735           jalview.bin.Cache.log
 736                   .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
 737           groovyJarsArePresent = 1;
 738           Logger lgclient = Logger.getLogger("groovy");
 739           lgclient.setLevel(Level.toLevel(Cache.getDefault(
 740                   "logs.Groovy.Level", Level.INFO.toString())));
 741
 742           lgclient.addAppender(log.getAppender("JalviewLogger"));
 743           // Tell the user that debug is enabled
 744           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 745         }
 746       } catch (Error e)
 747       {
 748         groovyJarsArePresent = 0;
 749         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 750       } catch (Exception e)
 751       {
 752         groovyJarsArePresent = 0;
 753         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 754       }
 755     }
 756     return (groovyJarsArePresent > 0);
 757   }
 758
 759   /**
 760    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 761    * enabled.
 762    */
 763   protected static Object tracker = null;
 764
 765   protected static Class trackerfocus = null;
 766
 767   protected static Class jgoogleanalyticstracker = null;
 768
 769   /**
 770    * Initialise the google tracker if it is not done already.
 771    */
 772   public static void initGoogleTracker()
 773   {
 774     if (tracker == null)
 775     {
 776       if (jgoogleanalyticstracker == null)
 777       {
 778         // try to get the tracker class
 779         try
 780         {
 781           jgoogleanalyticstracker = Cache.class
 782                   .getClassLoader()
 783                   .loadClass(
 784                           "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 785           trackerfocus = Cache.class.getClassLoader().loadClass(
 786                   "com.boxysystems.jgoogleanalytics.FocusPoint");
 787         } catch (Exception e)
 788         {
 789           log.debug("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.getConstructor(
 804                 new Class[] { String.class, String.class, String.class })
 805                 .newInstance(
 806                         new Object[] {
 807                             "Jalview Desktop",
 808                             (vrs = jalview.bin.Cache.getProperty("VERSION")
 809                                     + "_"
 810                                     + jalview.bin.Cache.getDefault(
 811                                             "BUILD_DATE", "unknown")),
 812                             "UA-9060947-1" });
 813         jgoogleanalyticstracker.getMethod("trackAsynchronously",
 814                 new Class[] { trackerfocus }).invoke(
 815                 tracker,
 816                 new Object[] { trackerfocus.getConstructor(
 817                         new Class[] { String.class }).newInstance(
 818                         new Object[] { "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:", re);
 836           }
 837           if (ex != null)
 838           {
 839             log.warn(
 840                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 841                             + vrs, ex);
 842           }
 843           if (err != null)
 844           {
 845             log.error(
 846                     "Whilst initing GoogleTracker for Jalview Desktop version "
 847                             + vrs, err);
 848           }
 849         }
 850         else
 851         {
 852           if (re != null)
 853           {
 854             System.err
 855                     .println("Debug: Caught runtime exception in googletracker init:"
 856                             + vrs);
 857             re.printStackTrace();
 858           }
 859           if (ex != null)
 860           {
 861             System.err
 862                     .println("Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 863                             + vrs);
 864             ex.printStackTrace();
 865           }
 866
 867           if (err != null)
 868           {
 869             System.err
 870                     .println("ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 871                             + vrs);
 872             err.printStackTrace();
 873           }
 874         }
 875       }
 876       else
 877       {
 878         log.debug("Successfully initialised tracker.");
 879       }
 880     }
 881   }
 882
 883   /**
 884    * get the user's default colour if available
 885    *
 886    * @param property
 887    * @param defcolour
 888    * @return
 889    */
 890   public static Color getDefaultColour(String property, Color defcolour)
 891   {
 892     String colprop = getProperty(property);
 893     if (colprop == null)
 894     {
 895       return defcolour;
 896     }
 897     Color col = ColorUtils.parseColourString(colprop);
 898     if (col == null)
 899     {
 900       log.warn("Couldn't parse '" + colprop + "' as a colour for "
 901               + property);
 902     }
 903     return (col == null) ? defcolour : col;
 904   }
 905
 906   /**
 907    * store a colour as a Jalview user default property
 908    *
 909    * @param property
 910    * @param colour
 911    */
 912   public static void setColourProperty(String property, Color colour)
 913   {
 914     setProperty(property, jalview.util.Format.getHexString(colour));
 915   }
 916
 917   /**
 918    * Stores a formatted date in a jalview property, using a fixed locale.
 919    *
 920    * @param propertyName
 921    * @param date
 922    * @return the formatted date string
 923    */
 924   public static String setDateProperty(String propertyName, Date date)
 925   {
 926     String formatted = date_format.format(date);
 927     setProperty(propertyName, formatted);
 928     return formatted;
 929   }
 930
 931   /**
 932    * Reads a date stored in a Jalview property, parses it (using a fixed locale
 933    * format) and returns as a Date, or null if parsing fails
 934    *
 935    * @param propertyName
 936    * @return
 937    *
 938    */
 939   public static Date getDateProperty(String propertyName)
 940   {
 941     String val = getProperty(propertyName);
 942     if (val != null)
 943     {
 944       try
 945       {
 946         return date_format.parse(val);
 947       } catch (Exception ex)
 948       {
 949         System.err.println("Invalid or corrupt date in property '"
 950                 + propertyName + "' : value was '" + val + "'");
 951       }
 952     }
 953     return null;
 954   }
 955
 956   /**
 957    * get and parse a property as an integer. send any parsing problems to
 958    * System.err
 959    *
 960    * @param property
 961    * @return null or Integer
 962    */
 963   public static Integer getIntegerProperty(String property)
 964   {
 965     String val = getProperty(property);
 966     if (val != null && (val = val.trim()).length() > 0)
 967     {
 968       try
 969       {
 970         return Integer.valueOf(val);
 971       } catch (NumberFormatException x)
 972       {
 973         System.err.println("Invalid integer in property '" + property
 974                 + "' (value was '" + val + "')");
 975       }
 976     }
 977     return null;
 978   }
 979
 980   private static DasSourceRegistryI sourceRegistry = null;
 981
 982   /**
 983    * initialise and ..
 984    *
 985    * @return instance of the das source registry
 986    */
 987   public static DasSourceRegistryI getDasSourceRegistry()
 988   {
 989     if (sourceRegistry == null)
 990     {
 991       sourceRegistry = new DasSourceRegistry();
 992     }
 993     return sourceRegistry;
 994   }
 995
 996   /**
 997    * Set the specified value, or remove it if null or empty. Does not save the
 998    * properties file.
 999    *
1000    * @param propName
1001    * @param value
1002    */
1003   public static void setOrRemove(String propName, String value)
1004   {
1005     if (propName == null)
1006     {
1007       return;
1008     }
1009     if (value == null || value.trim().length() < 1)
1010     {
1011       Cache.applicationProperties.remove(propName);
1012     }
1013     else
1014     {
1015       Cache.applicationProperties.setProperty(propName, value);
1016     }
1017   }
1018
1019   /**
1020    * Loads in user colour schemes from files.
1021    *
1022    * @param files
1023    *          a '|'-delimited list of file paths
1024    */
1025   public static void initUserColourSchemes(String files)
1026   {
1027     if (files == null || files.length() == 0)
1028     {
1029       return;
1030     }
1031
1032     // In case colours can't be loaded, we'll remove them
1033     // from the default list here.
1034     StringBuffer coloursFound = new StringBuffer();
1035     StringTokenizer st = new StringTokenizer(files, "|");
1036     while (st.hasMoreElements())
1037     {
1038       String file = st.nextToken();
1039       try
1040       {
1041         UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1042         if (ucs != null)
1043         {
1044           if (coloursFound.length() > 0)
1045           {
1046             coloursFound.append("|");
1047           }
1048           coloursFound.append(file);
1049           ColourSchemes.getInstance().registerColourScheme(ucs);
1050         }
1051       } catch (Exception ex)
1052       {
1053         System.out.println("Error loading User ColourFile\n" + ex);
1054       }
1055     }
1056     if (!files.equals(coloursFound.toString()))
1057     {
1058       if (coloursFound.toString().length() > 1)
1059       {
1060         setProperty(UserDefinedColours.USER_DEFINED_COLOURS, coloursFound.toString());
1061       }
1062       else
1063       {
1064         applicationProperties.remove(UserDefinedColours.USER_DEFINED_COLOURS);
1065       }
1066     }
1067   }
1068 }