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("H ") && !aaIndexHeaderRead)
 154         {
 155           aaIndexHeaderRead = true;
 156         }
 157         if (data.startsWith("D ") && aaIndexHeaderRead)
 158         {
 159           reply = FileFormat.ScoreMatrix;
 160           break;
 161         }
 162         if (data.startsWith("##GFF-VERSION"))
 163         {
 164           // GFF - possibly embedded in a Jalview features file!
 165           reply = FileFormat.Features;
 166           break;
 167         }
 168         if (looksLikeFeatureData(data))
 169         {
 170           reply = FileFormat.Features;
 171           break;
 172         }
 173         if (data.indexOf("# STOCKHOLM") > -1)
 174         {
 175           reply = FileFormat.Stockholm;
 176           break;
 177         }
 178         if (data.indexOf("_ENTRY.ID") > -1
 179                 || data.indexOf("_AUDIT_AUTHOR.NAME") > -1
 180                 || data.indexOf("_ATOM_SITE.") > -1)
 181         {
 182           reply = FileFormat.MMCif;
 183           break;
 184         }
 185         // if (data.indexOf(">") > -1)
 186         if (data.startsWith(">"))
 187         {
 188           // FASTA, PIR file or BLC file
 189           boolean checkPIR = false, starterm = false;
 190           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
 191           {
 192             // watch for PIR file attributes
 193             checkPIR = true;
 194             reply = FileFormat.PIR;
 195           }
 196           // could also be BLC file, read next line to confirm
 197           data = source.nextLine();
 198
 199           if (data.indexOf(">") > -1)
 200           {
 201             reply = FileFormat.BLC;
 202           }
 203           else
 204           {
 205             // Is this a single line BLC file?
 206             String data1 = source.nextLine();
 207             String data2 = source.nextLine();
 208             int c1;
 209             if (checkPIR)
 210             {
 211               starterm = (data1 != null && data1.indexOf("*") > -1)
 212                       || (data2 != null && data2.indexOf("*") > -1);
 213             }
 214             if (data2 != null && (c1 = data.indexOf("*")) > -1)
 215             {
 216               if (c1 == 0 && c1 == data2.indexOf("*"))
 217               {
 218                 reply = FileFormat.BLC;
 219               }
 220               else
 221               {
 222                 reply = FileFormat.Fasta; // possibly a bad choice - may be
 223                                           // recognised as
 224                 // PIR
 225               }
 226               // otherwise can still possibly be a PIR file
 227             }
 228             else
 229             {
 230               reply = FileFormat.Fasta;
 231               // TODO : AMSA File is indicated if there is annotation in the
 232               // FASTA file - but FASTA will automatically generate this at the
 233               // mo.
 234               if (!checkPIR)
 235               {
 236                 break;
 237               }
 238             }
 239           }
 240           // final check for PIR content. require
 241           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 242
 243           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 244           // have
 245           // a 'Parse as type XXX' parameter for the applet/application.
 246           if (checkPIR)
 247           {
 248             String dta = null;
 249             if (!starterm)
 250             {
 251               do
 252               {
 253                 try
 254                 {
 255                   dta = source.nextLine();
 256                 } catch (IOException ex)
 257                 {
 258                 }
 259                 if (dta != null && dta.indexOf("*") > -1)
 260                 {
 261                   starterm = true;
 262                 }
 263               } while (dta != null && !starterm);
 264             }
 265             if (starterm)
 266             {
 267               reply = FileFormat.PIR;
 268               break;
 269             }
 270             else
 271             {
 272               reply = FileFormat.Fasta; // probably a bad choice!
 273             }
 274           }
 275           // read as a FASTA (probably)
 276           break;
 277         }
 278         if (data.indexOf("{\"") > -1)
 279         {
 280           reply = FileFormat.Json;
 281           break;
 282         }
 283         int lessThan = data.indexOf("<");
 284         if ((lessThan > -1)) // possible Markup Language data i.e HTML,
 285                              // RNAML, XML
 286         {
 287           String upper = data.toUpperCase();
 288           if (upper.substring(lessThan).startsWith("<HTML"))
 289           {
 290             reply = FileFormat.Html;
 291             break;
 292           }
 293           if (upper.substring(lessThan).startsWith("<RNAML"))
 294           {
 295             reply = FileFormat.Rnaml;
 296             break;
 297           }
 298         }
 299
 300         if ((data.length() < 1) || (data.indexOf("#") == 0))
 301         {
 302           lineswereskipped = true;
 303           continue;
 304         }
 305
 306         if (data.indexOf("PILEUP") > -1)
 307         {
 308           reply = FileFormat.Pileup;
 309
 310           break;
 311         }
 312
 313         if ((data.indexOf("//") == 0) || ((data.indexOf("!!") > -1) && (data
 314                 .indexOf("!!") < data.indexOf("_MULTIPLE_ALIGNMENT "))))
 315         {
 316           reply = FileFormat.MSF;
 317
 318           break;
 319         }
 320         else if (data.indexOf("CLUSTAL") > -1)
 321         {
 322           reply = FileFormat.Clustal;
 323
 324           break;
 325         }
 326
 327         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 328         {
 329           reply = FileFormat.PDB;
 330           break;
 331         }
 332         else if (data.matches("\\s*\\d+\\s+\\d+\\s*"))
 333         {
 334           reply = FileFormat.Phylip;
 335           break;
 336         }
 337         else
 338         {
 339           if (!lineswereskipped && looksLikeJnetData(data))
 340           {
 341             reply = FileFormat.Jnet;
 342             break;
 343           }
 344         }
 345
 346         lineswereskipped = true; // this means there was some junk before any
 347         // key file signature
 348       }
 349       if (closeSource)
 350       {
 351         source.close();
 352       }
 353       else
 354       {
 355         source.reset(bytesRead); // so the file can be parsed from the mark
 356       }
 357     } catch (Exception ex)
 358     {
 359       System.err.println("File Identification failed!\n" + ex);
 360       throw new FileFormatException(source.errormessage);
 361     }
 362     if (trimmedLength == 0)
 363     {
 364       System.err.println(
 365               "File Identification failed! - Empty file was read.");
 366       throw new FileFormatException("EMPTY DATA FILE");
 367     }
 368     System.out.println("File format identified as " + reply.toString());
 369     return reply;
 370   }
 371
 372   /**
 373    * Returns true if the data appears to be Jnet concise annotation format
 374    *
 375    * @param data
 376    * @return
 377    */
 378   protected boolean looksLikeJnetData(String data)
 379   {
 380     char firstChar = data.charAt(0);
 381     int colonPos = data.indexOf(":");
 382     int commaPos = data.indexOf(",");
 383     boolean isJnet = firstChar != '*' && firstChar != ' ' && colonPos > -1
 384             && commaPos > -1 && colonPos < commaPos;
 385     // && data.indexOf(",")<data.indexOf(",", data.indexOf(","))) / ??
 386     return isJnet;
 387   }
 388
 389   /**
 390    * Returns true if the data has at least 6 tab-delimited fields _and_ fields 4
 391    * and 5 are integer (start/end)
 392    *
 393    * @param data
 394    * @return
 395    */
 396   protected boolean looksLikeFeatureData(String data)
 397   {
 398     if (data == null)
 399     {
 400       return false;
 401     }
 402     String[] columns = data.split("\t");
 403     if (columns.length < 6)
 404     {
 405       return false;
 406     }
 407     for (int col = 3; col < 5; col++)
 408     {
 409       try
 410       {
 411         Integer.parseInt(columns[col]);
 412       } catch (NumberFormatException e)
 413       {
 414         return false;
 415       }
 416     }
 417     return true;
 418   }
 419
 420   public static void main(String[] args)
 421   {
 422     for (int i = 0; args != null && i < args.length; i++)
 423     {
 424       IdentifyFile ider = new IdentifyFile();
 425       FileFormatI type = null;
 426       try
 427       {
 428         type = ider.identify(args[i], DataSourceType.FILE);
 429       } catch (FileFormatException e)
 430       {
 431         System.err.println(
 432                 String.format("Error '%s' identifying file type for %s",
 433                         args[i], e.getMessage()));
 434       }
 435       System.out.println("Type of " + args[i] + " is " + type);
 436     }
 437     if (args == null || args.length == 0)
 438     {
 439       System.err.println("Usage: <Filename> [<Filename> ...]");
 440     }
 441   }
 442 }