1 /************************************************************************
2 * IRC - Internet Relay Chat, doc/example_module.c
3 * Copyright (C) 2001 Hybrid Development Team
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)
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.
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.
19 * $Id: example_module.c 3161 2007-01-25 07:23:01Z nenolod $
22 /* List of ircd includes from ../include/ */
30 /* Declare the void's initially up here, as modules dont have an
31 * include file, we will normally have client_p, source_p, parc
34 * client_p == client issuing command
35 * source_p == where the command came from
36 * parc == the number of parameters
37 * parv == an array of the parameters
40 static int munreg_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[]);
41 static int mclient_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[]);
42 static int mserver_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[]);
43 static int mrclient_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[]);
44 static int moper_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[]);
46 /* Show the commands this module can handle in a msgtab
47 * and give the msgtab a name, here its test_msgtab
50 struct Message test_msgtab
= {
51 "TEST", /* the /COMMAND you want */
52 0, /* SET TO ZERO -- number of times command used by clients */
53 0, /* SET TO ZERO -- number of times command used by clients */
54 0, /* SET TO ZERO -- number of times command used by clients */
55 0, /* ALWAYS SET TO 0 */
57 /* the functions to call for each handler. If not using the generic
58 * handlers, the first param is the function to call, the second is the
59 * required number of parameters. NOTE: If you specify a min para of 2,
60 * then parv[1] must *also* be non-empty.
63 {munreg_test
, 0}, /* function call for unregistered clients, 0 parms required */
64 {mclient_test
, 0}, /* function call for local clients, 0 parms required */
65 {mrclient_test
, 0}, /* function call for remote clients, 0 parms required */
66 {mserver_test
, 0}, /* function call for servers, 0 parms required */
67 mg_ignore
, /* function call for ENCAP, unused in this test */
68 {moper_test
, 0} /* function call for operators, 0 parms required */
72 * There are also some macros for the above function calls and parameter counts.
75 * mg_ignore: ignore the command when it comes from certain types
76 * mg_not_oper: tell the client it requires being an operator
77 * mg_reg: prevent the client using this if registered
78 * mg_unreg: prevent the client using this if unregistered
80 * These macros assume a parameter count of zero; you do not set it.
81 * For further details, see include/msg.h
85 /* The mapi_clist_av1 indicates which commands (struct Message)
86 * should be loaded from the module. The list should be terminated
89 mapi_clist_av1 test_clist
[] = { &test_msgtab
, NULL
};
91 /* The mapi_hlist_av1 indicates which hook functions we need to be able to
92 * call. We need to declare an integer, then add the name of the hook
93 * function to call and a pointer to this integer. The list should be
94 * terminated with NULLs.
96 int doing_example_hook
;
97 mapi_hlist_av1 test_hlist
[] = {
98 { "doing_example_hook", &doing_example_hook
, },
102 /* The mapi_hfn_list_av1 declares the hook functions which other modules can
103 * call. The first parameter is the name of the hook, the second is a void
104 * returning function, with arbitrary parameters casted to (hookfn). This
105 * list must be terminated with NULLs.
107 static void show_example_hook(void *unused
);
109 mapi_hfn_list_av1 test_hfnlist
[] = {
110 { "doing_example_hook", (hookfn
) show_example_hook
},
114 /* Here we tell it what to do when the module is loaded */
118 /* Nothing to do for the example module. */
119 /* The init function should return -1 on failure,
120 which will cause the module to be unloaded,
121 otherwise 0 to indicate success. */
125 /* here we tell it what to do when the module is unloaded */
129 /* Again, nothing to do. */
132 /* DECLARE_MODULE_AV1() actually declare the MAPI header. */
134 /* The first argument is the name */
136 /* The second argument is the function to call on load */
138 /* And the function to call on unload */
140 /* Then the MAPI command list */
142 /* Next the hook list, if we have one. */
144 /* Then the hook function list, if we have one */
146 /* And finally the version number of this module. */
147 "$Revision: 3161 $");
149 /* Any of the above arguments can be NULL to indicate they aren't used. */
154 * parv[1] = parameter
157 /* Here we have the functions themselves that we declared above,
158 * and the fairly normal C coding
161 munreg_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
165 sendto_one_notice(source_p
, ":You are unregistered and sent no parameters");
169 sendto_one_notice(source_p
, ":You are unregistered and sent parameter: %s", parv
[1]);
172 /* illustration of how to call a hook function */
173 call_hook(doing_example_hook
, NULL
);
180 * parv[1] = parameter
183 mclient_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
187 sendto_one_notice(source_p
, ":You are a normal user, and sent no parameters");
191 sendto_one_notice(source_p
, ":You are a normal user, and send parameters: %s", parv
[1]);
194 /* illustration of how to call a hook function */
195 call_hook(doing_example_hook
, NULL
);
202 * parv[1] = parameter
205 mrclient_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
209 sendto_one_notice(source_p
, ":You are a remote client, and sent no parameters");
213 sendto_one_notice(source_p
, ":You are a remote client, and sent parameters: %s", parv
[1]);
220 * parv[1] = parameter
223 mserver_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
227 sendto_one_notice(source_p
, ":You are a server, and sent no parameters");
231 sendto_one_notice(source_p
, ":You are a server, and sent parameters: %s", parv
[1]);
238 * parv[1] = parameter
241 moper_test(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
245 sendto_one_notice(source_p
, ":You are an operator, and sent no parameters");
249 sendto_one_notice(source_p
, ":You are an operator, and sent parameters: %s", parv
[1]);
255 show_example_hook(void *unused
)
257 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Called example hook!");
260 /* END OF EXAMPLE MODULE */