Mercurial > hg > release > thermostat-0.6
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/PluginCommandInfoSource.java @ 996:a5e29a0c324e
Handle plugin.xml file specifying invalid jars
Reviewed-by: neugens
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-February/005804.html
author | Omair Majid <omajid@redhat.com> |
---|---|
date | Mon, 25 Feb 2013 13:17:04 -0500 |
parents | e7411f4afdf1 |
children |
line wrap: on
line source
/* * Copyright 2013 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat 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 2, or (at your * option) any later version. * * Thermostat 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 Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.launcher.internal; import java.io.File; import java.io.FileNotFoundException; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.logging.Level; import java.util.logging.Logger; import com.redhat.thermostat.common.cli.CommandInfo; import com.redhat.thermostat.common.cli.CommandInfoNotFoundException; import com.redhat.thermostat.common.cli.CommandInfoSource; import com.redhat.thermostat.common.utils.LoggingUtils; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandExtensions; import com.redhat.thermostat.launcher.internal.PluginConfiguration.NewCommand; /** * Searches for plugins under <code>$THERMOSTAT_HOME/plugins/</code> and * provides information about all commands specified by them. * <p> * Each plugin is located under * <code>$THERMOSTAT_HOME/plugins/$PLUGIN_NAME/</code> and must have a * <code>plugin.xml</code> file in the main plugin directory. * * @see PluginConfigurationParser how the plugin.xml file is parsed */ public class PluginCommandInfoSource implements CommandInfoSource { private static final String PLUGIN_CONFIG_FILE = "plugin.xml"; private static final Logger logger = LoggingUtils.getLogger(PluginCommandInfoSource.class); private Map<String, BasicCommandInfo> allNewCommands = new HashMap<>(); private Map<String, List<String>> additionalBundlesForExistingCommands = new HashMap<>(); public PluginCommandInfoSource(String internalJarRoot, String pluginRootDir) { this(new File(internalJarRoot), new File(pluginRootDir), new PluginConfigurationParser()); } PluginCommandInfoSource(File internalJarRoot, File pluginRootDir, PluginConfigurationParser parser) { File[] pluginDirs = pluginRootDir.listFiles(); if (pluginDirs == null) { logger.log(Level.SEVERE, "plugin root dir " + pluginRootDir + " does not exist"); return; } for (File pluginDir : pluginDirs) { try { File configurationFile = new File(pluginDir, PLUGIN_CONFIG_FILE); PluginConfiguration pluginConfig = parser.parse(configurationFile); loadNewAndExtendedCommands(internalJarRoot, pluginDir, pluginConfig); } catch (PluginConfigurationParseException | FileNotFoundException exception) { logger.log(Level.WARNING, "unable to parse plugin configuration", exception); } } combineCommands(); } private void loadNewAndExtendedCommands(File coreJarRoot, File pluginDir, PluginConfiguration pluginConfig) { for (CommandExtensions extension : pluginConfig.getExtendedCommands()) { String commandName = extension.getCommandName(); List<String> pluginBundles = extension.getPluginBundles(); List<String> dependencyBundles = extension.getDepenedencyBundles(); logger.config("plugin at " + pluginDir + " contributes " + pluginBundles.size() + " bundles to comamnd '" + commandName + "'"); List<String> bundlePaths = additionalBundlesForExistingCommands.get(commandName); if (bundlePaths == null) { bundlePaths = new LinkedList<>(); } addIfValidPath(bundlePaths, pluginDir, pluginBundles); addIfValidPath(bundlePaths, coreJarRoot, dependencyBundles); additionalBundlesForExistingCommands.put(commandName, bundlePaths); } for (NewCommand command : pluginConfig.getNewCommands()) { String commandName = command.getCommandName(); logger.config("plugin at " + pluginDir + " contributes new command '" + commandName + "'"); if (allNewCommands.containsKey(commandName)) { throw new IllegalStateException("multiple plugins are providing the command " + commandName); } List<String> bundlePaths = new LinkedList<>(); addIfValidPath(bundlePaths, pluginDir, command.getPluginBundles()); addIfValidPath(bundlePaths, coreJarRoot, command.getDepenedencyBundles()); BasicCommandInfo info = new BasicCommandInfo(commandName, command.getDescription(), command.getUsage(), command.getOptions(), bundlePaths); allNewCommands.put(commandName, info); } } private void addIfValidPath(List<String> result, File parentDir, List<String> pathsRelativeToParent) { for (String bundle : pathsRelativeToParent) { File bundleFile = new File(parentDir, bundle); if (bundleFile.isFile()) { result.add(bundleFile.toURI().toString()); } else { logger.warning("File " + bundleFile.toString() + " not found. Removing it from list of bundles to load."); } } } private void combineCommands() { Iterator<Entry<String, List<String>>> iter = additionalBundlesForExistingCommands.entrySet().iterator(); while (iter.hasNext()) { Map.Entry<String, List<String>> entry = iter.next(); if (allNewCommands.containsKey(entry.getKey())) { BasicCommandInfo old = allNewCommands.get(entry.getKey()); List<String> updatedResources = new ArrayList<>(); updatedResources.addAll(old.getDependencyResourceNames()); updatedResources.addAll(entry.getValue()); BasicCommandInfo updated = new BasicCommandInfo(old.getName(), old.getDescription(), old.getUsage(), old.getOptions(), updatedResources); allNewCommands.put(entry.getKey(), updated); iter.remove(); } } } @Override public CommandInfo getCommandInfo(String name) throws CommandInfoNotFoundException { if (allNewCommands.containsKey(name)) { return allNewCommands.get(name); } List<String> bundles = additionalBundlesForExistingCommands.get(name); if (bundles != null) { return new BasicCommandInfo(name, null, null, null, bundles); } throw new CommandInfoNotFoundException(name); } @Override public Collection<CommandInfo> getCommandInfos() { List<CommandInfo> result = new ArrayList<>(); result.addAll(allNewCommands.values()); for (Entry<String, List<String>> entry : additionalBundlesForExistingCommands.entrySet()) { result.add(new BasicCommandInfo(entry.getKey(), null, null, null, entry.getValue())); } return result; } }