tennu/tennu_plugins/help.js

Tennu - Modular IRC Bot Framework for Node.js

// This entire plugin is written so badly, but I don't know how to make it cleaner.
// :(
//
// -- Havvy

const HELP_NOT_FOUND = "Help file for selected topic does not exist.";

const isArray = require("util").isArray;
const format = require("util").format;
const inspect = require("util").inspect;
const Set = require("simplesets").Set;

module.exports = {
    name: "help",

    configDefaults: {
        "help-helpfile": [
            "{{!}}help <query>",
            " ",
            "Display the help message for the topic located at the given query.",
            "Query can be made of multiple subtopics",
            "Without a query, shows this help message.",
            " ",
            "Ex: {{!}}help commands",
            "Ex: {{!}}help learn formats"
        ],

        "disable-help": false,
    },

    init: function (client, imports) {
        const enabled = !(client.config("disable-help"));

        if (!enabled) {
            // Empty module.
            return {};
        }

        const commandTrigger = client.config("command-trigger");
        const commandIgnoreList = client.config("command-ignore-list");

        // (string | [string]) -> string | [string]
        function replaceCommandTrigger (response) {
            if (typeof response === "string") {
                return response.replace(/{{!}}/g, commandTrigger);
            } else {
                return response.map(replaceCommandTrigger);
            }
        }

        const registry = {};
        const commandset = new Set();

        function helpResponseMessage (query) {
            const cursor = query.reduce(function (cursor, topic) {
                if (typeof cursor !== "object") {
                    return undefined;
                }

                if (cursor.hasOwnProperty(topic)) {
                    return cursor[topic];
                } else {
                    return undefined;
                }
            }, registry);

            if (cursor === undefined) {
                return HELP_NOT_FOUND;
            }

            if (typeof cursor === "string" || Array.isArray(cursor)) {
                return replaceCommandTrigger(cursor);
            }

            if (typeof cursor["*"] === "string" || Array.isArray(cursor["*"])) {
                return replaceCommandTrigger(cursor["*"]);
            }

            return HELP_NOT_FOUND;
        }

        return {
            handlers: {
                "!help": function (command) {
                    // Default to showing the help for the help module if no args given.
                    const query = command.args.length === 0 ? ["help"] : command.args.slice();
                    var response = helpResponseMessage(query);

                    return {
                        message: response,
                        query: true,
                        intent: "say"
                    };
                },

                "!commands": function (command) {
                    const start = ["List of known commands:"];
                    return start.concat(commandset.array().join(", "));
                }
            },

            exports: {
                help: helpResponseMessage,
                helpObject: function () { return JSON.parse(JSON.stringify(registry)); },
                HELP_NOT_FOUND: HELP_NOT_FOUND
            },

            hooks: {
                help: function (module, help) {
                    if (typeof help === "string") {
                        registry[module] = {"*": help}
                        return;
                    }

                    if (Array.isArray(help)) {
                        registry[module] = {"*": help}
                        return;
                    }

                    if (typeof help === "object") {
                        Object.keys(help).forEach(function (key) {
                            if (key === "*") {
                                registry[module] = help["*"];
                            }

                            registry[key] = help[key];
                        });
                        return;
                    }

                    throw new TypeError(format("Help property for module %s is invalid.", module));
                },

                commands: function (module, commands) {
                    if (!Array.isArray(commands)) {
                        throw new TypeError(format("Commands property for module %s is invalid.", module));
                    }

                    commands.forEach(function (command) {
                        if (typeof command !== "string") {
                            throw new TypeError(format("Commands property for module %s is invalid.", module));
                        }

                        if (commandIgnoreList.indexOf(command) !== -1) {
                            return;
                        }

                        commandset.add(command);
                    });
                }
            },

            help: {
                help: client.config("help-helpfile"),

                commands: [
                    "{{!}}commands",
                    " ",
                    "Show the list of commands."
                ]
            },

            commands: ["help", "commands"]
        };
    },

    requires: ["config", "subscriber", "messages", "commands"]
};