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
  22 #include <typeinfo>
  23 #include <iostream>
  24 #include <string>
  25 #include <deque>
  26 #include <sstream>
  27 #include <vector>
  28 #include "users.h"
  29 #include "channels.h"
  30 #include "ctables.h"
  31
  32 /**
  33  * Holds the values for different type of modes
  34  * that can exist, USER or CHANNEL type.
  35  */
  36 enum ModeType {
  37         MODETYPE_USER = 0,
  38         MODETYPE_CHANNEL = 1
  39 };
  40
  41 /**
  42  * Holds mode actions - modes can be allowed or denied.
  43  */
  44 enum ModeAction {
  45         MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
  46         MODEACTION_ALLOW = 1 /* Allow the mode */
  47 };
  48
  49 /**
  50  * Used to mask off the mode types in the mode handler
  51  * array. Used in a simple two instruction hashing function
  52  * "(modeletter - 65) OR mask"
  53  */
  54 enum ModeMasks {
  55         MASK_USER = 128,        /* A user mode */
  56         MASK_CHANNEL = 0        /* A channel mode */
  57 };
  58
  59 /** Each mode is implemented by ONE ModeHandler class.
  60  * You must derive ModeHandler and add the child class to
  61  * the list of modes handled by the ircd, using
  62  * ModeParser::AddMode. When the mode you implement is
  63  * set by a user, the virtual function OnModeChange is
  64  * called. If you specify a value greater than 0 for
  65  * parameters_on or parameters_off, then when the mode is
  66  * set or unset respectively, std::string &parameter will
  67  * contain the parameter given by the user, else it will
  68  * contain an empty string. You may alter this parameter
  69  * string, and if you alter it to an empty string, and your
  70  * mode is expected to have a parameter, then this is
  71  * equivalent to returning MODEACTION_DENY.
  72  */
  73 class ModeHandler
  74 {
  75         /**
  76          * The mode letter you're implementing.
  77          */
  78         char mode;
  79         /**
  80          * Number of parameters when being set
  81          */
  82         int n_params_on;
  83         /**
  84          * Number of parameters when being unset
  85          */
  86         int n_params_off;
  87         /**
  88          * Mode is a 'list' mode. The behaviour
  89          * of your mode is now set entirely within
  90          * the class as of the 1.1 api, rather than
  91          * inside the mode parser as in the 1.0 api,
  92          * so the only use of this value (along with
  93          * IsListMode()) is for the core to determine
  94          * wether your module can produce 'lists' or not
  95          * (e.g. banlists, etc)
  96          */
  97         bool list;
  98         /**
  99          * The mode type, either MODETYPE_USER or
 100          * MODETYPE_CHANNEL.
 101          */
 102         ModeType m_type;
 103         /**
 104          * True if the mode requires oper status
 105          * to set.
 106          */
 107         bool oper;
 108
 109  public:
 110         /**
 111          * The constructor for ModeHandler initalizes the mode handler.
 112          * The constructor of any class you derive from ModeHandler should
 113          * probably call this constructor with the parameters set correctly.
 114          * @param modeletter The mode letter you wish to handle
 115          * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
 116          * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
 117          * @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
 118          * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
 119          * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
 120          */
 121         ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
 122         /**
 123          * The default destructor does nothing
 124          */
 125         virtual ~ModeHandler();
 126
 127         /**
 128          * Returns true if the mode is a list mode
 129          */
 130         bool IsListMode();
 131         /**
 132          * Returns the modes type
 133          */
 134         ModeType GetModeType();
 135         /**
 136          * Returns true if the mode can only be set/unset by an oper
 137          */
 138         bool NeedsOper();
 139         /**
 140          * Returns the number of parameters for the mode. Any non-zero
 141          * value should be considered to be equivalent to one.
 142          * @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.
 143          * @return The number of parameters the mode expects
 144          */
 145         int GetNumParams(bool adding);
 146         /**
 147          * Returns the mode character this handler handles.
 148          * @return The mode character
 149          */
 150         char GetModeChar();
 151
 152         /**
 153          * Called when a mode change for your mode occurs.
 154          * @param source Contains the user setting the mode.
 155          * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
 156          * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
 157          * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
 158          * 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
 159          * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
 160          * displayed.
 161          * @param adding This value is true when the mode is being set, or false when it is being unset.
 162          * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
 163          */
 164         virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
 165         /**
 166          * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
 167          * without any parameter or other modes in the command.
 168          * @param user The user issuing the command
 169          * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
 170          */
 171         virtual void DisplayList(userrec* user, chanrec* channel);
 172         /**
 173          * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
 174          * override this function and use it to return true or false. The default implementation just returns true if
 175          * theirs < ours.
 176          * @param theirs The timestamp of the remote side
 177          * @param ours The timestamp of the local side
 178          * @param their_param Their parameter if the mode has a parameter
 179          * @param our_param Our parameter if the mode has a parameter
 180          * @param channel The channel we are checking against
 181          * @return True if the other side wins the merge, false if we win the merge for this mode.
 182          */
 183         virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel);
 184 };
 185
 186 class ModeWatcher
 187 {
 188         char mode;
 189         ModeType m_type;
 190
 191  public:
 192         ModeWatcher(char modeletter, ModeType type);
 193         virtual ~ModeWatcher();
 194
 195         char GetModeChar();
 196         ModeType GetModeType();
 197
 198         virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding, ModeType type); /* Can change the mode parameter */
 199         virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter, bool adding, ModeType type);
 200 };
 201
 202 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
 203
 204 class ModeParser
 205 {
 206  private:
 207         /**
 208          * Mode handlers for each mode, to access a handler subtract
 209          * 65 from the ascii value of the mode letter.
 210          * The upper bit of the value indicates if its a usermode
 211          * or a channel mode, so we have 256 of them not 64.
 212          */
 213         ModeHandler* modehandlers[256];
 214         /**
 215          * Mode watcher classes arranged in the same way as the
 216          * mode handlers, except for instead of having 256 of them
 217          * we have 256 lists of them.
 218          */
 219         std::vector<ModeWatcher*> modewatchers[256];
 220
 221         void DisplayCurrentModes(userrec *user, userrec* targetuser, chanrec* targetchannel, const char* text);
 222
 223  public:
 224
 225         ModeParser();
 226
 227         static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
 228         static const char* Grant(userrec *d,chanrec *chan,int MASK);
 229         static const char* Revoke(userrec *d,chanrec *chan,int MASK);
 230         static void CleanMask(std::string &mask);
 231         static void BuildModeString(userrec* user);
 232
 233         bool AddMode(ModeHandler* mh, unsigned const char modeletter);
 234         void Process(char **parameters, int pcnt, userrec *user, bool servermode);
 235 };
 236
 237 class cmd_mode : public command_t
 238 {
 239  public:
 240         cmd_mode () : command_t("MODE",0,1) { }
 241         void Handle(char **parameters, int pcnt, userrec *user);
 242 };
 243
 244 #endif