DMDirc-Client/src/com/dmdirc/commandparser/PopupManager.java

/*
 * 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.DMDircMBassador;
import com.dmdirc.events.ClientPopupGeneratedEvent;
import com.dmdirc.interfaces.CommandController;
import com.dmdirc.interfaces.config.AggregateConfigProvider;

import javax.inject.Inject;

/**
 * The popup manager manages which commands should be present in popup menus.
 */
public class PopupManager {

    /** The command controller to use for items. */
    private final CommandController commandController;
    /** The bus to dispatch events on. */
    private final DMDircMBassador eventBus;

    /**
     * Creates a new instance of PopupManager.
     *
     * @param commandController The controller to use for commands.
     * @param eventBus          The bus to dispatch events on.
     */
    @Inject
    public PopupManager(final CommandController commandController, final DMDircMBassador eventBus) {
        this.commandController = commandController;
        this.eventBus = eventBus;
    }

    /**
     * Returns the popup menu that should be used for the specified type. Configuration data is read
     * from the specified config manager.
     *
     * @param menuType      The type of the menu that is needed
     * @param configManager The config manager to be used for the menu
     *
     * @return The PopupMenu that should be displayed
     */
    public PopupMenu getMenu(final PopupType menuType, final AggregateConfigProvider configManager) {
        final PopupMenu menu = getMenu(menuType.toString(), menuType, configManager);

        eventBus.publishAsync(new ClientPopupGeneratedEvent(menuType, menu, configManager));

        return menu;
    }

    /**
     * Retrieves the menu with the specified name.
     *
     * @param menuName      The name of the menu to read
     * @param type          The type of the menu that is needed
     * @param configManager The config manager to be used for the menu
     *
     * @return The PopupMenu with the specified name
     */
    private PopupMenu getMenu(final String menuName,
            final PopupType type, final AggregateConfigProvider configManager) {
        final PopupMenu res = new PopupMenu();

        for (String item : configManager.getOptionList("popups", menuName)) {
            if (!item.isEmpty() && item.charAt(0) == '<') {
                res.addAll(getMenu(item.substring(1), type, configManager).getItems());
            } else {
                res.add(getItem(item, type, configManager));
            }
        }

        return res;
    }

    /**
     * Creates a PopupMenuItem for the specified item.
     *
     * @param item          The item to be turned into a PopupMenuItem
     * @param type          The type of popup item to create
     * @param configManager The config manager to be used for the menu
     *
     * @return The corresponding PopupMenuItem
     */
    private PopupMenuItem getItem(final String item,
            final PopupType type, final AggregateConfigProvider configManager) {
        final PopupMenuItem res;

        if ("-".equals(item)) {
            res = new PopupMenuItem(commandController);
        } else {
            final int colon = item.indexOf(':');

            if (colon == -1) {
                throw new IllegalArgumentException("Invalid popup menu item: "
                        + item);
            }

            final String name = item.substring(0, colon);
            final String command = item.substring(colon + 1);

            if (!command.isEmpty() && command.charAt(0) == '<') {
                res = new PopupMenuItem(commandController,
                        name, getMenu(command.substring(1),
                                type, configManager));
            } else {
                res = new PopupMenuItem(commandController,
                        name, type.getArity(), command);
            }
        }

        return res;
    }

}