2002-08-13 14:34:25 +00:00
|
|
|
/*
|
2002-09-13 06:50:09 +00:00
|
|
|
* NeoIRCd: NeoStats Group. Based on Hybird7
|
2002-08-13 14:34:25 +00:00
|
|
|
* m_help.c: Provides help information to a user/operator.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2002 by the past and present ircd coders, and others.
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*
|
2003-03-13 08:49:24 +00:00
|
|
|
* $Id: m_help.c,v 1.6 2003/03/13 08:49:24 fishwaldo Exp $
|
2002-08-13 14:34:25 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include "stdinc.h"
|
|
|
|
#include "handlers.h"
|
|
|
|
#include "client.h"
|
|
|
|
#include "ircd.h"
|
|
|
|
#include "motd.h"
|
|
|
|
#include "ircd_handler.h"
|
|
|
|
#include "msg.h"
|
|
|
|
#include "numeric.h"
|
|
|
|
#include "send.h"
|
|
|
|
#include "s_conf.h"
|
2002-09-02 04:11:00 +00:00
|
|
|
#include "s_log.h"
|
2002-08-13 14:34:25 +00:00
|
|
|
#include "parse.h"
|
|
|
|
#include "modules.h"
|
|
|
|
|
|
|
|
static void m_help(struct Client*, struct Client*, int, char**);
|
|
|
|
static void mo_help(struct Client*, struct Client*, int, char**);
|
|
|
|
static void mo_uhelp(struct Client*, struct Client*, int, char**);
|
|
|
|
static void dohelp(struct Client *, char *, char *, char *);
|
|
|
|
static void sendhelpfile(struct Client *, char *, char *, char *);
|
|
|
|
|
|
|
|
struct Message help_msgtab = {
|
2003-03-13 08:49:24 +00:00
|
|
|
"IRCDHELP", 0, 0, 0, 0, MFLG_SLOW, 0,
|
2002-08-13 14:34:25 +00:00
|
|
|
{m_unregistered, m_help, m_ignore, mo_help}
|
|
|
|
};
|
|
|
|
|
|
|
|
struct Message uhelp_msgtab = {
|
2003-03-13 08:49:24 +00:00
|
|
|
"IRCDUHELP", 0, 0, 0, 0, MFLG_SLOW, 0,
|
2002-08-13 14:34:25 +00:00
|
|
|
{m_unregistered, m_help, m_ignore, mo_uhelp}
|
|
|
|
};
|
|
|
|
#ifndef STATIC_MODULES
|
|
|
|
|
|
|
|
void
|
|
|
|
_modinit(void)
|
|
|
|
{
|
|
|
|
mod_add_cmd(&help_msgtab);
|
|
|
|
mod_add_cmd(&uhelp_msgtab);
|
|
|
|
}
|
|
|
|
|
|
|
|
void
|
|
|
|
_moddeinit(void)
|
|
|
|
{
|
|
|
|
mod_del_cmd(&help_msgtab);
|
|
|
|
mod_del_cmd(&uhelp_msgtab);
|
|
|
|
}
|
|
|
|
|
2003-03-13 08:49:24 +00:00
|
|
|
const char *_version = "$Revision: 1.6 $";
|
2002-08-13 14:34:25 +00:00
|
|
|
#endif
|
|
|
|
/*
|
|
|
|
* m_help - HELP message handler
|
|
|
|
* parv[0] = sender prefix
|
|
|
|
*/
|
2002-09-02 04:11:00 +00:00
|
|
|
static void
|
|
|
|
m_help(struct Client *client_p, struct Client *source_p,
|
2002-08-13 14:34:25 +00:00
|
|
|
int parc, char *parv[])
|
|
|
|
{
|
|
|
|
static time_t last_used = 0;
|
|
|
|
|
|
|
|
if(ConfigFileEntry.use_help)
|
|
|
|
{
|
|
|
|
/* HELP is always local */
|
|
|
|
if ((last_used + ConfigFileEntry.pace_wait_simple) > CurrentTime)
|
|
|
|
{
|
|
|
|
/* safe enough to give this on a local connect only */
|
|
|
|
sendto_one(source_p,form_str(RPL_LOAD2HI),me.name,parv[0]);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
last_used = CurrentTime;
|
|
|
|
}
|
|
|
|
|
|
|
|
if(parc > 1)
|
|
|
|
dohelp(source_p, UHPATH, parv[1], parv[0]);
|
|
|
|
else
|
|
|
|
dohelp(source_p, UHPATH, NULL, parv[0]);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
list_commands(source_p);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* mo_help - HELP message handler
|
|
|
|
* parv[0] = sender prefix
|
|
|
|
*/
|
2002-09-02 04:11:00 +00:00
|
|
|
static void
|
|
|
|
mo_help(struct Client *client_p, struct Client *source_p,
|
2002-08-13 14:34:25 +00:00
|
|
|
int parc, char *parv[])
|
|
|
|
{
|
|
|
|
if(parc > 1)
|
|
|
|
dohelp(source_p, HPATH, parv[1], parv[0]);
|
|
|
|
else
|
|
|
|
dohelp(source_p, HPATH, NULL, parv[0]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* mo_uhelp - HELP message handler
|
|
|
|
* This is used so that opers can view the user help file without deopering
|
|
|
|
* parv[0] = sender prefix
|
|
|
|
*/
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
static void
|
|
|
|
mo_uhelp(struct Client *client_p, struct Client *source_p,
|
|
|
|
int parc, char *parv[])
|
2002-08-13 14:34:25 +00:00
|
|
|
{
|
|
|
|
if(parc > 1)
|
|
|
|
dohelp(source_p, UHPATH, parv[1], parv[0]);
|
|
|
|
else
|
|
|
|
dohelp(source_p, UHPATH, NULL, parv[0]);
|
|
|
|
}
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
static void
|
|
|
|
dohelp(struct Client *source_p, char *hpath,
|
2002-08-13 14:34:25 +00:00
|
|
|
char *topic, char *nick)
|
|
|
|
{
|
|
|
|
char path[MAXPATHLEN + 1];
|
|
|
|
struct stat sb;
|
|
|
|
int i;
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
if (topic != NULL)
|
2002-08-13 14:34:25 +00:00
|
|
|
{
|
|
|
|
/* convert to lower case */
|
|
|
|
for (i = 0; topic[i] != '\0'; i++)
|
|
|
|
{
|
|
|
|
topic[i] = ToLower(topic[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
topic = "index"; /* list available help topics */
|
|
|
|
|
|
|
|
if (strchr(topic, '/'))
|
|
|
|
{
|
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (strlen(hpath) + strlen(topic) + 1 > MAXPATHLEN)
|
|
|
|
{
|
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
sprintf(path, "%s/%s", hpath, topic);
|
|
|
|
|
|
|
|
if (stat(path, &sb) < 0)
|
|
|
|
{
|
2002-09-02 04:11:00 +00:00
|
|
|
ilog(L_NOTICE, "help file %s not found", path);
|
2002-08-13 14:34:25 +00:00
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!S_ISREG(sb.st_mode))
|
|
|
|
{
|
2002-09-02 04:11:00 +00:00
|
|
|
ilog(L_NOTICE, "help file %s not found", path);
|
2002-08-13 14:34:25 +00:00
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
sendhelpfile(source_p, path, topic, nick);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
static void
|
|
|
|
sendhelpfile(struct Client *source_p, char *path,
|
2002-08-13 14:34:25 +00:00
|
|
|
char *topic, char *nick)
|
|
|
|
{
|
2002-09-02 04:11:00 +00:00
|
|
|
FBFILE *file;
|
2002-08-13 14:34:25 +00:00
|
|
|
char line[HELPLEN];
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
if ((file = fbopen(path, "r")) == NULL)
|
2002-08-13 14:34:25 +00:00
|
|
|
{
|
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
if (fbgets(line, sizeof(line), file) == NULL)
|
2002-08-13 14:34:25 +00:00
|
|
|
{
|
|
|
|
sendto_one(source_p, form_str(ERR_HELPNOTFOUND), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
sendto_one(source_p, form_str(RPL_HELPSTART), me.name, nick, topic, line);
|
|
|
|
|
2002-09-02 04:11:00 +00:00
|
|
|
while (fbgets(line, sizeof(line), file))
|
2002-08-13 14:34:25 +00:00
|
|
|
{
|
|
|
|
sendto_one(source_p, form_str(RPL_HELPTXT), me.name, nick, topic, line);
|
|
|
|
}
|
|
|
|
|
2003-01-29 09:28:50 +00:00
|
|
|
fbclose(file);
|
2002-08-13 14:34:25 +00:00
|
|
|
sendto_one(source_p, form_str(RPL_ENDOFHELP), me.name, nick, topic);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|