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