1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
/*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*
* $Id: m_help.c 26094 2008-09-19 15:33:46Z androsyn $
*/
#include "stdinc.h"
#include "struct.h"
#include "ircd.h"
#include "numeric.h"
#include "send.h"
#include "s_conf.h"
#include "parse.h"
#include "modules.h"
#include "hash.h"
#include "cache.h"
#include "match.h"
#include "client.h"
static int m_help(struct Client *, struct Client *, int, const char **);
static int mo_help(struct Client *, struct Client *, int, const char **);
static int mo_uhelp(struct Client *, struct Client *, int, const char **);
static void dohelp(struct Client *, int, const char *);
struct Message help_msgtab = {
"HELP", 0, 0, 0, MFLG_SLOW,
{mg_unreg, {m_help, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_help, 0}}
};
struct Message uhelp_msgtab = {
"UHELP", 0, 0, 0, MFLG_SLOW,
{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_AV1(help, NULL, NULL, help_clist, NULL, NULL, "$Revision: 26094 $");
/*
* m_help - HELP message handler
* parv[0] = sender prefix
*/
static int
m_help(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
{
static time_t last_used = 0;
/* HELP is always local */
if((last_used + ConfigFileEntry.pace_wait_simple) > rb_current_time())
{
/* safe enough to give this on a local connect only */
sendto_one(source_p, form_str(RPL_LOAD2HI), me.name, source_p->name, "HELP");
sendto_one(source_p, form_str(RPL_ENDOFHELP),
me.name, source_p->name,
(parc > 1 && !EmptyString(parv[1])) ? parv[1] : "index");
return 0;
}
else
{
last_used = rb_current_time();
}
dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL);
return 0;
}
/*
* mo_help - HELP message handler
* parv[0] = sender prefix
*/
static int
mo_help(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
{
dohelp(source_p, HELP_OPER, parc > 1 ? parv[1] : NULL);
return 0;
}
/*
* mo_uhelp - HELP message handler
* This is used so that opers can view the user help file without deopering
* parv[0] = sender prefix
*/
static int
mo_uhelp(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
{
dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL);
return 0;
}
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 = hash_find_help(topic, flags);
if(hptr == NULL)
{
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, source_p->name, topic);
return;
}
fptr = hptr->contents.head;
lineptr = fptr->data;
SetCork(source_p);
/* 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);
}
ClearCork(source_p);
sendto_one(source_p, form_str(RPL_ENDOFHELP), me.name, source_p->name, topic);
return;
}
|