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