ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/modules/m_help.c
Revision: 5881
Committed: Sun May 3 16:04:15 2015 UTC (8 years, 10 months ago) by michael
Content type: text/x-csrc
File size: 4744 byte(s)
Log Message:
- Use C99-style initializers in all struct Message items
- Removed MFLG_SLOW
- Removed DUMMY_HANDLER

File Contents

# Content
1 /*
2 * ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3 *
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
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 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
19 * USA
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"
28 #include "client.h"
29 #include "ircd.h"
30 #include "numeric.h"
31 #include "send.h"
32 #include "conf.h"
33 #include "parse.h"
34 #include "modules.h"
35 #include "irc_string.h"
36
37 #define HELPLEN 400
38
39
40 static void
41 sendhelpfile(struct Client *source_p, const char *path, const char *topic)
42 {
43 FILE *file = NULL;
44 char *p = NULL;
45 char line[HELPLEN] = "";
46
47 if ((file = fopen(path, "r")) == NULL)
48 {
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_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
56 fclose(file);
57 return;
58 }
59
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 if ((p = strpbrk(line, "\r\n")))
68 *p = '\0';
69
70 sendto_one_numeric(source_p, &me, RPL_HELPTXT, topic, line);
71 }
72
73 fclose(file);
74 sendto_one_numeric(source_p, &me, RPL_ENDOFHELP, topic);
75 }
76
77 static void
78 do_help(struct Client *source_p, char *topic)
79 {
80 char h_index[] = "index";
81 char path[HYB_PATH_MAX + 1];
82 struct stat sb;
83
84 if (EmptyString(topic))
85 topic = h_index;
86 else
87 for (char *p = topic; *p; ++p)
88 *p = ToLower(*p);
89
90 if (strpbrk(topic, "/\\"))
91 {
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_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
99 return;
100 }
101
102 snprintf(path, sizeof(path), "%s/%s", HPATH, topic);
103
104 if (stat(path, &sb) < 0)
105 {
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_numeric(source_p, &me, ERR_HELPNOTFOUND, topic);
113 return;
114 }
115
116 sendhelpfile(source_p, path, topic);
117 }
118
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 int
131 m_help(struct Client *source_p, int parc, char *parv[])
132 {
133 static time_t last_used = 0;
134
135 if ((last_used + ConfigGeneral.pace_wait_simple) > CurrentTime)
136 {
137 sendto_one_numeric(source_p, &me, RPL_LOAD2HI, "HELP");
138 return 0;
139 }
140
141 last_used = CurrentTime;
142
143 do_help(source_p, parv[1]);
144 return 0;
145 }
146
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 int
159 mo_help(struct Client *source_p, int parc, char *parv[])
160 {
161 do_help(source_p, parv[1]);
162 return 0;
163 }
164
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
177 module_init(void)
178 {
179 mod_add_cmd(&help_msgtab);
180 }
181
182 static void
183 module_exit(void)
184 {
185 mod_del_cmd(&help_msgtab);
186 }
187
188 struct module module_entry =
189 {
190 .version = "$Revision$",
191 .modinit = module_init,
192 .modexit = module_exit,
193 };

Properties

Name Value
svn:eol-style native
svn:keywords Id Revision