src/org/sonews/daemon/command/HelpCommand.java
author František Kučera <franta-hg@frantovo.cz>
Mon, 07 Nov 2011 17:35:43 +0100
changeset 117 79ce65d63cce
parent 37 74139325d305
permissions -rwxr-xr-x
ACL: uživatel v Article bude jako User ne jen jako String.
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
cli@37
    38
	@Override
cli@37
    39
	public boolean hasFinished()
cli@37
    40
	{
cli@37
    41
		return true;
cli@37
    42
	}
chris@3
    43
cli@37
    44
	@Override
cli@37
    45
	public String impliedCapability()
cli@37
    46
	{
cli@37
    47
		return null;
cli@37
    48
	}
cli@20
    49
cli@37
    50
	@Override
cli@37
    51
	public boolean isStateful()
cli@37
    52
	{
cli@37
    53
		return true;
cli@37
    54
	}
chris@3
    55
cli@37
    56
	@Override
cli@37
    57
	public String[] getSupportedCommandStrings()
cli@37
    58
	{
cli@37
    59
		return new String[] {"HELP"};
cli@37
    60
	}
cli@26
    61
cli@37
    62
	@Override
cli@37
    63
	public void processLine(NNTPConnection conn, final String line, byte[] raw)
cli@37
    64
		throws IOException
cli@37
    65
	{
cli@37
    66
		final String[] command = line.split(" ");
cli@37
    67
		conn.println("100 help text follows");
cli@26
    68
cli@37
    69
		if (line.length() <= 1) {
cli@37
    70
			final String[] help = Resource.getAsString("helpers/helptext", true).split("\n");
cli@37
    71
			for (String hstr : help) {
cli@37
    72
				conn.println(hstr);
cli@37
    73
			}
cli@37
    74
cli@37
    75
			Set<String> commandNames = CommandSelector.getCommandNames();
cli@37
    76
			for (String cmdName : commandNames) {
cli@37
    77
				conn.println(cmdName);
cli@37
    78
			}
cli@37
    79
		} else {
cli@37
    80
			Command cmd = CommandSelector.getInstance().get(command[1]);
cli@37
    81
			if (cmd instanceof HelpfulCommand) {
cli@37
    82
				conn.println(((HelpfulCommand) cmd).getHelpString());
cli@37
    83
			} else {
cli@37
    84
				conn.println("No further help information available.");
cli@37
    85
			}
cli@37
    86
		}
cli@37
    87
cli@37
    88
		conn.println(".");
cli@37
    89
	}
chris@1
    90
}