]>
Commit | Line | Data |
---|---|---|
212380e3 AC |
1 | /************************************************************************ |
2 | * IRC - Internet Relay Chat, doc/example_module.c | |
3 | * Copyright (C) 2001 Hybrid Development Team | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; either version 1, or (at your option) | |
8 | * any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this program; if not, write to the Free Software | |
17 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
212380e3 AC |
18 | */ |
19 | ||
20 | /* List of ircd includes from ../include/ */ | |
21 | #include "stdinc.h" | |
22 | #include "modules.h" | |
23 | #include "hook.h" | |
24 | #include "client.h" | |
25 | #include "ircd.h" | |
26 | #include "send.h" | |
27 | ||
28 | /* Declare the void's initially up here, as modules dont have an | |
29 | * include file, we will normally have client_p, source_p, parc | |
30 | * and parv[] where: | |
31 | * | |
32 | * client_p == client issuing command | |
33 | * source_p == where the command came from | |
34 | * parc == the number of parameters | |
35 | * parv == an array of the parameters | |
36 | */ | |
37 | ||
760bafda AC |
38 | static int munreg_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]); |
39 | static int mclient_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]); | |
40 | static int mserver_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]); | |
41 | static int mrclient_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]); | |
42 | static int moper_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]); | |
212380e3 AC |
43 | |
44 | /* Show the commands this module can handle in a msgtab | |
45 | * and give the msgtab a name, here its test_msgtab | |
46 | */ | |
47 | ||
48 | struct Message test_msgtab = { | |
49 | "TEST", /* the /COMMAND you want */ | |
50 | 0, /* SET TO ZERO -- number of times command used by clients */ | |
51 | 0, /* SET TO ZERO -- number of times command used by clients */ | |
52 | 0, /* SET TO ZERO -- number of times command used by clients */ | |
7baa37a9 | 53 | 0, /* ALWAYS SET TO 0 */ |
212380e3 AC |
54 | |
55 | /* the functions to call for each handler. If not using the generic | |
56 | * handlers, the first param is the function to call, the second is the | |
57 | * required number of parameters. NOTE: If you specify a min para of 2, | |
58 | * then parv[1] must *also* be non-empty. | |
59 | */ | |
60 | { | |
61 | {munreg_test, 0}, /* function call for unregistered clients, 0 parms required */ | |
62 | {mclient_test, 0}, /* function call for local clients, 0 parms required */ | |
63 | {mrclient_test, 0}, /* function call for remote clients, 0 parms required */ | |
64 | {mserver_test, 0}, /* function call for servers, 0 parms required */ | |
65 | mg_ignore, /* function call for ENCAP, unused in this test */ | |
66 | {moper_test, 0} /* function call for operators, 0 parms required */ | |
67 | } | |
68 | }; | |
69 | /* | |
70 | * There are also some macros for the above function calls and parameter counts. | |
71 | * Here's a list: | |
72 | * | |
73 | * mg_ignore: ignore the command when it comes from certain types | |
74 | * mg_not_oper: tell the client it requires being an operator | |
75 | * mg_reg: prevent the client using this if registered | |
76 | * mg_unreg: prevent the client using this if unregistered | |
77 | * | |
78 | * These macros assume a parameter count of zero; you do not set it. | |
79 | * For further details, see include/msg.h | |
80 | */ | |
81 | ||
82 | ||
83 | /* The mapi_clist_av1 indicates which commands (struct Message) | |
84 | * should be loaded from the module. The list should be terminated | |
85 | * by a NULL. | |
86 | */ | |
87 | mapi_clist_av1 test_clist[] = { &test_msgtab, NULL }; | |
88 | ||
89 | /* The mapi_hlist_av1 indicates which hook functions we need to be able to | |
90 | * call. We need to declare an integer, then add the name of the hook | |
91 | * function to call and a pointer to this integer. The list should be | |
92 | * terminated with NULLs. | |
93 | */ | |
94 | int doing_example_hook; | |
55abcbb2 | 95 | mapi_hlist_av1 test_hlist[] = { |
212380e3 AC |
96 | { "doing_example_hook", &doing_example_hook, }, |
97 | { NULL, NULL } | |
98 | }; | |
99 | ||
100 | /* The mapi_hfn_list_av1 declares the hook functions which other modules can | |
101 | * call. The first parameter is the name of the hook, the second is a void | |
102 | * returning function, with arbitrary parameters casted to (hookfn). This | |
103 | * list must be terminated with NULLs. | |
104 | */ | |
105 | static void show_example_hook(void *unused); | |
106 | ||
107 | mapi_hfn_list_av1 test_hfnlist[] = { | |
108 | { "doing_example_hook", (hookfn) show_example_hook }, | |
109 | { NULL, NULL } | |
110 | }; | |
111 | ||
112 | /* Here we tell it what to do when the module is loaded */ | |
113 | static int | |
114 | modinit(void) | |
115 | { | |
116 | /* Nothing to do for the example module. */ | |
117 | /* The init function should return -1 on failure, | |
118 | which will cause the module to be unloaded, | |
119 | otherwise 0 to indicate success. */ | |
120 | return 0; | |
121 | } | |
122 | ||
123 | /* here we tell it what to do when the module is unloaded */ | |
124 | static void | |
125 | moddeinit(void) | |
126 | { | |
127 | /* Again, nothing to do. */ | |
128 | } | |
129 | ||
130 | /* DECLARE_MODULE_AV1() actually declare the MAPI header. */ | |
131 | DECLARE_MODULE_AV1( | |
132 | /* The first argument is the name */ | |
133 | example, | |
134 | /* The second argument is the function to call on load */ | |
135 | modinit, | |
136 | /* And the function to call on unload */ | |
137 | moddeinit, | |
138 | /* Then the MAPI command list */ | |
139 | test_clist, | |
140 | /* Next the hook list, if we have one. */ | |
141 | test_hlist, | |
142 | /* Then the hook function list, if we have one */ | |
143 | test_hfnlist, | |
144 | /* And finally the version number of this module. */ | |
04f832b7 | 145 | NULL); |
212380e3 AC |
146 | |
147 | /* Any of the above arguments can be NULL to indicate they aren't used. */ | |
148 | ||
149 | ||
150 | /* | |
151 | * mr_test | |
212380e3 AC |
152 | * parv[1] = parameter |
153 | */ | |
154 | ||
155 | /* Here we have the functions themselves that we declared above, | |
156 | * and the fairly normal C coding | |
157 | */ | |
158 | static int | |
760bafda | 159 | munreg_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) |
212380e3 AC |
160 | { |
161 | if(parc < 2) | |
162 | { | |
5366977b | 163 | sendto_one_notice(source_p, ":You are unregistered and sent no parameters"); |
212380e3 AC |
164 | } |
165 | else | |
166 | { | |
5366977b | 167 | sendto_one_notice(source_p, ":You are unregistered and sent parameter: %s", parv[1]); |
212380e3 AC |
168 | } |
169 | ||
170 | /* illustration of how to call a hook function */ | |
171 | call_hook(doing_example_hook, NULL); | |
172 | ||
173 | return 0; | |
174 | } | |
175 | ||
176 | /* | |
177 | * mclient_test | |
212380e3 AC |
178 | * parv[1] = parameter |
179 | */ | |
180 | static int | |
760bafda | 181 | mclient_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) |
212380e3 AC |
182 | { |
183 | if(parc < 2) | |
184 | { | |
5366977b | 185 | sendto_one_notice(source_p, ":You are a normal user, and sent no parameters"); |
212380e3 AC |
186 | } |
187 | else | |
188 | { | |
5366977b | 189 | sendto_one_notice(source_p, ":You are a normal user, and send parameters: %s", parv[1]); |
212380e3 AC |
190 | } |
191 | ||
192 | /* illustration of how to call a hook function */ | |
193 | call_hook(doing_example_hook, NULL); | |
194 | ||
195 | return 0; | |
196 | } | |
197 | ||
198 | /* | |
199 | * mrclient_test | |
212380e3 AC |
200 | * parv[1] = parameter |
201 | */ | |
202 | static int | |
760bafda | 203 | mrclient_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) |
212380e3 AC |
204 | { |
205 | if(parc < 2) | |
206 | { | |
5366977b | 207 | sendto_one_notice(source_p, ":You are a remote client, and sent no parameters"); |
212380e3 AC |
208 | } |
209 | else | |
210 | { | |
5366977b | 211 | sendto_one_notice(source_p, ":You are a remote client, and sent parameters: %s", parv[1]); |
212380e3 AC |
212 | } |
213 | return 0; | |
214 | } | |
215 | ||
216 | /* | |
217 | * mserver_test | |
212380e3 AC |
218 | * parv[1] = parameter |
219 | */ | |
220 | static int | |
760bafda | 221 | mserver_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) |
212380e3 AC |
222 | { |
223 | if(parc < 2) | |
224 | { | |
5366977b | 225 | sendto_one_notice(source_p, ":You are a server, and sent no parameters"); |
212380e3 AC |
226 | } |
227 | else | |
228 | { | |
5366977b | 229 | sendto_one_notice(source_p, ":You are a server, and sent parameters: %s", parv[1]); |
212380e3 AC |
230 | } |
231 | return 0; | |
232 | } | |
233 | ||
234 | /* | |
235 | * moper_test | |
212380e3 AC |
236 | * parv[1] = parameter |
237 | */ | |
238 | static int | |
760bafda | 239 | moper_test(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) |
212380e3 AC |
240 | { |
241 | if(parc < 2) | |
242 | { | |
5366977b | 243 | sendto_one_notice(source_p, ":You are an operator, and sent no parameters"); |
212380e3 AC |
244 | } |
245 | else | |
246 | { | |
5366977b | 247 | sendto_one_notice(source_p, ":You are an operator, and sent parameters: %s", parv[1]); |
212380e3 AC |
248 | } |
249 | return 0; | |
250 | } | |
251 | ||
252 | static void | |
253 | show_example_hook(void *unused) | |
254 | { | |
255 | sendto_realops_snomask(SNO_GENERAL, L_ALL, "Called example hook!"); | |
256 | } | |
257 | ||
258 | /* END OF EXAMPLE MODULE */ |