8.2.x/modules/m_help.c

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 1999-2016 ircd-hybrid 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
 */

/*! \file m_help.c
 * \brief Includes required functions for processing the HELP command.
 * \version $Id$
 */

#include "stdinc.h"
#include "client.h"
#include "ircd.h"
#include "numeric.h"
#include "send.h"
#include "conf.h"
#include "parse.h"
#include "modules.h"
#include "irc_string.h"


enum { HELPLEN = 400 };

static void
sendhelpfile(struct Client *source_p, const char *path, const char *topic)
{
  FILE *file = NULL;
  char *p = NULL;
  char line[HELPLEN] = "";

  if ((file = fopen(path, "r")) == NULL)
  {
    sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
    return;
  }

  if (fgets(line, sizeof(line), file) == NULL)
  {
    sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
    fclose(file);
    return;
  }

  if ((p = strpbrk(line, "\r\n")))
    *p = '\0';

  sendto_one_numeric(source_p, &me, RPL_HELPSTART, topic, line);

  while (fgets(line, sizeof(line), file))
  {
    if ((p = strpbrk(line, "\r\n")))
      *p = '\0';

    sendto_one_numeric(source_p, &me, RPL_HELPTXT, topic, line);
  }

  fclose(file);
  sendto_one_numeric(source_p, &me, RPL_ENDOFHELP, topic);
}

static void
do_help(struct Client *source_p, char *topic)
{
  char h_index[] = "index";
  struct stat sb;

  if (EmptyString(topic))
    topic = h_index;
  else
    for (char *p = topic; *p; ++p)
      *p = ToLower(*p);

  if (strpbrk(topic, "/\\"))
  {
    sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
    return;
  }

  char path[sizeof(HPATH) + strlen(topic) + 1];  /* +1 for / */
  snprintf(path, sizeof(path), "%s/%s", HPATH, topic);

  if (stat(path, &sb) < 0)
  {
    sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
    return;
  }

  if (!S_ISREG(sb.st_mode))
  {
    sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
    return;
  }

  sendhelpfile(source_p, path, topic);
}

/*! \brief HELP command handler
 *
 * \param source_p Pointer to allocated Client struct from which the message
 *                 originally comes from.  This can be a local or remote client.
 * \param parc     Integer holding the number of supplied arguments.
 * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
 *                 pointers.
 * \note Valid arguments for this command are:
 *      - parv[0] = command
 *      - parv[1] = help topic
 */
static int
m_help(struct Client *source_p, int parc, char *parv[])
{
  static time_t last_used = 0;

  if ((last_used + ConfigGeneral.pace_wait_simple) > CurrentTime)
  {
    sendto_one_numeric(source_p, &me, RPL_LOAD2HI, "HELP");
    return 0;
  }

  last_used = CurrentTime;

  do_help(source_p, parv[1]);
  return 0;
}

/*! \brief HELP command handler
 *
 * \param source_p Pointer to allocated Client struct from which the message
 *                 originally comes from.  This can be a local or remote client.
 * \param parc     Integer holding the number of supplied arguments.
 * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
 *                 pointers.
 * \note Valid arguments for this command are:
 *      - parv[0] = command
 *      - parv[1] = help topic
 */
static int
mo_help(struct Client *source_p, int parc, char *parv[])
{
  do_help(source_p, parv[1]);
  return 0;
}

static struct Message help_msgtab =
{
  .cmd = "HELP",
  .args_max = MAXPARA,
  .handlers[UNREGISTERED_HANDLER] = m_unregistered,
  .handlers[CLIENT_HANDLER] = m_help,
  .handlers[SERVER_HANDLER] = m_ignore,
  .handlers[ENCAP_HANDLER] = m_ignore,
  .handlers[OPER_HANDLER] = mo_help
};

static void
module_init(void)
{
  mod_add_cmd(&help_msgtab);
}

static void
module_exit(void)
{
  mod_del_cmd(&help_msgtab);
}

