ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/svn/ircd-hybrid/trunk/modules/m_help.c

Comparing ircd-hybrid/trunk/modules/m_help.c (file contents):
Revision 2657 by michael, Thu Dec 12 19:04:53 2013 UTC vs.
Revision 6350 by michael, Tue Aug 11 17:53:44 2015 UTC

#	Line 1 | Line 1
1		/*
2	<	*  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3	<	*  m_help.c: Provides help information to a user/operator.
2	>	*  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3		*
4	<	*  Copyright (C) 2002 by the past and present ircd coders, and others.
4	>	*  Copyright (c) 1999-2015 ircd-hybrid development team
5		*
6		*  This program is free software; you can redistribute it and/or modify
7		*  it under the terms of the GNU General Public License as published by
#	Line 16 | Line 15
15		*
16		*  You should have received a copy of the GNU General Public License
17		*  along with this program; if not, write to the Free Software
18	<	*  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
18	>	*  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19		*  USA
20	<	*
21	<	*  $Id$
20	>	*/
21	>
22	>	/*! \file m_help.c
23	>	* \brief Includes required functions for processing the HELP command.
24	>	* \version $Id$
25		*/
26
27		#include "stdinc.h"
#	Line 32 | Line 34
34		#include "modules.h"
35		#include "irc_string.h"
36
35	–	#define HELPLEN 400
37
38	+	enum { HELPLEN = 400 };
39
40		static void
41		sendhelpfile(struct Client *source_p, const char *path, const char *topic)
42		{
43		FILE *file = NULL;
44	<	char line[HELPLEN] = { '\0' };
44	>	char *p = NULL;
45	>	char line[HELPLEN] = "";
46
47		if ((file = fopen(path, "r")) == NULL)
48		{
49	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
47	<	me.name, source_p->name, topic);
49	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
50		return;
51		}
52
53		if (fgets(line, sizeof(line), file) == NULL)
54		{
55	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
54	<	me.name, source_p->name, topic);
55	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
56		fclose(file);
57		return;
58		}
59
60	<	line[strlen(line) - 1] = '\0';
61	<	sendto_one(source_p, form_str(RPL_HELPSTART),
62	<	me.name, source_p->name, topic, line);
60	>	if ((p = strpbrk(line, "\r\n")))
61	>	*p = '\0';
62	>
63	>	sendto_one_numeric(source_p, &me, RPL_HELPSTART, topic, line);
64
65		while (fgets(line, sizeof(line), file))
66		{
67	<	line[strlen(line) - 1] = '\0';
67	>	if ((p = strpbrk(line, "\r\n")))
68	>	*p = '\0';
69
70	<	sendto_one(source_p, form_str(RPL_HELPTXT),
68	<	me.name, source_p->name, topic, line);
70	>	sendto_one_numeric(source_p, &me, RPL_HELPTXT, topic, line);
71		}
72
73		fclose(file);
74	<	sendto_one(source_p, form_str(RPL_ENDOFHELP),
73	<	me.name, source_p->name, topic);
74	>	sendto_one_numeric(source_p, &me, RPL_ENDOFHELP, topic);
75		}
76
77		static void
78	<	dohelp(struct Client *source_p, char *topic)
78	>	do_help(struct Client *source_p, char *topic)
79		{
79	–	char *p = topic;
80		char h_index[] = "index";
81		char path[HYB_PATH_MAX + 1];
82		struct stat sb;
#	Line 84 | Line 84 | dohelp(struct Client *source_p, char *to
84		if (EmptyString(topic))
85		topic = h_index;
86		else
87	<	for (; *p; ++p)
87	>	for (char *p = topic; *p; ++p)
88		*p = ToLower(*p);
89
90		if (strpbrk(topic, "/\\"))
91		{
92	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
93	<	me.name, source_p->name, topic);
92	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
93		return;
94		}
95
96		if (strlen(HPATH) + strlen(topic) + 1 > HYB_PATH_MAX)
97		{
98	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
100	<	me.name, source_p->name, topic);
98	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
99		return;
100		}
101
#	Line 105 | Line 103 | dohelp(struct Client *source_p, char *to
103
104		if (stat(path, &sb) < 0)
105		{
106	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
109	<	me.name, source_p->name, topic);
106	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
107		return;
108		}
109
110		if (!S_ISREG(sb.st_mode))
111		{
112	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
116	<	me.name, source_p->name, topic);
112	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
113		return;
114		}
115
116		sendhelpfile(source_p, path, topic);
117		}
118
119	<	/*
120	<	* m_help - HELP message handler
121	<	*      parv[0] = sender prefix
119	>	/*! \brief HELP command handler
120	>	*
121	>	* \param source_p Pointer to allocated Client struct from which the message
122	>	*                 originally comes from.  This can be a local or remote client.
123	>	* \param parc     Integer holding the number of supplied arguments.
124	>	* \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
125	>	*                 pointers.
126	>	* \note Valid arguments for this command are:
127	>	*      - parv[0] = command
128	>	*      - parv[1] = help topic
129		*/
130	<	static void
131	<	m_help(struct Client *client_p, struct Client *source_p,
129	<	int parc, char *parv[])
130	>	static int
131	>	m_help(struct Client *source_p, int parc, char *parv[])
132		{
133		static time_t last_used = 0;
134
135	<	/* HELP is always local */
134	<	if ((last_used + ConfigFileEntry.pace_wait_simple) > CurrentTime)
135	>	if ((last_used + ConfigGeneral.pace_wait_simple) > CurrentTime)
136		{
137	<	/* safe enough to give this on a local connect only */
138	<	sendto_one(source_p,form_str(RPL_LOAD2HI),
138	<	me.name, source_p->name);
139	<	return;
137	>	sendto_one_numeric(source_p, &me, RPL_LOAD2HI, "HELP");
138	>	return 0;
139		}
140
141		last_used = CurrentTime;
142
143	<	dohelp(source_p, parv[1]);
143	>	do_help(source_p, parv[1]);
144	>	return 0;
145		}
146
147	<	/*
148	<	* mo_help - HELP message handler
149	<	*      parv[0] = sender prefix
147	>	/*! \brief HELP command handler
148	>	*
149	>	* \param source_p Pointer to allocated Client struct from which the message
150	>	*                 originally comes from.  This can be a local or remote client.
151	>	* \param parc     Integer holding the number of supplied arguments.
152	>	* \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
153	>	*                 pointers.
154	>	* \note Valid arguments for this command are:
155	>	*      - parv[0] = command
156	>	*      - parv[1] = help topic
157		*/
158	<	static void
159	<	mo_help(struct Client *client_p, struct Client *source_p,
153	<	int parc, char *parv[])
158	>	static int
159	>	mo_help(struct Client *source_p, int parc, char *parv[])
160		{
161	<	dohelp(source_p, parv[1]);
161	>	do_help(source_p, parv[1]);
162	>	return 0;
163		}
164
165	<	static struct Message help_msgtab = {
166	<	"HELP", 0, 0, 0, MAXPARA, MFLG_SLOW, 0,
167	<	{m_unregistered, m_help, m_ignore, m_ignore, mo_help, m_ignore}
165	>	static struct Message help_msgtab =
166	>	{
167	>	.cmd = "HELP",
168	>	.args_max = MAXPARA,
169	>	.handlers[UNREGISTERED_HANDLER] = m_unregistered,
170	>	.handlers[CLIENT_HANDLER] = m_help,
171	>	.handlers[SERVER_HANDLER] = m_ignore,
172	>	.handlers[ENCAP_HANDLER] = m_ignore,
173	>	.handlers[OPER_HANDLER] = mo_help
174		};
175
176		static void
#	Line 172 | Line 185 | module_exit(void)
185		mod_del_cmd(&help_msgtab);
186		}
187
188	<	struct module module_entry = {
189	<	.node    = { NULL, NULL, NULL },
177	<	.name    = NULL,
188	>	struct module module_entry =
189	>	{
190		.version = "$Revision$",
179	–	.handle  = NULL,
191		.modinit = module_init,
192		.modexit = module_exit,
182	–	.flags   = 0
193		};

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines (old)
>	Changed lines (new)