XarFile.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.xar;

import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;

import org.apache.commons.compress.archivers.zip.ZipFile;
import org.xwiki.model.reference.LocalDocumentReference;

/**
 * @version $Id: 458af0038e6dfdd11f9db93589ca3c17c303f74c $
 * @since 5.4RC1
 */
public class XarFile implements Closeable
{
    private File file;

    private ZipFile zipFile;

    private XarPackage xarPackage;

    /**
     * @param file the XAR file
     * @throws XarException when failing parse the file (for example if it's not a valid XAR package)
     * @throws IOException when failing to read file
     */
    public XarFile(File file) throws XarException, IOException
    {
        this(file, (XarPackage) null);
    }

    /**
     * @param file the XAR file
     * @param pages the pages in the XAR package
     * @throws XarException when failing parse the file (for example if it's not a valid XAR package)
     * @throws IOException when failing to read file
     */
    public XarFile(File file, Collection<XarEntry> pages) throws XarException, IOException
    {
        this(file, pages != null ? new XarPackage(pages) : null);
    }

    /**
     * @param file the XAR file
     * @param xarPackage the descriptor of the XAR package
     * @throws XarException when failing parse the file (for example if it's not a valid XAR package)
     * @throws IOException when failing to read file
     */
    public XarFile(File file, XarPackage xarPackage) throws XarException, IOException
    {
        this.file = file;
        this.zipFile = new ZipFile(file);
        this.xarPackage = xarPackage != null ? xarPackage : new XarPackage(this.zipFile);
    }

    /**
     * @return the XAR file
     */
    public File getFile()
    {
        return this.file;
    }

    @Override
    public void close() throws IOException
    {
        this.zipFile.close();
    }

    /**
     * @param reference the reference of the page
     * @return an input stream to the page XML
     * @throws IOException when failing to open a stream to the page XML
     */
    public InputStream getInputStream(LocalDocumentReference reference) throws IOException
    {
        XarEntry entry = this.xarPackage.getEntry(reference);
        if (entry == null) {
            throw new IOException("Failed to find entry for referenc [" + reference + "]");
        }

        return this.zipFile.getInputStream(this.zipFile.getEntry(entry.getEntryName()));
    }

    /**
     * @return the entries in the XAR file
     */
    public Collection<XarEntry> getEntries()
    {
        return this.xarPackage.getEntries();
    }

    /**
     * @param reference the reference of the document
     * @return the XAR entry associated to a wiki document
     */
    public XarEntry getEntry(LocalDocumentReference reference)
    {
        return this.xarPackage.getEntry(reference);
    }

    @Override
    public String toString()
    {
        return this.file.toString();
    }
}