1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 * ---------------------------------------------------
25 * Holds the values for different type of modes
26 * that can exist, USER or CHANNEL type.
37 * Holds mode actions - modes can be allowed or denied.
41 MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
42 MODEACTION_ALLOW = 1 /* Allow the mode */
46 * Used to mask off the mode types in the mode handler
47 * array. Used in a simple two instruction hashing function
48 * "(modeletter - 65) OR mask"
52 MASK_USER = 128, /* A user mode */
53 MASK_CHANNEL = 0 /* A channel mode */
57 * These fixed values can be used to proportionally compare module-defined prefixes to known values.
58 * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
59 * '$', and you dont know what $ means, then you can compare it to these three values to determine
60 * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
61 * status than voice, but lower status than halfop.
62 * No two modes should have equal prefix values.
75 * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
76 * The pair contains an activity flag, true if the mode is set with the given parameter,
77 * and the parameter of the mode (or the parameter provided) in the std::string.
79 typedef std::pair<bool,std::string> ModePair;
81 /** Each mode is implemented by ONE ModeHandler class.
82 * You must derive ModeHandler and add the child class to
83 * the list of modes handled by the ircd, using
84 * ModeParser::AddMode. When the mode you implement is
85 * set by a user, the virtual function OnModeChange is
86 * called. If you specify a value greater than 0 for
87 * parameters_on or parameters_off, then when the mode is
88 * set or unset respectively, std::string ¶meter will
89 * contain the parameter given by the user, else it will
90 * contain an empty string. You may alter this parameter
91 * string, and if you alter it to an empty string, and your
92 * mode is expected to have a parameter, then this is
93 * equivalent to returning MODEACTION_DENY.
95 class CoreExport ModeHandler : public Extensible
99 * Creator/owner pointer
101 InspIRCd* ServerInstance;
103 * The mode letter you're implementing.
107 * Number of parameters when being set
111 * Number of parameters when being unset
115 * Mode is a 'list' mode. The behaviour
116 * of your mode is now set entirely within
117 * the class as of the 1.1 api, rather than
118 * inside the mode parser as in the 1.0 api,
119 * so the only use of this value (along with
120 * IsListMode()) is for the core to determine
121 * wether your module can produce 'lists' or not
122 * (e.g. banlists, etc)
126 * The mode type, either MODETYPE_USER or
131 * True if the mode requires oper status
136 /** Mode prefix, or 0
140 /** Number of items with this mode set on them
146 * The constructor for ModeHandler initalizes the mode handler.
147 * The constructor of any class you derive from ModeHandler should
148 * probably call this constructor with the parameters set correctly.
149 * @param modeletter The mode letter you wish to handle
150 * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
151 * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
152 * @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
153 * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
154 * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
155 * @param mprefix For listmodes where parameters are NICKNAMES which are on the channel (for example, +ohv), you may define a prefix.
156 * When you define a prefix, it can be returned in NAMES, WHO etc if it has the highest value (as returned by GetPrefixRank())
157 * In the core, the only modes to implement prefixes are +ovh (ops, voice, halfop) which define the prefix characters @, % and +
158 * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional
159 * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example.
161 ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0);
163 * The default destructor does nothing
165 virtual ~ModeHandler();
167 * Returns true if the mode is a list mode
171 * Mode prefix or 0. If this is defined, you should
172 * also implement GetPrefixRank() to return an integer
173 * value for this mode prefix.
176 /** Get number of items with this mode set on them
178 virtual unsigned int GetCount();
179 /** Adjust usage count returned by GetCount
181 virtual void ChangeCount(int modifier);
183 * Get the 'value' of this modes prefix.
184 * determines which to display when there are multiple.
185 * The mode with the highest value is ranked first. See the
186 * PrefixModeValue enum and Channel::GetPrefixValue() for
189 virtual unsigned int GetPrefixRank();
191 * Returns the modes type
193 ModeType GetModeType();
195 * Returns true if the mode can only be set/unset by an oper
199 * Returns the number of parameters for the mode. Any non-zero
200 * value should be considered to be equivalent to one.
201 * @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.
202 * @return The number of parameters the mode expects
204 int GetNumParams(bool adding);
206 * Returns the mode character this handler handles.
207 * @return The mode character
212 * Called when a mode change for your mode occurs.
213 * @param source Contains the user setting the mode.
214 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
215 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
216 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
217 * 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
218 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
220 * @param adding This value is true when the mode is being set, or false when it is being unset.
221 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
223 virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
225 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
226 * without any parameter or other modes in the command.
227 * @param user The user issuing the command
228 * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
230 virtual void DisplayList(User* user, Channel* channel);
233 * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
234 * @param user The user issuing the command
235 * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
237 virtual void DisplayEmptyList(User* user, Channel* channel);
240 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
241 * override this function and use it to return true or false. The default implementation just returns true if
242 * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
243 * theirs == ours (therefore the default implementation will always return false).
244 * @param theirs The timestamp of the remote side
245 * @param ours The timestamp of the local side
246 * @param their_param Their parameter if the mode has a parameter
247 * @param our_param Our parameter if the mode has a parameter
248 * @param channel The channel we are checking against
249 * @return True if the other side wins the merge, false if we win the merge for this mode.
251 virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel);
254 * When a remote server needs to bounce a set of modes, it will call this method for every mode
255 * in the mode string to determine if the mode is set or not.
256 * @param source of the mode change, this will be NULL for a server mode
257 * @param dest Target user of the mode change, if this is a user mode
258 * @param channel Target channel of the mode change, if this is a channel mode
259 * @param parameter The parameter given for the mode change, or an empty string
260 * @returns The first value of the pair should be true if the mode is set with the given parameter.
261 * In the case of permissions modes such as channelmode +o, this should return true if the user given
262 * as the parameter has the given privilage on the given channel. The string value of the pair will hold
263 * the current setting for this mode set locally, when the bool is true, or, the parameter given.
264 * This allows the local server to enforce our locally set parameters back to a remote server.
266 virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string ¶meter);
269 * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
270 * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
271 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
272 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
273 * your mode properly from each user.
274 * @param user The user which the server wants to remove your mode from
276 virtual void RemoveMode(User* user);
279 * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
280 * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
281 * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
282 * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
283 * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
284 * @param channel The channel which the server wants to remove your mode from
286 virtual void RemoveMode(Channel* channel);
290 * The ModeWatcher class can be used to alter the behaviour of a mode implemented
291 * by the core or by another module. To use ModeWatcher, derive a class from it,
292 * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
293 * A ModeWatcher will be called both before and after the mode change.
295 class CoreExport ModeWatcher : public Extensible
299 * Creator/owner pointer
301 InspIRCd* ServerInstance;
303 * The mode letter this class is watching
307 * The mode type being watched (user or channel)
313 * The constructor initializes the mode and the mode type
315 ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type);
317 * The default destructor does nothing.
319 virtual ~ModeWatcher();
322 * Get the mode character being watched
323 * @return The mode character being watched
327 * Get the mode type being watched
328 * @return The mode type being watched (user or channel)
330 ModeType GetModeType();
333 * Before the mode character is processed by its handler, this method will be called.
334 * @param source The sender of the mode
335 * @param dest The target user for the mode, if you are watching a user mode
336 * @param channel The target channel for the mode, if you are watching a channel mode
337 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
338 * If you alter the parameter you are given, the mode handler will see your atered version
339 * when it handles the mode.
340 * @param adding True if the mode is being added and false if it is being removed
341 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
342 * @return True to allow the mode change to go ahead, false to abort it. If you abort the
343 * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
345 virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, ModeType type);
347 * After the mode character has been processed by the ModeHandler, this method will be called.
348 * @param source The sender of the mode
349 * @param dest The target user for the mode, if you are watching a user mode
350 * @param channel The target channel for the mode, if you are watching a channel mode
351 * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
352 * You cannot alter the parameter here, as the mode handler has already processed it.
353 * @param adding True if the mode is being added and false if it is being removed
354 * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
356 virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string ¶meter, bool adding, ModeType type);
359 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
361 /** The mode parser handles routing of modes and handling of mode strings.
362 * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
363 * parses client to server MODE strings for user and channel modes, and performs
364 * processing for the 004 mode list numeric, amongst other things.
366 class CoreExport ModeParser : public classbase
370 * Creator/owner pointer
372 InspIRCd* ServerInstance;
373 /** Mode handlers for each mode, to access a handler subtract
374 * 65 from the ascii value of the mode letter.
375 * The upper bit of the value indicates if its a usermode
376 * or a channel mode, so we have 256 of them not 64.
378 ModeHandler* modehandlers[256];
379 /** Mode watcher classes arranged in the same way as the
380 * mode handlers, except for instead of having 256 of them
381 * we have 256 lists of them.
383 std::vector<ModeWatcher*> modewatchers[256];
384 /** Displays the current modes of a channel or user.
385 * Used by ModeParser::Process.
387 void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
389 /** The string representing the last set of modes to be parsed.
390 * Use GetLastParse() to get this value, to be used for display purposes.
392 std::string LastParse;
396 /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
398 ModeParser(InspIRCd* Instance);
400 /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
401 * for example, should 'user A' be able to 'op' on 'channel B'.
403 User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
404 /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
406 const char* Grant(User *d,Channel *chan,int MASK);
407 /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
409 const char* Revoke(User *d,Channel *chan,int MASK);
410 /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
415 * nick!ident -> nick!ident@*
417 * host.name -> *!*@host.name
419 * ident@host.name -> *!ident@host.name
421 * This method can be used on both IPV4 and IPV6 user masks.
423 static void CleanMask(std::string &mask);
424 /** Get the last string to be processed, as it was sent to the user or channel.
425 * Use this to display a string you just sent to be parsed, as the actual output
426 * may be different to what you sent after it has been 'cleaned up' by the parser.
427 * @return Last parsed string, as seen by users.
429 const std::string& GetLastParse();
430 /** Add a mode to the mode parser.
431 * @return True if the mode was successfully added.
433 bool AddMode(ModeHandler* mh);
434 /** Delete a mode from the mode parser.
435 * When a mode is deleted, the mode handler will be called
436 * for every user (if it is a user mode) or for every channel
437 * (if it is a channel mode) to unset the mode on all objects.
438 * This prevents modes staying in the system which no longer exist.
439 * @param mh The mode handler to remove
440 * @return True if the mode was successfully removed.
442 bool DelMode(ModeHandler* mh);
443 /** Add a mode watcher.
444 * A mode watcher is triggered before and after a mode handler is
445 * triggered. See the documentation of class ModeWatcher for more
447 * @param mw The ModeWatcher you want to add
448 * @return True if the ModeWatcher was added correctly
450 bool AddModeWatcher(ModeWatcher* mw);
451 /** Delete a mode watcher.
452 * A mode watcher is triggered before and after a mode handler is
453 * triggered. See the documentation of class ModeWatcher for more
455 * @param mw The ModeWatcher you want to delete
456 * @return True if the ModeWatcher was deleted correctly
458 bool DelModeWatcher(ModeWatcher* mw);
459 /** Process a set of mode changes from a server or user.
460 * @param parameters The parameters of the mode change, in the format
461 * they would be from a MODE command.
462 * @param pcnt The number of items in the parameters array
463 * @param user The user setting or removing the modes. When the modes are set
464 * by a server, an 'uninitialized' User is used, where *user::nick == NULL
465 * and *user->server == NULL.
466 * @param servermode True if a server is setting the mode.
468 void Process(const char** parameters, int pcnt, User *user, bool servermode);
470 /** Find the mode handler for a given mode and type.
471 * @param modeletter mode letter to search for
472 * @param type of mode to search for, user or channel
473 * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
475 ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
477 /** Find a mode handler by its prefix.
478 * If there is no mode handler with the given prefix, NULL will be returned.
479 * @param pfxletter The prefix to find, e.g. '@'
480 * @return The mode handler which handles this prefix, or NULL if there is none.
482 ModeHandler* FindPrefix(unsigned const char pfxletter);
484 /** Returns a list of mode characters which are usermodes.
485 * This is used in the 004 numeric when users connect.
487 std::string UserModeList();
489 /** Returns a list of channel mode characters which are listmodes.
490 * This is used in the 004 numeric when users connect.
492 std::string ChannelModeList();
494 /** Returns a list of channel mode characters which take parameters.
495 * This is used in the 004 numeric when users connect.
497 std::string ParaModeList();
499 /** Generates the CHANMODES= 005 sequence
501 std::string ChanModes();
502 /** Used by this class internally during std::sort and 005 generation
504 static bool PrefixComparison(prefixtype one, prefixtype two);
506 /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
508 std::string BuildPrefixes();
510 /** This returns the privilages of a user upon a channel, in the format of a mode change.
511 * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
512 * This is used by the core when cycling a user to refresh their hostname. You may use it for
514 * @param user The username to look up
515 * @param channel The channel name to look up the privilages of the user for
516 * @return The mode string.
518 std::string ModeString(User* user, Channel* channel);