src/network/clientopcodes.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2015 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #include "clientopcodes.h"
  22
  23 const static ToClientCommandHandler null_command_handler = {"TOCLIENT_NULL", TOCLIENT_STATE_ALL, &Client::handleCommand_Null};
  24
  25 const ToClientCommandHandler toClientCommandTable[TOCLIENT_NUM_MSG_TYPES] =
  26 {
  27         null_command_handler, // 0x00 (never use this)
  28         null_command_handler, // 0x01
  29         { "TOCLIENT_HELLO",                   TOCLIENT_STATE_NOT_CONNECTED, &Client::handleCommand_Hello }, // 0x02
  30         { "TOCLIENT_AUTH_ACCEPT",             TOCLIENT_STATE_NOT_CONNECTED, &Client::handleCommand_AuthAccept }, // 0x03
  31         { "TOCLIENT_ACCEPT_SUDO_MODE",        TOCLIENT_STATE_CONNECTED, &Client::handleCommand_AcceptSudoMode}, // 0x04
  32         { "TOCLIENT_DENY_SUDO_MODE",          TOCLIENT_STATE_CONNECTED, &Client::handleCommand_DenySudoMode}, // 0x05
  33         null_command_handler, // 0x06
  34         null_command_handler, // 0x07
  35         null_command_handler, // 0x08
  36         null_command_handler, // 0x09
  37         { "TOCLIENT_ACCESS_DENIED",           TOCLIENT_STATE_NOT_CONNECTED, &Client::handleCommand_AccessDenied }, // 0x0A
  38         null_command_handler, // 0x0B
  39         null_command_handler, // 0x0C
  40         null_command_handler, // 0x0D
  41         null_command_handler, // 0x0E
  42         null_command_handler, // 0x0F
  43         null_command_handler, // 0x10
  44         null_command_handler,
  45         null_command_handler,
  46         null_command_handler,
  47         null_command_handler,
  48         null_command_handler,
  49         null_command_handler,
  50         null_command_handler,
  51         null_command_handler,
  52         null_command_handler,
  53         null_command_handler,
  54         null_command_handler,
  55         null_command_handler,
  56         null_command_handler,
  57         null_command_handler,
  58         null_command_handler,
  59         { "TOCLIENT_BLOCKDATA",                TOCLIENT_STATE_CONNECTED, &Client::handleCommand_BlockData }, // 0x20
  60         { "TOCLIENT_ADDNODE",                  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_AddNode }, // 0x21
  61         { "TOCLIENT_REMOVENODE",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_RemoveNode }, // 0x22
  62         null_command_handler,
  63         null_command_handler,
  64         null_command_handler,
  65         null_command_handler,
  66         { "TOCLIENT_INVENTORY",                TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Inventory }, // 0x27
  67         null_command_handler,
  68         { "TOCLIENT_TIME_OF_DAY",              TOCLIENT_STATE_CONNECTED, &Client::handleCommand_TimeOfDay }, // 0x29
  69         { "TOCLIENT_CSM_RESTRICTION_FLAGS",    TOCLIENT_STATE_CONNECTED, &Client::handleCommand_CSMRestrictionFlags }, // 0x2A
  70         { "TOCLIENT_PLAYER_SPEED",             TOCLIENT_STATE_CONNECTED, &Client::handleCommand_PlayerSpeed }, // 0x2B
  71         { "TOCLIENT_MEDIA_PUSH",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_MediaPush }, // 0x2C
  72         null_command_handler,
  73         null_command_handler,
  74         { "TOCLIENT_CHAT_MESSAGE",             TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ChatMessage }, // 0x2F
  75         null_command_handler, // 0x30
  76         { "TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD", TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ActiveObjectRemoveAdd }, // 0x31
  77         { "TOCLIENT_ACTIVE_OBJECT_MESSAGES",   TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ActiveObjectMessages }, // 0x32
  78         { "TOCLIENT_HP",                       TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HP }, // 0x33
  79         { "TOCLIENT_MOVE_PLAYER",              TOCLIENT_STATE_CONNECTED, &Client::handleCommand_MovePlayer }, // 0x34
  80         { "TOCLIENT_ACCESS_DENIED_LEGACY",     TOCLIENT_STATE_NOT_CONNECTED, &Client::handleCommand_AccessDenied }, // 0x35
  81         { "TOCLIENT_FOV",                      TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Fov }, // 0x36
  82         { "TOCLIENT_DEATHSCREEN",              TOCLIENT_STATE_CONNECTED, &Client::handleCommand_DeathScreen }, // 0x37
  83         { "TOCLIENT_MEDIA",                    TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Media }, // 0x38
  84         null_command_handler,
  85         { "TOCLIENT_NODEDEF",                  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_NodeDef }, // 0x3a
  86         null_command_handler,
  87         { "TOCLIENT_ANNOUNCE_MEDIA",           TOCLIENT_STATE_CONNECTED, &Client::handleCommand_AnnounceMedia }, // 0x3c
  88         { "TOCLIENT_ITEMDEF",                  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ItemDef }, // 0x3d
  89         null_command_handler,
  90         { "TOCLIENT_PLAY_SOUND",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_PlaySound }, // 0x3f
  91         { "TOCLIENT_STOP_SOUND",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_StopSound }, // 0x40
  92         { "TOCLIENT_PRIVILEGES",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Privileges }, // 0x41
  93         { "TOCLIENT_INVENTORY_FORMSPEC",       TOCLIENT_STATE_CONNECTED, &Client::handleCommand_InventoryFormSpec }, // 0x42
  94         { "TOCLIENT_DETACHED_INVENTORY",       TOCLIENT_STATE_CONNECTED, &Client::handleCommand_DetachedInventory }, // 0x43
  95         { "TOCLIENT_SHOW_FORMSPEC",            TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ShowFormSpec }, // 0x44
  96         { "TOCLIENT_MOVEMENT",                 TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Movement }, // 0x45
  97         { "TOCLIENT_SPAWN_PARTICLE",           TOCLIENT_STATE_CONNECTED, &Client::handleCommand_SpawnParticle }, // 0x46
  98         { "TOCLIENT_ADD_PARTICLESPAWNER",      TOCLIENT_STATE_CONNECTED, &Client::handleCommand_AddParticleSpawner }, // 0x47
  99         null_command_handler,
 100         { "TOCLIENT_HUDADD",                   TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudAdd }, // 0x49
 101         { "TOCLIENT_HUDRM",                    TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudRemove }, // 0x4a
 102         { "TOCLIENT_HUDCHANGE",                TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudChange }, // 0x4b
 103         { "TOCLIENT_HUD_SET_FLAGS",            TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetFlags }, // 0x4c
 104         { "TOCLIENT_HUD_SET_PARAM",            TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetParam }, // 0x4d
 105         { "TOCLIENT_BREATH",                   TOCLIENT_STATE_CONNECTED, &Client::handleCommand_Breath }, // 0x4e
 106         { "TOCLIENT_SET_SKY",                  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetSky }, // 0x4f
 107         { "TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO", TOCLIENT_STATE_CONNECTED, &Client::handleCommand_OverrideDayNightRatio }, // 0x50
 108         { "TOCLIENT_LOCAL_PLAYER_ANIMATIONS",  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_LocalPlayerAnimations }, // 0x51
 109         { "TOCLIENT_EYE_OFFSET",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_EyeOffset }, // 0x52
 110         { "TOCLIENT_DELETE_PARTICLESPAWNER",   TOCLIENT_STATE_CONNECTED, &Client::handleCommand_DeleteParticleSpawner }, // 0x53
 111         { "TOCLIENT_CLOUD_PARAMS",             TOCLIENT_STATE_CONNECTED, &Client::handleCommand_CloudParams }, // 0x54
 112         { "TOCLIENT_FADE_SOUND",               TOCLIENT_STATE_CONNECTED, &Client::handleCommand_FadeSound }, // 0x55
 113         { "TOCLIENT_UPDATE_PLAYER_LIST",       TOCLIENT_STATE_CONNECTED, &Client::handleCommand_UpdatePlayerList }, // 0x56
 114         { "TOCLIENT_MODCHANNEL_MSG",           TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ModChannelMsg }, // 0x57
 115         { "TOCLIENT_MODCHANNEL_SIGNAL",        TOCLIENT_STATE_CONNECTED, &Client::handleCommand_ModChannelSignal }, // 0x58
 116         { "TOCLIENT_NODEMETA_CHANGED",         TOCLIENT_STATE_CONNECTED, &Client::handleCommand_NodemetaChanged }, // 0x59
 117         { "TOCLIENT_SET_SUN",                  TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetSun }, // 0x5a
 118         { "TOCLIENT_SET_MOON",                 TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetMoon }, // 0x5b
 119         { "TOCLIENT_SET_STARS",                TOCLIENT_STATE_CONNECTED, &Client::handleCommand_HudSetStars }, // 0x5c
 120         null_command_handler,
 121         null_command_handler,
 122         null_command_handler,
 123         { "TOCLIENT_SRP_BYTES_S_B",            TOCLIENT_STATE_NOT_CONNECTED, &Client::handleCommand_SrpBytesSandB }, // 0x60
 124         { "TOCLIENT_FORMSPEC_PREPEND",         TOCLIENT_STATE_CONNECTED, &Client::handleCommand_FormspecPrepend }, // 0x61,
 125         { "TOCLIENT_MINIMAP_MODES",            TOCLIENT_STATE_CONNECTED, &Client::handleCommand_MinimapModes }, // 0x62,
 126         { "TOCLIENT_SET_LIGHTING",        TOCLIENT_STATE_CONNECTED, &Client::handleCommand_SetLighting }, // 0x63,
 127 };
 128
 129 const static ServerCommandFactory null_command_factory = { "TOSERVER_NULL", 0, false };
 130
 131 /*
 132         Channels used for Client -> Server communication
 133         2: Notifications back to the server (e.g. GOTBLOCKS)
 134         1: Init and Authentication
 135         0: everything else
 136
 137         Packet order is only guaranteed inside a channel, so packets that operate on
 138         the same objects are *required* to be in the same channel.
 139 */
 140
 141 const ServerCommandFactory serverCommandFactoryTable[TOSERVER_NUM_MSG_TYPES] =
 142 {
 143         null_command_factory, // 0x00
 144         null_command_factory, // 0x01
 145         { "TOSERVER_INIT",               1, false }, // 0x02
 146         null_command_factory, // 0x03
 147         null_command_factory, // 0x04
 148         null_command_factory, // 0x05
 149         null_command_factory, // 0x06
 150         null_command_factory, // 0x07
 151         null_command_factory, // 0x08
 152         null_command_factory, // 0x09
 153         null_command_factory, // 0x0a
 154         null_command_factory, // 0x0b
 155         null_command_factory, // 0x0c
 156         null_command_factory, // 0x0d
 157         null_command_factory, // 0x0e
 158         null_command_factory, // 0x0f
 159         null_command_factory, // 0x10
 160         { "TOSERVER_INIT2",              1, true }, // 0x11
 161         null_command_factory, // 0x12
 162         null_command_factory, // 0x13
 163         null_command_factory, // 0x14
 164         null_command_factory, // 0x15
 165         null_command_factory, // 0x16
 166         { "TOSERVER_MODCHANNEL_JOIN",    0, true }, // 0x17
 167         { "TOSERVER_MODCHANNEL_LEAVE",   0, true }, // 0x18
 168         { "TOSERVER_MODCHANNEL_MSG",     0, true }, // 0x19
 169         null_command_factory, // 0x1a
 170         null_command_factory, // 0x1b
 171         null_command_factory, // 0x1c
 172         null_command_factory, // 0x1d
 173         null_command_factory, // 0x1e
 174         null_command_factory, // 0x1f
 175         null_command_factory, // 0x20
 176         null_command_factory, // 0x21
 177         null_command_factory, // 0x22
 178         { "TOSERVER_PLAYERPOS",          0, false }, // 0x23
 179         { "TOSERVER_GOTBLOCKS",          2, true }, // 0x24
 180         { "TOSERVER_DELETEDBLOCKS",      2, true }, // 0x25
 181         null_command_factory, // 0x26
 182         null_command_factory, // 0x27
 183         null_command_factory, // 0x28
 184         null_command_factory, // 0x29
 185         null_command_factory, // 0x2a
 186         null_command_factory, // 0x2b
 187         null_command_factory, // 0x2c
 188         null_command_factory, // 0x2d
 189         null_command_factory, // 0x2e
 190         null_command_factory, // 0x2f
 191         null_command_factory, // 0x30
 192         { "TOSERVER_INVENTORY_ACTION",   0, true }, // 0x31
 193         { "TOSERVER_CHAT_MESSAGE",       0, true }, // 0x32
 194         null_command_factory, // 0x33
 195         null_command_factory, // 0x34
 196         { "TOSERVER_DAMAGE",             0, true }, // 0x35
 197         null_command_factory, // 0x36
 198         { "TOSERVER_PLAYERITEM",         0, true }, // 0x37
 199         { "TOSERVER_RESPAWN",            0, true }, // 0x38
 200         { "TOSERVER_INTERACT",           0, true }, // 0x39
 201         { "TOSERVER_REMOVED_SOUNDS",     2, true }, // 0x3a
 202         { "TOSERVER_NODEMETA_FIELDS",    0, true }, // 0x3b
 203         { "TOSERVER_INVENTORY_FIELDS",   0, true }, // 0x3c
 204         null_command_factory, // 0x3d
 205         null_command_factory, // 0x3e
 206         null_command_factory, // 0x3f
 207         { "TOSERVER_REQUEST_MEDIA",      1, true }, // 0x40
 208         { "TOSERVER_HAVE_MEDIA",         2, true }, // 0x41
 209         null_command_factory, // 0x42
 210         { "TOSERVER_CLIENT_READY",       1, true }, // 0x43
 211         null_command_factory, // 0x44
 212         null_command_factory, // 0x45
 213         null_command_factory, // 0x46
 214         null_command_factory, // 0x47
 215         null_command_factory, // 0x48
 216         null_command_factory, // 0x49
 217         null_command_factory, // 0x4a
 218         null_command_factory, // 0x4b
 219         null_command_factory, // 0x4c
 220         null_command_factory, // 0x4d
 221         null_command_factory, // 0x4e
 222         null_command_factory, // 0x4f
 223         { "TOSERVER_FIRST_SRP",          1, true }, // 0x50
 224         { "TOSERVER_SRP_BYTES_A",        1, true }, // 0x51
 225         { "TOSERVER_SRP_BYTES_M",        1, true }, // 0x52
 226         { "TOSERVER_UPDATE_CLIENT_INFO", 1, true }, // 0x53
 227 };