src/jalview/io/IdentifyFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.io;
  20
  21 import java.io.*;
  22
  23 /**
  24  * DOCUMENT ME!
  25  *
  26  * @author $author$
  27  * @version $Revision$
  28  */
  29 public class IdentifyFile
  30 {
  31   /**
  32    * Identify a datasource's file content.
  33    *
  34    * @note Do not use this method for stream sources - create a FileParse object
  35    *       instead.
  36    *
  37    * @param file
  38    *          DOCUMENT ME!
  39    * @param protocol
  40    *          DOCUMENT ME!
  41    * @return ID String
  42    */
  43   public String Identify(String file, String protocol)
  44   {
  45     String emessage = "UNIDENTIFIED FILE PARSING ERROR";
  46     FileParse parser = null;
  47     try
  48     {
  49       parser = new FileParse(file, protocol);
  50       if (parser.isValid())
  51       {
  52         return Identify(parser);
  53       }
  54     } catch (Exception e)
  55     {
  56       System.err.println("Error whilst identifying");
  57       e.printStackTrace(System.err);
  58       emessage = e.getMessage();
  59     }
  60     if (parser != null)
  61       return parser.errormessage;
  62     return emessage;
  63   }
  64
  65   public String Identify(FileParse source)
  66   {
  67     return Identify(source, true); // preserves original behaviour prior to
  68     // version 2.3
  69   }
  70
  71   /**
  72    * Identify contents of source, closing it or resetting source to start
  73    * afterwards.
  74    *
  75    * @param source
  76    * @param closeSource
  77    * @return filetype string
  78    */
  79   public String Identify(FileParse source, boolean closeSource)
  80   {
  81     String reply = "PFAM";
  82     String data;
  83     int length = 0;
  84     boolean lineswereskipped = false;
  85     boolean isBinary = false; // true if length is non-zero and non-printable
  86     // characters are encountered
  87     try
  88     {
  89       if (!closeSource)
  90       {
  91         source.mark();
  92       }
  93       while ((data = source.nextLine()) != null)
  94       {
  95         length += data.length();
  96         if (!lineswereskipped)
  97         {
  98           for (int i = 0; !isBinary && i < data.length(); i++)
  99           {
 100             char c = data.charAt(i);
 101             isBinary = (c < 32 && c != '\t' && c != '\n' && c != '\r'
 102                     && c != 5 && c != 27); // nominal binary character filter
 103             // excluding CR, LF, tab,DEL and ^E
 104             // for certain blast ids
 105           }
 106         }
 107         if (isBinary)
 108         {
 109           // jar files are special - since they contain all sorts of random
 110           // characters.
 111           if (source.inFile != null)
 112           {
 113             String fileStr = source.inFile.getName();
 114             // possibly a Jalview archive.
 115             if (fileStr.lastIndexOf(".jar") > -1
 116                     || fileStr.lastIndexOf(".zip") > -1)
 117             {
 118               reply = "Jalview";
 119             }
 120           }
 121           if (!lineswereskipped && data.startsWith("PK"))
 122           {
 123             reply = "Jalview"; // archive.
 124             break;
 125           }
 126         }
 127         data = data.toUpperCase();
 128
 129         if ((data.indexOf("# STOCKHOLM") > -1))
 130         {
 131           reply = "STH";
 132
 133           break;
 134         }
 135
 136         if ((data.indexOf("<") > -1))
 137         {
 138           reply = "RNAML";
 139
 140           break;
 141         }
 142
 143         if ((data.length() < 1) || (data.indexOf("#") == 0))
 144         {
 145           lineswereskipped = true;
 146           continue;
 147         }
 148
 149         if (data.indexOf("PILEUP") > -1)
 150         {
 151           reply = "PileUp";
 152
 153           break;
 154         }
 155
 156         if ((data.indexOf("//") == 0)
 157                 || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
 158                         .indexOf("_MULTIPLE_ALIGNMENT "))))
 159         {
 160           reply = "MSF";
 161
 162           break;
 163         }
 164         else if (data.indexOf("CLUSTAL") > -1)
 165         {
 166           reply = "CLUSTAL";
 167
 168           break;
 169         }
 170
 171
 172         else if (data.indexOf(">") > -1)
 173         {
 174           // FASTA, PIR file or BLC file
 175           boolean checkPIR = false, starterm = false;
 176           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
 177           {
 178             // watch for PIR file attributes
 179             checkPIR = true;
 180             reply = "PIR";
 181           }
 182           // could also be BLC file, read next line to confirm
 183           data = source.nextLine();
 184
 185           if (data.indexOf(">") > -1)
 186           {
 187             reply = "BLC";
 188           }
 189           else
 190           {
 191             // Is this a single line BLC file?
 192             String data1 = source.nextLine();
 193             String data2 = source.nextLine();
 194             if (checkPIR)
 195             {
 196               starterm = (data1 != null && data1.indexOf("*") > -1)
 197                       || (data2 != null && data2.indexOf("*") > -1);
 198             }
 199             if (data2 != null && data.indexOf("*") > -1)
 200             {
 201               if (data.indexOf("*") == data2.indexOf("*"))
 202               {
 203                 reply = "BLC";
 204               }
 205               // otherwise can still possibly be a PIR file
 206             }
 207             else
 208             {
 209               reply = "FASTA";
 210               // TODO : AMSA File is indicated if there is annotation in the
 211               // FASTA file - but FASTA will automatically generate this at the
 212               // mo.
 213               if (!checkPIR)
 214               {
 215                 break;
 216               }
 217             }
 218           }
 219           // final check for PIR content. require
 220           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 221
 222           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 223           // have
 224           // a 'Parse as type XXX' parameter for the applet/application.
 225           if (checkPIR)
 226           {
 227             String dta = null;
 228             if (!starterm)
 229             {
 230               do
 231               {
 232                 try
 233                 {
 234                   dta = source.nextLine();
 235                 } catch (IOException ex)
 236                 {
 237                 }
 238                 ;
 239                 if (dta != null && dta.indexOf("*") > -1)
 240                 {
 241                   starterm = true;
 242                 }
 243               } while (dta != null && !starterm);
 244             }
 245             if (starterm)
 246             {
 247               reply = "PIR";
 248               break;
 249             }
 250             else
 251             {
 252               reply = "FASTA"; // probably a bad choice!
 253             }
 254           }
 255           // read as a FASTA (probably)
 256           break;
 257         }
 258         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 259         {
 260           reply = "PDB";
 261           break;
 262         }
 263         /*
 264          * // TODO comment out SimpleBLAST identification for Jalview 2.4.1 else
 265          * if (!lineswereskipped && data.indexOf("BLAST")<4) { reply =
 266          * "SimpleBLAST"; break;
 267          *
 268          * } // end comments for Jalview 2.4.1
 269          */
 270         else if (!lineswereskipped && data.charAt(0) != '*'
 271                 && data.charAt(0) != ' '
 272                 && data.indexOf(":") < data.indexOf(",")) // &&
 273         // data.indexOf(",")<data.indexOf(",",
 274         // data.indexOf(",")))
 275         {
 276           // file looks like a concise JNet file
 277           reply = "JnetFile";
 278           break;
 279         }
 280
 281         lineswereskipped = true; // this means there was some junk before any
 282         // key file signature
 283       }
 284       if (closeSource)
 285       {
 286         source.close();
 287       }
 288       else
 289       {
 290         source.reset(); // so the file can be parsed from the beginning again.
 291       }
 292     } catch (Exception ex)
 293     {
 294       System.err.println("File Identification failed!\n" + ex);
 295       return source.errormessage;
 296     }
 297     if (length == 0)
 298     {
 299       System.err
 300               .println("File Identification failed! - Empty file was read.");
 301       return "EMPTY DATA FILE";
 302     }
 303     return reply;
 304   }
 305
 306   public static void main(String[] args)
 307   {
 308     for (int i = 0; args != null && i < args.length; i++)
 309     {
 310       IdentifyFile ider = new IdentifyFile();
 311       String type = ider.Identify(args[i], AppletFormatAdapter.FILE);
 312       System.out.println("Type of " + args[i] + " is " + type);
 313     }
 314     if (args == null || args.length == 0)
 315     {
 316       System.err.println("Usage: <Filename> [<Filename> ...]");
 317     }
 318   }
 319 }