src/jalview/bin/Cache.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 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
  44  * on startup </li>
  45  * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
  46  * </li>
  47  * <li>SCREEN_WIDTH </li>
  48  * <li>SCREEN_HEIGHT </li>
  49  * <li>SCREEN_Y=285 </li>
  50  * <li>SCREEN_X=371 </li>
  51  * <li>SHOW_FULLSCREEN boolean </li>
  52  * <li>FONT_NAME java font name for alignment text display </li>
  53  * <li>FONT_SIZE size of displayed alignment text </li>
  54  * <li>FONT_STYLE style of font displayed (sequence labels are always italic)
  55  * </li>
  56  * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ') </li>
  57  * <li>LAST_DIRECTORY last directory for browsing alignment </li>
  58  * <li>USER_DEFINED_COLOURS list of user defined colour scheme files </li>
  59  * <li>SHOW_FULL_ID show id with '/start-end' numbers appended </li>
  60  * <li>SHOW_IDENTITY show percentage identity annotation </li>
  61  * <li>SHOW_QUALITY show alignment quality annotation </li>
  62  * <li>SHOW_ANNOTATIONS show alignment annotation rows </li>
  63  * <li>SHOW_CONSERVATION show alignment conservation annotation </li>
  64  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
  65  * annotation row </li>
  66  * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment </li>
  67  * <li>DEFAULT_FILE_FORMAT file format used to save </li>
  68  * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url) </li>
  69  * <li>SHOW_STARTUP_FILE flag to control loading of startup file </li>
  70  * <li>VERSION the version of the jalview build </li>
  71  * <li>BUILD_DATE date of this build </li>
  72  * <li>LATEST_VERSION the latest jalview version advertised on the
  73  * www.jalview.org </li>
  74  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
  75  * descriptions </li>
  76  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
  77  * suffix to file </li>
  78  * <li>RECENT_URL list of recently retrieved URLs </li>
  79  * <li>RECENT_FILE list of recently opened files </li>
  80  * <li>USE_PROXY flag for whether a http proxy is to be used </li>
  81  * <li>PROXY_SERVER the proxy </li>
  82  * <li>PROXY_PORT </li>
  83  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
  84  * service </li>
  85  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
  86  * service </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
  92  * </li>
  93  * <li>PAD_GAPS boolean </li>
  94  * <li>ID_ITALICS boolean </li>
  95  * <li>SHOW_JV_SUFFIX </li>
  96  * <li>WRAP_ALIGNMENT </li>
  97  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
  98  * style check </li>
  99  * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity) </li>
 100  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
 101  * $SEQUENCE_ID$ </li>
 102  * <li>DAS_REGISTRY_URL the registry to query </li>
 103  * <li>DEFAULT_BROWSER for unix </li>
 104  * <li>DAS_ACTIVE_SOURCE list of active sources </li>
 105  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
 106  * (false) </li>
 107  * <li>SHOW_NPFEATS_TOOLTIP (true) show non-positional features in the Sequence ID tooltip</li>
 108  * <li>SHOW_DBREFS_TOOLTIP (true) show Database Cross References in the Sequence ID tooltip</li>
 109  * <li>SHOW_UNCONSERVED (false) only render unconserved residues - conserved displayed as '.'</li>
 110  * <li>SORT_BY_TREE (false) sort the current alignment view according to the order of a newly displayed tree</li>
 111  *
 112  * <li> </li>
 113  *
 114  * </ul>
 115  *
 116  * @author $author$
 117  * @version $Revision$
 118  */
 119 public class Cache
 120 {
 121   /**
 122    * property giving log4j level for CASTOR loggers
 123    */
 124   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 125
 126   /**
 127    * property giving log4j level for AXIS loggers
 128    */
 129   public static final String AXISLOGLEVEL = "logs.Axis.level";
 130
 131   /**
 132    * property giving log4j level for Jalview Log
 133    */
 134   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 135
 136   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 137
 138   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 139
 140   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 141
 142   /**
 143    * Initialises the Jalview Application Log
 144    */
 145   public static Logger log;
 146
 147   /** Jalview Properties */
 148   public static Properties applicationProperties = new Properties();
 149
 150   /** Default file is ~/.jalview_properties */
 151   static String propertiesFile;
 152
 153   public static void initLogger()
 154   {
 155     try
 156     {
 157       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 158               "System.err");
 159       ap.setName("JalviewLogger");
 160       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 161                                                                 // log output
 162       Logger laxis = Logger.getLogger("org.apache.axis");
 163       Logger lcastor = Logger.getLogger("org.exolab.castor");
 164       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 165
 166       laxis.setLevel(Level.toLevel(Cache.getDefault("logs.Axis.Level",
 167               Level.INFO.toString())));
 168       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 169               Level.INFO.toString())));
 170       lcastor = Logger.getLogger("org.exolab.castor.xml");
 171       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 172               Level.INFO.toString())));
 173       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 174       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 175       // Level.INFO.toString())));
 176       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache.getDefault(
 177               "logs.Jalview.level", Level.INFO.toString())));
 178       // laxis.addAppender(ap);
 179       // lcastor.addAppender(ap);
 180       // jalview.bin.Cache.log.addAppender(ap);
 181       // Tell the user that debug is enabled
 182       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 183     } catch (Exception ex)
 184     {
 185       System.err.println("Problems initializing the log4j system\n");
 186       ex.printStackTrace(System.err);
 187     }
 188   }
 189
 190   /** Called when Jalview is started */
 191   public static void loadProperties(String propsFile)
 192   {
 193     propertiesFile = propsFile;
 194     if (propsFile == null)
 195     {
 196       propertiesFile = System.getProperty("user.home") + File.separatorChar
 197               + ".jalview_properties";
 198     }
 199
 200     try
 201     {
 202       FileInputStream fis = new FileInputStream(propertiesFile);
 203       applicationProperties.load(fis);
 204       applicationProperties.remove("LATEST_VERSION");
 205       applicationProperties.remove("VERSION");
 206       fis.close();
 207     } catch (Exception ex)
 208     {
 209       System.out.println("Error reading properties file: " + ex);
 210     }
 211
 212     if (getDefault("USE_PROXY", false))
 213     {
 214       System.out.println("Using proxyServer: "
 215               + getDefault("PROXY_SERVER", null) + " proxyPort: "
 216               + getDefault("PROXY_PORT", null));
 217       System
 218               .setProperty("http.proxyHost", getDefault("PROXY_SERVER",
 219                       null));
 220       System.setProperty("http.proxyPort", getDefault("PROXY_PORT", null));
 221     }
 222
 223     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 224     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 225     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 226     try
 227     {
 228       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 229               .getCodeSource().getLocation().toString().concat(
 230                       "!/.build_properties"));
 231
 232       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 233
 234       InputStream in = localJarFileURL.openStream();
 235       applicationProperties.load(in);
 236       in.close();
 237     } catch (Exception ex)
 238     {
 239       System.out.println("Error reading build details: " + ex);
 240       applicationProperties.remove("VERSION");
 241     }
 242
 243     String jnlpVersion = System.getProperty("jalview.version");
 244     String codeVersion = getProperty("VERSION");
 245
 246     if (codeVersion == null)
 247     {
 248       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 249       codeVersion = "Test";
 250       jnlpVersion = "Test";
 251     }
 252
 253     System.out.println("Jalview Version: " + codeVersion);
 254
 255     // jnlpVersion will be null if we're using InstallAnywhere
 256     // Dont do this check if running in headless mode
 257     if (jnlpVersion == null
 258             && (System.getProperty("java.awt.headless") == null || System
 259                     .getProperty("java.awt.headless").equals("false")))
 260     {
 261
 262       class VersionChecker extends Thread
 263       {
 264         public void run()
 265         {
 266           String orgtimeout = System
 267                   .getProperty("sun.net.client.defaultConnectTimeout");
 268           if (orgtimeout == null)
 269           {
 270             orgtimeout = "30";
 271             System.out.println("# INFO: Setting default net timeout to "
 272                     + orgtimeout + " seconds.");
 273           }
 274           String jnlpVersion = null;
 275           try
 276           {
 277             System.setProperty("sun.net.client.defaultConnectTimeout",
 278                     "5000");
 279             java.net.URL url = new java.net.URL(
 280                     "http://www.jalview.org/webstart/jalview.jnlp");
 281             BufferedReader in = new BufferedReader(new InputStreamReader(
 282                     url.openStream()));
 283             String line = null;
 284             while ((line = in.readLine()) != null)
 285             {
 286               if (line.indexOf("jalview.version") == -1)
 287               {
 288                 continue;
 289               }
 290
 291               line = line.substring(line.indexOf("value=") + 7);
 292               line = line.substring(0, line.lastIndexOf("\""));
 293               jnlpVersion = line;
 294               break;
 295             }
 296           } catch (Exception ex)
 297           {
 298             System.out
 299                     .println("Non-fatal exceptions when checking version at www.jalview.org :");
 300             System.out.println(ex);
 301             jnlpVersion = getProperty("VERSION");
 302           }
 303           System.setProperty("sun.net.client.defaultConnectTimeout",
 304                   orgtimeout);
 305
 306           setProperty("LATEST_VERSION", jnlpVersion);
 307         }
 308       }
 309
 310       VersionChecker vc = new VersionChecker();
 311       vc.start();
 312     }
 313     else
 314     {
 315       if (jnlpVersion != null)
 316       {
 317         setProperty("LATEST_VERSION", jnlpVersion);
 318       }
 319       else
 320       {
 321         applicationProperties.remove("LATEST_VERSION");
 322       }
 323     }
 324
 325     setProperty("VERSION", codeVersion);
 326
 327     // LOAD USERDEFINED COLOURS
 328     jalview.gui.UserDefinedColours
 329             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 330     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 331             false);
 332   }
 333
 334   /**
 335    * Gets Jalview application property of given key. Returns null if key not
 336    * found
 337    *
 338    * @param key
 339    *                Name of property
 340    *
 341    * @return Property value
 342    */
 343   public static String getProperty(String key)
 344   {
 345     return applicationProperties.getProperty(key);
 346   }
 347
 348   /**
 349    * These methods are used when checking if the saved preference is different
 350    * to the default setting
 351    */
 352
 353   public static boolean getDefault(String property, boolean def)
 354   {
 355     String string = getProperty(property);
 356     if (string != null)
 357     {
 358       def = Boolean.valueOf(string).booleanValue();
 359     }
 360
 361     return def;
 362   }
 363
 364   /**
 365    * These methods are used when checking if the saved preference is different
 366    * to the default setting
 367    */
 368   public static String getDefault(String property, String def)
 369   {
 370     String string = getProperty(property);
 371     if (string != null)
 372     {
 373       return string;
 374     }
 375
 376     return def;
 377   }
 378
 379   /**
 380    * Stores property in the file "HOME_DIR/.jalview_properties"
 381    *
 382    * @param key
 383    *                Name of object
 384    * @param obj
 385    *                String value of property
 386    *
 387    * @return String value of property
 388    */
 389   public static String setProperty(String key, String obj)
 390   {
 391     try
 392     {
 393       FileOutputStream out = new FileOutputStream(propertiesFile);
 394       applicationProperties.setProperty(key, obj);
 395       applicationProperties.store(out, "---JalviewX Properties File---");
 396       out.close();
 397     } catch (Exception ex)
 398     {
 399       System.out.println("Error setting property: " + key + " " + obj
 400               + "\n" + ex);
 401     }
 402     return obj;
 403   }
 404
 405   public static void saveProperties()
 406   {
 407     try
 408     {
 409       FileOutputStream out = new FileOutputStream(propertiesFile);
 410       applicationProperties.store(out, "---JalviewX Properties File---");
 411       out.close();
 412     } catch (Exception ex)
 413     {
 414       System.out.println("Error saving properties: " + ex);
 415     }
 416   }
 417
 418   /**
 419    * internal vamsas class discovery state
 420    */
 421   private static int vamsasJarsArePresent = -1;
 422
 423   /**
 424    * Searches for vamsas client classes on class path.
 425    *
 426    * @return true if vamsas client is present on classpath
 427    */
 428   public static boolean vamsasJarsPresent()
 429   {
 430     if (vamsasJarsArePresent == -1)
 431     {
 432       try
 433       {
 434         if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
 435                 "uk.ac.vamsas.client.VorbaId") != null)
 436         {
 437           jalview.bin.Cache.log
 438                   .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 439           vamsasJarsArePresent = 1;
 440           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 441           lvclient.setLevel(Level.toLevel(Cache.getDefault(
 442                   "logs.Vamsas.Level", Level.INFO.toString())));
 443
 444           lvclient.addAppender(log.getAppender("JalviewLogger"));
 445           // Tell the user that debug is enabled
 446           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 447         }
 448       } catch (Exception e)
 449       {
 450         vamsasJarsArePresent = 0;
 451         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 452       }
 453     }
 454     return (vamsasJarsArePresent > 0);
 455   }
 456
 457   /**
 458    * internal vamsas class discovery state
 459    */
 460   private static int groovyJarsArePresent = -1;
 461
 462   /**
 463    * Searches for vamsas client classes on class path.
 464    *
 465    * @return true if vamsas client is present on classpath
 466    */
 467   public static boolean groovyJarsPresent()
 468   {
 469     if (groovyJarsArePresent == -1)
 470     {
 471       try
 472       {
 473         if (Cache.class.getClassLoader().loadClass(
 474                 "groovy.lang.GroovyObject") != null)
 475         {
 476           jalview.bin.Cache.log
 477                   .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
 478           groovyJarsArePresent = 1;
 479           Logger lgclient = Logger.getLogger("groovy");
 480           lgclient.setLevel(Level.toLevel(Cache.getDefault(
 481                   "logs.Groovy.Level", Level.INFO.toString())));
 482
 483           lgclient.addAppender(log.getAppender("JalviewLogger"));
 484           // Tell the user that debug is enabled
 485           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 486         }
 487       } catch (Exception e)
 488       {
 489         groovyJarsArePresent = 0;
 490         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 491       }
 492     }
 493     return (groovyJarsArePresent > 0);
 494   }
 495
 496   /**
 497    * generate Das1Sources from the local das source list
 498    * @return Vector of Das1Sources
 499    */
 500   public static Vector getLocalDasSources()
 501   {
 502     Vector localSources = new Vector();
 503     String local = jalview.bin.Cache.getProperty("DAS_LOCAL_SOURCE");
 504     if (local != null)
 505     {
 506       StringTokenizer st = new StringTokenizer(local, "\t");
 507       while (st.hasMoreTokens())
 508       {
 509         String token = st.nextToken();
 510         int bar = token.indexOf("|");
 511         Das1Source source = new Das1Source();
 512         source.setUrl(token.substring(bar + 1));
 513         if (source.getUrl().startsWith("sequence:"))
 514         {
 515           source.setUrl(source.getUrl().substring(9));
 516           // this source also serves sequences as well as features
 517           source.setCapabilities(new String[] { "sequence", "features"});
 518         } else {
 519           // default is that all user added sources serve features
 520           source.setCapabilities(new String[] { "features"});
 521         }
 522
 523         source.setNickname(token.substring(0, bar));
 524
 525         localSources.addElement(source);
 526       }
 527     }
 528     return localSources;
 529   }
 530
 531 }