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     int responseCode = connection.getResponseCode();
 252
 253     if (responseCode != 200)
 254     {
 255       /*
 256        * note: a GET request for an invalid id returns an error code e.g. 415
 257        * but POST request returns 200 and an empty Fasta response
 258        */
 259       throw new IOException(
 260               "Response code was not 200. Detected response was "
 261                       + responseCode);
 262     }
 263     // get content
 264     InputStream response = connection.getInputStream();
 265
 266     // System.out.println(getClass().getName() + " took "
 267     // + (System.currentTimeMillis() - now) + "ms to fetch");
 268
 269     checkRateLimits(connection);
 270
 271     BufferedReader reader = null;
 272     reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
 273     return reader;
 274   }
 275
 276   /**
 277    * Inspect response headers for any sign of server overload and respect any
 278    * 'retry-after' directive
 279    *
 280    * @see https://github.com/Ensembl/ensembl-rest/wiki/Rate-Limits
 281    * @param connection
 282    */
 283   void checkRateLimits(HttpURLConnection connection)
 284   {
 285     // number of requests allowed per time interval:
 286     String limit = connection.getHeaderField("X-RateLimit-Limit");
 287     // length of quota time interval in seconds:
 288     // String period = connection.getHeaderField("X-RateLimit-Period");
 289     // seconds remaining until usage quota is reset:
 290     String reset = connection.getHeaderField("X-RateLimit-Reset");
 291     // number of requests remaining from quota for current period:
 292     String remaining = connection.getHeaderField("X-RateLimit-Remaining");
 293     // number of seconds to wait before retrying (if remaining == 0)
 294     String retryDelay = connection.getHeaderField("Retry-After");
 295
 296     // to test:
 297     // retryDelay = "5";
 298
 299     EnsemblInfo info = domainData.get(getDomain());
 300     if (retryDelay != null)
 301     {
 302       System.err.println("Ensembl REST service rate limit exceeded, wait "
 303               + retryDelay + " seconds before retrying");
 304       try
 305       {
 306         info.retryAfter = System.currentTimeMillis()
 307                 + (1000 * Integer.valueOf(retryDelay));
 308       } catch (NumberFormatException e)
 309       {
 310         System.err.println("Unexpected value for Retry-After: "
 311                 + retryDelay);
 312       }
 313     }
 314     else
 315     {
 316       info.retryAfter = 0;
 317       // debug:
 318       // System.out.println(String.format(
 319       // "%s Ensembl requests remaining of %s (reset in %ss)",
 320       // remaining, limit, reset));
 321     }
 322   }
 323
 324   /**
 325    * Rechecks if Ensembl is responding, unless the last check was successful and
 326    * the retest interval has not yet elapsed. Returns true if Ensembl is up,
 327    * else false. Also retrieves and saves the current version of Ensembl data
 328    * and REST services at intervals.
 329    *
 330    * @return
 331    */
 332   protected boolean isEnsemblAvailable()
 333   {
 334     EnsemblInfo info = domainData.get(getDomain());
 335
 336     long now = System.currentTimeMillis();
 337
 338     /*
 339      * check if we are waiting for 'Retry-After' to expire
 340      */
 341     if (info.retryAfter > now)
 342     {
 343       System.err.println("Still " + (1 + (info.retryAfter - now) / 1000)
 344               + " secs to wait before retrying Ensembl");
 345       return false;
 346     }
 347     else
 348     {
 349       info.retryAfter = 0;
 350     }
 351
 352     /*
 353      * recheck if Ensembl is up if it was down, or the recheck period has elapsed
 354      */
 355     boolean retestAvailability = (now - info.lastAvailableCheckTime) > AVAILABILITY_RETEST_INTERVAL;
 356     if (!info.restAvailable || retestAvailability)
 357     {
 358       info.restAvailable = checkEnsembl();
 359       info.lastAvailableCheckTime = now;
 360     }
 361
 362     /*
 363      * refetch Ensembl versions if the recheck period has elapsed
 364      */
 365     boolean refetchVersion = (now - info.lastVersionCheckTime) > VERSION_RETEST_INTERVAL;
 366     if (refetchVersion)
 367     {
 368       checkEnsemblRestVersion();
 369       checkEnsemblDataVersion();
 370       info.lastVersionCheckTime = now;
 371     }
 372
 373     return info.restAvailable;
 374   }
 375
 376   /**
 377    * Constructs, writes and flushes the POST body of the request, containing the
 378    * query ids in JSON format
 379    *
 380    * @param connection
 381    * @param ids
 382    * @throws IOException
 383    */
 384   protected void writePostBody(HttpURLConnection connection,
 385           List<String> ids) throws IOException
 386   {
 387     boolean first;
 388     StringBuilder postBody = new StringBuilder(64);
 389     postBody.append("{\"ids\":[");
 390     first = true;
 391     for (String id : ids)
 392     {
 393       if (!first)
 394       {
 395         postBody.append(",");
 396       }
 397       first = false;
 398       postBody.append("\"");
 399       postBody.append(id.trim());
 400       postBody.append("\"");
 401     }
 402     postBody.append("]}");
 403     byte[] thepostbody = postBody.toString().getBytes();
 404     connection.setRequestProperty("Content-Length",
 405             Integer.toString(thepostbody.length));
 406     DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
 407     wr.write(thepostbody);
 408     wr.flush();
 409     wr.close();
 410   }
 411
 412   /**
 413    * Fetches and checks Ensembl's REST version number
 414    *
 415    * @return
 416    */
 417   private void checkEnsemblRestVersion()
 418   {
 419     EnsemblInfo info = domainData.get(getDomain());
 420
 421     JSONParser jp = new JSONParser();
 422     URL url = null;
 423     try
 424     {
 425       url = new URL(getDomain()
 426               + "/info/rest?content-type=application/json");
 427       BufferedReader br = getHttpResponse(url, null);
 428       JSONObject val = (JSONObject) jp.parse(br);
 429       String version = val.get("release").toString();
 430       String majorVersion = version.substring(0, version.indexOf("."));
 431       String expected = info.expectedRestVersion;
 432       String expectedMajorVersion = expected.substring(0,
 433               expected.indexOf("."));
 434       info.restMajorVersionMismatch = false;
 435       try
 436       {
 437         /*
 438          * if actual REST major version is ahead of what we expect,
 439          * record this in case we want to warn the user
 440          */
 441         if (Float.valueOf(majorVersion) > Float
 442                 .valueOf(expectedMajorVersion))
 443         {
 444           info.restMajorVersionMismatch = true;
 445         }
 446       } catch (NumberFormatException e)
 447       {
 448         System.err.println("Error in REST version: " + e.toString());
 449       }
 450
 451       /*
 452        * check if REST version is later than what Jalview has tested against,
 453        * if so warn; we don't worry if it is earlier (this indicates Jalview has
 454        * been tested in advance against the next pending REST version)
 455        */
 456       boolean laterVersion = StringUtils.compareVersions(version, expected) == 1;
 457       if (laterVersion)
 458       {
 459         System.err.println(String.format(
 460                 "Expected %s REST version %s but found %s, see %s",
 461                 getDbSource(), expected, version, REST_CHANGE_LOG));
 462       }
 463       info.restVersion = version;
 464     } catch (Throwable t)
 465     {
 466       System.err.println("Error checking Ensembl REST version: "
 467               + t.getMessage());
 468     }
 469   }
 470
 471   public boolean isRestMajorVersionMismatch()
 472   {
 473     return domainData.get(getDomain()).restMajorVersionMismatch;
 474   }
 475
 476   /**
 477    * Fetches and checks Ensembl's data version number
 478    *
 479    * @return
 480    */
 481   private void checkEnsemblDataVersion()
 482   {
 483     JSONParser jp = new JSONParser();
 484     URL url = null;
 485     try
 486     {
 487       url = new URL(getDomain()
 488               + "/info/data?content-type=application/json");
 489       BufferedReader br = getHttpResponse(url, null);
 490       JSONObject val = (JSONObject) jp.parse(br);
 491       JSONArray versions = (JSONArray) val.get("releases");
 492       domainData.get(getDomain()).dataVersion = versions.get(0).toString();
 493     } catch (Throwable t)
 494     {
 495       System.err.println("Error checking Ensembl data version: "
 496               + t.getMessage());
 497     }
 498   }
 499
 500   public String getEnsemblDataVersion()
 501   {
 502     return domainData.get(getDomain()).dataVersion;
 503   }
 504
 505   @Override
 506   public String getDbVersion()
 507   {
 508     return getEnsemblDataVersion();
 509   }
 510
 511 }