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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
|
/* Copyright (C) 2005-2007, Thorvald Natvig <thorvald@natvig.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of the Mumble Developers nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _MESSAGE_H
#define _MESSAGE_H
#define MESSAGE_STREAM_VERSION 2
#include "ACL.h"
class Connection;
class PacketDataStream;
class Message {
protected:
virtual void saveStream(PacketDataStream &) const;
virtual void restoreStream(PacketDataStream &);
public:
enum MessageType { ServerReject, ServerAuthenticate, Speex, ServerSync, ServerJoin, ServerLeave, ServerBanList, PlayerMute, PlayerDeaf, PlayerKick, PlayerRename, PlayerBan, PlayerMove, PlayerSelfMuteDeaf, ChannelAdd, ChannelRemove, ChannelMove, ChannelLink, PermissionDenied, EditACL, QueryUsers, Ping, TextMessage, PlayerTexture, CryptSetup, CryptSync };
unsigned int uiSession;
Message();
virtual ~Message();
virtual Message::MessageType messageType() const = 0;
virtual bool isValid() const;
void messageToNetwork(QByteArray &) const;
void messageToNetwork(PacketDataStream &) const;
static Message *networkToMessage(QByteArray &);
static Message *networkToMessage(PacketDataStream &);
};
class MessageSpeex : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
enum { AltSpeak = 0x01, LoopBack = 0x02, EndSpeech = 0x04, FrameCountMask = 0x50 };
unsigned int iSeq;
// Flags is in first byte of packet.
QByteArray qbaSpeexPacket;
Message::MessageType messageType() const {
return Speex;
};
bool isValid() const;
};
class MessageServerAuthenticate : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iVersion;
int iMaxBandwidth;
QString qsUsername;
QString qsPassword;
MessageServerAuthenticate();
Message::MessageType messageType() const {
return ServerAuthenticate;
};
};
class MessagePing : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
quint64 uiTimestamp;
Message::MessageType messageType() const {
return Ping;
};
};
class MessageServerReject : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
enum RejectType { None, WrongVersion, InvalidUsername, WrongUserPW, WrongServerPW, UsernameInUse, BandwidthExceeded, ServerFull };
QString qsReason;
RejectType rtType;
Message::MessageType messageType() const {
return ServerReject;
};
};
class MessageServerSync : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iMaxBandwidth;
QString qsWelcomeText;
Message::MessageType messageType() const {
return ServerSync;
};
};
class MessageServerJoin : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QString qsPlayerName;
int iId;
Message::MessageType messageType() const {
return ServerJoin;
};
};
class MessageServerLeave : public Message {
public:
Message::MessageType messageType() const {
return ServerLeave;
};
};
class MessagePlayerMute : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
bool bMute;
Message::MessageType messageType() const {
return PlayerMute;
};
};
class MessagePlayerDeaf : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
bool bDeaf;
Message::MessageType messageType() const {
return PlayerDeaf;
};
};
class MessagePlayerSelfMuteDeaf : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
bool bMute;
bool bDeaf;
Message::MessageType messageType() const {
return PlayerSelfMuteDeaf;
};
};
class MessagePlayerKick : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
QString qsReason;
Message::MessageType messageType() const {
return PlayerKick;
};
};
class MessagePlayerBan : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
QString qsReason;
Message::MessageType messageType() const {
return PlayerBan;
};
};
class MessagePlayerMove : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
int iChannelId;
Message::MessageType messageType() const {
return PlayerMove;
};
};
class MessagePlayerRename : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QString qsName;
Message::MessageType messageType() const {
return PlayerRename;
};
};
class MessageChannelAdd : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iId;
int iParent;
QString qsName;
Message::MessageType messageType() const {
return ChannelAdd;
};
};
class MessageChannelRemove : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iId;
Message::MessageType messageType() const {
return ChannelRemove;
};
};
class MessageChannelMove : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iId;
int iParent;
Message::MessageType messageType() const {
return ChannelMove;
};
};
class MessageChannelLink : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
enum LinkType {
Link, Unlink, UnlinkAll, PushLink, PushUnlink
};
int iId;
LinkType ltType;
QList<int> qlTargets;
Message::MessageType messageType() const {
return ChannelLink;
};
};
class MessageServerBanList : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
bool bQuery;
QList<QPair<quint32, int> > qlBans;
Message::MessageType messageType() const {
return ServerBanList;
};
};
class MessageTextMessage : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
unsigned int uiVictim;
QString qsMessage;
Message::MessageType messageType() const {
return TextMessage;
};
};
class MessagePermissionDenied : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QString qsReason;
Message::MessageType messageType() const {
return PermissionDenied;
};
};
class MessageEditACL : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
struct GroupStruct {
QString qsName;
bool bInherited;
bool bInherit;
bool bInheritable;
QSet<int> qsAdd;
QSet<int> qsRemove;
QSet<int> qsInheritedMembers;
};
struct ACLStruct {
bool bApplyHere;
bool bApplySubs;
bool bInherited;
int iPlayerId;
QString qsGroup;
ChanACL::Permissions pAllow;
ChanACL::Permissions pDeny;
};
int iId;
bool bQuery;
bool bInheritACL;
QList<GroupStruct> groups;
QList<ACLStruct> acls;
Message::MessageType messageType() const {
return EditACL;
};
};
PacketDataStream & operator<< (PacketDataStream & out, const MessageEditACL::GroupStruct &gs);
PacketDataStream & operator>> (PacketDataStream & in, MessageEditACL::GroupStruct &gs);
PacketDataStream & operator<< (PacketDataStream & out, const MessageEditACL::ACLStruct &gs);
PacketDataStream & operator>> (PacketDataStream & in, MessageEditACL::ACLStruct &gs);
class MessageQueryUsers : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QList<int> qlIds;
QList<QString> qlNames;
Message::MessageType messageType() const {
return QueryUsers;
};
bool isValid() const;
};
class MessageTexture : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
int iPlayerId;
QByteArray qbaTexture;
Message::MessageType messageType() const {
return PlayerTexture;
}
};
class MessageCryptSetup : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QByteArray qbaKey, qbaClientNonce, qbaServerNonce;
Message::MessageType messageType() const {
return CryptSetup;
}
bool isValid() const;
};
class MessageCryptSync : public Message {
protected:
void saveStream(PacketDataStream &) const;
void restoreStream(PacketDataStream &);
public:
QByteArray qbaNonce;
Message::MessageType messageType() const {
return PlayerTexture;
}
bool isValid() const;
};
class MessageHandler {
protected:
virtual void msgSpeex(Connection *, MessageSpeex *) = 0;
virtual void msgServerAuthenticate(Connection *, MessageServerAuthenticate *) = 0;
virtual void msgPing(Connection *, MessagePing *) = 0;
virtual void msgServerReject(Connection *, MessageServerReject *) = 0;
virtual void msgServerSync(Connection *, MessageServerSync *) = 0;
virtual void msgServerJoin(Connection *, MessageServerJoin *) = 0;
virtual void msgServerLeave(Connection *, MessageServerLeave *) = 0;
virtual void msgPlayerMute(Connection *, MessagePlayerMute *) = 0;
virtual void msgPlayerDeaf(Connection *, MessagePlayerDeaf *) = 0;
virtual void msgPlayerSelfMuteDeaf(Connection *, MessagePlayerSelfMuteDeaf *) = 0;
virtual void msgPlayerKick(Connection *, MessagePlayerKick *) = 0;
virtual void msgPlayerBan(Connection *, MessagePlayerBan *) = 0;
virtual void msgPlayerMove(Connection *, MessagePlayerMove *) = 0;
virtual void msgPlayerRename(Connection *, MessagePlayerRename *) = 0;
virtual void msgChannelAdd(Connection *, MessageChannelAdd *) = 0;
virtual void msgChannelRemove(Connection *, MessageChannelRemove *) = 0;
virtual void msgChannelMove(Connection *, MessageChannelMove *) = 0;
virtual void msgChannelLink(Connection *, MessageChannelLink *) = 0;
virtual void msgServerBanList(Connection *, MessageServerBanList *) = 0;
virtual void msgTextMessage(Connection *, MessageTextMessage *) = 0;
virtual void msgPermissionDenied(Connection *, MessagePermissionDenied *) = 0;
virtual void msgEditACL(Connection *, MessageEditACL *) = 0;
virtual void msgQueryUsers(Connection *, MessageQueryUsers *) = 0;
virtual void msgTexture(Connection *, MessageTexture *) = 0;
virtual void msgCryptSetup(Connection *, MessageCryptSetup *) = 0;
virtual void msgCryptSync(Connection *, MessageCryptSync *) = 0;
void dispatch(Connection *, Message *);
public:
virtual ~MessageHandler() { };
};
#else
class Message;
#endif
|