Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.karaf.features.internal.service.FeatureConfigInstaller Maven / Gradle / Ivy
/*
* 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.karaf.features.internal.service;
import java.io.*;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.*;
import java.util.regex.Pattern;
import org.apache.felix.cm.json.Configurations;
import org.apache.felix.utils.properties.InterpolationHelper;
import org.apache.felix.utils.properties.TypedProperties;
import org.apache.karaf.features.ConfigFileInfo;
import org.apache.karaf.features.ConfigInfo;
import org.apache.karaf.features.Feature;
import org.apache.karaf.util.StreamUtils;
import org.osgi.framework.Constants;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class FeatureConfigInstaller {
private static final Logger LOGGER = LoggerFactory.getLogger(FeaturesServiceImpl.class);
private static final String CONFIG_KEY = "org.apache.karaf.features.configKey";
private static final String FILEINSTALL_FILE_NAME = "felix.fileinstall.filename";
private static final Pattern JSON_PATTERN = Pattern.compile("\\s*\\{[\\s\\S]*");
private final ConfigurationAdmin configAdmin;
private File storage;
private boolean configCfgStore;
public FeatureConfigInstaller(ConfigurationAdmin configAdmin) {
this.configAdmin = configAdmin;
this.storage = new File(System.getProperty("karaf.etc"));
this.configCfgStore = FeaturesServiceImpl.DEFAULT_CONFIG_CFG_STORE;
}
public FeatureConfigInstaller(ConfigurationAdmin configAdmin, boolean configCfgStore) {
this.configAdmin = configAdmin;
this.storage = new File(System.getProperty("karaf.etc"));
this.configCfgStore = configCfgStore;
}
private ConfigId parsePid(final String pid) {
final ConfigId cid = new ConfigId();
cid.pid = pid;
final int n = pid.contains("~") ? pid.indexOf('~') : pid.indexOf('-');
if (n > 0) {
cid.isFactoryPid = true;
cid.factoryPid = pid.substring(0, n);
if (pid.contains("~")) {
cid.name = pid.substring(n + 1);
}
}
return cid;
}
private Configuration createConfiguration(ConfigurationAdmin configurationAdmin, ConfigId cid)
throws IOException, InvalidSyntaxException {
if (cid.isFactoryPid) {
if (Objects.nonNull(cid.name)) {
return configurationAdmin.getFactoryConfiguration(cid.factoryPid, cid.name, null);
} else {
return configurationAdmin.createFactoryConfiguration(cid.factoryPid, null);
}
} else {
return configurationAdmin.getConfiguration(cid.pid, null);
}
}
private Configuration findExistingConfiguration(ConfigurationAdmin configurationAdmin, ConfigId cid)
throws IOException, InvalidSyntaxException {
String filter;
if (!cid.isFactoryPid) {
filter = "(" + Constants.SERVICE_PID + "=" + cid.pid + ")";
} else {
filter = "(" + CONFIG_KEY + "=" + cid.pid + ")";
}
Configuration[] configurations = configurationAdmin.listConfigurations(filter);
return (configurations != null && configurations.length > 0) ? configurations[0] : null;
}
public void installFeatureConfigs(Feature feature) throws IOException, InvalidSyntaxException {
for (ConfigInfo config : feature.getConfigurations()) {
String configValue = config.getValue();
TypedProperties properties = new TypedProperties();
boolean jsonFormat = false;
if (config.isExternal()) {
// the configuration is actually located on the URL contained in the config value
try {
configValue = loadConfiguration(new URL(configValue));
} catch (MalformedURLException e) {
throw new IOException("Failed to load configuration from URL " + configValue + " for feature " + feature.getName() + "/" + feature.getVersion(), e);
}
}
if (JSON_PATTERN.matcher(configValue).matches()) {
// json format
properties = convertToTypedProperties(Configurations.buildReader().build(new StringReader(configValue)).readConfiguration());
jsonFormat = true;
} else {
// properties format
properties.load(new StringReader(configValue));
}
ConfigId cid = parsePid(config.getName());
Configuration cfg = findExistingConfiguration(configAdmin, cid);
if (cfg == null || config.isOverride()) {
File cfgFile = null;
if (storage != null) {
if (jsonFormat) {
cfgFile = new File(storage, cid.pid + ".json");
} else {
cfgFile = new File(storage, cid.pid + ".cfg");
}
}
if (!cfgFile.exists() || config.isOverride()) {
Dictionary cfgProps = convertToDict(properties);
cfg = createConfiguration(configAdmin, cid);
cfgProps.put(CONFIG_KEY, cid.pid);
properties.put(CONFIG_KEY, cid.pid);
if (storage != null && configCfgStore) {
cfgProps.put(FILEINSTALL_FILE_NAME, cfgFile.getAbsoluteFile().toURI().toString());
}
cfg.update(cfgProps);
try {
updateStorage(cid, properties, false, jsonFormat);
} catch (Exception e) {
LOGGER.warn("Can't update cfg file", e);
}
} else {
LOGGER.info("Skipping configuration {} - file already exists", cfgFile);
}
} else if (config.isAppend()) {
boolean update = false;
Dictionary p = cfg.getProcessedProperties(null);
for (String key : properties.keySet()) {
if (p.get(key) == null) {
p.put(key, properties.get(key));
update = true;
}
}
if (update) {
cfg.update(p);
try {
updateStorage(cid, properties, true, jsonFormat);
} catch (Exception e) {
LOGGER.warn("Can't update cfg file", e);
}
}
}
}
for (ConfigFileInfo configFile : feature.getConfigurationFiles()) {
installConfigurationFile(configFile.getLocation(), configFile.getFinalname(),
configFile.isOverride());
}
}
private String loadConfiguration(final URL url) throws IOException {
try (final InputStream inputStream = new BufferedInputStream(url.openStream())) {
final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
StreamUtils.copy(inputStream, outputStream);
return new String(outputStream.toByteArray(), StandardCharsets.UTF_8);
}
}
public void uninstallFeatureConfigs(Feature feature) throws IOException, InvalidSyntaxException {
if (feature != null) {
if (feature.getConfigurations() != null) {
for (ConfigInfo configInfo : feature.getConfigurations()) {
ConfigId configId = parsePid(configInfo.getName());
Configuration configuration = findExistingConfiguration(configAdmin, configId);
if (configuration != null) {
configuration.delete();
}
File cfgFile = null;
if (storage != null) {
cfgFile = new File(storage, configId.pid + ".cfg");
}
if (cfgFile.exists()) {
cfgFile.delete();
}
}
}
if (feature.getConfigurationFiles() != null) {
for (ConfigFileInfo configFileInfo : feature.getConfigurationFiles()) {
String finalname = substFinalName(configFileInfo.getFinalname());
File cfgFile = new File(finalname);
if (cfgFile.exists()) {
cfgFile.delete();
}
}
}
}
}
private Dictionary convertToDict(Map props) {
Dictionary cfgProps = new Hashtable<>();
for (Map.Entry e : props.entrySet()) {
cfgProps.put(e.getKey(), e.getValue());
}
return cfgProps;
}
private TypedProperties convertToTypedProperties(Dictionary dict) {
TypedProperties typedProperties = new TypedProperties();
Enumeration keys = dict.keys();
while (keys.hasMoreElements()) {
String key = keys.nextElement();
typedProperties.put(key, dict.get(key));
}
return typedProperties;
}
/**
* Substitute variables in the final name and append prefix if necessary.
*
*
* If the final name does not start with '${' it is prefixed with
* karaf.base (+ file separator).
* It substitute also all variables (scheme ${...}) with the respective
* configuration values and system properties.
* All unknown variables kept unchanged.
* If the substituted string starts with an variable that could not be
* substituted, it will be prefixed with karaf.base (+ file separator), too.
*
*
*
* @param finalname
* The final name that should be processed.
* @return the location in the file system that should be accesses.
*/
protected static String substFinalName(String finalname) {
final String markerVarBeg = "${";
final String markerVarEnd = "}";
boolean startsWithVariable = finalname.startsWith(markerVarBeg) && finalname.contains(markerVarEnd);
// Substitute all variables, but keep unknown ones.
final String dummyKey = "";
try {
finalname = InterpolationHelper.substVars(finalname, dummyKey, null, null, null, true, true,
false);
} catch (final IllegalArgumentException ex) {
LOGGER.info("Substitution failed. Skip substitution of variables of configuration final name ({}).",
finalname);
}
// Prefix with karaf base if the initial final name does not start with
// a variable or the first variable was not substituted.
if (!startsWithVariable || finalname.startsWith(markerVarBeg)) {
final String basePath = System.getProperty("karaf.base");
finalname = basePath + File.separator + finalname;
}
// Remove all unknown variables.
while (finalname.contains(markerVarBeg) && finalname.contains(markerVarEnd)) {
int beg = finalname.indexOf(markerVarBeg);
int end = finalname.indexOf(markerVarEnd);
final String rem = finalname.substring(beg, end + markerVarEnd.length());
finalname = finalname.replace(rem, "");
}
return finalname;
}
private void installConfigurationFile(String fileLocation, String finalname, boolean override)
throws IOException {
finalname = substFinalName(finalname);
File file = new File(finalname);
if (file.exists()) {
if (!override) {
LOGGER.debug("Configuration file {} already exist, don't override it", finalname);
return;
} else {
LOGGER.info("Configuration file {} already exist, overriding it", finalname);
}
} else {
LOGGER.info("Creating configuration file {}", finalname);
}
// TODO: use download manager to download the configuration
try (
InputStream is = new BufferedInputStream(new URL(fileLocation).openStream())
) {
if (!file.exists()) {
File parentFile = file.getParentFile();
if (parentFile != null) {
parentFile.mkdirs();
}
file.createNewFile();
}
try (
FileOutputStream fop = new FileOutputStream(file)
) {
StreamUtils.copy(is, fop);
}
} catch (RuntimeException | MalformedURLException e) {
LOGGER.error(e.getMessage());
throw e;
}
}
protected void updateStorage(ConfigId cid, TypedProperties props, boolean append, boolean jsonFormat)
throws Exception {
if (storage != null && configCfgStore) {
File cfgFile = getConfigFile(cid, jsonFormat);
if (!cfgFile.exists()) {
if (jsonFormat) {
Configurations.buildWriter().build(new FileWriter(cfgFile)).writeConfiguration(convertToDict(props));
} else {
props.save(cfgFile);
}
} else {
updateExistingConfig(props, append, cfgFile, jsonFormat);
}
}
}
private File getConfigFile(ConfigId cid, boolean jsonFormat) throws IOException, InvalidSyntaxException {
Configuration cfg = findExistingConfiguration(configAdmin, cid);
// update the cfg file depending of the configuration
File cfgFile;
if (jsonFormat) {
cfgFile = new File(storage, cid.pid + ".json");
} else {
cfgFile = new File(storage, cid.pid + ".cfg");
}
if (cfg != null && cfg.getProcessedProperties(null) != null) {
Object val = cfg.getProcessedProperties(null).get(FILEINSTALL_FILE_NAME);
try {
if (val instanceof URL) {
cfgFile = new File(((URL)val).toURI());
}
if (val instanceof URI) {
cfgFile = new File((URI)val);
}
if (val instanceof String) {
cfgFile = new File(new URL((String)val).toURI());
}
} catch (Exception e) {
throw new IOException(e.getMessage(), e);
}
}
LOGGER.trace("Update {}", cfgFile.getName());
return cfgFile;
}
private void updateExistingConfig(TypedProperties props, boolean append, File cfgFile, boolean jsonFormat) throws IOException {
TypedProperties properties = new TypedProperties();
if (jsonFormat) {
properties = convertToTypedProperties(Configurations.buildReader().build(new FileReader(cfgFile)).readConfiguration());
} else {
properties.load(cfgFile);
}
for (String key : props.keySet()) {
if (!isInternalKey(key)) {
List comments = props.getComments(key);
Object value = props.get(key);
if (!properties.containsKey(key)) {
properties.put(key, comments, value);
} else if (!append) {
if (comments.isEmpty()) {
comments = properties.getComments(key);
}
properties.put(key, comments, value);
}
}
}
if (!append) {
// remove "removed" properties from the cfg file
ArrayList propertiesToRemove = new ArrayList<>();
for (String key : properties.keySet()) {
if (!props.containsKey(key) && !isInternalKey(key)) {
propertiesToRemove.add(key);
}
}
for (String key : propertiesToRemove) {
properties.remove(key);
}
}
storage.mkdirs();
if (jsonFormat) {
Configurations.buildWriter().build(new FileWriter(cfgFile)).writeConfiguration(new Hashtable(properties));
} else {
properties.save(cfgFile);
}
}
private boolean isInternalKey(String key) {
return Constants.SERVICE_PID.equals(key)
|| ConfigurationAdmin.SERVICE_FACTORYPID.equals(key)
|| FILEINSTALL_FILE_NAME.equals(key);
}
private static final class ConfigId {
boolean isFactoryPid;
String pid;
String factoryPid;
String name;
}
}
