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_RESTRICTION_FLAGS to define which CSM features 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                 Change TileDef serialization format.
 184                 Add world-aligned tiles.
 185                 Mod channels
 186                 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
 187                         'zoom_fov'.
 188                 Nodebox version 5
 189                 Add disconnected nodeboxes
 190                 Add TOCLIENT_FORMSPEC_PREPEND
 191 */
 192
 193 #define LATEST_PROTOCOL_VERSION 36
 194 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
 195
 196 // Server's supported network protocol range
 197 #define SERVER_PROTOCOL_VERSION_MIN 36
 198 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 199
 200 // Client's supported network protocol range
 201 // The minimal version depends on whether
 202 // send_pre_v25_init is enabled or not
 203 #define CLIENT_PROTOCOL_VERSION_MIN 36
 204 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 205
 206 // Constant that differentiates the protocol from random data and other protocols
 207 #define PROTOCOL_ID 0x4f457403
 208
 209 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 210                                // base64-encoded SHA-1 (27+\0).
 211
 212 #define FORMSPEC_API_VERSION 1
 213 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 214
 215 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 216
 217 typedef u16 session_t;
 218
 219 enum ToClientCommand
 220 {
 221         TOCLIENT_HELLO = 0x02,
 222         /*
 223                 Sent after TOSERVER_INIT.
 224
 225                 u8 deployed serialisation version
 226                 u16 deployed network compression mode
 227                 u16 deployed protocol version
 228                 u32 supported auth methods
 229                 std::string username that should be used for legacy hash (for proper casing)
 230         */
 231         TOCLIENT_AUTH_ACCEPT = 0x03,
 232         /*
 233                 Message from server to accept auth.
 234
 235                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 236                 u64 map seed
 237                 f1000 recommended send interval
 238                 u32 : supported auth methods for sudo mode
 239                       (where the user can change their password)
 240         */
 241         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 242         /*
 243                 Sent to client to show it is in sudo mode now.
 244         */
 245         TOCLIENT_DENY_SUDO_MODE = 0x05,
 246         /*
 247                 Signals client that sudo mode auth failed.
 248         */
 249         TOCLIENT_ACCESS_DENIED = 0x0A,
 250         /*
 251                 u8 reason
 252                 std::string custom reason (if needed, otherwise "")
 253                 u8 (bool) reconnect
 254         */
 255
 256         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 257
 258         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 259         TOCLIENT_ADDNODE = 0x21,
 260         /*
 261                 v3s16 position
 262                 serialized mapnode
 263                 u8 keep_metadata // Added in protocol version 22
 264         */
 265         TOCLIENT_REMOVENODE = 0x22,
 266
 267         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 268         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 269         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 270         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 271
 272         TOCLIENT_INVENTORY = 0x27,
 273         /*
 274                 [0] u16 command
 275                 [2] serialized inventory
 276         */
 277
 278         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 279
 280         TOCLIENT_TIME_OF_DAY = 0x29,
 281         /*
 282                 u16 time (0-23999)
 283                 Added in a later version:
 284                 f1000 time_speed
 285         */
 286
 287         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 288         /*
 289                 u32 CSMRestrictionFlags byteflag
 290          */
 291
 292         // (oops, there is some gap here)
 293
 294         TOCLIENT_CHAT_MESSAGE = 0x2F,
 295         /*
 296                 u8 version
 297                 u8 message_type
 298                 u16 sendername length
 299                 wstring sendername
 300                 u16 length
 301                 wstring message
 302         */
 303
 304         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 305
 306         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 307         /*
 308                 u16 count of removed objects
 309                 for all removed objects {
 310                         u16 id
 311                 }
 312                 u16 count of added objects
 313                 for all added objects {
 314                         u16 id
 315                         u8 type
 316                         u32 initialization data length
 317                         string initialization data
 318                 }
 319         */
 320
 321         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 322         /*
 323                 for all objects
 324                 {
 325                         u16 id
 326                         u16 message length
 327                         string message
 328                 }
 329         */
 330
 331         TOCLIENT_HP = 0x33,
 332         /*
 333                 u8 hp
 334         */
 335
 336         TOCLIENT_MOVE_PLAYER = 0x34,
 337         /*
 338                 v3f1000 player position
 339                 f1000 player pitch
 340                 f1000 player yaw
 341         */
 342
 343         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 344         /*
 345                 u16 reason_length
 346                 wstring reason
 347         */
 348
 349         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 350
 351         TOCLIENT_DEATHSCREEN = 0x37,
 352         /*
 353                 u8 bool set camera point target
 354                 v3f1000 camera point target (to point the death cause or whatever)
 355         */
 356
 357         TOCLIENT_MEDIA = 0x38,
 358         /*
 359                 u16 total number of texture bunches
 360                 u16 index of this bunch
 361                 u32 number of files in this bunch
 362                 for each file {
 363                         u16 length of name
 364                         string name
 365                         u32 length of data
 366                         data
 367                 }
 368                 u16 length of remote media server url (if applicable)
 369                 string url
 370         */
 371
 372         TOCLIENT_TOOLDEF = 0x39,
 373         /*
 374                 u32 length of the next item
 375                 serialized ToolDefManager
 376         */
 377
 378         TOCLIENT_NODEDEF = 0x3a,
 379         /*
 380                 u32 length of the next item
 381                 serialized NodeDefManager
 382         */
 383
 384         TOCLIENT_CRAFTITEMDEF = 0x3b,
 385         /*
 386                 u32 length of the next item
 387                 serialized CraftiItemDefManager
 388         */
 389
 390         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 391
 392         /*
 393                 u32 number of files
 394                 for each texture {
 395                         u16 length of name
 396                         string name
 397                         u16 length of sha1_digest
 398                         string sha1_digest
 399                 }
 400         */
 401
 402         TOCLIENT_ITEMDEF = 0x3d,
 403         /*
 404                 u32 length of next item
 405                 serialized ItemDefManager
 406         */
 407
 408         TOCLIENT_PLAY_SOUND = 0x3f,
 409         /*
 410                 s32 sound_id
 411                 u16 len
 412                 u8[len] sound name
 413                 s32 gain*1000
 414                 u8 type (0=local, 1=positional, 2=object)
 415                 s32[3] pos_nodes*10000
 416                 u16 object_id
 417                 u8 loop (bool)
 418         */
 419
 420         TOCLIENT_STOP_SOUND = 0x40,
 421         /*
 422                 s32 sound_id
 423         */
 424
 425         TOCLIENT_PRIVILEGES = 0x41,
 426         /*
 427                 u16 number of privileges
 428                 for each privilege
 429                         u16 len
 430                         u8[len] privilege
 431         */
 432
 433         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 434         /*
 435                 u32 len
 436                 u8[len] formspec
 437         */
 438
 439         TOCLIENT_DETACHED_INVENTORY = 0x43,
 440         /*
 441                 [0] u16 command
 442                 u16 len
 443                 u8[len] name
 444                 [2] serialized inventory
 445         */
 446
 447         TOCLIENT_SHOW_FORMSPEC = 0x44,
 448         /*
 449                 [0] u16 command
 450                 u32 len
 451                 u8[len] formspec
 452                 u16 len
 453                 u8[len] formname
 454         */
 455
 456         TOCLIENT_MOVEMENT = 0x45,
 457         /*
 458                 f1000 movement_acceleration_default
 459                 f1000 movement_acceleration_air
 460                 f1000 movement_acceleration_fast
 461                 f1000 movement_speed_walk
 462                 f1000 movement_speed_crouch
 463                 f1000 movement_speed_fast
 464                 f1000 movement_speed_climb
 465                 f1000 movement_speed_jump
 466                 f1000 movement_liquid_fluidity
 467                 f1000 movement_liquid_fluidity_smooth
 468                 f1000 movement_liquid_sink
 469                 f1000 movement_gravity
 470         */
 471
 472         TOCLIENT_SPAWN_PARTICLE = 0x46,
 473         /*
 474                 v3f1000 pos
 475                 v3f1000 velocity
 476                 v3f1000 acceleration
 477                 f1000 expirationtime
 478                 f1000 size
 479                 u8 bool collisiondetection
 480                 u32 len
 481                 u8[len] texture
 482                 u8 bool vertical
 483                 u8 collision_removal
 484                 TileAnimation animation
 485                 u8 glow
 486                 u8 object_collision
 487         */
 488
 489         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 490         /*
 491                 u16 amount
 492                 f1000 spawntime
 493                 v3f1000 minpos
 494                 v3f1000 maxpos
 495                 v3f1000 minvel
 496                 v3f1000 maxvel
 497                 v3f1000 minacc
 498                 v3f1000 maxacc
 499                 f1000 minexptime
 500                 f1000 maxexptime
 501                 f1000 minsize
 502                 f1000 maxsize
 503                 u8 bool collisiondetection
 504                 u32 len
 505                 u8[len] texture
 506                 u8 bool vertical
 507                 u8 collision_removal
 508                 u32 id
 509                 TileAnimation animation
 510                 u8 glow
 511                 u8 object_collision
 512         */
 513
 514         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 515
 516         TOCLIENT_HUDADD = 0x49,
 517         /*
 518                 u32 id
 519                 u8 type
 520                 v2f1000 pos
 521                 u32 len
 522                 u8[len] name
 523                 v2f1000 scale
 524                 u32 len2
 525                 u8[len2] text
 526                 u32 number
 527                 u32 item
 528                 u32 dir
 529                 v2f1000 align
 530                 v2f1000 offset
 531                 v3f1000 world_pos
 532                 v2s32 size
 533         */
 534
 535         TOCLIENT_HUDRM = 0x4a,
 536         /*
 537                 u32 id
 538         */
 539
 540         TOCLIENT_HUDCHANGE = 0x4b,
 541         /*
 542                 u32 id
 543                 u8 stat
 544                 [v2f1000 data |
 545                  u32 len
 546                  u8[len] data |
 547                  u32 data]
 548         */
 549
 550         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 551         /*
 552                 u32 flags
 553                 u32 mask
 554         */
 555
 556         TOCLIENT_HUD_SET_PARAM = 0x4d,
 557         /*
 558                 u16 param
 559                 u16 len
 560                 u8[len] value
 561         */
 562
 563         TOCLIENT_BREATH = 0x4e,
 564         /*
 565                 u16 breath
 566         */
 567
 568         TOCLIENT_SET_SKY = 0x4f,
 569         /*
 570                 u8[4] color (ARGB)
 571                 u8 len
 572                 u8[len] type
 573                 u16 count
 574                 foreach count:
 575                         u8 len
 576                         u8[len] param
 577                 u8 clouds (boolean)
 578         */
 579
 580         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 581         /*
 582                 u8 do_override (boolean)
 583                 u16 day-night ratio 0...65535
 584         */
 585
 586         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 587         /*
 588                 v2s32 stand/idle
 589                 v2s32 walk
 590                 v2s32 dig
 591                 v2s32 walk+dig
 592                 f1000 frame_speed
 593         */
 594
 595         TOCLIENT_EYE_OFFSET = 0x52,
 596         /*
 597                 v3f1000 first
 598                 v3f1000 third
 599         */
 600
 601         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 602         /*
 603                 u32 id
 604         */
 605
 606         TOCLIENT_CLOUD_PARAMS = 0x54,
 607         /*
 608                 f1000 density
 609                 u8[4] color_diffuse (ARGB)
 610                 u8[4] color_ambient (ARGB)
 611                 f1000 height
 612                 f1000 thickness
 613                 v2f1000 speed
 614         */
 615
 616         TOCLIENT_FADE_SOUND = 0x55,
 617         /*
 618                 s32 sound_id
 619                 float step
 620                 float gain
 621         */
 622         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 623         /*
 624                 u8 type
 625                 u16 number of players
 626                 for each player
 627                         u16 len
 628                         u8[len] player name
 629         */
 630
 631         TOCLIENT_MODCHANNEL_MSG = 0x57,
 632         /*
 633                 u16 channel name length
 634                 std::string channel name
 635                 u16 channel name sender
 636                 std::string channel name
 637                 u16 message length
 638                 std::string message
 639          */
 640         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 641         /*
 642                 u8 signal id
 643                 u16 channel name length
 644                 std::string channel name
 645          */
 646
 647         TOCLIENT_SRP_BYTES_S_B = 0x60,
 648         /*
 649                 Belonging to AUTH_MECHANISM_SRP.
 650
 651                 std::string bytes_s
 652                 std::string bytes_B
 653         */
 654
 655         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 656         /*
 657                 u16 len
 658                 u8[len] formspec
 659         */
 660
 661         TOCLIENT_NUM_MSG_TYPES = 0x62,
 662 };
 663
 664 enum ToServerCommand
 665 {
 666         TOSERVER_INIT = 0x02,
 667         /*
 668                 Sent first after connected.
 669
 670                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 671                 u16 supported network compression modes
 672                 u16 minimum supported network protocol version
 673                 u16 maximum supported network protocol version
 674                 std::string player name
 675         */
 676
 677         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 678
 679         TOSERVER_INIT2 = 0x11,
 680         /*
 681                 Sent as an ACK for TOCLIENT_INIT.
 682                 After this, the server can send data.
 683
 684                 [0] u16 TOSERVER_INIT2
 685         */
 686
 687         TOSERVER_MODCHANNEL_JOIN = 0x17,
 688         /*
 689                 u16 channel name length
 690                 std::string channel name
 691          */
 692
 693         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 694         /*
 695                 u16 channel name length
 696                 std::string channel name
 697          */
 698
 699         TOSERVER_MODCHANNEL_MSG = 0x19,
 700         /*
 701                 u16 channel name length
 702                 std::string channel name
 703                 u16 message length
 704                 std::string message
 705          */
 706
 707         TOSERVER_GETBLOCK = 0x20, // Obsolete
 708         TOSERVER_ADDNODE = 0x21, // Obsolete
 709         TOSERVER_REMOVENODE = 0x22, // Obsolete
 710
 711         TOSERVER_PLAYERPOS = 0x23,
 712         /*
 713                 [0] u16 command
 714                 [2] v3s32 position*100
 715                 [2+12] v3s32 speed*100
 716                 [2+12+12] s32 pitch*100
 717                 [2+12+12+4] s32 yaw*100
 718                 [2+12+12+4+4] u32 keyPressed
 719                 [2+12+12+4+4+1] u8 fov*80
 720                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 721         */
 722
 723         TOSERVER_GOTBLOCKS = 0x24,
 724         /*
 725                 [0] u16 command
 726                 [2] u8 count
 727                 [3] v3s16 pos_0
 728                 [3+6] v3s16 pos_1
 729                 ...
 730         */
 731
 732         TOSERVER_DELETEDBLOCKS = 0x25,
 733         /*
 734                 [0] u16 command
 735                 [2] u8 count
 736                 [3] v3s16 pos_0
 737                 [3+6] v3s16 pos_1
 738                 ...
 739         */
 740
 741         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 742         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 743         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 744         TOSERVER_RELEASE = 0x29, // Obsolete
 745         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 746
 747         TOSERVER_INVENTORY_ACTION = 0x31,
 748         /*
 749                 See InventoryAction in inventorymanager.h
 750         */
 751
 752         TOSERVER_CHAT_MESSAGE = 0x32,
 753         /*
 754                 u16 length
 755                 wstring message
 756         */
 757
 758         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 759         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 760
 761         TOSERVER_DAMAGE = 0x35,
 762         /*
 763                 u8 amount
 764         */
 765
 766         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 767
 768         TOSERVER_PLAYERITEM = 0x37,
 769         /*
 770                 Sent to change selected item.
 771
 772                 [0] u16 TOSERVER_PLAYERITEM
 773                 [2] u16 item
 774         */
 775
 776         TOSERVER_RESPAWN = 0x38,
 777         /*
 778                 u16 TOSERVER_RESPAWN
 779         */
 780
 781         TOSERVER_INTERACT = 0x39,
 782         /*
 783                 [0] u16 command
 784                 [2] u8 action
 785                 [3] u16 item
 786                 [5] u32 length of the next item
 787                 [9] serialized PointedThing
 788                 actions:
 789                 0: start digging (from undersurface) or use
 790                 1: stop digging (all parameters ignored)
 791                 2: digging completed
 792                 3: place block or item (to abovesurface)
 793                 4: use item
 794         */
 795
 796         TOSERVER_REMOVED_SOUNDS = 0x3a,
 797         /*
 798                 u16 len
 799                 s32[len] sound_id
 800         */
 801
 802         TOSERVER_NODEMETA_FIELDS = 0x3b,
 803         /*
 804                 v3s16 p
 805                 u16 len
 806                 u8[len] form name (reserved for future use)
 807                 u16 number of fields
 808                 for each field:
 809                         u16 len
 810                         u8[len] field name
 811                         u32 len
 812                         u8[len] field value
 813         */
 814
 815         TOSERVER_INVENTORY_FIELDS = 0x3c,
 816         /*
 817                 u16 len
 818                 u8[len] form name (reserved for future use)
 819                 u16 number of fields
 820                 for each field:
 821                         u16 len
 822                         u8[len] field name
 823                         u32 len
 824                         u8[len] field value
 825         */
 826
 827         TOSERVER_REQUEST_MEDIA = 0x40,
 828         /*
 829                 u16 number of files requested
 830                 for each file {
 831                         u16 length of name
 832                         string name
 833                 }
 834         */
 835
 836         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 837         TOSERVER_BREATH = 0x42, // Obsolete
 838
 839         TOSERVER_CLIENT_READY = 0x43,
 840         /*
 841                 u8 major
 842                 u8 minor
 843                 u8 patch
 844                 u8 reserved
 845                 u16 len
 846                 u8[len] full_version_string
 847         */
 848
 849         TOSERVER_FIRST_SRP = 0x50,
 850         /*
 851                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 852
 853                 std::string srp salt
 854                 std::string srp verification key
 855                 u8 is_empty (=1 if password is empty, 0 otherwise)
 856         */
 857
 858         TOSERVER_SRP_BYTES_A = 0x51,
 859         /*
 860                 Belonging to AUTH_MECHANISM_SRP,
 861                         depending on current_login_based_on.
 862
 863                 std::string bytes_A
 864                 u8 current_login_based_on : on which version of the password's
 865                                             hash this login is based on (0 legacy hash,
 866                                             or 1 directly the password)
 867         */
 868
 869         TOSERVER_SRP_BYTES_M = 0x52,
 870         /*
 871                 Belonging to AUTH_MECHANISM_SRP.
 872
 873                 std::string bytes_M
 874         */
 875
 876         TOSERVER_NUM_MSG_TYPES = 0x53,
 877 };
 878
 879 enum AuthMechanism
 880 {
 881         // reserved
 882         AUTH_MECHANISM_NONE = 0,
 883
 884         // SRP based on the legacy hash
 885         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 886
 887         // SRP based on the srp verification key
 888         AUTH_MECHANISM_SRP = 1 << 1,
 889
 890         // Establishes a srp verification key, for first login and password changing
 891         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 892 };
 893
 894 enum AccessDeniedCode {
 895         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 896         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 897         SERVER_ACCESSDENIED_SINGLEPLAYER,
 898         SERVER_ACCESSDENIED_WRONG_VERSION,
 899         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 900         SERVER_ACCESSDENIED_WRONG_NAME,
 901         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 902         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 903         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 904         SERVER_ACCESSDENIED_SERVER_FAIL,
 905         SERVER_ACCESSDENIED_CUSTOM_STRING,
 906         SERVER_ACCESSDENIED_SHUTDOWN,
 907         SERVER_ACCESSDENIED_CRASH,
 908         SERVER_ACCESSDENIED_MAX,
 909 };
 910
 911 enum NetProtoCompressionMode {
 912         NETPROTO_COMPRESSION_NONE = 0,
 913 };
 914
 915 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 916         "Invalid password",
 917         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 918         "The server is running in simple singleplayer mode.  You cannot connect.",
 919         "Your client's version is not supported.\nPlease contact server administrator.",
 920         "Player name contains disallowed characters.",
 921         "Player name not allowed.",
 922         "Too many users.",
 923         "Empty passwords are disallowed.  Set a password and try again.",
 924         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 925         "Server authentication failed.  This is likely a server error.",
 926         "",
 927         "Server shutting down.",
 928         "This server has experienced an internal error. You will now be disconnected."
 929 };
 930
 931 enum PlayerListModifer: u8
 932 {
 933         PLAYER_LIST_INIT,
 934         PLAYER_LIST_ADD,
 935         PLAYER_LIST_REMOVE,
 936 };
 937
 938 enum CSMRestrictionFlags : u64 {
 939         CSM_RF_NONE = 0x00000000,
 940         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Disable mods provided by clients
 941         CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
 942         CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
 943         CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
 944         CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
 945         CSM_RF_ALL = 0xFFFFFFFF,
 946 };