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