src/network/networkprotocol.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "util/string.h"
  23
  24 /*
  25         changes by PROTOCOL_VERSION:
  26
  27         PROTOCOL_VERSION 3:
  28                 Base for writing changes here
  29         PROTOCOL_VERSION 4:
  30                 Add TOCLIENT_MEDIA
  31                 Add TOCLIENT_TOOLDEF
  32                 Add TOCLIENT_NODEDEF
  33                 Add TOCLIENT_CRAFTITEMDEF
  34                 Add TOSERVER_INTERACT
  35                 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
  36                 Obsolete TOSERVER_GROUND_ACTION
  37         PROTOCOL_VERSION 5:
  38                 Make players to be handled mostly as ActiveObjects
  39         PROTOCOL_VERSION 6:
  40                 Only non-cached textures are sent
  41         PROTOCOL_VERSION 7:
  42                 Add TOCLIENT_ITEMDEF
  43                 Obsolete TOCLIENT_TOOLDEF
  44                 Obsolete TOCLIENT_CRAFTITEMDEF
  45                 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
  46         PROTOCOL_VERSION 8:
  47                 Digging based on item groups
  48                 Many things
  49         PROTOCOL_VERSION 9:
  50                 ContentFeatures and NodeDefManager use a different serialization
  51                     format; better for future version cross-compatibility
  52                 Many things
  53                 Obsolete TOCLIENT_PLAYERITEM
  54         PROTOCOL_VERSION 10:
  55                 TOCLIENT_PRIVILEGES
  56                 Version raised to force 'fly' and 'fast' privileges into effect.
  57                 Node metadata change (came in later; somewhat incompatible)
  58         PROTOCOL_VERSION 11:
  59                 TileDef in ContentFeatures
  60                 Nodebox drawtype
  61                 (some dev snapshot)
  62                 TOCLIENT_INVENTORY_FORMSPEC
  63                 (0.4.0, 0.4.1)
  64         PROTOCOL_VERSION 12:
  65                 TOSERVER_INVENTORY_FIELDS
  66                 16-bit node ids
  67                 TOCLIENT_DETACHED_INVENTORY
  68         PROTOCOL_VERSION 13:
  69                 InventoryList field "Width" (deserialization fails with old versions)
  70         PROTOCOL_VERSION 14:
  71                 Added transfer of player pressed keys to the server
  72                 Added new messages for mesh and bone animation, as well as attachments
  73                 GENERIC_CMD_SET_ANIMATION
  74                 GENERIC_CMD_SET_BONE_POSITION
  75                 GENERIC_CMD_SET_ATTACHMENT
  76         PROTOCOL_VERSION 15:
  77                 Serialization format changes
  78         PROTOCOL_VERSION 16:
  79                 TOCLIENT_SHOW_FORMSPEC
  80         PROTOCOL_VERSION 17:
  81                 Serialization format change: include backface_culling flag in TileDef
  82                 Added rightclickable field in nodedef
  83                 TOCLIENT_SPAWN_PARTICLE
  84                 TOCLIENT_ADD_PARTICLESPAWNER
  85                 TOCLIENT_DELETE_PARTICLESPAWNER
  86         PROTOCOL_VERSION 18:
  87                 damageGroups added to ToolCapabilities
  88                 sound_place added to ItemDefinition
  89         PROTOCOL_VERSION 19:
  90                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
  91         PROTOCOL_VERSION 20:
  92                 TOCLIENT_HUDADD
  93                 TOCLIENT_HUDRM
  94                 TOCLIENT_HUDCHANGE
  95                 TOCLIENT_HUD_SET_FLAGS
  96         PROTOCOL_VERSION 21:
  97                 TOCLIENT_BREATH
  98                 TOSERVER_BREATH
  99                 range added to ItemDefinition
 100                 drowning, leveled and liquid_range added to ContentFeatures
 101                 stepheight and collideWithObjects added to object properties
 102                 version, heat and humidity transfer in MapBock
 103                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 104                         added to object properties
 105         PROTOCOL_VERSION 22:
 106                 add swap_node
 107         PROTOCOL_VERSION 23:
 108                 Obsolete TOSERVER_RECEIVED_MEDIA
 109                 Server: Stop using TOSERVER_CLIENT_READY
 110         PROTOCOL_VERSION 24:
 111                 ContentFeatures version 7
 112                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 113         PROTOCOL_VERSION 25:
 114                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
 115                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
 116                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
 117                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
 118                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
 119                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
 120                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
 121                         for standard error, keeping customisation possible. This
 122                         permit translation
 123                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
 124                         reading u32
 125                 Add new opcode TOSERVER_INIT for client presentation to server
 126                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
 127                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
 128                         for the three supported auth mechanisms around srp
 129                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
 130                         for sudo mode handling (auth mech generic way of changing password).
 131                 Add TOCLIENT_HELLO for presenting server to client after client
 132                         presentation
 133                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
 134                 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
 135         PROTOCOL_VERSION 26:
 136                 Add TileDef tileable_horizontal, tileable_vertical flags
 137         PROTOCOL_VERSION 27:
 138                 backface_culling: backwards compatibility for playing with
 139                 newer client on pre-27 servers.
 140                 Add nodedef v3 - connected nodeboxes
 141         PROTOCOL_VERSION 28:
 142                 CPT2_MESHOPTIONS
 143         PROTOCOL_VERSION 29:
 144                 Server doesn't accept TOSERVER_BREATH anymore
 145                 serialization of TileAnimation params changed
 146                 TAT_SHEET_2D
 147                 Removed client-sided chat perdiction
 148         PROTOCOL VERSION 30:
 149                 New ContentFeatures serialization version
 150                 Add node and tile color and palette
 151                 Fix plantlike visual_scale being applied squared and add compatibility
 152                         with pre-30 clients by sending sqrt(visual_scale)
 153         PROTOCOL VERSION 31:
 154                 Add tile overlay
 155                 Stop sending TOSERVER_CLIENT_READY
 156         PROTOCOL VERSION 32:
 157                 Add fading sounds
 158         PROTOCOL VERSION 33:
 159                 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
 160                         instead of guessing based on the active object list.
 161         PROTOCOL VERSION 34:
 162                 Add sound pitch
 163         PROTOCOL VERSION 35:
 164                 Rename TOCLIENT_CHAT_MESSAGE to TOCLIENT_CHAT_MESSAGE_OLD (0x30)
 165                 Add TOCLIENT_CHAT_MESSAGE (0x2F)
 166                         This chat message is a signalisation message containing various
 167                         informations:
 168                         * timestamp
 169                         * sender
 170                         * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
 171                         * content
 172                 Add TOCLIENT_CSM_FLAVOUR_LIMITS to define which CSM flavour should be
 173                         limited
 174                 Add settable player collisionbox. Breaks compatibility with older
 175                         clients as a 1-node vertical offset has been removed from player's
 176                         position
 177                 Add settable player stepheight using existing object property.
 178                         Breaks compatibility with older clients.
 179         PROTOCOL VERSION 36:
 180                 Backwards compatibility drop
 181                 Add 'can_zoom' to player object properties
 182                 Add glow to object properties
 183 */
 184
 185 #define LATEST_PROTOCOL_VERSION 36
 186
 187 // Server's supported network protocol range
 188 #define SERVER_PROTOCOL_VERSION_MIN 36
 189 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 190
 191 // Client's supported network protocol range
 192 // The minimal version depends on whether
 193 // send_pre_v25_init is enabled or not
 194 #define CLIENT_PROTOCOL_VERSION_MIN 36
 195 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 196
 197 // Constant that differentiates the protocol from random data and other protocols
 198 #define PROTOCOL_ID 0x4f457403
 199
 200 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 201                                // base64-encoded SHA-1 (27+\0).
 202
 203 #define FORMSPEC_API_VERSION 1
 204 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 205
 206 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 207
 208 enum ToClientCommand
 209 {
 210         TOCLIENT_HELLO = 0x02,
 211         /*
 212                 Sent after TOSERVER_INIT.
 213
 214                 u8 deployed serialisation version
 215                 u16 deployed network compression mode
 216                 u16 deployed protocol version
 217                 u32 supported auth methods
 218                 std::string username that should be used for legacy hash (for proper casing)
 219         */
 220         TOCLIENT_AUTH_ACCEPT = 0x03,
 221         /*
 222                 Message from server to accept auth.
 223
 224                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 225                 u64 map seed
 226                 f1000 recommended send interval
 227                 u32 : supported auth methods for sudo mode
 228                       (where the user can change their password)
 229         */
 230         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 231         /*
 232                 Sent to client to show it is in sudo mode now.
 233         */
 234         TOCLIENT_DENY_SUDO_MODE = 0x05,
 235         /*
 236                 Signals client that sudo mode auth failed.
 237         */
 238         TOCLIENT_ACCESS_DENIED = 0x0A,
 239         /*
 240                 u8 reason
 241                 std::string custom reason (if needed, otherwise "")
 242                 u8 (bool) reconnect
 243         */
 244
 245         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 246
 247         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 248         TOCLIENT_ADDNODE = 0x21,
 249         /*
 250                 v3s16 position
 251                 serialized mapnode
 252                 u8 keep_metadata // Added in protocol version 22
 253         */
 254         TOCLIENT_REMOVENODE = 0x22,
 255
 256         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 257         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 258         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 259         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 260
 261         TOCLIENT_INVENTORY = 0x27,
 262         /*
 263                 [0] u16 command
 264                 [2] serialized inventory
 265         */
 266
 267         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 268
 269         TOCLIENT_TIME_OF_DAY = 0x29,
 270         /*
 271                 u16 time (0-23999)
 272                 Added in a later version:
 273                 f1000 time_speed
 274         */
 275
 276         TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
 277         /*
 278                 u32 CSMFlavourLimits byteflag
 279          */
 280
 281         // (oops, there is some gap here)
 282
 283         TOCLIENT_CHAT_MESSAGE = 0x2F,
 284         /*
 285                 u8 version
 286                 u8 message_type
 287                 u16 sendername length
 288                 wstring sendername
 289                 u16 length
 290                 wstring message
 291         */
 292
 293         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 294
 295         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 296         /*
 297                 u16 count of removed objects
 298                 for all removed objects {
 299                         u16 id
 300                 }
 301                 u16 count of added objects
 302                 for all added objects {
 303                         u16 id
 304                         u8 type
 305                         u32 initialization data length
 306                         string initialization data
 307                 }
 308         */
 309
 310         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 311         /*
 312                 for all objects
 313                 {
 314                         u16 id
 315                         u16 message length
 316                         string message
 317                 }
 318         */
 319
 320         TOCLIENT_HP = 0x33,
 321         /*
 322                 u8 hp
 323         */
 324
 325         TOCLIENT_MOVE_PLAYER = 0x34,
 326         /*
 327                 v3f1000 player position
 328                 f1000 player pitch
 329                 f1000 player yaw
 330         */
 331
 332         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 333         /*
 334                 u16 reason_length
 335                 wstring reason
 336         */
 337
 338         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 339
 340         TOCLIENT_DEATHSCREEN = 0x37,
 341         /*
 342                 u8 bool set camera point target
 343                 v3f1000 camera point target (to point the death cause or whatever)
 344         */
 345
 346         TOCLIENT_MEDIA = 0x38,
 347         /*
 348                 u16 total number of texture bunches
 349                 u16 index of this bunch
 350                 u32 number of files in this bunch
 351                 for each file {
 352                         u16 length of name
 353                         string name
 354                         u32 length of data
 355                         data
 356                 }
 357                 u16 length of remote media server url (if applicable)
 358                 string url
 359         */
 360
 361         TOCLIENT_TOOLDEF = 0x39,
 362         /*
 363                 u32 length of the next item
 364                 serialized ToolDefManager
 365         */
 366
 367         TOCLIENT_NODEDEF = 0x3a,
 368         /*
 369                 u32 length of the next item
 370                 serialized NodeDefManager
 371         */
 372
 373         TOCLIENT_CRAFTITEMDEF = 0x3b,
 374         /*
 375                 u32 length of the next item
 376                 serialized CraftiItemDefManager
 377         */
 378
 379         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 380
 381         /*
 382                 u32 number of files
 383                 for each texture {
 384                         u16 length of name
 385                         string name
 386                         u16 length of sha1_digest
 387                         string sha1_digest
 388                 }
 389         */
 390
 391         TOCLIENT_ITEMDEF = 0x3d,
 392         /*
 393                 u32 length of next item
 394                 serialized ItemDefManager
 395         */
 396
 397         TOCLIENT_PLAY_SOUND = 0x3f,
 398         /*
 399                 s32 sound_id
 400                 u16 len
 401                 u8[len] sound name
 402                 s32 gain*1000
 403                 u8 type (0=local, 1=positional, 2=object)
 404                 s32[3] pos_nodes*10000
 405                 u16 object_id
 406                 u8 loop (bool)
 407         */
 408
 409         TOCLIENT_STOP_SOUND = 0x40,
 410         /*
 411                 s32 sound_id
 412         */
 413
 414         TOCLIENT_PRIVILEGES = 0x41,
 415         /*
 416                 u16 number of privileges
 417                 for each privilege
 418                         u16 len
 419                         u8[len] privilege
 420         */
 421
 422         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 423         /*
 424                 u32 len
 425                 u8[len] formspec
 426         */
 427
 428         TOCLIENT_DETACHED_INVENTORY = 0x43,
 429         /*
 430                 [0] u16 command
 431                 u16 len
 432                 u8[len] name
 433                 [2] serialized inventory
 434         */
 435
 436         TOCLIENT_SHOW_FORMSPEC = 0x44,
 437         /*
 438                 [0] u16 command
 439                 u32 len
 440                 u8[len] formspec
 441                 u16 len
 442                 u8[len] formname
 443         */
 444
 445         TOCLIENT_MOVEMENT = 0x45,
 446         /*
 447                 f1000 movement_acceleration_default
 448                 f1000 movement_acceleration_air
 449                 f1000 movement_acceleration_fast
 450                 f1000 movement_speed_walk
 451                 f1000 movement_speed_crouch
 452                 f1000 movement_speed_fast
 453                 f1000 movement_speed_climb
 454                 f1000 movement_speed_jump
 455                 f1000 movement_liquid_fluidity
 456                 f1000 movement_liquid_fluidity_smooth
 457                 f1000 movement_liquid_sink
 458                 f1000 movement_gravity
 459         */
 460
 461         TOCLIENT_SPAWN_PARTICLE = 0x46,
 462         /*
 463                 v3f1000 pos
 464                 v3f1000 velocity
 465                 v3f1000 acceleration
 466                 f1000 expirationtime
 467                 f1000 size
 468                 u8 bool collisiondetection
 469                 u8 bool vertical
 470                 u32 len
 471                 u8[len] texture
 472                 u8 collision_removal
 473         */
 474
 475         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 476         /*
 477                 u16 amount
 478                 f1000 spawntime
 479                 v3f1000 minpos
 480                 v3f1000 maxpos
 481                 v3f1000 minvel
 482                 v3f1000 maxvel
 483                 v3f1000 minacc
 484                 v3f1000 maxacc
 485                 f1000 minexptime
 486                 f1000 maxexptime
 487                 f1000 minsize
 488                 f1000 maxsize
 489                 u8 bool collisiondetection
 490                 u8 bool vertical
 491                 u32 len
 492                 u8[len] texture
 493                 u32 id
 494                 u8 collision_removal
 495         */
 496
 497         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 498
 499         TOCLIENT_HUDADD = 0x49,
 500         /*
 501                 u32 id
 502                 u8 type
 503                 v2f1000 pos
 504                 u32 len
 505                 u8[len] name
 506                 v2f1000 scale
 507                 u32 len2
 508                 u8[len2] text
 509                 u32 number
 510                 u32 item
 511                 u32 dir
 512                 v2f1000 align
 513                 v2f1000 offset
 514                 v3f1000 world_pos
 515                 v2s32 size
 516         */
 517
 518         TOCLIENT_HUDRM = 0x4a,
 519         /*
 520                 u32 id
 521         */
 522
 523         TOCLIENT_HUDCHANGE = 0x4b,
 524         /*
 525                 u32 id
 526                 u8 stat
 527                 [v2f1000 data |
 528                  u32 len
 529                  u8[len] data |
 530                  u32 data]
 531         */
 532
 533         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 534         /*
 535                 u32 flags
 536                 u32 mask
 537         */
 538
 539         TOCLIENT_HUD_SET_PARAM = 0x4d,
 540         /*
 541                 u16 param
 542                 u16 len
 543                 u8[len] value
 544         */
 545
 546         TOCLIENT_BREATH = 0x4e,
 547         /*
 548                 u16 breath
 549         */
 550
 551         TOCLIENT_SET_SKY = 0x4f,
 552         /*
 553                 u8[4] color (ARGB)
 554                 u8 len
 555                 u8[len] type
 556                 u16 count
 557                 foreach count:
 558                         u8 len
 559                         u8[len] param
 560                 u8 clouds (boolean)
 561         */
 562
 563         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 564         /*
 565                 u8 do_override (boolean)
 566                 u16 day-night ratio 0...65535
 567         */
 568
 569         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 570         /*
 571                 v2s32 stand/idle
 572                 v2s32 walk
 573                 v2s32 dig
 574                 v2s32 walk+dig
 575                 f1000 frame_speed
 576         */
 577
 578         TOCLIENT_EYE_OFFSET = 0x52,
 579         /*
 580                 v3f1000 first
 581                 v3f1000 third
 582         */
 583
 584         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 585         /*
 586                 u32 id
 587         */
 588
 589         TOCLIENT_CLOUD_PARAMS = 0x54,
 590         /*
 591                 f1000 density
 592                 u8[4] color_diffuse (ARGB)
 593                 u8[4] color_ambient (ARGB)
 594                 f1000 height
 595                 f1000 thickness
 596                 v2f1000 speed
 597         */
 598
 599         TOCLIENT_FADE_SOUND = 0x55,
 600         /*
 601                 s32 sound_id
 602                 float step
 603                 float gain
 604         */
 605         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 606         /*
 607                 u8 type
 608                 u16 number of players
 609                 for each player
 610                         u16 len
 611                         u8[len] player name
 612         */
 613
 614         TOCLIENT_SRP_BYTES_S_B = 0x60,
 615         /*
 616                 Belonging to AUTH_MECHANISM_SRP.
 617
 618                 std::string bytes_s
 619                 std::string bytes_B
 620         */
 621
 622         TOCLIENT_NUM_MSG_TYPES = 0x61,
 623 };
 624
 625 enum ToServerCommand
 626 {
 627         TOSERVER_INIT = 0x02,
 628         /*
 629                 Sent first after connected.
 630
 631                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 632                 u16 supported network compression modes
 633                 u16 minimum supported network protocol version
 634                 u16 maximum supported network protocol version
 635                 std::string player name
 636         */
 637
 638         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 639
 640         TOSERVER_INIT2 = 0x11,
 641         /*
 642                 Sent as an ACK for TOCLIENT_INIT.
 643                 After this, the server can send data.
 644
 645                 [0] u16 TOSERVER_INIT2
 646         */
 647
 648         TOSERVER_GETBLOCK = 0x20, // Obsolete
 649         TOSERVER_ADDNODE = 0x21, // Obsolete
 650         TOSERVER_REMOVENODE = 0x22, // Obsolete
 651
 652         TOSERVER_PLAYERPOS = 0x23,
 653         /*
 654                 [0] u16 command
 655                 [2] v3s32 position*100
 656                 [2+12] v3s32 speed*100
 657                 [2+12+12] s32 pitch*100
 658                 [2+12+12+4] s32 yaw*100
 659                 [2+12+12+4+4] u32 keyPressed
 660                 [2+12+12+4+4+1] u8 fov*80
 661                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 662         */
 663
 664         TOSERVER_GOTBLOCKS = 0x24,
 665         /*
 666                 [0] u16 command
 667                 [2] u8 count
 668                 [3] v3s16 pos_0
 669                 [3+6] v3s16 pos_1
 670                 ...
 671         */
 672
 673         TOSERVER_DELETEDBLOCKS = 0x25,
 674         /*
 675                 [0] u16 command
 676                 [2] u8 count
 677                 [3] v3s16 pos_0
 678                 [3+6] v3s16 pos_1
 679                 ...
 680         */
 681
 682         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 683         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 684         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 685         TOSERVER_RELEASE = 0x29, // Obsolete
 686         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 687
 688         TOSERVER_INVENTORY_ACTION = 0x31,
 689         /*
 690                 See InventoryAction in inventorymanager.h
 691         */
 692
 693         TOSERVER_CHAT_MESSAGE = 0x32,
 694         /*
 695                 u16 length
 696                 wstring message
 697         */
 698
 699         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 700         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 701
 702         TOSERVER_DAMAGE = 0x35,
 703         /*
 704                 u8 amount
 705         */
 706
 707         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 708
 709         TOSERVER_PLAYERITEM = 0x37,
 710         /*
 711                 Sent to change selected item.
 712
 713                 [0] u16 TOSERVER_PLAYERITEM
 714                 [2] u16 item
 715         */
 716
 717         TOSERVER_RESPAWN = 0x38,
 718         /*
 719                 u16 TOSERVER_RESPAWN
 720         */
 721
 722         TOSERVER_INTERACT = 0x39,
 723         /*
 724                 [0] u16 command
 725                 [2] u8 action
 726                 [3] u16 item
 727                 [5] u32 length of the next item
 728                 [9] serialized PointedThing
 729                 actions:
 730                 0: start digging (from undersurface) or use
 731                 1: stop digging (all parameters ignored)
 732                 2: digging completed
 733                 3: place block or item (to abovesurface)
 734                 4: use item
 735         */
 736
 737         TOSERVER_REMOVED_SOUNDS = 0x3a,
 738         /*
 739                 u16 len
 740                 s32[len] sound_id
 741         */
 742
 743         TOSERVER_NODEMETA_FIELDS = 0x3b,
 744         /*
 745                 v3s16 p
 746                 u16 len
 747                 u8[len] form name (reserved for future use)
 748                 u16 number of fields
 749                 for each field:
 750                         u16 len
 751                         u8[len] field name
 752                         u32 len
 753                         u8[len] field value
 754         */
 755
 756         TOSERVER_INVENTORY_FIELDS = 0x3c,
 757         /*
 758                 u16 len
 759                 u8[len] form name (reserved for future use)
 760                 u16 number of fields
 761                 for each field:
 762                         u16 len
 763                         u8[len] field name
 764                         u32 len
 765                         u8[len] field value
 766         */
 767
 768         TOSERVER_REQUEST_MEDIA = 0x40,
 769         /*
 770                 u16 number of files requested
 771                 for each file {
 772                         u16 length of name
 773                         string name
 774                 }
 775         */
 776
 777         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 778         TOSERVER_BREATH = 0x42, // Obsolete
 779
 780         TOSERVER_CLIENT_READY = 0x43,
 781         /*
 782                 u8 major
 783                 u8 minor
 784                 u8 patch
 785                 u8 reserved
 786                 u16 len
 787                 u8[len] full_version_string
 788         */
 789
 790         TOSERVER_FIRST_SRP = 0x50,
 791         /*
 792                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 793
 794                 std::string srp salt
 795                 std::string srp verification key
 796                 u8 is_empty (=1 if password is empty, 0 otherwise)
 797         */
 798
 799         TOSERVER_SRP_BYTES_A = 0x51,
 800         /*
 801                 Belonging to AUTH_MECHANISM_SRP,
 802                         depending on current_login_based_on.
 803
 804                 std::string bytes_A
 805                 u8 current_login_based_on : on which version of the password's
 806                                             hash this login is based on (0 legacy hash,
 807                                             or 1 directly the password)
 808         */
 809
 810         TOSERVER_SRP_BYTES_M = 0x52,
 811         /*
 812                 Belonging to AUTH_MECHANISM_SRP.
 813
 814                 std::string bytes_M
 815         */
 816
 817         TOSERVER_NUM_MSG_TYPES = 0x53,
 818 };
 819
 820 enum AuthMechanism
 821 {
 822         // reserved
 823         AUTH_MECHANISM_NONE = 0,
 824
 825         // SRP based on the legacy hash
 826         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 827
 828         // SRP based on the srp verification key
 829         AUTH_MECHANISM_SRP = 1 << 1,
 830
 831         // Establishes a srp verification key, for first login and password changing
 832         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 833 };
 834
 835 enum AccessDeniedCode {
 836         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 837         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 838         SERVER_ACCESSDENIED_SINGLEPLAYER,
 839         SERVER_ACCESSDENIED_WRONG_VERSION,
 840         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 841         SERVER_ACCESSDENIED_WRONG_NAME,
 842         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 843         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 844         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 845         SERVER_ACCESSDENIED_SERVER_FAIL,
 846         SERVER_ACCESSDENIED_CUSTOM_STRING,
 847         SERVER_ACCESSDENIED_SHUTDOWN,
 848         SERVER_ACCESSDENIED_CRASH,
 849         SERVER_ACCESSDENIED_MAX,
 850 };
 851
 852 enum NetProtoCompressionMode {
 853         NETPROTO_COMPRESSION_NONE = 0,
 854 };
 855
 856 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 857         "Invalid password",
 858         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 859         "The server is running in simple singleplayer mode.  You cannot connect.",
 860         "Your client's version is not supported.\nPlease contact server administrator.",
 861         "Player name contains disallowed characters.",
 862         "Player name not allowed.",
 863         "Too many users.",
 864         "Empty passwords are disallowed.  Set a password and try again.",
 865         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 866         "Server authentication failed.  This is likely a server error.",
 867         "",
 868         "Server shutting down.",
 869         "This server has experienced an internal error. You will now be disconnected."
 870 };
 871
 872 enum PlayerListModifer: u8
 873 {
 874         PLAYER_LIST_INIT,
 875         PLAYER_LIST_ADD,
 876         PLAYER_LIST_REMOVE,
 877 };
 878
 879 enum CSMFlavourLimit : u64 {
 880         CSM_FL_NONE = 0x00000000,
 881         CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
 882         CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
 883         CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
 884         CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
 885         CSM_FL_ALL = 0xFFFFFFFF,
 886 };
 887