mirror of
https://github.com/matrix-construct/construct
synced 2024-12-28 00:14:07 +01:00
130 lines
3.8 KiB
C++
130 lines
3.8 KiB
C++
/*
|
|
* ircd-ratbox: A slightly useful ircd.
|
|
* m_help.c: Provides help information to a user/operator.
|
|
*
|
|
* Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
|
|
* Copyright (C) 1996-2002 Hybrid Development Team
|
|
* Copyright (C) 2002-2005 ircd-ratbox development team
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
* USA
|
|
*/
|
|
|
|
using namespace ircd;
|
|
|
|
static const char help_desc[] =
|
|
"Provides the help facility for commands, modes, and server concepts";
|
|
|
|
static void m_help(struct MsgBuf *, client::client &, client::client &, int, const char **);
|
|
static void mo_help(struct MsgBuf *, client::client &, client::client &, int, const char **);
|
|
static void mo_uhelp(struct MsgBuf *, client::client &, client::client &, int, const char **);
|
|
static void dohelp(client::client &, int, const char *);
|
|
|
|
struct Message help_msgtab = {
|
|
"HELP", 0, 0, 0, 0,
|
|
{mg_unreg, {m_help, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_help, 0}}
|
|
};
|
|
struct Message uhelp_msgtab = {
|
|
"UHELP", 0, 0, 0, 0,
|
|
{mg_unreg, {m_help, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_uhelp, 0}}
|
|
};
|
|
|
|
mapi_clist_av1 help_clist[] = { &help_msgtab, &uhelp_msgtab, NULL };
|
|
|
|
DECLARE_MODULE_AV2(help, NULL, NULL, help_clist, NULL, NULL, NULL, NULL, help_desc);
|
|
|
|
/*
|
|
* m_help - HELP message handler
|
|
*/
|
|
static void
|
|
m_help(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[])
|
|
{
|
|
using namespace cache::help;
|
|
|
|
dohelp(source, USER, parc > 1 ? parv[1] : NULL);
|
|
}
|
|
|
|
/*
|
|
* mo_help - HELP message handler
|
|
*/
|
|
static void
|
|
mo_help(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[])
|
|
{
|
|
using namespace cache::help;
|
|
|
|
dohelp(source, OPER, parc > 1 ? parv[1] : NULL);
|
|
}
|
|
|
|
/*
|
|
* mo_uhelp - HELP message handler
|
|
* This is used so that opers can view the user help file without deopering
|
|
*/
|
|
static void
|
|
mo_uhelp(struct MsgBuf *msgbuf_p, client::client &client, client::client &source, int parc, const char *parv[])
|
|
{
|
|
using namespace cache::help;
|
|
|
|
dohelp(source, USER, parc > 1 ? parv[1] : NULL);
|
|
}
|
|
|
|
static void
|
|
dohelp(client::client &source,
|
|
int type,
|
|
const char *topic)
|
|
try
|
|
{
|
|
namespace help = cache::help;
|
|
|
|
static const char *const ntopic("index");
|
|
if (EmptyString(topic))
|
|
topic = ntopic;
|
|
|
|
std::shared_ptr<cache::file> file
|
|
{
|
|
type & help::OPER? help::oper.at(topic):
|
|
type & help::USER? help::user.at(topic):
|
|
nullptr
|
|
};
|
|
|
|
if (!file || !(flags(*file) & type))
|
|
throw std::out_of_range(ntopic);
|
|
|
|
auto it(begin(contents(*file)));
|
|
if (it != end(contents(*file)))
|
|
sendto_one(&source, form_str(RPL_HELPSTART),
|
|
me.name,
|
|
source.name,
|
|
topic,
|
|
it->c_str());
|
|
|
|
for (++it; it != end(contents(*file)); ++it)
|
|
sendto_one(&source, form_str(RPL_HELPTXT),
|
|
me.name,
|
|
source.name,
|
|
topic,
|
|
it->c_str());
|
|
|
|
sendto_one(&source, form_str(RPL_ENDOFHELP),
|
|
me.name,
|
|
source.name,
|
|
topic);
|
|
}
|
|
catch(const std::out_of_range &e)
|
|
{
|
|
sendto_one(&source, form_str(ERR_HELPNOTFOUND),
|
|
me.name,
|
|
source.name,
|
|
topic?: e.what());
|
|
}
|