chris@1: /*
chris@1:  *   SONEWS News Server
chris@1:  *   see AUTHORS for the list of contributors
chris@1:  *
chris@1:  *   This program is free software: you can redistribute it and/or modify
chris@1:  *   it under the terms of the GNU General Public License as published by
chris@1:  *   the Free Software Foundation, either version 3 of the License, or
chris@1:  *   (at your option) any later version.
chris@1:  *
chris@1:  *   This program is distributed in the hope that it will be useful,
chris@1:  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@1:  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@1:  *   GNU General Public License for more details.
chris@1:  *
chris@1:  *   You should have received a copy of the GNU General Public License
chris@1:  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
chris@1:  */
chris@1: 
chris@1: package org.sonews.daemon.command;
chris@1: 
chris@1: import java.io.IOException;
cli@26: import java.util.Set;
cli@26: import org.sonews.daemon.CommandSelector;
chris@1: import org.sonews.daemon.NNTPConnection;
chris@1: import org.sonews.util.io.Resource;
chris@1: 
chris@1: /**
chris@1:  * This command provides a short summary of the commands that are
cli@26:  * understood by this implementation of the server. The help text will
chris@1:  * be presented as a multi-line data block following the 100 response
chris@1:  * code (taken from RFC).
chris@1:  * @author Christian Lins
chris@1:  * @since sonews/0.5.0
chris@1:  */
chris@3: public class HelpCommand implements Command
chris@1: {
chris@1: 
cli@37: 	@Override
cli@37: 	public boolean hasFinished()
cli@37: 	{
cli@37: 		return true;
cli@37: 	}
chris@3: 
cli@37: 	@Override
cli@37: 	public String impliedCapability()
cli@37: 	{
cli@37: 		return null;
cli@37: 	}
cli@20: 
cli@37: 	@Override
cli@37: 	public boolean isStateful()
cli@37: 	{
cli@37: 		return true;
cli@37: 	}
chris@3: 
cli@37: 	@Override
cli@37: 	public String[] getSupportedCommandStrings()
cli@37: 	{
cli@37: 		return new String[] {"HELP"};
cli@37: 	}
cli@26: 
cli@37: 	@Override
cli@37: 	public void processLine(NNTPConnection conn, final String line, byte[] raw)
cli@37: 		throws IOException
cli@37: 	{
cli@37: 		final String[] command = line.split(" ");
cli@37: 		conn.println("100 help text follows");
cli@26: 
cli@37: 		if (line.length() <= 1) {
cli@37: 			final String[] help = Resource.getAsString("helpers/helptext", true).split("\n");
cli@37: 			for (String hstr : help) {
cli@37: 				conn.println(hstr);
cli@37: 			}
cli@37: 
cli@37: 			Set<String> commandNames = CommandSelector.getCommandNames();
cli@37: 			for (String cmdName : commandNames) {
cli@37: 				conn.println(cmdName);
cli@37: 			}
cli@37: 		} else {
cli@37: 			Command cmd = CommandSelector.getInstance().get(command[1]);
cli@37: 			if (cmd instanceof HelpfulCommand) {
cli@37: 				conn.println(((HelpfulCommand) cmd).getHelpString());
cli@37: 			} else {
cli@37: 				conn.println("No further help information available.");
cli@37: 			}
cli@37: 		}
cli@37: 
cli@37: 		conn.println(".");
cli@37: 	}
chris@1: }