include/mode.h

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