src/jalview/ext/ensembl/EnsemblRestClient.java

   1 package jalview.ext.ensembl;
   2
   3 import jalview.io.FileParse;
   4 import jalview.util.StringUtils;
   5
   6 import java.io.BufferedReader;
   7 import java.io.DataOutputStream;
   8 import java.io.IOException;
   9 import java.io.InputStream;
  10 import java.io.InputStreamReader;
  11 import java.net.HttpURLConnection;
  12 import java.net.MalformedURLException;
  13 import java.net.URL;
  14 import java.util.HashMap;
  15 import java.util.List;
  16 import java.util.Map;
  17
  18 import javax.ws.rs.HttpMethod;
  19
  20 import org.json.simple.JSONArray;
  21 import org.json.simple.JSONObject;
  22 import org.json.simple.parser.JSONParser;
  23
  24 import com.stevesoft.pat.Regex;
  25
  26 /**
  27  * Base class for Ensembl REST service clients
  28  *
  29  * @author gmcarstairs
  30  */
  31 abstract class EnsemblRestClient extends EnsemblSequenceFetcher
  32 {
  33   /*
  34    * update these constants when Jalview has been checked / updated for
  35    * changes to Ensembl REST API
  36    * @see https://github.com/Ensembl/ensembl-rest/wiki/Change-log
  37    */
  38   private static final String LATEST_ENSEMBLGENOMES_REST_VERSION = "4.6";
  39
  40   private static final String LATEST_ENSEMBL_REST_VERSION = "4.6";
  41
  42   private static final String REST_CHANGE_LOG = "https://github.com/Ensembl/ensembl-rest/wiki/Change-log";
  43
  44   private static Map<String, EnsemblInfo> domainData;
  45
  46   // @see https://github.com/Ensembl/ensembl-rest/wiki/Output-formats
  47   private static final String PING_URL = "http://rest.ensembl.org/info/ping.json";
  48
  49   private final static long AVAILABILITY_RETEST_INTERVAL = 10000L; // 10 seconds
  50
  51   private final static long VERSION_RETEST_INTERVAL = 1000L * 3600; // 1 hr
  52
  53   private static final Regex TRANSCRIPT_REGEX = new Regex(
  54             "(ENS)([A-Z]{3}|)T[0-9]{11}$");
  55
  56   private static final Regex GENE_REGEX = new Regex(
  57             "(ENS)([A-Z]{3}|)G[0-9]{11}$");
  58
  59   static
  60   {
  61     domainData = new HashMap<String, EnsemblInfo>();
  62     domainData.put(ENSEMBL_REST, new EnsemblInfo(ENSEMBL_REST,
  63             LATEST_ENSEMBL_REST_VERSION));
  64     domainData.put(ENSEMBL_GENOMES_REST, new EnsemblInfo(
  65             ENSEMBL_GENOMES_REST, LATEST_ENSEMBLGENOMES_REST_VERSION));
  66   }
  67
  68   protected volatile boolean inProgress = false;
  69
  70   /**
  71    * Default constructor to use rest.ensembl.org
  72    */
  73   public EnsemblRestClient()
  74   {
  75     this(ENSEMBL_REST);
  76   }
  77
  78   /**
  79    * Constructor given the target domain to fetch data from
  80    *
  81    * @param d
  82    */
  83   public EnsemblRestClient(String d)
  84   {
  85     setDomain(d);
  86   }
  87
  88   /**
  89    * Answers true if the query matches the regular expression pattern for an
  90    * Ensembl transcript stable identifier
  91    *
  92    * @param query
  93    * @return
  94    */
  95   public boolean isTranscriptIdentifier(String query)
  96   {
  97     return query == null ? false : TRANSCRIPT_REGEX.search(query);
  98   }
  99
 100   /**
 101    * Answers true if the query matches the regular expression pattern for an
 102    * Ensembl gene stable identifier
 103    *
 104    * @param query
 105    * @return
 106    */
 107   public boolean isGeneIdentifier(String query)
 108   {
 109     return query == null ? false : GENE_REGEX.search(query);
 110   }
 111
 112   @Override
 113   public boolean queryInProgress()
 114   {
 115     return inProgress;
 116   }
 117
 118   @Override
 119   public StringBuffer getRawRecords()
 120   {
 121     return null;
 122   }
 123
 124   /**
 125    * Returns the URL for the client http request
 126    *
 127    * @param ids
 128    * @return
 129    * @throws MalformedURLException
 130    */
 131   protected abstract URL getUrl(List<String> ids)
 132           throws MalformedURLException;
 133
 134   /**
 135    * Returns true if client uses GET method, false if it uses POST
 136    *
 137    * @return
 138    */
 139   protected abstract boolean useGetRequest();
 140
 141   /**
 142    * Return the desired value for the Content-Type request header
 143    *
 144    * @param multipleIds
 145    *
 146    * @return
 147    * @see https://github.com/Ensembl/ensembl-rest/wiki/HTTP-Headers
 148    */
 149   protected abstract String getRequestMimeType(boolean multipleIds);
 150
 151   /**
 152    * Return the desired value for the Accept request header
 153    *
 154    * @return
 155    * @see https://github.com/Ensembl/ensembl-rest/wiki/HTTP-Headers
 156    */
 157   protected abstract String getResponseMimeType();
 158
 159   /**
 160    * Checks Ensembl's REST 'ping' endpoint, and returns true if response
 161    * indicates available, else false
 162    *
 163    * @see http://rest.ensembl.org/documentation/info/ping
 164    * @return
 165    */
 166   private boolean checkEnsembl()
 167   {
 168     HttpURLConnection conn = null;
 169     try
 170     {
 171       // note this format works for both ensembl and ensemblgenomes
 172       // info/ping.json works for ensembl only (March 2016)
 173       URL ping = new URL(getDomain()
 174               + "/info/ping?content-type=application/json");
 175
 176       /*
 177        * expect {"ping":1} if ok
 178        */
 179       BufferedReader br = getHttpResponse(ping, null);
 180       JSONParser jp = new JSONParser();
 181       JSONObject val = (JSONObject) jp.parse(br);
 182       String pingString = val.get("ping").toString();
 183       return pingString != null;
 184     } catch (Throwable t)
 185     {
 186       System.err.println("Error connecting to " + PING_URL + ": "
 187               + t.getMessage());
 188     } finally
 189     {
 190       if (conn != null)
 191       {
 192         conn.disconnect();
 193       }
 194     }
 195     return false;
 196   }
 197
 198   /**
 199    * returns a reader to a Fasta response from the Ensembl sequence endpoint
 200    *
 201    * @param ids
 202    * @return
 203    * @throws IOException
 204    */
 205   protected FileParse getSequenceReader(List<String> ids)
 206           throws IOException
 207   {
 208     URL url = getUrl(ids);
 209
 210     BufferedReader reader = getHttpResponse(url, ids);
 211     FileParse fp = new FileParse(reader, url.toString(), "HTTP_POST");
 212     return fp;
 213   }
 214
 215   /**
 216    * Writes the HTTP request and gets the response as a reader.
 217    *
 218    * @param url
 219    * @param ids
 220    *          written as Json POST body if more than one
 221    * @return
 222    * @throws IOException
 223    *           if response code was not 200, or other I/O error
 224    */
 225   protected BufferedReader getHttpResponse(URL url, List<String> ids)
 226           throws IOException
 227   {
 228     // long now = System.currentTimeMillis();
 229     HttpURLConnection connection = (HttpURLConnection) url.openConnection();
 230
 231     /*
 232      * POST method allows multiple queries in one request; it is supported for
 233      * sequence queries, but not for overlap
 234      */
 235     boolean multipleIds = ids != null && ids.size() > 1;
 236     connection.setRequestMethod(multipleIds ? HttpMethod.POST
 237             : HttpMethod.GET);
 238     connection.setRequestProperty("Content-Type",
 239             getRequestMimeType(multipleIds));
 240     connection.setRequestProperty("Accept", getResponseMimeType());
 241
 242     connection.setUseCaches(false);
 243     connection.setDoInput(true);
 244     connection.setDoOutput(multipleIds);
 245
 246     if (multipleIds)
 247     {
 248       writePostBody(connection, ids);
 249     }
 250
 251     InputStream response = connection.getInputStream();
 252     int responseCode = connection.getResponseCode();
 253
 254     if (responseCode != 200)
 255     {
 256       /*
 257        * note: a GET request for an invalid id returns an error code e.g. 415
 258        * but POST request returns 200 and an empty Fasta response
 259        */
 260       throw new IOException(
 261               "Response code was not 200. Detected response was "
 262                       + responseCode);
 263     }
 264     // System.out.println(getClass().getName() + " took "
 265     // + (System.currentTimeMillis() - now) + "ms to fetch");
 266
 267     checkRateLimits(connection);
 268
 269     BufferedReader reader = null;
 270     reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
 271     return reader;
 272   }
 273
 274   /**
 275    * Inspect response headers for any sign of server overload and respect any
 276    * 'retry-after' directive
 277    *
 278    * @see https://github.com/Ensembl/ensembl-rest/wiki/Rate-Limits
 279    * @param connection
 280    */
 281   void checkRateLimits(HttpURLConnection connection)
 282   {
 283     // number of requests allowed per time interval:
 284     String limit = connection.getHeaderField("X-RateLimit-Limit");
 285     // length of quota time interval in seconds:
 286     // String period = connection.getHeaderField("X-RateLimit-Period");
 287     // seconds remaining until usage quota is reset:
 288     String reset = connection.getHeaderField("X-RateLimit-Reset");
 289     // number of requests remaining from quota for current period:
 290     String remaining = connection.getHeaderField("X-RateLimit-Remaining");
 291     // number of seconds to wait before retrying (if remaining == 0)
 292     String retryDelay = connection.getHeaderField("Retry-After");
 293
 294     // to test:
 295     // retryDelay = "5";
 296
 297     EnsemblInfo info = domainData.get(getDomain());
 298     if (retryDelay != null)
 299     {
 300       System.err.println("Ensembl REST service rate limit exceeded, wait "
 301               + retryDelay + " seconds before retrying");
 302       try
 303       {
 304         info.retryAfter = System.currentTimeMillis()
 305                 + (1000 * Integer.valueOf(retryDelay));
 306       } catch (NumberFormatException e)
 307       {
 308         System.err.println("Unexpected value for Retry-After: "
 309                 + retryDelay);
 310       }
 311     }
 312     else
 313     {
 314       info.retryAfter = 0;
 315       // debug:
 316       // System.out.println(String.format(
 317       // "%s Ensembl requests remaining of %s (reset in %ss)",
 318       // remaining, limit, reset));
 319     }
 320   }
 321
 322   /**
 323    * Rechecks if Ensembl is responding, unless the last check was successful and
 324    * the retest interval has not yet elapsed. Returns true if Ensembl is up,
 325    * else false. Also retrieves and saves the current version of Ensembl data
 326    * and REST services at intervals.
 327    *
 328    * @return
 329    */
 330   protected boolean isEnsemblAvailable()
 331   {
 332     EnsemblInfo info = domainData.get(getDomain());
 333
 334     long now = System.currentTimeMillis();
 335
 336     /*
 337      * check if we are waiting for 'Retry-After' to expire
 338      */
 339     if (info.retryAfter > now)
 340     {
 341       System.err.println("Still " + (1 + (info.retryAfter - now) / 1000)
 342               + " secs to wait before retrying Ensembl");
 343       return false;
 344     }
 345     else
 346     {
 347       info.retryAfter = 0;
 348     }
 349
 350     /*
 351      * recheck if Ensembl is up if it was down, or the recheck period has elapsed
 352      */
 353     boolean retestAvailability = (now - info.lastAvailableCheckTime) > AVAILABILITY_RETEST_INTERVAL;
 354     if (!info.restAvailable || retestAvailability)
 355     {
 356       info.restAvailable = checkEnsembl();
 357       info.lastAvailableCheckTime = now;
 358     }
 359
 360     /*
 361      * refetch Ensembl versions if the recheck period has elapsed
 362      */
 363     boolean refetchVersion = (now - info.lastVersionCheckTime) > VERSION_RETEST_INTERVAL;
 364     if (refetchVersion)
 365     {
 366       checkEnsemblRestVersion();
 367       checkEnsemblDataVersion();
 368       info.lastVersionCheckTime = now;
 369     }
 370
 371     return info.restAvailable;
 372   }
 373
 374   /**
 375    * Constructs, writes and flushes the POST body of the request, containing the
 376    * query ids in JSON format
 377    *
 378    * @param connection
 379    * @param ids
 380    * @throws IOException
 381    */
 382   protected void writePostBody(HttpURLConnection connection,
 383           List<String> ids) throws IOException
 384   {
 385     boolean first;
 386     StringBuilder postBody = new StringBuilder(64);
 387     postBody.append("{\"ids\":[");
 388     first = true;
 389     for (String id : ids)
 390     {
 391       if (!first)
 392       {
 393         postBody.append(",");
 394       }
 395       first = false;
 396       postBody.append("\"");
 397       postBody.append(id.trim());
 398       postBody.append("\"");
 399     }
 400     postBody.append("]}");
 401     byte[] thepostbody = postBody.toString().getBytes();
 402     connection.setRequestProperty("Content-Length",
 403             Integer.toString(thepostbody.length));
 404     DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
 405     wr.write(thepostbody);
 406     wr.flush();
 407     wr.close();
 408   }
 409
 410   /**
 411    * Fetches and checks Ensembl's REST version number
 412    *
 413    * @return
 414    */
 415   private void checkEnsemblRestVersion()
 416   {
 417     EnsemblInfo info = domainData.get(getDomain());
 418
 419     JSONParser jp = new JSONParser();
 420     URL url = null;
 421     try
 422     {
 423       url = new URL(getDomain()
 424               + "/info/rest?content-type=application/json");
 425       BufferedReader br = getHttpResponse(url, null);
 426       JSONObject val = (JSONObject) jp.parse(br);
 427       String version = val.get("release").toString();
 428       String majorVersion = version.substring(0, version.indexOf("."));
 429       String expected = info.expectedRestVersion;
 430       String expectedMajorVersion = expected.substring(0,
 431               expected.indexOf("."));
 432       info.restMajorVersionMismatch = false;
 433       try
 434       {
 435         /*
 436          * if actual REST major version is ahead of what we expect,
 437          * record this in case we want to warn the user
 438          */
 439         if (Float.valueOf(majorVersion) > Float
 440                 .valueOf(expectedMajorVersion))
 441         {
 442           info.restMajorVersionMismatch = true;
 443         }
 444       } catch (NumberFormatException e)
 445       {
 446         System.err.println("Error in REST version: " + e.toString());
 447       }
 448
 449       /*
 450        * check if REST version is later than what Jalview has tested against,
 451        * if so warn; we don't worry if it is earlier (this indicates Jalview has
 452        * been tested in advance against the next pending REST version)
 453        */
 454       boolean laterVersion = StringUtils.compareVersions(version, expected) == 1;
 455       if (laterVersion)
 456       {
 457         System.err.println(String.format(
 458                 "Expected %s REST version %s but found %s, see %s",
 459                 getDbSource(), expected, version, REST_CHANGE_LOG));
 460       }
 461       info.restVersion = version;
 462     } catch (Throwable t)
 463     {
 464       System.err.println("Error checking Ensembl REST version: "
 465               + t.getMessage());
 466     }
 467   }
 468
 469   public boolean isRestMajorVersionMismatch()
 470   {
 471     return domainData.get(getDomain()).restMajorVersionMismatch;
 472   }
 473
 474   /**
 475    * Fetches and checks Ensembl's data version number
 476    *
 477    * @return
 478    */
 479   private void checkEnsemblDataVersion()
 480   {
 481     JSONParser jp = new JSONParser();
 482     URL url = null;
 483     try
 484     {
 485       url = new URL(getDomain()
 486               + "/info/data?content-type=application/json");
 487       BufferedReader br = getHttpResponse(url, null);
 488       JSONObject val = (JSONObject) jp.parse(br);
 489       JSONArray versions = (JSONArray) val.get("releases");
 490       domainData.get(getDomain()).dataVersion = versions.get(0).toString();
 491     } catch (Throwable t)
 492     {
 493       System.err.println("Error checking Ensembl data version: "
 494               + t.getMessage());
 495     }
 496   }
 497
 498   public String getEnsemblDataVersion()
 499   {
 500     return domainData.get(getDomain()).dataVersion;
 501   }
 502
 503   @Override
 504   public String getDbVersion()
 505   {
 506     return getEnsemblDataVersion();
 507   }
 508
 509 }