include/mode.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __MODE_H
  15 #define __MODE_H
  16
  17 /* Forward declarations. */
  18 class User;
  19
  20 #include "channels.h"
  21
  22 /**
  23  * Holds the values for different type of modes
  24  * that can exist, USER or CHANNEL type.
  25  */
  26 enum ModeType
  27 {
  28         /** User mode */
  29         MODETYPE_USER = 0,
  30         /** Channel mode */
  31         MODETYPE_CHANNEL = 1
  32 };
  33
  34 /**
  35  * Holds mode actions - modes can be allowed or denied.
  36  */
  37 enum ModeAction
  38 {
  39         MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
  40         MODEACTION_ALLOW = 1 /* Allow the mode */
  41 };
  42
  43 /**
  44  * Used to mask off the mode types in the mode handler
  45  * array. Used in a simple two instruction hashing function
  46  * "(modeletter - 65) OR mask"
  47  */
  48 enum ModeMasks
  49 {
  50         MASK_USER = 128,        /* A user mode */
  51         MASK_CHANNEL = 0        /* A channel mode */
  52 };
  53
  54 /**
  55  * These fixed values can be used to proportionally compare module-defined prefixes to known values.
  56  * For example, if your module queries a Channel, and is told that user 'joebloggs' has the prefix
  57  * '$', and you dont know what $ means, then you can compare it to these three values to determine
  58  * its worth against them. For example if '$' had a value of 15000, you would know it is of higher
  59  * status than voice, but lower status than halfop.
  60  * No two modes should have equal prefix values.
  61  */
  62 enum PrefixModeValue
  63 {
  64         /* +v */
  65         VOICE_VALUE     =       10000,
  66         /* +h */
  67         HALFOP_VALUE    =       20000,
  68         /* +o */
  69         OP_VALUE        =       30000
  70 };
  71
  72 /**
  73  * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
  74  * The pair contains an activity flag, true if the mode is set with the given parameter,
  75  * and the parameter of the mode (or the parameter provided) in the std::string.
  76  */
  77 typedef std::pair<bool,std::string> ModePair;
  78
  79 /** Each mode is implemented by ONE ModeHandler class.
  80  * You must derive ModeHandler and add the child class to
  81  * the list of modes handled by the ircd, using
  82  * ModeParser::AddMode. When the mode you implement is
  83  * set by a user, the virtual function OnModeChange is
  84  * called. If you specify a value greater than 0 for
  85  * parameters_on or parameters_off, then when the mode is
  86  * set or unset respectively, std::string &parameter will
  87  * contain the parameter given by the user, else it will
  88  * contain an empty string. You may alter this parameter
  89  * string, and if you alter it to an empty string, and your
  90  * mode is expected to have a parameter, then this is
  91  * equivalent to returning MODEACTION_DENY.
  92  */
  93 class CoreExport ModeHandler : public Extensible
  94 {
  95  protected:
  96         /**
  97          * Creator/owner pointer
  98          */
  99         InspIRCd* ServerInstance;
 100         /**
 101          * The mode letter you're implementing.
 102          */
 103         char mode;
 104         /**
 105          * Number of parameters when being set
 106          */
 107         int n_params_on;
 108         /**
 109          * Number of parameters when being unset
 110          */
 111         int n_params_off;
 112         /**
 113          * Mode is a 'list' mode. The behaviour
 114          * of your mode is now set entirely within
 115          * the class as of the 1.1 api, rather than
 116          * inside the mode parser as in the 1.0 api,
 117          * so the only use of this value (along with
 118          * IsListMode()) is for the core to determine
 119          * wether your module can produce 'lists' or not
 120          * (e.g. banlists, etc)
 121          */
 122         bool list;
 123         /**
 124          * The mode type, either MODETYPE_USER or
 125          * MODETYPE_CHANNEL.
 126          */
 127         ModeType m_type;
 128         /**
 129          * True if the mode requires oper status
 130          * to set.
 131          */
 132         bool oper;
 133
 134         /** Mode prefix, or 0
 135          */
 136         char prefix;
 137
 138         /** Number of items with this mode set on them
 139          */
 140         unsigned int count;
 141
 142         /** The prefix char needed on channel to use this mode,
 143          * only checked for channel modes
 144          */
 145         char prefixneeded;
 146
 147  public:
 148         /**
 149          * The constructor for ModeHandler initalizes the mode handler.
 150          * The constructor of any class you derive from ModeHandler should
 151          * probably call this constructor with the parameters set correctly.
 152          * @param modeletter The mode letter you wish to handle
 153          * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
 154          * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
 155          * @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
 156          * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
 157          * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
 158          * @param mprefix For listmodes where parameters are NICKNAMES which are on the channel (for example, +ohv), you may define a prefix.
 159          * When you define a prefix, it can be returned in NAMES, WHO etc if it has the highest value (as returned by GetPrefixRank())
 160          * In the core, the only modes to implement prefixes are +ovh (ops, voice, halfop) which define the prefix characters @, % and +
 161          * and the rank values OP_VALUE, HALFOP_VALUE and VOICE_VALUE respectively. Any prefixes you define should have unique values proportional
 162          * to these three defaults or proportional to another mode in a module you depend on. See src/cmode_o.cpp as an example.
 163          */
 164         ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0, char prefixrequired = '%');
 165         /**
 166          * The default destructor does nothing
 167          */
 168         virtual ~ModeHandler();
 169         /**
 170          * Returns true if the mode is a list mode
 171          */
 172         bool IsListMode();
 173         /**
 174          * Mode prefix or 0. If this is defined, you should
 175          * also implement GetPrefixRank() to return an integer
 176          * value for this mode prefix.
 177          */
 178         char GetPrefix();
 179         /** Get number of items with this mode set on them
 180          */
 181         virtual unsigned int GetCount();
 182         /** Adjust usage count returned by GetCount
 183          */
 184         virtual void ChangeCount(int modifier);
 185         /**
 186          * Get the 'value' of this modes prefix.
 187          * determines which to display when there are multiple.
 188          * The mode with the highest value is ranked first. See the
 189          * PrefixModeValue enum and Channel::GetPrefixValue() for
 190          * more information.
 191          */
 192         virtual unsigned int GetPrefixRank();
 193         /**
 194          * Returns the modes type
 195          */
 196         ModeType GetModeType();
 197         /**
 198          * Returns true if the mode can only be set/unset by an oper
 199          */
 200         bool NeedsOper();
 201         /**
 202          * Returns the number of parameters for the mode. Any non-zero
 203          * value should be considered to be equivalent to one.
 204          * @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.
 205          * @return The number of parameters the mode expects
 206          */
 207         int GetNumParams(bool adding);
 208         /**
 209          * Returns the mode character this handler handles.
 210          * @return The mode character
 211          */
 212         char GetModeChar();
 213
 214         /** For user modes, return the current parameter, if any
 215          */
 216         virtual std::string GetUserParameter(User* useor);
 217
 218         /**
 219          * Called when a mode change for your mode occurs.
 220          * @param source Contains the user setting the mode.
 221          * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
 222          * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
 223          * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
 224          * 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
 225          * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
 226          * displayed.
 227          * @param adding This value is true when the mode is being set, or false when it is being unset.
 228          * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
 229          */
 230         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false); /* Can change the mode parameter as its a ref */
 231         /**
 232          * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
 233          * without any parameter or other modes in the command.
 234          * @param user The user issuing the command
 235          * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
 236          */
 237         virtual void DisplayList(User* user, Channel* channel);
 238
 239         /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
 240          * This allows you to give special information to the user, or handle this any way you like.
 241          * @param user The user issuing the mode change
 242          * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
 243          * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
 244          */
 245         virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
 246
 247         /**
 248          * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
 249          * @param user The user issuing the command
 250          * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
 251          */
 252         virtual void DisplayEmptyList(User* user, Channel* channel);
 253
 254         /**
 255          * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
 256          * override this function and use it to return true or false. The default implementation just returns true if
 257          * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
 258          * theirs == ours (therefore the default implementation will always return false).
 259          * @param theirs The timestamp of the remote side
 260          * @param ours The timestamp of the local side
 261          * @param their_param Their parameter if the mode has a parameter
 262          * @param our_param Our parameter if the mode has a parameter
 263          * @param channel The channel we are checking against
 264          * @return True if the other side wins the merge, false if we win the merge for this mode.
 265          */
 266         virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel);
 267
 268         /**
 269          * When a remote server needs to bounce a set of modes, it will call this method for every mode
 270          * in the mode string to determine if the mode is set or not.
 271          * @param source of the mode change, this will be NULL for a server mode
 272          * @param dest Target user of the mode change, if this is a user mode
 273          * @param channel Target channel of the mode change, if this is a channel mode
 274          * @param parameter The parameter given for the mode change, or an empty string
 275          * @returns The first value of the pair should be true if the mode is set with the given parameter.
 276          * In the case of permissions modes such as channelmode +o, this should return true if the user given
 277          * as the parameter has the given privilage on the given channel. The string value of the pair will hold
 278          * the current setting for this mode set locally, when the bool is true, or, the parameter given.
 279          * This allows the local server to enforce our locally set parameters back to a remote server.
 280          */
 281         virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string &parameter);
 282
 283         /**
 284          * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
 285          * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
 286          * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
 287          * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
 288          * your mode properly from each user.
 289          * @param user The user which the server wants to remove your mode from
 290          */
 291         virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
 292
 293         /**
 294          * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
 295          * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
 296          * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
 297          * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
 298          * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
 299          * @param channel The channel which the server wants to remove your mode from
 300          */
 301         virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
 302
 303         char GetNeededPrefix();
 304
 305         void SetNeededPrefix(char needsprefix);
 306 };
 307
 308 /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
 309  * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
 310  * is already set and not allowing it to be unset if it is already unset.
 311  * An example of a simple user mode is user mode +w.
 312  */
 313 class CoreExport SimpleUserModeHandler : public ModeHandler
 314 {
 315  public:
 316         SimpleUserModeHandler(InspIRCd* Instance, char modeletter);
 317         virtual ~SimpleUserModeHandler();
 318         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
 319 };
 320
 321 /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
 322  * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
 323  * is already set and not allowing it to be unset if it is already unset.
 324  * An example of a simple channel mode is channel mode +s.
 325  */
 326 class CoreExport SimpleChannelModeHandler : public ModeHandler
 327 {
 328  public:
 329         SimpleChannelModeHandler(InspIRCd* Instance, char modeletter);
 330         virtual ~SimpleChannelModeHandler();
 331         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
 332 };
 333
 334 /**
 335  * The ModeWatcher class can be used to alter the behaviour of a mode implemented
 336  * by the core or by another module. To use ModeWatcher, derive a class from it,
 337  * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
 338  * A ModeWatcher will be called both before and after the mode change.
 339  */
 340 class CoreExport ModeWatcher : public Extensible
 341 {
 342  protected:
 343         /**
 344          * Creator/owner pointer
 345          */
 346         InspIRCd* ServerInstance;
 347         /**
 348          * The mode letter this class is watching
 349          */
 350         char mode;
 351         /**
 352          * The mode type being watched (user or  channel)
 353          */
 354         ModeType m_type;
 355
 356  public:
 357         /**
 358          * The constructor initializes the mode and the mode type
 359          */
 360         ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type);
 361         /**
 362          * The default destructor does nothing.
 363          */
 364         virtual ~ModeWatcher();
 365
 366         /**
 367          * Get the mode character being watched
 368          * @return The mode character being watched
 369          */
 370         char GetModeChar();
 371         /**
 372          * Get the mode type being watched
 373          * @return The mode type being watched (user or channel)
 374          */
 375         ModeType GetModeType();
 376
 377         /**
 378          * Before the mode character is processed by its handler, this method will be called.
 379          * @param source The sender of the mode
 380          * @param dest The target user for the mode, if you are watching a user mode
 381          * @param channel The target channel for the mode, if you are watching a channel mode
 382          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 383          * If you alter the parameter you are given, the mode handler will see your atered version
 384          * when it handles the mode.
 385          * @param adding True if the mode is being added and false if it is being removed
 386          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 387          * @return True to allow the mode change to go ahead, false to abort it. If you abort the
 388          * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
 389          */
 390         virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, ModeType type, bool servermode = false);
 391         /**
 392          * After the mode character has been processed by the ModeHandler, this method will be called.
 393          * @param source The sender of the mode
 394          * @param dest The target user for the mode, if you are watching a user mode
 395          * @param channel The target channel for the mode, if you are watching a channel mode
 396          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 397          * You cannot alter the parameter here, as the mode handler has already processed it.
 398          * @param adding True if the mode is being added and false if it is being removed
 399          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 400          */
 401         virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type, bool servermode = false);
 402 };
 403
 404 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
 405
 406 /** The mode parser handles routing of modes and handling of mode strings.
 407  * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
 408  * parses client to server MODE strings for user and channel modes, and performs
 409  * processing for the 004 mode list numeric, amongst other things.
 410  */
 411 class CoreExport ModeParser : public classbase
 412 {
 413  private:
 414         /**
 415          * Creator/owner pointer
 416          */
 417         InspIRCd* ServerInstance;
 418         /** Mode handlers for each mode, to access a handler subtract
 419          * 65 from the ascii value of the mode letter.
 420          * The upper bit of the value indicates if its a usermode
 421          * or a channel mode, so we have 256 of them not 64.
 422          */
 423         ModeHandler* modehandlers[256];
 424         /** Mode watcher classes arranged in the same way as the
 425          * mode handlers, except for instead of having 256 of them
 426          * we have 256 lists of them.
 427          */
 428         std::vector<ModeWatcher*> modewatchers[256];
 429         /** Displays the current modes of a channel or user.
 430          * Used by ModeParser::Process.
 431          */
 432         void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
 433
 434         /** The string representing the last set of modes to be parsed.
 435          * Use GetLastParse() to get this value, to be used for  display purposes.
 436          */
 437         std::string LastParse;
 438
 439         unsigned int sent[256];
 440
 441         unsigned int seq;
 442
 443  public:
 444
 445         /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
 446          */
 447         ModeParser(InspIRCd* Instance);
 448
 449         /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
 450          * for example, should 'user A' be able to 'op' on 'channel B'.
 451          */
 452         User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
 453         /** Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
 454          */
 455         const char* Grant(User *d,Channel *chan,int MASK);
 456         /** Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
 457          */
 458         const char* Revoke(User *d,Channel *chan,int MASK);
 459         /** Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
 460          * E.g.
 461          *
 462          * nick -> nick!*@*
 463          *
 464          * nick!ident -> nick!ident@*
 465          *
 466          * host.name -> *!*@host.name
 467          *
 468          * ident@host.name -> *!ident@host.name
 469          *
 470          * This method can be used on both IPV4 and IPV6 user masks.
 471          */
 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.
 477          */
 478         const std::string& GetLastParse();
 479         /** Add a mode to the mode parser.
 480          * @return True if the mode was successfully added.
 481          */
 482         bool AddMode(ModeHandler* mh);
 483         /** Delete a mode from the mode parser.
 484          * When a mode is deleted, the mode handler will be called
 485          * for every user (if it is a user mode) or for every  channel
 486          * (if it is a channel mode) to unset the mode on all objects.
 487          * This prevents modes staying in the system which no longer exist.
 488          * @param mh The mode handler to remove
 489          * @return True if the mode was successfully removed.
 490          */
 491         bool DelMode(ModeHandler* mh);
 492         /** Add a mode watcher.
 493          * A mode watcher is triggered before and after a mode handler is
 494          * triggered. See the documentation of class ModeWatcher for more
 495          * information.
 496          * @param mw The ModeWatcher you want to add
 497          * @return True if the ModeWatcher was added correctly
 498          */
 499         bool AddModeWatcher(ModeWatcher* mw);
 500         /** Delete a mode watcher.
 501          * A mode watcher is triggered before and after a mode handler is
 502          * triggered. See the documentation of class ModeWatcher for more
 503          * information.
 504          * @param mw The ModeWatcher you want to delete
 505          * @return True if the ModeWatcher was deleted correctly
 506          */
 507         bool DelModeWatcher(ModeWatcher* mw);
 508         /** Process a set of mode changes from a server or user.
 509          * @param parameters The parameters of the mode change, in the format
 510          * they would be from a MODE command.
 511          * @param user The user setting or removing the modes. When the modes are set
 512          * by a server, an 'uninitialized' User is used, where *user::nick == NULL
 513          * and *user->server == NULL.
 514          * @param servermode True if a server is setting the mode.
 515          */
 516         void Process(const std::vector<std::string>& parameters, User *user, bool servermode);
 517
 518         /** Find the mode handler for a given mode and type.
 519          * @param modeletter mode letter to search for
 520          * @param type of mode to search for, user or channel
 521          * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
 522          */
 523         ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
 524
 525         /** Find a mode handler by its prefix.
 526          * If there is no mode handler with the given prefix, NULL will be returned.
 527          * @param pfxletter The prefix to find, e.g. '@'
 528          * @return The mode handler which handles this prefix, or NULL if there is none.
 529          */
 530         ModeHandler* FindPrefix(unsigned const char pfxletter);
 531
 532         /** Returns a list of mode characters which are usermodes.
 533          * This is used in the 004 numeric when users connect.
 534          */
 535         std::string UserModeList();
 536
 537         /** Returns a list of channel mode characters which are listmodes.
 538          * This is used in the 004 numeric when users connect.
 539          */
 540         std::string ChannelModeList();
 541
 542         /** Returns a list of channel mode characters which take parameters.
 543          * This is used in the 004 numeric when users connect.
 544          */
 545         std::string ParaModeList();
 546
 547         /** Generates the CHANMODES= 005 sequence
 548          */
 549         std::string ChanModes();
 550         /** Used by this class internally during std::sort and 005 generation
 551          */
 552         static bool PrefixComparison(prefixtype one, prefixtype two);
 553
 554         /** This returns the PREFIX=(ohv)@%+ section of the 005 numeric.
 555          */
 556         std::string BuildPrefixes();
 557
 558         /** This returns the privilages of a user upon a channel, in the format of a mode change.
 559          * For example, if a user has privilages +avh, this will return the string "avh nick nick nick".
 560          * This is used by the core when cycling a user to refresh their hostname. You may use it for
 561          * similar purposes.
 562          * @param user The username to look up
 563          * @param channel The channel name to look up the privilages of the user for
 564          * @param nick_suffix true (the default) if you want nicknames in the mode string, for easy
 565          * use with the mode stacker, false if you just want the "avh" part of "avh nick nick nick".
 566          * @return The mode string.
 567          */
 568         std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
 569 };
 570
 571 #endif
 572