com.adobe.epubcheck.bitmap.BitmapChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of epubcheck Show documentation
EPUBCheck is a tool to validate the conformance of EPUB publications against the EPUB specifications. EPUBCheck can be run as a standalone command-line tool or used as a Java library.
The newest version!
/*
 * Copyright (c) 2007 Adobe Systems Incorporated
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package com.adobe.epubcheck.bitmap;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Iterator;

import javax.imageio.ImageIO;
import javax.imageio.ImageReader;
import javax.imageio.stream.FileImageInputStream;
import javax.imageio.stream.ImageInputStream;

import com.adobe.epubcheck.api.EPUBLocation;
import com.adobe.epubcheck.messages.MessageId;
import com.adobe.epubcheck.ocf.OCFContainer;
import com.adobe.epubcheck.opf.PublicationResourceChecker;
import com.adobe.epubcheck.opf.ValidationContext;
import com.adobe.epubcheck.util.CheckUtil;

import io.mola.galimatias.URL;

public class BitmapChecker extends PublicationResourceChecker
{
  private static final int HEIGHT_MAX = 2 * 1080;
  private static final int WIDTH_MAX = 2 * 1920;
  private static final long IMAGESIZE_MAX = 4 * 1024 * 1024;

  public BitmapChecker(ValidationContext context)
  {
    super(context);
  }

  private void checkHeader(byte[] header)
  {
    String mimeType = context.mimeType;
    boolean passed;
    if (mimeType.equals("image/jpeg"))
    {
      passed = header[0] == (byte) 0xFF && header[1] == (byte) 0xD8;
    }
    else if (mimeType.equals("image/gif"))
    {
      passed = header[0] == (byte) 'G' && header[1] == (byte) 'I'
          && header[2] == (byte) 'F' && header[3] == (byte) '8';
    }
    else
    {
      passed = !mimeType.equals("image/png") || header[0] == (byte) 0x89 && header[1] == (byte) 'P' && header[2] == (byte) 'N' && header[3] == (byte) 'G';
    }
    if (!passed)
    {
      report.message(MessageId.OPF_029, EPUBLocation.of(context), context.path, mimeType);
    }
  }


  /**
   * Gets image dimensions for given file
   *
   * @return dimensions of image
   * @throws IOException if the file is not a known image
   */
  private ImageHeuristics getImageSizes() throws
      IOException
  {
    OCFContainer container = context.container.get();
    URL imgURL = context.url;
    //FIXME 2022 move extension extraction to URL utils
    int pos = imgURL.path().lastIndexOf(".");
    if (pos == -1)
    {
      throw new IOException("No extension for file: " + imgURL);
    }

    String suffix = imgURL.path().substring(pos + 1);
    File tempFile = null;
    if ("svg".compareToIgnoreCase(suffix) == 0)
    {
      tempFile = getImageFile(container, imgURL);
      if (tempFile != null)
      {
        long tempFileLength = tempFile.length();
        // FIXME 2022 check if file need to be deleted for expanded containers
        tempFile.delete();
        return new ImageHeuristics(0, 0, tempFileLength);
      }
      return null;
    }
    
    // Determine format by file extension and by inspecting the file
    tempFile = getImageFile(container, imgURL);
    String formatFromInputStream = null;
    String formatFromSuffix = null;
    ImageReader reader = null;
    ImageInputStream imageInputStream = ImageIO.createImageInputStream(tempFile);
    Iterator imageReaderIteratorFromInputStream = ImageIO.getImageReaders(imageInputStream);
    while (imageReaderIteratorFromInputStream.hasNext()) {
      ImageReader imageReaderFromInputStream = imageReaderIteratorFromInputStream.next();
      formatFromInputStream = imageReaderFromInputStream.getFormatName();
        
      Iterator imageReaderIteratorFromSuffix = ImageIO.getImageReadersBySuffix(suffix);
        while (imageReaderIteratorFromSuffix.hasNext()) {
          reader = imageReaderIteratorFromSuffix.next();
          formatFromSuffix = reader.getFormatName();
          
          if (formatFromSuffix != null && formatFromSuffix.equals(formatFromInputStream)) break;
        }
        if (formatFromSuffix != null && formatFromSuffix.equals(formatFromInputStream)) break;
    }
    imageInputStream.close();



    if (formatFromSuffix != null && formatFromSuffix.equals(formatFromInputStream)) {
      // file format and file extension matches; read image file

      try (ImageInputStream stream = new FileImageInputStream(tempFile)) {
        reader.setInput(stream);
        int width = reader.getWidth(reader.getMinIndex());
        int height = reader.getHeight(reader.getMinIndex());
        return new ImageHeuristics(width, height, tempFile.length());
      }
      catch (IOException e)
      {
        report.message(MessageId.PKG_021, EPUBLocation.of(context));
        return null;
      }
      catch (RuntimeException argex)
      {
        report.message(MessageId.PKG_021, EPUBLocation.of(context));
        return null;
      }
      finally
      {
         tempFile.delete();
      }
  
    } else
      {
          tempFile.delete();
          if (formatFromSuffix != null) {
              // file format and file extension differs

              report.message(MessageId.PKG_022, EPUBLocation.of(context), formatFromInputStream, suffix);
              return null;

          } else {
              // file format could not be determined

              throw new IOException("Not a known image file: " + imgURL);
          }
      }
  }

  private static File getImageFile(OCFContainer container, URL imageURL) throws IOException
  {
    return getTempImageFile(container, imageURL);
  }

  public class ImageHeuristics
  {
    public int width;
    public int height;
    public long length;

    public ImageHeuristics(int width, int height, long length)
    {
      this.width = width;
      this.height = height;
      this.length = length;
    }
  }

  private static File getTempImageFile(OCFContainer container, URL imageURL) throws IOException
  {
    // FIXME 2022 better implement file copy
    File file = null;
    FileOutputStream os = null;
    InputStream is = null;
    try
    {
      int pos = imageURL.path().lastIndexOf(".");
      if (pos == -1)
      {
        throw new IOException("No extension for file: " + imageURL);
      }
      String suffix = imageURL.path().substring(pos);
      String prefix = "img";

      file = File.createTempFile(prefix, suffix);
      os = new FileOutputStream(file);

      is = container.openStream(imageURL);
      if (is == null)
      {
        return null;
      }
      byte[] bytes = new byte[32 * 1024];
      int read;
      while ((read = is.read(bytes)) > 0)
      {
        os.write(bytes, 0, read);
      }
    }
    finally
    {
      if (os != null)
      {
        os.flush();
        os.close();
      }
      if (is != null)
      {
        is.close();
      }
    }
    return file;  //To change body of created methods use File | Settings | File Templates.
  }

  private void checkImageDimensions()
  {
    try
    {
      ImageHeuristics h = getImageSizes();
      if (h != null)
      {
        if (h.height >= HEIGHT_MAX || h.width >= WIDTH_MAX)
        {
          report.message(MessageId.OPF_051, EPUBLocation.of(context));
        }
        if (h.length >= IMAGESIZE_MAX)
        {
          report.message(MessageId.OPF_057, EPUBLocation.of(context));
        }
      }
    }
    catch (IOException ex)
    {
      report.message(MessageId.PKG_021, EPUBLocation.of(context) );
    } catch (LinkageError error)
    {
      report.message(MessageId.RSC_022, EPUBLocation.of(context));
    }
  }

  @Override
  protected boolean checkContent()
  {
    try (InputStream in = context.resourceProvider.openStream(context.url))
    {
      if (in == null)
      {
        report.message(MessageId.RSC_001, EPUBLocation.of(context));
        return false;
      }
      byte[] header = new byte[4];
      int rd = CheckUtil.readBytes(in, header, 0, 4);
      if (rd < 4)
      {
        report.message(MessageId.MED_004, EPUBLocation.of(context));
      }
      else
      {
        checkHeader(header);
      }
      checkImageDimensions();
      return true;
    }
    catch (IOException e)
    {
      report.message(MessageId.PKG_021, EPUBLocation.of(context));
      return false;
    }
   }
}