src/jalview/io/FileParse.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.BufferedInputStream;
  24 import java.io.BufferedReader;
  25 import java.io.ByteArrayInputStream;
  26 import java.io.File;
  27 import java.io.FileInputStream;
  28 import java.io.FileReader;
  29 import java.io.IOException;
  30 import java.io.InputStream;
  31 import java.io.InputStreamReader;
  32 import java.io.Reader;
  33 import java.io.StringReader;
  34 import java.net.HttpURLConnection;
  35 import java.net.MalformedURLException;
  36 import java.net.URL;
  37 import java.net.URLConnection;
  38 import java.util.zip.GZIPInputStream;
  39
  40 import jalview.api.AlignExportSettingsI;
  41 import jalview.api.AlignViewportI;
  42 import jalview.api.AlignmentViewPanel;
  43 import jalview.api.FeatureSettingsModelI;
  44 import jalview.bin.Cache;
  45 import jalview.util.MessageManager;
  46 import jalview.util.Platform;
  47
  48 /**
  49  * implements a random access wrapper around a particular datasource, for
  50  * passing to identifyFile and AlignFile objects.
  51  */
  52 public class FileParse
  53 {
  54   protected static final String SPACE = " ";
  55
  56   protected static final String TAB = "\t";
  57
  58   /**
  59    * text specifying source of data. usually filename or url.
  60    */
  61   private String dataName = "unknown source";
  62
  63   public File inFile = null;
  64
  65   private byte[] bytes; // from JavaScript
  66
  67   public byte[] getBytes()
  68   {
  69     return bytes;
  70   }
  71
  72   /**
  73    * a viewport associated with the current file operation. May be null. May
  74    * move to different object.
  75    */
  76   private AlignViewportI viewport;
  77
  78   /**
  79    * specific settings for exporting data from the current context
  80    */
  81   private AlignExportSettingsI exportSettings;
  82
  83   /**
  84    * sequence counter for FileParse object created from same data source
  85    */
  86   public int index = 1;
  87
  88   /**
  89    * separator for extracting specific 'frame' of a datasource for formats that
  90    * support multiple records (e.g. BLC, Stockholm, etc)
  91    */
  92   protected char suffixSeparator = '#';
  93
  94   /**
  95    * character used to write newlines
  96    */
  97   protected String newline = System.getProperty("line.separator");
  98
  99   public void setNewlineString(String nl)
 100   {
 101     newline = nl;
 102   }
 103
 104   public String getNewlineString()
 105   {
 106     return newline;
 107   }
 108
 109   /**
 110    * '#' separated string tagged on to end of filename or url that was clipped
 111    * off to resolve to valid filename
 112    */
 113   protected String suffix = null;
 114
 115   protected DataSourceType dataSourceType = null;
 116
 117   protected BufferedReader dataIn = null;
 118
 119   protected String errormessage = "UNINITIALISED SOURCE";
 120
 121   protected boolean error = true;
 122
 123   protected String warningMessage = null;
 124
 125   /**
 126    * size of readahead buffer used for when initial stream position is marked.
 127    */
 128   final int READAHEAD_LIMIT = 2048;
 129
 130   public FileParse()
 131   {
 132   }
 133
 134   /**
 135    * Create a new FileParse instance reading from the same datasource starting
 136    * at the current position. WARNING! Subsequent reads from either object will
 137    * affect the read position of the other, but not the error state.
 138    *
 139    * @param from
 140    */
 141   public FileParse(FileParse from) throws IOException
 142   {
 143     if (from == null)
 144     {
 145       throw new Error(MessageManager
 146               .getString("error.implementation_error_null_fileparse"));
 147     }
 148     if (from == this)
 149     {
 150       return;
 151     }
 152     index = ++from.index;
 153     inFile = from.inFile;
 154     suffixSeparator = from.suffixSeparator;
 155     suffix = from.suffix;
 156     errormessage = from.errormessage; // inherit potential error messages
 157     error = false; // reset any error condition.
 158     dataSourceType = from.dataSourceType;
 159     dataIn = from.dataIn;
 160     if (dataIn != null)
 161     {
 162       mark();
 163     }
 164     dataName = from.dataName;
 165   }
 166
 167   /**
 168    * Attempt to open a file as a datasource. Sets error and errormessage if
 169    * fileStr was invalid.
 170    *
 171    * @param fileStr
 172    * @return this.error (true if the source was invalid)
 173    */
 174   private boolean checkFileSource(String fileStr) throws IOException
 175   {
 176     error = false;
 177     this.inFile = new File(fileStr);
 178     // check to see if it's a Jar file in disguise.
 179     if (!inFile.exists())
 180     {
 181       errormessage = "FILE NOT FOUND";
 182       error = true;
 183     }
 184     if (!inFile.canRead())
 185     {
 186       errormessage = "FILE CANNOT BE OPENED FOR READING";
 187       error = true;
 188     }
 189     if (inFile.isDirectory())
 190     {
 191       // this is really a 'complex' filetype - but we don't handle directory
 192       // reads yet.
 193       errormessage = "FILE IS A DIRECTORY";
 194       error = true;
 195     }
 196     if (!error)
 197     {
 198       try
 199       {
 200         dataIn = checkForGzipStream(new FileInputStream(fileStr));
 201         dataName = fileStr;
 202       } catch (Exception x)
 203       {
 204         warningMessage = "Failed to resolve " + fileStr
 205                 + " as a data source. (" + x.getMessage() + ")";
 206         // x.printStackTrace();
 207         error = true;
 208       }
 209       ;
 210     }
 211     return error;
 212   }
 213
 214   /**
 215    * Recognise the 2-byte magic header for gzip streams
 216    *
 217    * https://recalll.co/ask/v/topic/java-How-to-check-if-InputStream-is-Gzipped/555aadd62bd27354438b90f6
 218    *
 219    * @param bytes
 220    *          - at least two bytes
 221    * @return
 222    * @throws IOException
 223    */
 224   public static boolean isGzipStream(InputStream input) throws IOException
 225   {
 226     if (!input.markSupported())
 227     {
 228       Cache.log.error(
 229               "FileParse.izGzipStream: input stream must support mark/reset");
 230       return false;
 231     }
 232     input.mark(4);
 233
 234     // get first 2 bytes or return false
 235     byte[] bytes = new byte[2];
 236     int read = input.read(bytes);
 237     input.reset();
 238     if (read != bytes.length)
 239     {
 240       return false;
 241     }
 242
 243     int header = (bytes[0] & 0xff) | ((bytes[1] << 8) & 0xff00);
 244     return (GZIPInputStream.GZIP_MAGIC == header);
 245   }
 246
 247   /**
 248    * Returns a Reader for the given input after wrapping it in a buffered input
 249    * stream, and then checking if it needs to be wrapped by a GZipInputStream
 250    *
 251    * @param input
 252    * @return
 253    */
 254   private BufferedReader checkForGzipStream(InputStream input)
 255           throws Exception
 256   {
 257     // NB: stackoverflow
 258     // https://stackoverflow.com/questions/4818468/how-to-check-if-inputstream-is-gzipped
 259     // could use a PushBackInputStream rather than a BufferedInputStream
 260     if (!input.markSupported())
 261     {
 262       input = new BufferedInputStream(input, 16);
 263     }
 264     if (isGzipStream(input))
 265     {
 266       return getGzipReader(input);
 267     }
 268     // return a buffered reader for the stream.
 269     InputStreamReader isReader = new InputStreamReader(input);
 270     BufferedReader toReadFrom = new BufferedReader(isReader);
 271     return toReadFrom;
 272   }
 273
 274   /**
 275    * Returns a {@code BufferedReader} which wraps the input stream with a
 276    * GZIPInputStream. Throws a {@code ZipException} if a GZIP format error
 277    * occurs or the compression method used is unsupported.
 278    *
 279    * @param inputStream
 280    * @return
 281    * @throws Exception
 282    */
 283   private BufferedReader getGzipReader(InputStream inputStream)
 284           throws Exception
 285   {
 286     BufferedReader inData = new BufferedReader(
 287             new InputStreamReader(new GZIPInputStream(inputStream)));
 288     inData.mark(2048);
 289     inData.read();
 290     inData.reset();
 291     return inData;
 292   }
 293
 294   /**
 295    * Tries to read from the given URL. If successful, saves a reader to the
 296    * response in field {@code dataIn}, otherwise (on exception, or HTTP response
 297    * status not 200), throws an exception.
 298    * <p>
 299    * If the response status includes
 300    *
 301    * <pre>
 302    * Content-Type : application/x-gzip
 303    * </pre>
 304    *
 305    * then tries to read as gzipped content.
 306    *
 307    * @param urlStr
 308    * @throws IOException
 309    * @throws MalformedURLException
 310    */
 311   private void checkURLSource(String urlStr)
 312           throws IOException, MalformedURLException
 313   {
 314     errormessage = "URL NOT FOUND";
 315     URL url = new URL(urlStr);
 316     URLConnection _conn = url.openConnection();
 317     if (_conn instanceof HttpURLConnection)
 318     {
 319       HttpURLConnection conn = (HttpURLConnection) _conn;
 320       int rc = conn.getResponseCode();
 321       if (rc != HttpURLConnection.HTTP_OK)
 322       {
 323         throw new IOException(
 324                 "Response status from " + urlStr + " was " + rc);
 325       }
 326     }
 327     else
 328     {
 329       try
 330       {
 331         dataIn = checkForGzipStream(_conn.getInputStream());
 332         dataName = urlStr;
 333       } catch (IOException ex)
 334       {
 335         throw new IOException("Failed to handle non-HTTP URI stream", ex);
 336       } catch (Exception ex)
 337       {
 338         throw new IOException(
 339                 "Failed to determine type of input stream for given URI",
 340                 ex);
 341       }
 342       return;
 343     }
 344     String encoding = _conn.getContentEncoding();
 345     String contentType = _conn.getContentType();
 346     boolean isgzipped = "application/x-gzip".equalsIgnoreCase(contentType)
 347             || "gzip".equals(encoding);
 348     Exception e = null;
 349     InputStream inputStream = _conn.getInputStream();
 350     if (isgzipped)
 351     {
 352       try
 353       {
 354         dataIn = getGzipReader(inputStream);
 355         dataName = urlStr;
 356       } catch (Exception e1)
 357       {
 358         throw new IOException(MessageManager
 359                 .getString("exception.failed_to_resolve_gzip_stream"), e);
 360       }
 361       return;
 362     }
 363
 364     dataIn = new BufferedReader(new InputStreamReader(inputStream));
 365     dataName = urlStr;
 366     return;
 367   }
 368
 369   /**
 370    * sets the suffix string (if any) and returns remainder (if suffix was
 371    * detected)
 372    *
 373    * @param fileStr
 374    * @return truncated fileStr or null
 375    */
 376   private String extractSuffix(String fileStr)
 377   {
 378     // first check that there wasn't a suffix string tagged on.
 379     int sfpos = fileStr.lastIndexOf(suffixSeparator);
 380     if (sfpos > -1 && sfpos < fileStr.length() - 1)
 381     {
 382       suffix = fileStr.substring(sfpos + 1);
 383       // System.err.println("DEBUG: Found Suffix:"+suffix);
 384       return fileStr.substring(0, sfpos);
 385     }
 386     return null;
 387   }
 388
 389   /**
 390    * not for general use, creates a fileParse object for an existing reader with
 391    * configurable values for the origin and the type of the source
 392    */
 393   public FileParse(BufferedReader source, String originString,
 394           DataSourceType sourceType)
 395   {
 396     dataSourceType = sourceType;
 397     error = false;
 398     inFile = null;
 399     dataName = originString;
 400     dataIn = source;
 401     try
 402     {
 403       if (dataIn.markSupported())
 404       {
 405         dataIn.mark(READAHEAD_LIMIT);
 406       }
 407     } catch (IOException q)
 408     {
 409
 410     }
 411   }
 412
 413   /**
 414    * Create a datasource for input to Jalview. See AppletFormatAdapter for the
 415    * types of sources that are handled.
 416    *
 417    * @param file
 418    *          - datasource locator/content as File or String
 419    * @param sourceType
 420    *          - protocol of source
 421    * @throws MalformedURLException
 422    * @throws IOException
 423    */
 424   public FileParse(Object file, DataSourceType sourceType)
 425           throws MalformedURLException, IOException
 426   {
 427     if (file instanceof File)
 428     {
 429       parse((File) file, ((File) file).getPath(), sourceType, true);
 430     }
 431     else
 432     {
 433       parse(null, file.toString(), sourceType, false);
 434     }
 435   }
 436
 437   private void parse(File file, String fileStr, DataSourceType sourceType,
 438           boolean isFileObject) throws IOException
 439   {
 440     bytes = Platform.getFileBytes(file);
 441     dataSourceType = sourceType;
 442     error = false;
 443
 444     if (sourceType == DataSourceType.FILE)
 445     {
 446
 447       if (bytes != null)
 448       {
 449         // this will be from JavaScript
 450         inFile = file;
 451         dataIn = new BufferedReader(
 452                 new InputStreamReader(new ByteArrayInputStream(bytes)));
 453         dataName = fileStr;
 454       }
 455       else if (checkFileSource(fileStr))
 456       {
 457         String suffixLess = extractSuffix(fileStr);
 458         if (suffixLess != null)
 459         {
 460           if (checkFileSource(suffixLess))
 461           {
 462             throw new IOException(MessageManager.formatMessage(
 463                     "exception.problem_opening_file_also_tried",
 464                     new String[]
 465                     { inFile.getName(), suffixLess, errormessage }));
 466           }
 467         }
 468         else
 469         {
 470           throw new IOException(MessageManager.formatMessage(
 471                   "exception.problem_opening_file", new String[]
 472                   { inFile.getName(), errormessage }));
 473         }
 474       }
 475     }
 476     else if (sourceType == DataSourceType.RELATIVE_URL)
 477     {
 478       // BH 2018 hack for no support for access-origin
 479       bytes = Platform.getFileAsBytes(fileStr);
 480       dataIn = new BufferedReader(
 481               new InputStreamReader(new ByteArrayInputStream(bytes)));
 482       dataName = fileStr;
 483
 484     }
 485     else if (sourceType == DataSourceType.URL)
 486     {
 487       try
 488       {
 489         try
 490         {
 491           checkURLSource(fileStr);
 492           if (suffixSeparator == '#')
 493           {
 494             dataName = extractSuffix(fileStr); // URL lref is stored for later
 495                                                // reference.
 496           }
 497         } catch (IOException e)
 498         {
 499           String suffixLess = extractSuffix(fileStr);
 500           if (suffixLess == null)
 501           {
 502             throw (e);
 503           }
 504           else
 505           {
 506             try
 507             {
 508               checkURLSource(suffixLess);
 509             } catch (IOException e2)
 510             {
 511               errormessage = "BAD URL WITH OR WITHOUT SUFFIX";
 512               throw (e); // just pass back original - everything was wrong.
 513             }
 514           }
 515         }
 516       } catch (Exception e)
 517       {
 518         errormessage = "CANNOT ACCESS DATA AT URL '" + fileStr + "' ("
 519                 + e.getMessage() + ")";
 520         error = true;
 521       }
 522     }
 523     else if (sourceType == DataSourceType.PASTE)
 524     {
 525       errormessage = "PASTE INACCESSIBLE!";
 526       dataIn = new BufferedReader(new StringReader(fileStr));
 527       dataName = "Paste";
 528     }
 529     else if (sourceType == DataSourceType.CLASSLOADER)
 530     {
 531       errormessage = "RESOURCE CANNOT BE LOCATED";
 532       InputStream is = getClass().getResourceAsStream("/" + fileStr);
 533       if (is == null)
 534       {
 535         String suffixLess = extractSuffix(fileStr);
 536         if (suffixLess != null)
 537         {
 538           is = getClass().getResourceAsStream("/" + suffixLess);
 539         }
 540       }
 541       if (is != null)
 542       {
 543         dataIn = new BufferedReader(new InputStreamReader(is));
 544         dataName = fileStr;
 545       }
 546       else
 547       {
 548         error = true;
 549       }
 550     }
 551     else
 552     {
 553       errormessage = "PROBABLE IMPLEMENTATION ERROR : Datasource Type given as '"
 554               + (sourceType != null ? sourceType : "null") + "'";
 555       error = true;
 556     }
 557     if (dataIn == null || error)
 558     {
 559       // pass up the reason why we have no source to read from
 560       throw new IOException(MessageManager.formatMessage(
 561               "exception.failed_to_read_data_from_source", new String[]
 562               { errormessage }));
 563     }
 564     error = false;
 565     dataIn.mark(READAHEAD_LIMIT);
 566   }
 567
 568   /**
 569    * mark the current position in the source as start for the purposes of it
 570    * being analysed by IdentifyFile().identify
 571    *
 572    * @throws IOException
 573    */
 574   public void mark() throws IOException
 575   {
 576     if (dataIn != null)
 577     {
 578       dataIn.mark(READAHEAD_LIMIT);
 579     }
 580     else
 581     {
 582       throw new IOException(
 583               MessageManager.getString("exception.no_init_source_stream"));
 584     }
 585   }
 586
 587   public String nextLine() throws IOException
 588   {
 589     if (!error)
 590     {
 591       return dataIn.readLine();
 592     }
 593     throw new IOException(MessageManager
 594             .formatMessage("exception.invalid_source_stream", new String[]
 595             { errormessage }));
 596   }
 597
 598   /**
 599    *
 600    * @return true if this FileParse is configured for Export only
 601    */
 602   public boolean isExporting()
 603   {
 604     return !error && dataIn == null;
 605   }
 606
 607   /**
 608    *
 609    * @return true if the data source is valid
 610    */
 611   public boolean isValid()
 612   {
 613     return !error;
 614   }
 615
 616   /**
 617    * closes the datasource and tidies up. source will be left in an error state
 618    */
 619   public void close() throws IOException
 620   {
 621     errormessage = "EXCEPTION ON CLOSE";
 622     error = true;
 623     dataIn.close();
 624     dataIn = null;
 625     errormessage = "SOURCE IS CLOSED";
 626   }
 627
 628   /**
 629    * Rewinds the datasource to the marked point if possible
 630    *
 631    * @param bytesRead
 632    *
 633    */
 634   public void reset(int bytesRead) throws IOException
 635   {
 636     if (bytesRead >= READAHEAD_LIMIT)
 637     {
 638       System.err.println(String.format(
 639               "File reset error: read %d bytes but reset limit is %d",
 640               bytesRead, READAHEAD_LIMIT));
 641     }
 642     if (dataIn != null && !error)
 643     {
 644       dataIn.reset();
 645     }
 646     else
 647     {
 648       throw new IOException(MessageManager.getString(
 649               "error.implementation_error_reset_called_for_invalid_source"));
 650     }
 651   }
 652
 653   /**
 654    *
 655    * @return true if there is a warning for the user
 656    */
 657   public boolean hasWarningMessage()
 658   {
 659     return (warningMessage != null && warningMessage.length() > 0);
 660   }
 661
 662   /**
 663    *
 664    * @return empty string or warning message about file that was just parsed.
 665    */
 666   public String getWarningMessage()
 667   {
 668     return warningMessage;
 669   }
 670
 671   public String getInFile()
 672   {
 673     if (inFile != null)
 674     {
 675       return inFile.getAbsolutePath() + " (" + index + ")";
 676     }
 677     else
 678     {
 679       return "From Paste + (" + index + ")";
 680     }
 681   }
 682
 683   /**
 684    * @return the dataName
 685    */
 686   public String getDataName()
 687   {
 688     return dataName;
 689   }
 690
 691   /**
 692    * set the (human readable) name or URI for this datasource
 693    *
 694    * @param dataname
 695    */
 696   protected void setDataName(String dataname)
 697   {
 698     dataName = dataname;
 699   }
 700
 701   /**
 702    * get the underlying bufferedReader for this data source.
 703    *
 704    * @return null if no reader available
 705    * @throws IOException
 706    */
 707   public Reader getReader()
 708   {
 709     if (dataIn != null) // Probably don't need to test for readiness &&
 710                         // dataIn.ready())
 711     {
 712       return dataIn;
 713     }
 714     return null;
 715   }
 716
 717   public AlignViewportI getViewport()
 718   {
 719     return viewport;
 720   }
 721
 722   public void setViewport(AlignViewportI viewport)
 723   {
 724     this.viewport = viewport;
 725   }
 726
 727   /**
 728    * @return the currently configured exportSettings for writing data.
 729    */
 730   public AlignExportSettingsI getExportSettings()
 731   {
 732     return exportSettings;
 733   }
 734
 735   /**
 736    * Set configuration for export of data.
 737    *
 738    * @param exportSettings
 739    *          the exportSettings to set
 740    */
 741   public void setExportSettings(AlignExportSettingsI exportSettings)
 742   {
 743     this.exportSettings = exportSettings;
 744   }
 745
 746   /**
 747    * method overridden by complex file exporter/importers which support
 748    * exporting visualisation and layout settings for a view
 749    *
 750    * @param avpanel
 751    */
 752   public void configureForView(AlignmentViewPanel avpanel)
 753   {
 754     if (avpanel != null)
 755     {
 756       setViewport(avpanel.getAlignViewport());
 757     }
 758     // could also set export/import settings
 759   }
 760
 761   /**
 762    * Returns the preferred feature colour configuration if there is one, else
 763    * null
 764    *
 765    * @return
 766    */
 767   public FeatureSettingsModelI getFeatureColourScheme()
 768   {
 769     return null;
 770   }
 771
 772   public DataSourceType getDataSourceType()
 773   {
 774     return dataSourceType;
 775   }
 776
 777   /**
 778    * Returns a buffered reader for the input object. Returns null, or throws
 779    * IOException, on failure.
 780    *
 781    * @param file
 782    *          a File, or a String which is a name of a file
 783    * @param sourceType
 784    * @return
 785    * @throws IOException
 786    */
 787   public BufferedReader getBufferedReader(Object file,
 788           DataSourceType sourceType) throws IOException
 789   {
 790     BufferedReader in = null;
 791     byte[] bytes;
 792
 793     switch (sourceType)
 794     {
 795     case FILE:
 796       if (file instanceof String)
 797       {
 798         return new BufferedReader(new FileReader((String) file));
 799       }
 800       bytes = Platform.getFileBytes((File) file);
 801       if (bytes != null)
 802       {
 803         return new BufferedReader(
 804                 new InputStreamReader(new ByteArrayInputStream(bytes)));
 805       }
 806       return new BufferedReader(new FileReader((File) file));
 807     case URL:
 808       URL url = new URL(file.toString());
 809       in = new BufferedReader(new InputStreamReader(url.openStream()));
 810       break;
 811     case RELATIVE_URL: // JalviewJS only
 812       bytes = Platform.getFileAsBytes(file.toString());
 813       if (bytes != null)
 814       {
 815         in = new BufferedReader(
 816                 new InputStreamReader(new ByteArrayInputStream(bytes)));
 817       }
 818       break;
 819     case PASTE:
 820       in = new BufferedReader(new StringReader(file.toString()));
 821       break;
 822     case CLASSLOADER:
 823       InputStream is = getClass().getResourceAsStream("/" + file);
 824       if (is != null)
 825       {
 826         in = new BufferedReader(new InputStreamReader(is));
 827       }
 828       break;
 829     }
 830
 831     return in;
 832   }
 833 }