2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2004-2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 * Holds the values for different type of modes
29 * that can exist, USER or CHANNEL type.
40 * 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"
55 MASK_USER = 128, /* A user mode */
56 MASK_CHANNEL = 0 /* A channel mode */
60 * These fixed values can be used to proportionally compare module-defined prefixes to known values.
61 * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
62 * '$', and you dont know what $ means, then you can compare it to these three values to determine
63 * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
64 * status than voice, but lower status than halfop.
65 * No two modes should have equal prefix values.
81 /** Parameter required on mode setting only */
83 /** Parameter always required */
87 /** Each mode is implemented by ONE ModeHandler class.
88 * You must derive ModeHandler and add the child class to
89 * the list of modes handled by the ircd, using
90 * ModeParser::AddMode. When the mode you implement is
91 * set by a user, the virtual function OnModeChange is
92 * called. If you specify a value greater than 0 for
93 * parameters_on or parameters_off, then when the mode is
94 * set or unset respectively, std::string ¶meter will
95 * contain the parameter given by the user, else it will
96 * contain an empty string. You may alter this parameter
97 * string, and if you alter it to an empty string, and your
98 * mode is expected to have a parameter, then this is
99 * equivalent to returning MODEACTION_DENY.
101 class CoreExport ModeHandler : public ServiceProvider
104 * Removes this prefix mode from all users on the given channel
105 * @param channel The channel which the server wants to remove your mode from
106 * @param stack The mode stack to add the mode change to
108 void RemovePrefixMode(Channel* chan, irc::modestacker& stack);
112 * The mode parameter translation type
114 TranslateType m_paramtype;
116 /** What kind of parameters does the mode take?
118 ParamSpec parameters_taken;
121 * The mode letter you're implementing.
125 /** Mode prefix, or 0
130 * True if the mode requires oper status
136 * Mode is a 'list' mode. The behaviour
137 * of your mode is now set entirely within
138 * the class as of the 1.1 api, rather than
139 * inside the mode parser as in the 1.0 api,
140 * so the only use of this value (along with
141 * IsListMode()) is for the core to determine
142 * wether your module can produce 'lists' or not
143 * (e.g. banlists, etc)
148 * The mode type, either MODETYPE_USER or
153 /** The prefix char needed on channel to use this mode,
154 * only checked for channel modes
158 /** The prefix rank of this mode, used to compare prefix
161 unsigned int prefixrank;
165 * The constructor for ModeHandler initalizes the mode handler.
166 * The constructor of any class you derive from ModeHandler should
167 * probably call this constructor with the parameters set correctly.
168 * @param me The module which created this mode
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 CullResult cull();
176 virtual ~ModeHandler();
178 * Returns true if the mode is a list mode
180 bool IsListMode() const { return list; }
182 * Mode prefix or 0. If this is defined, you should
183 * also implement GetPrefixRank() to return an integer
184 * value for this mode prefix.
186 inline char GetPrefix() const { return prefix; }
188 * Get the 'value' of this modes prefix.
189 * determines which to display when there are multiple.
190 * The mode with the highest value is ranked first. See the
191 * PrefixModeValue enum and Channel::GetPrefixValue() for
194 unsigned int GetPrefixRank() const { return prefixrank; }
196 * Returns the mode's type
198 inline ModeType GetModeType() const { return m_type; }
200 * Returns the mode's parameter translation type
202 inline TranslateType GetTranslateType() const { return m_paramtype; }
204 * Returns true if the mode can only be set/unset by an oper
206 inline bool NeedsOper() const { return oper; }
208 * Returns the number of parameters for the mode. Any non-zero
209 * value should be considered to be equivalent to one.
210 * @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.
211 * @return The number of parameters the mode expects
213 int GetNumParams(bool adding);
215 * Returns the mode character this handler handles.
216 * @return The mode character
218 inline char GetModeChar() { return mode; }
220 /** For user modes, return the current parameter, if any
222 virtual std::string GetUserParameter(User* useor);
225 * Called when a channel mode change access check for your mode occurs.
226 * @param source Contains the user setting the mode.
227 * @param channel contains the destination channel the modes are being set on.
228 * @param parameter The parameter for your mode. This is modifiable.
229 * @param adding This value is true when the mode is being set, or false when it is being unset.
230 * @return allow, deny, or passthru to check against the required level
232 virtual ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding);
235 * Called when a mode change for your mode occurs.
236 * @param source Contains the user setting the mode.
237 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
238 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
239 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
240 * 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
241 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
243 * @param adding This value is true when the mode is being set, or false when it is being unset.
244 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
246 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
248 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE \#channel +modechar
249 * without any parameter or other modes in the command.
250 * @param user The user issuing the command
251 * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
253 virtual void DisplayList(User* user, Channel* channel);
255 /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
256 * This allows you to give special information to the user, or handle this any way you like.
257 * @param user The user issuing the mode change
258 * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
259 * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
261 virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
264 * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
265 * @param user The user issuing the command
266 * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
268 virtual void DisplayEmptyList(User* user, Channel* channel);
271 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
272 * override this function and use it to return true or false. The default implementation just returns true if
273 * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
274 * theirs == ours (therefore the default implementation will always return false).
275 * @param their_param Their parameter if the mode has a parameter
276 * @param our_param Our parameter if the mode has a parameter
277 * @param channel The channel we are checking against
278 * @return True if the other side wins the merge, false if we win the merge for this mode.
280 virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
283 * When a MODETYPE_USER mode handler is being removed, the core will call this method for every user on the server.
284 * The usermode will be removed using the appropiate server mode using InspIRCd::SendMode().
285 * @param user The user which the server wants to remove your mode from
287 void RemoveMode(User* user);
290 * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
291 * The mode handler has to populate the given modestacker with mode changes that remove the mode from the channel.
292 * The default implementation of this method can remove all kinds of channel modes except listmodes.
293 * In the case of listmodes, the entire list of items must be added to the modestacker (which is handled by ListModeBase,
294 * so if you inherit from it or your mode can be removed by the default implementation then you do not have to implement
296 * @param channel The channel which the server wants to remove your mode from
297 * @param stack The mode stack to add the mode change to
299 virtual void RemoveMode(Channel* channel, irc::modestacker& stack);
301 inline unsigned int GetLevelRequired() const { return levelrequired; }
304 /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
305 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
306 * is already set and not allowing it to be unset if it is already unset.
307 * An example of a simple user mode is user mode +w.
309 class CoreExport SimpleUserModeHandler : public ModeHandler
312 SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter)
313 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {}
314 virtual ~SimpleUserModeHandler() {}
315 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
318 /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
319 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
320 * is already set and not allowing it to be unset if it is already unset.
321 * An example of a simple channel mode is channel mode +s.
323 class CoreExport SimpleChannelModeHandler : public ModeHandler
326 SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
327 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {}
328 virtual ~SimpleChannelModeHandler() {}
329 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
332 class CoreExport ParamChannelModeHandler : public ModeHandler
335 ParamChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
336 : ModeHandler(Creator, Name, modeletter, PARAM_SETONLY, MODETYPE_CHANNEL) {}
337 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
338 /** Validate the parameter - you may change the value to normalize it. Return true if it is valid. */
339 virtual bool ParamValidate(std::string& parameter);
343 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
344 * by the core or by another module. To use ModeWatcher, derive a class from it,
345 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
346 * A ModeWatcher will be called both before and after the mode change.
348 class CoreExport ModeWatcher : public classbase
352 * The mode name this class is watching
354 const std::string mode;
357 * The mode type being watched (user or channel)
364 * The constructor initializes the mode and the mode type
366 ModeWatcher(Module* creator, const std::string& modename, ModeType type);
368 * The default destructor does nothing.
370 virtual ~ModeWatcher();
373 * Get the mode name being watched
374 * @return The mode name being watched
376 const std::string& GetModeName() const { return mode; }
379 * Get the mode type being watched
380 * @return The mode type being watched (user or channel)
382 ModeType GetModeType();
385 * Before the mode character is processed by its handler, this method will be called.
386 * @param source The sender of the mode
387 * @param dest The target user for the mode, if you are watching a user mode
388 * @param channel The target channel for the mode, if you are watching a channel mode
389 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
390 * If you alter the parameter you are given, the mode handler will see your atered version
391 * when it handles the mode.
392 * @param adding True if the mode is being added and false if it is being removed
393 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
394 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
396 virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string& parameter, bool adding);
398 * After the mode character has been processed by the ModeHandler, this method will be called.
399 * @param source The sender of the mode
400 * @param dest The target user for the mode, if you are watching a user mode
401 * @param channel The target channel for the mode, if you are watching a channel mode
402 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
403 * You cannot alter the parameter here, as the mode handler has already processed it.
404 * @param adding True if the mode is being added and false if it is being removed
406 virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string& parameter, bool adding);
409 typedef std::multimap<std::string, ModeWatcher*>::iterator ModeWatchIter;
411 /** The mode parser handles routing of modes and handling of mode strings.
412 * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
413 * parses client to server MODE strings for user and channel modes, and performs
414 * processing for the 004 mode list numeric, amongst other things.
416 class CoreExport ModeParser
419 /** Mode handlers for each mode, to access a handler subtract
420 * 65 from the ascii value of the mode letter.
421 * The upper bit of the value indicates if its a usermode
422 * or a channel mode, so we have 256 of them not 64.
424 ModeHandler* modehandlers[256];
426 /** Mode watcher classes
428 std::multimap<std::string, ModeWatcher*> modewatchermap;
430 /** Displays the current modes of a channel or user.
431 * Used by ModeParser::Process.
433 void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
434 /** Displays the value of a list mode
435 * Used by ModeParser::Process.
437 void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence);
440 * Attempts to apply a mode change to a user or channel
442 ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string ¶m, bool SkipACL);
444 /** Returns a list of user or channel mode characters.
445 * Used for constructing the parts of the mode list in the 004 numeric.
446 * @param mt Controls whether to list user modes or channel modes
447 * @param needparam Return modes only if they require a parameter to be set
448 * @return The available mode letters that satisfy the given conditions
450 std::string CreateModeList(ModeType mt, bool needparam = false);
452 /** Recreate the cached mode list that is displayed in the 004 numeric
453 * in Cached004ModeList.
454 * Called when a mode handler is added or removed.
456 void RecreateModeListFor004Numeric();
458 /** The string representing the last set of modes to be parsed.
459 * Use GetLastParse() to get this value, to be used for display purposes.
461 std::string LastParse;
462 std::vector<std::string> LastParseParams;
463 std::vector<TranslateType> LastParseTranslate;
465 unsigned int sent[256];
469 /** Cached mode list for use in 004 numeric
471 std::string Cached004ModeList;
477 /** Initialize all built-in modes
479 static void InitBuiltinModes();
481 /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
486 * nick!ident -> nick!ident@*
488 * host.name -> *!*\@host.name
490 * ident@host.name -> *!ident\@host.name
492 * This method can be used on both IPV4 and IPV6 user masks.
494 static void CleanMask(std::string &mask);
495 /** Get the last string to be processed, as it was sent to the user or channel.
496 * Use this to display a string you just sent to be parsed, as the actual output
497 * may be different to what you sent after it has been 'cleaned up' by the parser.
498 * @return Last parsed string, as seen by users.
500 const std::string& GetLastParse() const { return LastParse; }
501 const std::vector<std::string>& GetLastParseParams() { return LastParseParams; }
502 const std::vector<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
503 /** Add a mode to the mode parser.
504 * @return True if the mode was successfully added.
506 bool AddMode(ModeHandler* mh);
507 /** Delete a mode from the mode parser.
508 * When a mode is deleted, the mode handler will be called
509 * for every user (if it is a user mode) or for every channel
510 * (if it is a channel mode) to unset the mode on all objects.
511 * This prevents modes staying in the system which no longer exist.
512 * @param mh The mode handler to remove
513 * @return True if the mode was successfully removed.
515 bool DelMode(ModeHandler* mh);
517 /** Add a mode watcher.
518 * A mode watcher is triggered before and after a mode handler is
519 * triggered. See the documentation of class ModeWatcher for more
521 * @param mw The ModeWatcher you want to add
523 void AddModeWatcher(ModeWatcher* mw);
525 /** Delete a mode watcher.
526 * A mode watcher is triggered before and after a mode handler is
527 * triggered. See the documentation of class ModeWatcher for more
529 * @param mw The ModeWatcher you want to delete
530 * @return True if the ModeWatcher was deleted correctly
532 bool DelModeWatcher(ModeWatcher* mw);
533 /** Process a set of mode changes from a server or user.
534 * @param parameters The parameters of the mode change, in the format
535 * they would be from a MODE command.
536 * @param user The user setting or removing the modes. When the modes are set
537 * by a server, an 'uninitialized' User is used, where *user\::nick == NULL
538 * and *user->server == NULL.
539 * @param merge Should the mode parameters be merged?
541 void Process(const std::vector<std::string>& parameters, User *user, bool merge = false);
543 /** Find the mode handler for a given mode and type.
544 * @param modeletter mode letter to search for
545 * @param mt type of mode to search for, user or channel
546 * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
548 ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
550 /** Find a mode handler by its prefix.
551 * If there is no mode handler with the given prefix, NULL will be returned.
552 * @param pfxletter The prefix to find, e.g. '@'
553 * @return The mode handler which handles this prefix, or NULL if there is none.
555 ModeHandler* FindPrefix(unsigned const char pfxletter);
557 /** Returns a list of modes, space seperated by type:
560 * 3. Channel modes that require a parameter when set
561 * This is sent to users as the last part of the 004 numeric
563 const std::string& GetModeListFor004Numeric();
565 /** Generates a list of modes, comma seperated by type:
566 * 1; Listmodes EXCEPT those with a prefix
567 * 2; Modes that take a param when adding or removing
568 * 3; Modes that only take a param when adding
569 * 4; Modes that dont take a param
571 std::string GiveModeList(ModeMasks m);
573 /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or
574 * just the "@%+" part if the parameter false
576 std::string BuildPrefixes(bool lettersAndModes = true);
579 inline const std::string& ModeParser::GetModeListFor004Numeric()
581 return Cached004ModeList;