1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 /* Forward declarations. */
24 * Holds the values for different type of modes
25 * that can exist, USER or CHANNEL type.
36 * Holds mode actions - modes can be allowed or denied.
40 MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
41 MODEACTION_ALLOW = 1 /* Allow the mode */
45 * Used to mask off the mode types in the mode handler
46 * array. Used in a simple two instruction hashing function
47 * "(modeletter - 65) OR mask"
51 MASK_USER = 128, /* A user mode */
52 MASK_CHANNEL = 0 /* A channel mode */
56 * These fixed values can be used to proportionally compare module-defined prefixes to known values.
57 * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
58 * '$', and you dont know what $ means, then you can compare it to these three values to determine
59 * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
60 * status than voice, but lower status than halfop.
61 * No two modes should have equal prefix values.
77 /** Parameter required on mode setting only */
79 /** Parameter always required */
84 * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
85 * The pair contains an activity flag, true if the mode is set with the given parameter,
86 * and the parameter of the mode (or the parameter provided) in the std::string.
88 typedef std::pair<bool,std::string> ModePair;
90 /** Each mode is implemented by ONE ModeHandler class.
91 * You must derive ModeHandler and add the child class to
92 * the list of modes handled by the ircd, using
93 * ModeParser::AddMode. When the mode you implement is
94 * set by a user, the virtual function OnModeChange is
95 * called. If you specify a value greater than 0 for
96 * parameters_on or parameters_off, then when the mode is
97 * set or unset respectively, std::string ¶meter will
98 * contain the parameter given by the user, else it will
99 * contain an empty string. You may alter this parameter
100 * string, and if you alter it to an empty string, and your
101 * mode is expected to have a parameter, then this is
102 * equivalent to returning MODEACTION_DENY.
104 class CoreExport ModeHandler : public classbase
108 * The mode parameter translation type
110 TranslateType m_paramtype;
112 /** What kind of parameters does the mode take?
114 ParamSpec parameters_taken;
117 * The mode letter you're implementing.
121 /** Mode prefix, or 0
126 * True if the mode requires oper status
132 * Mode is a 'list' mode. The behaviour
133 * of your mode is now set entirely within
134 * the class as of the 1.1 api, rather than
135 * inside the mode parser as in the 1.0 api,
136 * so the only use of this value (along with
137 * IsListMode()) is for the core to determine
138 * wether your module can produce 'lists' or not
139 * (e.g. banlists, etc)
144 * The mode type, either MODETYPE_USER or
149 /** Number of items with this mode set on them
153 /** The prefix char needed on channel to use this mode,
154 * only checked for channel modes
159 /** Module that created this mode. NULL for core modes */
160 Module* const creator;
163 const std::string name;
166 * The constructor for ModeHandler initalizes the mode handler.
167 * The constructor of any class you derive from ModeHandler should
168 * probably call this constructor with the parameters set correctly.
169 * @param name A one-word name for the mode
170 * @param modeletter The mode letter you wish to handle
171 * @param params Parameters taken by the mode
172 * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL)
174 ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type);
175 virtual ~ModeHandler();
177 * Returns true if the mode is a list mode
181 * Mode prefix or 0. If this is defined, you should
182 * also implement GetPrefixRank() to return an integer
183 * value for this mode prefix.
185 inline char GetPrefix() const { return prefix; }
186 /** Get number of items with this mode set on them
188 virtual unsigned int GetCount();
189 /** Adjust usage count returned by GetCount
191 virtual void ChangeCount(int modifier);
193 * Get the 'value' of this modes prefix.
194 * determines which to display when there are multiple.
195 * The mode with the highest value is ranked first. See the
196 * PrefixModeValue enum and Channel::GetPrefixValue() for
199 virtual unsigned int GetPrefixRank();
201 * Returns the mode's type
203 inline ModeType GetModeType() const { return m_type; }
205 * Returns the mode's parameter translation type
207 inline TranslateType GetTranslateType() const { return m_paramtype; }
209 * Returns true if the mode can only be set/unset by an oper
211 inline bool NeedsOper() const { return oper; }
213 * Returns the number of parameters for the mode. Any non-zero
214 * value should be considered to be equivalent to one.
215 * @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.
216 * @return The number of parameters the mode expects
218 int GetNumParams(bool adding);
220 * Returns the mode character this handler handles.
221 * @return The mode character
225 /** For user modes, return the current parameter, if any
227 virtual std::string GetUserParameter(User* useor);
230 * Called when a channel mode change access check for your mode occurs.
231 * @param source Contains the user setting the mode.
232 * @param channel contains the destination channel the modes are being set on.
233 * @param parameter The parameter for your mode. This is modifiable.
234 * @param adding This value is true when the mode is being set, or false when it is being unset.
235 * @return allow, deny, or passthru to check against the required level
237 virtual ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding);
240 * Called when a mode change for your mode occurs.
241 * @param source Contains the user setting the mode.
242 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
243 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
244 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
245 * 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
246 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
248 * @param adding This value is true when the mode is being set, or false when it is being unset.
249 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
251 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
253 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
254 * without any parameter or other modes in the command.
255 * @param user The user issuing the command
256 * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
258 virtual void DisplayList(User* user, Channel* channel);
260 /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
261 * This allows you to give special information to the user, or handle this any way you like.
262 * @param user The user issuing the mode change
263 * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
264 * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
266 virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
269 * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
270 * @param user The user issuing the command
271 * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
273 virtual void DisplayEmptyList(User* user, Channel* channel);
276 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
277 * override this function and use it to return true or false. The default implementation just returns true if
278 * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
279 * theirs == ours (therefore the default implementation will always return false).
280 * @param their_param Their parameter if the mode has a parameter
281 * @param our_param Our parameter if the mode has a parameter
282 * @param channel The channel we are checking against
283 * @return True if the other side wins the merge, false if we win the merge for this mode.
285 virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
288 * When a remote server needs to bounce a set of modes, it will call this method for every mode
289 * in the mode string to determine if the mode is set or not.
290 * @param source of the mode change, this will be NULL for a server mode
291 * @param dest Target user of the mode change, if this is a user mode
292 * @param channel Target channel of the mode change, if this is a channel mode
293 * @param parameter The parameter given for the mode change, or an empty string
294 * @returns The first value of the pair should be true if the mode is set with the given parameter.
295 * In the case of permissions modes such as channelmode +o, this should return true if the user given
296 * as the parameter has the given privilage on the given channel. The string value of the pair will hold
297 * the current setting for this mode set locally, when the bool is true, or, the parameter given.
298 * This allows the local server to enforce our locally set parameters back to a remote server.
300 virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter);
303 * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
304 * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
305 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
306 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
307 * your mode properly from each user.
308 * @param user The user which the server wants to remove your mode from
310 virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
313 * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
314 * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
315 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
316 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
317 * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
318 * @param channel The channel which the server wants to remove your mode from
320 virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
322 inline unsigned int GetLevelRequired() const { return levelrequired; }
325 /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
326 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
327 * is already set and not allowing it to be unset if it is already unset.
328 * An example of a simple user mode is user mode +w.
330 class CoreExport SimpleUserModeHandler : public ModeHandler
333 SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter)
334 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {}
335 virtual ~SimpleUserModeHandler() {}
336 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
339 /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
340 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
341 * is already set and not allowing it to be unset if it is already unset.
342 * An example of a simple channel mode is channel mode +s.
344 class CoreExport SimpleChannelModeHandler : public ModeHandler
347 SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
348 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {}
349 virtual ~SimpleChannelModeHandler() {}
350 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
354 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
355 * by the core or by another module. To use ModeWatcher, derive a class from it,
356 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
357 * A ModeWatcher will be called both before and after the mode change.
359 class CoreExport ModeWatcher : public classbase
363 * The mode letter this class is watching
367 * The mode type being watched (user or channel)
372 Module* const creator;
374 * The constructor initializes the mode and the mode type
376 ModeWatcher(Module* creator, char modeletter, ModeType type);
378 * The default destructor does nothing.
380 virtual ~ModeWatcher();
383 * Get the mode character being watched
384 * @return The mode character being watched
388 * Get the mode type being watched
389 * @return The mode type being watched (user or channel)
391 ModeType GetModeType();
394 * Before the mode character is processed by its handler, this method will be called.
395 * @param source The sender of the mode
396 * @param dest The target user for the mode, if you are watching a user mode
397 * @param channel The target channel for the mode, if you are watching a channel mode
398 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
399 * If you alter the parameter you are given, the mode handler will see your atered version
400 * when it handles the mode.
401 * @param adding True if the mode is being added and false if it is being removed
402 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
403 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
404 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
406 virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type);
408 * After the mode character has been processed by the ModeHandler, this method will be called.
409 * @param source The sender of the mode
410 * @param dest The target user for the mode, if you are watching a user mode
411 * @param channel The target channel for the mode, if you are watching a channel mode
412 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
413 * You cannot alter the parameter here, as the mode handler has already processed it.
414 * @param adding True if the mode is being added and false if it is being removed
415 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
417 virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type);
420 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
422 /** The mode parser handles routing of modes and handling of mode strings.
423 * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
424 * parses client to server MODE strings for user and channel modes, and performs
425 * processing for the 004 mode list numeric, amongst other things.
427 class CoreExport ModeParser : public classbase
430 /** Mode handlers for each mode, to access a handler subtract
431 * 65 from the ascii value of the mode letter.
432 * The upper bit of the value indicates if its a usermode
433 * or a channel mode, so we have 256 of them not 64.
435 ModeHandler* modehandlers[256];
436 /** Mode watcher classes arranged in the same way as the
437 * mode handlers, except for instead of having 256 of them
438 * we have 256 lists of them.
440 std::vector<ModeWatcher*> modewatchers[256];
441 /** Displays the current modes of a channel or user.
442 * Used by ModeParser::Process.
444 void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
445 /** Displays the value of a list mode
446 * Used by ModeParser::Process.
448 void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence);
451 * Attempts to apply a mode change to a user or channel
453 ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string ¶m, bool SkipACL);
455 /** The string representing the last set of modes to be parsed.
456 * Use GetLastParse() to get this value, to be used for display purposes.
458 std::string LastParse;
459 std::vector<std::string> LastParseParams;
460 std::vector<TranslateType> LastParseTranslate;
462 unsigned int sent[256];
468 /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
473 /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
474 * for example, should 'user A' be able to 'op' on 'channel B'.
476 User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
477 /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
482 * nick!ident -> nick!ident@*
484 * host.name -> *!*@host.name
486 * ident@host.name -> *!ident@host.name
488 * This method can be used on both IPV4 and IPV6 user masks.
490 static void CleanMask(std::string &mask);
491 /** Get the last string to be processed, as it was sent to the user or channel.
492 * Use this to display a string you just sent to be parsed, as the actual output
493 * may be different to what you sent after it has been 'cleaned up' by the parser.
494 * @return Last parsed string, as seen by users.
496 const std::string& GetLastParse();
497 const std::vector<std::string>& GetLastParseParams() { return LastParseParams; }
498 const std::vector<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
499 /** Add a mode to the mode parser.
500 * @return True if the mode was successfully added.
502 bool AddMode(ModeHandler* mh);
503 /** Delete a mode from the mode parser.
504 * When a mode is deleted, the mode handler will be called
505 * for every user (if it is a user mode) or for every channel
506 * (if it is a channel mode) to unset the mode on all objects.
507 * This prevents modes staying in the system which no longer exist.
508 * @param mh The mode handler to remove
509 * @return True if the mode was successfully removed.
511 bool DelMode(ModeHandler* mh);
513 /** Delete all modes and mode watchers associated with a given module
515 void RemoveModes(Module* mod);
516 /** Add a mode watcher.
517 * A mode watcher is triggered before and after a mode handler is
518 * triggered. See the documentation of class ModeWatcher for more
520 * @param mw The ModeWatcher you want to add
521 * @return True if the ModeWatcher was added correctly
523 bool AddModeWatcher(ModeWatcher* mw);
524 /** Delete a mode watcher.
525 * A mode watcher is triggered before and after a mode handler is
526 * triggered. See the documentation of class ModeWatcher for more
528 * @param mw The ModeWatcher you want to delete
529 * @return True if the ModeWatcher was deleted correctly
531 bool DelModeWatcher(ModeWatcher* mw);
532 /** Process a set of mode changes from a server or user.
533 * @param parameters The parameters of the mode change, in the format
534 * they would be from a MODE command.
535 * @param user The user setting or removing the modes. When the modes are set
536 * by a server, an 'uninitialized' User is used, where *user::nick == NULL
537 * and *user->server == NULL.
539 void Process(const std::vector<std::string>& parameters, User *user, bool merge = false);
541 /** Find the mode handler for a given mode and type.
542 * @param modeletter mode letter to search for
543 * @param type of mode to search for, user or channel
544 * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
546 ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
548 /** Find a mode handler by its prefix.
549 * If there is no mode handler with the given prefix, NULL will be returned.
550 * @param pfxletter The prefix to find, e.g. '@'
551 * @return The mode handler which handles this prefix, or NULL if there is none.
553 ModeHandler* FindPrefix(unsigned const char pfxletter);
555 /** Returns a list of mode characters which are usermodes.
556 * This is used in the 004 numeric when users connect.
558 std::string UserModeList();
560 /** Returns a list of channel mode characters which are listmodes.
561 * This is used in the 004 numeric when users connect.
563 std::string ChannelModeList();
565 /** Returns a list of channel mode characters which take parameters.
566 * This is used in the 004 numeric when users connect.
568 std::string ParaModeList();
570 /** Generates a list of modes, comma seperated by type:
571 * 1; Listmodes EXCEPT those with a prefix
572 * 2; Modes that take a param when adding or removing
573 * 3; Modes that only take a param when adding
574 * 4; Modes that dont take a param
576 std::string GiveModeList(ModeMasks m);
578 static bool PrefixComparison(ModeHandler* one, ModeHandler* two);
580 /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
582 std::string BuildPrefixes();
584 /** This returns the privilages of a user upon a channel, in the format of a mode change.
585 * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
586 * This is used by the core when cycling a user to refresh their hostname. You may use it for
588 * @param user The username to look up
589 * @param channel The channel name to look up the privilages of the user for
590 * @param nick_suffix true (the default) if you want nicknames in the mode string, for easy
591 * use with the mode stacker, false if you just want the "avh" part of "avh nick nick nick".
592 * @return The mode string.
594 std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);