1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
20 /* include the common header files */
32 * Holds the values for different type of modes
33 * that can exist, USER or CHANNEL type.
41 * Holds mode actions - modes can be allowed or denied.
44 MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
45 MODEACTION_ALLOW = 1 /* Allow the mode */
49 * Used to mask off the mode types in the mode handler
50 * array. Used in a simple two instruction hashing function
51 * "(modeletter - 65) OR mask"
54 MASK_USER = 128, /* A user mode */
55 MASK_CHANNEL = 0 /* A channel mode */
58 /** Each mode is implemented by ONE ModeHandler class.
59 * You must derive ModeHandler and add the child class to
60 * the list of modes handled by the ircd, using
61 * ModeParser::AddMode. When the mode you implement is
62 * set by a user, the virtual function OnModeChange is
63 * called. If you specify a value greater than 0 for
64 * parameters_on or parameters_off, then when the mode is
65 * set or unset respectively, std::string ¶meter will
66 * contain the parameter given by the user, else it will
67 * contain an empty string. You may alter this parameter
68 * string, and if you alter it to an empty string, and your
69 * mode is expected to have a parameter, then this is
70 * equivalent to returning MODEACTION_DENY.
72 class ModeHandler : public Extensible
76 * The mode letter you're implementing.
80 * Number of parameters when being set
84 * Number of parameters when being unset
88 * Mode is a 'list' mode. The behaviour
89 * of your mode is now set entirely within
90 * the class as of the 1.1 api, rather than
91 * inside the mode parser as in the 1.0 api,
92 * so the only use of this value (along with
93 * IsListMode()) is for the core to determine
94 * wether your module can produce 'lists' or not
95 * (e.g. banlists, etc)
99 * The mode type, either MODETYPE_USER or
104 * True if the mode requires oper status
111 * The constructor for ModeHandler initalizes the mode handler.
112 * The constructor of any class you derive from ModeHandler should
113 * probably call this constructor with the parameters set correctly.
114 * @param modeletter The mode letter you wish to handle
115 * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
116 * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
117 * @param listmode Set to true if your mode is a listmode, e.g. it will respond to MODE #channel +modechar with a list of items
118 * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
119 * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
121 ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
123 * The default destructor does nothing
125 virtual ~ModeHandler();
128 * Returns true if the mode is a list mode
132 * Returns the modes type
134 ModeType GetModeType();
136 * Returns true if the mode can only be set/unset by an oper
140 * Returns the number of parameters for the mode. Any non-zero
141 * value should be considered to be equivalent to one.
142 * @param adding If this is true, the number of parameters required to set the mode should be returned, otherwise the number of parameters required to unset the mode shall be returned.
143 * @return The number of parameters the mode expects
145 int GetNumParams(bool adding);
147 * Returns the mode character this handler handles.
148 * @return The mode character
153 * Called when a mode change for your mode occurs.
154 * @param source Contains the user setting the mode.
155 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
156 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
157 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
158 * if you alter this value, the new value becomes the one displayed and send out to the network, also, if you set this to an empty string
159 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
161 * @param adding This value is true when the mode is being set, or false when it is being unset.
162 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
164 virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
166 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
167 * without any parameter or other modes in the command.
168 * @param user The user issuing the command
169 * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
171 virtual void DisplayList(userrec* user, chanrec* channel);
173 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
174 * override this function and use it to return true or false. The default implementation just returns true if
176 * @param theirs The timestamp of the remote side
177 * @param ours The timestamp of the local side
178 * @param their_param Their parameter if the mode has a parameter
179 * @param our_param Our parameter if the mode has a parameter
180 * @param channel The channel we are checking against
181 * @return True if the other side wins the merge, false if we win the merge for this mode.
183 virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel);
187 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
188 * by the core or by another module. To use ModeWatcher, derive a class from it,
189 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
190 * A ModeWatcher will be called both before and after the mode change.
192 class ModeWatcher : public Extensible
196 * The mode letter this class is watching
200 * The mode type being watched (user or channel)
206 * The constructor initializes the mode and the mode type
208 ModeWatcher(char modeletter, ModeType type);
210 * The default destructor does nothing.
212 virtual ~ModeWatcher();
215 * Get the mode character being watched
216 * @return The mode character being watched
220 * Get the mode type being watched
221 * @return The mode type being watched (user or channel)
223 ModeType GetModeType();
226 * Before the mode character is processed by its handler, this method will be called.
227 * @param source The sender of the mode
228 * @param dest The target user for the mode, if you are watching a user mode
229 * @param channel The target channel for the mode, if you are watching a channel mode
230 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
231 * If you alter the parameter you are given, the mode handler will see your atered version
232 * when it handles the mode.
233 * @param adding True if the mode is being added and false if it is being removed
234 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
235 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
236 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
238 virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding, ModeType type);
240 * After the mode character has been processed by the ModeHandler, this method will be called.
241 * @param source The sender of the mode
242 * @param dest The target user for the mode, if you are watching a user mode
243 * @param channel The target channel for the mode, if you are watching a channel mode
244 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
245 * You cannot alter the parameter here, as the mode handler has already processed it.
246 * @param adding True if the mode is being added and false if it is being removed
247 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
249 virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter, bool adding, ModeType type);
252 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
254 class ModeParser : public classbase
258 * Mode handlers for each mode, to access a handler subtract
259 * 65 from the ascii value of the mode letter.
260 * The upper bit of the value indicates if its a usermode
261 * or a channel mode, so we have 256 of them not 64.
263 ModeHandler* modehandlers[256];
265 * Mode watcher classes arranged in the same way as the
266 * mode handlers, except for instead of having 256 of them
267 * we have 256 lists of them.
269 std::vector<ModeWatcher*> modewatchers[256];
271 * Displays the current modes of a channel or user.
272 * Used by ModeParser::Process.
274 void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text);
279 * The constructor initializes all the RFC basic modes by using ModeParserAddMode().
284 * Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
285 * for example, should 'user A' be able to 'op' on 'channel B'.
287 static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
289 * Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
291 static const char* Grant(userrec *d,chanrec *chan,int MASK);
293 * Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
295 static const char* Revoke(userrec *d,chanrec *chan,int MASK);
297 * Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
302 * nick!ident -> nick!ident@*
304 * host.name -> *!*@host.name
306 * ident@host.name -> *!ident@host.name
308 * This method can be used on both IPV4 and IPV6 user masks.
310 static void CleanMask(std::string &mask);
312 * Add a mode to the mode parser. The modeletter parameter
313 * is purely to save on doing a lookup in the function, as
314 * strictly it could be obtained via ModeHandler::GetModeChar().
315 * @return True if the mode was successfully added.
317 bool AddMode(ModeHandler* mh, unsigned const char modeletter);
319 * Add a mode watcher.
320 * A mode watcher is triggered before and after a mode handler is
321 * triggered. See the documentation of class ModeWatcher for more
323 * @param mw The ModeWatcher you want to add
324 * @return True if the ModeWatcher was added correctly
326 bool AddModeWatcher(ModeWatcher* mw);
328 * Delete a mode watcher.
329 * A mode watcher is triggered before and after a mode handler is
330 * triggered. See the documentation of class ModeWatcher for more
332 * @param mw The ModeWatcher you want to delete
333 * @return True if the ModeWatcher was deleted correctly
335 bool DelModeWatcher(ModeWatcher* mw);
337 * Process a set of mode changes from a server or user.
338 * @param parameters The parameters of the mode change, in the format
339 * they would be from a MODE command.
340 * @param pcnt The number of items in the parameters array
341 * @param user The user setting or removing the modes. When the modes are set
342 * by a server, an 'uninitialized' userrec is used, where *user::nick == NULL
343 * and *user->server == NULL.
344 * @param servermode True if a server is setting the mode.
346 void Process(char **parameters, int pcnt, userrec *user, bool servermode);
350 * Command handler class for the MODE command.
351 * put here for completeness.
353 class cmd_mode : public command_t
357 * Standard constructor
359 cmd_mode () : command_t("MODE",0,1) { }
363 void Handle(char **parameters, int pcnt, userrec *user);