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