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
105 * The mode parameter translation type
107 TranslateType m_paramtype;
109 /** What kind of parameters does the mode take?
111 ParamSpec parameters_taken;
114 * The mode letter you're implementing.
118 /** Mode prefix, or 0
123 * True if the mode requires oper status
129 * Mode is a 'list' mode. The behaviour
130 * of your mode is now set entirely within
131 * the class as of the 1.1 api, rather than
132 * inside the mode parser as in the 1.0 api,
133 * so the only use of this value (along with
134 * IsListMode()) is for the core to determine
135 * wether your module can produce 'lists' or not
136 * (e.g. banlists, etc)
141 * The mode type, either MODETYPE_USER or
146 /** The prefix char needed on channel to use this mode,
147 * only checked for channel modes
153 * The constructor for ModeHandler initalizes the mode handler.
154 * The constructor of any class you derive from ModeHandler should
155 * probably call this constructor with the parameters set correctly.
156 * @param me The module which created this mode
157 * @param name A one-word name for the mode
158 * @param modeletter The mode letter you wish to handle
159 * @param params Parameters taken by the mode
160 * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL)
162 ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type);
163 virtual CullResult cull();
164 virtual ~ModeHandler();
166 * Returns true if the mode is a list mode
170 * Mode prefix or 0. If this is defined, you should
171 * also implement GetPrefixRank() to return an integer
172 * value for this mode prefix.
174 inline char GetPrefix() const { return prefix; }
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 mode's type
186 inline ModeType GetModeType() const { return m_type; }
188 * Returns the mode's parameter translation type
190 inline TranslateType GetTranslateType() const { return m_paramtype; }
192 * Returns true if the mode can only be set/unset by an oper
194 inline bool NeedsOper() const { return oper; }
196 * Returns the number of parameters for the mode. Any non-zero
197 * value should be considered to be equivalent to one.
198 * @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.
199 * @return The number of parameters the mode expects
201 int GetNumParams(bool adding);
203 * Returns the mode character this handler handles.
204 * @return The mode character
206 inline char GetModeChar() { return mode; }
208 /** For user modes, return the current parameter, if any
210 virtual std::string GetUserParameter(User* useor);
213 * Called when a channel mode change access check for your mode occurs.
214 * @param source Contains the user setting the mode.
215 * @param channel contains the destination channel the modes are being set on.
216 * @param parameter The parameter for your mode. This is modifiable.
217 * @param adding This value is true when the mode is being set, or false when it is being unset.
218 * @return allow, deny, or passthru to check against the required level
220 virtual ModResult AccessCheck(User* source, Channel* channel, std::string ¶meter, bool adding);
223 * Called when a mode change for your mode occurs.
224 * @param source Contains the user setting the mode.
225 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
226 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
227 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
228 * 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
229 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
231 * @param adding This value is true when the mode is being set, or false when it is being unset.
232 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
234 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
236 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE \#channel +modechar
237 * without any parameter or other modes in the command.
238 * @param user The user issuing the command
239 * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
241 virtual void DisplayList(User* user, Channel* channel);
243 /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
244 * This allows you to give special information to the user, or handle this any way you like.
245 * @param user The user issuing the mode change
246 * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
247 * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
249 virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
252 * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
253 * @param user The user issuing the command
254 * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
256 virtual void DisplayEmptyList(User* user, Channel* channel);
259 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
260 * override this function and use it to return true or false. The default implementation just returns true if
261 * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
262 * theirs == ours (therefore the default implementation will always return false).
263 * @param their_param Their parameter if the mode has a parameter
264 * @param our_param Our parameter if the mode has a parameter
265 * @param channel The channel we are checking against
266 * @return True if the other side wins the merge, false if we win the merge for this mode.
268 virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
271 * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
272 * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
273 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
274 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
275 * your mode properly from each user.
276 * @param user The user which the server wants to remove your mode from
277 * @param stack The mode stack to add the mode change to
279 virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
282 * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
283 * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
284 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
285 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
286 * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
287 * @param channel The channel which the server wants to remove your mode from
288 * @param stack The mode stack to add the mode change to
290 virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
292 inline unsigned int GetLevelRequired() const { return levelrequired; }
295 /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
296 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
297 * is already set and not allowing it to be unset if it is already unset.
298 * An example of a simple user mode is user mode +w.
300 class CoreExport SimpleUserModeHandler : public ModeHandler
303 SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter)
304 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {}
305 virtual ~SimpleUserModeHandler() {}
306 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
309 /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
310 * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
311 * is already set and not allowing it to be unset if it is already unset.
312 * An example of a simple channel mode is channel mode +s.
314 class CoreExport SimpleChannelModeHandler : public ModeHandler
317 SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
318 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {}
319 virtual ~SimpleChannelModeHandler() {}
320 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
323 class CoreExport ParamChannelModeHandler : public ModeHandler
326 ParamChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
327 : ModeHandler(Creator, Name, modeletter, PARAM_SETONLY, MODETYPE_CHANNEL) {}
328 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding);
329 /** Validate the parameter - you may change the value to normalize it. Return true if it is valid. */
330 virtual bool ParamValidate(std::string& parameter);
334 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
335 * by the core or by another module. To use ModeWatcher, derive a class from it,
336 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
337 * A ModeWatcher will be called both before and after the mode change.
339 class CoreExport ModeWatcher : public classbase
343 * The mode letter this class is watching
347 * The mode type being watched (user or channel)
354 * The constructor initializes the mode and the mode type
356 ModeWatcher(Module* creator, char modeletter, ModeType type);
358 * The default destructor does nothing.
360 virtual ~ModeWatcher();
363 * Get the mode character being watched
364 * @return The mode character being watched
368 * Get the mode type being watched
369 * @return The mode type being watched (user or channel)
371 ModeType GetModeType();
374 * Before the mode character is processed by its handler, this method will be called.
375 * @param source The sender of the mode
376 * @param dest The target user for the mode, if you are watching a user mode
377 * @param channel The target channel for the mode, if you are watching a channel mode
378 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
379 * If you alter the parameter you are given, the mode handler will see your atered version
380 * when it handles the mode.
381 * @param adding True if the mode is being added and false if it is being removed
382 * @param type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
383 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
384 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
386 virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type);
388 * After the mode character has been processed by the ModeHandler, this method will be called.
389 * @param source The sender of the mode
390 * @param dest The target user for the mode, if you are watching a user mode
391 * @param channel The target channel for the mode, if you are watching a channel mode
392 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
393 * You cannot alter the parameter here, as the mode handler has already processed it.
394 * @param adding True if the mode is being added and false if it is being removed
395 * @param type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
397 virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type);
400 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
402 /** The mode parser handles routing of modes and handling of mode strings.
403 * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
404 * parses client to server MODE strings for user and channel modes, and performs
405 * processing for the 004 mode list numeric, amongst other things.
407 class CoreExport ModeParser
410 /** Mode handlers for each mode, to access a handler subtract
411 * 65 from the ascii value of the mode letter.
412 * The upper bit of the value indicates if its a usermode
413 * or a channel mode, so we have 256 of them not 64.
415 ModeHandler* modehandlers[256];
416 /** Mode watcher classes arranged in the same way as the
417 * mode handlers, except for instead of having 256 of them
418 * we have 256 lists of them.
420 std::vector<ModeWatcher*> modewatchers[256];
421 /** Displays the current modes of a channel or user.
422 * Used by ModeParser::Process.
424 void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
425 /** Displays the value of a list mode
426 * Used by ModeParser::Process.
428 void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence);
431 * Attempts to apply a mode change to a user or channel
433 ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string ¶m, bool SkipACL);
435 /** The string representing the last set of modes to be parsed.
436 * Use GetLastParse() to get this value, to be used for display purposes.
438 std::string LastParse;
439 std::vector<std::string> LastParseParams;
440 std::vector<TranslateType> LastParseTranslate;
442 unsigned int sent[256];
450 /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
451 * for example, should 'user A' be able to 'op' on 'channel B'.
453 User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
455 /** Initialize all built-in modes
457 static void InitBuiltinModes();
459 /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
464 * nick!ident -> nick!ident@*
466 * host.name -> *!*\@host.name
468 * ident@host.name -> *!ident\@host.name
470 * This method can be used on both IPV4 and IPV6 user masks.
472 static void CleanMask(std::string &mask);
473 /** Get the last string to be processed, as it was sent to the user or channel.
474 * Use this to display a string you just sent to be parsed, as the actual output
475 * may be different to what you sent after it has been 'cleaned up' by the parser.
476 * @return Last parsed string, as seen by users.
478 const std::string& GetLastParse();
479 const std::vector<std::string>& GetLastParseParams() { return LastParseParams; }
480 const std::vector<TranslateType>& GetLastParseTranslate() { return LastParseTranslate; }
481 /** Add a mode to the mode parser.
482 * @return True if the mode was successfully added.
484 bool AddMode(ModeHandler* mh);
485 /** Delete a mode from the mode parser.
486 * When a mode is deleted, the mode handler will be called
487 * for every user (if it is a user mode) or for every channel
488 * (if it is a channel mode) to unset the mode on all objects.
489 * This prevents modes staying in the system which no longer exist.
490 * @param mh The mode handler to remove
491 * @return True if the mode was successfully removed.
493 bool DelMode(ModeHandler* mh);
495 /** Add a mode watcher.
496 * A mode watcher is triggered before and after a mode handler is
497 * triggered. See the documentation of class ModeWatcher for more
499 * @param mw The ModeWatcher you want to add
500 * @return True if the ModeWatcher was added correctly
502 bool AddModeWatcher(ModeWatcher* mw);
503 /** Delete a mode watcher.
504 * A mode watcher is triggered before and after a mode handler is
505 * triggered. See the documentation of class ModeWatcher for more
507 * @param mw The ModeWatcher you want to delete
508 * @return True if the ModeWatcher was deleted correctly
510 bool DelModeWatcher(ModeWatcher* mw);
511 /** Process a set of mode changes from a server or user.
512 * @param parameters The parameters of the mode change, in the format
513 * they would be from a MODE command.
514 * @param user The user setting or removing the modes. When the modes are set
515 * by a server, an 'uninitialized' User is used, where *user\::nick == NULL
516 * and *user->server == NULL.
517 * @param merge Should the mode parameters be merged?
519 void Process(const std::vector<std::string>& parameters, User *user, bool merge = false);
521 /** Find the mode handler for a given mode and type.
522 * @param modeletter mode letter to search for
523 * @param mt type of mode to search for, user or channel
524 * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
526 ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
528 /** Find a mode handler by its prefix.
529 * If there is no mode handler with the given prefix, NULL will be returned.
530 * @param pfxletter The prefix to find, e.g. '@'
531 * @return The mode handler which handles this prefix, or NULL if there is none.
533 ModeHandler* FindPrefix(unsigned const char pfxletter);
535 /** Returns a list of mode characters which are usermodes.
536 * This is used in the 004 numeric when users connect.
538 std::string UserModeList();
540 /** Returns a list of channel mode characters which are listmodes.
541 * This is used in the 004 numeric when users connect.
543 std::string ChannelModeList();
545 /** Returns a list of channel mode characters which take parameters.
546 * This is used in the 004 numeric when users connect.
548 std::string ParaModeList();
550 /** Generates a list of modes, comma seperated by type:
551 * 1; Listmodes EXCEPT those with a prefix
552 * 2; Modes that take a param when adding or removing
553 * 3; Modes that only take a param when adding
554 * 4; Modes that dont take a param
556 std::string GiveModeList(ModeMasks m);
558 static bool PrefixComparison(ModeHandler* one, ModeHandler* two);
560 /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric, or
561 * just the "@%+" part if the parameter false
563 std::string BuildPrefixes(bool lettersAndModes = true);