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