/**
* DataCleaner (community edition)
* Copyright (C) 2014 Neopost - Customer Information Management
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program 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 distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.datacleaner.user;
import java.io.File;
import java.io.InputStream;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.apache.commons.vfs2.FileObject;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.metamodel.util.FileHelper;
import org.apache.metamodel.util.LazyRef;
import org.apache.metamodel.util.Ref;
import org.datacleaner.configuration.DataCleanerConfiguration;
import org.datacleaner.configuration.DataCleanerConfigurationImpl;
import org.datacleaner.configuration.JaxbConfigurationReader;
import org.datacleaner.extensions.ExtensionPackage;
import org.datacleaner.extensions.ExtensionReader;
import org.datacleaner.util.FileFilters;
import org.datacleaner.util.ResourceManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Reads {@link DataCleanerConfiguration} from conf.xml and decorates it with
* additional configuration from {@link UserPreferences}.
*/
public class DataCleanerConfigurationReader extends LazyRef<DataCleanerConfiguration> {
private static final Logger logger = LoggerFactory.getLogger(DataCleanerConfigurationReader.class);
private final FileObject _dataCleanerHome;
private final FileObject _configurationFile;
private final Ref<UserPreferences> _userPreferencesRef;
public DataCleanerConfigurationReader(final FileObject dataCleanerHome, final FileObject configurationFile,
final Ref<UserPreferences> userPreferencesRef) {
_dataCleanerHome = dataCleanerHome;
_configurationFile = configurationFile;
_userPreferencesRef = userPreferencesRef;
}
/**
* Gets the configuration file, if any. Note that in embedded mode or during
* tests etc. there might not be a configuration file, and this method may
* return null!
*
* @return
*/
public FileObject getConfigurationFile() {
return _configurationFile;
}
@Override
protected DataCleanerConfiguration fetch() {
// load user preferences first, since we need it while reading
// the configuration (some custom elements may refer to classes
// within the extensions)
final UserPreferences userPreferences = _userPreferencesRef.get();
loadExtensions(userPreferences);
// load the configuration file
final JaxbConfigurationReader configurationReader =
new JaxbConfigurationReader(new DesktopConfigurationReaderInterceptor(_dataCleanerHome));
boolean exists;
try {
exists = _configurationFile != null && _configurationFile.exists();
} catch (final FileSystemException e) {
logger.debug("Could not determine if configuration file exists");
exists = false;
}
final DataCleanerConfiguration c;
if (exists) {
InputStream inputStream = null;
try {
inputStream = _configurationFile.getContent().getInputStream();
c = configurationReader.create(inputStream);
logger.info("Succesfully read configuration from {}", _configurationFile.getName().getPath());
} catch (final Exception e) {
FileHelper.safeClose(inputStream);
try {
inputStream = _configurationFile.getContent().getInputStream();
final String content = FileHelper.readInputStreamAsString(inputStream, FileHelper.DEFAULT_ENCODING);
logger.error("Failed to read configuration file {}. File contents was:", _configurationFile);
logger.error(content);
} catch (final Throwable t) {
logger.debug("Failed to re-open configuration file to determine file contents", e);
}
if (e instanceof RuntimeException) {
throw (RuntimeException) e;
}
throw new IllegalStateException(
"Unexpected error while reading configuration file: " + _configurationFile, e);
} finally {
FileHelper.safeClose(inputStream);
}
} else {
logger.info("Configuration file does not exist, reading built-in configuration.");
c = getConfigurationFromClasspath(configurationReader);
}
return c;
}
private void loadExtensions(final UserPreferences userPreferences) {
final String dumpInstallKey = "org.datacleaner.extension.dumpinstall";
final File extensionsDirectory = userPreferences.getExtensionsDirectory();
final Set<String> extensionFilenames = new HashSet<>();
final List<ExtensionPackage> extensionPackages = userPreferences.getExtensionPackages();
for (final Iterator<ExtensionPackage> it = extensionPackages.iterator(); it.hasNext(); ) {
final ExtensionPackage extensionPackage = (ExtensionPackage) it.next();
// some extensions may be installed simply by "dumping" a JAR in the
// extension folder. Such installs will have this key registered.
final boolean dumpInstalled = "true".equals(extensionPackage.getAdditionalProperties().get(dumpInstallKey));
boolean remove = false;
final File[] files = extensionPackage.getFiles();
for (final File file : files) {
if (dumpInstalled && !file.exists()) {
// file has been removed, we'll remove this extension
remove = true;
break;
} else {
final File directory = file.getParentFile();
if (extensionsDirectory.equals(directory)) {
extensionFilenames.add(file.getName());
}
}
}
if (remove) {
it.remove();
} else {
extensionPackage.loadExtension();
}
}
// Read all JAR files in the 'extensions' directory and register those
// that are not already loaded.
final File[] jarFiles = extensionsDirectory.listFiles(FileFilters.JAR);
if (jarFiles != null) {
for (final File file : jarFiles) {
final String filename = file.getName();
if (!extensionFilenames.contains(filename)) {
logger.info("Adding extension from 'extension' folder: {}", file.getName());
final ExtensionReader reader = new ExtensionReader();
final ExtensionPackage extension = reader.readExternalExtension(file);
userPreferences.addExtensionPackage(extension);
extension.getAdditionalProperties().put(dumpInstallKey, "true");
extension.loadExtension();
}
}
}
// List directories and treat each sub directory with JAR files as
// an extension
final File[] subDirectories = extensionsDirectory.listFiles(File::isDirectory);
if (subDirectories != null) {
for (final File subDirectory : subDirectories) {
final String directoryName = subDirectory.getName();
if (!extensionFilenames.contains(directoryName)) {
logger.info("Adding extension from 'extension' folder: {}", directoryName);
final ExtensionReader reader = new ExtensionReader();
final ExtensionPackage extension = reader.readExternalExtension(subDirectory);
if (extension != null) {
userPreferences.addExtensionPackage(extension);
extension.getAdditionalProperties().put(dumpInstallKey, "true");
extension.loadExtension();
}
}
}
}
}
private DataCleanerConfiguration getConfigurationFromClasspath(final JaxbConfigurationReader configurationReader) {
logger.info("Reading conf.xml from classpath");
try {
return configurationReader.create(ResourceManager.get().getUrl("datacleaner-home/conf.xml").openStream());
} catch (final Exception e) {
logger.warn("Unexpected error while reading conf.xml from classpath!", e);
logger.warn("Creating a bare-minimum configuration because of previous errors!");
return new DataCleanerConfigurationImpl();
}
}
}