1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
20 // include the common header files
33 * This enum contains a set of bitmasks which
34 * are used to compress the 'standard' usermodes
35 * +isw into a bitfield for fast checking.
44 * Holds the values for different type of modes
45 * that can exist, USER or CHANNEL type.
53 * Holds mode actions - modes can be allowed or denied.
56 MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
57 MODEACTION_ALLOW = 1 /* Allow the mode */
61 * Used to mask off the mode types in the mode handler
62 * array. Used in a simple two instruction hashing function
63 * "(modeletter - 65) OR mask"
66 MASK_USER = 128, /* A user mode */
67 MASK_CHANNEL = 0 /* A channel mode */
70 /** Each mode is implemented by ONE ModeHandler class.
71 * You must derive ModeHandler and add the child class to
72 * the list of modes handled by the ircd, using
73 * ModeParser::AddMode. When the mode you implement is
74 * set by a user, the virtual function OnModeChange is
75 * called. If you specify a value greater than 0 for
76 * parameters_on or parameters_off, then when the mode is
77 * set or unset respectively, std::string ¶meter will
78 * contain the parameter given by the user, else it will
79 * contain an empty string. You may alter this parameter
80 * string, and if you alter it to an empty string, and your
81 * mode is expected to have a parameter, then this is
82 * equivalent to returning MODEACTION_DENY.
87 * The mode letter you're implementing.
91 * Number of parameters when being set
95 * Number of parameters when being unset
99 * Mode is a 'list' mode. The behaviour
100 * of your mode is now set entirely within
101 * the class as of the 1.1 api, rather than
102 * inside the mode parser as in the 1.0 api,
103 * so the only use of this value (along with
104 * IsListMode()) is for the core to determine
105 * wether your module can produce 'lists' or not
106 * (e.g. banlists, etc)
110 * The mode type, either MODETYPE_USER or
115 * True if the mode requires oper status
122 * The constructor for ModeHandler initalizes the mode handler.
123 * The constructor of any class you derive from ModeHandler should
124 * probably call this constructor with the parameters set correctly.
125 * @param modeletter The mode letter you wish to handle
126 * @param parameters_on The number of parameters your mode takes when being set. Note that any nonzero value is treated as 1.
127 * @param parameters_off The number of parameters your mode takes when being unset. Note that any nonzero value is treated as 1.
128 * @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
129 * @param ModeType Set this to MODETYPE_USER for a usermode, or MODETYPE_CHANNEL for a channelmode.
130 * @param operonly Set this to true if only opers should be allowed to set or unset the mode.
132 ModeHandler(char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly);
134 * The default destructor does nothing
136 virtual ~ModeHandler();
139 * Returns true if the mode is a list mode
143 * Returns the modes type
145 ModeType GetModeType();
147 * Returns true if the mode can only be set/unset by an oper
151 * Returns the number of parameters for the mode. Any non-zero
152 * value should be considered to be equivalent to one.
153 * @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.
154 * @return The number of parameters the mode expects
156 int GetNumParams(bool adding);
158 * Returns the mode character this handler handles.
159 * @return The mode character
164 * Called when a mode change for your mode occurs.
165 * @param source Contains the user setting the mode.
166 * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
167 * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
168 * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
169 * 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
170 * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
172 * @param adding This value is true when the mode is being set, or false when it is being unset.
173 * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
175 virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding); /* Can change the mode parameter as its a ref */
177 * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
178 * without any parameter or other modes in the command.
179 * @param user The user issuing the command
180 * @parameter channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
182 virtual void DisplayList(userrec* user, chanrec* channel);
184 * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
185 * override this function and use it to return true or false. The default implementation just returns true if
187 * @param theirs The timestamp of the remote side
188 * @param ours The timestamp of the local side
189 * @param their_param Their parameter if the mode has a parameter
190 * @param our_param Our parameter if the mode has a parameter
191 * @param channel The channel we are checking against
192 * @return True if the other side wins the merge, false if we win the merge for this mode.
194 virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel);
203 ModeWatcher(char modeletter, ModeType type);
204 virtual ~ModeWatcher();
207 ModeType GetModeType();
209 virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding, ModeType type); /* Can change the mode parameter */
210 virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string ¶meter, bool adding, ModeType type);
213 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
219 * Mode handlers for each mode, to access a handler subtract
220 * 65 from the ascii value of the mode letter.
221 * The upper bit of the value indicates if its a usermode
222 * or a channel mode, so we have 256 of them not 64.
224 ModeHandler* modehandlers[256];
226 * Mode watcher classes arranged in the same way as the
227 * mode handlers, except for instead of having 256 of them
228 * we have 256 lists of them.
230 std::vector<ModeWatcher*> modewatchers[256];
232 /*char* GiveHops(userrec *user,char *dest,chanrec *chan,int status);
233 char* GiveVoice(userrec *user,char *dest,chanrec *chan,int status);
234 char* TakeHops(userrec *user,char *dest,chanrec *chan,int status);
235 char* TakeVoice(userrec *user,char *dest,chanrec *chan,int status);*/
241 static userrec* SanityChecks(userrec *user,const char *dest,chanrec *chan,int status);
242 static const char* Grant(userrec *d,chanrec *chan,int MASK);
243 static const char* Revoke(userrec *d,chanrec *chan,int MASK);
244 static void CleanMask(std::string &mask);
246 bool AddMode(ModeHandler* mh, unsigned const char modeletter);
247 void Process(char **parameters, int pcnt, userrec *user, bool servermode);
250 class cmd_mode : public command_t
253 cmd_mode () : command_t("MODE",0,1) { }
254 void Handle(char **parameters, int pcnt, userrec *user);