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
  76 /** Holds a custom parameter to a module-defined channel mode
  77   * e.g. for +L this would hold the channel name.
  78   */
  79
  80 class ModeParameter : public classbase
  81 {
  82  public:
  83         char mode;
  84         char parameter[MAXBUF];
  85         char channel[CHANMAX];
  86 };
  87
  88 /** Holds a complete ban list
  89  */
  90 typedef std::vector<BanItem>    BanList;
  91
  92 /** Holds a complete exempt list
  93  */
  94 typedef std::vector<ExemptItem> ExemptList;
  95
  96 /** Holds a complete invite list
  97  */
  98 typedef std::vector<InviteItem> InviteList;
  99
 100 /** Holds all relevent information for a channel.
 101  * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
 102  * etc, and an instance of the BanList type.
 103  */
 104 class chanrec : public Extensible
 105 {
 106  public:
 107         /** The channels name.
 108          */
 109         char name[CHANMAX]; /* channel name */
 110         /** Custom modes for the channel.
 111          * Plugins may use this field in any way they see fit.
 112          */
 113         char custom_modes[MAXMODES];     /* modes handled by modules */
 114
 115         /** User list (casted to char*'s to stop forward declaration stuff)
 116          * (chicken and egg scenario!)
 117          */
 118         std::map<char*,char*> internal_userlist;
 119
 120         /** Channel topic.
 121          * If this is an empty string, no channel topic is set.
 122          */
 123         char topic[MAXBUF];
 124         /** Creation time.
 125          */
 126         time_t created;
 127         /** Time topic was set.
 128          * If no topic was ever set, this will be equal to chanrec::created
 129          */
 130         time_t topicset;
 131         /** The last user to set the topic.
 132          * If this member is an empty string, no topic was ever set.
 133          */
 134         char setby[NICKMAX];
 135
 136         /** Contains the channel user limit.
 137          * If this value is zero, there is no limit in place.
 138          */
 139         short int limit;
 140
 141         /** Contains the channel key.
 142          * If this value is an empty string, there is no channel key in place.
 143          */
 144         char key[32];
 145
 146         /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
 147          */
 148         char binarymodes;
 149
 150         /** The list of all bans set on the channel.
 151          */
 152         BanList bans;
 153
 154         /** Sets or unsets a custom mode in the channels info
 155          * @param mode The mode character to set or unset
 156          * @param mode_on True if you want to set the mode or false if you want to remove it
 157          */
 158         void SetCustomMode(char mode,bool mode_on);
 159
 160         /** Sets or unsets the parameters for a custom mode in a channels info
 161          * @param mode The mode character to set or unset
 162          * @param parameter The parameter string to associate with this mode character
 163          * @param mode_on True if you want to set the mode or false if you want to remove it
 164          */
 165         void SetCustomModeParam(char mode,char* parameter,bool mode_on);
 166
 167         /** Returns true if a custom mode is set on a channel
 168           * @param mode The mode character you wish to query
 169           * @return True if the custom mode is set, false if otherwise
 170           */
 171         bool IsCustomModeSet(char mode);
 172
 173         /** Returns the parameter for a custom mode on a channel.
 174           * @param mode The mode character you wish to query
 175           *
 176           * For example if "+L #foo" is set, and you pass this method
 177           * 'L', it will return '#foo'. If the mode is not set on the
 178           * channel, or the mode has no parameters associated with it,
 179           * it will return an empty string.
 180           *
 181           * @return The parameter for this mode is returned, or an empty string
 182           */
 183         std::string GetModeParameter(char mode);
 184
 185         /** Obtain the channel "user counter"
 186          * This returns the channel reference counter, which is initialized
 187          * to 0 when the channel is created and incremented/decremented
 188          * upon joins, parts quits and kicks.
 189          *
 190          * @return The number of users on this channel
 191          */
 192         long GetUserCounter();
 193
 194         /** Add a user pointer to the internal reference list
 195          * @param castuser This should be a pointer to a userrec, casted to char*
 196          *
 197          * The data inserted into the reference list is a table as it is
 198          * an arbitary pointer compared to other users by its memory address,
 199          * as this is a very fast 32 or 64 bit integer comparison.
 200          */
 201         void AddUser(char* castuser);
 202
 203         /** Delete a user pointer to the internal reference list
 204          * @param castuser This should be a pointer to a userrec, casted to char*
 205          *
 206          * The data removed from the reference list is a table as it is
 207          * an arbitary pointer compared to other users by its memory address,
 208          * as this is a very fast 32 or 64 bit integer comparison.
 209          */
 210         void DelUser(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
 223         /** Creates a channel record and initialises it with default values
 224          */
 225         chanrec();
 226
 227         virtual ~chanrec() { /* stub */ }
 228 };
 229
 230 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
 231  * needs to come AFTER struct chanrec */
 232
 233 #define UCMODE_OP      1
 234 #define UCMODE_VOICE   2
 235 #define UCMODE_HOP     4
 236 #define UCMODE_PROTECT 8
 237 #define UCMODE_FOUNDER 16
 238
 239 /** Holds a user's modes on a channel
 240  * This class associates a users privilages with a channel by creating a pointer link between
 241  * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
 242  * has on the channel, such as op, voice, etc.
 243  */
 244 class ucrec : public classbase
 245 {
 246  public:
 247         /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
 248          * If this value is zero, the user has no privilages upon the channel.
 249          */
 250         char uc_modes;
 251
 252         /** Points to the channel record where the given modes apply.
 253          * If the record is not in use, this value will be NULL.
 254          */
 255         chanrec *channel;
 256
 257         ucrec() { /* stub */ }
 258         virtual ~ucrec() { /* stub */ }
 259 };
 260
 261 chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
 262 chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
 263 void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
 264
 265 #endif
 266