/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.sling.installer.provider.file.impl;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigInteger;
import java.security.MessageDigest;
import java.util.ArrayList;
import java.util.Dictionary;
import java.util.List;
import java.util.Map;
import org.apache.felix.cm.file.ConfigurationHandler;
import org.apache.sling.installer.api.InstallableResource;
import org.apache.sling.installer.api.OsgiInstaller;
import org.apache.sling.installer.api.UpdateHandler;
import org.apache.sling.installer.api.UpdateResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The <code>FileInstaller</code> manages the file installers and
* handles updates.
*
*/
public class FileInstaller
implements UpdateHandler {
/** The scheme we use to register our resources. */
public static final String SCHEME_PREFIX = "fileinstall";
/** Logger. */
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/** All active scan configurations. */
private final List<ScanConfiguration> scanConfigurations = new ArrayList<ScanConfiguration>();
/** All monitors. */
private final List<FileMonitor> monitors = new ArrayList<FileMonitor>();
private final boolean writeBack;
public FileInstaller(final List<ScanConfiguration> configs, final boolean writeBack) {
this.writeBack = writeBack;
if ( configs != null ) {
scanConfigurations.addAll(configs);
}
}
public boolean hasConfigurations() {
return !this.scanConfigurations.isEmpty();
}
public void start(final OsgiInstaller installer) {
for(final ScanConfiguration config : this.scanConfigurations) {
logger.debug("Starting monitor for {}", config.directory);
this.monitors.add(new FileMonitor(new File(config.directory),
config.scanInterval, new Installer(installer, hash(config.directory))));
}
}
public void stop() {
for(final FileMonitor monitor : this.monitors) {
monitor.stop();
}
this.monitors.clear();
}
public String[] getSchemes() {
final String[] schemes = new String[this.monitors.size()];
int index = 0;
for(final FileMonitor m : this.monitors) {
schemes[index] = m.getListener().getScheme();
index++;
}
return schemes;
}
/**
* @see org.apache.sling.installer.api.UpdateHandler#handleRemoval(java.lang.String, java.lang.String, java.lang.String)
*/
public UpdateResult handleRemoval(final String resourceType,
final String id,
final String url) {
if ( !this.writeBack ) {
return null;
}
final int pos = url.indexOf(':');
final String path = url.substring(pos + 1);
// remove
logger.debug("Removal of {}", path);
final File file = new File(path);
if ( file.exists() ) {
file.delete();
}
return new UpdateResult(url);
}
/**
* @see org.apache.sling.installer.api.UpdateHandler#handleUpdate(java.lang.String, java.lang.String, java.lang.String, java.util.Dictionary, Map)
*/
public UpdateResult handleUpdate(final String resourceType,
final String id,
final String url,
final Dictionary<String, Object> dict,
final Map<String, Object> attributes) {
return this.handleUpdate(resourceType, id, url, null, dict, attributes);
}
/**
* @see org.apache.sling.installer.api.UpdateHandler#handleUpdate(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream, Map)
*/
public UpdateResult handleUpdate(final String resourceType,
final String id,
final String url,
final InputStream is,
final Map<String, Object> attributes) {
return this.handleUpdate(resourceType, id, url, is, null, attributes);
}
/**
* Internal implementation of update handling
*/
private UpdateResult handleUpdate(final String resourceType,
final String id,
final String url,
final InputStream is,
final Dictionary<String, Object> dict,
final Map<String, Object> attributes) {
if ( !this.writeBack ) {
return null;
}
// we only handle add/update of configs for now
if ( !resourceType.equals(InstallableResource.TYPE_CONFIG) ) {
return null;
}
try {
final String path;
final String prefix;
if ( url != null ) {
// update
final int pos = url.indexOf(':');
final String oldPath = url.substring(pos + 1);
prefix = url.substring(0, pos);
// ensure extension 'config'
if ( !oldPath.endsWith(".config") ) {
final File file = new File(oldPath);
if ( file.exists() ) {
file.delete();
}
final int lastDot = oldPath.lastIndexOf('.');
final int lastSlash = oldPath.lastIndexOf('/');
if ( lastDot <= lastSlash ) {
path = oldPath + ".config";
} else {
path = oldPath.substring(0, lastDot) + ".config";
}
} else {
path = oldPath;
}
logger.debug("Update of {} at {}", resourceType, path);
} else {
// add
final FileMonitor first = this.monitors.get(0);
path = first.getRoot().getAbsolutePath() + '/' + id + ".config";
prefix = first.getListener().getScheme();
logger.debug("Add of {} at {}", resourceType, path);
}
final File file = new File(path);
file.getParentFile().mkdirs();
final FileOutputStream fos = new FileOutputStream(file);
try {
fos.write("# Configuration created by Apache Sling File Installer\n".getBytes("UTF-8"));
ConfigurationHandler.write(fos, dict);
} finally {
try {
fos.close();
} catch (final IOException ignore) {}
}
final UpdateResult result = new UpdateResult(prefix + ':' + path);
result.setResourceIsMoved(true);
return result;
} catch (final IOException e) {
logger.error("Unable to add/update resource " + resourceType + ':' + id, e);
return null;
}
}
/**
* Hash the string
*/
private static String hash(String value) {
try {
final MessageDigest d = MessageDigest.getInstance("MD5");
d.update(value.getBytes("UTF-8"));
final BigInteger bigInt = new BigInteger(1, d.digest());
return new String(bigInt.toString(16));
} catch (Exception ignore) {
// if anything goes wrong we just return the value
return value;
}
}
}