include/channels.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2004 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 #include "inspircd_config.h"
  18 #include "base.h"
  19 #include <time.h>
  20 #include <vector>
  21 #include <string>
  22
  23 #ifndef __CHANNELS_H__
  24 #define __CHANNELS_H__
  25
  26 /** Holds an entry for a ban list, exemption list, or invite list.
  27  * This class contains a single element in a channel list, such as a banlist.
  28  */
  29 class HostItem : public classbase
  30 {
  31  public:
  32         time_t set_time;
  33         char set_by[NICKMAX];
  34         char data[MAXBUF];
  35
  36         HostItem() { /* stub */ }
  37         virtual ~HostItem() { /* stub */ }
  38 };
  39
  40 // banlist is inherited from HostList mainly for readability
  41 // reasons only
  42
  43 /** A subclass of HostItem designed to hold channel bans (+b)
  44  */
  45 class BanItem : public HostItem
  46 {
  47 };
  48
  49 // same with this...
  50
  51 /** A subclass of HostItem designed to hold channel exempts (+e)
  52  */
  53 class ExemptItem : public HostItem
  54 {
  55 };
  56
  57 // and this...
  58
  59 /** A subclass of HostItem designed to hold channel invites (+I)
  60  */
  61 class InviteItem : public HostItem
  62 {
  63 };
  64
  65
  66 /** Holds a custom parameter to a module-defined channel mode
  67   * e.g. for +L this would hold the channel name.
  68   */
  69
  70 class ModeParameter : public classbase
  71 {
  72  public:
  73         char mode;
  74         char parameter[MAXBUF];
  75         char channel[CHANMAX];
  76 };
  77
  78 /** Holds a complete ban list
  79  */
  80 typedef std::vector<BanItem>    BanList;
  81
  82 /** Holds a complete exempt list
  83  */
  84 typedef std::vector<ExemptItem> ExemptList;
  85
  86 /** Holds a complete invite list
  87  */
  88 typedef std::vector<InviteItem> InviteList;
  89
  90 /** Holds all relevent information for a channel.
  91  * This class represents a channel, and contains its name, modes, time created, topic, topic set time,
  92  * etc, and an instance of the BanList type.
  93  */
  94 class chanrec : public Extensible
  95 {
  96  public:
  97         /** The channels name.
  98          */
  99         char name[CHANMAX]; /* channel name */
 100         /** Custom modes for the channel.
 101          * Plugins may use this field in any way they see fit.
 102          */
 103         char custom_modes[MAXMODES];     /* modes handled by modules */
 104
 105         /** Count of users on the channel used for fast user counting
 106          */
 107         long users;
 108
 109         /** Channel topic.
 110          * If this is an empty string, no channel topic is set.
 111          */
 112         char topic[MAXBUF];
 113         /** Creation time.
 114          */
 115         time_t created;
 116         /** Time topic was set.
 117          * If no topic was ever set, this will be equal to chanrec::created
 118          */
 119         time_t topicset;
 120         /** The last user to set the topic.
 121          * If this member is an empty string, no topic was ever set.
 122          */
 123         char setby[NICKMAX];
 124
 125         /** Contains the channel user limit.
 126          * If this value is zero, there is no limit in place.
 127          */
 128         long limit;
 129
 130         /** Contains the channel key.
 131          * If this value is an empty string, there is no channel key in place.
 132          */
 133         char key[32];
 134
 135         /** Nonzero if the mode +t is set.
 136          */
 137         short int topiclock;
 138
 139         /** Nonzero if the mode +n is set.
 140          */
 141         short int noexternal;
 142
 143         /** Nonzero if the mode +i is set.
 144          */
 145         short int inviteonly;
 146
 147         /** Nonzero if the mode +m is set.
 148          */
 149         short int moderated;
 150
 151         /** Nonzero if the mode +s is set.
 152          * This value cannot be set at the same time as chanrec::c_private
 153          */
 154         short int secret;
 155
 156         /** Nonzero if the mode +p is set.
 157          * This value cannot be set at the same time as chanrec::secret
 158          */
 159         short int c_private;
 160
 161         /** The list of all bans set on the channel.
 162          */
 163         BanList bans;
 164
 165         /** Sets or unsets a custom mode in the channels info
 166          */
 167         void SetCustomMode(char mode,bool mode_on);
 168
 169         /** Sets or unsets the parameters for a custom mode in a channels info
 170          */
 171         void SetCustomModeParam(char mode,char* parameter,bool mode_on);
 172
 173         /** Returns true if a custom mode is set on a channel
 174           */
 175         bool IsCustomModeSet(char mode);
 176
 177         /** Returns the parameter for a custom mode on a channel.
 178           * For example if "+L #foo" is set, and you pass this method
 179           * 'L', it will return '#foo'. If the mode is not set on the
 180           * channel, or the mode has no parameters associated with it,
 181           * it will return an empty string.
 182           */
 183         std::string GetModeParameter(char mode);
 184
 185         void IncUserCounter();
 186         void DecUserCounter();
 187         long GetUserCounter();
 188
 189
 190         /** Creates a channel record and initialises it with default values
 191          */
 192         chanrec();
 193
 194         virtual ~chanrec() { /* stub */ }
 195 };
 196
 197 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
 198  * needs to come AFTER struct chanrec */
 199
 200 #define UCMODE_OP      1
 201 #define UCMODE_VOICE   2
 202 #define UCMODE_HOP     4
 203 #define UCMODE_PROTECT 8
 204 #define UCMODE_FOUNDER 16
 205
 206 /** Holds a user's modes on a channel
 207  * This class associates a users privilages with a channel by creating a pointer link between
 208  * a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
 209  * has on the channel, such as op, voice, etc.
 210  */
 211 class ucrec : public classbase
 212 {
 213  public:
 214         /** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
 215          * If this value is zero, the user has no privilages upon the channel.
 216          */
 217         long uc_modes;
 218
 219         /** Points to the channel record where the given modes apply.
 220          * If the record is not in use, this value will be NULL.
 221          */
 222         chanrec *channel;
 223
 224         ucrec() { /* stub */ }
 225         virtual ~ucrec() { /* stub */ }
 226 };
 227
 228 #endif
 229