-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
- */\r
-package jalview.io;\r
-\r
-import java.io.*;\r
-import java.net.*;\r
-\r
-public class FileParse\r
-{\r
- public File inFile;\r
- protected String type;\r
- protected BufferedReader dataIn;\r
-\r
- public FileParse()\r
- {\r
- }\r
-\r
- public FileParse(String fileStr, String type)\r
- throws MalformedURLException, IOException\r
- {\r
- this.type = type;\r
-\r
- if (type.equals(AppletFormatAdapter.FILE))\r
- {\r
- this.inFile = new File(fileStr);\r
- dataIn = new BufferedReader(new FileReader(fileStr));\r
- }\r
- else if (type.equals(AppletFormatAdapter.URL))\r
- {\r
- URL url = new URL(fileStr);\r
- dataIn = new BufferedReader(new InputStreamReader(url.openStream()));\r
- }\r
- else if (type.equals(AppletFormatAdapter.PASTE))\r
- {\r
- dataIn = new BufferedReader(new StringReader(fileStr));\r
- }\r
- else if (type.equals(AppletFormatAdapter.CLASSLOADER))\r
- {\r
- java.io.InputStream is = getClass().getResourceAsStream("/" + fileStr);\r
- if (is != null)\r
- {\r
- dataIn = new BufferedReader(new java.io.InputStreamReader(is));\r
- }\r
- }\r
- }\r
-\r
- public String nextLine()\r
- throws IOException\r
- {\r
- return dataIn.readLine();\r
- }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * This program 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 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+package jalview.io;
+
+import java.io.*;
+import java.net.*;
+/**
+ * implements a random access wrapper around a particular datasource, for passing to
+ * identifyFile and AlignFile objects.
+ */
+public class FileParse
+{
+ public File inFile=null;
+ /**
+ * '#' separated string tagged on to end of filename
+ * or url that was clipped off to resolve to valid filename
+ */
+ protected String suffix=null;
+ protected String type=null;
+ protected BufferedReader dataIn=null;
+ protected String errormessage="UNITIALISED SOURCE";
+ protected boolean error=true;
+ /**
+ * size of readahead buffer used for when initial stream position is marked.
+ */
+ final int READAHEAD_LIMIT=2048;
+ public FileParse()
+ {
+ }
+ /**
+ * Attempt to open a file as a datasource.
+ * Sets error and errormessage if fileStr was invalid.
+ * @param fileStr
+ * @return this.error (true if the source was invalid)
+ */
+ private boolean checkFileSource(String fileStr) throws IOException {
+ this.inFile = new File(fileStr);
+ // check to see if it's a Jar file in disguise.
+ if (!inFile.exists()) {
+ errormessage = "FILE NOT FOUND";
+ error=true;
+ }
+ if (!inFile.canRead()) {
+ errormessage = "FILE CANNOT BE OPENED FOR READING";
+ error=true;
+ }
+ if (inFile.isDirectory()) {
+ // this is really a 'complex' filetype - but we don't handle directory reads yet.
+ errormessage = "FILE IS A DIRECTORY";
+ error=true;
+ }
+ if (!error) {
+ dataIn = new BufferedReader(new FileReader(fileStr));
+ }
+ return error;
+ }
+ private boolean checkURLSource(String fileStr) throws IOException, MalformedURLException
+ {
+ errormessage = "URL NOT FOUND";
+ URL url = new URL(fileStr);
+ dataIn = new BufferedReader(new InputStreamReader(url.openStream()));
+ return false;
+ }
+ /**
+ * sets the suffix string (if any) and returns remainder (if suffix was detected)
+ * @param fileStr
+ * @return truncated fileStr or null
+ */
+ private String extractSuffix(String fileStr) {
+ // first check that there wasn't a suffix string tagged on.
+ int sfpos = fileStr.lastIndexOf('#');
+ if (sfpos>-1 && sfpos<fileStr.length()-1) {
+ suffix = fileStr.substring(sfpos+1);
+ // System.err.println("DEBUG: Found Suffix:"+suffix);
+ return fileStr.substring(0,sfpos);
+ }
+ return null;
+ }
+ /**
+ * Create a datasource for input to Jalview.
+ * See AppletFormatAdapter for the types of sources that are handled.
+ * @param fileStr - datasource locator/content
+ * @param type - protocol of source
+ * @throws MalformedURLException
+ * @throws IOException
+ */
+ public FileParse(String fileStr, String type)
+ throws MalformedURLException, IOException
+ {
+ this.type = type;
+ error=false;
+
+ if (type.equals(AppletFormatAdapter.FILE))
+ {
+ if (checkFileSource(fileStr)) {
+ String suffixLess = extractSuffix(fileStr);
+ if (suffixLess!=null && checkFileSource(suffixLess))
+ {
+ throw new IOException("Problem opening "+inFile+" (also tried "+fileStr+") : "+errormessage);
+ }
+ // returns normally.
+ } else {
+ throw new IOException("Problem opening "+inFile+" : "+errormessage);
+ }
+ }
+ else if (type.equals(AppletFormatAdapter.URL))
+ {
+ try {
+ checkURLSource(fileStr);
+ String suffixLess = extractSuffix(fileStr); // URL lref is stored for later reference.
+ } catch (IOException e) {
+ String suffixLess = extractSuffix(fileStr);
+ if (suffixLess==null)
+ {
+ throw(e);
+ } else {
+ try {
+ checkURLSource(suffixLess);
+ }
+ catch (IOException e2) {
+ errormessage = "BAD URL WITH OR WITHOUT SUFFIX";
+ throw(e); // just pass back original - everything was wrong.
+ }
+ }
+ }
+ }
+ else if (type.equals(AppletFormatAdapter.PASTE))
+ {
+ errormessage = "PASTE INACCESSIBLE!";
+ dataIn = new BufferedReader(new StringReader(fileStr));
+ }
+ else if (type.equals(AppletFormatAdapter.CLASSLOADER))
+ {
+ errormessage = "RESOURCE CANNOT BE LOCATED";
+ java.io.InputStream is = getClass().getResourceAsStream("/" + fileStr);
+ if (is==null) {
+ String suffixLess = extractSuffix(fileStr);
+ if (suffixLess!=null)
+ is = getClass().getResourceAsStream("/" + suffixLess);
+ }
+ if (is != null)
+ {
+ dataIn = new BufferedReader(new java.io.InputStreamReader(is));
+ } else {
+ error = true;
+ }
+ }
+ error=false;
+ dataIn.mark(READAHEAD_LIMIT);
+ }
+ public String nextLine()
+ throws IOException
+ {
+ if (!error)
+ return dataIn.readLine();
+ throw new IOException("Invalid Source Stream:"+errormessage);
+ }
+
+ public boolean isValid()
+ {
+ return !error;
+ }
+ /**
+ * closes the datasource and tidies up.
+ * source will be left in an error state
+ */
+ public void close() throws IOException
+ {
+ errormessage="EXCEPTION ON CLOSE";
+ error=true;
+ dataIn.close();
+ dataIn=null;
+ errormessage="SOURCE IS CLOSED";
+ }
+ /**
+ * rewinds the datasource the beginning.
+ *
+ */
+ public void reset() throws IOException
+ {
+ if (dataIn!=null && !error) {
+ dataIn.reset();
+ } else {
+ throw new IOException("Implementation Error: Reset called for invalid source.");
+ }
+ }
+}
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
- */\r
-package jalview.io;\r
-\r
-import java.io.*;\r
-import java.net.*;\r
-\r
-/**\r
- * DOCUMENT ME!\r
- *\r
- * @author $author$\r
- * @version $Revision$\r
- */\r
-public class IdentifyFile\r
-{\r
- /**\r
- * DOCUMENT ME!\r
- *\r
- * @param file DOCUMENT ME!\r
- * @param protocol DOCUMENT ME!\r
- *\r
- * @return DOCUMENT ME!\r
- */\r
- public String Identify(String file, String protocol)\r
- {\r
- String reply = "PFAM";\r
- String error = "FILE NOT FOUND";\r
- try\r
- {\r
- BufferedReader reader = null;\r
-\r
- if (protocol.equals(AppletFormatAdapter.FILE))\r
- {\r
- reader = new BufferedReader(new FileReader(file));\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.URL))\r
- {\r
- error = "URL NOT FOUND";\r
- URL url = new URL(file);\r
- reader = new BufferedReader(new InputStreamReader(\r
- url.openStream()));\r
-\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.PASTE))\r
- {\r
- reader = new BufferedReader(new StringReader(file));\r
- }\r
- else if (protocol.equals(AppletFormatAdapter.CLASSLOADER))\r
- {\r
- java.io.InputStream is = getClass().getResourceAsStream("/" +\r
- file);\r
- reader = new BufferedReader(new java.io.InputStreamReader(is));\r
- }\r
-\r
- String data;\r
-\r
- while ( (data = reader.readLine()) != null)\r
- {\r
- data = data.toUpperCase();\r
-\r
- if ( (data.indexOf("# STOCKHOLM") > -1))\r
- {\r
- reply = "STH";\r
-\r
- break;\r
- }\r
-\r
- if ( (data.indexOf("#") == 0) || (data.length() < 1))\r
- {\r
- continue;\r
- }\r
-\r
- if (data.indexOf("PILEUP") > -1)\r
- {\r
- reply = "PileUp";\r
-\r
- break;\r
- }\r
-\r
- if ( (data.indexOf("//") == 0) ||\r
- ( (data.indexOf("!!") > -1) &&\r
- (data.indexOf("!!") < data.indexOf(\r
- "_MULTIPLE_ALIGNMENT "))))\r
- {\r
- reply = "MSF";\r
-\r
- break;\r
- }\r
- else if (data.indexOf("CLUSTAL") > -1)\r
- {\r
- reply = "CLUSTAL";\r
-\r
- break;\r
- }\r
- else if ( (data.indexOf(">P1;") > -1) ||\r
- (data.indexOf(">DL;") > -1))\r
- {\r
- reply = "PIR";\r
-\r
- break;\r
- }\r
- else if (data.indexOf(">") > -1)\r
- {\r
- // could be BLC file, read next line to confirm\r
- data = reader.readLine();\r
-\r
- if (data.indexOf(">") > -1)\r
- {\r
- reply = "BLC";\r
- }\r
- else\r
- {\r
- //Is this a single line BLC file?\r
- reader.readLine();\r
- String data2 = reader.readLine();\r
- if (data2 != null\r
- && data.indexOf("*") > -1\r
- && data.indexOf("*") == data2.indexOf("*"))\r
- {\r
- reply = "BLC";\r
- }\r
- else\r
- {\r
- reply = "FASTA";\r
- }\r
- }\r
-\r
- break;\r
- }\r
- else if (data.indexOf("HEADER") == 0 ||\r
- data.indexOf("ATOM") == 0)\r
- {\r
- reply = "PDB";\r
- break;\r
- }\r
- else if (data.indexOf(":") < data.indexOf(",")) // && data.indexOf(",")<data.indexOf(",", data.indexOf(",")))\r
- {\r
- // file looks like a concise JNet file\r
- reply = "JnetFile";\r
- break;\r
- }\r
- }\r
-\r
- reader.close();\r
- }\r
- catch (Exception ex)\r
- {\r
- System.err.println("File Identification failed!\n" + ex);\r
- return error;\r
- }\r
-\r
- return reply;\r
- }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * This program 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 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+package jalview.io;
+
+import java.io.*;
+import java.net.*;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class IdentifyFile
+{
+ /**
+ * Identify a datasource's file content.
+ * @note Do not use this method
+ * for stream sources - create a FileParse object instead.
+ *
+ * @param file DOCUMENT ME!
+ * @param protocol DOCUMENT ME!
+ * @return ID String
+ */
+ public String Identify(String file, String protocol)
+ {
+ FileParse parser = null;
+ try {
+ parser = new FileParse(file, protocol);
+ if (parser.isValid()) {
+ return Identify(parser);
+ }
+ } catch (Exception e) {
+ System.err.println("Error whilst identifying");
+ e.printStackTrace(System.err);
+ }
+ if (parser!=null)
+ return parser.errormessage;
+ return "UNIDENTIFIED FILE PARSING ERROR";
+ }
+ public String Identify(FileParse source) {
+ return Identify(source, true); // preserves original behaviour prior to version 2.3
+ }
+ /**
+ * Identify contents of source, closing it or resetting source to start afterwards.
+ * @param source
+ * @param closeSource
+ * @return filetype string
+ */
+ public String Identify(FileParse source, boolean closeSource) {
+ String reply = "PFAM";
+ String data;
+ try {
+ while ( (data = source.nextLine()) != null)
+ {
+ data = data.toUpperCase();
+
+ if ( (data.indexOf("# STOCKHOLM") > -1))
+ {
+ reply = "STH";
+
+ break;
+ }
+
+ if ( (data.indexOf("#") == 0) || (data.length() < 1))
+ {
+ continue;
+ }
+
+ if (data.indexOf("PILEUP") > -1)
+ {
+ reply = "PileUp";
+
+ break;
+ }
+
+ if ( (data.indexOf("//") == 0) ||
+ ( (data.indexOf("!!") > -1) &&
+ (data.indexOf("!!") < data.indexOf(
+ "_MULTIPLE_ALIGNMENT "))))
+ {
+ reply = "MSF";
+
+ break;
+ }
+ else if (data.indexOf("CLUSTAL") > -1)
+ {
+ reply = "CLUSTAL";
+
+ break;
+ }
+ else if ( (data.indexOf(">P1;") > -1) ||
+ (data.indexOf(">DL;") > -1))
+ {
+ reply = "PIR";
+
+ break;
+ }
+ else if (data.indexOf(">") > -1)
+ {
+ // could be BLC file, read next line to confirm
+ data = source.nextLine();
+
+ if (data.indexOf(">") > -1)
+ {
+ reply = "BLC";
+ }
+ else
+ {
+ //Is this a single line BLC file?
+ source.nextLine();
+ String data2 = source.nextLine();
+ if (data2 != null
+ && data.indexOf("*") > -1
+ && data.indexOf("*") == data2.indexOf("*"))
+ {
+ reply = "BLC";
+ }
+ else
+ {
+ reply = "FASTA";
+ }
+ }
+
+ break;
+ }
+ else if (data.indexOf("HEADER") == 0 ||
+ data.indexOf("ATOM") == 0)
+ {
+ reply = "PDB";
+ break;
+ }
+ else if (data.indexOf(":") < data.indexOf(",")) // && data.indexOf(",")<data.indexOf(",", data.indexOf(",")))
+ {
+ // file looks like a concise JNet file
+ reply = "JnetFile";
+ break;
+ }
+ else if (source.inFile!=null)
+ {
+ String fileStr=source.inFile.getName();
+ // possibly a Jalview archive.
+ if (fileStr.lastIndexOf(".jar")>-1 || fileStr.lastIndexOf(".zip")>-1)
+ {
+ reply = "Jalview";
+ }
+ } else if (data.startsWith("PK")) {
+ reply="Jalview"; // archive.
+ break;
+ }
+ }
+ if (closeSource) {
+ source.close();
+ } else {
+ source.reset(); // so the file can be parsed from the beginning again.
+ }
+ }
+ catch (Exception ex)
+ {
+ System.err.println("File Identification failed!\n" + ex);
+ return source.errormessage;
+ }
+
+ return reply;
+ }
+}