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.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("##GFF-VERSION"))
 136         {
 137           reply = GFF3File;
 138           break;
 139         }
 140         if (data.indexOf("# STOCKHOLM") > -1)
 141         {
 142           reply = "STH";
 143           break;
 144         }
 145         // if (data.matches("<(\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 146         if (data.matches("<(?i)html(\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 147         {
 148           reply = HtmlFile.FILE_DESC;
 149           break;
 150         }
 151
 152         if (data.matches("<(?i)rnaml (\"[^\"]*\"|'[^']*'|[^'\">])*>"))
 153         {
 154           reply = "RNAML";
 155           break;
 156         }
 157
 158          if (data.indexOf("{\"") > -1)
 159          {
 160          reply = JSONFile.FILE_DESC;
 161          break;
 162          }
 163         if ((data.length() < 1) || (data.indexOf("#") == 0))
 164         {
 165           lineswereskipped = true;
 166           continue;
 167         }
 168
 169         if (data.indexOf("PILEUP") > -1)
 170         {
 171           reply = "PileUp";
 172
 173           break;
 174         }
 175
 176         if ((data.indexOf("//") == 0)
 177                 || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
 178                         .indexOf("_MULTIPLE_ALIGNMENT "))))
 179         {
 180           reply = "MSF";
 181
 182           break;
 183         }
 184         else if (data.indexOf("CLUSTAL") > -1)
 185         {
 186           reply = "CLUSTAL";
 187
 188           break;
 189         }
 190
 191         else if (data.indexOf(">") > -1)
 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 = "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 = "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 = "BLC";
 224               }
 225               else
 226               {
 227                 reply = "FASTA"; // possibly a bad choice - may be recognised as
 228                 // PIR
 229               }
 230               // otherwise can still possibly be a PIR file
 231             }
 232             else
 233             {
 234               reply = "FASTA";
 235               // TODO : AMSA File is indicated if there is annotation in the
 236               // FASTA file - but FASTA will automatically generate this at the
 237               // mo.
 238               if (!checkPIR)
 239               {
 240                 break;
 241               }
 242             }
 243           }
 244           // final check for PIR content. require
 245           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 246
 247           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 248           // have
 249           // a 'Parse as type XXX' parameter for the applet/application.
 250           if (checkPIR)
 251           {
 252             String dta = null;
 253             if (!starterm)
 254             {
 255               do
 256               {
 257                 try
 258                 {
 259                   dta = source.nextLine();
 260                 } catch (IOException ex)
 261                 {
 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 = "PIR";
 273               break;
 274             }
 275             else
 276             {
 277               reply = "FASTA"; // probably a bad choice!
 278             }
 279           }
 280           // read as a FASTA (probably)
 281           break;
 282         }
 283         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 284         {
 285           reply = "PDB";
 286           break;
 287         }
 288         else if (data.matches("\\s*\\d+\\s+\\d+\\s*"))
 289         {
 290           reply = PhylipFile.FILE_DESC;
 291           break;
 292         }
 293
 294
 295         /*
 296          * // TODO comment out SimpleBLAST identification for Jalview 2.4.1 else
 297          * if (!lineswereskipped && data.indexOf("BLAST")<4) { reply =
 298          * "SimpleBLAST"; break;
 299          *
 300          * } // end comments for Jalview 2.4.1
 301          */
 302         else if (!lineswereskipped && data.charAt(0) != '*'
 303                 && data.charAt(0) != ' '
 304                 && data.indexOf(":") < data.indexOf(",")) // &&
 305           // data.indexOf(",")<data.indexOf(",",
 306           // data.indexOf(",")))
 307         {
 308           // file looks like a concise JNet file
 309           reply = "JnetFile";
 310           break;
 311         }
 312
 313         lineswereskipped = true; // this means there was some junk before any
 314         // key file signature
 315       }
 316       if (closeSource)
 317       {
 318         source.close();
 319       }
 320       else
 321       {
 322         source.reset(); // so the file can be parsed from the beginning again.
 323       }
 324     } catch (Exception ex)
 325     {
 326       System.err.println("File Identification failed!\n" + ex);
 327       return source.errormessage;
 328     }
 329     if (length == 0)
 330     {
 331       System.err
 332       .println("File Identification failed! - Empty file was read.");
 333       return "EMPTY DATA FILE";
 334     }
 335     return reply;
 336   }
 337
 338   public static void main(String[] args)
 339   {
 340
 341     for (int i = 0; args != null && i < args.length; i++)
 342     {
 343       IdentifyFile ider = new IdentifyFile();
 344       String type = ider.Identify(args[i], AppletFormatAdapter.FILE);
 345       System.out.println("Type of " + args[i] + " is " + type);
 346     }
 347     if (args == null || args.length == 0)
 348     {
 349       System.err.println("Usage: <Filename> [<Filename> ...]");
 350     }
 351   }
 352 }