org.rhq.plugins.apache.augeas.AugeasConfigurationApache Maven / Gradle / Ivy
Show all versions of rhq-apache-plugin Show documentation
/*
* RHQ Management Platform
* Copyright (C) 2005-2009 Red Hat, Inc.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2, as
* published by the Free Software Foundation, and/or the GNU Lesser
* General Public License, version 2.1, also 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 General Public License and the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program;
* if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.rhq.plugins.apache.augeas;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.rhq.augeas.config.AugeasModuleConfig;
import org.rhq.augeas.util.Glob;
import org.rhq.core.domain.configuration.Configuration;
import org.rhq.plugins.apache.ApacheServerComponent;
import org.rhq.rhqtransform.AugeasRhqException;
import org.rhq.rhqtransform.impl.PluginDescriptorBasedAugeasConfiguration;
/**
* Represents the configuration of Augeas needed to parse Apache.
* In this class, we scan the supplied main configuration file for include directives
* (recursively) and thus make up the full list of files the concrete Apache configuration
* is comprised of.
*
* Also, in case the serverRoot is overriden in the configuration files from the default
* supplied in the configuration object in the constructor, it is updated accordingly.
*
* @author Filip Drabek
*/
public class AugeasConfigurationApache extends PluginDescriptorBasedAugeasConfiguration {
public static final String INCLUDE_DIRECTIVE = "Include";
private static final String INCLUDE_FILES_PATTERN = "^[\t ]*Include[\t ]+(.*)$";
private static final String SERVER_ROOT_PATTERN = "^[\t ]*ServerRoot[\t ]+[\"]?([^\"\n]*)[\"]?$";
private final Pattern includePattern = Pattern.compile(INCLUDE_FILES_PATTERN);
private final Pattern serverRootPattern = Pattern.compile(SERVER_ROOT_PATTERN);
private static final Log LOG = LogFactory.getLog(AugeasConfigurationApache.class);
private String serverRootPath;
private AugeasModuleConfig module;
private List allConfigFiles;
public String getServerRootPath() {
return serverRootPath;
}
public AugeasConfigurationApache(String path, Configuration configuration) throws AugeasRhqException {
super(path, configuration);
serverRootPath = configuration.getSimpleValue(ApacheServerComponent.PLUGIN_CONFIG_PROP_SERVER_ROOT, null);
if (modules.isEmpty())
throw new AugeasRhqException("There is not configuration for this resource.");
try {
module = modules.get(0);
List foundIncludes = new ArrayList();
loadIncludes(module.getIncludedGlobs().get(0), foundIncludes);
allConfigFiles = getIncludeFiles(serverRootPath, foundIncludes);
} catch (Exception e) {
throw new AugeasRhqException(e);
}
}
public String getAugeasModuleName() {
return module.getModuletName();
}
public List getIncludes(File file) {
List includeFiles = new ArrayList();
return includeFiles;
}
public List getAllConfigurationFiles() {
return allConfigFiles;
}
private void loadIncludes(String expression, List foundIncludes) {
try {
List files = new ArrayList();
File check = new File(expression);
File root = new File(check.isAbsolute() ? Glob.rootPortion(expression) : serverRootPath);
files.addAll(Glob.match(root, expression, Glob.ALPHABETICAL_COMPARATOR));
for (File fl : files) {
if (fl.exists() && fl.isFile()) {
foundIncludes.add(fl.getAbsolutePath());
BufferedReader br = null;
try {
br = new BufferedReader(new InputStreamReader(new FileInputStream(fl)));
String strLine;
while ((strLine = br.readLine()) != null) {
Matcher m = includePattern.matcher(strLine);
if (m.matches()) {
String glob = m.group(1);
module.addIncludedGlob(glob);
loadIncludes(glob, foundIncludes);
}
Matcher serverRootMatcher = serverRootPattern.matcher(strLine);
if (serverRootMatcher.matches()) {
serverRootPath = serverRootMatcher.group(1);
}
}
} finally {
if (br != null) {
br.close();
}
}
}
}
} catch (Exception e) {
throw new IllegalStateException(e);
}
}
public void loadFiles() {
for (AugeasModuleConfig module : modules) {
List includeGlobs = module.getIncludedGlobs();
if (includeGlobs.size() <= 0) {
throw new IllegalStateException("Expecting at least once inclusion pattern for configuration files.");
}
ArrayList files = new ArrayList();
for (String incl : includeGlobs) {
File check = new File(incl);
File root = new File(check.isAbsolute() ? Glob.rootPortion(incl) : serverRootPath);
files.addAll(Glob.match(root, incl, Glob.ALPHABETICAL_COMPARATOR));
}
if (module.getExcludedGlobs() != null) {
List excludeGlobs = module.getExcludedGlobs();
Glob.excludeAll(files, excludeGlobs);
}
for (File configFile : files) {
if (!configFile.isAbsolute()) {
LOG.warn("Configuration files inclusion patterns contain a non-absolute file: " + configFile);
continue;
}
if (!configFile.exists()) {
LOG.warn("Configuration files inclusion patterns refer to a non-existent file: " + configFile);
continue;
}
if (configFile.isDirectory()) {
LOG.warn("Configuration files inclusion patterns refer to a directory: " + configFile);
continue;
}
if (!module.getConfigFiles().contains(configFile.getAbsolutePath())) {
module.addConfigFile(configFile.getAbsolutePath());
}
}
}
}
private static List getIncludeFiles(String serverRoot, List foundIncludes) {
List ret = new ArrayList();
for (String path : foundIncludes) {
File check = new File(path);
File root = new File(check.isAbsolute() ? Glob.rootPortion(path) : serverRoot);
for (File f : Glob.match(root, path, Glob.ALPHABETICAL_COMPARATOR)) {
ret.add(f);
}
}
return ret;
}
}