nom.tam.fits.compress.CompressionManager Maven / Gradle / Ivy

Go to download
package nom.tam.fits.compress;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ServiceLoader;
import java.util.logging.Level;
import java.util.logging.Logger;

import nom.tam.fits.FitsException;

/*
 * #%L
 * nom.tam FITS library
 * %%
 * Copyright (C) 1996 - 2024 nom-tam-fits
 * %%
 * This is free and unencumbered software released into the public domain.
 *
 * Anyone is free to copy, modify, publish, use, compile, sell, or
 * distribute this software, either in source code form or as a compiled
 * binary, for any purpose, commercial or non-commercial, and by any
 * means.
 *
 * In jurisdictions that recognize copyright laws, the author or authors
 * of this software dedicate any and all copyright interest in the
 * software to the public domain. We make this dedication for the benefit
 * of the public at large and to the detriment of our heirs and
 * successors. We intend this dedication to be an overt act of
 * relinquishment in perpetuity of all present and future rights to this
 * software under copyright law.
 *
 * 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 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.
 * #L%
 */

import static nom.tam.util.LoggerHelper.getLogger;

/**
 * (for internal use) Decompression of compressed FITS files of all supported types (.gz,
 * .Z, .bz2). It autodetects the type of compression used based on the first 2-bytes of the
 * compressed input stream. When possible, preference will be given to perform the decompression using a system command
 * (uncompress or bzip2, which are likely faster for large files). If such a tool is not
 * available, then the Apache common-compress classes will be used to the same effect.
 * 
 * @see GZipCompressionProvider
 * @see BZip2CompressionProvider
 * @see ZCompressionProvider
 */
public final class CompressionManager {

    private static final String BZIP2_EXTENTION = ".bz2";

    private static final String COMPRESS_EXTENTION = ".Z";

    private static final String GZIP_EXTENTION = ".gz";

    /** bytes in a megabyte (MB) */
    public static final int ONE_MEGABYTE = 1024 * 1024;

    /**
     * logger to log to.
     */
    private static final Logger LOG = getLogger(CompressionManager.class);

    private CompressionManager() {
    }

    /**
     * This method decompresses a compressed input stream. The decompression method is selected automatically based upon
     * the first two bytes read.
     *
     * @param  compressed    The compressed input stream
     *
     * @return               A stream which wraps the input stream and decompresses it. If the input stream is not
     *                           compressed, a pushback input stream wrapping the original stream is returned.
     *
     * @throws FitsException when the stream could not be read or decompressed
     */
    public static InputStream decompress(InputStream compressed) throws FitsException {
        BufferedInputStream pb = new BufferedInputStream(compressed, ONE_MEGABYTE);
        pb.mark(2);
        int mag1 = -1;
        int mag2 = -1;

        try {
            mag1 = pb.read();
            mag2 = pb.read();
            // Push the data back into the stream
            pb.reset();
            ICompressProvider selectedProvider = selectCompressionProvider(mag1, mag2);
            if (selectedProvider != null) {
                return selectedProvider.decompress(pb);
            }
            return pb;
        } catch (IOException e) {
            // This is probably a prelude to failure...
            throw new FitsException("Unable to analyze input stream", e);
        }
    }

    /**
     * Is a file compressed? (the magic number in the first 2 bytes is used to detect the compression.
     *
     * @param  file file to test for compression algorithms
     *
     * @return      true if the file is compressed
     */
    public static boolean isCompressed(File file) {
        if (!file.exists()) {
            return false;
        }

        try (InputStream fis = new FileInputStream(file)) {
            int mag1 = fis.read();
            int mag2 = fis.read();
            fis.close();
            return selectCompressionProvider(mag1, mag2) != null;
        } catch (IOException e) {
            LOG.log(Level.FINEST, "Error while checking if file " + file + " is compressed", e);
        }
        return false;
    }

    /**
     * 
     * Checks if a file is compressed. If the file by the name exists, it will check the magic number in the first
     * 2-bytes to see if they matched those of the supported compression algorithms. Otherwise it checks if the file
     * extension atches one of the standard extensions for supported compressed files (.gz,
     * .Z, or .bz2).
     * 
     * 
     * As of 1.18, all file extension are checked in a case insensitive manner
     * 
     * 
     * @param  filename of the file to test for compression algorithms
     *
     * @return          true if the file is compressed
     */
    public static boolean isCompressed(String filename) {
        if (filename == null) {
            return false;
        }
        File test = new File(filename);
        if (test.exists()) {
            return isCompressed(test);
        }

        int iExt = filename.lastIndexOf('.');
        if (iExt < 0) {
            return false;
        }

        String ext = filename.substring(iExt);
        return ext.equalsIgnoreCase(GZIP_EXTENTION) || ext.equalsIgnoreCase(COMPRESS_EXTENTION)
                || ext.equalsIgnoreCase(BZIP2_EXTENTION);
    }

    private static ICompressProvider selectCompressionProvider(int mag1, int mag2) {
        return nextCompressionProvider(mag1, mag2, null);
    }

    /**
     * Returned the next highest priority decompression class, after the one we don't want, for the given type of
     * compressed file.
     * 
     * @param  mag1 the first magic byte at the head of the compressed file
     * @param  mag2 the second magic byte at the head of the compressed file
     * @param  old  the last decompression class we tried for this type of file
     * 
     * @return      the next lower priority decompression class we might use.
     */
    protected static ICompressProvider nextCompressionProvider(int mag1, int mag2, ICompressProvider old) {
        ICompressProvider selectedProvider = null;
        int priority = 0;
        int maxPriority = Integer.MAX_VALUE;
        if (old != null) {
            maxPriority = old.priority();
        }
        ServiceLoader compressionProviders = ServiceLoader.load(ICompressProvider.class,
                Thread.currentThread().getContextClassLoader());

        for (ICompressProvider provider : compressionProviders) {
            if (provider.priority() > Math.max(0, priority) && provider.priority() < maxPriority && provider != old && //
                    provider.provides(mag1, mag2)) {
                priority = provider.priority();
                selectedProvider = provider;
            }
        }
        return selectedProvider;
    }
}