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> </li>
 111  *
 112  * </ul>
 113  *
 114  * @author $author$
 115  * @version $Revision$
 116  */
 117 public class Cache
 118 {
 119   /**
 120    * property giving log4j level for CASTOR loggers
 121    */
 122   public static final String CASTORLOGLEVEL = "logs.Castor.level";
 123
 124   /**
 125    * property giving log4j level for AXIS loggers
 126    */
 127   public static final String AXISLOGLEVEL = "logs.Axis.level";
 128
 129   /**
 130    * property giving log4j level for Jalview Log
 131    */
 132   public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
 133
 134   public static final String DAS_LOCAL_SOURCE = "DAS_LOCAL_SOURCE";
 135
 136   public static final String DAS_REGISTRY_URL = "DAS_REGISTRY_URL";
 137
 138   public static final String DAS_ACTIVE_SOURCE = "DAS_ACTIVE_SOURCE";
 139
 140   /**
 141    * Initialises the Jalview Application Log
 142    */
 143   public static Logger log;
 144
 145   /** Jalview Properties */
 146   public static Properties applicationProperties = new Properties();
 147
 148   /** Default file is ~/.jalview_properties */
 149   static String propertiesFile;
 150
 151   public static void initLogger()
 152   {
 153     try
 154     {
 155       ConsoleAppender ap = new ConsoleAppender(new SimpleLayout(),
 156               "System.err");
 157       ap.setName("JalviewLogger");
 158       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
 159                                                                 // log output
 160       Logger laxis = Logger.getLogger("org.apache.axis");
 161       Logger lcastor = Logger.getLogger("org.exolab.castor");
 162       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
 163
 164       laxis.setLevel(Level.toLevel(Cache.getDefault("logs.Axis.Level",
 165               Level.INFO.toString())));
 166       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 167               Level.INFO.toString())));
 168       lcastor = Logger.getLogger("org.exolab.castor.xml");
 169       lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 170               Level.INFO.toString())));
 171       // lcastor = Logger.getLogger("org.exolab.castor.xml.Marshaller");
 172       // lcastor.setLevel(Level.toLevel(Cache.getDefault("logs.Castor.Level",
 173       // Level.INFO.toString())));
 174       jalview.bin.Cache.log.setLevel(Level.toLevel(Cache.getDefault(
 175               "logs.Jalview.level", Level.INFO.toString())));
 176       // laxis.addAppender(ap);
 177       // lcastor.addAppender(ap);
 178       // jalview.bin.Cache.log.addAppender(ap);
 179       // Tell the user that debug is enabled
 180       jalview.bin.Cache.log.debug("Jalview Debugging Output Follows.");
 181     } catch (Exception ex)
 182     {
 183       System.err.println("Problems initializing the log4j system\n");
 184       ex.printStackTrace(System.err);
 185     }
 186   }
 187
 188   /** Called when Jalview is started */
 189   public static void loadProperties(String propsFile)
 190   {
 191     propertiesFile = propsFile;
 192     if (propsFile == null)
 193     {
 194       propertiesFile = System.getProperty("user.home") + File.separatorChar
 195               + ".jalview_properties";
 196     }
 197
 198     try
 199     {
 200       FileInputStream fis = new FileInputStream(propertiesFile);
 201       applicationProperties.load(fis);
 202       applicationProperties.remove("LATEST_VERSION");
 203       applicationProperties.remove("VERSION");
 204       fis.close();
 205     } catch (Exception ex)
 206     {
 207       System.out.println("Error reading properties file: " + ex);
 208     }
 209
 210     if (getDefault("USE_PROXY", false))
 211     {
 212       System.out.println("Using proxyServer: "
 213               + getDefault("PROXY_SERVER", null) + " proxyPort: "
 214               + getDefault("PROXY_PORT", null));
 215       System
 216               .setProperty("http.proxyHost", getDefault("PROXY_SERVER",
 217                       null));
 218       System.setProperty("http.proxyPort", getDefault("PROXY_PORT", null));
 219     }
 220
 221     // FIND THE VERSION NUMBER AND BUILD DATE FROM jalview.jar
 222     // MUST FOLLOW READING OF LOCAL PROPERTIES FILE AS THE
 223     // VERSION MAY HAVE CHANGED SINCE LAST USING JALVIEW
 224     try
 225     {
 226       String buildDetails = "jar:".concat(Cache.class.getProtectionDomain()
 227               .getCodeSource().getLocation().toString().concat(
 228                       "!/.build_properties"));
 229
 230       java.net.URL localJarFileURL = new java.net.URL(buildDetails);
 231
 232       InputStream in = localJarFileURL.openStream();
 233       applicationProperties.load(in);
 234       in.close();
 235     } catch (Exception ex)
 236     {
 237       System.out.println("Error reading build details: " + ex);
 238       applicationProperties.remove("VERSION");
 239     }
 240
 241     String jnlpVersion = System.getProperty("jalview.version");
 242     String codeVersion = getProperty("VERSION");
 243
 244     if (codeVersion == null)
 245     {
 246       // THIS SHOULD ONLY BE THE CASE WHEN TESTING!!
 247       codeVersion = "Test";
 248       jnlpVersion = "Test";
 249     }
 250
 251     System.out.println("Jalview Version: " + codeVersion);
 252
 253     // jnlpVersion will be null if we're using InstallAnywhere
 254     // Dont do this check if running in headless mode
 255     if (jnlpVersion == null
 256             && (System.getProperty("java.awt.headless") == null || System
 257                     .getProperty("java.awt.headless").equals("false")))
 258     {
 259
 260       class VersionChecker extends Thread
 261       {
 262         public void run()
 263         {
 264           String orgtimeout = System
 265                   .getProperty("sun.net.client.defaultConnectTimeout");
 266           if (orgtimeout == null)
 267           {
 268             orgtimeout = "30";
 269             System.out.println("# INFO: Setting default net timeout to "
 270                     + orgtimeout + " seconds.");
 271           }
 272           String jnlpVersion = null;
 273           try
 274           {
 275             System.setProperty("sun.net.client.defaultConnectTimeout",
 276                     "5000");
 277             java.net.URL url = new java.net.URL(
 278                     "http://www.jalview.org/webstart/jalview.jnlp");
 279             BufferedReader in = new BufferedReader(new InputStreamReader(
 280                     url.openStream()));
 281             String line = null;
 282             while ((line = in.readLine()) != null)
 283             {
 284               if (line.indexOf("jalview.version") == -1)
 285               {
 286                 continue;
 287               }
 288
 289               line = line.substring(line.indexOf("value=") + 7);
 290               line = line.substring(0, line.lastIndexOf("\""));
 291               jnlpVersion = line;
 292               break;
 293             }
 294           } catch (Exception ex)
 295           {
 296             System.out
 297                     .println("Non-fatal exceptions when checking version at www.jalview.org :");
 298             System.out.println(ex);
 299             jnlpVersion = getProperty("VERSION");
 300           }
 301           System.setProperty("sun.net.client.defaultConnectTimeout",
 302                   orgtimeout);
 303
 304           setProperty("LATEST_VERSION", jnlpVersion);
 305         }
 306       }
 307
 308       VersionChecker vc = new VersionChecker();
 309       vc.start();
 310     }
 311     else
 312     {
 313       if (jnlpVersion != null)
 314       {
 315         setProperty("LATEST_VERSION", jnlpVersion);
 316       }
 317       else
 318       {
 319         applicationProperties.remove("LATEST_VERSION");
 320       }
 321     }
 322
 323     setProperty("VERSION", codeVersion);
 324
 325     // LOAD USERDEFINED COLOURS
 326     jalview.gui.UserDefinedColours
 327             .initUserColourSchemes(getProperty("USER_DEFINED_COLOURS"));
 328     jalview.io.PIRFile.useModellerOutput = Cache.getDefault("PIR_MODELLER",
 329             false);
 330   }
 331
 332   /**
 333    * Gets Jalview application property of given key. Returns null if key not
 334    * found
 335    *
 336    * @param key
 337    *                Name of property
 338    *
 339    * @return Property value
 340    */
 341   public static String getProperty(String key)
 342   {
 343     return applicationProperties.getProperty(key);
 344   }
 345
 346   /**
 347    * These methods are used when checking if the saved preference is different
 348    * to the default setting
 349    */
 350
 351   public static boolean getDefault(String property, boolean def)
 352   {
 353     String string = getProperty(property);
 354     if (string != null)
 355     {
 356       def = Boolean.valueOf(string).booleanValue();
 357     }
 358
 359     return def;
 360   }
 361
 362   /**
 363    * These methods are used when checking if the saved preference is different
 364    * to the default setting
 365    */
 366   public static String getDefault(String property, String def)
 367   {
 368     String string = getProperty(property);
 369     if (string != null)
 370     {
 371       return string;
 372     }
 373
 374     return def;
 375   }
 376
 377   /**
 378    * Stores property in the file "HOME_DIR/.jalview_properties"
 379    *
 380    * @param key
 381    *                Name of object
 382    * @param obj
 383    *                String value of property
 384    *
 385    * @return String value of property
 386    */
 387   public static String setProperty(String key, String obj)
 388   {
 389     try
 390     {
 391       FileOutputStream out = new FileOutputStream(propertiesFile);
 392       applicationProperties.setProperty(key, obj);
 393       applicationProperties.store(out, "---JalviewX Properties File---");
 394       out.close();
 395     } catch (Exception ex)
 396     {
 397       System.out.println("Error setting property: " + key + " " + obj
 398               + "\n" + ex);
 399     }
 400     return obj;
 401   }
 402
 403   public static void saveProperties()
 404   {
 405     try
 406     {
 407       FileOutputStream out = new FileOutputStream(propertiesFile);
 408       applicationProperties.store(out, "---JalviewX Properties File---");
 409       out.close();
 410     } catch (Exception ex)
 411     {
 412       System.out.println("Error saving properties: " + ex);
 413     }
 414   }
 415
 416   /**
 417    * internal vamsas class discovery state
 418    */
 419   private static int vamsasJarsArePresent = -1;
 420
 421   /**
 422    * Searches for vamsas client classes on class path.
 423    *
 424    * @return true if vamsas client is present on classpath
 425    */
 426   public static boolean vamsasJarsPresent()
 427   {
 428     if (vamsasJarsArePresent == -1)
 429     {
 430       try
 431       {
 432         if (jalview.jbgui.GDesktop.class.getClassLoader().loadClass(
 433                 "uk.ac.vamsas.client.VorbaId") != null)
 434         {
 435           jalview.bin.Cache.log
 436                   .debug("Found Vamsas Classes (uk.ac..vamsas.client.VorbaId can be loaded)");
 437           vamsasJarsArePresent = 1;
 438           Logger lvclient = Logger.getLogger("uk.ac.vamsas");
 439           lvclient.setLevel(Level.toLevel(Cache.getDefault(
 440                   "logs.Vamsas.Level", Level.INFO.toString())));
 441
 442           lvclient.addAppender(log.getAppender("JalviewLogger"));
 443           // Tell the user that debug is enabled
 444           lvclient.debug("Jalview Vamsas Client Debugging Output Follows.");
 445         }
 446       } catch (Exception e)
 447       {
 448         vamsasJarsArePresent = 0;
 449         jalview.bin.Cache.log.debug("Vamsas Classes are not present");
 450       }
 451     }
 452     return (vamsasJarsArePresent > 0);
 453   }
 454
 455   /**
 456    * internal vamsas class discovery state
 457    */
 458   private static int groovyJarsArePresent = -1;
 459
 460   /**
 461    * Searches for vamsas client classes on class path.
 462    *
 463    * @return true if vamsas client is present on classpath
 464    */
 465   public static boolean groovyJarsPresent()
 466   {
 467     if (groovyJarsArePresent == -1)
 468     {
 469       try
 470       {
 471         if (Cache.class.getClassLoader().loadClass(
 472                 "groovy.lang.GroovyObject") != null)
 473         {
 474           jalview.bin.Cache.log
 475                   .debug("Found Groovy (groovy.lang.GroovyObject can be loaded)");
 476           groovyJarsArePresent = 1;
 477           Logger lgclient = Logger.getLogger("groovy");
 478           lgclient.setLevel(Level.toLevel(Cache.getDefault(
 479                   "logs.Groovy.Level", Level.INFO.toString())));
 480
 481           lgclient.addAppender(log.getAppender("JalviewLogger"));
 482           // Tell the user that debug is enabled
 483           lgclient.debug("Jalview Groovy Client Debugging Output Follows.");
 484         }
 485       } catch (Exception e)
 486       {
 487         groovyJarsArePresent = 0;
 488         jalview.bin.Cache.log.debug("Groovy Classes are not present");
 489       }
 490     }
 491     return (groovyJarsArePresent > 0);
 492   }
 493
 494   /**
 495    * generate Das1Sources from the local das source list
 496    * @return Vector of Das1Sources
 497    */
 498   public static Vector getLocalDasSources()
 499   {
 500     Vector localSources = new Vector();
 501     String local = jalview.bin.Cache.getProperty("DAS_LOCAL_SOURCE");
 502     if (local != null)
 503     {
 504       StringTokenizer st = new StringTokenizer(local, "\t");
 505       while (st.hasMoreTokens())
 506       {
 507         String token = st.nextToken();
 508         int bar = token.indexOf("|");
 509         Das1Source source = new Das1Source();
 510         source.setUrl(token.substring(bar + 1));
 511         if (source.getUrl().startsWith("sequence:"))
 512         {
 513           source.setUrl(source.getUrl().substring(9));
 514           // this source also serves sequences as well as features
 515           source.setCapabilities(new String[] { "sequence", "features"});
 516         } else {
 517           // default is that all user added sources serve features
 518           source.setCapabilities(new String[] { "features"});
 519         }
 520
 521         source.setNickname(token.substring(0, bar));
 522
 523         localSources.addElement(source);
 524       }
 525     }
 526     return localSources;
 527   }
 528
 529 }