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.HashMap;
  46 import java.util.Locale;
  47 import java.util.Map;
  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>SHOW_OCCUPANCY show alignment column ungapped count annotation</li>
  91  * <li>SORT_ANNOTATIONS currently either SEQUENCE_AND_LABEL or
  92  * LABEL_AND_SEQUENCE</li>
  93  * <li>SHOW_AUTOCALC_ABOVE true to show autocalculated annotations above
  94  * sequence annotations</li>
  95  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  96  * annotation row</li>
  97  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
  98  * <li>DEFAULT_FILE_FORMAT file format used to save</li>
  99  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
 100  * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
 101  * <li>VERSION the version of the jalview build</li>
 102  * <li>BUILD_DATE date of this build</li>
 103  * <li>LATEST_VERSION the latest jalview version advertised on the
 104  * www.jalview.org</li>
 105  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
 106  * descriptions</li>
 107  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
 108  * suffix to file</li>
 109  * <li>RECENT_URL list of recently retrieved URLs</li>
 110  * <li>RECENT_FILE list of recently opened files</li>
 111  * <li>USE_PROXY flag for whether a http proxy is to be used</li>
 112  * <li>PROXY_SERVER the proxy</li>
 113  * <li>PROXY_PORT</li>
 114  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
 115  * service</li>
 116  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
 117  * service</li>
 118  * <li>USAGESTATS (false - user prompted) Enable google analytics tracker for
 119  * collecting usage statistics</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>DEFAULT_BROWSER for unix</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   /**
 230    * Sifts settings
 231    */
 232   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
 233           .getProperty("user.home") + File.separatorChar
 234           + ".sifts_downloads" + File.separatorChar;
 235
 236   private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
 237
 238   private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
 239
 240   /**
 241    * Identifiers.org download settings
 242    */
 243   private static final String ID_ORG_FILE = System.getProperty("user.home")
 244           + File.separatorChar + ".identifiers.org.ids.json";
 245
 246   /**
 247    * Allowed values are PDB or mmCIF
 248    */
 249   private final static String PDB_DOWNLOAD_FORMAT = PDBEntry.Type.MMCIF
 250           .toString();
 251
 252   private final static String DEFAULT_PDB_FILE_PARSER = StructureImportSettings.StructureParser.JMOL_PARSER
 253           .toString();
 254
 255   /*
 256    * a date formatter using a fixed (rather than the user's) locale;
 257    * this ensures that date properties can be written and re-read successfully
 258    * even if the user changes their locale setting
 259    */
 260   private static final DateFormat date_format = SimpleDateFormat
 261           .getDateTimeInstance(SimpleDateFormat.MEDIUM,
 262                   SimpleDateFormat.MEDIUM, Locale.UK);
 263
 264   /**
 265    * Initialises the Jalview Application Log
 266    */
 267   public static Logger log;
 268
 269   /** Jalview Properties */
 270   public static Properties applicationProperties = new Properties()
 271   {
 272     // override results in properties output in alphabetical order
 273     @Override
 274     public synchronized Enumeration<Object> keys()
 275     {
 276       return Collections.enumeration(new TreeSet<>(super.keySet()));
 277     }
 278   };
 279
 280   /** Default file is ~/.jalview_properties */
 281   static String propertiesFile;
 282
 283   private static boolean propsAreReadOnly = false;
 284
 285   public static void initLogger()
 286   {
 287     if (log != null)
 288     {
 289       return;
 290     }
 291     try
 292     {
 293       // TODO: redirect stdout and stderr here in order to grab the output of
 294       // the log
 295
 296       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 297               "System.err");
 298       ap.setName("JalviewLogger");
 299       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 300       // log output
 301       Logger laxis = Logger.getLogger("org.apache.axis");
 302       Logger lcastor = Logger.getLogger("org.exolab.castor");
 303       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 304
 305       laxis.setLevel(Level.toLevel(
 306               Cache.getDefault("logs.Axis.Level", Level.INFO.toString())));
 307       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 308               Level.INFO.toString())));
 309       lcastor = Logger.getLogger("org.exolab.castor.xml");
 310       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 311               Level.INFO.toString())));
 312       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 313       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 314       // Level.INFO.toString())));
 315       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache
 316               .getDefault("logs.Jalview.level", Level.INFO.toString())));
 317       // laxis.addAppender(ap);
 318       // lcastor.addAppender(ap);
 319       // jalview.bin.Cache.log.addAppender(ap);
 320       // Tell the user that debug is enabled
 321       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 322     } catch (Exception ex)
 323     {
 324       System.err.println("Problems initializing the log4j system\n");
 325       ex.printStackTrace(System.err);
 326     }
 327   }
 328
 329   /**
 330    * Loads properties from the given properties file. Any existing properties
 331    * are first cleared.
 332    */
 333   public static void loadProperties(String propsFile)
 334   {
 335     propertiesFile = propsFile;
 336     if (propsFile == null)
 337     {
 338       propertiesFile = System.getProperty("user.home") + File.separatorChar
 339               + ".jalview_properties";
 340     }
 341     else
 342     {
 343       // don't corrupt the file we've been given.
 344       propsAreReadOnly = true;
 345     }
 346
 347     try
 348     {
 349       InputStream fis;
 350       try
 351       {
 352         fis = new java.net.URL(propertiesFile).openStream();
 353         System.out.println(
 354                 "Loading jalview properties from : " + propertiesFile);
 355         System.out.println(
 356                 "Disabling Jalview writing to user's local properties file.");
 357         propsAreReadOnly = true;
 358
 359       } catch (Exception ex)
 360       {
 361         fis = null;
 362       }
 363       if (fis == null)
 364       {
 365         fis = new FileInputStream(propertiesFile);
 366       }
 367       applicationProperties.clear();
 368       applicationProperties.load(fis);
 369
 370       // remove any old build properties
 371
 372       deleteBuildProperties();
 373       fis.close();
 374     } catch (Exception ex)
 375     {
 376       System.out.println("Error reading properties file: " + ex);
 377     }
 378
 379     if (getDefault("USE_PROXY", false))
 380     {
 381       String proxyServer = getDefault("PROXY_SERVER", ""),
 382               proxyPort = getDefault("PROXY_PORT", "8080");
 383
 384       System.out.println("Using proxyServer: " + proxyServer
 385               + " proxyPort: " + proxyPort);
 386
 387       System.setProperty("http.proxyHost", proxyServer);
 388       System.setProperty("http.proxyPort", proxyPort);
 389     }
 390
 391     // LOAD THE AUTHORS FROM THE authors.props file
 392     try
 393     {
 394       String authorDetails = "jar:"
 395               .concat(Cache.class.getProtectionDomain().getCodeSource()
 396                       .getLocation().toString().concat("!/authors.props"));
 397
 398       java.net.URL localJarFileURL = new java.net.URL(authorDetails);
 399
 400       InputStream in = localJarFileURL.openStream();
 401       applicationProperties.load(in);
 402       in.close();
 403     } catch (Exception ex)
 404     {
 405       System.out.println("Error reading author details: " + ex);
 406       applicationProperties.remove("AUTHORS");
 407       applicationProperties.remove("AUTHORFNAMES");
 408       applicationProperties.remove("YEAR");
 409     }
 410
 411     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 412     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 413     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 414     try
 415     {
 416       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 417               .getCodeSource().getLocation().toString()
 418               .concat("!/.build_properties"));
 419
 420       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 421
 422       InputStream in = localJarFileURL.openStream();
 423       applicationProperties.load(in);
 424       in.close();
 425     } catch (Exception ex)
 426     {
 427       System.out.println("Error reading build details: " + ex);
 428       applicationProperties.remove("VERSION");
 429     }
 430
 431     String jnlpVersion = System.getProperty("jalview.version");
 432     String codeVersion = getProperty("VERSION");
 433     String codeInstallation = getProperty("INSTALLATION");
 434     if (codeVersion == null)
 435     {
 436       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 437       codeVersion = "Test";
 438       jnlpVersion = "Test";
 439       codeInstallation = "";
 440     }
 441     else
 442     {
 443       codeInstallation = " (" + codeInstallation + ")";
 444     }
 445     new BuildDetails(codeVersion, null, codeInstallation);
 446
 447     SiftsSettings
 448             .setMapWithSifts(Cache.getDefault("MAP_WITH_SIFTS", false));
 449
 450     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache
 451             .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 452
 453     SiftsSettings.setFailSafePIDThreshold(
 454             jalview.bin.Cache.getDefault("sifts_fail_safe_pid_threshold",
 455                     DEFAULT_FAIL_SAFE_PID_THRESHOLD));
 456
 457     SiftsSettings.setCacheThresholdInDays(
 458             jalview.bin.Cache.getDefault("sifts_cache_threshold_in_days",
 459                     DEFAULT_CACHE_THRESHOLD_IN_DAYS));
 460
 461     IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
 462             "http://www.jalview.org/services/identifiers"));
 463     IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
 464
 465     System.out
 466             .println("Jalview Version: " + codeVersion + codeInstallation);
 467
 468     StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
 469             .getDefault("PDB_DOWNLOAD_FORMAT", PDB_DOWNLOAD_FORMAT));
 470     StructureImportSettings
 471             .setDefaultPDBFileParser(DEFAULT_PDB_FILE_PARSER);
 472     // StructureImportSettings
 473     // .setDefaultPDBFileParser(jalview.bin.Cache.getDefault(
 474     // "DEFAULT_PDB_FILE_PARSER", DEFAULT_PDB_FILE_PARSER));
 475     // jnlpVersion will be null if we're using InstallAnywhere
 476     // Dont do this check if running in headless mode
 477     if (jnlpVersion == null && getDefault("VERSION_CHECK", true)
 478             && (System.getProperty("java.awt.headless") == null || System
 479                     .getProperty("java.awt.headless").equals("false")))
 480     {
 481
 482       class VersionChecker extends Thread
 483       {
 484         @Override
 485         public void run()
 486         {
 487           String orgtimeout = System
 488                   .getProperty("sun.net.client.defaultConnectTimeout");
 489           if (orgtimeout == null)
 490           {
 491             orgtimeout = "30";
 492             System.out.println("# INFO: Setting default net timeout to "
 493                     + orgtimeout + " seconds.");
 494           }
 495           String remoteVersion = null;
 496           try
 497           {
 498             System.setProperty("sun.net.client.defaultConnectTimeout",
 499                     "5000");
 500             java.net.URL url = new java.net.URL(Cache
 501                     .getDefault("www.jalview.org", "http://www.jalview.org")
 502                     + "/webstart/jalview.jnlp");
 503             BufferedReader in = new BufferedReader(
 504                     new InputStreamReader(url.openStream()));
 505             String line = null;
 506             while ((line = in.readLine()) != null)
 507             {
 508               if (line.indexOf("jalview.version") == -1)
 509               {
 510                 continue;
 511               }
 512
 513               line = line.substring(line.indexOf("value=") + 7);
 514               line = line.substring(0, line.lastIndexOf("\""));
 515               remoteVersion = line;
 516               break;
 517             }
 518           } catch (Exception ex)
 519           {
 520             System.out.println(
 521                     "Non-fatal exception when checking version at www.jalview.org :");
 522             System.out.println(ex);
 523             remoteVersion = getProperty("VERSION");
 524           }
 525           System.setProperty("sun.net.client.defaultConnectTimeout",
 526                   orgtimeout);
 527
 528           setProperty("LATEST_VERSION", remoteVersion);
 529         }
 530       }
 531
 532       VersionChecker vc = new VersionChecker();
 533       vc.start();
 534     }
 535     else
 536     {
 537       if (jnlpVersion != null)
 538       {
 539         setProperty("LATEST_VERSION", jnlpVersion);
 540       }
 541       else
 542       {
 543         applicationProperties.remove("LATEST_VERSION");
 544       }
 545     }
 546
 547     setProperty("VERSION", codeVersion);
 548
 549     // LOAD USERDEFINED COLOURS
 550     jalview.bin.Cache
 551             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 552     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 553             false);
 554   }
 555
 556   private static void deleteBuildProperties()
 557   {
 558     applicationProperties.remove("LATEST_VERSION");
 559     applicationProperties.remove("VERSION");
 560     applicationProperties.remove("AUTHORS");
 561     applicationProperties.remove("AUTHORFNAMES");
 562     applicationProperties.remove("YEAR");
 563     applicationProperties.remove("BUILD_DATE");
 564     applicationProperties.remove("INSTALLATION");
 565   }
 566
 567   /**
 568    * Gets Jalview application property of given key. Returns null if key not
 569    * found
 570    *
 571    * @param key
 572    *          Name of property
 573    *
 574    * @return Property value
 575    */
 576   public static String getProperty(String key)
 577   {
 578     return applicationProperties.getProperty(key);
 579   }
 580
 581   /**
 582    * A convenience method that returns a map holding property values for the
 583    * specified keys. A null entry in the map indicates a property that is either
 584    * not set, or set with value null.
 585    *
 586    * @param key
 587    * @return
 588    */
 589   public static Map<String, String> getProperties(String... key)
 590   {
 591     Map<String, String> map = new HashMap<>();
 592     for (String k : key)
 593     {
 594       map.put(k, getProperty(k));
 595     }
 596     return map;
 597   }
 598
 599   /**
 600    * These methods are used when checking if the saved preference is different
 601    * to the default setting
 602    */
 603
 604   public static boolean getDefault(String property, boolean def)
 605   {
 606     String string = getProperty(property);
 607     if (string != null)
 608     {
 609       def = Boolean.valueOf(string).booleanValue();
 610     }
 611
 612     return def;
 613   }
 614
 615   public static int getDefault(String property, int def)
 616   {
 617     String string = getProperty(property);
 618     if (string != null)
 619     {
 620       try
 621       {
 622         def = Integer.parseInt(string);
 623       } catch (NumberFormatException e)
 624       {
 625         System.out.println("Error parsing int property '" + property
 626                 + "' with value '" + string + "'");
 627       }
 628     }
 629
 630     return def;
 631   }
 632
 633   /**
 634    * These methods are used when checking if the saved preference is different
 635    * to the default setting
 636    */
 637   public static String getDefault(String property, String def)
 638   {
 639     String string = getProperty(property);
 640     if (string != null)
 641     {
 642       return string;
 643     }
 644
 645     return def;
 646   }
 647
 648   /**
 649    * Stores property in the file "HOME_DIR/.jalview_properties"
 650    *
 651    * @param key
 652    *          Name of object
 653    * @param obj
 654    *          String value of property
 655    *
 656    * @return previous value of property (or null)
 657    */
 658   public static Object setProperty(String key, String obj)
 659   {
 660     Object oldValue = null;
 661     try
 662     {
 663       oldValue = applicationProperties.setProperty(key, obj);
 664       if (!propsAreReadOnly)
 665       {
 666         FileOutputStream out = new FileOutputStream(propertiesFile);
 667         applicationProperties.store(out, "---JalviewX Properties File---");
 668         out.close();
 669       }
 670     } catch (Exception ex)
 671     {
 672       System.out.println(
 673               "Error setting property: " + key + " " + obj + "\n" + ex);
 674     }
 675     return oldValue;
 676   }
 677
 678   /**
 679    * remove the specified property from the jalview properties file
 680    *
 681    * @param string
 682    */
 683   public static void removeProperty(String string)
 684   {
 685     applicationProperties.remove(string);
 686     saveProperties();
 687   }
 688
 689   /**
 690    * save the properties to the jalview properties path
 691    */
 692   public static void saveProperties()
 693   {
 694     if (!propsAreReadOnly)
 695     {
 696       try
 697       {
 698         FileOutputStream out = new FileOutputStream(propertiesFile);
 699         applicationProperties.store(out, "---JalviewX Properties File---");
 700         out.close();
 701       } catch (Exception ex)
 702       {
 703         System.out.println("Error saving properties: " + ex);
 704       }
 705     }
 706   }
 707
 708   /**
 709    * internal vamsas class discovery state
 710    */
 711   private static int vamsasJarsArePresent = -1;
 712
 713   /**
 714    * Searches for vamsas client classes on class path.
 715    *
 716    * @return true if vamsas client is present on classpath
 717    */
 718   public static boolean vamsasJarsPresent()
 719   {
 720     if (vamsasJarsArePresent == -1)
 721     {
 722       try
 723       {
 724         if (jalview.jbgui.GDesktop.class.getClassLoader()
 725                 .loadClass("uk.ac.vamsas.client.VorbaId") != null)
 726         {
 727           jalview.bin.Cache.log.debug(
 728                   "Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 729           vamsasJarsArePresent = 1;
 730           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 731           lvclient.setLevel(Level.toLevel(Cache
 732                   .getDefault("logs.Vamsas.Level", Level.INFO.toString())));
 733
 734           lvclient.addAppender(log.getAppender("JalviewLogger"));
 735           // Tell the user that debug is enabled
 736           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 737         }
 738       } catch (Exception e)
 739       {
 740         vamsasJarsArePresent = 0;
 741         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 742       }
 743     }
 744     return (vamsasJarsArePresent > 0);
 745   }
 746
 747   /**
 748    * internal vamsas class discovery state
 749    */
 750   private static int groovyJarsArePresent = -1;
 751
 752   /**
 753    * Searches for vamsas client classes on class path.
 754    *
 755    * @return true if vamsas client is present on classpath
 756    */
 757   public static boolean groovyJarsPresent()
 758   {
 759     if (groovyJarsArePresent == -1)
 760     {
 761       try
 762       {
 763         if (Cache.class.getClassLoader()
 764                 .loadClass("groovy.lang.GroovyObject") != null)
 765         {
 766           jalview.bin.Cache.log.debug(
 767                   "Found Groovy (groovy.lang.GroovyObject can be loaded)");
 768           groovyJarsArePresent = 1;
 769           Logger lgclient = Logger.getLogger("groovy");
 770           lgclient.setLevel(Level.toLevel(Cache
 771                   .getDefault("logs.Groovy.Level", Level.INFO.toString())));
 772
 773           lgclient.addAppender(log.getAppender("JalviewLogger"));
 774           // Tell the user that debug is enabled
 775           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 776         }
 777       } catch (Error e)
 778       {
 779         groovyJarsArePresent = 0;
 780         jalview.bin.Cache.log.debug("Groovy Classes are not present", e);
 781       } catch (Exception e)
 782       {
 783         groovyJarsArePresent = 0;
 784         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 785       }
 786     }
 787     return (groovyJarsArePresent > 0);
 788   }
 789
 790   /**
 791    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
 792    * enabled.
 793    */
 794   protected static Object tracker = null;
 795
 796   protected static Class trackerfocus = null;
 797
 798   protected static Class jgoogleanalyticstracker = null;
 799
 800   /**
 801    * Initialise the google tracker if it is not done already.
 802    */
 803   public static void initGoogleTracker()
 804   {
 805     if (tracker == null)
 806     {
 807       if (jgoogleanalyticstracker == null)
 808       {
 809         // try to get the tracker class
 810         try
 811         {
 812           jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
 813                   "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 814           trackerfocus = Cache.class.getClassLoader()
 815                   .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
 816         } catch (Exception e)
 817         {
 818           log.debug(
 819                   "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 820           tracker = null;
 821           jgoogleanalyticstracker = null;
 822           trackerfocus = null;
 823           return;
 824         }
 825       }
 826       // now initialise tracker
 827       Exception re = null, ex = null;
 828       Error err = null;
 829       String vrs = "No Version Accessible";
 830       try
 831       {
 832         // Google analytics tracking code for Library Finder
 833         tracker = jgoogleanalyticstracker
 834                 .getConstructor(new Class[]
 835                 { String.class, String.class, String.class })
 836                 .newInstance(new Object[]
 837                 { "Jalview Desktop",
 838                     (vrs = jalview.bin.Cache.getProperty("VERSION") + "_"
 839                             + jalview.bin.Cache.getDefault("BUILD_DATE",
 840                                     "unknown")),
 841                     "UA-9060947-1" });
 842         jgoogleanalyticstracker
 843                 .getMethod("trackAsynchronously", new Class[]
 844                 { trackerfocus })
 845                 .invoke(tracker, new Object[]
 846                 { trackerfocus.getConstructor(new Class[] { String.class })
 847                         .newInstance(new Object[]
 848                         { "Application Started." }) });
 849       } catch (RuntimeException e)
 850       {
 851         re = e;
 852       } catch (Exception e)
 853       {
 854         ex = e;
 855       } catch (Error e)
 856       {
 857         err = e;
 858       }
 859       if (re != null || ex != null || err != null)
 860       {
 861         if (log != null)
 862         {
 863           if (re != null)
 864           {
 865             log.debug("Caught runtime exception in googletracker init:",
 866                     re);
 867           }
 868           if (ex != null)
 869           {
 870             log.warn(
 871                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 872                             + vrs,
 873                     ex);
 874           }
 875           if (err != null)
 876           {
 877             log.error(
 878                     "Whilst initing GoogleTracker for Jalview Desktop version "
 879                             + vrs,
 880                     err);
 881           }
 882         }
 883         else
 884         {
 885           if (re != null)
 886           {
 887             System.err.println(
 888                     "Debug: Caught runtime exception in googletracker init:"
 889                             + vrs);
 890             re.printStackTrace();
 891           }
 892           if (ex != null)
 893           {
 894             System.err.println(
 895                     "Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 896                             + vrs);
 897             ex.printStackTrace();
 898           }
 899
 900           if (err != null)
 901           {
 902             System.err.println(
 903                     "ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 904                             + vrs);
 905             err.printStackTrace();
 906           }
 907         }
 908       }
 909       else
 910       {
 911         log.debug("Successfully initialised tracker.");
 912       }
 913     }
 914   }
 915
 916   /**
 917    * get the user's default colour if available
 918    *
 919    * @param property
 920    * @param defcolour
 921    * @return
 922    */
 923   public static Color getDefaultColour(String property, Color defcolour)
 924   {
 925     String colprop = getProperty(property);
 926     if (colprop == null)
 927     {
 928       return defcolour;
 929     }
 930     Color col = ColorUtils.parseColourString(colprop);
 931     if (col == null)
 932     {
 933       log.warn("Couldn't parse '" + colprop + "' as a colour for "
 934               + property);
 935     }
 936     return (col == null) ? defcolour : col;
 937   }
 938
 939   /**
 940    * store a colour as a Jalview user default property
 941    *
 942    * @param property
 943    * @param colour
 944    */
 945   public static void setColourProperty(String property, Color colour)
 946   {
 947     setProperty(property, jalview.util.Format.getHexString(colour));
 948   }
 949
 950   /**
 951    * Stores a formatted date in a jalview property, using a fixed locale.
 952    *
 953    * @param propertyName
 954    * @param date
 955    * @return the formatted date string
 956    */
 957   public static String setDateProperty(String propertyName, Date date)
 958   {
 959     String formatted = date_format.format(date);
 960     setProperty(propertyName, formatted);
 961     return formatted;
 962   }
 963
 964   /**
 965    * Reads a date stored in a Jalview property, parses it (using a fixed locale
 966    * format) and returns as a Date, or null if parsing fails
 967    *
 968    * @param propertyName
 969    * @return
 970    *
 971    */
 972   public static Date getDateProperty(String propertyName)
 973   {
 974     String val = getProperty(propertyName);
 975     if (val != null)
 976     {
 977       try
 978       {
 979         return date_format.parse(val);
 980       } catch (Exception ex)
 981       {
 982         System.err.println("Invalid or corrupt date in property '"
 983                 + propertyName + "' : value was '" + val + "'");
 984       }
 985     }
 986     return null;
 987   }
 988
 989   /**
 990    * get and parse a property as an integer. send any parsing problems to
 991    * System.err
 992    *
 993    * @param property
 994    * @return null or Integer
 995    */
 996   public static Integer getIntegerProperty(String property)
 997   {
 998     String val = getProperty(property);
 999     if (val != null && (val = val.trim()).length() > 0)
1000     {
1001       try
1002       {
1003         return Integer.valueOf(val);
1004       } catch (NumberFormatException x)
1005       {
1006         System.err.println("Invalid integer in property '" + property
1007                 + "' (value was '" + val + "')");
1008       }
1009     }
1010     return null;
1011   }
1012
1013   /**
1014    * Set the specified value, or remove it if null or empty. Does not save the
1015    * properties file.
1016    *
1017    * @param propName
1018    * @param value
1019    */
1020   public static void setOrRemove(String propName, String value)
1021   {
1022     if (propName == null)
1023     {
1024       return;
1025     }
1026     if (value == null || value.trim().length() < 1)
1027     {
1028       Cache.applicationProperties.remove(propName);
1029     }
1030     else
1031     {
1032       Cache.applicationProperties.setProperty(propName, value);
1033     }
1034   }
1035
1036   /**
1037    * Loads in user colour schemes from files.
1038    *
1039    * @param files
1040    *          a '|'-delimited list of file paths
1041    */
1042   public static void initUserColourSchemes(String files)
1043   {
1044     if (files == null || files.length() == 0)
1045     {
1046       return;
1047     }
1048
1049     // In case colours can't be loaded, we'll remove them
1050     // from the default list here.
1051     StringBuffer coloursFound = new StringBuffer();
1052     StringTokenizer st = new StringTokenizer(files, "|");
1053     while (st.hasMoreElements())
1054     {
1055       String file = st.nextToken();
1056       try
1057       {
1058         UserColourScheme ucs = ColourSchemeLoader.loadColourScheme(file);
1059         if (ucs != null)
1060         {
1061           if (coloursFound.length() > 0)
1062           {
1063             coloursFound.append("|");
1064           }
1065           coloursFound.append(file);
1066           ColourSchemes.getInstance().registerColourScheme(ucs);
1067         }
1068       } catch (Exception ex)
1069       {
1070         System.out.println("Error loading User ColourFile\n" + ex);
1071       }
1072     }
1073     if (!files.equals(coloursFound.toString()))
1074     {
1075       if (coloursFound.toString().length() > 1)
1076       {
1077         setProperty(UserDefinedColours.USER_DEFINED_COLOURS,
1078                 coloursFound.toString());
1079       }
1080       else
1081       {
1082         applicationProperties
1083                 .remove(UserDefinedColours.USER_DEFINED_COLOURS);
1084       }
1085     }
1086   }
1087 }