JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / io / IdentifyFile.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  *
5  * This file is part of Jalview.
6  *
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * Jalview is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE.  See the GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.io;
22
23 import java.io.IOException;
24
25 /**
26  * DOCUMENT ME!
27  *
28  * @author $author$
29  * @version $Revision$
30  */
31 public class IdentifyFile
32 {
33   /**
34    * Identify a datasource's file content.
35    *
36    * @note Do not use this method for stream sources - create a FileParse object
37    *       instead.
38    *
39    * @param file
40    * @param sourceType
41    * @return
42    * @throws FileFormatException
43    */
44   public FileFormatI identify(String file, DataSourceType sourceType)
45           throws FileFormatException
46   {
47     String emessage = "UNIDENTIFIED FILE PARSING ERROR";
48     FileParse parser = null;
49     try
50     {
51       parser = new FileParse(file, sourceType);
52       if (parser.isValid())
53       {
54         return identify(parser);
55       }
56     } catch (Exception e)
57     {
58       System.err.println("Error whilst identifying");
59       e.printStackTrace(System.err);
60       emessage = e.getMessage();
61     }
62     if (parser != null)
63     {
64       throw new FileFormatException(parser.errormessage);
65     }
66     throw new FileFormatException(emessage);
67   }
68
69   public FileFormatI identify(FileParse source) throws FileFormatException
70   {
71     return identify(source, true);
72     // preserves original behaviour prior to version 2.3
73   }
74
75   public FileFormatI identify(AlignmentFileReaderI file,
76           boolean closeSource) throws IOException
77   {
78     FileParse fp = new FileParse(file.getInFile(),
79             file.getDataSourceType());
80     return identify(fp, closeSource);
81   }
82
83   /**
84    * Identify contents of source, closing it or resetting source to start
85    * afterwards.
86    *
87    * @param source
88    * @param closeSource
89    * @return (best guess at) file format
90    * @throws FileFormatException
91    */
92   public FileFormatI identify(FileParse source, boolean closeSource)
93           throws FileFormatException
94   {
95     FileFormatI reply = FileFormat.Pfam;
96     String data;
97     int bytesRead = 0;
98     int trimmedLength = 0;
99     boolean lineswereskipped = false;
100     boolean isBinary = false; // true if length is non-zero and non-printable
101     // characters are encountered
102
103     try
104     {
105       if (!closeSource)
106       {
107         source.mark();
108       }
109       boolean aaIndexHeaderRead = false;
110
111       while ((data = source.nextLine()) != null)
112       {
113         bytesRead += data.length();
114         trimmedLength += data.trim().length();
115         if (!lineswereskipped)
116         {
117           for (int i = 0; !isBinary && i < data.length(); i++)
118           {
119             char c = data.charAt(i);
120             isBinary = (c < 32 && c != '\t' && c != '\n' && c != '\r'
121                     && c != 5 && c != 27); // nominal binary character filter
122             // excluding CR, LF, tab,DEL and ^E
123             // for certain blast ids
124           }
125         }
126         if (isBinary)
127         {
128           // jar files are special - since they contain all sorts of random
129           // characters.
130           if (source.inFile != null)
131           {
132             String fileStr = source.inFile.getName();
133             // possibly a Jalview archive.
134             if (fileStr.lastIndexOf(".jar") > -1
135                     || fileStr.lastIndexOf(".zip") > -1)
136             {
137               reply = FileFormat.Jalview;
138             }
139           }
140           if (!lineswereskipped && data.startsWith("PK"))
141           {
142             reply = FileFormat.Jalview; // archive.
143             break;
144           }
145         }
146         data = data.toUpperCase();
147
148         if (data.startsWith(ScoreMatrixFile.SCOREMATRIX))
149         {
150           reply = FileFormat.ScoreMatrix;
151           break;
152         }
153         if (data.startsWith("HMMER3"))
154         {
155           reply = FileFormat.HMMER3;
156           break;
157         }
158         if (data.startsWith("H ") && !aaIndexHeaderRead)
159         {
160           aaIndexHeaderRead = true;
161         }
162         if (data.startsWith("D ") && aaIndexHeaderRead)
163         {
164           reply = FileFormat.ScoreMatrix;
165           break;
166         }
167         if (data.startsWith("##GFF-VERSION"))
168         {
169           // GFF - possibly embedded in a Jalview features file!
170           reply = FileFormat.Features;
171           break;
172         }
173         if (looksLikeFeatureData(data))
174         {
175           reply = FileFormat.Features;
176           break;
177         }
178         if (data.indexOf("# STOCKHOLM") > -1)
179         {
180           reply = FileFormat.Stockholm;
181           break;
182         }
183         if (data.indexOf("_ENTRY.ID") > -1
184                 || data.indexOf("_AUDIT_AUTHOR.NAME") > -1
185                 || data.indexOf("_ATOM_SITE.") > -1)
186         {
187           reply = FileFormat.MMCif;
188           break;
189         }
190         // if (data.indexOf(">") > -1)
191         if (data.startsWith(">"))
192         {
193           // FASTA, PIR file or BLC file
194           boolean checkPIR = false, starterm = false;
195           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
196           {
197             // watch for PIR file attributes
198             checkPIR = true;
199             reply = FileFormat.PIR;
200           }
201           // could also be BLC file, read next line to confirm
202           data = source.nextLine();
203
204           if (data.indexOf(">") > -1)
205           {
206             reply = FileFormat.BLC;
207           }
208           else
209           {
210             // Is this a single line BLC file?
211             String data1 = source.nextLine();
212             String data2 = source.nextLine();
213             int c1;
214             if (checkPIR)
215             {
216               starterm = (data1 != null && data1.indexOf("*") > -1)
217                       || (data2 != null && data2.indexOf("*") > -1);
218             }
219             if (data2 != null && (c1 = data.indexOf("*")) > -1)
220             {
221               if (c1 == 0 && c1 == data2.indexOf("*"))
222               {
223                 reply = FileFormat.BLC;
224               }
225               else
226               {
227                 reply = FileFormat.Fasta; // possibly a bad choice - may be
228                                           // recognised as
229                 // PIR
230               }
231               // otherwise can still possibly be a PIR file
232             }
233             else
234             {
235               reply = FileFormat.Fasta;
236               // TODO : AMSA File is indicated if there is annotation in the
237               // FASTA file - but FASTA will automatically generate this at the
238               // mo.
239               if (!checkPIR)
240               {
241                 break;
242               }
243             }
244           }
245           // final check for PIR content. require
246           // >P1;title\n<blah>\nterminated sequence to occur at least once.
247
248           // TODO the PIR/fasta ambiguity may be the use case that is needed to
249           // have
250           // a 'Parse as type XXX' parameter for the applet/application.
251           if (checkPIR)
252           {
253             String dta = null;
254             if (!starterm)
255             {
256               do
257               {
258                 try
259                 {
260                   dta = source.nextLine();
261                 } catch (IOException ex)
262                 {
263                 }
264                 if (dta != null && dta.indexOf("*") > -1)
265                 {
266                   starterm = true;
267                 }
268               } while (dta != null && !starterm);
269             }
270             if (starterm)
271             {
272               reply = FileFormat.PIR;
273               break;
274             }
275             else
276             {
277               reply = FileFormat.Fasta; // probably a bad choice!
278             }
279           }
280           // read as a FASTA (probably)
281           break;
282         }
283         if (data.indexOf("{\"") > -1)
284         {
285           reply = FileFormat.Json;
286           break;
287         }
288         int lessThan = data.indexOf("<");
289         if ((lessThan > -1)) // possible Markup Language data i.e HTML,
290                              // RNAML, XML
291         {
292           String upper = data.toUpperCase();
293           if (upper.substring(lessThan).startsWith("<HTML"))
294           {
295             reply = FileFormat.Html;
296             break;
297           }
298           if (upper.substring(lessThan).startsWith("<RNAML"))
299           {
300             reply = FileFormat.Rnaml;
301             break;
302           }
303         }
304
305         if ((data.length() < 1) || (data.indexOf("#") == 0))
306         {
307           lineswereskipped = true;
308           continue;
309         }
310
311         if (data.indexOf("PILEUP") > -1)
312         {
313           reply = FileFormat.Pileup;
314
315           break;
316         }
317
318         if ((data.indexOf("//") == 0) || ((data.indexOf("!!") > -1) && (data
319                 .indexOf("!!") < data.indexOf("_MULTIPLE_ALIGNMENT "))))
320         {
321           reply = FileFormat.MSF;
322
323           break;
324         }
325         else if (data.indexOf("CLUSTAL") > -1)
326         {
327           reply = FileFormat.Clustal;
328
329           break;
330         }
331
332         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
333         {
334           reply = FileFormat.PDB;
335           break;
336         }
337         else if (data.matches("\\s*\\d+\\s+\\d+\\s*"))
338         {
339           reply = FileFormat.Phylip;
340           break;
341         }
342         else
343         {
344           if (!lineswereskipped && looksLikeJnetData(data))
345           {
346             reply = FileFormat.Jnet;
347             break;
348           }
349         }
350
351         lineswereskipped = true; // this means there was some junk before any
352         // key file signature
353       }
354       if (closeSource)
355       {
356         source.close();
357       }
358       else
359       {
360         source.reset(bytesRead); // so the file can be parsed from the mark
361       }
362     } catch (Exception ex)
363     {
364       System.err.println("File Identification failed!\n" + ex);
365       throw new FileFormatException(source.errormessage);
366     }
367     if (trimmedLength == 0)
368     {
369       System.err.println(
370               "File Identification failed! - Empty file was read.");
371       throw new FileFormatException("EMPTY DATA FILE");
372     }
373     System.out.println("File format identified as " + reply.toString());
374     return reply;
375   }
376
377   /**
378    * Returns true if the data appears to be Jnet concise annotation format
379    * 
380    * @param data
381    * @return
382    */
383   protected boolean looksLikeJnetData(String data)
384   {
385     char firstChar = data.charAt(0);
386     int colonPos = data.indexOf(":");
387     int commaPos = data.indexOf(",");
388     boolean isJnet = firstChar != '*' && firstChar != ' ' && colonPos > -1
389             && commaPos > -1 && colonPos < commaPos;
390     // && data.indexOf(",")<data.indexOf(",", data.indexOf(","))) / ??
391     return isJnet;
392   }
393
394   /**
395    * Returns true if the data has at least 6 tab-delimited fields _and_ fields 4
396    * and 5 are integer (start/end)
397    * 
398    * @param data
399    * @return
400    */
401   protected boolean looksLikeFeatureData(String data)
402   {
403     if (data == null)
404     {
405       return false;
406     }
407     String[] columns = data.split("\t");
408     if (columns.length < 6)
409     {
410       return false;
411     }
412     for (int col = 3; col < 5; col++)
413     {
414       try
415       {
416         Integer.parseInt(columns[col]);
417       } catch (NumberFormatException e)
418       {
419         return false;
420       }
421     }
422     return true;
423   }
424
425   public static void main(String[] args)
426   {
427     for (int i = 0; args != null && i < args.length; i++)
428     {
429       IdentifyFile ider = new IdentifyFile();
430       FileFormatI type = null;
431       try
432       {
433         type = ider.identify(args[i], DataSourceType.FILE);
434       } catch (FileFormatException e)
435       {
436         System.err.println(
437                 String.format("Error '%s' identifying file type for %s",
438                         args[i], e.getMessage()));
439       }
440       System.out.println("Type of " + args[i] + " is " + type);
441     }
442     if (args == null || args.length == 0)
443     {
444       System.err.println("Usage: <Filename> [<Filename> ...]");
445     }
446   }
447 }