123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296 |
- /*
- * Copyright (c) 2006-2015 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc.commandparser;
-
- import com.dmdirc.GlobalWindow;
- import com.dmdirc.commandparser.commands.Command;
- import com.dmdirc.commandparser.parsers.CommandParser;
- import com.dmdirc.config.ConfigBinding;
- import com.dmdirc.interfaces.CommandController;
- import com.dmdirc.interfaces.Connection;
- import com.dmdirc.interfaces.ConnectionManager;
- import com.dmdirc.interfaces.GroupChat;
- import com.dmdirc.interfaces.PrivateChat;
- import com.dmdirc.interfaces.config.AggregateConfigProvider;
- import com.dmdirc.ui.input.TabCompleter;
- import com.dmdirc.ui.input.TabCompletionType;
-
- import com.google.common.collect.ArrayListMultimap;
- import com.google.common.collect.Multimap;
-
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import java.util.stream.Collectors;
-
- import javax.inject.Provider;
-
- /**
- * The command manager creates and manages a single instance of all commands, and provides methods
- * to load each group of commands into a parser instance.
- */
- public class CommandManager implements CommandController {
-
- /** A list of commands that have been instantiated. */
- private final Map<CommandInfo, Command> commands = new HashMap<>();
- /** A list of command parsers that have been instantiated. */
- private final Multimap<CommandType, CommandParser> parsers = ArrayListMultimap.create();
- /** The manager to use to iterate servers. */
- private final ConnectionManager connectionManager;
- /** Provider to use to retrieve the global window. */
- private final Provider<GlobalWindow> globalWindowProvider;
- /** The command char we're using. */
- @ConfigBinding(domain = "general", key = "commandchar")
- private char commandChar;
- /** The silence char we're using. */
- @ConfigBinding(domain = "general", key = "silencechar")
- private char silenceChar;
-
- /**
- * Creates a new instance of the Command Manager.
- *
- * @param connectionManager the manager to use to iterate servers.
- * @param globalWindowProvider provider to use to retrieve the global window.
- */
- public CommandManager(final ConnectionManager connectionManager,
- final Provider<GlobalWindow> globalWindowProvider) {
- this.connectionManager = connectionManager;
- this.globalWindowProvider = globalWindowProvider;
- }
-
- @Override
- public char getCommandChar() {
- return commandChar;
- }
-
- @Override
- public char getSilenceChar() {
- return silenceChar;
- }
-
- /**
- * Initialises the command manager.
- *
- * @param configManager The configuration manager to read settings from.
- */
- public void initialise(final AggregateConfigProvider configManager) {
- configManager.getBinder().bind(this, CommandManager.class);
- }
-
- @Override
- public void registerCommand(final Command command, final CommandInfo info) {
- registerCommand(info, command, true);
- }
-
- @Override
- public void unregisterCommand(final CommandInfo info) {
- registerCommand(info, commands.get(info), false);
- }
-
- /**
- * Registers or unregisters a command.
- *
- * @param info The information about the command
- * @param command The command to be (un)registered
- * @param register True if the command should be registered, false if it should be unregistered.
- *
- * @since 0.6.3m1
- */
- private void registerCommand(final CommandInfo info, final Command command,
- final boolean register) {
- if (parsers.containsKey(info.getType())) {
- registerCommand(info, command, parsers.get(info.getType()), register);
- }
-
- if (register) {
- commands.put(info, command);
- } else {
- commands.remove(info);
- }
-
- registerCommandName(info, register);
- }
-
- /**
- * Registers or unregisters the specified command with all of the specified parsers.
- *
- * @param info The command information object
- * @param command The command to be registered
- * @param myParsers The parsers to register the command with
- * @param register Whether to register or unregister the commands
- *
- * @since 0.6.3m1
- */
- private void registerCommand(final CommandInfo info, final Command command,
- final Iterable<? extends CommandParser> myParsers, final boolean register) {
- for (CommandParser parser : myParsers) {
- if (register) {
- parser.registerCommand(command, info);
- } else {
- parser.unregisterCommand(info);
- }
- }
- }
-
- /**
- * Registers or unregisters the specified command's name with the relevant tab completers.
- *
- * @param command The command to be registered
- * @param register True if the command should be registered, false if it should be unregistered.
- *
- * @since 0.6.3m1
- */
- private void registerCommandName(final CommandInfo command,
- final boolean register) {
- // Do tab completion
- final String plainCommandName = getCommandChar() + command.getName();
- final String silencedCommandName = getCommandChar() + getSilenceChar() + command.getName();
-
- if (command.getType() == CommandType.TYPE_GLOBAL) {
- registerCommandName(globalWindowProvider.get().getInputModel().get().getTabCompleter(),
- plainCommandName, register);
- registerCommandName(globalWindowProvider.get().getInputModel().get().getTabCompleter(),
- silencedCommandName, register);
- }
-
- // TODO: This logic is probably in two places. Abstract it.
- for (Connection server : connectionManager.getConnections()) {
- if (command.getType() == CommandType.TYPE_SERVER
- || command.getType() == CommandType.TYPE_GLOBAL) {
- registerCommandName(server.getWindowModel().getInputModel().get().getTabCompleter(),
- plainCommandName, register);
- registerCommandName(server.getWindowModel().getInputModel().get().getTabCompleter(),
- silencedCommandName, register);
- }
-
- if (command.getType() == CommandType.TYPE_CHANNEL
- || command.getType() == CommandType.TYPE_CHAT) {
- for (GroupChat channel : server.getGroupChatManager().getChannels()) {
- registerCommandName(
- channel.getWindowModel().getInputModel().get().getTabCompleter(),
- plainCommandName, register);
- registerCommandName(
- channel.getWindowModel().getInputModel().get().getTabCompleter(),
- silencedCommandName, register);
- }
- }
-
- if (command.getType() == CommandType.TYPE_QUERY
- || command.getType() == CommandType.TYPE_CHAT) {
- for (PrivateChat query : server.getQueries()) {
- registerCommandName(
- query.getWindowModel().getInputModel().get().getTabCompleter(),
- plainCommandName, register);
- registerCommandName(
- query.getWindowModel().getInputModel().get().getTabCompleter(),
- silencedCommandName, register);
- }
- }
- }
- }
-
- /**
- * Registers or unregisters the specified command with the specified tab- completer.
- *
- * @param completer The tab completer to be used
- * @param name The command name to be registered
- * @param register True if the command should be registered, false if it should be
- * unregistered.
- */
- private void registerCommandName(final TabCompleter completer,
- final String name, final boolean register) {
- if (register) {
- completer.addEntry(TabCompletionType.COMMAND, name);
- } else {
- completer.removeEntry(TabCompletionType.COMMAND, name);
- }
- }
-
- @Override
- public void loadCommands(final CommandParser parser,
- final CommandType... supertypes) {
- for (CommandType supertype : supertypes) {
- for (CommandType type : supertype.getComponentTypes()) {
- for (Map.Entry<CommandInfo, Command> pair : getCommands(type, null).entrySet()) {
- parser.registerCommand(pair.getValue(), pair.getKey());
- }
-
- parsers.put(type, parser);
- }
- }
- }
-
- @Override
- public Map.Entry<CommandInfo, Command> getCommand(final String name) {
- return getCommand(null, name);
- }
-
- @Override
- public Map.Entry<CommandInfo, Command> getCommand(final CommandType type,
- final String name) {
- final Map<CommandInfo, Command> res = getCommands(type, name);
-
- return res.isEmpty() ? null : res.entrySet().iterator().next();
- }
-
- @Override
- public boolean isChannelCommand(final String command) {
- return getCommand(CommandType.TYPE_CHANNEL, command) != null
- || getCommand(CommandType.TYPE_CHAT, command) != null;
- }
-
- @Override
- public List<String> getCommandNames(final CommandType type) {
- return getCommands(type).keySet().stream()
- .map(command -> getCommandChar() + command.getName())
- .collect(Collectors.toList());
- }
-
- @Override
- public Map<CommandInfo, Command> getCommands(final CommandType type) {
- return getCommands(type, null);
- }
-
- /**
- * Retrieves a map of all commands of the specified type, with the specified name.
- *
- * @param type The type of command to list, or null for all types
- * @param name The name of the command to look for, or null for any name
- *
- * @return A map of {@link CommandInfo}s and their associated {@link Command}.
- *
- * @since 0.6.3m1
- */
- private Map<CommandInfo, Command> getCommands(final CommandType type,
- final String name) {
- final Map<CommandInfo, Command> res = new HashMap<>();
-
- commands.entrySet().stream()
- .filter(entry -> (type == null || type == entry.getKey().getType()) &&
- (name == null || name.equals(entry.getKey().getName())))
- .forEach(entry -> res.put(entry.getKey(), entry.getValue()));
-
- return res;
- }
-
- }
|