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