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 #define CM_TOPICLOCK 1
  28 #define CM_NOEXTERNAL 2
  29 #define CM_INVITEONLY 4
  30 #define CM_MODERATED 8
  31 #define CM_SECRET 16
  32 #define CM_PRIVATE 32
  33
  34 class userrec;
  35
  36 /** Holds an entry for a ban list, exemption list, or invite list.
  37  * This class contains a single element in a channel list, such as a banlist.
  38  */
  39 class HostItem : public classbase
  40 {
  41  public:
  42         time_t set_time;
  43         char set_by[NICKMAX];
  44         char data[MAXBUF];
  45
  46         HostItem() { /* stub */ }
  47         virtual ~HostItem() { /* stub */ }
  48 };
  49
  50 // banlist is inherited from HostList mainly for readability
  51 // reasons only
  52
  53 /** A subclass of HostItem designed to hold channel bans (+b)
  54  */
  55 class BanItem : public HostItem
  56 {
  57 };
  58
  59 // same with this...
  60
  61 /** A subclass of HostItem designed to hold channel exempts (+e)
  62  */
  63 class ExemptItem : public HostItem
  64 {
  65 };
  66
  67 // and this...
  68
  69 /** A subclass of HostItem designed to hold channel invites (+I)
  70  */
  71 class InviteItem : public HostItem
  72 {
  73 };
  74
  75 /** Holds a complete ban list
  76  */
  77 typedef std::vector<BanItem>    BanList;
  78
  79 /** Holds a complete exempt list
  80  */
  81 typedef std::vector<ExemptItem> ExemptList;
  82
  83 /** Holds a complete invite list
  84  */
  85 typedef std::vector<InviteItem> InviteList;
  86
  87 /** Holds all relevent information for a channel.
  88  * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
  89  * etc, and an instance of the BanList type.
  90  */
  91 class chanrec : public Extensible
  92 {
  93  public:
  94         /** The channels name.
  95          */
  96         char name[CHANMAX]; /* channel name */
  97         /** Custom modes for the channel.
  98          * Plugins may use this field in any way they see fit.
  99          */
 100         char custom_modes[190];     /* modes handled by modules */
 101
 102         /** User list (casted to char*'s to stop forward declaration stuff)
 103          * (chicken and egg scenario!)
 104          */
 105         std::map<char*,char*> internal_userlist;
 106         std::map<char*,char*> internal_op_userlist;
 107         std::map<char*,char*> internal_halfop_userlist;
 108         std::map<char*,char*> internal_voice_userlist;
 109
 110         /** Parameters for custom modes
 111          */
 112         std::map<char,char*> custom_mode_params;
 113
 114         /** Channel topic.
 115          * If this is an empty string, no channel topic is set.
 116          */
 117         char topic[MAXBUF];
 118         /** Creation time.
 119          */
 120         time_t created;
 121         /** Time topic was set.
 122          * If no topic was ever set, this will be equal to chanrec::created
 123          */
 124         time_t topicset;
 125         /** The last user to set the topic.
 126          * If this member is an empty string, no topic was ever set.
 127          */
 128         char setby[NICKMAX];
 129
 130         /** Contains the channel user limit.
 131          * If this value is zero, there is no limit in place.
 132          */
 133         short int limit;
 134
 135         /** Contains the channel key.
 136          * If this value is an empty string, there is no channel key in place.
 137          */
 138         char key[32];
 139
 140         /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
 141          */
 142         char binarymodes;
 143
 144         /** The list of all bans set on the channel.
 145          */
 146         BanList bans;
 147
 148         /** Sets or unsets a custom mode in the channels info
 149          * @param mode The mode character to set or unset
 150          * @param mode_on True if you want to set the mode or false if you want to remove it
 151          */
 152         void SetCustomMode(char mode,bool mode_on);
 153
 154         /** Sets or unsets the parameters for a custom mode in a channels info
 155          * @param mode The mode character to set or unset
 156          * @param parameter The parameter string to associate with this mode character
 157          * @param mode_on True if you want to set the mode or false if you want to remove it
 158          */
 159         void SetCustomModeParam(char mode,char* parameter,bool mode_on);
 160
 161         /** Returns true if a custom mode is set on a channel
 162           * @param mode The mode character you wish to query
 163           * @return True if the custom mode is set, false if otherwise
 164           */
 165         bool IsCustomModeSet(char mode);
 166
 167         /** Returns the parameter for a custom mode on a channel.
 168           * @param mode The mode character you wish to query
 169           *
 170           * For example if "+L #foo" is set, and you pass this method
 171           * 'L', it will return '#foo'. If the mode is not set on the
 172           * channel, or the mode has no parameters associated with it,
 173           * it will return an empty string.
 174           *
 175           * @return The parameter for this mode is returned, or an empty string
 176           */
 177         std::string GetModeParameter(char mode);
 178
 179         /** Obtain the channel "user counter"
 180          * This returns the channel reference counter, which is initialized
 181          * to 0 when the channel is created and incremented/decremented
 182          * upon joins, parts quits and kicks.
 183          *
 184          * @return The number of users on this channel
 185          */
 186         long GetUserCounter();
 187
 188         /** Add a user pointer to the internal reference list
 189          * @param castuser This should be a pointer to a userrec, casted to char*
 190          *
 191          * The data inserted into the reference list is a table as it is
 192          * an arbitary pointer compared to other users by its memory address,
 193          * as this is a very fast 32 or 64 bit integer comparison.
 194          */
 195         void AddUser(char* castuser);
 196         void AddOppedUser(char* castuser);
 197         void AddHalfoppedUser(char* castuser);
 198         void AddVoicedUser(char* castuser);
 199
 200         /** Delete a user pointer to the internal reference list
 201          * @param castuser This should be a pointer to a userrec, casted to char*
 202          *
 203          * The data removed from the reference list is a table as it is
 204          * an arbitary pointer compared to other users by its memory address,
 205          * as this is a very fast 32 or 64 bit integer comparison.
 206          */
 207         void DelUser(char* castuser);
 208         void DelOppedUser(char* castuser);
 209         void DelHalfoppedUser(char* castuser);
 210         void DelVoicedUser(char* castuser);
 211
 212         /** Obrain the internal reference list
 213          * The internal reference list contains a list of userrec*
 214          * cast to char*. These are used for rapid comparison to determine
 215          * channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
 216          * The resulting pointer to the vector should be considered
 217          * readonly and only modified via AddUser and DelUser.
 218          *
 219          * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
 220          */
 221         std::map<char*,char*> *GetUsers();
 222         std::map<char*,char*> *GetOppedUsers();
 223         std::map<char*,char*> *GetHalfoppedUsers();
 224         std::map<char*,char*> *GetVoicedUsers();
 225
 226         /** Creates a channel record and initialises it with default values
 227          */
 228         chanrec();
 229
 230         virtual ~chanrec() { /* stub */ }
 231 };
 232
 233 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
 234  * needs to come AFTER struct chanrec */
 235
 236 #define UCMODE_OP      1
 237 #define UCMODE_VOICE   2
 238 #define UCMODE_HOP     4
 239 #define UCMODE_PROTECT 8
 240 #define UCMODE_FOUNDER 16
 241
 242 /** Holds a user's modes on a channel
 243  * This class associates a users privilages with a channel by creating a pointer link between
 244  * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
 245  * has on the channel, such as op, voice, etc.
 246  */
 247 class ucrec : public classbase
 248 {
 249  public:
 250         /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
 251          * If this value is zero, the user has no privilages upon the channel.
 252          */
 253         char uc_modes;
 254
 255         /** Points to the channel record where the given modes apply.
 256          * If the record is not in use, this value will be NULL.
 257          */
 258         chanrec *channel;
 259
 260         ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
 261         virtual ~ucrec() { /* stub */ }
 262 };
 263
 264 chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
 265 chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
 266 void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
 267 void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents);
 268
 269 #endif
 270