/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.Ctcp__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.server;
    24  
    25  import com.dmdirc.Server;
    26  import com.dmdirc.commandparser.CommandArguments;
    27  import com.dmdirc.commandparser.CommandManager;
    28  import com.dmdirc.commandparser.commands.CommandOptions;
    29  import com.dmdirc.commandparser.commands.IntelligentCommand;
    30  import com.dmdirc.commandparser.commands.ServerCommand;
    31  import com.dmdirc.ui.input.AdditionalTabTargets;
    32  import com.dmdirc.ui.input.TabCompletionType;
    33  import com.dmdirc.ui.interfaces.InputWindow;
    34  
    35  import java.util.List;
    36  
    37  /**
    38   * Allows the user to send CTCP messages.
    39   * @author chris
    40   */
    41  @CommandOptions(allowOffline=false)
    42  public final class Ctcp extends ServerCommand implements IntelligentCommand {
    43      
    44      /**
    45       * Creates a new instance of Ctcp.
    46       */
    47      public Ctcp() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.Ctcp()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    48          super();
    49          
    50          CommandManager.registerCommand(this);
    51      }
    52      
    53      /**
    54       * Executes this command.
    55       * @param origin The frame in which this command was issued
    56       * @param server The server object that this command is associated with
    57       * @param isSilent Whether this command is silenced or not
    58       * @param args The user supplied arguments
    59       */
    60      @Override
    61      public void execute(final InputWindow origin, final Server server,
    62              final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    (soft) args.line != null
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  *    (soft) server != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Server:getParser(...)@66 != null
                  *    getArguments(...).length@66 >= 1
                  *    getArguments(...).length@68 >= 1
                  *    java.util.Arrays:copyOfRange(...)@99 != 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:
                  *    getArguments(...).length@63: {2..+Inf}, {0,1}
                  */
    63          if (args.getArguments().length < 2) {
    64              showUsage(origin, isSilent, "ctcp", "<target> <type> [arguments]");
    65          } else {
    66              server.getParser().sendLine("PRIVMSG " + args.getArguments()[0] + " :"
    67                      + ((char) 1) + args.getArgumentsAsString(1) + ((char) 1));
    68              sendLine(origin, isSilent, "selfCTCP", args.getArguments()[0],
    69                      args.getArgumentsAsString(1));
    70          }
    71      }
    72      
    73      
    74      /** {@inheritDoc}. */
    75      @Override
    76      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"ctcp"
                  */
    77          return "ctcp";
    78      }
    79      
    80      /** {@inheritDoc}. */
    81      @Override
    82      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    83          return true;
    84      }
    85      
    86      /** {@inheritDoc}. */
    87      @Override
    88      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"ctcp <target> <type> [arguments] - sends a CTCP message"
                  */
    89          return "ctcp <target> <type> [arguments] - sends a CTCP message";
    90      }
    91      
    92      /** {@inheritDoc} */
    93      @Override
    94      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.COMMAND)
                  * 
                  *  Postconditions:
                  *    return_value == &amp;new AdditionalTabTargets(getSuggestions#1)
                  *    new AdditionalTabTargets(getSuggestions#1) num objects == 1
                  * 
                  *  Test Vectors:
                  *    arg: {-231..-1, 2..232-1}, {0}, {1}
                  */
    95          final AdditionalTabTargets res = new AdditionalTabTargets();
    96          
    97          if (arg == 0) {
    98              res.exclude(TabCompletionType.COMMAND);
    99          } else if (arg == 1) {
   100              res.add("VERSION");
   101              res.add("ACTION");
   102              res.add("USERINFO");
   103              res.add("CLIENTINFO");
   104              res.add("PING");
   105              res.add("FINGER");
   106              res.add("SOURCE");
   107              res.add("TIME");
   108              res.excludeAll();
   109          }
   110          
   111          return res;
   112      }
   113      
   114  }