cloud.piranha.resource.impl.JarResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of piranha-resource-impl Show documentation
The newest version!
/*
 * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *   3. Neither the name of the copyright holder nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package cloud.piranha.resource.impl;

import cloud.piranha.resource.api.Resource;
import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import static java.lang.System.Logger.Level.WARNING;
import java.net.URL;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.stream.Stream;
import java.util.zip.ZipEntry;

/**
 * The default JarResource.
 *
 * @author Manfred Riem ([email protected])
 */
public class JarResource implements Resource {

    /**
     * Stores the logger.
     */
    private static final System.Logger LOGGER = System.getLogger(JarResource.class.getName());

    /**
     * Stores the JAR file.
     */
    private File jarFile;

    /**
     * Constructor.
     */
    public JarResource() {
    }

    /**
     * Constructor.
     *
     * @param jarFile the JAR file.
     */
    public JarResource(File jarFile) {
        this.jarFile = jarFile;
    }

    /**
     * {@return the resource}
     */
    @Override
    public URL getResource(String location) {
        URL result = null;
        if (location != null) {
            try {
                try ( JarFile jar = new JarFile(jarFile)) {
                    if (jar.getJarEntry(location) != null) {
                        result = new URL("jar:" + jarFile.toURI() + "!/" + location);
                    }
                }
            } catch (IOException ioe) {
                LOGGER.log(WARNING, "I/O error occurred while getting JAR resource", ioe);
                result = null;
            }
        }
        return result;
    }

    /**
     * Get the resource as a stream.
     *
     * 
     * Note that this method will read the content of a JAR entry into a
     * byte-array to avoid locking the JAR file.
     * 
     *
     * @param location the resource location.
     * @return the input stream, or null if not found.
     * @see Resource#getResourceAsStream(java.lang.String)
     */
    @Override
    public InputStream getResourceAsStream(String location) {
        InputStream result = null;
        try ( JarFile jar = new JarFile(jarFile)) {
            JarEntry entry = jar.getJarEntry(location.startsWith("/") ? location.substring(1) : location);
            if (entry != null) {
                InputStream inputStream;
                try ( InputStream jarInputStream = jar.getInputStream(entry)) {
                    inputStream = new BufferedInputStream(jarInputStream);
                    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
                    inputStream.transferTo(outputStream);
                    result = new ByteArrayInputStream(outputStream.toByteArray());
                }
                inputStream.close();
            }
        } catch (IOException ioe) {
            LOGGER.log(WARNING, "I/O error occurred while getting JAR resource", ioe);
        }
        return result;
    }

    @Override
    public Stream getAllLocations() {
        List entryNames;
        try ( JarFile jar = new JarFile(jarFile)) {
            entryNames = jar
                    .stream()
                    .map(ZipEntry::getName)
                    .map(x -> "/" + x)
                    .toList();
        } catch (IOException e) {
            return Stream.of();
        }
        return entryNames.stream();
    }

    /**
     * {@return the JAR file}
     */
    public File getJarFile() {
        return this.jarFile;
    }

    /**
     * Set the JAR file.
     *
     * @param jarFile the JAR file.
     */
    public void setJarFile(File jarFile) {
        this.jarFile = jarFile;
    }

    @Override
    public String getName() {
        return jarFile.getName();
    }

    @Override
    public String toString() {
        return getName() + " " + super.toString();
    }
}