3c7d6fcce7
Also fix up some return values and stuff to use bool (or void if nothing). I just did it whilst I was here. According to jilles, the return value used to signify whether or not the client had exited. This was error-prone and was fixed a long, long time ago, but the return value was left int for historical reasons. Since the return type is not used (and has no clear use case anyway), it's safe to just get rid of it.
127 lines
3.7 KiB
C
127 lines
3.7 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
|
|
*/
|
|
|
|
#include "stdinc.h"
|
|
#include "client.h"
|
|
#include "ircd.h"
|
|
#include "msg.h"
|
|
#include "numeric.h"
|
|
#include "send.h"
|
|
#include "s_conf.h"
|
|
#include "logger.h"
|
|
#include "parse.h"
|
|
#include "modules.h"
|
|
#include "hash.h"
|
|
#include "cache.h"
|
|
#include "rb_dictionary.h"
|
|
|
|
static const char help_desc[] =
|
|
"Provides the help facility for commands, modes, and server concepts";
|
|
|
|
static void m_help(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
static void mo_help(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
static void mo_uhelp(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
|
|
static void dohelp(struct 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, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
|
|
{
|
|
dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL);
|
|
}
|
|
|
|
/*
|
|
* mo_help - HELP message handler
|
|
*/
|
|
static void
|
|
mo_help(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
|
|
{
|
|
dohelp(source_p, HELP_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, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
|
|
{
|
|
dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL);
|
|
}
|
|
|
|
static void
|
|
dohelp(struct Client *source_p, int flags, const char *topic)
|
|
{
|
|
static const char ntopic[] = "index";
|
|
struct cachefile *hptr;
|
|
struct cacheline *lineptr;
|
|
rb_dlink_node *ptr;
|
|
rb_dlink_node *fptr;
|
|
|
|
if(EmptyString(topic))
|
|
topic = ntopic;
|
|
|
|
hptr = rb_dictionary_retrieve(flags & HELP_OPER ? help_dict_oper : help_dict_user, topic);
|
|
|
|
if(hptr == NULL || !(hptr->flags & flags))
|
|
{
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
|
|
me.name, source_p->name, topic);
|
|
return;
|
|
}
|
|
|
|
fptr = hptr->contents.head;
|
|
lineptr = fptr->data;
|
|
|
|
/* first line cant be empty */
|
|
sendto_one(source_p, form_str(RPL_HELPSTART),
|
|
me.name, source_p->name, topic, lineptr->data);
|
|
|
|
RB_DLINK_FOREACH(ptr, fptr->next)
|
|
{
|
|
lineptr = ptr->data;
|
|
|
|
sendto_one(source_p, form_str(RPL_HELPTXT),
|
|
me.name, source_p->name, topic, lineptr->data);
|
|
}
|
|
|
|
sendto_one(source_p, form_str(RPL_ENDOFHELP),
|
|
me.name, source_p->name, topic);
|
|
}
|