DMDirc-Client/src/com/dmdirc/commandparser/commands/channel/SetNickColour.java

/*
 * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * 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.commands.channel;

import java.awt.Color;
import java.util.Map;
import com.dmdirc.Channel;
import com.dmdirc.ChannelClientProperty;
import com.dmdirc.Config;
import com.dmdirc.Server;
import com.dmdirc.commandparser.ChannelCommand;
import com.dmdirc.commandparser.CommandManager;
import com.dmdirc.commandparser.CommandWindow;
import com.dmdirc.parser.ChannelClientInfo;
import com.dmdirc.parser.ChannelInfo;
import com.dmdirc.ui.ChannelFrame;
import com.dmdirc.ui.messages.ColourManager;

/**
 * Allows the user to set a nickname on the channel to use a custom colour.
 * @author chris
 */
public final class SetNickColour extends ChannelCommand {
    
    /** Creates a new instance of SetNickColour. */
    public SetNickColour() {
        super();
        
        CommandManager.registerCommand(this);
    }
    
    /**
     * Executes this command.
     * @param origin The frame in which this command was issued
     * @param server The server object that this command is associated with
     * @param channel The channel object that this command is associated with
     * @param isSilent Whetehr this command is silenced or not
     * @param args The user supplied arguments
     */
    @SuppressWarnings("unchecked")
    public void execute(final CommandWindow origin, final Server server,
            final Channel channel, final boolean isSilent, final String... args) {
        
        int offset = 0;
        boolean nicklist = true;
        boolean text = true;
        
        if (args.length > offset && args[offset].equalsIgnoreCase("--nicklist")) {
            text = false;
            offset++;
        } else if (args.length > offset && args[offset].equalsIgnoreCase("--text")) {
            nicklist = false;
            offset++;
        }
        
        if (args.length <= offset) {
            origin.addLine("commandUsage", Config.getCommandChar(),
                    "setnickcolour", "[--nicklist|--text] <nick> [colour]");
            return;
        }
        
        final ChannelClientInfo target = channel.getChannelInfo().getUser(args[offset]);
        offset++;
        
        if (target == null) {
            origin.addLine("commandError", "No such nickname!");
        } else if (args.length <= offset) {
            // We're removing the colour
            if (nicklist) {
                target.getMap().remove(ChannelClientProperty.NICKLIST_FOREGROUND);
            }
            if (text) {
                target.getMap().remove(ChannelClientProperty.TEXT_FOREGROUND);
            }
            ((ChannelFrame) channel.getFrame()).getNickList().repaint();
        } else {
            // We're setting the colour
            final Color newColour = ColourManager.parseColour(args[offset], null);
            if (newColour == null) {
                origin.addLine("commandError", "Invalid colour specified.");
                return;
            }
            if (nicklist) {
                target.getMap().put(ChannelClientProperty.NICKLIST_FOREGROUND, newColour);
            }
            if (text) {
                target.getMap().put(ChannelClientProperty.TEXT_FOREGROUND, newColour);
            }
            ((ChannelFrame) channel.getFrame()).getNickList().repaint();
        }
    }
    
    /** {@inheritDoc}. */
    public String getName() {
        return "setnickcolour";
    }
    
    /** {@inheritDoc}. */
    public boolean showInHelp() {
        return true;
    }
    
    /** {@inheritDoc}. */
    public boolean isPolyadic() {
        return true;
    }
    
    /** {@inheritDoc}. */
    public int getArity() {
        return 0;
    }
    
    /** {@inheritDoc}. */
    public String getHelp() {
        return "setnickcolour [--nicklist|--text] <nick> [colour] - set the specified person's display colour";
    }
    
}