1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 * Holds the values for different type of modes
19 * that can exist, USER or CHANNEL type.
30 * Holds mode actions - modes can be allowed or denied.
34 MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
35 MODEACTION_ALLOW = 1 /* Allow the mode */
39 * Used to mask off the mode types in the mode handler
40 * array. Used in a simple two instruction hashing function
41 * "(modeletter - 65) OR mask"
45 MASK_USER = 128, /* A user mode */
46 MASK_CHANNEL = 0 /* A channel mode */
50 * These fixed values can be used to proportionally compare module-defined prefixes to known values.
51 * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
52 * '$', and you dont know what $ means, then you can compare it to these three values to determine
53 * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
54 * status than voice, but lower status than halfop.
55 * No two modes should have equal prefix values.
68 * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
69 * The pair contains an activity flag, true if the mode is set with the given parameter,
70 * and the parameter of the mode (or the parameter provided) in the std::string.
72 typedef std::pair<bool,std::string> ModePair;
74 /** Each mode is implemented by ONE ModeHandler class.
75 * You must derive ModeHandler and add the child class to
76 * the list of modes handled by the ircd, using
77 * ModeParser::AddMode. When the mode you implement is
78 * set by a user, the virtual function OnModeChange is
79 * called. If you specify a value greater than 0 for
80 * parameters_on or parameters_off, then when the mode is
81 * set or unset respectively, std::string ¶meter will
82 * contain the parameter given by the user, else it will
83 * contain an empty string. You may alter this parameter
84 * string, and if you alter it to an empty string, and your
85 * mode is expected to have a parameter, then this is
86 * equivalent to returning MODEACTION_DENY.
88 class CoreExport ModeHandler : public Extensible
92 * Creator/owner pointer
94 InspIRCd* ServerInstance;
96 * The mode letter you're implementing.
100 * Number of parameters when being set
104 * Number of parameters when being unset
108 * Mode is a 'list' mode. The behaviour
109 * of your mode is now set entirely within
110 * the class as of the 1.1 api, rather than
111 * inside the mode parser as in the 1.0 api,
112 * so the only use of this value (along with
113 * IsListMode()) is for the core to determine
114 * wether your module can produce 'lists' or not
115 * (e.g. banlists, etc)
119 * The mode type, either MODETYPE_USER or
124 * True if the mode requires oper status
129 /** Mode prefix, or 0
133 /** Number of items with this mode set on them
139 * The constructor for ModeHandler initalizes the mode handler.
140 * The constructor of any class you derive from ModeHandler should
141 * probably call this constructor with the parameters set correctly.
142 * @param modeletter The mode letter you wish to handle
143 * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
144 * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
145 * @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
146 * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
147 * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
148 * @param mprefix For listmodes where parameters are NICKNAMES which are on the channel (for example, +ohv), you may define a prefix.
149 * When you define a prefix, it can be returned in NAMES, WHO etc if it has the highest value (as returned by GetPrefixRank())
150 * In the core, the only modes to implement prefixes are +ovh (ops, voice, halfop) which define the prefix characters @, % and +
151 * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional
152 * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example.
154 ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0);
156 * The default destructor does nothing
158 virtual ~ModeHandler();
160 * Returns true if the mode is a list mode
164 * Mode prefix or 0. If this is defined, you should
165 * also implement GetPrefixRank() to return an integer
166 * value for this mode prefix.
169 /** Get number of items with this mode set on them
171 virtual unsigned int GetCount();
172 /** Adjust usage count returned by GetCount
174 virtual void ChangeCount(int modifier);
176 * Get the 'value' of this modes prefix.
177 * determines which to display when there are multiple.
178 * The mode with the highest value is ranked first. See the
179 * PrefixModeValue enum and Channel::GetPrefixValue() for
182 virtual unsigned int GetPrefixRank();
184 * Returns the modes type
186 ModeType GetModeType();
188 * Returns true if the mode can only be set/unset by an oper
192 * Returns the number of parameters for the mode. Any non-zero
193 * value should be considered to be equivalent to one.
194 * @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.
195 * @return The number of parameters the mode expects
197 int GetNumParams(bool adding);
199 * Returns the mode character this handler handles.
200 * @return The mode character
205 * Called when a mode change for your mode occurs.
206 * @param source Contains the user setting the mode.
207 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
208 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
209 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
210 * 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
211 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
213 * @param adding This value is true when the mode is being set, or false when it is being unset.
214 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
216 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
218 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
219 * without any parameter or other modes in the command.
220 * @param user The user issuing the command
221 * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
223 virtual void DisplayList(User* user, Channel* channel);
226 * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
227 * @param user The user issuing the command
228 * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
230 virtual void DisplayEmptyList(User* user, Channel* channel);
233 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
234 * override this function and use it to return true or false. The default implementation just returns true if
235 * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
236 * theirs == ours (therefore the default implementation will always return false).
237 * @param theirs The timestamp of the remote side
238 * @param ours The timestamp of the local side
239 * @param their_param Their parameter if the mode has a parameter
240 * @param our_param Our parameter if the mode has a parameter
241 * @param channel The channel we are checking against
242 * @return True if the other side wins the merge, false if we win the merge for this mode.
244 virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel);
247 * When a remote server needs to bounce a set of modes, it will call this method for every mode
248 * in the mode string to determine if the mode is set or not.
249 * @param source of the mode change, this will be NULL for a server mode
250 * @param dest Target user of the mode change, if this is a user mode
251 * @param channel Target channel of the mode change, if this is a channel mode
252 * @param parameter The parameter given for the mode change, or an empty string
253 * @returns The first value of the pair should be true if the mode is set with the given parameter.
254 * In the case of permissions modes such as channelmode +o, this should return true if the user given
255 * as the parameter has the given privilage on the given channel. The string value of the pair will hold
256 * the current setting for this mode set locally, when the bool is true, or, the parameter given.
257 * This allows the local server to enforce our locally set parameters back to a remote server.
259 virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter);
262 * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
263 * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
264 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
265 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
266 * your mode properly from each user.
267 * @param user The user which the server wants to remove your mode from
269 virtual void RemoveMode(User* user);
272 * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
273 * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
274 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
275 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
276 * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
277 * @param channel The channel which the server wants to remove your mode from
279 virtual void RemoveMode(Channel* channel);
283 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
284 * by the core or by another module. To use ModeWatcher, derive a class from it,
285 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
286 * A ModeWatcher will be called both before and after the mode change.
288 class CoreExport ModeWatcher : public Extensible
292 * Creator/owner pointer
294 InspIRCd* ServerInstance;
296 * The mode letter this class is watching
300 * The mode type being watched (user or channel)
306 * The constructor initializes the mode and the mode type
308 ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type);
310 * The default destructor does nothing.
312 virtual ~ModeWatcher();
315 * Get the mode character being watched
316 * @return The mode character being watched
320 * Get the mode type being watched
321 * @return The mode type being watched (user or channel)
323 ModeType GetModeType();
326 * Before the mode character is processed by its handler, this method will be called.
327 * @param source The sender of the mode
328 * @param dest The target user for the mode, if you are watching a user mode
329 * @param channel The target channel for the mode, if you are watching a channel mode
330 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
331 * If you alter the parameter you are given, the mode handler will see your atered version
332 * when it handles the mode.
333 * @param adding True if the mode is being added and false if it is being removed
334 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
335 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
336 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
338 virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type);
340 * After the mode character has been processed by the ModeHandler, this method will be called.
341 * @param source The sender of the mode
342 * @param dest The target user for the mode, if you are watching a user mode
343 * @param channel The target channel for the mode, if you are watching a channel mode
344 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
345 * You cannot alter the parameter here, as the mode handler has already processed it.
346 * @param adding True if the mode is being added and false if it is being removed
347 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
349 virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type);
352 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
354 /** The mode parser handles routing of modes and handling of mode strings.
355 * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
356 * parses client to server MODE strings for user and channel modes, and performs
357 * processing for the 004 mode list numeric, amongst other things.
359 class CoreExport ModeParser : public classbase
363 * Creator/owner pointer
365 InspIRCd* ServerInstance;
366 /** Mode handlers for each mode, to access a handler subtract
367 * 65 from the ascii value of the mode letter.
368 * The upper bit of the value indicates if its a usermode
369 * or a channel mode, so we have 256 of them not 64.
371 ModeHandler* modehandlers[256];
372 /** Mode watcher classes arranged in the same way as the
373 * mode handlers, except for instead of having 256 of them
374 * we have 256 lists of them.
376 std::vector<ModeWatcher*> modewatchers[256];
377 /** Displays the current modes of a channel or user.
378 * Used by ModeParser::Process.
380 void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
382 /** The string representing the last set of modes to be parsed.
383 * Use GetLastParse() to get this value, to be used for display purposes.
385 std::string LastParse;
389 /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
391 ModeParser(InspIRCd* Instance);
393 /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
394 * for example, should 'user A' be able to 'op' on 'channel B'.
396 User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
397 /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
399 const char* Grant(User *d,Channel *chan,int MASK);
400 /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
402 const char* Revoke(User *d,Channel *chan,int MASK);
403 /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
408 * nick!ident -> nick!ident@*
410 * host.name -> *!*@host.name
412 * ident@host.name -> *!ident@host.name
414 * This method can be used on both IPV4 and IPV6 user masks.
416 static void CleanMask(std::string &mask);
417 /** Get the last string to be processed, as it was sent to the user or channel.
418 * Use this to display a string you just sent to be parsed, as the actual output
419 * may be different to what you sent after it has been 'cleaned up' by the parser.
420 * @return Last parsed string, as seen by users.
422 const std::string& GetLastParse();
423 /** Add a mode to the mode parser.
424 * @return True if the mode was successfully added.
426 bool AddMode(ModeHandler* mh);
427 /** Delete a mode from the mode parser.
428 * When a mode is deleted, the mode handler will be called
429 * for every user (if it is a user mode) or for every channel
430 * (if it is a channel mode) to unset the mode on all objects.
431 * This prevents modes staying in the system which no longer exist.
432 * @param mh The mode handler to remove
433 * @return True if the mode was successfully removed.
435 bool DelMode(ModeHandler* mh);
436 /** Add a mode watcher.
437 * A mode watcher is triggered before and after a mode handler is
438 * triggered. See the documentation of class ModeWatcher for more
440 * @param mw The ModeWatcher you want to add
441 * @return True if the ModeWatcher was added correctly
443 bool AddModeWatcher(ModeWatcher* mw);
444 /** Delete a mode watcher.
445 * A mode watcher is triggered before and after a mode handler is
446 * triggered. See the documentation of class ModeWatcher for more
448 * @param mw The ModeWatcher you want to delete
449 * @return True if the ModeWatcher was deleted correctly
451 bool DelModeWatcher(ModeWatcher* mw);
452 /** Process a set of mode changes from a server or user.
453 * @param parameters The parameters of the mode change, in the format
454 * they would be from a MODE command.
455 * @param pcnt The number of items in the parameters array
456 * @param user The user setting or removing the modes. When the modes are set
457 * by a server, an 'uninitialized' User is used, where *user::nick == NULL
458 * and *user->server == NULL.
459 * @param servermode True if a server is setting the mode.
461 void Process(const char** parameters, int pcnt, User *user, bool servermode);
463 /** Find the mode handler for a given mode and type.
464 * @param modeletter mode letter to search for
465 * @param type of mode to search for, user or channel
466 * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
468 ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
470 /** Find a mode handler by its prefix.
471 * If there is no mode handler with the given prefix, NULL will be returned.
472 * @param pfxletter The prefix to find, e.g. '@'
473 * @return The mode handler which handles this prefix, or NULL if there is none.
475 ModeHandler* FindPrefix(unsigned const char pfxletter);
477 /** Returns a list of mode characters which are usermodes.
478 * This is used in the 004 numeric when users connect.
480 std::string UserModeList();
482 /** Returns a list of channel mode characters which are listmodes.
483 * This is used in the 004 numeric when users connect.
485 std::string ChannelModeList();
487 /** Returns a list of channel mode characters which take parameters.
488 * This is used in the 004 numeric when users connect.
490 std::string ParaModeList();
492 /** Generates the CHANMODES= 005 sequence
494 std::string ChanModes();
495 /** Used by this class internally during std::sort and 005 generation
497 static bool PrefixComparison(prefixtype one, prefixtype two);
499 /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
501 std::string BuildPrefixes();
503 /** This returns the privilages of a user upon a channel, in the format of a mode change.
504 * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
505 * This is used by the core when cycling a user to refresh their hostname. You may use it for
507 * @param user The username to look up
508 * @param channel The channel name to look up the privilages of the user for
509 * @return The mode string.
511 std::string ModeString(User* user, Channel* channel);