org.exist.util.FileInputSource Maven / Gradle / Ivy

Go to download
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.util;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.io.BufferedInputStream;
import java.io.InputStream;
import java.io.IOException;
import java.io.Reader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Optional;

public class FileInputSource extends EXistInputSource {
	private static final Logger LOG = LogManager.getLogger(FileInputSource.class);

	private Optional file = Optional.empty();
	private Optional inputStream = Optional.empty();
	
	/**
	 * Constructor which calls {@link #setFile(Path)}
	 * @param file
	 * The file passed to {@link #setFile(Path)}
	 */
	public FileInputSource(final Path file) {
		super();
		setFile(file);
	}
	
	/**
	 * If a file source has been set, the File
	 * object used for that is returned
	 *
	 * @return The Path object.
	 */
	public Path getFile() {
		return file.orElse(null);
	}
	
	/**
	 * This method sets the File object used to get
	 * the uncompressed stream of data
	 *
	 * @param file The Path object pointing to the file.
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	public void setFile(final Path file) {
		assertOpen();

		close();
		this.file = Optional.of(file);
		reOpen();

		// Remember: super.setSystemId must be used instead of local implementation
		super.setSystemId(this.file.map(f -> f.toUri().toASCIIString()).orElse(null));
	}
	
	/**
	 * This method was re-implemented to open a
	 * new InputStream each time it is called.
	 *
	 * @return If the file was set, and it could be opened, an InputStream object.
	 * null, otherwise.
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public InputStream getByteStream() {
		assertOpen();

        // close any open stream first
		close();

		if(file.isPresent()) {
			try {
				this.inputStream = Optional.of(new BufferedInputStream(Files.newInputStream(file.get())));
				reOpen();
				return inputStream.get();
			} catch(final IOException e) {
				LOG.error(e);
			}
		}

		return null;
	}

    /**
	 * This method now does nothing, so collateral
	 * effects from superclass with this one are avoided
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public void setByteStream(final InputStream is) {
		assertOpen();
		throw new IllegalStateException("FileInputSource is immutable");
	}
	
	/**
	 * This method now does nothing, so collateral
	 * effects from superclass with this one are avoided
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public void setCharacterStream(final Reader r) {
		assertOpen();
		throw new IllegalStateException("FileInputSource is immutable");
	}

	/**
	 * This method now does nothing, so collateral
	 * effects from superclass with this one are avoided
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public void setSystemId(final String systemId) {
		assertOpen();
		throw new IllegalStateException("FileInputSource is immutable");
	}

	/**
	 * @see EXistInputSource#getByteStreamLength()
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public long getByteStreamLength() {
		assertOpen();
		if(file.isPresent()) {
			try {
				return Files.size(file.get());
			} catch(final IOException e) {
				LOG.error(e);
			}
		}

		return -1;
	}

	/**
	 * @see EXistInputSource#getSymbolicPath()
	 *
	 * @throws IllegalStateException if the InputSource was previously closed
	 */
	@Override
	public String getSymbolicPath() {
		assertOpen();
		return file.map(Path::toAbsolutePath).map(Path::toString).orElse(null);
	}

	@Override
	public void close() {
		if(!isClosed()) {
			try {
				if (inputStream.isPresent()) {
					try {
						inputStream.get().close();
					} catch (final IOException e) {
						LOG.warn(e);
					}
					inputStream = Optional.empty();
				}
			} finally {
				super.close();
			}
		}
	}
}