1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/org/sonews/daemon/command/HelpCommand.java	Sun Aug 29 17:28:58 2010 +0200
     1.3 @@ -0,0 +1,100 @@
     1.4 +/*
     1.5 + *   SONEWS News Server
     1.6 + *   see AUTHORS for the list of contributors
     1.7 + *
     1.8 + *   This program is free software: you can redistribute it and/or modify
     1.9 + *   it under the terms of the GNU General Public License as published by
    1.10 + *   the Free Software Foundation, either version 3 of the License, or
    1.11 + *   (at your option) any later version.
    1.12 + *
    1.13 + *   This program is distributed in the hope that it will be useful,
    1.14 + *   but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 + *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.16 + *   GNU General Public License for more details.
    1.17 + *
    1.18 + *   You should have received a copy of the GNU General Public License
    1.19 + *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
    1.20 + */
    1.21 +
    1.22 +package org.sonews.daemon.command;
    1.23 +
    1.24 +import java.io.IOException;
    1.25 +import java.util.Set;
    1.26 +import org.sonews.daemon.CommandSelector;
    1.27 +import org.sonews.daemon.NNTPConnection;
    1.28 +import org.sonews.util.io.Resource;
    1.29 +
    1.30 +/**
    1.31 + * This command provides a short summary of the commands that are
    1.32 + * understood by this implementation of the server. The help text will
    1.33 + * be presented as a multi-line data block following the 100 response
    1.34 + * code (taken from RFC).
    1.35 + * @author Christian Lins
    1.36 + * @since sonews/0.5.0
    1.37 + */
    1.38 +public class HelpCommand implements Command
    1.39 +{
    1.40 +
    1.41 +  @Override
    1.42 +  public boolean hasFinished()
    1.43 +  {
    1.44 +    return true;
    1.45 +  }
    1.46 +
    1.47 +  @Override
    1.48 +  public String impliedCapability()
    1.49 +  {
    1.50 +    return null;
    1.51 +  }
    1.52 +
    1.53 +  @Override
    1.54 +  public boolean isStateful()
    1.55 +  {
    1.56 +    return true;
    1.57 +  }
    1.58 +
    1.59 +  @Override
    1.60 +  public String[] getSupportedCommandStrings()
    1.61 +  {
    1.62 +    return new String[]{"HELP"};
    1.63 +  }
    1.64 +  
    1.65 +  @Override
    1.66 +  public void processLine(NNTPConnection conn, final String line, byte[] raw)
    1.67 +    throws IOException
    1.68 +  {
    1.69 +    final String[] command = line.split(" ");
    1.70 +    conn.println("100 help text follows");
    1.71 +
    1.72 +    if(line.length() <= 1)
    1.73 +    {
    1.74 +      final String[] help = Resource
    1.75 +        .getAsString("helpers/helptext", true).split("\n");
    1.76 +      for(String hstr : help)
    1.77 +      {
    1.78 +        conn.println(hstr);
    1.79 +      }
    1.80 +
    1.81 +      Set<String> commandNames = CommandSelector.getCommandNames();
    1.82 +      for(String cmdName : commandNames)
    1.83 +      {
    1.84 +        conn.println(cmdName);
    1.85 +      }
    1.86 +    }
    1.87 +    else
    1.88 +    {
    1.89 +      Command cmd = CommandSelector.getInstance().get(command[1]);
    1.90 +      if(cmd instanceof HelpfulCommand)
    1.91 +      {
    1.92 +        conn.println(((HelpfulCommand)cmd).getHelpString());
    1.93 +      }
    1.94 +      else
    1.95 +      {
    1.96 +        conn.println("No further help information available.");
    1.97 +      }
    1.98 +    }
    1.99 +    
   1.100 +    conn.println(".");
   1.101 +  }
   1.102 +  
   1.103 +}