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