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