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 1834 by michael, Fri Apr 19 19:50:27 2013 UTC vs.
Revision 4759 by michael, Sun Oct 19 10:54:43 2014 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-2014 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 34 | Line 36
36
37		#define HELPLEN 400
38
37	–	static void dohelp(struct Client *, const char *, char *);
38	–	static void sendhelpfile(struct Client *, const char *, const char *);
39	–
39
41	–	/*
42	–	* m_help - HELP message handler
43	–	*      parv[0] = sender prefix
44	–	*/
40		static void
41	<	m_help(struct Client *client_p, struct Client *source_p,
47	<	int parc, char *parv[])
41	>	sendhelpfile(struct Client *source_p, const char *path, const char *topic)
42		{
43	<	static time_t last_used = 0;
43	>	FILE *file = NULL;
44	>	char line[HELPLEN] = "";
45
46	<	/* HELP is always local */
52	<	if ((last_used + ConfigFileEntry.pace_wait_simple) > CurrentTime)
46	>	if ((file = fopen(path, "r")) == NULL)
47		{
48	<	/* safe enough to give this on a local connect only */
55	<	sendto_one(source_p,form_str(RPL_LOAD2HI),
56	<	me.name, source_p->name);
48	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
49		return;
50		}
51
52	<	last_used = CurrentTime;
52	>	if (fgets(line, sizeof(line), file) == NULL)
53	>	{
54	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
55	>	fclose(file);
56	>	return;
57	>	}
58
59	<	dohelp(source_p, UHPATH, parv[1]);
60	<	}
59	>	line[strlen(line) - 1] = '\0';
60	>	sendto_one_numeric(source_p, &me, RPL_HELPSTART, topic, line);
61
62	<	/*
63	<	* mo_help - HELP message handler
64	<	*      parv[0] = sender prefix
68	<	*/
69	<	static void
70	<	mo_help(struct Client *client_p, struct Client *source_p,
71	<	int parc, char *parv[])
72	<	{
73	<	dohelp(source_p, HPATH, parv[1]);
74	<	}
62	>	while (fgets(line, sizeof(line), file))
63	>	{
64	>	line[strlen(line) - 1] = '\0';
65
66	<	/*
67	<	* mo_uhelp - HELP message handler
68	<	* This is used so that opers can view the user help file without deopering
69	<	*      parv[0] = sender prefix
70	<	*/
81	<	static void
82	<	mo_uhelp(struct Client *client_p, struct Client *source_p,
83	<	int parc, char *parv[])
84	<	{
85	<	dohelp(source_p, UHPATH, parv[1]);
66	>	sendto_one_numeric(source_p, &me, RPL_HELPTXT, topic, line);
67	>	}
68	>
69	>	fclose(file);
70	>	sendto_one_numeric(source_p, &me, RPL_ENDOFHELP, topic);
71		}
72
73		static void
74	<	dohelp(struct Client *source_p, const char *hpath, char *topic)
74	>	do_help(struct Client *source_p, char *topic)
75		{
76		char h_index[] = "index";
77		char path[HYB_PATH_MAX + 1];
78		struct stat sb;
94	–	unsigned int i;
79
80		if (EmptyString(topic))
81		topic = h_index;
82		else
83	<	for (i = 0; topic[i] != '\0'; ++i)
84	<	topic[i] = ToLower(topic[i]);
83	>	for (char *p = topic; *p; ++p)
84	>	*p = ToLower(*p);
85
86		if (strpbrk(topic, "/\\"))
87		{
88	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
105	<	me.name, source_p->name, topic);
88	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
89		return;
90		}
91
92	<	if (strlen(hpath) + strlen(topic) + 1 > HYB_PATH_MAX)
92	>	if (strlen(HPATH) + strlen(topic) + 1 > HYB_PATH_MAX)
93		{
94	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
112	<	me.name, source_p->name, topic);
94	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
95		return;
96		}
97
98	<	snprintf(path, sizeof(path), "%s/%s", hpath, topic);
98	>	snprintf(path, sizeof(path), "%s/%s", HPATH, topic);
99
100		if (stat(path, &sb) < 0)
101		{
102	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
121	<	me.name, source_p->name, topic);
102	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
103		return;
104		}
105
106		if (!S_ISREG(sb.st_mode))
107		{
108	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
128	<	me.name, source_p->name, topic);
108	>	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
109		return;
110		}
111
112		sendhelpfile(source_p, path, topic);
113		}
114
115	<	static void
116	<	sendhelpfile(struct Client *source_p, const char *path, const char *topic)
115	>	/*! \brief HELP command handler
116	>	*
117	>	* \param source_p Pointer to allocated Client struct from which the message
118	>	*                 originally comes from.  This can be a local or remote client.
119	>	* \param parc     Integer holding the number of supplied arguments.
120	>	* \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
121	>	*                 pointers.
122	>	* \note Valid arguments for this command are:
123	>	*      - parv[0] = command
124	>	*      - parv[1] = help topic
125	>	*/
126	>	static int
127	>	m_help(struct Client *source_p, int parc, char *parv[])
128		{
129	<	FILE *file;
139	<	char line[HELPLEN];
140	<
141	<	if ((file = fopen(path, "r")) == NULL)
142	<	{
143	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
144	<	me.name, source_p->name, topic);
145	<	return;
146	<	}
129	>	static time_t last_used = 0;
130
131	<	if (fgets(line, sizeof(line), file) == NULL)
131	>	if ((last_used + ConfigGeneral.pace_wait_simple) > CurrentTime)
132		{
133	<	sendto_one(source_p, form_str(ERR_HELPNOTFOUND),
134	<	me.name, source_p->name, topic);
152	<	return;
133	>	sendto_one_numeric(source_p, &me, RPL_LOAD2HI, "HELP");
134	>	return 0;
135		}
136
137	<	line[strlen(line) - 1] = '\0';
156	<	sendto_one(source_p, form_str(RPL_HELPSTART),
157	<	me.name, source_p->name, topic, line);
158	<
159	<	while (fgets(line, sizeof(line), file))
160	<	{
161	<	line[strlen(line) - 1] = '\0';
162	<
163	<	sendto_one(source_p, form_str(RPL_HELPTXT),
164	<	me.name, source_p->name, topic, line);
165	<	}
137	>	last_used = CurrentTime;
138
139	<	fclose(file);
140	<	sendto_one(source_p, form_str(RPL_ENDOFHELP),
169	<	me.name, source_p->name, topic);
139	>	do_help(source_p, parv[1]);
140	>	return 0;
141		}
142
143	<	static struct Message help_msgtab = {
144	<	"HELP", 0, 0, 0, MAXPARA, MFLG_SLOW, 0,
145	<	{m_unregistered, m_help, m_ignore, m_ignore, mo_help, m_ignore}
146	<	};
143	>	/*! \brief HELP command handler
144	>	*
145	>	* \param source_p Pointer to allocated Client struct from which the message
146	>	*                 originally comes from.  This can be a local or remote client.
147	>	* \param parc     Integer holding the number of supplied arguments.
148	>	* \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
149	>	*                 pointers.
150	>	* \note Valid arguments for this command are:
151	>	*      - parv[0] = command
152	>	*      - parv[1] = help topic
153	>	*/
154	>	static int
155	>	mo_help(struct Client *source_p, int parc, char *parv[])
156	>	{
157	>	do_help(source_p, parv[1]);
158	>	return 0;
159	>	}
160
161	<	static struct Message uhelp_msgtab = {
162	<	"UHELP", 0, 0, 0, MAXPARA, MFLG_SLOW, 0,
163	<	{m_unregistered, m_help, m_ignore, m_ignore, mo_uhelp, m_ignore}
161	>	static struct Message help_msgtab =
162	>	{
163	>	"HELP", NULL, 0, 0, 0, MAXPARA, MFLG_SLOW, 0,
164	>	{ m_unregistered, m_help, m_ignore, m_ignore, mo_help, m_ignore }
165		};
166
167		static void
168		module_init(void)
169		{
170		mod_add_cmd(&help_msgtab);
186	–	mod_add_cmd(&uhelp_msgtab);
171		}
172
173		static void
174		module_exit(void)
175		{
176		mod_del_cmd(&help_msgtab);
193	–	mod_del_cmd(&uhelp_msgtab);
177		}
178
179	<	struct module module_entry = {
179	>	struct module module_entry =
180	>	{
181		.node    = { NULL, NULL, NULL },
182		.name    = NULL,
183		.version = "$Revision$",

Diff Legend

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