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