001    /**
002     * Jetrix TetriNET Server
003     * Copyright (C) 2001-2004  Emmanuel Bourg
004     *
005     * This program is free software; you can redistribute it and/or
006     * modify it under the terms of the GNU General Public License
007     * as published by the Free Software Foundation; either version 2
008     * of the License, or (at your option) any later version.
009     *
010     * This program is distributed in the hope that it will be useful,
011     * but WITHOUT ANY WARRANTY; without even the implied warranty of
012     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013     * GNU General Public License for more details.
014     *
015     * You should have received a copy of the GNU General Public License
016     * along with this program; if not, write to the Free Software
017     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
018     */
019    
020    package net.jetrix.commands;
021    
022    import java.util.*;
023    
024    import net.jetrix.*;
025    import net.jetrix.messages.channel.CommandMessage;
026    import net.jetrix.messages.channel.PlineMessage;
027    
028    /**
029     * List all commands available.
030     *
031     * @author Emmanuel Bourg
032     * @version $Revision: 798 $, $Date: 2009-02-18 16:24:28 +0100 (Wed, 18 Feb 2009) $
033     */
034    public class HelpCommand extends AbstractCommand
035    {
036        public String[] getAliases()
037        {
038            return (new String[]{"help", "?", "h"});
039        }
040    
041        public void execute(CommandMessage message)
042        {
043            Client client = (Client) message.getSource();
044            Locale locale = client.getUser().getLocale();
045    
046            // send the header
047            PlineMessage header = new PlineMessage();
048            header.setKey("command.help.header");
049            client.send(header);
050    
051            // iterate through the commands accessible to the user
052            Iterator commands = CommandManager.getInstance().getCommands(client.getUser().getAccessLevel());
053            while (commands.hasNext())
054            {
055                Command command = (Command) commands.next();
056    
057                if (command.isHidden())
058                {
059                    continue;
060                }
061    
062                // parse the usage string, and color and command and the parameters
063                String usage = command.getUsage(locale);
064                String line1Body;
065                int space = usage.indexOf(" ");
066                if (space == -1)
067                {
068                    line1Body = "<red>" + usage;
069                }
070                else
071                {
072                    line1Body = "<red>" + usage.substring(0, space) + "<aqua>" + usage.substring(space);
073                }
074    
075                // build the lines
076                PlineMessage line1 = new PlineMessage(line1Body);
077                PlineMessage line2 = new PlineMessage("         " + command.getDescription(locale));
078    
079                // send the lines
080                client.send(line1);
081                client.send(line2);
082            }
083        }
084    }