src/jalview/bin/Cache.java

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