org.mycore.common.config.MCRConfigurationInputStream Maven / Gradle / Ivy
/*
* This file is part of *** M y C o R e ***
* See http://www.mycore.de/ for details.
*
* MyCoRe is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* MyCoRe 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MyCoRe. If not, see
* - mycore-base
* - other mycore-components
* - application modules
* - installation specific files
*
*
* @author Thomas Scheffler (yagee)
* @author Robert Stephan
* @since 2013.12
*/
public class MCRConfigurationInputStream extends InputStream {
private static final String MYCORE_PROPERTIES = "mycore.properties";
// latin1 for properties
private static final byte[] LINE_BREAK = System.getProperty("line.separator").getBytes(StandardCharsets.ISO_8859_1);
InputStream in;
private Enumeration e;
private boolean empty;
/**
* Combined Stream of all config files named filename available via
* {@link MCRRuntimeComponentDetector#getAllComponents()}.
*
* @param filename
* , e.g. mycore.properties or messages_de.properties
*/
public MCRConfigurationInputStream(String filename) throws IOException {
this(filename, null);
}
private MCRConfigurationInputStream(String filename, InputStream initStream) throws IOException {
super();
this.empty = true;
this.e = getPropertyInputStreams(filename, initStream);
if (e.hasMoreElements()) {
nextStream();
}
}
/**
* {@link InputStream} that includes all properties from {@link MCRRuntimeComponentDetector#getAllComponents()} and
* mycore.properties. Use system property MCR.Configuration.File to configure
* alternative property file.
*
* @since 2014.04
*/
public static MCRConfigurationInputStream getMyCoRePropertiesInstance() throws IOException {
File configurationDirectory = MCRConfigurationDir.getConfigurationDirectory();
InputStream initStream = null;
if (configurationDirectory != null) {
LogManager.getLogger().info("Current configuration directory: {}",
configurationDirectory.getAbsolutePath());
// set MCR.basedir, is normally overwritten later
if (configurationDirectory.isDirectory()) {
initStream = getBaseDirInputStream(configurationDirectory);
}
}
return new MCRConfigurationInputStream(MYCORE_PROPERTIES, initStream);
}
public boolean isEmpty() {
return empty;
}
private Enumeration getPropertyInputStreams(String filename, InputStream initStream)
throws IOException {
LinkedList cList = new LinkedList<>();
if (initStream != null) {
empty = false;
cList.add(initStream);
}
for (MCRComponent component : MCRRuntimeComponentDetector.getAllComponents()) {
InputStream is = component.getConfigFileStream(filename);
if (is != null) {
empty = false;
String comment = "\n\n#\n#\n# Component: " + component.getName() + "\n#\n#\n";
cList.add(new ByteArrayInputStream(comment.getBytes(StandardCharsets.ISO_8859_1)));
cList.add(is);
//workaround if last property is not terminated with line break
cList.add(new ByteArrayInputStream(LINE_BREAK));
} else {
cList.add(new ByteArrayInputStream(
("# Unable to find " + filename + " in " + component.getResourceBase() + "\n")
.getBytes(StandardCharsets.ISO_8859_1)));
}
}
InputStream propertyStream = getConfigFileStream(filename);
if (propertyStream != null) {
empty = false;
cList.add(propertyStream);
cList.add(new ByteArrayInputStream(LINE_BREAK));
}
File localProperties = MCRConfigurationDir.getConfigFile(filename);
if (localProperties != null && localProperties.canRead()) {
empty = false;
LogManager.getLogger().info("Loading additional properties from {}", localProperties.getAbsolutePath());
cList.add(new FileInputStream(localProperties));
cList.add(new ByteArrayInputStream(LINE_BREAK));
}
return Collections.enumeration(cList);
}
private static ByteArrayInputStream getBaseDirInputStream(File configurationDirectory) throws IOException {
Properties dataProp = new Properties();
//On Windows we require forward slashes
dataProp.setProperty("MCR.basedir", configurationDirectory.getAbsolutePath().replace('\\', '/'));
ByteArrayOutputStream out = new ByteArrayOutputStream(1024);
dataProp.store(out, null);
return new ByteArrayInputStream(out.toByteArray());
}
private static InputStream getConfigFileStream(String filename) throws IOException {
File cfgFile = new File(filename);
MCRContent input = null;
if (cfgFile.canRead()) {
input = new MCRFileContent(cfgFile);
} else {
URL url = MCRConfigurationInputStream.class.getClassLoader().getResource(filename);
if (url != null) {
input = new MCRURLContent(url);
}
}
return input == null ? null : input.getInputStream();
}
/**
* return an enumeration of input streams of configuration files
* found in MyCoRe components and modules, respecting the proper loading order
*/
public static List getConfigFileContents(String filename) throws IOException {
ArrayList cList = new ArrayList<>();
for (MCRComponent component : MCRRuntimeComponentDetector.getAllComponents()) {
try (InputStream is = component.getConfigFileStream(filename)) {
if (is != null) {
cList.add(IOUtils.toByteArray(is));
}
}
}
// load config file from classpath
try (InputStream configStream = getConfigFileStream(filename)) {
if (configStream != null) {
LogManager.getLogger().debug("Loaded config file from classpath: " + filename);
cList.add(IOUtils.toByteArray(configStream));
}
}
//load config file from app config dir
File localConfigFile = MCRConfigurationDir.getConfigFile(filename);
if (localConfigFile != null && localConfigFile.canRead()) {
LogManager.getLogger().debug("Loaded config file from config dir: " + filename);
try (FileInputStream fis = new FileInputStream(localConfigFile)) {
cList.add(IOUtils.toByteArray(fis));
}
}
return cList;
}
/**
* Continues reading in the next stream if an EOF is reached.
*/
final void nextStream() throws IOException {
if (in != null) {
in.close();
}
if (e.hasMoreElements()) {
in = e.nextElement();
if (in == null) {
throw new NullPointerException();
}
} else {
in = null;
}
}
@Override
public int available() throws IOException {
if (in == null) {
return 0; // no way to signal EOF from available()
}
return in.available();
}
@Override
public int read() throws IOException {
if (in == null) {
return -1;
}
int c = in.read();
if (c == -1) {
nextStream();
return read();
}
return c;
}
@Override
public int read(byte[] b, int off, int len) throws IOException {
if (in == null) {
return -1;
}
int n = in.read(b, off, len);
if (n <= 0) {
nextStream();
return read(b, off, len);
}
return n;
}
@Override
public void close() throws IOException {
do {
nextStream();
} while (in != null);
}
}