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 . 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: chris@1: @Override chris@1: public boolean hasFinished() chris@1: { chris@1: return true; chris@1: } chris@3: chris@3: @Override cli@20: public String impliedCapability() cli@20: { cli@20: return null; cli@20: } cli@20: cli@20: @Override chris@3: public boolean isStateful() chris@3: { chris@3: return true; chris@3: } chris@3: chris@3: @Override chris@3: public String[] getSupportedCommandStrings() chris@3: { chris@3: return new String[]{"HELP"}; chris@3: } chris@1: chris@1: @Override chris@3: public void processLine(NNTPConnection conn, final String line, byte[] raw) chris@1: throws IOException chris@1: { cli@26: final String[] command = line.split(" "); chris@3: conn.println("100 help text follows"); cli@26: cli@26: if(line.length() <= 1) chris@1: { cli@26: final String[] help = Resource cli@26: .getAsString("helpers/helptext", true).split("\n"); cli@26: for(String hstr : help) cli@26: { cli@26: conn.println(hstr); cli@26: } cli@26: cli@26: Set commandNames = CommandSelector.getCommandNames(); cli@26: for(String cmdName : commandNames) cli@26: { cli@26: conn.println(cmdName); cli@26: } cli@26: } cli@26: else cli@26: { cli@26: Command cmd = CommandSelector.getInstance().get(command[1]); cli@26: if(cmd instanceof HelpfulCommand) cli@26: { cli@26: conn.println(((HelpfulCommand)cmd).getHelpString()); cli@26: } cli@26: else cli@26: { cli@26: conn.println("No further help information available."); cli@26: } chris@1: } chris@1: chris@3: conn.println("."); chris@1: } chris@1: chris@1: }