/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
* Jalview is free software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
*
* Jalview is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
-package jalview.ws.ebi;\r
-\r
-import java.io.BufferedInputStream;\r
-import java.io.BufferedReader;\r
-import java.io.File;\r
-import java.io.FileOutputStream;\r
-import java.io.InputStreamReader;\r
-import java.net.URL;\r
-import java.util.ArrayList;\r
-import java.util.StringTokenizer;\r
-\r
-/**\r
- * DOCUMENT ME!\r
- * \r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class EBIFetchClient\r
-{\r
- String format = "default";\r
-\r
- String style = "raw";\r
-\r
- /**\r
- * Creates a new EBIFetchClient object.\r
- */\r
- public EBIFetchClient()\r
- {\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- * \r
- * @return DOCUMENT ME!\r
- */\r
- public String[] getSupportedDBs()\r
- {\r
- // TODO - implement rest call for dbfetch getSupportedDBs\r
- throw new Error("Not yet implemented");\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- * \r
- * @return DOCUMENT ME!\r
- */\r
- public String[] getSupportedFormats()\r
- {\r
- // TODO - implement rest call for dbfetch getSupportedFormats\r
- throw new Error("Not yet implemented");\r
- }\r
-\r
- /**\r
- * DOCUMENT ME!\r
- * \r
- * @return DOCUMENT ME!\r
- */\r
- public String[] getSupportedStyles()\r
- {\r
- // TODO - implement rest call for dbfetch getSupportedStyles\r
- throw new Error("Not yet implemented");\r
- }\r
-\r
- public File fetchDataAsFile(String ids, String f, String s)\r
- throws OutOfMemoryError\r
- {\r
- File outFile = null;\r
- try\r
- {\r
- outFile = File.createTempFile("jalview", ".xml");\r
- outFile.deleteOnExit();\r
- fetchData(ids, f, s, outFile);\r
- if (outFile.length() == 0)\r
- {\r
- outFile.delete();\r
- return null;\r
- }\r
- } catch (Exception ex)\r
- {\r
- }\r
- return outFile;\r
- }\r
-\r
- /**\r
- * Single DB multiple record retrieval\r
- * \r
- * @param ids\r
- * db:query1;query2;query3\r
- * @param f\r
- * raw/xml\r
- * @param s\r
- * ?\r
- * \r
- * @return Raw string array result of query set\r
- */\r
- public String[] fetchData(String ids, String f, String s)\r
- throws OutOfMemoryError\r
- {\r
- return fetchData(ids, f, s, null);\r
- }\r
-\r
- public String[] fetchData(String ids, String f, String s, File outFile)\r
- throws OutOfMemoryError\r
- {\r
- // Need to split\r
- // ids of the form uniprot:25KD_SARPE;ADHR_DROPS;\r
- String[] rslts = new String[0];\r
- StringTokenizer queries = new StringTokenizer(ids, ";");\r
- String db = null;\r
- StringBuffer querystring = null;\r
- int nq = 0;\r
- while (queries.hasMoreTokens())\r
- {\r
- String query = queries.nextToken();\r
- int p;\r
- if ((p = query.indexOf(':')) > -1)\r
- {\r
- db = query.substring(0, p);\r
- query = query.substring(p + 1);\r
- }\r
- if (querystring == null)\r
- {\r
- querystring = new StringBuffer(query);\r
- nq++;\r
- }\r
- else\r
- {\r
- querystring.append("," + query);\r
- nq++;\r
- }\r
- }\r
- if (db == null)\r
- {\r
- System.err.println("Invalid Query string : '" + ids\r
- + "'\nShould be of form 'dbname:q1;q2;q3;q4'");\r
- return null;\r
- }\r
- String[] rslt = fetchBatch(querystring.toString(), db, f, s, outFile);\r
- if (rslt != null)\r
- {\r
- String[] nrslts = new String[rslt.length + rslts.length];\r
- System.arraycopy(rslts, 0, nrslts, 0, rslts.length);\r
- System.arraycopy(rslt, 0, nrslts, rslts.length, rslt.length);\r
- rslts = nrslts;\r
- }\r
-\r
- return (rslts.length == 0 ? null : rslts);\r
- }\r
-\r
- public String[] fetchBatch(String ids, String db, String f, String s,\r
- File outFile) throws OutOfMemoryError\r
- {\r
- long time = System.currentTimeMillis();\r
- // max 200 ids can be added at one time\r
- try\r
- {\r
- URL rcall = new URL("http://www.ebi.ac.uk/Tools/dbfetch/dbfetch/"\r
- + db.toLowerCase() + "/" + ids.toLowerCase()\r
- + (f != null ? "/" + f : ""));\r
-\r
- BufferedInputStream is = new BufferedInputStream(rcall.openStream());\r
- if (outFile != null)\r
- {\r
- FileOutputStream fio = new FileOutputStream(outFile);\r
- byte[] bb = new byte[32 * 1024];\r
- int l;\r
- while ((l = is.read(bb)) > 0)\r
- {\r
- fio.write(bb, 0, l);\r
- }\r
- fio.close();\r
- is.close();\r
- }\r
- else\r
- {\r
- BufferedReader br = new BufferedReader(new InputStreamReader(is));\r
- String rtn;\r
- ArrayList<String> arl = new ArrayList<String>();\r
- while ((rtn = br.readLine()) != null)\r
- {\r
- arl.add(rtn);\r
- }\r
- return arl.toArray(new String[arl.size()]);\r
- }\r
- } catch (OutOfMemoryError er)\r
- {\r
-\r
- System.out.println("OUT OF MEMORY DOWNLOADING QUERY FROM " + db\r
- + ":\n" + ids);\r
- throw er;\r
- } catch (Exception ex)\r
- {\r
- if (ex.getMessage().startsWith(\r
- "uk.ac.ebi.jdbfetch.exceptions.DbfNoEntryFoundException"))\r
- {\r
- return null;\r
- }\r
- System.err.println("Unexpected exception when retrieving from " + db\r
- + "\nQuery was : '" + ids + "'");\r
- ex.printStackTrace(System.err);\r
- return null;\r
- } finally\r
- {\r
- //System.err.println("Took " + (System.currentTimeMillis() - time)\r
- // / 1000 + " secs for one call.");\r
- }\r
- return null;\r
- }\r
-}\r
+package jalview.ws.ebi;
+import java.util.Locale;
+
+import jalview.datamodel.DBRefSource;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.StringTokenizer;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class EBIFetchClient
+{
+
+ /**
+ * Creates a new EBIFetchClient object.
+ */
+ public EBIFetchClient()
+ {
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedDBs()
+ {
+ // TODO - implement rest call for dbfetch getSupportedDBs
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedFormats()
+ {
+ // TODO - implement rest call for dbfetch getSupportedFormats
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String[] getSupportedStyles()
+ {
+ // TODO - implement rest call for dbfetch getSupportedStyles
+ throw new Error(MessageManager.getString("error.not_yet_implemented"));
+ }
+
+ /**
+ * Send an HTTP fetch request to EBI and save the reply in a temporary file.
+ *
+ * @param ids
+ * the query formatted as db:query1;query2;query3
+ * @param format
+ * the format wanted
+ * @param ext
+ * for the temporary file to hold response (without separator)
+ * @return the file holding the response
+ * @throws OutOfMemoryError
+ */
+
+ public File fetchDataAsFile(String ids, String format, String ext)
+ throws OutOfMemoryError
+ {
+ File outFile = null;
+ try
+ {
+ outFile = File.createTempFile("jalview", "." + ext);
+ outFile.deleteOnExit();
+ fetchData(ids, format, outFile);
+ if (outFile.length() == 0)
+ {
+ outFile.delete();
+ return null;
+ }
+ } catch (Exception ex)
+ {
+ }
+ return outFile;
+ }
+
+ /**
+ * Fetches queries and either saves the response to a file or returns as
+ * string data
+ *
+ * @param ids
+ * @param format
+ * @param outFile
+ * @return
+ * @throws OutOfMemoryError
+ */
+ String[] fetchData(String ids, String format, File outFile)
+ throws OutOfMemoryError
+ {
+ StringBuilder querystring = new StringBuilder(ids.length());
+ String database = parseIds(ids, querystring);
+ if (database == null)
+ {
+ System.err.println("Invalid Query string : '" + ids + "'");
+ System.err.println("Should be of form 'dbname:q1;q2;q3;q4'");
+ return null;
+ }
+
+ // note: outFile is currently always specified, so return value is null
+ String[] rslt = fetchBatch(querystring.toString(), database, format,
+ outFile);
+
+ return (rslt != null && rslt.length > 0 ? rslt : null);
+ }
+
+ /**
+ * Parses ids formatted as dbname:q1;q2;q3, returns the dbname and adds
+ * queries as comma-separated items to the querystring. dbname must be
+ * specified for at least one queryId. Returns null if a mixture of different
+ * dbnames is found (ignoring case).
+ *
+ * @param ids
+ * @param queryString
+ * @return
+ */
+ static String parseIds(String ids, StringBuilder queryString)
+ {
+ String database = null;
+ StringTokenizer queries = new StringTokenizer(ids, ";");
+ boolean appending = queryString.length() > 0;
+ while (queries.hasMoreTokens())
+ {
+ String query = queries.nextToken();
+ int p = query.indexOf(':');
+ if (p > -1)
+ {
+ String db = query.substring(0, p);
+ if (database != null && !db.equalsIgnoreCase(database))
+ {
+ /*
+ * different databases mixed in together - invalid
+ */
+ return null;
+ }
+ database = db;
+ query = query.substring(p + 1);
+ }
+ queryString.append(appending ? "," : "");
+ queryString.append(query);
+ appending = true;
+ }
+ return database;
+ }
+
+ /**
+ * Fetches queries and either saves the response to a file or (if no file
+ * specified) returns as string data
+ *
+ * @param ids
+ * @param database
+ * @param format
+ * @param outFile
+ * @return array of lines from EBI only if outFile is null (which it will not
+ * be)
+ * @throws OutOfMemoryError
+ */
+ String[] fetchBatch(String ids, String database, String format,
+ File outFile) throws OutOfMemoryError
+ {
+ String url = buildUrl(ids, database, format);
+ InputStream is = null;
+ BufferedReader br = null;
+ try
+ {
+ URL rcall = new URL(url);
+ HttpURLConnection conn = (HttpURLConnection) rcall.openConnection();
+ int responseCode = conn.getResponseCode();
+ if (responseCode == 200)
+ {
+ is = conn.getInputStream();
+ if (outFile != null)
+ {
+ Platform.streamToFile(is, outFile);
+ return null;
+ }
+ br = new BufferedReader(new InputStreamReader(is));
+ String rtn;
+ List<String> arl = new ArrayList<>();
+ while ((rtn = br.readLine()) != null)
+ {
+ arl.add(rtn);
+ }
+ return (String[]) arl.toArray();
+ }
+ System.err.println(
+ "Warning: response code " + responseCode + " for " + url);
+ } catch (OutOfMemoryError er)
+ {
+ System.out.println("OUT OF MEMORY DOWNLOADING QUERY FROM " + database
+ + ":\n" + ids);
+ throw er;
+ } catch (Exception ex)
+ {
+ if (!ex.getMessage().startsWith(
+ "uk.ac.ebi.jdbfetch.exceptions.DbfNoEntryFoundException"))
+ {
+ System.err.println("Unexpected exception when retrieving from "
+ + database + "\nQuery was : '" + ids + "'");
+ ex.printStackTrace(System.err);
+ }
+ } finally
+ {
+ if (is != null)
+ {
+ try
+ {
+ is.close();
+ } catch (IOException e)
+ {
+ }
+ }
+ if (br != null)
+ {
+ try
+ {
+ br.close();
+ } catch (IOException e)
+ {
+ }
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Constructs the URL to fetch from
+ *
+ * @param ids
+ * @param database
+ * @param format
+ * @return
+ */
+ static String buildUrl(String ids, String database, String format)
+ {
+ String url;
+ if (database.equalsIgnoreCase(DBRefSource.EMBL)
+ || database.equalsIgnoreCase(DBRefSource.EMBLCDS))
+ {
+ url = "https://www.ebi.ac.uk/ena/browser/api/embl/"
+ + ids.toLowerCase(Locale.ROOT) + "?download=true&gzip=true";
+ }
+ else
+ {
+ url = "https://www.ebi.ac.uk/Tools/dbfetch/dbfetch/"
+ + database.toLowerCase(Locale.ROOT) + "/" + ids.toLowerCase(Locale.ROOT)
+ + (format != null ? "/" + format : "");
+ }
+ return url;
+ }
+}
git://source.jalview.org / jalview.git / blobdiff