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