/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.channel.KickReason__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.commandparser.commands.channel;
    24  
    25  import com.dmdirc.Channel;
    26  import com.dmdirc.Server;
    27  import com.dmdirc.commandparser.CommandArguments;
    28  import com.dmdirc.commandparser.commands.ChannelCommand;
    29  import com.dmdirc.commandparser.CommandManager;
    30  import com.dmdirc.commandparser.commands.IntelligentCommand;
    31  import com.dmdirc.parser.irc.ChannelClientInfo;
    32  import com.dmdirc.ui.input.AdditionalTabTargets;
    33  import com.dmdirc.ui.input.TabCompletionType;
    34  import com.dmdirc.ui.interfaces.InputWindow;
    35  
    36  import java.util.List;
    37  
    38  /**
    39   * The kick command kicks a specified user from the channel.
    40   * This version allows the user to specify a reason.
    41   * @author chris
    42   */
    43  public final class KickReason extends ChannelCommand implements IntelligentCommand {
    44      
    45      /** Creates a new instance of KickReason. */
    46      public KickReason() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.channel.KickReason()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    47          super();
    48          
    49          CommandManager.registerCommand(this);
    50      }
    51      
    52      /** {@inheritDoc} */
    53      @Override
    54      public void execute(final InputWindow origin, final Server server,
    55              final Channel channel, final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, Channel, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    (soft) args.line != null
                  *    (soft) channel != null
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  *    (soft) origin != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Channel:getChannelInfo(...)@61 != null
                  *    com.dmdirc.ui.interfaces.InputWindow:getConfigManager(...).sources@68 != null
                  *    com.dmdirc.ui.interfaces.InputWindow:getConfigManager(...)@68 != null
                  *    getArguments(...).length@61 >= 1
                  *    getArguments(...).length@65 >= 1
                  *    ...
                  * 
                  *  Postconditions:
                  *    args.words != null
                  *    init'ed(java.lang.String:split(...)._tainted)
                  *    java.lang.String:split(...)._tainted == 0
                  *    init'ed(java.lang.String:split(...).length)
                  * 
                  *  Test Vectors:
                  *    com.dmdirc.parser.irc.ChannelInfo:getUser(...)@61: Inverse{null}, Addr_Set{null}
                  *    getArguments(...).length@56: {1..+Inf}, {0}
                  *    getArguments(...).length@68: {0,1}, {2..+Inf}
                  */
    56          if (args.getArguments().length == 0) {
    57              showUsage(origin, isSilent, "kick", "<user> [reason]");
    58              return;
    59          }
    60          
    61          final ChannelClientInfo victim = channel.getChannelInfo().getUser(args
    62                  .getArguments()[0]);
    63          
    64          if (victim == null) {
    65              sendLine(origin, isSilent, FORMAT_ERROR, "User not found: "
    66                      + args.getArguments()[0]);
    67          } else {
    68              victim.kick(args.getArguments().length > 1 ? args.getArgumentsAsString(1) :
    69                  origin.getConfigManager().getOption("general", "kickmessage"));
    70          }
    71      }
    72      
    73      /** {@inheritDoc} */
    74      @Override
    75      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"kick"
                  */
    76          return "kick";
    77      }
    78      
    79      /** {@inheritDoc} */
    80      @Override
    81      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    82          return true;
    83      }
    84      
    85      /** {@inheritDoc} */
    86      @Override
    87      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"kick <user> [reason] - kicks the specified user from the channel"
                  */
    88          return "kick <user> [reason] - kicks the specified user from the channel";
    89      }
    90  
    91      /** {@inheritDoc} */
    92      @Override
    93      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Presumptions:
                  *    init'ed(com.dmdirc.ui.input.TabCompletionType.CHANNEL_NICK)
                  * 
                  *  Postconditions:
                  *    return_value == &amp;new AdditionalTabTargets(getSuggestions#1)
                  *    new AdditionalTabTargets(getSuggestions#1) num objects == 1
                  * 
                  *  Test Vectors:
                  *    arg: {-231..-1, 1..232-1}, {0}
                  */
    94          final AdditionalTabTargets res = new AdditionalTabTargets();
    95          
    96          if (arg == 0) {
    97              res.excludeAll();
    98              res.include(TabCompletionType.CHANNEL_NICK);
    99          }
   100          
   101          return res;
   102      }    
   103      
   104  }