]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * ircd-ratbox: A slightly useful ircd. | |
3 | * m_help.c: Provides help information to a user/operator. | |
4 | * | |
5 | * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center | |
6 | * Copyright (C) 1996-2002 Hybrid Development Team | |
7 | * Copyright (C) 2002-2005 ircd-ratbox development team | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation; either version 2 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | |
22 | * USA | |
23 | * | |
24 | * $Id: m_help.c 254 2005-09-21 23:35:12Z nenolod $ | |
25 | */ | |
26 | ||
27 | #include "stdinc.h" | |
28 | #include "client.h" | |
29 | #include "ircd.h" | |
30 | #include "msg.h" | |
31 | #include "numeric.h" | |
32 | #include "send.h" | |
33 | #include "s_conf.h" | |
34 | #include "logger.h" | |
35 | #include "parse.h" | |
36 | #include "modules.h" | |
37 | #include "hash.h" | |
38 | #include "cache.h" | |
39 | #include "irc_dictionary.h" | |
40 | ||
41 | static int m_help(struct Client *, struct Client *, int, const char **); | |
42 | static int mo_help(struct Client *, struct Client *, int, const char **); | |
43 | static int mo_uhelp(struct Client *, struct Client *, int, const char **); | |
44 | static void dohelp(struct Client *, int, const char *); | |
45 | ||
46 | struct Message help_msgtab = { | |
47 | "HELP", 0, 0, 0, MFLG_SLOW, | |
48 | {mg_unreg, {m_help, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_help, 0}} | |
49 | }; | |
50 | struct Message uhelp_msgtab = { | |
51 | "UHELP", 0, 0, 0, MFLG_SLOW, | |
52 | {mg_unreg, {m_help, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_uhelp, 0}} | |
53 | }; | |
54 | ||
55 | mapi_clist_av1 help_clist[] = { &help_msgtab, &uhelp_msgtab, NULL }; | |
56 | DECLARE_MODULE_AV1(help, NULL, NULL, help_clist, NULL, NULL, "$Revision: 254 $"); | |
57 | ||
58 | /* | |
59 | * m_help - HELP message handler | |
60 | * parv[0] = sender prefix | |
61 | */ | |
62 | static int | |
63 | m_help(struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) | |
64 | { | |
65 | dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL); | |
66 | ||
67 | return 0; | |
68 | } | |
69 | ||
70 | /* | |
71 | * mo_help - HELP message handler | |
72 | * parv[0] = sender prefix | |
73 | */ | |
74 | static int | |
75 | mo_help(struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) | |
76 | { | |
77 | dohelp(source_p, HELP_OPER, parc > 1 ? parv[1] : NULL); | |
78 | return 0; | |
79 | } | |
80 | ||
81 | /* | |
82 | * mo_uhelp - HELP message handler | |
83 | * This is used so that opers can view the user help file without deopering | |
84 | * parv[0] = sender prefix | |
85 | */ | |
86 | static int | |
87 | mo_uhelp(struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) | |
88 | { | |
89 | dohelp(source_p, HELP_USER, parc > 1 ? parv[1] : NULL); | |
90 | return 0; | |
91 | } | |
92 | ||
93 | static void | |
94 | dohelp(struct Client *source_p, int flags, const char *topic) | |
95 | { | |
96 | static const char ntopic[] = "index"; | |
97 | struct cachefile *hptr; | |
98 | struct cacheline *lineptr; | |
99 | rb_dlink_node *ptr; | |
100 | rb_dlink_node *fptr; | |
101 | ||
102 | if(EmptyString(topic)) | |
103 | topic = ntopic; | |
104 | ||
105 | hptr = irc_dictionary_retrieve(flags & HELP_OPER ? help_dict_oper : help_dict_user, topic); | |
106 | ||
107 | if(hptr == NULL || !(hptr->flags & flags)) | |
108 | { | |
109 | sendto_one(source_p, form_str(ERR_HELPNOTFOUND), | |
110 | me.name, source_p->name, topic); | |
111 | return; | |
112 | } | |
113 | ||
114 | fptr = hptr->contents.head; | |
115 | lineptr = fptr->data; | |
116 | ||
117 | /* first line cant be empty */ | |
118 | sendto_one(source_p, form_str(RPL_HELPSTART), | |
119 | me.name, source_p->name, topic, lineptr->data); | |
120 | ||
121 | RB_DLINK_FOREACH(ptr, fptr->next) | |
122 | { | |
123 | lineptr = ptr->data; | |
124 | ||
125 | sendto_one(source_p, form_str(RPL_HELPTXT), | |
126 | me.name, source_p->name, topic, lineptr->data); | |
127 | } | |
128 | ||
129 | sendto_one(source_p, form_str(RPL_ENDOFHELP), | |
130 | me.name, source_p->name, topic); | |
131 | return; | |
132 | } |