struct module module_entry =
{
  .version = "$Revision$",
  .modinit = module_init,
  .modexit = module_exit,
};
Revision:	7007
Committed:	Fri Jan 1 00:09:08 2016 UTC (10 years, 6 months ago) by michael
Content type:	text/x-csrc
File size:	4640 byte(s)
Log Message:	- Update copyright years
#	User	Rev	Content
1	adx	30	/*
2	michael	2820	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	adx	30	*
4	michael	7007	* Copyright (c) 1999-2016 ircd-hybrid development team
5	adx	30	*
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
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
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	michael	4564	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19	adx	30	* USA
20			*/
21
22	michael	2820	/*! \file m_help.c
23			* \brief Includes required functions for processing the HELP command.
24			* \version $Id$
25			*/
26
27	adx	30	#include "stdinc.h"
28			#include "client.h"
29			#include "ircd.h"
30			#include "numeric.h"
31			#include "send.h"
32	michael	1309	#include "conf.h"
33	adx	30	#include "parse.h"
34			#include "modules.h"
35			#include "irc_string.h"
36
37
38	michael	6349	enum { HELPLEN = 400 };
39	adx	30
40	michael	2972	static void
41	michael	1997	sendhelpfile(struct Client source_p, const char path, const char *topic)
42	adx	30	{
43	michael	2028	FILE *file = NULL;
44	michael	5770	char *p = NULL;
45	michael	4268	char line[HELPLEN] = "";
46	adx	30
47	michael	1997	if ((file = fopen(path, "r")) == NULL)
48	adx	30	{
49	michael	3109	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
50	michael	2972	return;
51	adx	30	}
52
53	michael	1997	if (fgets(line, sizeof(line), file) == NULL)
54			{
55	michael	3109	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
56	michael	2657	fclose(file);
57	michael	2972	return;
58	michael	1997	}
59	adx	30
60	michael	5770	if ((p = strpbrk(line, "\r\n")))
61			*p = '\0';
62
63	michael	3109	sendto_one_numeric(source_p, &me, RPL_HELPSTART, topic, line);
64	adx	30
65	michael	1997	while (fgets(line, sizeof(line), file))
66			{
67	michael	5770	if ((p = strpbrk(line, "\r\n")))
68			*p = '\0';
69	adx	30
70	michael	3109	sendto_one_numeric(source_p, &me, RPL_HELPTXT, topic, line);
71	michael	1997	}
72
73			fclose(file);
74	michael	3109	sendto_one_numeric(source_p, &me, RPL_ENDOFHELP, topic);
75	adx	30	}
76
77	michael	2972	static void
78			do_help(struct Client source_p, char topic)
79	adx	30	{
80	michael	575	char h_index[] = "index";
81	adx	30	struct stat sb;
82
83	michael	1674	if (EmptyString(topic))
84			topic = h_index;
85	adx	30	else
86	michael	4268	for (char p = topic; p; ++p)
87	michael	2045	p = ToLower(p);
88	adx	30
89			if (strpbrk(topic, "/\\"))
90			{
91	michael	3109	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
92	michael	2972	return;
93	adx	30	}
94
95	michael	6997	char path[sizeof(HPATH) + strlen(topic) + 1]; /* +1 for / */
96	michael	2028	snprintf(path, sizeof(path), "%s/%s", HPATH, topic);
97	adx	30
98			if (stat(path, &sb) < 0)
99			{
100	michael	3109	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
101	michael	2972	return;
102	adx	30	}
103
104			if (!S_ISREG(sb.st_mode))
105			{
106	michael	3109	sendto_one_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
107	michael	2972	return;
108	adx	30	}
109
110	michael	2972	sendhelpfile(source_p, path, topic);
111	adx	30	}
112
113	michael	3266	/*! \brief HELP command handler
114			*
115			* \param source_p Pointer to allocated Client struct from which the message
116			* originally comes from. This can be a local or remote client.
117			* \param parc Integer holding the number of supplied arguments.
118			* \param parv Argument vector where parv[0] .. parv[parc-1] are non-NULL
119			* pointers.
120			* \note Valid arguments for this command are:
121			* - parv[0] = command
122			* - parv[1] = help topic
123	michael	1997	*/
124	michael	2820	static int
125	michael	3156	m_help(struct Client source_p, int parc, char parv[])
126	adx	30	{
127	michael	1997	static time_t last_used = 0;
128	adx	30
129	michael	4341	if ((last_used + ConfigGeneral.pace_wait_simple) > CurrentTime)
130	adx	30	{
131	michael	4758	sendto_one_numeric(source_p, &me, RPL_LOAD2HI, "HELP");
132	michael	2820	return 0;
133	adx	30	}
134
135	michael	1997	last_used = CurrentTime;
136	adx	30
137	michael	2972	do_help(source_p, parv[1]);
138			return 0;
139	michael	1997	}
140	adx	30
141	michael	3266	/*! \brief HELP command handler
142			*
143			* \param source_p Pointer to allocated Client struct from which the message
144			* originally comes from. This can be a local or remote client.
145			* \param parc Integer holding the number of supplied arguments.
146			* \param parv Argument vector where parv[0] .. parv[parc-1] are non-NULL
147			* pointers.
148			* \note Valid arguments for this command are:
149			* - parv[0] = command
150			* - parv[1] = help topic
151	michael	1997	*/
152	michael	2820	static int
153	michael	3156	mo_help(struct Client source_p, int parc, char parv[])
154	michael	1997	{
155	michael	2972	do_help(source_p, parv[1]);
156			return 0;
157	michael	1997	}
158	michael	1674
159	michael	2820	static struct Message help_msgtab =
160			{
161	michael	5880	.cmd = "HELP",
162			.args_max = MAXPARA,
163			.handlers[UNREGISTERED_HANDLER] = m_unregistered,
164			.handlers[CLIENT_HANDLER] = m_help,
165			.handlers[SERVER_HANDLER] = m_ignore,
166			.handlers[ENCAP_HANDLER] = m_ignore,
167			.handlers[OPER_HANDLER] = mo_help
168	michael	1230	};
169
170			static void
171			module_init(void)
172			{
173			mod_add_cmd(&help_msgtab);
174			}
175
176			static void
177			module_exit(void)
178			{
179			mod_del_cmd(&help_msgtab);
180			}
181
182	michael	2820	struct module module_entry =
183			{
184	michael	1230	.version = "$Revision$",
185			.modinit = module_init,
186			.modexit = module_exit,
187			};