org/sonews/daemon/command/HelpCommand.java
author cli
Tue, 27 Apr 2010 22:11:30 +0200
changeset 27 d879bab39600
parent 26 407c428adb5b
permissions -rw-r--r--
Fix for #567 "mailinglist gateway does not recover after database outage".
chris@1
     1
/*
chris@1
     2
 *   SONEWS News Server
chris@1
     3
 *   see AUTHORS for the list of contributors
chris@1
     4
 *
chris@1
     5
 *   This program is free software: you can redistribute it and/or modify
chris@1
     6
 *   it under the terms of the GNU General Public License as published by
chris@1
     7
 *   the Free Software Foundation, either version 3 of the License, or
chris@1
     8
 *   (at your option) any later version.
chris@1
     9
 *
chris@1
    10
 *   This program is distributed in the hope that it will be useful,
chris@1
    11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@1
    12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@1
    13
 *   GNU General Public License for more details.
chris@1
    14
 *
chris@1
    15
 *   You should have received a copy of the GNU General Public License
chris@1
    16
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
chris@1
    17
 */
chris@1
    18
chris@1
    19
package org.sonews.daemon.command;
chris@1
    20
chris@1
    21
import java.io.IOException;
cli@26
    22
import java.util.Set;
cli@26
    23
import org.sonews.daemon.CommandSelector;
chris@1
    24
import org.sonews.daemon.NNTPConnection;
chris@1
    25
import org.sonews.util.io.Resource;
chris@1
    26
chris@1
    27
/**
chris@1
    28
 * This command provides a short summary of the commands that are
cli@26
    29
 * understood by this implementation of the server. The help text will
chris@1
    30
 * be presented as a multi-line data block following the 100 response
chris@1
    31
 * code (taken from RFC).
chris@1
    32
 * @author Christian Lins
chris@1
    33
 * @since sonews/0.5.0
chris@1
    34
 */
chris@3
    35
public class HelpCommand implements Command
chris@1
    36
{
chris@1
    37
chris@1
    38
  @Override
chris@1
    39
  public boolean hasFinished()
chris@1
    40
  {
chris@1
    41
    return true;
chris@1
    42
  }
chris@3
    43
chris@3
    44
  @Override
cli@20
    45
  public String impliedCapability()
cli@20
    46
  {
cli@20
    47
    return null;
cli@20
    48
  }
cli@20
    49
cli@20
    50
  @Override
chris@3
    51
  public boolean isStateful()
chris@3
    52
  {
chris@3
    53
    return true;
chris@3
    54
  }
chris@3
    55
chris@3
    56
  @Override
chris@3
    57
  public String[] getSupportedCommandStrings()
chris@3
    58
  {
chris@3
    59
    return new String[]{"HELP"};
chris@3
    60
  }
chris@1
    61
  
chris@1
    62
  @Override
chris@3
    63
  public void processLine(NNTPConnection conn, final String line, byte[] raw)
chris@1
    64
    throws IOException
chris@1
    65
  {
cli@26
    66
    final String[] command = line.split(" ");
chris@3
    67
    conn.println("100 help text follows");
cli@26
    68
cli@26
    69
    if(line.length() <= 1)
chris@1
    70
    {
cli@26
    71
      final String[] help = Resource
cli@26
    72
        .getAsString("helpers/helptext", true).split("\n");
cli@26
    73
      for(String hstr : help)
cli@26
    74
      {
cli@26
    75
        conn.println(hstr);
cli@26
    76
      }
cli@26
    77
cli@26
    78
      Set<String> commandNames = CommandSelector.getCommandNames();
cli@26
    79
      for(String cmdName : commandNames)
cli@26
    80
      {
cli@26
    81
        conn.println(cmdName);
cli@26
    82
      }
cli@26
    83
    }
cli@26
    84
    else
cli@26
    85
    {
cli@26
    86
      Command cmd = CommandSelector.getInstance().get(command[1]);
cli@26
    87
      if(cmd instanceof HelpfulCommand)
cli@26
    88
      {
cli@26
    89
        conn.println(((HelpfulCommand)cmd).getHelpString());
cli@26
    90
      }
cli@26
    91
      else
cli@26
    92
      {
cli@26
    93
        conn.println("No further help information available.");
cli@26
    94
      }
chris@1
    95
    }
chris@1
    96
    
chris@3
    97
    conn.println(".");
chris@1
    98
  }
chris@1
    99
  
chris@1
   100
}