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 parameter translation type
 109          */
 110         TranslateType m_paramtype;
 111
 112         /** What kind of parameters does the mode take?
 113          */
 114         ParamSpec parameters_taken;
 115
 116         /**
 117          * The mode letter you're implementing.
 118          */
 119         const char mode;
 120
 121         /** Mode prefix, or 0
 122          */
 123         char prefix;
 124
 125         /**
 126          * True if the mode requires oper status
 127          * to set.
 128          */
 129         bool oper;
 130
 131         /**
 132          * Mode is a 'list' mode. The behaviour
 133          * of your mode is now set entirely within
 134          * the class as of the 1.1 api, rather than
 135          * inside the mode parser as in the 1.0 api,
 136          * so the only use of this value (along with
 137          * IsListMode()) is for the core to determine
 138          * wether your module can produce 'lists' or not
 139          * (e.g. banlists, etc)
 140          */
 141         bool list;
 142
 143         /**
 144          * The mode type, either MODETYPE_USER or
 145          * MODETYPE_CHANNEL.
 146          */
 147         ModeType m_type;
 148
 149         /** Number of items with this mode set on them
 150          */
 151         unsigned int count;
 152
 153         /** The prefix char needed on channel to use this mode,
 154          * only checked for channel modes
 155          */
 156         int levelrequired;
 157
 158  public:
 159         /** Module that created this mode. NULL for core modes */
 160         Module* const creator;
 161         /** Long-form name
 162          */
 163         const std::string name;
 164
 165         /**
 166          * The constructor for ModeHandler initalizes the mode handler.
 167          * The constructor of any class you derive from ModeHandler should
 168          * probably call this constructor with the parameters set correctly.
 169          * @param name A one-word name for the mode
 170          * @param modeletter The mode letter you wish to handle
 171          * @param params Parameters taken by the mode
 172          * @param type Type of the mode (MODETYPE_USER or MODETYPE_CHANNEL)
 173          */
 174         ModeHandler(Module* me, const std::string& name, char modeletter, ParamSpec params, ModeType type);
 175         virtual CullResult cull();
 176         virtual ~ModeHandler();
 177         /**
 178          * Returns true if the mode is a list mode
 179          */
 180         bool IsListMode();
 181         /**
 182          * Mode prefix or 0. If this is defined, you should
 183          * also implement GetPrefixRank() to return an integer
 184          * value for this mode prefix.
 185          */
 186         inline char GetPrefix() const { return prefix; }
 187         /** Get number of items with this mode set on them
 188          */
 189         virtual unsigned int GetCount();
 190         /** Adjust usage count returned by GetCount
 191          */
 192         virtual void ChangeCount(int modifier);
 193         /**
 194          * Get the 'value' of this modes prefix.
 195          * determines which to display when there are multiple.
 196          * The mode with the highest value is ranked first. See the
 197          * PrefixModeValue enum and Channel::GetPrefixValue() for
 198          * more information.
 199          */
 200         virtual unsigned int GetPrefixRank();
 201         /**
 202          * Returns the mode's type
 203          */
 204         inline ModeType GetModeType() const { return m_type; }
 205         /**
 206          * Returns the mode's parameter translation type
 207          */
 208         inline TranslateType GetTranslateType() const { return m_paramtype; }
 209         /**
 210          * Returns true if the mode can only be set/unset by an oper
 211          */
 212         inline bool NeedsOper() const { return oper; }
 213         /**
 214          * Returns the number of parameters for the mode. Any non-zero
 215          * value should be considered to be equivalent to one.
 216          * @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.
 217          * @return The number of parameters the mode expects
 218          */
 219         int GetNumParams(bool adding);
 220         /**
 221          * Returns the mode character this handler handles.
 222          * @return The mode character
 223          */
 224         char GetModeChar();
 225
 226         /** For user modes, return the current parameter, if any
 227          */
 228         virtual std::string GetUserParameter(User* useor);
 229
 230         /**
 231          * Called when a channel mode change access check for your mode occurs.
 232          * @param source Contains the user setting the mode.
 233          * @param channel contains the destination channel the modes are being set on.
 234          * @param parameter The parameter for your mode. This is modifiable.
 235          * @param adding This value is true when the mode is being set, or false when it is being unset.
 236          * @return allow, deny, or passthru to check against the required level
 237          */
 238         virtual ModResult AccessCheck(User* source, Channel* channel, std::string &parameter, bool adding);
 239
 240         /**
 241          * Called when a mode change for your mode occurs.
 242          * @param source Contains the user setting the mode.
 243          * @param dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
 244          * @param channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
 245          * @param parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that
 246          * 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
 247          * but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being
 248          * displayed.
 249          * @param adding This value is true when the mode is being set, or false when it is being unset.
 250          * @return MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.
 251          */
 252         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
 253         /**
 254          * If your mode is a listmode, then this method will be called for displaying an item list, e.g. on MODE #channel +modechar
 255          * without any parameter or other modes in the command.
 256          * @param user The user issuing the command
 257          * @param channel The channel they're requesting an item list of (e.g. a banlist, or an exception list etc)
 258          */
 259         virtual void DisplayList(User* user, Channel* channel);
 260
 261         /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
 262          * This allows you to give special information to the user, or handle this any way you like.
 263          * @param user The user issuing the mode change
 264          * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
 265          * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
 266          */
 267         virtual void OnParameterMissing(User* user, User* dest, Channel* channel);
 268
 269         /**
 270          * If your mode is a listmode, this method will be called to display an empty list (just the end of list numeric)
 271          * @param user The user issuing the command
 272          * @param channel The channel tehy're requesting an item list of (e.g. a banlist, or an exception list etc)
 273          */
 274         virtual void DisplayEmptyList(User* user, Channel* channel);
 275
 276         /**
 277          * If your mode needs special action during a server sync to determine which side wins when comparing timestamps,
 278          * override this function and use it to return true or false. The default implementation just returns true if
 279          * theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where
 280          * theirs == ours (therefore the default implementation will always return false).
 281          * @param their_param Their parameter if the mode has a parameter
 282          * @param our_param Our parameter if the mode has a parameter
 283          * @param channel The channel we are checking against
 284          * @return True if the other side wins the merge, false if we win the merge for this mode.
 285          */
 286         virtual bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
 287
 288         /**
 289          * When a remote server needs to bounce a set of modes, it will call this method for every mode
 290          * in the mode string to determine if the mode is set or not.
 291          * @param source of the mode change, this will be NULL for a server mode
 292          * @param dest Target user of the mode change, if this is a user mode
 293          * @param channel Target channel of the mode change, if this is a channel mode
 294          * @param parameter The parameter given for the mode change, or an empty string
 295          * @returns The first value of the pair should be true if the mode is set with the given parameter.
 296          * In the case of permissions modes such as channelmode +o, this should return true if the user given
 297          * as the parameter has the given privilage on the given channel. The string value of the pair will hold
 298          * the current setting for this mode set locally, when the bool is true, or, the parameter given.
 299          * This allows the local server to enforce our locally set parameters back to a remote server.
 300          */
 301         virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string &parameter);
 302
 303         /**
 304          * When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
 305          * Your mode handler should remove its user mode from the user by sending the appropriate server modes using
 306          * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
 307          * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
 308          * your mode properly from each user.
 309          * @param user The user which the server wants to remove your mode from
 310          */
 311         virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);
 312
 313         /**
 314          * When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
 315          * Your mode handler should remove its user mode from the channel by sending the appropriate server modes using
 316          * InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters,
 317          * and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove
 318          * your mode properly from each channel. Note that in the case of listmodes, you should remove the entire list of items.
 319          * @param channel The channel which the server wants to remove your mode from
 320          */
 321         virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);
 322
 323         inline unsigned int GetLevelRequired() const { return levelrequired; }
 324 };
 325
 326 /** A prebuilt mode handler which handles a simple user mode, e.g. no parameters, usable by any user, with no extra
 327  * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
 328  * is already set and not allowing it to be unset if it is already unset.
 329  * An example of a simple user mode is user mode +w.
 330  */
 331 class CoreExport SimpleUserModeHandler : public ModeHandler
 332 {
 333  public:
 334         SimpleUserModeHandler(Module* Creator, const std::string& Name, char modeletter)
 335                 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_USER) {}
 336         virtual ~SimpleUserModeHandler() {}
 337         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
 338 };
 339
 340 /** A prebuilt mode handler which handles a simple channel mode, e.g. no parameters, usable by any user, with no extra
 341  * behaviour to the mode beyond the basic setting and unsetting of the mode, not allowing the mode to be set if it
 342  * is already set and not allowing it to be unset if it is already unset.
 343  * An example of a simple channel mode is channel mode +s.
 344  */
 345 class CoreExport SimpleChannelModeHandler : public ModeHandler
 346 {
 347  public:
 348         SimpleChannelModeHandler(Module* Creator, const std::string& Name, char modeletter)
 349                 : ModeHandler(Creator, Name, modeletter, PARAM_NONE, MODETYPE_CHANNEL) {}
 350         virtual ~SimpleChannelModeHandler() {}
 351         virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
 352 };
 353
 354 /**
 355  * The ModeWatcher class can be used to alter the behaviour of a mode implemented
 356  * by the core or by another module. To use ModeWatcher, derive a class from it,
 357  * and attach it to the mode using Server::AddModeWatcher and Server::DelModeWatcher.
 358  * A ModeWatcher will be called both before and after the mode change.
 359  */
 360 class CoreExport ModeWatcher : public classbase
 361 {
 362  protected:
 363         /**
 364          * The mode letter this class is watching
 365          */
 366         char mode;
 367         /**
 368          * The mode type being watched (user or  channel)
 369          */
 370         ModeType m_type;
 371
 372  public:
 373         Module* const creator;
 374         /**
 375          * The constructor initializes the mode and the mode type
 376          */
 377         ModeWatcher(Module* creator, char modeletter, ModeType type);
 378         /**
 379          * The default destructor does nothing.
 380          */
 381         virtual ~ModeWatcher();
 382
 383         /**
 384          * Get the mode character being watched
 385          * @return The mode character being watched
 386          */
 387         char GetModeChar();
 388         /**
 389          * Get the mode type being watched
 390          * @return The mode type being watched (user or channel)
 391          */
 392         ModeType GetModeType();
 393
 394         /**
 395          * Before the mode character is processed by its handler, this method will be called.
 396          * @param source The sender of the mode
 397          * @param dest The target user for the mode, if you are watching a user mode
 398          * @param channel The target channel for the mode, if you are watching a channel mode
 399          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 400          * If you alter the parameter you are given, the mode handler will see your atered version
 401          * when it handles the mode.
 402          * @param adding True if the mode is being added and false if it is being removed
 403          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 404          * @return True to allow the mode change to go ahead, false to abort it. If you abort the
 405          * change, the mode handler (and ModeWatcher::AfterMode()) will never see the mode change.
 406          */
 407         virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, ModeType type);
 408         /**
 409          * After the mode character has been processed by the ModeHandler, this method will be called.
 410          * @param source The sender of the mode
 411          * @param dest The target user for the mode, if you are watching a user mode
 412          * @param channel The target channel for the mode, if you are watching a channel mode
 413          * @param parameter The parameter of the mode, if the mode is supposed to have a parameter.
 414          * You cannot alter the parameter here, as the mode handler has already processed it.
 415          * @param adding True if the mode is being added and false if it is being removed
 416          * @type The mode type, either MODETYPE_USER or MODETYPE_CHANNEL
 417          */
 418         virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type);
 419 };
 420
 421 typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;
 422
 423 /** The mode parser handles routing of modes and handling of mode strings.
 424  * It marshalls, controls and maintains both ModeWatcher and ModeHandler classes,
 425  * parses client to server MODE strings for user and channel modes, and performs
 426  * processing for the 004 mode list numeric, amongst other things.
 427  */
 428 class CoreExport ModeParser : public classbase
 429 {
 430  private:
 431         /** Mode handlers for each mode, to access a handler subtract
 432          * 65 from the ascii value of the mode letter.
 433          * The upper bit of the value indicates if its a usermode
 434          * or a channel mode, so we have 256 of them not 64.
 435          */
 436         ModeHandler* modehandlers[256];
 437         /** Mode watcher classes arranged in the same way as the
 438          * mode handlers, except for instead of having 256 of them
 439          * we have 256 lists of them.
 440          */
 441         std::vector<ModeWatcher*> modewatchers[256];
 442         /** Displays the current modes of a channel or user.
 443          * Used by ModeParser::Process.
 444          */
 445         void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);
 446         /** Displays the value of a list mode
 447          * Used by ModeParser::Process.
 448          */
 449         void DisplayListModes(User* user, Channel* chan, std::string &mode_sequence);
 450
 451         /**
 452          * Attempts to apply a mode change to a user or channel
 453          */
 454         ModeAction TryMode(User* user, User* targu, Channel* targc, bool adding, unsigned char mode, std::string &param, bool SkipACL);
 455
 456         /** The string representing the last set of modes to be parsed.
 457          * Use GetLastParse() to get this value, to be used for  display purposes.
 458          */
 459         std::string LastParse;
 460         std::vector<std::string> LastParseParams;
 461         std::vector<TranslateType> LastParseTranslate;
 462
 463         unsigned int sent[256];
 464
 465         unsigned int seq;
 466
 467  public:
 468
 469         /** The constructor initializes all the RFC basic modes by using ModeParserAddMode().
 470          */
 471         ModeParser();
 472         ~ModeParser();
 473
 474         /** Used to check if user 'd' should be allowed to do operation 'MASK' on channel 'chan'.
 475          * for example, should 'user A' be able to 'op' on 'channel B'.
 476          */
 477         User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
 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
 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