DMDirc-Parser/src/com/dmdirc/parser/irc/processors/ProcessWallops.java

/*
 * Copyright (c) 2006-2014 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.parser.irc.processors;

import com.dmdirc.parser.interfaces.callbacks.WallDesyncListener;
import com.dmdirc.parser.interfaces.callbacks.WallopListener;
import com.dmdirc.parser.interfaces.callbacks.WalluserListener;
import com.dmdirc.parser.irc.IRCParser;
import com.dmdirc.parser.irc.ProcessingManager;

/**
 * Process a WALLOPS Message.
 */
public class ProcessWallops extends IRCProcessor {

    /**
     * Create a new instance of the IRCProcessor Object.
     *
     * @param parser IRCParser That owns this IRCProcessor
     * @param manager ProcessingManager that is in charge of this IRCProcessor
     */
    public ProcessWallops(final IRCParser parser, final ProcessingManager manager) {
        super(parser, manager);
    }

    /**
     * Process a Wallops Message.
     *
     * @param sParam Type of line to process ("WALLOPS")
     * @param token IRCTokenised line to process
     */
    @Override
    public void process(final String sParam, final String[] token) {
        if (token.length < 3) {
            return;
        }

        String user = token[0];
        final String message = token[token.length - 1];
        if (user.charAt(0) == ':' && user.length() > 1) {
            user = user.substring(1);
        }
        final String[] bits = message.split(" ", 2);

        if (bits.length > 1) {
            if (message.charAt(0) == '*') {
                callWallop(bits[1], user);
                return;
            } else if (message.charAt(0) == '$') {
                callWalluser(bits[1], user);
                return;
            }
        }
        callWallDesync(message, user);
    }

    /**
     * Callback to all objects implementing the Wallop Callback.
     *
     * @see com.dmdirc.parser.interfaces.callbacks.WallopListener
     * @param host Host of the user who sent the wallop
     * @param message The message
     * @return true if a method was called, false otherwise
     */
    protected boolean callWallop(final String message, final String host) {
        return getCallbackManager().getCallbackType(WallopListener.class).call(message, host);
    }

    /**
     * Callback to all objects implementing the Walluser Callback.
     *
     * @see com.dmdirc.parser.interfaces.callbacks.WalluserListener
     * @param host Host of the user who sent the walluser
     * @param message The message
     * @return true if a method was called, false otherwise
     */
    protected boolean callWalluser(final String message, final String host) {
        return getCallbackManager().getCallbackType(WalluserListener.class).call(message, host);
    }

    /**
     * Callback to all objects implementing the WallDesync Callback.
     *
     * @see com.dmdirc.parser.interfaces.callbacks.WallDesyncListener
     * @param host Host of the user who sent the WallDesync
     * @param message The message
     * @return true if a method was called, false otherwise
     */
    protected boolean callWallDesync(final String message, final String host) {
        return getCallbackManager().getCallbackType(WallDesyncListener.class).call(message, host);
    }

    /**
     * What does this IRCProcessor handle.
     *
     * @return String[] with the names of the tokens we handle.
     */
    @Override
    public String[] handles() {
        return new String[]{"WALLOPS"};
    }
}