Help.cs

using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
using Waher.IoTGateway;
 
namespace Waher.Service.IoTBroker.Admin.Feedback
{
    public class Help : IAdminCommand
    {
        public Help()
        {
        }
 
        public string Name => "Help";
 
        public string[] Aliases => new string[] { "Menu", "?", "#" };
 
        public bool AppliesTo(string CommandLine, string[] Arguments, out object Details)
        {
            Details = null;
            return Arguments.Length <= 1;
        }
 
        public Task Execute(ChatState State, string[] Arguments, string OrgMessage, object Details, ResponseCallbackHandler ResponseCallback)
        {
            StringBuilder Markdown = new StringBuilder();
 
            switch (Arguments.Length)
            {
                case 0:
                    Markdown.AppendLine("The following commands are available through the chat interface.");
                    Markdown.AppendLine("To get help about a specific command, type `help COMMAND`, where `COMMAND` is the name of the command you want more help about.");
                    Markdown.AppendLine();
 
                    bool First = true;
 
                    foreach (string Command in XmppServerModule.Instance.AdminCommands)
                    {
                        if (First)
                            First = false;
                        else
                            Markdown.Append(", ");
 
                        Markdown.Append('`');
                        Markdown.Append(Command);
                        Markdown.Append('`');
                    }
 
                    Markdown.AppendLine(".");
                    Markdown.AppendLine();
 
                    if (State.CommandMode)
                    {
                        Markdown.AppendLine("Any other sentence will be executed on the command prompt, and the response returned.");
                        Markdown.AppendLine();
                        Markdown.AppendLine("Additional commands (apart from normal DOS commands) in command mode:");
                        Markdown.AppendLine();
                        Markdown.AppendLine("| Additional commands in command mode           ||");
                        Markdown.AppendLine("|:-----------------------------------------|:----|");
                        Markdown.AppendLine("| `analyzeclock ...`                       | Executes `Waher.Utility.AnalyzeClock` with the provided parameters. |");
                        Markdown.AppendLine("| `csp ...`                                | Executes `Waher.Utility.Csp` with the provided parameters. |");
                        Markdown.AppendLine("| `exstat ...`                             | Executes `Waher.Utility.ExStat` with the provided parameters. |");
                        Markdown.AppendLine("| `extract ...`                            | Executes `Waher.Utility.Extract` with the provided parameters. |");
                        Markdown.AppendLine("| `install ...`                            | Executes `Waher.Utility.Install` with the provided parameters. |");
                        Markdown.AppendLine("| `regex ...`                              | Executes `Waher.Utility.RegEx` with the provided parameters. |");
                        Markdown.AppendLine("| `sign ...`                               | Executes `Waher.Utility.Sign` with the provided parameters. |");
                        Markdown.AppendLine("| `transform ...`                          | Executes `Waher.Utility.Transform` with the provided parameters. |");
                    }
                    else
                        Markdown.AppendLine("Any other sentence will be executed as [script](" + Gateway.GetUrl("/Script.md") + "), and the response returned.");
                    break;
 
                case 1:
                    if (XmppServerModule.Instance.TryGetAdminCommand(Arguments[0].ToLower(), out LinkedList<IAdminCommand> Commands))
                    {
                        foreach (IAdminCommand Command in Commands)
                        {
                            foreach (HelpItem Help in Command.GetHelp())
                            {
                                Markdown.Append('`');
                                Markdown.Append(Help.Syntax);
                                Markdown.AppendLine("`");
                                Markdown.AppendLine();
 
                                foreach (string Paragraph in Help.Paragraphs)
                                {
                                    Markdown.Append(':');
                                    Markdown.Append('\t');
                                    Markdown.AppendLine(Paragraph);
                                    Markdown.AppendLine();
                                }
                            }
                        }
                    }
                    else
                        Markdown.Append("Command not recognized. No help available.");
                    break;
            }
 
            return ResponseCallback(Markdown.ToString(), string.Empty);
        }
 
        public HelpItem[] GetHelp()
        {
            return new HelpItem[]
            {
                new HelpItem("help", "Gets help about available commands."),
                new HelpItem("help COMMAND", "Gets help about a specific command named `COMMAND`.")
            };
        }
 
    }
}