include/mode.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __MODE_H
  18 #define __MODE_H
  19
  20 /* include the common header files */
  21 #include <typeinfo>
  22 #include <iostream>
  23 #include <string>
  24 #include <deque>
  25 #include <sstream>
  26 #include <vector>
  27 #include "users.h"
  28 #include "channels.h"
  29 #include "ctables.h"
  30
  31 /**
  32  * Holds the values for different type of modes
  33  * that can exist, USER or CHANNEL type.
  34  */
  35 enum ModeType {
  36         MODETYPE_USER = 0,
  37         MODETYPE_CHANNEL = 1
  38 };
  39
  40 /**
  41  * Holds mode actions - modes can be allowed or denied.
  42  */
  43 enum ModeAction {
  44         MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
  45         MODEACTION_ALLOW = 1 /* Allow the mode */
  46 };
  47
  48 /**
  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"
  52  */
  53 enum ModeMasks {
  54         MASK_USER = 128,        /* A user mode */
  55         MASK_CHANNEL = 0        /* A channel mode */
  56 };
  57
  58 /**
  59  * Used by ModeHandler::ModeSet() to return the state of a mode upon a channel or user.
  60  * The pair contains an activity flag, true if the mode is set with the given parameter,
  61  * and the parameter of the mode (or the parameter provided) in the std::string.
  62  */
  63 typedef std::pair<bool,std::string> ModePair;
  64
  65 /** Each mode is implemented by ONE ModeHandler class.
  66  * You must derive ModeHandler and add the child class to
  67  * the list of modes handled by the ircd, using
  68  * ModeParser::AddMode. When the mode you implement is
  69  * set by a user, the virtual function OnModeChange is
  70  * called. If you specify a value greater than 0 for
  71  * parameters_on or parameters_off, then when the mode is
  72  * set or unset respectively, std::string &parameter will
  73  * contain the parameter given by the user, else it will
  74  * contain an empty string. You may alter this parameter
  75  * string, and if you alter it to an empty string, and your
  76  * mode is expected to have a parameter, then this is
  77  * equivalent to returning MODEACTION_DENY.
  78  */
  79 class ModeHandler : public Extensible
  80 {
  81  protected:
  82         /**
  83          * The mode letter you're implementing.
  84          */
  85         char mode;
  86         /**
  87          * Number of parameters when being set
  88          */
  89         int n_params_on;
  90         /**
  91          * Number of parameters when being unset
  92          */
  93         int n_params_off;
  94         /**
  95          * Mode is a 'list' mode. The behaviour
  96          * of your mode is now set entirely within
  97          * the class as of the 1.1 api, rather than
  98          * inside the mode parser as in the 1.0 api,
  99          * so the only use of this value (along with
 100          * IsListMode()) is for the core to determine
 101          * wether your module can produce 'lists' or not
 102          * (e.g. banlists, etc)
 103          */
 104         bool list;
 105         /**
 106          * The mode type, either MODETYPE_USER or
 107          * MODETYPE_CHANNEL.
 108          */
 109         ModeType m_type;
 110         /**
 111          * True if the mode requires oper status
 112          * to set.
 113          */
 114         bool oper;
 115
 116  public:
 117         /**
 118          * The constructor for ModeHandler initalizes the mode handler.
 119          * The constructor of any class you derive from ModeHandler should
 120          * probably call this constructor with the parameters set correctly.
 121          * @param modeletter The mode letter you wish to handle
 122          * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
 123          * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
 124          * @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
 125          * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
 126          * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
 127          */
 128         ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
 129         /**
 130          * The default destructor does nothing
 131          */
 132         virtual ~ModeHandler();
 133
 134         /**
 135          * Returns true if the mode is a list mode
 136          */
 137         bool IsListMode();
 138         /**
 139          * Returns the modes type
 140          */
 141         ModeType GetModeType();
 142         /**
 143          * Returns true if the mode can only be set/unset by an oper
 144          */
 145         bool NeedsOper();
 146         /**
 147          * Returns the number of parameters for the mode. Any non-zero
 148          * value should be considered to be equivalent to one.
 149          * @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.
 150          * @return The number of parameters the mode expects
 151          */
 152         int GetNumParams(bool adding);
 153         /**
 154          * Returns the mode character this handler handles.
 155          * @return The mode character
 156          */
 157         char GetModeChar();
 158
 159         /**
 160          * Called when a mode change for your mode occurs.
 161          * @param source Contains the user setting the mode.
 162          * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
 163          * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
 164          * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
 165          * 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
 166          * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
 167          * displayed.
 168          * @param adding This value is true when the mode is being set, or false when it is being unset.
 169          * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
 170          */
 171         virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
 172         /**
 173          * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
 174          * without any parameter or other modes in the command.
 175          * @param user The user issuing the command
 176          * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
 177          */
 178         virtual void DisplayList(userrec* user, chanrec* channel);
 179         /**
 180          * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
 181          * override this function and use it to return true or false. The default implementation just returns true if
 182          * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
 183          * theirs == ours (therefore the default implementation will always return false).
 184          * @param theirs The timestamp of the remote side
 185          * @param ours The timestamp of the local side
 186          * @param their_param Their parameter if the mode has a parameter
 187          * @param our_param Our parameter if the mode has a parameter
 188          * @param channel The channel we are checking against
 189          * @return True if the other side wins the merge, false if we win the merge for this mode.
 190          */
 191         virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel);
 192
 193         /**
 194          * When a remote server needs to bounce a set of modes, it will call this method for every mode
 195          * in the mode string to determine if the mode is set or not.
 196          * @param source of the mode change, this will be NULL for a server mode
 197          * @param dest Target user of the mode change, if this is a user mode
 198          * @param channel Target channel of the mode change, if this is a channel mode
 199          * @param parameter The parameter given for the mode change, or an empty string
 200          * @returns The first value of the pair should be true if the mode is set with the given parameter.
 201          * In the case of permissions modes such as channelmode +o, this should return true if the user given
 202          * as the parameter has the given privilage on the given channel. The string value of the pair will hold
 203          * the current setting for this mode set locally, when the bool is true, or, the parameter given.
 204          * This allows the local server to enforce our locally set parameters back to a remote server.
 205          */
 206         virtual ModePair ModeSet(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter);
 207 };
 208
 209 /**
 210  * The ModeWatcher class can be used to alter the behaviour of a mode implemented
 211  * by the core or by another module. To use ModeWatcher, derive a class from it,
 212  * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
 213  * A ModeWatcher will be called both before and after the mode change.
 214  */
 215 class ModeWatcher : public Extensible
 216 {
 217  protected:
 218         /**
 219          * The mode letter this class is watching
 220          */
 221         char mode;
 222         /**
 223          * The mode type being watched (user or  channel)
 224          */
 225         ModeType m_type;
 226
 227  public:
 228         /**
 229          * The constructor initializes the mode and the mode type
 230          */
 231         ModeWatcher(char modeletter, ModeType type);
 232         /**
 233          * The default destructor does nothing.
 234          */
 235         virtual ~ModeWatcher();
 236
 237         /**
 238          * Get the mode character being watched
 239          * @return The mode character being watched
 240          */
 241         char GetModeChar();
 242         /**
 243          * Get the mode type being watched
 244          * @return The mode type being watched (user or channel)
 245          */
 246         ModeType GetModeType();
 247
 248         /**
 249          * Before the mode character is processed by its handler, this method will be called.
 250          * @param source The sender of the mode
 251          * @param dest The target user for the mode, if you are watching a user mode
 252          * @param channel The target channel for the mode, if you are watching a channel mode
 253          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 254          * If you alter the parameter you are given, the mode handler will see your atered version
 255          * when it handles the mode.
 256          * @param adding True if the mode is being added and false if it is being removed
 257          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 258          * @return True to allow the mode change to go ahead, false to abort it. If you abort the
 259          * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
 260          */
 261         virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding, ModeType type);
 262         /**
 263          * After the mode character has been processed by the ModeHandler, this method will be called.
 264          * @param source The sender of the mode
 265          * @param dest The target user for the mode, if you are watching a user mode
 266          * @param channel The target channel for the mode, if you are watching a channel mode
 267          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 268          * You cannot alter the parameter here, as the mode handler has already processed it.
 269          * @param adding True if the mode is being added and false if it is being removed
 270          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 271          */
 272         virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter, bool adding, ModeType type);
 273 };
 274
 275 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
 276
 277 class ModeParser : public classbase
 278 {
 279  private:
 280         /**
 281          * Mode handlers for each mode, to access a handler subtract
 282          * 65 from the ascii value of the mode letter.
 283          * The upper bit of the value indicates if its a usermode
 284          * or a channel mode, so we have 256 of them not 64.
 285          */
 286         ModeHandler* modehandlers[256];
 287         /**
 288          * Mode watcher classes arranged in the same way as the
 289          * mode handlers, except for instead of having 256 of them
 290          * we have 256 lists of them.
 291          */
 292         std::vector<ModeWatcher*> modewatchers[256];
 293         /**
 294          * Displays the current modes of a channel or user.
 295          * Used by ModeParser::Process.
 296          */
 297         void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text);
 298
 299  public:
 300
 301         /**
 302          * The constructor initializes all the RFC basic modes by using ModeParserAddMode().
 303          */
 304         ModeParser();
 305
 306         /**
 307          * Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
 308          * for example, should 'user A' be able to 'op' on 'channel B'.
 309          */
 310         static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
 311         /**
 312          * Grant a built in privilage (e.g. ops, halfops, voice) to a user on a channel
 313          */
 314         static const char* Grant(userrec *d,chanrec *chan,int MASK);
 315         /**
 316          * Revoke a built in privilage (e.g. ops, halfops, voice) to a user on a channel
 317          */
 318         static const char* Revoke(userrec *d,chanrec *chan,int MASK);
 319         /**
 320          * Tidy a banmask. This makes a banmask 'acceptable' if fields are left out.
 321          * E.g.
 322          *
 323          * nick -> nick!*@*
 324          *
 325          * nick!ident -> nick!ident@*
 326          *
 327          * host.name -> *!*@host.name
 328          *
 329          * ident@host.name -> *!ident@host.name
 330          *
 331          * This method can be used on both IPV4 and IPV6 user masks.
 332          */
 333         static void CleanMask(std::string &mask);
 334         /**
 335          * Add a mode to the mode parser. The modeletter parameter
 336          * is purely to save on doing a lookup in the function, as
 337          * strictly it could be obtained via ModeHandler::GetModeChar().
 338          * @return True if the mode was successfully added.
 339          */
 340         bool AddMode(ModeHandler* mh, unsigned const char modeletter);
 341         /**
 342          * Add a mode watcher.
 343          * A mode watcher is triggered before and after a mode handler is
 344          * triggered. See the documentation of class ModeWatcher for more
 345          * information.
 346          * @param mw The ModeWatcher you want to add
 347          * @return True if the ModeWatcher was added correctly
 348          */
 349         bool AddModeWatcher(ModeWatcher* mw);
 350         /**
 351          * Delete a mode watcher.
 352          * A mode watcher is triggered before and after a mode handler is
 353          * triggered. See the documentation of class ModeWatcher for more
 354          * information.
 355          * @param mw The ModeWatcher you want to delete
 356          * @return True if the ModeWatcher was deleted correctly
 357          */
 358         bool DelModeWatcher(ModeWatcher* mw);
 359         /**
 360          * Process a set of mode changes from a server or user.
 361          * @param parameters The parameters of the mode change, in the format
 362          * they would be from a MODE command.
 363          * @param pcnt The number of items in the parameters array
 364          * @param user The user setting or removing the modes. When the modes are set
 365          * by a server, an 'uninitialized' userrec is used, where *user::nick == NULL
 366          * and *user->server == NULL.
 367          * @param servermode True if a server is setting the mode.
 368          */
 369         void Process(const char** parameters, int pcnt, userrec *user, bool servermode);
 370
 371         /**
 372          * Find the mode handler for a given mode and type
 373          * @param modeletter mode letter to search for
 374          * @param type of mode to search for, user or channel
 375          * @returns a pointer to a ModeHandler class, or NULL of there isnt a handler for the given mode
 376          */
 377         ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);
 378 };
 379
 380 /**
 381  * Command handler class for the MODE command.
 382  * put here for completeness.
 383  */
 384 class cmd_mode : public command_t
 385 {
 386  public:
 387         /**
 388          * Standard constructor
 389          */
 390         cmd_mode () : command_t("MODE",0,1) { syntax = "<target> <modes> {<mode-parameters>}"; }
 391         /**
 392          * Handle MODE
 393          */
 394         void Handle(const char** parameters, int pcnt, userrec *user);
 395 };
 396
 397 #endif