src/jalview/bin/Cache.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
   3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.bin;
  20
  21 import java.io.*;
  22 import java.util.*;
  23
  24 import org.apache.log4j.*;
  25 import org.biojava.dasobert.dasregistry.Das1Source;
  26
  27 /**
  28  * Stores and retrieves Jalview Application Properties Lists and fields within
  29  * list entries are separated by '|' symbols unless otherwise stated (|) clauses
  30  * are alternative values for a tag. <br>
  31  * <br>
  32  * Current properties include:
  33  * <ul>
  34  * <br>
  35  * logs.Axis.Level - one of the stringified Levels for log4j controlling the
  36  * logging level for axis (used for web services) <br>
  37  * </li>
  38  * <li>logs.Castor.Level - one of the stringified Levels for log4j controlling
  39  * the logging level for castor (used for serialization) <br>
  40  * </li>
  41  * <li>logs.Jalview.Level - Cache.log stringified level. <br>
  42  * </li>
  43  * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
  44  * startup</li>
  45  * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.</li>
  46  * <li>SCREEN_WIDTH</li>
  47  * <li>SCREEN_HEIGHT</li>
  48  * <li>SCREEN_Y=285</li>
  49  * <li>SCREEN_X=371</li>
  50  * <li>SHOW_FULLSCREEN boolean</li>
  51  * <li>FONT_NAME java font name for alignment text display</li>
  52  * <li>FONT_SIZE size of displayed alignment text</li>
  53  * <li>FONT_STYLE style of font displayed (sequence labels are always italic)</li>
  54  * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
  55  * <li>LAST_DIRECTORY last directory for browsing alignment</li>
  56  * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
  57  * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
  58  * <li>SHOW_IDENTITY show percentage identity annotation</li>
  59  * <li>SHOW_QUALITY show alignment quality annotation</li>
  60  * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
  61  * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
  62  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  63  * annotation row</li>
  64  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
  65  * <li>DEFAULT_FILE_FORMAT file format used to save</li>
  66  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
  67  * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
  68  * <li>VERSION the version of the jalview build</li>
  69  * <li>BUILD_DATE date of this build</li>
  70  * <li>LATEST_VERSION the latest jalview version advertised on the
  71  * www.jalview.org</li>
  72  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
  73  * descriptions</li>
  74  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
  75  * suffix to file</li>
  76  * <li>RECENT_URL list of recently retrieved URLs</li>
  77  * <li>RECENT_FILE list of recently opened files</li>
  78  * <li>USE_PROXY flag for whether a http proxy is to be used</li>
  79  * <li>PROXY_SERVER the proxy</li>
  80  * <li>PROXY_PORT</li>
  81  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
  82  * service</li>
  83  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
  84  * service</li>
  85  * <li>USAGESTATS (true) Enable google analytics tracker for collecting usage
  86  * statistics</li>
  87  * <li>DAS_LOCAL_SOURCE list of local das sources</li>
  88  * <li>SHOW_OVERVIEW boolean for overview window display</li>
  89  * <li>ANTI_ALIAS boolean for smooth fonts</li>
  90  * <li>RIGHT_ALIGN_IDS boolean</li>
  91  * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
  92  * <li>PAD_GAPS boolean</li>
  93  * <li>ID_ITALICS boolean</li>
  94  * <li>SHOW_JV_SUFFIX</li>
  95  * <li>WRAP_ALIGNMENT</li>
  96  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
  97  * style check</li>
  98  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
  99  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
 100  * $SEQUENCE_ID$</li>
 101  * <li>DAS_REGISTRY_URL the registry to query</li>
 102  * <li>DEFAULT_BROWSER for unix</li>
 103  * <li>DAS_ACTIVE_SOURCE list of active sources</li>
 104  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
 105  * (false)</li>
 106  * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence
 107  * ID tooltip</li>
 108  * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence
 109  * ID tooltip</li>
 110  * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved
 111  * displayed as '.'</li>
 112  * <li>SORT_BY_TREE (false) sort the current alignment view according to the
 113  * order of a newly displayed tree</li>
 114  *
 115  * <li></li>
 116  *
 117  * </ul>
 118  *
 119  * @author $author$
 120  * @version $Revision$
 121  */
 122 public class Cache
 123 {
 124   /**
 125    * property giving log4j level for CASTOR loggers
 126    */
 127   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 128
 129   /**
 130    * property giving log4j level for AXIS loggers
 131    */
 132   public static final String AXISLOGLEVEL = "logs.Axis.level";
 133
 134   /**
 135    * property giving log4j level for Jalview Log
 136    */
 137   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 138
 139   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 140
 141   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 142
 143   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 144
 145   /**
 146    * Initialises the Jalview Application Log
 147    */
 148   public static Logger log;
 149
 150   /** Jalview Properties */
 151   public static Properties applicationProperties = new Properties();
 152
 153   /** Default file is ~/.jalview_properties */
 154   static String propertiesFile;
 155
 156   public static void initLogger()
 157   {
 158     try
 159     {
 160       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 161               "System.err");
 162       ap.setName("JalviewLogger");
 163       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 164       // log output
 165       Logger laxis = Logger.getLogger("org.apache.axis");
 166       Logger lcastor = Logger.getLogger("org.exolab.castor");
 167       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 168
 169       laxis.setLevel(Level.toLevel(Cache.getDefault("logs.Axis.Level",
 170               Level.INFO.toString())));
 171       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 172               Level.INFO.toString())));
 173       lcastor = Logger.getLogger("org.exolab.castor.xml");
 174       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 175               Level.INFO.toString())));
 176       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 177       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 178       // Level.INFO.toString())));
 179       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache.getDefault(
 180               "logs.Jalview.level", Level.INFO.toString())));
 181       // laxis.addAppender(ap);
 182       // lcastor.addAppender(ap);
 183       // jalview.bin.Cache.log.addAppender(ap);
 184       // Tell the user that debug is enabled
 185       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 186     } catch (Exception ex)
 187     {
 188       System.err.println("Problems initializing the log4j system\n");
 189       ex.printStackTrace(System.err);
 190     }
 191   }
 192
 193   /** Called when Jalview is started */
 194   public static void loadProperties(String propsFile)
 195   {
 196     propertiesFile = propsFile;
 197     if (propsFile == null)
 198     {
 199       propertiesFile = System.getProperty("user.home") + File.separatorChar
 200               + ".jalview_properties";
 201     }
 202
 203     try
 204     {
 205       FileInputStream fis = new FileInputStream(propertiesFile);
 206       applicationProperties.load(fis);
 207       applicationProperties.remove("LATEST_VERSION");
 208       applicationProperties.remove("VERSION");
 209       fis.close();
 210     } catch (Exception ex)
 211     {
 212       System.out.println("Error reading properties file: " + ex);
 213     }
 214
 215     if (getDefault("USE_PROXY", false))
 216     {
 217       System.out.println("Using proxyServer: "
 218               + getDefault("PROXY_SERVER", null) + " proxyPort: "
 219               + getDefault("PROXY_PORT", null));
 220       System
 221               .setProperty("http.proxyHost", getDefault("PROXY_SERVER",
 222                       null));
 223       System.setProperty("http.proxyPort", getDefault("PROXY_PORT", null));
 224     }
 225
 226     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 227     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 228     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 229     try
 230     {
 231       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 232               .getCodeSource().getLocation().toString().concat(
 233                       "!/.build_properties"));
 234
 235       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 236
 237       InputStream in = localJarFileURL.openStream();
 238       applicationProperties.load(in);
 239       in.close();
 240     } catch (Exception ex)
 241     {
 242       System.out.println("Error reading build details: " + ex);
 243       applicationProperties.remove("VERSION");
 244     }
 245
 246     String jnlpVersion = System.getProperty("jalview.version");
 247     String codeVersion = getProperty("VERSION");
 248
 249     if (codeVersion == null)
 250     {
 251       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 252       codeVersion = "Test";
 253       jnlpVersion = "Test";
 254     }
 255
 256     System.out.println("Jalview Version: " + codeVersion);
 257
 258     // jnlpVersion will be null if we're using InstallAnywhere
 259     // Dont do this check if running in headless mode
 260     if (jnlpVersion == null
 261             && (System.getProperty("java.awt.headless") == null || System
 262                     .getProperty("java.awt.headless").equals("false")))
 263     {
 264
 265       class VersionChecker extends Thread
 266       {
 267         public void run()
 268         {
 269           String orgtimeout = System
 270                   .getProperty("sun.net.client.defaultConnectTimeout");
 271           if (orgtimeout == null)
 272           {
 273             orgtimeout = "30";
 274             System.out.println("# INFO: Setting default net timeout to "
 275                     + orgtimeout + " seconds.");
 276           }
 277           String jnlpVersion = null;
 278           try
 279           {
 280             System.setProperty("sun.net.client.defaultConnectTimeout",
 281                     "5000");
 282             java.net.URL url = new java.net.URL(
 283                     "http://www.jalview.org/webstart/jalview.jnlp");
 284             BufferedReader in = new BufferedReader(new InputStreamReader(
 285                     url.openStream()));
 286             String line = null;
 287             while ((line = in.readLine()) != null)
 288             {
 289               if (line.indexOf("jalview.version") == -1)
 290               {
 291                 continue;
 292               }
 293
 294               line = line.substring(line.indexOf("value=") + 7);
 295               line = line.substring(0, line.lastIndexOf("\""));
 296               jnlpVersion = line;
 297               break;
 298             }
 299           } catch (Exception ex)
 300           {
 301             System.out
 302                     .println("Non-fatal exceptions when checking version at www.jalview.org :");
 303             System.out.println(ex);
 304             jnlpVersion = getProperty("VERSION");
 305           }
 306           System.setProperty("sun.net.client.defaultConnectTimeout",
 307                   orgtimeout);
 308
 309           setProperty("LATEST_VERSION", jnlpVersion);
 310         }
 311       }
 312
 313       VersionChecker vc = new VersionChecker();
 314       vc.start();
 315     }
 316     else
 317     {
 318       if (jnlpVersion != null)
 319       {
 320         setProperty("LATEST_VERSION", jnlpVersion);
 321       }
 322       else
 323       {
 324         applicationProperties.remove("LATEST_VERSION");
 325       }
 326     }
 327
 328     setProperty("VERSION", codeVersion);
 329
 330     // LOAD USERDEFINED COLOURS
 331     jalview.gui.UserDefinedColours
 332             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 333     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 334             false);
 335   }
 336
 337   /**
 338    * Gets Jalview application property of given key. Returns null if key not
 339    * found
 340    *
 341    * @param key
 342    *          Name of property
 343    *
 344    * @return Property value
 345    */
 346   public static String getProperty(String key)
 347   {
 348     return applicationProperties.getProperty(key);
 349   }
 350
 351   /**
 352    * These methods are used when checking if the saved preference is different
 353    * to the default setting
 354    */
 355
 356   public static boolean getDefault(String property, boolean def)
 357   {
 358     String string = getProperty(property);
 359     if (string != null)
 360     {
 361       def = Boolean.valueOf(string).booleanValue();
 362     }
 363
 364     return def;
 365   }
 366
 367   /**
 368    * These methods are used when checking if the saved preference is different
 369    * to the default setting
 370    */
 371   public static String getDefault(String property, String def)
 372   {
 373     String string = getProperty(property);
 374     if (string != null)
 375     {
 376       return string;
 377     }
 378
 379     return def;
 380   }
 381
 382   /**
 383    * Stores property in the file "HOME_DIR/.jalview_properties"
 384    *
 385    * @param key
 386    *          Name of object
 387    * @param obj
 388    *          String value of property
 389    *
 390    * @return String value of property
 391    */
 392   public static String setProperty(String key, String obj)
 393   {
 394     try
 395     {
 396       FileOutputStream out = new FileOutputStream(propertiesFile);
 397       applicationProperties.setProperty(key, obj);
 398       applicationProperties.store(out, "---JalviewX Properties File---");
 399       out.close();
 400     } catch (Exception ex)
 401     {
 402       System.out.println("Error setting property: " + key + " " + obj
 403               + "\n" + ex);
 404     }
 405     return obj;
 406   }
 407
 408   public static void saveProperties()
 409   {
 410     try
 411     {
 412       FileOutputStream out = new FileOutputStream(propertiesFile);
 413       applicationProperties.store(out, "---JalviewX Properties File---");
 414       out.close();
 415     } catch (Exception ex)
 416     {
 417       System.out.println("Error saving properties: " + ex);
 418     }
 419   }
 420
 421   /**
 422    * internal vamsas class discovery state
 423    */
 424   private static int vamsasJarsArePresent = -1;
 425
 426   /**
 427    * Searches for vamsas client classes on class path.
 428    *
 429    * @return true if vamsas client is present on classpath
 430    */
 431   public static boolean vamsasJarsPresent()
 432   {
 433     if (vamsasJarsArePresent == -1)
 434     {
 435       try
 436       {
 437         if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
 438                 "uk.ac.vamsas.client.VorbaId") != null)
 439         {
 440           jalview.bin.Cache.log
 441                   .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 442           vamsasJarsArePresent = 1;
 443           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 444           lvclient.setLevel(Level.toLevel(Cache.getDefault(
 445                   "logs.Vamsas.Level", Level.INFO.toString())));
 446
 447           lvclient.addAppender(log.getAppender("JalviewLogger"));
 448           // Tell the user that debug is enabled
 449           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 450         }
 451       } catch (Exception e)
 452       {
 453         vamsasJarsArePresent = 0;
 454         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 455       }
 456     }
 457     return (vamsasJarsArePresent > 0);
 458   }
 459
 460   /**
 461    * internal vamsas class discovery state
 462    */
 463   private static int groovyJarsArePresent = -1;
 464
 465   /**
 466    * Searches for vamsas client classes on class path.
 467    *
 468    * @return true if vamsas client is present on classpath
 469    */
 470   public static boolean groovyJarsPresent()
 471   {
 472     if (groovyJarsArePresent == -1)
 473     {
 474       try
 475       {
 476         if (Cache.class.getClassLoader().loadClass(
 477                 "groovy.lang.GroovyObject") != null)
 478         {
 479           jalview.bin.Cache.log
 480                   .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
 481           groovyJarsArePresent = 1;
 482           Logger lgclient = Logger.getLogger("groovy");
 483           lgclient.setLevel(Level.toLevel(Cache.getDefault(
 484                   "logs.Groovy.Level", Level.INFO.toString())));
 485
 486           lgclient.addAppender(log.getAppender("JalviewLogger"));
 487           // Tell the user that debug is enabled
 488           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 489         }
 490       } catch (Exception e)
 491       {
 492         groovyJarsArePresent = 0;
 493         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 494       }
 495     }
 496     return (groovyJarsArePresent > 0);
 497   }
 498
 499   /**
 500    * generate Das1Sources from the local das source list
 501    *
 502    * @return Vector of Das1Sources
 503    */
 504   public static Vector getLocalDasSources()
 505   {
 506     Vector localSources = new Vector();
 507     String local = jalview.bin.Cache.getProperty("DAS_LOCAL_SOURCE");
 508     if (local != null)
 509     {
 510       StringTokenizer st = new StringTokenizer(local, "\t");
 511       while (st.hasMoreTokens())
 512       {
 513         String token = st.nextToken();
 514         int bar = token.indexOf("|");
 515         Das1Source source = new Das1Source();
 516         source.setUrl(token.substring(bar + 1));
 517         if (source.getUrl().startsWith("sequence:"))
 518         {
 519           source.setUrl(source.getUrl().substring(9));
 520           // this source also serves sequences as well as features
 521           source.setCapabilities(new String[]
 522           { "sequence", "features" });
 523         }
 524         else
 525         {
 526           // default is that all user added sources serve features
 527           source.setCapabilities(new String[]
 528           { "features" });
 529         }
 530
 531         source.setNickname(token.substring(0, bar));
 532
 533         localSources.addElement(source);
 534       }
 535     }
 536     return localSources;
 537   }
 538
 539   /**
 540    * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not enabled.
 541    */
 542   protected static Object tracker = null;
 543   protected static Class trackerfocus = null;
 544   protected static Class jgoogleanalyticstracker = null;
 545
 546   /**
 547    * Initialise the google tracker if it is not done already.
 548    */
 549   public static void initGoogleTracker()
 550   {
 551     if (tracker == null)
 552     {
 553       if (jgoogleanalyticstracker==null)
 554       {
 555         // try to get the tracker class
 556         try {
 557           jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
 558           "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
 559           trackerfocus = Cache.class.getClassLoader().loadClass(
 560           "com.boxysystems.jgoogleanalytics.FocusPoint");
 561         } catch (Exception e)
 562         {
 563           log.debug("com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
 564           tracker = null;
 565           jgoogleanalyticstracker=null;
 566           trackerfocus=null;
 567           return;
 568         }
 569       }
 570       // now initialise tracker
 571       Exception re = null, ex = null;
 572       Error err = null;
 573       String vrs = "No Version Accessible";
 574       try
 575       {
 576         // Google analytics tracking code for Library Finder
 577         tracker = jgoogleanalyticstracker.getConstructor(new Class[] { String.class,String.class,String.class}).newInstance(new Object[] { "Jalview Desktop",
 578                 (vrs = jalview.bin.Cache.getProperty("VERSION")
 579                         + "_"
 580                         + jalview.bin.Cache.getDefault("BUILD_DATE",
 581                                 "unknown")), "UA-9060947-1"});
 582         jgoogleanalyticstracker.getMethod("trackAsynchronously", new Class[] { trackerfocus })
 583         .invoke(tracker, new Object[] { trackerfocus.getConstructor(
 584                 new Class[] { String.class}).newInstance(new Object[] { "Application Started." })});
 585       } catch (RuntimeException e)
 586       {
 587         re = e;
 588       } catch (Exception e)
 589       {
 590         ex = e;
 591       } catch (Error e)
 592       {
 593         err = e;
 594       }
 595       if (re != null || ex != null || err != null)
 596       {
 597         if (log != null)
 598         {
 599           if (re != null)
 600             log
 601                     .debug(
 602                             "Caught runtime exception in googletracker init:",
 603                             re);
 604           if (ex != null)
 605             log.warn(
 606                     "Failed to initialise GoogleTracker for Jalview Desktop with version "
 607                             + vrs, ex);
 608           if (err != null)
 609             log.error(
 610                     "Whilst initing GoogleTracker for Jalview Desktop version "
 611                             + vrs, err);
 612         }
 613         else
 614         {
 615           if (re != null)
 616           {
 617             System.err
 618                     .println("Debug: Caught runtime exception in googletracker init:"
 619                             + vrs);
 620             re.printStackTrace();
 621           }
 622           if (ex != null)
 623           {
 624             System.err
 625                     .println("Warning:  Failed to initialise GoogleTracker for Jalview Desktop with version "
 626                             + vrs);
 627             ex.printStackTrace();
 628           }
 629
 630           if (err != null)
 631           {
 632             System.err
 633                     .println("ERROR: Whilst initing GoogleTracker for Jalview Desktop version "
 634                             + vrs);
 635             err.printStackTrace();
 636           }
 637         }
 638       }
 639       else
 640       {
 641         log.debug("Successfully initialised tracker.");
 642       }
 643     }
 644   }
 645 }