This repository has been archived on 2021-04-24. You can view files and clone it, but cannot push or open issues or pull requests.
Mikubot-2/otouto/plugins/help.lua
topkecleon 9f760114bd otouto 3.14
All help messages and many other things moved from markdown to html.
Eventually, I'd like only things made from user input to use markdown.

cats.lua, rmspic.lua, and dilbert.lua moved to sendPhoto with URL.
xkcd.lua and apod.lua not moved to retain formatting.

Probably a lot of other stuff that I forget about. I should commit more often.
2016-10-04 10:07:15 -04:00

54 lines
2.3 KiB
Lua

local utilities = require('otouto.utilities')
local help = {}
function help:init(config)
help.triggers = utilities.triggers(self.info.username, config.cmd_pat):t('help', true):t('h', true).table
help.command = 'help [command]'
help.doc = config.cmd_pat .. 'help [command] \nReturns usage information for a given command.'
end
function help:action(msg, config)
local input = utilities.input(msg.text_lower)
if input then
if not help.help_word then
for _, plugin in ipairs(self.plugins) do
if plugin.command and plugin.doc and not plugin.help_word then
plugin.help_word = utilities.get_word(plugin.command, 1)
end
end
end
for _,plugin in ipairs(self.plugins) do
if plugin.help_word == input:gsub('^/', '') then
local output = '<b>Help for</b> <i>' .. plugin.help_word .. '</i><b>:</b>\n' .. plugin.doc
utilities.send_message(msg.chat.id, output, true, nil, 'html')
return
end
end
utilities.send_reply(msg, 'Sorry, there is no help for that command.')
else
-- Generate the help message on first run.
if not help.text then
local commandlist = {}
for _, plugin in ipairs(self.plugins) do
if plugin.command then
table.insert(commandlist, plugin.command)
end
end
table.sort(commandlist)
local comlist = '\n' .. config.cmd_pat .. table.concat(commandlist, '\n' .. config.cmd_pat) .. '\nArguments: <required> [optional]'
help.text = '<b>Available commands:</b>' .. utilities.html_escape(comlist)
end
-- Attempt to send the help message via PM.
-- If msg is from a group, tell the group whether the PM was successful.
local res = utilities.send_message(msg.from.id, help.text, true, nil, 'html')
if not res then
utilities.send_reply(msg, 'Please <a href="http://telegram.me/' .. self.info.username .. '?start=help">message me privately</a> for a list of commands.', 'html')
elseif msg.chat.type ~= 'private' then
utilities.send_reply(msg, 'I have sent you the requested information in a private message.')
end
end
end
return help