/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.channel.Ban__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 bans a specified user or host from the channel.
    40   * 
    41   * @author chris
    42   */
    43  public final class Ban extends ChannelCommand implements IntelligentCommand {
    44      
    45      /** Creates a new instance of Ban. */
    46      public Ban() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.channel.Ban()
                  * 
                  *  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) server != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Channel:getChannelInfo(...)@62 != null
                  *    com.dmdirc.Server:getParser(...)@68 != null
                  *    com.dmdirc.parser.irc.ChannelClientInfo:getClient(...)@63 != null
                  *    com.dmdirc.parser.irc.ChannelClientInfo:getClient(...)@65 != null
                  *    com.dmdirc.parser.irc.ClientInfo:getHost(...)@63 != null
                  *    ...
                  * 
                  *  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(...)@62: Addr_Set{null}, Inverse{null}
                  *    getArguments(...).length@56: {1..+Inf}, {0}
                  *    java.lang.String:isEmpty(...)@63: {1}, {0}
                  */
    56          if (args.getArguments().length == 0) {
    57              showUsage(origin, isSilent, "ban", "<user|host>");
    58              return;
    59          }
    60          
    61          String host = args.getArguments()[0];
    62          final ChannelClientInfo user = channel.getChannelInfo().getUser(host);
    63          if (user != null && !user.getClient().getHost().isEmpty()) {
    64              // TODO: Customisable ban masks, somehow.
    65              host = "*!*@" + user.getClient().getHost();
    66          }
    67          
    68          server.getParser().sendLine("MODE " + channel + " +b " + host);
    69      }
    70      
    71      /** {@inheritDoc} */
    72      @Override
    73      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"ban"
                  */
    74          return "ban";
    75      }
    76      
    77      /** {@inheritDoc} */
    78      @Override
    79      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    80          return true;
    81      }
    82      
    83      /** {@inheritDoc} */
    84      @Override
    85      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"ban <user|host> - bans the specified user or host from the channel."
                  */
    86          return "ban <user|host> - bans the specified user or host from the channel.";
    87      }
    88  
    89      /** {@inheritDoc} */
    90      @Override
    91      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Presumptions:
                  *    com.dmdirc.ui.input.AdditionalTabTargets:excludeAll(...)@92 != null
                  *    init'ed(com.dmdirc.ui.input.TabCompletionType.CHANNEL_NICK)
                  * 
                  *  Postconditions:
                  *    return_value != null
                  * 
                  *  Test Vectors:
                  *    arg: {-231..-1, 1..232-1}, {0}
                  */
    92          final AdditionalTabTargets res = new AdditionalTabTargets().excludeAll();
    93          
    94          if (arg == 0) {
    95              res.include(TabCompletionType.CHANNEL_NICK);
    96          }
    97          
    98          return res;
    99      }
   100      
   101  }