DMDirc-Client/src/com/dmdirc/commandparser/commands/chat/Me.java

/*
 * Copyright (c) 2006-2010 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.chat;

import com.dmdirc.FrameContainer;
import com.dmdirc.MessageTarget;
import com.dmdirc.commandparser.CommandArguments;
import com.dmdirc.commandparser.CommandInfo;
import com.dmdirc.commandparser.CommandType;
import com.dmdirc.commandparser.commands.Command;
import com.dmdirc.commandparser.commands.ValidatingCommand;
import com.dmdirc.commandparser.commands.context.ChatCommandContext;
import com.dmdirc.commandparser.commands.context.CommandContext;
import com.dmdirc.util.validators.ValidationResponse;
import com.dmdirc.ui.interfaces.InputWindow;

/**
 * The me command sends a CTCP action to the current channel.
 * @author chris
 */
public final class Me extends Command implements ValidatingCommand, CommandInfo {

    /** Creates a new instance of Me. */
    public Me() {
        super();
    }

    /** {@inheritDoc} */
    @Override
    public void execute(final FrameContainer<?> origin,
            final CommandArguments args, final CommandContext context) {
        final MessageTarget<?> target = ((ChatCommandContext) context).getChat();
        if (args.getArguments().length == 0) {
            showUsage(origin, args.isSilent(), "me", "<action>");
        } else {
            target.sendAction(args.getArgumentsAsString());
        }
    }

    /** {@inheritDoc} */
    @Override
    public String getName() {
        return "me";
    }

    /** {@inheritDoc} */
    @Override
    public boolean showInHelp() {
        return true;
    }

    /** {@inheritDoc} */
    @Override
    public CommandType getType() {
        return CommandType.TYPE_CHAT;
    }

    /** {@inheritDoc} */
    @Override
    public String getHelp() {
        return "me <action> - sends the specified action";
    }

    /** {@inheritDoc} */
    @Override
    public ValidationResponse validateArguments(final InputWindow origin,
            final CommandArguments arguments) {
        if (origin.getContainer().getServer() == null
                || origin.getContainer().getServer().getParser() == null) {
            return new ValidationResponse();
        }

        final int length = 2 + arguments.getArgumentsAsString().length();

        if (origin.getContainer().getServer().getParser().getMaxLength("PRIVMSG",
                origin.getContainer().toString()) <= length) {
            return new ValidationResponse("Too long");
        } else {
            return new ValidationResponse();
        }
    }
}