1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*
$Log$
Revision 1.1 2003/01/23 19:45:58 brain
Initial revision
Revision 1.7 2003/01/22 00:44:26 brain
Added documentation comments
Revision 1.6 2003/01/21 21:11:17 brain
Added documentation
Revision 1.5 2003/01/16 20:11:55 brain
fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
Revision 1.4 2003/01/15 22:47:44 brain
Changed user and channel structs to classes (finally)
*/
#include "inspircd_config.h"
#include <time.h>
#include <vector>
#ifndef __CHANNELS_H__
#define __CHANNELS_H__
/** Holds an entry for a ban list, exemption list, or invite list.
* This class contains a single element in a channel list, such as a banlist.
*/
class HostItem
{
public:
time_t set_time;
char set_by[NICKMAX];
char data[MAXBUF];
HostItem() { /* stub */ }
virtual ~HostItem() { /* stub */ }
};
// banlist is inherited from HostList mainly for readability
// reasons only
/** A subclass of HostItem designed to hold channel bans (+b)
*/
class BanItem : public HostItem
{
};
// same with this...
/** A subclass of HostItem designed to hold channel exempts (+e)
*/
class ExemptItem : public HostItem
{
};
// and this...
/** A subclass of HostItem designed to hold channel invites (+I)
*/
class InviteItem : public HostItem
{
};
/** Holds a complete ban list
*/
typedef vector<BanItem> BanList;
/** Holds a complete exempt list
*/
typedef vector<ExemptItem> ExemptList;
/** Holds a complete invite list
*/
typedef vector<InviteItem> InviteList;
/** Holds all relevent information for a channel.
* This class represents a channel, and contains its name, modes, time created, topic, topic set time,
* etc, and an instance of the BanList type.
*/
class chanrec
{
public:
/** The channels name.
*/
char name[CHANMAX]; /* channel name */
/** Custom modes for the channel.
* Plugins may use this field in any way they see fit.
*/
char custom_modes[MAXMODES]; /* modes handled by modules */
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
char topic[MAXBUF];
/** Creation time.
*/
time_t created;
/** Time topic was set.
* If no topic was ever set, this will be equal to chanrec::created
*/
time_t topicset;
/** The last user to set the topic.
* If this member is an empty string, no topic was ever set.
*/
char setby[NICKMAX];
/** Contains the channel user limit.
* If this value is zero, there is no limit in place.
*/
long limit;
/** Contains the channel key.
* If this value is an empty string, there is no channel key in place.
*/
char key[32];
/** Nonzero if the mode +t is set.
*/
short int topiclock;
/** Nonzero if the mode +n is set.
*/
short int noexternal;
/** Nonzero if the mode +i is set.
*/
short int inviteonly;
/** Nonzero if the mode +m is set.
*/
short int moderated;
/** Nonzero if the mode +s is set.
* This value cannot be set at the same time as chanrec::c_private
*/
short int secret;
/** Nonzero if the mode +p is set.
* This value cannot be set at the same time as chanrec::secret
*/
short int c_private;
/** The list of all bans set on the channel.
*/
BanList bans;
/** Creates a channel record and initialises it with default values
*/
chanrec()
{
strcpy(name,"");
strcpy(custom_modes,"");
strcpy(topic,"");
strcpy(setby,"");
strcpy(key,"");
created = topicset = limit = 0;
topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
}
virtual ~chanrec() { /* stub */ }
};
/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
* needs to come AFTER struct chanrec */
#define UCMODE_OP 1
#define UCMODE_VOICE 2
#define UCMODE_HOP 4
#define UCMODE_PROTECT 8
#define UCMODE_FOUNDER 16
/** Holds a user's modes on a channel
* This class associates a users privilages with a channel by creating a pointer link between
* a userrec and chanrec class. The uc_modes member holds a bitmask of which privilages the user
* has on the channel, such as op, voice, etc.
*/
class ucrec
{
public:
/** Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values.
* If this value is zero, the user has no privilages upon the channel.
*/
long uc_modes;
/** Points to the channel record where the given modes apply.
* If the record is not in use, this value will be NULL.
*/
chanrec *channel;
ucrec() { /* stub */ }
virtual ~ucrec() { /* stub */ }
};
#endif
|
