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.length() < 1) || (data.indexOf("#") == 0))
 137         {
 138           lineswereskipped = true;
 139           continue;
 140         }
 141
 142         if (data.indexOf("PILEUP") > -1)
 143         {
 144           reply = "PileUp";
 145
 146           break;
 147         }
 148
 149         if ((data.indexOf("//") == 0)
 150                 || ((data.indexOf("!!") > -1) && (data.indexOf("!!") < data
 151                         .indexOf("_MULTIPLE_ALIGNMENT "))))
 152         {
 153           reply = "MSF";
 154
 155           break;
 156         }
 157         else if (data.indexOf("CLUSTAL") > -1)
 158         {
 159           reply = "CLUSTAL";
 160
 161           break;
 162         }
 163         else if (data.indexOf(">") > -1)
 164         {
 165           // FASTA, PIR file or BLC file
 166           boolean checkPIR = false, starterm = false;
 167           if ((data.indexOf(">P1;") > -1) || (data.indexOf(">DL;") > -1))
 168           {
 169             // watch for PIR file attributes
 170             checkPIR = true;
 171             reply = "PIR";
 172           }
 173           // could also be BLC file, read next line to confirm
 174           data = source.nextLine();
 175
 176           if (data.indexOf(">") > -1)
 177           {
 178             reply = "BLC";
 179           }
 180           else
 181           {
 182             // Is this a single line BLC file?
 183             String data1 = source.nextLine();
 184             String data2 = source.nextLine();
 185             int c1;
 186             if (checkPIR)
 187             {
 188               starterm = (data1 != null && data1.indexOf("*") > -1)
 189                       || (data2 != null && data2.indexOf("*") > -1);
 190             }
 191             if (data2 != null && (c1=data.indexOf("*")) > -1)
 192             {
 193               if (c1==0 && c1 == data2.indexOf("*"))
 194               {
 195                 reply = "BLC";
 196               } else {
 197                 reply = "FASTA"; // possibly a bad choice - may be recognised as PIR
 198               }
 199               // otherwise can still possibly be a PIR file
 200             }
 201             else
 202             {
 203               reply = "FASTA";
 204               // TODO : AMSA File is indicated if there is annotation in the
 205               // FASTA file - but FASTA will automatically generate this at the
 206               // mo.
 207               if (!checkPIR)
 208               {
 209                 break;
 210               }
 211             }
 212           }
 213           // final check for PIR content. require
 214           // >P1;title\n<blah>\nterminated sequence to occur at least once.
 215
 216           // TODO the PIR/fasta ambiguity may be the use case that is needed to
 217           // have
 218           // a 'Parse as type XXX' parameter for the applet/application.
 219           if (checkPIR)
 220           {
 221             String dta = null;
 222             if (!starterm)
 223             {
 224               do
 225               {
 226                 try
 227                 {
 228                   dta = source.nextLine();
 229                 } catch (IOException ex)
 230                 {
 231                 }
 232                 ;
 233                 if (dta != null && dta.indexOf("*") > -1)
 234                 {
 235                   starterm = true;
 236                 }
 237               } while (dta != null && !starterm);
 238             }
 239             if (starterm)
 240             {
 241               reply = "PIR";
 242               break;
 243             }
 244             else
 245             {
 246               reply = "FASTA"; // probably a bad choice!
 247             }
 248           }
 249           // read as a FASTA (probably)
 250           break;
 251         }
 252         else if (data.indexOf("HEADER") == 0 || data.indexOf("ATOM") == 0)
 253         {
 254           reply = "PDB";
 255           break;
 256         }
 257         /*
 258          * // TODO comment out SimpleBLAST identification for Jalview 2.4.1 else
 259          * if (!lineswereskipped && data.indexOf("BLAST")<4) { reply =
 260          * "SimpleBLAST"; break;
 261          *
 262          * } // end comments for Jalview 2.4.1
 263          */
 264         else if (!lineswereskipped && data.charAt(0) != '*'
 265                 && data.charAt(0) != ' '
 266                 && data.indexOf(":") < data.indexOf(",")) // &&
 267         // data.indexOf(",")<data.indexOf(",",
 268         // data.indexOf(",")))
 269         {
 270           // file looks like a concise JNet file
 271           reply = "JnetFile";
 272           break;
 273         }
 274
 275         lineswereskipped = true; // this means there was some junk before any
 276         // key file signature
 277       }
 278       if (closeSource)
 279       {
 280         source.close();
 281       }
 282       else
 283       {
 284         source.reset(); // so the file can be parsed from the beginning again.
 285       }
 286     } catch (Exception ex)
 287     {
 288       System.err.println("File Identification failed!\n" + ex);
 289       return source.errormessage;
 290     }
 291     if (length == 0)
 292     {
 293       System.err
 294               .println("File Identification failed! - Empty file was read.");
 295       return "EMPTY DATA FILE";
 296     }
 297     return reply;
 298   }
 299
 300   public static void main(String[] args)
 301   {
 302     for (int i = 0; args != null && i < args.length; i++)
 303     {
 304       IdentifyFile ider = new IdentifyFile();
 305       String type = ider.Identify(args[i], AppletFormatAdapter.FILE);
 306       System.out.println("Type of " + args[i] + " is " + type);
 307     }
 308     if (args == null || args.length == 0)
 309     {
 310       System.err.println("Usage: <Filename> [<Filename> ...]");
 311     }
 312   }
 313 }