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