include/channels.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __CHANNELS_H__
  18 #define __CHANNELS_H__
  19
  20 #include "inspircd_config.h"
  21 #include "base.h"
  22 #include <time.h>
  23 #include <vector>
  24 #include <string>
  25 #include <map>
  26
  27 /** RFC1459 channel modes
  28  */
  29 enum ChannelModes {
  30         CM_TOPICLOCK = 't'-65,
  31         CM_NOEXTERNAL = 'n'-65,
  32         CM_INVITEONLY = 'i'-65,
  33         CM_MODERATED = 'm'-65,
  34         CM_SECRET = 's'-65,
  35         CM_PRIVATE = 'p'-65,
  36         CM_KEY = 'k'-65,
  37         CM_LIMIT = 'l'-65
  38 };
  39
  40 class userrec;
  41 class chanrec;
  42
  43 /** Holds an entry for a ban list, exemption list, or invite list.
  44  * This class contains a single element in a channel list, such as a banlist.
  45  */
  46 class HostItem : public classbase
  47 {
  48  public:
  49         /** Time the item was added
  50          */
  51         time_t set_time;
  52         /** Who added the item
  53          */
  54         char set_by[NICKMAX];
  55         /** The actual item data
  56          */
  57         char data[MAXBUF];
  58
  59         HostItem() { /* stub */ }
  60         virtual ~HostItem() { /* stub */ }
  61 };
  62
  63 /** A subclass of HostItem designed to hold channel bans (+b)
  64  */
  65 class BanItem : public HostItem
  66 {
  67 };
  68
  69 /** A subclass of HostItem designed to hold channel exempts (+e)
  70  */
  71 class ExemptItem : public HostItem
  72 {
  73 };
  74
  75 /** A subclass of HostItem designed to hold channel invites (+I)
  76  */
  77 class InviteItem : public HostItem
  78 {
  79 };
  80
  81 /** Holds a complete ban list
  82  */
  83 typedef std::vector<BanItem>    BanList;
  84
  85 /** Holds a complete exempt list
  86  */
  87 typedef std::vector<ExemptItem> ExemptList;
  88
  89 /** Holds a complete invite list
  90  */
  91 typedef std::vector<InviteItem> InviteList;
  92
  93 /** A list of users on a channel
  94  */
  95 typedef std::map<userrec*,userrec*> CUList;
  96
  97 /** Shorthand for CUList::iterator
  98  */
  99 typedef CUList::iterator CUListIter;
 100
 101 /** Shorthand for CUList::const_iterator
 102  */
 103 typedef CUList::const_iterator CUListConstIter;
 104
 105 /** A list of custom modes parameters on a channel
 106  */
 107 typedef std::map<char,char*> CustomModeList;
 108
 109
 110 /** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
 111  */
 112 enum UserChannelModes {
 113         UCMODE_OP      = 1,
 114         UCMODE_VOICE   = 2,
 115         UCMODE_HOP     = 4
 116 };
 117
 118 /** Holds a user's modes on a channel
 119  * This class associates a users privilages with a channel by creating a pointer link between
 120  * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
 121  * has on the channel, such as op, voice, etc.
 122  */
 123 class ucrec : public classbase
 124 {
 125  public:
 126         /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
 127          * If this value is zero, the user has no privilages upon the channel.
 128          */
 129         char uc_modes;
 130
 131         /** Points to the channel record where the given modes apply.
 132          * If the record is not in use, this value will be NULL.
 133          */
 134         chanrec *channel;
 135
 136         /** Constructor for ucrec
 137          */
 138         ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
 139
 140         /** Destructor for ucrec
 141          */
 142         virtual ~ucrec() { /* stub */ }
 143 };
 144
 145
 146 /** Holds all relevent information for a channel.
 147  * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
 148  * etc, and an instance of the BanList type.
 149  */
 150 class chanrec : public Extensible
 151 {
 152  private:
 153
 154         /** Connect a chanrec to a userrec
 155          */
 156         static chanrec* ForceChan(chanrec* Ptr,ucrec *a,userrec* user, int created);
 157
 158  public:
 159         /** The channels name.
 160          */
 161         char name[CHANMAX];
 162
 163         /** Modes for the channel.
 164          * This is not a null terminated string! It is a hash where
 165          * each item in it represents if a mode is set. For example
 166          * for mode +A, index 0. Use modechar-65 to calculate which
 167          * field to check.
 168          */
 169         char modes[64];
 170
 171         /** User lists
 172          * There are four user lists, one for
 173          * all the users, one for the ops, one for
 174          * the halfops and another for the voices.
 175          */
 176         CUList internal_userlist;
 177
 178         /** Opped users
 179          */
 180         CUList internal_op_userlist;
 181
 182         /** Halfopped users
 183          */
 184         CUList internal_halfop_userlist;
 185
 186         /** Voiced users
 187          */
 188         CUList internal_voice_userlist;
 189
 190         /** Parameters for custom modes
 191          */
 192         CustomModeList custom_mode_params;
 193
 194         /** Channel topic.
 195          * If this is an empty string, no channel topic is set.
 196          */
 197         char topic[MAXTOPIC];
 198         /** Creation time.
 199          */
 200         time_t created;
 201         /** Time topic was set.
 202          * If no topic was ever set, this will be equal to chanrec::created
 203          */
 204         time_t topicset;
 205         /** The last user to set the topic.
 206          * If this member is an empty string, no topic was ever set.
 207          */
 208         char setby[NICKMAX];
 209
 210         /** Contains the channel user limit.
 211          * If this value is zero, there is no limit in place.
 212          */
 213         short int limit;
 214
 215         /** Contains the channel key.
 216          * If this value is an empty string, there is no channel key in place.
 217          */
 218         char key[32];
 219
 220         /** The list of all bans set on the channel.
 221          */
 222         BanList bans;
 223
 224         /** Sets or unsets a custom mode in the channels info
 225          * @param mode The mode character to set or unset
 226          * @param mode_on True if you want to set the mode or false if you want to remove it
 227          */
 228         void SetMode(char mode,bool mode_on);
 229
 230         /** Sets or unsets the parameters for a custom mode in a channels info
 231          * @param mode The mode character to set or unset
 232          * @param parameter The parameter string to associate with this mode character
 233          * @param mode_on True if you want to set the mode or false if you want to remove it
 234          */
 235         void SetModeParam(char mode,const char* parameter,bool mode_on);
 236
 237         /** Returns true if a mode is set on a channel
 238           * @param mode The mode character you wish to query
 239           * @return True if the custom mode is set, false if otherwise
 240           */
 241         bool IsModeSet(char mode);
 242
 243         /** Returns the parameter for a custom mode on a channel.
 244           * @param mode The mode character you wish to query
 245           *
 246           * For example if "+L #foo" is set, and you pass this method
 247           * 'L', it will return '#foo'. If the mode is not set on the
 248           * channel, or the mode has no parameters associated with it,
 249           * it will return an empty string.
 250           *
 251           * @return The parameter for this mode is returned, or an empty string
 252           */
 253         std::string GetModeParameter(char mode);
 254
 255         /** Obtain the channel "user counter"
 256          * This returns the channel reference counter, which is initialized
 257          * to 0 when the channel is created and incremented/decremented
 258          * upon joins, parts quits and kicks.
 259          *
 260          * @return The number of users on this channel
 261          */
 262         long GetUserCounter();
 263
 264         /** Add a user pointer to the internal reference list
 265          * @param user The user to add
 266          *
 267          * The data inserted into the reference list is a table as it is
 268          * an arbitary pointer compared to other users by its memory address,
 269          * as this is a very fast 32 or 64 bit integer comparison.
 270          */
 271         void AddUser(userrec* user);
 272
 273         /** Add a user pointer to the internal reference list of opped users
 274          * @param user The user to add
 275          */
 276         void AddOppedUser(userrec* user);
 277
 278         /** Add a user pointer to the internal reference list of halfopped users
 279          * @param user The user to add
 280          */
 281         void AddHalfoppedUser(userrec* user);
 282
 283         /** Add a user pointer to the internal reference list of voiced users
 284          * @param user The user to add
 285          */
 286         void AddVoicedUser(userrec* user);
 287
 288         /** Delete a user pointer to the internal reference list
 289          * @param user The user to delete
 290          * @return number of users left on the channel after deletion of the user
 291          */
 292         unsigned long DelUser(userrec* user);
 293
 294         /** Delete a user pointer to the internal reference list of opped users
 295          * @param user The user to delete
 296          */
 297         void DelOppedUser(userrec* user);
 298
 299         /** Delete a user pointer to the internal reference list of halfopped users
 300          * @param user The user to delete
 301          */
 302         void DelHalfoppedUser(userrec* user);
 303
 304         /** Delete a user pointer to the internal reference list of voiced users
 305          * @param user The user to delete
 306          */
 307         void DelVoicedUser(userrec* user);
 308
 309         /** Obtain the internal reference list
 310          * The internal reference list contains a list of userrec*.
 311          * These are used for rapid comparison to determine
 312          * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
 313          * The resulting pointer to the vector should be considered
 314          * readonly and only modified via AddUser and DelUser.
 315          *
 316          * @return This function returns pointer to a map of userrec pointers (CUList*).
 317          */
 318         CUList* GetUsers();
 319
 320         /** Obtain the internal reference list of opped users
 321          * @return This function returns pointer to a map of userrec pointers (CUList*).
 322          */
 323         CUList* GetOppedUsers();
 324
 325         /** Obtain the internal reference list of halfopped users
 326          * @return This function returns pointer to a map of userrec pointers (CUList*).
 327          */
 328         CUList* GetHalfoppedUsers();
 329
 330         /** Obtain the internal reference list of voiced users
 331          * @return This function returns pointer to a map of userrec pointers (CUList*).
 332          */
 333         CUList* GetVoicedUsers();
 334
 335         /** Returns true if the user given is on the given channel.
 336          * @param The user to look for
 337          * @return True if the user is on this channel
 338          */
 339         bool HasUser(userrec* user);
 340
 341         /** Creates a channel record and initialises it with default values
 342          * @throw Nothing at present.
 343          */
 344         chanrec();
 345
 346         /** Make src kick user from this channel with the given reason.
 347          * @param src The source of the kick
 348          * @param user The user being kicked (must be on this channel)
 349          * @param reason The reason for the kick
 350          * @return The number of users left on the channel. If this is zero
 351          * when the method returns, you MUST delete the chanrec immediately!
 352          */
 353         long KickUser(userrec *src, userrec *user, const char* reason);
 354
 355         /** Make the server kick user from this channel with the given reason.
 356          * @param user The user being kicked (must be on this channel)
 357          * @param reason The reason for the kick
 358          * @param triggerevents True if you wish this kick to trigger module events
 359          * @return The number of users left on the channel. If this is zero
 360          * when the method returns, you MUST delete the chanrec immediately!
 361          */
 362         long ServerKickUser(userrec* user, const char* reason, bool triggerevents);
 363
 364         /** Part a user from this channel with the given reason.
 365          * If the reason field is NULL, no reason will be sent.
 366          * @param user The user who is parting (must be on this channel)
 367          * @param reason The (optional) part reason
 368          * @return The number of users left on the channel. If this is zero
 369          * when the method returns, you MUST delete the chanrec immediately!
 370          */
 371         long PartUser(userrec *user, const char* reason = NULL);
 372
 373         /* Join a user to a channel. May be a channel that doesnt exist yet.
 374          * @param user The user to join to the channel.
 375          * @param cn The channel name to join to. Does not have to exist.
 376          * @param key The key of the channel, if given
 377          * @param override If true, override all join restrictions such as +bkil
 378          * @return A pointer to the chanrec the user was joined to. A new chanrec may have
 379          * been created if the channel did not exist before the user was joined to it.
 380          * If the user could not be joined to a channel, the return value may be NULL.
 381          */
 382         static chanrec* JoinUser(userrec *user, const char* cn, bool override, const char* key = "");
 383
 384         /** Write to a channel, from a user, using va_args for text
 385          * @param user User whos details to prefix the line with
 386          * @param text A printf-style format string which builds the output line without prefix
 387          * @param ... Zero or more POD types
 388          */
 389         void WriteChannel(userrec* user, char* text, ...);
 390
 391         /** Write to a channel, from a user, using std::string for text
 392          * @param user User whos details to prefix the line with
 393          * @param text A std::string containing the output line without prefix
 394          */
 395         void WriteChannel(userrec* user, const std::string &text);
 396
 397         /** Write to a channel, from a server, using va_args for text
 398          * @param ServName Server name to prefix the line with
 399          * @param text A printf-style format string which builds the output line without prefi
 400          * @param ... Zero or more POD type
 401          */
 402         void WriteChannelWithServ(const char* ServName, const char* text, ...);
 403
 404         /** Write to a channel, from a server, using std::string for text
 405          * @param ServName Server name to prefix the line with
 406          * @param text A std::string containing the output line without prefix
 407          */
 408         void WriteChannelWithServ(const char* ServName, const std::string &text);
 409
 410         /** Write to all users on a channel except a specific user, using va_args for text
 411          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 412          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 413          * @param text A printf-style format string which builds the output line without prefi
 414          * @param ... Zero or more POD type
 415          */
 416         void WriteAllExceptSender(userrec* user, char status, char* text, ...);
 417
 418         /** Write to all users on a channel except a specific user, using std::string for text
 419          * @param user User whos details to prefix the line with, and to omit from receipt of the message
 420          * @param status The status of the users to write to, e.g. '@' or '%'. Use a value of 0 to write to everyone
 421          * @param text A std::string containing the output line without prefix
 422          */
 423         void WriteAllExceptSender(userrec* user, char status, const std::string& text);
 424
 425         /** Destructor for chanrec
 426          */
 427         virtual ~chanrec() { /* stub */ }
 428 };
 429
 430 #endif