src/jalview/io/IdentifyFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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    *          DOCUMENT ME!
  41    * @param protocol
  42    *          DOCUMENT ME!
  43    * @return ID String
  44    */
  45   public String Identify(String file, String protocol)
  46   {
  47     String emessage = "UNIDENTIFIED FILE PARSING ERROR";
  48     FileParse parser = null;
  49     try
  50     {
  51       parser = new FileParse(file, protocol);
  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       return parser.errormessage;
  65     }
  66     return emessage;
  67   }
  68
  69   public String Identify(FileParse source)
  70   {
  71     return Identify(source, true); // preserves original behaviour prior to
  72     // version 2.3
  73   }
  74
  75   /**
  76    * Identify contents of source, closing it or resetting source to start
  77    * afterwards.
  78    *
  79    * @param source
  80    * @param closeSource
  81    * @return filetype string
  82    */
  83   public String Identify(FileParse source, boolean closeSource)
  84   {
  85     String reply = "PFAM";
  86     String data;
  87     int length = 0;
  88     boolean lineswereskipped = false;
  89     boolean isBinary = false; // true if length is non-zero and non-printable
  90     // characters are encountered
  91     try
  92     {
  93       if (!closeSource)
  94       {
  95         source.mark();
  96       }
  97       while ((data = source.nextLine()) != null)
  98       {
  99         length += data.length();
 100         if (!lineswereskipped)
 101         {
 102           for (int i = 0; !isBinary && i < data.length(); i++)
 103           {
 104             char c = data.charAt(i);
 105             isBinary = (c < 32 && c != '\t' && c != '\n' && c != '\r'
 106                     && c != 5 && c != 27); // nominal binary character filter
 107             // excluding CR, LF, tab,DEL and ^E
 108             // for certain blast ids
 109           }
 110         }
 111         if (isBinary)
 112         {
 113           // jar files are special - since they contain all sorts of random
 114           // characters.
 115           if (source.inFile != null)
 116           {
 117             String fileStr = source.inFile.getName();
 118             // possibly a Jalview archive.
 119             if (fileStr.lastIndexOf(".jar") > -1
 120                     || fileStr.lastIndexOf(".zip") > -1)
 121             {
 122               reply = "Jalview";
 123             }
 124           }
 125           if (!lineswereskipped && data.startsWith("PK"))
 126           {
 127             reply = "Jalview"; // archive.
 128             break;
 129           }
 130         }
 131         data = data.toUpperCase();
 132
 133         if ((data.indexOf("# STOCKHOLM") > -1))
 134         {
 135           reply = "STH";
 136
 137           break;
 138         }
 139         if (data.matches("<(\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 140         {
 141           reply = HtmlFile.FILE_DESC;
 142           break;
 143         }
 144
 145         if ((data.indexOf("<") > -1))
 146         {
 147           reply = "RNAML";
 148
 149           break;
 150         }
 151
 152         if ((data.length() < 1) || (data.indexOf("#") == 0))
 153         {
 154           lineswereskipped = true;
 155           continue;
 156         }
 157
 158         if (data.indexOf("PILEUP") > -1)
 159         {
 160           reply = "PileUp";
 161
 162           break;
 163         }
 164
 165         if ((data.indexOf("//") == 0)
 166                 || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
 167                         .indexOf("_MULTIPLE_ALIGNMENT "))))
 168         {
 169           reply = "MSF";
 170
 171           break;
 172         }
 173         else if (data.indexOf("CLUSTAL") > -1)
 174         {
 175           reply = "CLUSTAL";
 176
 177           break;
 178         }
 179
 180         else if (data.indexOf(">") > -1)
 181         {
 182           // FASTA, PIR file or BLC file
 183           boolean checkPIR = false, starterm = false;
 184           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
 185           {
 186             // watch for PIR file attributes
 187             checkPIR = true;
 188             reply = "PIR";
 189           }
 190           // could also be BLC file, read next line to confirm
 191           data = source.nextLine();
 192
 193           if (data.indexOf(">") > -1)
 194           {
 195             reply = "BLC";
 196           }
 197           else
 198           {
 199             // Is this a single line BLC file?
 200             String data1 = source.nextLine();
 201             String data2 = source.nextLine();
 202             int c1;
 203             if (checkPIR)
 204             {
 205               starterm = (data1 != null && data1.indexOf("*") > -1)
 206                       || (data2 != null && data2.indexOf("*") > -1);
 207             }
 208             if (data2 != null && (c1 = data.indexOf("*")) > -1)
 209             {
 210               if (c1 == 0 && c1 == data2.indexOf("*"))
 211               {
 212                 reply = "BLC";
 213               }
 214               else
 215               {
 216                 reply = "FASTA"; // possibly a bad choice - may be recognised as
 217                 // PIR
 218               }
 219               // otherwise can still possibly be a PIR file
 220             }
 221             else
 222             {
 223               reply = "FASTA";
 224               // TODO : AMSA File is indicated if there is annotation in the
 225               // FASTA file - but FASTA will automatically generate this at the
 226               // mo.
 227               if (!checkPIR)
 228               {
 229                 break;
 230               }
 231             }
 232           }
 233           // final check for PIR content. require
 234           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 235
 236           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 237           // have
 238           // a 'Parse as type XXX' parameter for the applet/application.
 239           if (checkPIR)
 240           {
 241             String dta = null;
 242             if (!starterm)
 243             {
 244               do
 245               {
 246                 try
 247                 {
 248                   dta = source.nextLine();
 249                 } catch (IOException ex)
 250                 {
 251                 }
 252                 ;
 253                 if (dta != null && dta.indexOf("*") > -1)
 254                 {
 255                   starterm = true;
 256                 }
 257               } while (dta != null && !starterm);
 258             }
 259             if (starterm)
 260             {
 261               reply = "PIR";
 262               break;
 263             }
 264             else
 265             {
 266               reply = "FASTA"; // probably a bad choice!
 267             }
 268           }
 269           // read as a FASTA (probably)
 270           break;
 271         }
 272         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 273         {
 274           reply = "PDB";
 275           break;
 276         }
 277         else if (data.matches("\\s*\\d+\\s+\\d+\\s*"))
 278         {
 279           reply = PhylipFile.FILE_DESC;
 280           break;
 281         }
 282
 283
 284         /*
 285          * // TODO comment out SimpleBLAST identification for Jalview 2.4.1 else
 286          * if (!lineswereskipped && data.indexOf("BLAST")<4) { reply =
 287          * "SimpleBLAST"; break;
 288          *
 289          * } // end comments for Jalview 2.4.1
 290          */
 291         else if (!lineswereskipped && data.charAt(0) != '*'
 292                 && data.charAt(0) != ' '
 293                 && data.indexOf(":") < data.indexOf(",")) // &&
 294           // data.indexOf(",")<data.indexOf(",",
 295           // data.indexOf(",")))
 296         {
 297           // file looks like a concise JNet file
 298           reply = "JnetFile";
 299           break;
 300         }
 301
 302         lineswereskipped = true; // this means there was some junk before any
 303         // key file signature
 304       }
 305       if (closeSource)
 306       {
 307         source.close();
 308       }
 309       else
 310       {
 311         source.reset(); // so the file can be parsed from the beginning again.
 312       }
 313     } catch (Exception ex)
 314     {
 315       System.err.println("File Identification failed!\n" + ex);
 316       return source.errormessage;
 317     }
 318     if (length == 0)
 319     {
 320       System.err
 321       .println("File Identification failed! - Empty file was read.");
 322       return "EMPTY DATA FILE";
 323     }
 324     return reply;
 325   }
 326
 327   public static void main(String[] args)
 328   {
 329
 330     for (int i = 0; args != null && i < args.length; i++)
 331     {
 332       IdentifyFile ider = new IdentifyFile();
 333       String type = ider.Identify(args[i], AppletFormatAdapter.FILE);
 334       System.out.println("Type of " + args[i] + " is " + type);
 335     }
 336     if (args == null || args.length == 0)
 337     {
 338       System.err.println("Usage: <Filename> [<Filename> ...]");
 339     }
 340   }
 341 }