include/channels.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __CHANNELS_H__
  15 #define __CHANNELS_H__
  16
  17 #include "inspircd_config.h"
  18 #include "base.h"
  19 #include <time.h>
  20 #include <vector>
  21 #include <string>
  22 #include <map>
  23
  24 /** RFC1459 channel modes
  25  */
  26 enum ChannelModes {
  27         CM_TOPICLOCK = 't'-65,
  28         CM_NOEXTERNAL = 'n'-65,
  29         CM_INVITEONLY = 'i'-65,
  30         CM_MODERATED = 'm'-65,
  31         CM_SECRET = 's'-65,
  32         CM_PRIVATE = 'p'-65,
  33         CM_KEY = 'k'-65,
  34         CM_LIMIT = 'l'-65
  35 };
  36
  37 class userrec;
  38 class chanrec;
  39
  40 /** Holds an entry for a ban list, exemption list, or invite list.
  41  * This class contains a single element in a channel list, such as a banlist.
  42  */
  43 class HostItem : public classbase
  44 {
  45  public:
  46         /** Time the item was added
  47          */
  48         time_t set_time;
  49         /** Who added the item
  50          */
  51         char set_by[NICKMAX];
  52         /** The actual item data
  53          */
  54         char data[MAXBUF];
  55
  56         HostItem() { /* stub */ }
  57         virtual ~HostItem() { /* stub */ }
  58 };
  59
  60 /** A subclass of HostItem designed to hold channel bans (+b)
  61  */
  62 class BanItem : public HostItem
  63 {
  64 };
  65
  66 /** Holds a complete ban list
  67  */
  68 typedef std::vector<BanItem>    BanList;
  69
  70 /** A list of users on a channel
  71  */
  72 typedef std::map<userrec*,userrec*> CUList;
  73
  74 /** Shorthand for CUList::iterator
  75  */
  76 typedef CUList::iterator CUListIter;
  77
  78 /** Shorthand for CUList::const_iterator
  79  */
  80 typedef CUList::const_iterator CUListConstIter;
  81
  82 /** A list of custom modes parameters on a channel
  83  */
  84 typedef std::map<char,char*> CustomModeList;
  85
  86
  87 /** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
  88  */
  89 enum UserChannelModes {
  90         UCMODE_OP      = 1,
  91         UCMODE_VOICE   = 2,
  92         UCMODE_HOP     = 4
  93 };
  94
  95 class InspIRCd;
  96
  97 /** A stored prefix and its rank
  98  */
  99 typedef std::pair<char, unsigned int> prefixtype;
 100
 101 /** A list of prefixes set on a user in a channel
 102  */
 103 typedef std::vector<prefixtype> pfxcontainer;
 104
 105 /** A list of users with zero or more prefixes set on them
 106  */
 107 typedef std::map<userrec*, std::vector<prefixtype> > prefixlist;
 108
 109 /** Holds all relevent information for a channel.
 110  * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
 111  * etc, and an instance of the BanList type.
 112  */
 113 class chanrec : public Extensible
 114 {
 115  private:
 116
 117         /** Pointer to creator object
 118          */
 119         InspIRCd* ServerInstance;
 120
 121         /** Connect a chanrec to a userrec
 122          */
 123         static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr, userrec* user, const std::string &privs);
 124
 125         prefixlist prefixes;
 126
 127  public:
 128         /** The channels name.
 129          */
 130         char name[CHANMAX];
 131
 132         /** Modes for the channel.
 133          * This is not a null terminated string! It is a hash where
 134          * each item in it represents if a mode is set. For example
 135          * for mode +A, index 0. Use modechar-65 to calculate which
 136          * field to check.
 137          */
 138         char modes[64];
 139
 140         /** User lists
 141          * There are four user lists, one for
 142          * all the users, one for the ops, one for
 143          * the halfops and another for the voices.
 144          */
 145         CUList internal_userlist;
 146
 147         /** Opped users
 148          */
 149         CUList internal_op_userlist;
 150
 151         /** Halfopped users
 152          */
 153         CUList internal_halfop_userlist;
 154
 155         /** Voiced users
 156          */
 157         CUList internal_voice_userlist;
 158
 159         /** Parameters for custom modes
 160          */
 161         CustomModeList custom_mode_params;
 162
 163         /** Channel topic.
 164          * If this is an empty string, no channel topic is set.
 165          */
 166         char topic[MAXTOPIC];
 167         /** Creation time.
 168          */
 169         time_t created;
 170         /** Time topic was set.
 171          * If no topic was ever set, this will be equal to chanrec::created
 172          */
 173         time_t topicset;
 174         /** The last user to set the topic.
 175          * If this member is an empty string, no topic was ever set.
 176          */
 177         char setby[NICKMAX];
 178
 179         /** Contains the channel user limit.
 180          * If this value is zero, there is no limit in place.
 181          */
 182         short int limit;
 183
 184         /** Contains the channel key.
 185          * If this value is an empty string, there is no channel key in place.
 186          */
 187         char key[32];
 188
 189         /** The list of all bans set on the channel.
 190          */
 191         BanList bans;
 192
 193         /** Sets or unsets a custom mode in the channels info
 194          * @param mode The mode character to set or unset
 195          * @param mode_on True if you want to set the mode or false if you want to remove it
 196          */
 197         void SetMode(char mode,bool mode_on);
 198
 199         /** Sets or unsets the parameters for a custom mode in a channels info
 200          * @param mode The mode character to set or unset
 201          * @param parameter The parameter string to associate with this mode character
 202          * @param mode_on True if you want to set the mode or false if you want to remove it
 203          */
 204         void SetModeParam(char mode,const char* parameter,bool mode_on);
 205
 206         /** Returns true if a mode is set on a channel
 207           * @param mode The mode character you wish to query
 208           * @return True if the custom mode is set, false if otherwise
 209           */
 210         bool IsModeSet(char mode);
 211
 212         /** Returns the parameter for a custom mode on a channel.
 213           * @param mode The mode character you wish to query
 214           *
 215           * For example if "+L #foo" is set, and you pass this method
 216           * 'L', it will return '#foo'. If the mode is not set on the
 217           * channel, or the mode has no parameters associated with it,
 218           * it will return an empty string.
 219           *
 220           * @return The parameter for this mode is returned, or an empty string
 221           */
 222         std::string GetModeParameter(char mode);
 223
 224         /** Obtain the channel "user counter"
 225          * This returns the channel reference counter, which is initialized
 226          * to 0 when the channel is created and incremented/decremented
 227          * upon joins, parts quits and kicks.
 228          *
 229          * @return The number of users on this channel
 230          */
 231         long GetUserCounter();
 232
 233         /** Add a user pointer to the internal reference list
 234          * @param user The user to add
 235          *
 236          * The data inserted into the reference list is a table as it is
 237          * an arbitary pointer compared to other users by its memory address,
 238          * as this is a very fast 32 or 64 bit integer comparison.
 239          */
 240         void AddUser(userrec* user);
 241
 242         /** Add a user pointer to the internal reference list of opped users
 243          * @param user The user to add
 244          */
 245         void AddOppedUser(userrec* user);
 246
 247         /** Add a user pointer to the internal reference list of halfopped users
 248          * @param user The user to add
 249          */
 250         void AddHalfoppedUser(userrec* user);
 251
 252         /** Add a user pointer to the internal reference list of voiced users
 253          * @param user The user to add
 254          */
 255         void AddVoicedUser(userrec* user);
 256
 257         /** Delete a user pointer to the internal reference list
 258          * @param user The user to delete
 259          * @return number of users left on the channel after deletion of the user
 260          */
 261         unsigned long DelUser(userrec* user);
 262
 263         /** Delete a user pointer to the internal reference list of opped users
 264          * @param user The user to delete
 265          */
 266         void DelOppedUser(userrec* user);
 267
 268         /** Delete a user pointer to the internal reference list of halfopped users
 269          * @param user The user to delete
 270          */
 271         void DelHalfoppedUser(userrec* user);
 272
 273         /** Delete a user pointer to the internal reference list of voiced users
 274          * @param user The user to delete
 275          */
 276         void DelVoicedUser(userrec* user);
 277
 278         /** Obtain the internal reference list
 279          * The internal reference list contains a list of userrec*.
 280          * These are used for rapid comparison to determine
 281          * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
 282          * The resulting pointer to the vector should be considered
 283          * readonly and only modified via AddUser and DelUser.
 284          *
 285          * @return This function returns pointer to a map of userrec pointers (CUList*).
 286          */
 287         CUList* GetUsers();
 288
 289         /** Obtain the internal reference list of opped users
 290          * @return This function returns pointer to a map of userrec pointers (CUList*).
 291          */
 292         CUList* GetOppedUsers();
 293
 294         /** Obtain the internal reference list of halfopped users
 295          * @return This function returns pointer to a map of userrec pointers (CUList*).
 296          */
 297         CUList* GetHalfoppedUsers();
 298
 299         /** Obtain the internal reference list of voiced users
 300          * @return This function returns pointer to a map of userrec pointers (CUList*).
 301          */
 302         CUList* GetVoicedUsers();
 303
 304         /** Returns true if the user given is on the given channel.
 305          * @param The user to look for
 306          * @return True if the user is on this channel
 307          */
 308         bool HasUser(userrec* user);
 309
 310         /** Creates a channel record and initialises it with default values
 311          * @throw Nothing at present.
 312          */
 313         chanrec(InspIRCd* Instance);
 314
 315         /** Make src kick user from this channel with the given reason.
 316          * @param src The source of the kick
 317          * @param user The user being kicked (must be on this channel)
 318          * @param reason The reason for the kick
 319          * @return The number of users left on the channel. If this is zero
 320          * when the method returns, you MUST delete the chanrec immediately!
 321          */
 322         long KickUser(userrec *src, userrec *user, const char* reason);
 323
 324         /** Make the server kick user from this channel with the given reason.
 325          * @param user The user being kicked (must be on this channel)
 326          * @param reason The reason for the kick
 327          * @param triggerevents True if you wish this kick to trigger module events
 328          * @return The number of users left on the channel. If this is zero
 329          * when the method returns, you MUST delete the chanrec immediately!
 330          */
 331         long ServerKickUser(userrec* user, const char* reason, bool triggerevents);
 332
 333         /** Part a user from this channel with the given reason.
 334          * If the reason field is NULL, no reason will be sent.
 335          * @param user The user who is parting (must be on this channel)
 336          * @param reason The (optional) part reason
 337          * @return The number of users left on the channel. If this is zero
 338          * when the method returns, you MUST delete the chanrec immediately!
 339          */
 340         long PartUser(userrec *user, const char* reason = NULL);
 341
 342         /* Join a user to a channel. May be a channel that doesnt exist yet.
 343          * @param user The user to join to the channel.
 344          * @param cn The channel name to join to. Does not have to exist.
 345          * @param key The key of the channel, if given
 346          * @param override If true, override all join restrictions such as +bkil
 347          * @return A pointer to the chanrec the user was joined to. A new chanrec may have
 348          * been created if the channel did not exist before the user was joined to it.
 349          * If the user could not be joined to a channel, the return value may be NULL.
 350          */
 351         static chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key = "");
 352
 353         /** Write to a channel, from a user, using va_args for text
 354          * @param user User whos details to prefix the line with
 355          * @param text A printf-style format string which builds the output line without prefix
 356          * @param ... Zero or more POD types
 357          */
 358         void WriteChannel(userrec* user, char* text, ...);
 359
 360         /** Write to a channel, from a user, using std::string for text
 361          * @param user User whos details to prefix the line with
 362          * @param text A std::string containing the output line without prefix
 363          */
 364         void WriteChannel(userrec* user, const std::string &text);
 365
 366         /** Write to a channel, from a server, using va_args for text
 367          * @param ServName Server name to prefix the line with
 368          * @param text A printf-style format string which builds the output line without prefix
 369          * @param ... Zero or more POD type
 370          */
 371         void WriteChannelWithServ(const char* ServName, const char* text, ...);
 372
 373         /** Write to a channel, from a server, using std::string for text
 374          * @param ServName Server name to prefix the line with
 375          * @param text A std::string containing the output line without prefix
 376          */
 377         void WriteChannelWithServ(const char* ServName, const std::string &text);
 378
 379         /** Write to all users on a channel except a specific user, using va_args for text.
 380          * Internally, this calls WriteAllExcept().
 381          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 382          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 383          * use the nick!user@host of the user.
 384          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 385          * @param text A printf-style format string which builds the output line without prefix
 386          * @param ... Zero or more POD type
 387          */
 388         void WriteAllExceptSender(userrec* user, bool serversource, char status, char* text, ...);
 389
 390         /** Write to all users on a channel except a list of users, using va_args for text
 391          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 392          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 393          * use the nick!user@host of the user.
 394          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 395          * @param except_list A list of users NOT to send the text to
 396          * @param text A printf-style format string which builds the output line without prefix
 397          * @param ... Zero or more POD type
 398          */
 399         void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, char* text, ...);
 400
 401         /** Write to all users on a channel except a specific user, using std::string for text.
 402          * Internally, this calls WriteAllExcept().
 403          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 404          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 405          * use the nick!user@host of the user.
 406          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 407          * @param text A std::string containing the output line without prefix
 408          */
 409         void WriteAllExceptSender(userrec* user, bool serversource, char status, const std::string& text);
 410
 411         /** Write to all users on a channel except a list of users, using std::string for text
 412          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 413          * @param serversource If this parameter is true, use the local server name as the source of the text, otherwise,
 414          * use the nick!user@host of the user.
 415          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 416          * @param except_list A list of users NOT to send the text to
 417          * @param text A std::string containing the output line without prefix
 418          */
 419         void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, const std::string& text);
 420
 421         /** Returns the maximum number of bans allowed to be set on this channel
 422          * @return The maximum number of bans allowed
 423          */
 424         long GetMaxBans();
 425
 426         /** Return the channel's modes with parameters.
 427          * @param showkey If this is set to true, the actual key is shown,
 428          * otherwise it is replaced with '&lt;KEY&gt;'
 429          * @return The channel mode string
 430          */
 431         char* ChanModes(bool showkey);
 432
 433         /** Spool the NAMES list for this channel to the given user
 434          * @param user The user to spool the NAMES list to
 435          */
 436         void UserList(userrec *user);
 437
 438         /** Get the number of invisible users on this channel
 439          * @return Number of invisible users
 440          */
 441         int CountInvisible();
 442
 443         /** Get a users status on this channel
 444          * @param user The user to look up
 445          * @return One of STATUS_OP, STATUS_HOP, STATUS_VOICE, or zero.
 446          */
 447         int GetStatus(userrec *user);
 448
 449         /** Get a users status on this channel in a bitmask
 450          * @param user The user to look up
 451          * @return A bitmask containing zero or more of STATUS_OP, STATUS_HOP, STATUS_VOICE
 452          */
 453         int GetStatusFlags(userrec *user);
 454
 455         /** Get a users prefix on this channel in a string.
 456          * @param user The user to look up
 457          * @return A character array containing the prefix string.
 458          * Unlike GetStatus and GetStatusFlags which will only return the
 459          * core specified modes @, % and + (op, halfop and voice), GetPrefixChar
 460          * will also return module-defined prefixes. If the user has to prefix,
 461          * an empty but non-null string is returned. If the user has multiple
 462          * prefixes, the highest is returned. If you do not recognise the prefix
 463          * character you can get, you can deal with it in a 'proprtional' manner
 464          * compared to known prefixes, using GetPrefixValue().
 465          */
 466         const char* GetPrefixChar(userrec *user);
 467
 468         /** Return all of a users mode prefixes into a char* string.
 469          * @param user The user to look up
 470          * @return A list of all prefix characters. The prefixes will always
 471          * be in rank order, greatest first, as certain IRC clients require
 472          * this when multiple prefixes are used names lists.
 473          */
 474         const char* GetAllPrefixChars(userrec* user);
 475
 476         /** Get the value of a users prefix on this channel.
 477          * @param user The user to look up
 478          * @return The module or core-defined value of the users prefix.
 479          * The values for op, halfop and voice status are constants in
 480          * mode.h, and are OP_VALUE, HALFOP_VALUE, and VOICE_VALUE respectively.
 481          * If the value you are given does not match one of these three, it is
 482          * a module-defined mode, and it should be compared in proportion to
 483          * these three constants. For example a value greater than OP_VALUE
 484          * is a prefix of greater 'worth' than ops, and a value less than
 485          * VOICE_VALUE is of lesser 'worth' than a voice.
 486          */
 487         unsigned int GetPrefixValue(userrec* user);
 488
 489         /** This method removes all prefix characters from a user.
 490          * It will not inform the user or the channel of the removal of prefixes,
 491          * and should be used when the user parts or quits.
 492          * @param user The user to remove all prefixes from
 493          */
 494         void RemoveAllPrefixes(userrec* user);
 495
 496         /** Add a prefix character to a user.
 497          * Only the core should call this method, usually  from
 498          * within the mode parser or when the first user joins
 499          * the channel (to grant ops to them)
 500          * @param user The user to associate the privilage with
 501          * @param prefix The prefix character to associate
 502          * @param prefix_rank The rank (value) of this prefix character
 503          * @param adding True if adding the prefix, false when removing
 504          */
 505         void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding);
 506
 507         /** Check if a user is banned on this channel
 508          * @param user A user to check against the banlist
 509          * @returns True if the user given is banned
 510          */
 511         bool IsBanned(userrec* user);
 512
 513         /** Destructor for chanrec
 514          */
 515         virtual ~chanrec() { /* stub */ }
 516 };
 517
 518 #endif