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