src/messages.h

   1 /* Copyright (C) 2009-2011, Martin Johansson <martin@fatbob.nu>
   2    Copyright (C) 2005-2011, Thorvald Natvig <thorvald@natvig.com>
   3
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    - Redistributions of source code must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    - Redistributions in binary form must reproduce the above copyright notice,
  13      this list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15    - Neither the name of the Developers nor the names of its contributors may
  16      be used to endorse or promote products derived from this software without
  17      specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31 #ifndef MESSAGES_H_89768
  32 #define MESSAGES_H_89768
  33
  34 #include <stdint.h>
  35 #include "Mumble.pb-c.h"
  36 #include "list.h"
  37 #include "types.h"
  38
  39 #define PROTVER_MAJOR 1
  40 #define PROTVER_MINOR 2
  41 #define PROTVER_PATCH 3
  42 #define PROTOCOL_VERSION ((PROTVER_MAJOR << 16) | (PROTVER_MINOR << 8) | (PROTVER_PATCH))
  43
  44 #define PERM_NONE 0x0
  45 #define PERM_WRITE 0x1
  46 #define PERM_TRAVERSE 0x2
  47 #define PERM_ENTER 0x4
  48 #define PERM_SPEAK 0x8
  49 #define PERM_MUTEDEAFEN 0x10
  50 #define PERM_MOVE 0x20
  51 #define PERM_MAKECHANNEL 0x40
  52 #define PERM_LINKCHANNEL 0x80
  53 #define PERM_WHISPER 0x100
  54 #define PERM_TEXTMESSAGE 0x200
  55 #define PERM_MAKETEMPCHANNEL 0x400
  56 // Root channel only
  57 #define PERM_KICK 0x10000
  58 #define PERM_BAN 0x20000
  59 #define PERM_REGISTER 0x40000
  60 #define PERM_SELFREGISTER 0x80000
  61 #define PERM_CACHED 0x8000000
  62 #define PERM_ALL 0xf07ff
  63
  64 #define PERM_DEFAULT (PERM_TRAVERSE | PERM_ENTER | PERM_SPEAK | PERM_WHISPER | PERM_TEXTMESSAGE | PERM_MAKETEMPCHANNEL)
  65
  66 typedef enum {
  67         Version,
  68         UDPTunnel,
  69         Authenticate,
  70         Ping,
  71         Reject,
  72         ServerSync,
  73         ChannelRemove,
  74         ChannelState,
  75         UserRemove,
  76         UserState,
  77         BanList, /* 10 */
  78         TextMessage,
  79         PermissionDenied,
  80         ACL,
  81         QueryUsers,
  82         CryptSetup,
  83         ContextActionAdd,
  84         ContextAction,
  85         UserList,
  86         VoiceTarget,
  87         PermissionQuery, /* 20 */
  88         CodecVersion,
  89         UserStats,
  90         RequestBlob,
  91         ServerConfig
  92 } messageType_t;
  93
  94 typedef enum {
  95         UDPVoiceCELTAlpha,
  96         UDPPing,
  97         UDPVoiceSpeex,
  98         UDPVoiceCELTBeta,
  99 } UDPMessageType_t;
 100
 101
 102 typedef union payload {
 103         struct  _MumbleProto__Version *version;
 104         struct  _MumbleProto__UDPTunnel *UDPTunnel;
 105         struct  _MumbleProto__Authenticate *authenticate;
 106         struct  _MumbleProto__Ping *ping;
 107         struct  _MumbleProto__Reject *reject;
 108         struct  _MumbleProto__ServerSync *serverSync;
 109         struct  _MumbleProto__ChannelRemove *channelRemove;
 110         struct  _MumbleProto__ChannelState *channelState;
 111         struct  _MumbleProto__UserRemove *userRemove;
 112         struct  _MumbleProto__UserState *userState;
 113         /* BanEntry not supported */
 114         /* BanList not supported */
 115         struct  _MumbleProto__TextMessage *textMessage;
 116         struct  _MumbleProto__PermissionDenied *permissionDenied;
 117         /* ChanACL not supported */
 118         /* ACL not supported */
 119         struct  _MumbleProto__QueryUsers *queryUsers;
 120         struct  _MumbleProto__CryptSetup *cryptSetup;
 121         /* ContextActionAdd not supported */
 122         /* ContextAction not supported */
 123         struct  _MumbleProto__UserList__User *userList_user;
 124         struct  _MumbleProto__UserList *userList;
 125         struct  _MumbleProto__VoiceTarget__Target *voiceTarget_target;
 126         struct  _MumbleProto__VoiceTarget *voiceTarget;
 127         struct  _MumbleProto__PermissionQuery *permissionQuery;
 128         struct  _MumbleProto__CodecVersion *codecVersion;
 129         struct  _MumbleProto__UserStats *userStats;
 130         struct  _MumbleProto__ServerConfig *serverConfig;
 131 } payload_t;
 132
 133 typedef struct message {
 134         messageType_t messageType;
 135         int refcount;
 136         struct dlist node;
 137         bool_t unpacked;
 138         payload_t payload;
 139 } message_t;
 140
 141
 142 int Msg_messageToNetwork(message_t *msg, uint8_t *buffer);
 143 message_t *Msg_networkToMessage(uint8_t *data, int size);
 144 void Msg_free(message_t *msg);
 145 void Msg_inc_ref(message_t *msg);
 146
 147 message_t *Msg_CreateVoiceMsg(uint8_t *data, int size);
 148 message_t *Msg_create(messageType_t messageType);
 149
 150 #endif