src/jalview/io/IdentifyFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
   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         if (data.matches("<(?i)html(\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 141         {
 142           reply = "HTML";
 143           break;
 144         }
 145
 146         if (data.matches("<(?i)rnaml (\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 147         {
 148           reply = "RNAML";
 149
 150           break;
 151         }
 152
 153         if ((data.length() < 1) || (data.indexOf("#") == 0))
 154         {
 155           lineswereskipped = true;
 156           continue;
 157         }
 158
 159         if (data.indexOf("PILEUP") > -1)
 160         {
 161           reply = "PileUp";
 162
 163           break;
 164         }
 165
 166         if ((data.indexOf("//") == 0)
 167                 || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
 168                         .indexOf("_MULTIPLE_ALIGNMENT "))))
 169         {
 170           reply = "MSF";
 171
 172           break;
 173         }
 174         else if (data.indexOf("CLUSTAL") > -1)
 175         {
 176           reply = "CLUSTAL";
 177
 178           break;
 179         }
 180
 181         else if (data.indexOf(">") > -1)
 182         {
 183           // FASTA, PIR file or BLC file
 184           boolean checkPIR = false, starterm = false;
 185           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
 186           {
 187             // watch for PIR file attributes
 188             checkPIR = true;
 189             reply = "PIR";
 190           }
 191           // could also be BLC file, read next line to confirm
 192           data = source.nextLine();
 193
 194           if (data.indexOf(">") > -1)
 195           {
 196             reply = "BLC";
 197           }
 198           else
 199           {
 200             // Is this a single line BLC file?
 201             String data1 = source.nextLine();
 202             String data2 = source.nextLine();
 203             int c1;
 204             if (checkPIR)
 205             {
 206               starterm = (data1 != null && data1.indexOf("*") > -1)
 207                       || (data2 != null && data2.indexOf("*") > -1);
 208             }
 209             if (data2 != null && (c1 = data.indexOf("*")) > -1)
 210             {
 211               if (c1 == 0 && c1 == data2.indexOf("*"))
 212               {
 213                 reply = "BLC";
 214               }
 215               else
 216               {
 217                 reply = "FASTA"; // possibly a bad choice - may be recognised as
 218                 // PIR
 219               }
 220               // otherwise can still possibly be a PIR file
 221             }
 222             else
 223             {
 224               reply = "FASTA";
 225               // TODO : AMSA File is indicated if there is annotation in the
 226               // FASTA file - but FASTA will automatically generate this at the
 227               // mo.
 228               if (!checkPIR)
 229               {
 230                 break;
 231               }
 232             }
 233           }
 234           // final check for PIR content. require
 235           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 236
 237           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 238           // have
 239           // a 'Parse as type XXX' parameter for the applet/application.
 240           if (checkPIR)
 241           {
 242             String dta = null;
 243             if (!starterm)
 244             {
 245               do
 246               {
 247                 try
 248                 {
 249                   dta = source.nextLine();
 250                 } catch (IOException ex)
 251                 {
 252                 }
 253                 ;
 254                 if (dta != null && dta.indexOf("*") > -1)
 255                 {
 256                   starterm = true;
 257                 }
 258               } while (dta != null && !starterm);
 259             }
 260             if (starterm)
 261             {
 262               reply = "PIR";
 263               break;
 264             }
 265             else
 266             {
 267               reply = "FASTA"; // probably a bad choice!
 268             }
 269           }
 270           // read as a FASTA (probably)
 271           break;
 272         }
 273         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 274         {
 275           reply = "PDB";
 276           break;
 277         }
 278         else if (data.matches("\\s*\\d+\\s+\\d+\\s*"))
 279         {
 280           reply = PhylipFile.FILE_DESC;
 281           break;
 282         }
 283
 284
 285         /*
 286          * // TODO comment out SimpleBLAST identification for Jalview 2.4.1 else
 287          * if (!lineswereskipped && data.indexOf("BLAST")<4) { reply =
 288          * "SimpleBLAST"; break;
 289          *
 290          * } // end comments for Jalview 2.4.1
 291          */
 292         else if (!lineswereskipped && data.charAt(0) != '*'
 293                 && data.charAt(0) != ' '
 294                 && data.indexOf(":") < data.indexOf(",")) // &&
 295           // data.indexOf(",")<data.indexOf(",",
 296           // data.indexOf(",")))
 297         {
 298           // file looks like a concise JNet file
 299           reply = "JnetFile";
 300           break;
 301         }
 302
 303         lineswereskipped = true; // this means there was some junk before any
 304         // key file signature
 305       }
 306       if (closeSource)
 307       {
 308         source.close();
 309       }
 310       else
 311       {
 312         source.reset(); // so the file can be parsed from the beginning again.
 313       }
 314     } catch (Exception ex)
 315     {
 316       System.err.println("File Identification failed!\n" + ex);
 317       return source.errormessage;
 318     }
 319     if (length == 0)
 320     {
 321       System.err
 322       .println("File Identification failed! - Empty file was read.");
 323       return "EMPTY DATA FILE";
 324     }
 325     return reply;
 326   }
 327
 328   public static void main(String[] args)
 329   {
 330
 331     for (int i = 0; args != null && i < args.length; i++)
 332     {
 333       IdentifyFile ider = new IdentifyFile();
 334       String type = ider.Identify(args[i], AppletFormatAdapter.FILE);
 335       System.out.println("Type of " + args[i] + " is " + type);
 336     }
 337     if (args == null || args.length == 0)
 338     {
 339       System.err.println("Usage: <Filename> [<Filename> ...]");
 340     }
 341   }
 342 }