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 #pragma once
  21
  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                 Obsolete TOCLIENT_PLAYERITEM
  54         PROTOCOL_VERSION 10:
  55                 TOCLIENT_PRIVILEGES
  56                 Version raised to force 'fly' and 'fast' privileges into effect.
  57                 Node metadata change (came in later; somewhat incompatible)
  58         PROTOCOL_VERSION 11:
  59                 TileDef in ContentFeatures
  60                 Nodebox drawtype
  61                 (some dev snapshot)
  62                 TOCLIENT_INVENTORY_FORMSPEC
  63                 (0.4.0, 0.4.1)
  64         PROTOCOL_VERSION 12:
  65                 TOSERVER_INVENTORY_FIELDS
  66                 16-bit node ids
  67                 TOCLIENT_DETACHED_INVENTORY
  68         PROTOCOL_VERSION 13:
  69                 InventoryList field "Width" (deserialization fails with old versions)
  70         PROTOCOL_VERSION 14:
  71                 Added transfer of player pressed keys to the server
  72                 Added new messages for mesh and bone animation, as well as attachments
  73                 GENERIC_CMD_SET_ANIMATION
  74                 GENERIC_CMD_SET_BONE_POSITION
  75                 GENERIC_CMD_SET_ATTACHMENT
  76         PROTOCOL_VERSION 15:
  77                 Serialization format changes
  78         PROTOCOL_VERSION 16:
  79                 TOCLIENT_SHOW_FORMSPEC
  80         PROTOCOL_VERSION 17:
  81                 Serialization format change: include backface_culling flag in TileDef
  82                 Added rightclickable field in nodedef
  83                 TOCLIENT_SPAWN_PARTICLE
  84                 TOCLIENT_ADD_PARTICLESPAWNER
  85                 TOCLIENT_DELETE_PARTICLESPAWNER
  86         PROTOCOL_VERSION 18:
  87                 damageGroups added to ToolCapabilities
  88                 sound_place added to ItemDefinition
  89         PROTOCOL_VERSION 19:
  90                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
  91         PROTOCOL_VERSION 20:
  92                 TOCLIENT_HUDADD
  93                 TOCLIENT_HUDRM
  94                 TOCLIENT_HUDCHANGE
  95                 TOCLIENT_HUD_SET_FLAGS
  96         PROTOCOL_VERSION 21:
  97                 TOCLIENT_BREATH
  98                 TOSERVER_BREATH
  99                 range added to ItemDefinition
 100                 drowning, leveled and liquid_range added to ContentFeatures
 101                 stepheight and collideWithObjects added to object properties
 102                 version, heat and humidity transfer in MapBock
 103                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 104                         added to object properties
 105         PROTOCOL_VERSION 22:
 106                 add swap_node
 107         PROTOCOL_VERSION 23:
 108                 Obsolete TOSERVER_RECEIVED_MEDIA
 109                 Server: Stop using TOSERVER_CLIENT_READY
 110         PROTOCOL_VERSION 24:
 111                 ContentFeatures version 7
 112                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 113         PROTOCOL_VERSION 25:
 114                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
 115                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
 116                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
 117                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
 118                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
 119                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
 120                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
 121                         for standard error, keeping customisation possible. This
 122                         permit translation
 123                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
 124                         reading u32
 125                 Add new opcode TOSERVER_INIT for client presentation to server
 126                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
 127                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
 128                         for the three supported auth mechanisms around srp
 129                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
 130                         for sudo mode handling (auth mech generic way of changing password).
 131                 Add TOCLIENT_HELLO for presenting server to client after client
 132                         presentation
 133                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
 134                 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
 135         PROTOCOL_VERSION 26:
 136                 Add TileDef tileable_horizontal, tileable_vertical flags
 137         PROTOCOL_VERSION 27:
 138                 backface_culling: backwards compatibility for playing with
 139                 newer client on pre-27 servers.
 140                 Add nodedef v3 - connected nodeboxes
 141         PROTOCOL_VERSION 28:
 142                 CPT2_MESHOPTIONS
 143         PROTOCOL_VERSION 29:
 144                 Server doesn't accept TOSERVER_BREATH anymore
 145                 serialization of TileAnimation params changed
 146                 TAT_SHEET_2D
 147                 Removed client-sided chat perdiction
 148         PROTOCOL VERSION 30:
 149                 New ContentFeatures serialization version
 150                 Add node and tile color and palette
 151                 Fix plantlike visual_scale being applied squared and add compatibility
 152                         with pre-30 clients by sending sqrt(visual_scale)
 153         PROTOCOL VERSION 31:
 154                 Add tile overlay
 155                 Stop sending TOSERVER_CLIENT_READY
 156         PROTOCOL VERSION 32:
 157                 Add fading sounds
 158         PROTOCOL VERSION 33:
 159                 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
 160                         instead of guessing based on the active object list.
 161         PROTOCOL VERSION 34:
 162                 Add sound pitch
 163         PROTOCOL VERSION 35:
 164                 Rename TOCLIENT_CHAT_MESSAGE to TOCLIENT_CHAT_MESSAGE_OLD (0x30)
 165                 Add TOCLIENT_CHAT_MESSAGE (0x2F)
 166                         This chat message is a signalisation message containing various
 167                         informations:
 168                         * timestamp
 169                         * sender
 170                         * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
 171                         * content
 172                 Add TOCLIENT_CSM_FLAVOUR_LIMITS to define which CSM flavour should be
 173                         limited
 174                 Add settable player collisionbox. Breaks compatibility with older
 175                         clients as a 1-node vertical offset has been removed from player's
 176                         position
 177                 Add settable player stepheight using existing object property.
 178                         Breaks compatibility with older clients.
 179         PROTOCOL VERSION 36:
 180                 Backwards compatibility drop
 181                 Add 'can_zoom' to player object properties
 182 */
 183
 184 #define LATEST_PROTOCOL_VERSION 36
 185
 186 // Server's supported network protocol range
 187 #define SERVER_PROTOCOL_VERSION_MIN 36
 188 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 189
 190 // Client's supported network protocol range
 191 // The minimal version depends on whether
 192 // send_pre_v25_init is enabled or not
 193 #define CLIENT_PROTOCOL_VERSION_MIN 36
 194 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 195
 196 // Constant that differentiates the protocol from random data and other protocols
 197 #define PROTOCOL_ID 0x4f457403
 198
 199 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 200                                // base64-encoded SHA-1 (27+\0).
 201
 202 #define FORMSPEC_API_VERSION 1
 203 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 204
 205 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 206
 207 enum ToClientCommand
 208 {
 209         TOCLIENT_HELLO = 0x02,
 210         /*
 211                 Sent after TOSERVER_INIT.
 212
 213                 u8 deployed serialisation version
 214                 u16 deployed network compression mode
 215                 u16 deployed protocol version
 216                 u32 supported auth methods
 217                 std::string username that should be used for legacy hash (for proper casing)
 218         */
 219         TOCLIENT_AUTH_ACCEPT = 0x03,
 220         /*
 221                 Message from server to accept auth.
 222
 223                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 224                 u64 map seed
 225                 f1000 recommended send interval
 226                 u32 : supported auth methods for sudo mode
 227                       (where the user can change their password)
 228         */
 229         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 230         /*
 231                 Sent to client to show it is in sudo mode now.
 232         */
 233         TOCLIENT_DENY_SUDO_MODE = 0x05,
 234         /*
 235                 Signals client that sudo mode auth failed.
 236         */
 237         TOCLIENT_ACCESS_DENIED = 0x0A,
 238         /*
 239                 u8 reason
 240                 std::string custom reason (if needed, otherwise "")
 241                 u8 (bool) reconnect
 242         */
 243
 244         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 245
 246         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 247         TOCLIENT_ADDNODE = 0x21,
 248         /*
 249                 v3s16 position
 250                 serialized mapnode
 251                 u8 keep_metadata // Added in protocol version 22
 252         */
 253         TOCLIENT_REMOVENODE = 0x22,
 254
 255         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 256         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 257         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 258         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 259
 260         TOCLIENT_INVENTORY = 0x27,
 261         /*
 262                 [0] u16 command
 263                 [2] serialized inventory
 264         */
 265
 266         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 267
 268         TOCLIENT_TIME_OF_DAY = 0x29,
 269         /*
 270                 u16 time (0-23999)
 271                 Added in a later version:
 272                 f1000 time_speed
 273         */
 274
 275         TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
 276         /*
 277                 u32 CSMFlavourLimits byteflag
 278          */
 279
 280         // (oops, there is some gap here)
 281
 282         TOCLIENT_CHAT_MESSAGE = 0x2F,
 283         /*
 284                 u8 version
 285                 u8 message_type
 286                 u16 sendername length
 287                 wstring sendername
 288                 u16 length
 289                 wstring message
 290         */
 291
 292         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 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         TOCLIENT_DEATHSCREEN = 0x37,
 340         /*
 341                 u8 bool set camera point target
 342                 v3f1000 camera point target (to point the death cause or whatever)
 343         */
 344
 345         TOCLIENT_MEDIA = 0x38,
 346         /*
 347                 u16 total number of texture bunches
 348                 u16 index of this bunch
 349                 u32 number of files in this bunch
 350                 for each file {
 351                         u16 length of name
 352                         string name
 353                         u32 length of data
 354                         data
 355                 }
 356                 u16 length of remote media server url (if applicable)
 357                 string url
 358         */
 359
 360         TOCLIENT_TOOLDEF = 0x39,
 361         /*
 362                 u32 length of the next item
 363                 serialized ToolDefManager
 364         */
 365
 366         TOCLIENT_NODEDEF = 0x3a,
 367         /*
 368                 u32 length of the next item
 369                 serialized NodeDefManager
 370         */
 371
 372         TOCLIENT_CRAFTITEMDEF = 0x3b,
 373         /*
 374                 u32 length of the next item
 375                 serialized CraftiItemDefManager
 376         */
 377
 378         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 379
 380         /*
 381                 u32 number of files
 382                 for each texture {
 383                         u16 length of name
 384                         string name
 385                         u16 length of sha1_digest
 386                         string sha1_digest
 387                 }
 388         */
 389
 390         TOCLIENT_ITEMDEF = 0x3d,
 391         /*
 392                 u32 length of next item
 393                 serialized ItemDefManager
 394         */
 395
 396         TOCLIENT_PLAY_SOUND = 0x3f,
 397         /*
 398                 s32 sound_id
 399                 u16 len
 400                 u8[len] sound name
 401                 s32 gain*1000
 402                 u8 type (0=local, 1=positional, 2=object)
 403                 s32[3] pos_nodes*10000
 404                 u16 object_id
 405                 u8 loop (bool)
 406         */
 407
 408         TOCLIENT_STOP_SOUND = 0x40,
 409         /*
 410                 s32 sound_id
 411         */
 412
 413         TOCLIENT_PRIVILEGES = 0x41,
 414         /*
 415                 u16 number of privileges
 416                 for each privilege
 417                         u16 len
 418                         u8[len] privilege
 419         */
 420
 421         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 422         /*
 423                 u32 len
 424                 u8[len] formspec
 425         */
 426
 427         TOCLIENT_DETACHED_INVENTORY = 0x43,
 428         /*
 429                 [0] u16 command
 430                 u16 len
 431                 u8[len] name
 432                 [2] serialized inventory
 433         */
 434
 435         TOCLIENT_SHOW_FORMSPEC = 0x44,
 436         /*
 437                 [0] u16 command
 438                 u32 len
 439                 u8[len] formspec
 440                 u16 len
 441                 u8[len] formname
 442         */
 443
 444         TOCLIENT_MOVEMENT = 0x45,
 445         /*
 446                 f1000 movement_acceleration_default
 447                 f1000 movement_acceleration_air
 448                 f1000 movement_acceleration_fast
 449                 f1000 movement_speed_walk
 450                 f1000 movement_speed_crouch
 451                 f1000 movement_speed_fast
 452                 f1000 movement_speed_climb
 453                 f1000 movement_speed_jump
 454                 f1000 movement_liquid_fluidity
 455                 f1000 movement_liquid_fluidity_smooth
 456                 f1000 movement_liquid_sink
 457                 f1000 movement_gravity
 458         */
 459
 460         TOCLIENT_SPAWN_PARTICLE = 0x46,
 461         /*
 462                 v3f1000 pos
 463                 v3f1000 velocity
 464                 v3f1000 acceleration
 465                 f1000 expirationtime
 466                 f1000 size
 467                 u8 bool collisiondetection
 468                 u8 bool vertical
 469                 u32 len
 470                 u8[len] texture
 471                 u8 collision_removal
 472         */
 473
 474         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 475         /*
 476                 u16 amount
 477                 f1000 spawntime
 478                 v3f1000 minpos
 479                 v3f1000 maxpos
 480                 v3f1000 minvel
 481                 v3f1000 maxvel
 482                 v3f1000 minacc
 483                 v3f1000 maxacc
 484                 f1000 minexptime
 485                 f1000 maxexptime
 486                 f1000 minsize
 487                 f1000 maxsize
 488                 u8 bool collisiondetection
 489                 u8 bool vertical
 490                 u32 len
 491                 u8[len] texture
 492                 u32 id
 493                 u8 collision_removal
 494         */
 495
 496         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 497
 498         TOCLIENT_HUDADD = 0x49,
 499         /*
 500                 u32 id
 501                 u8 type
 502                 v2f1000 pos
 503                 u32 len
 504                 u8[len] name
 505                 v2f1000 scale
 506                 u32 len2
 507                 u8[len2] text
 508                 u32 number
 509                 u32 item
 510                 u32 dir
 511                 v2f1000 align
 512                 v2f1000 offset
 513                 v3f1000 world_pos
 514                 v2s32 size
 515         */
 516
 517         TOCLIENT_HUDRM = 0x4a,
 518         /*
 519                 u32 id
 520         */
 521
 522         TOCLIENT_HUDCHANGE = 0x4b,
 523         /*
 524                 u32 id
 525                 u8 stat
 526                 [v2f1000 data |
 527                  u32 len
 528                  u8[len] data |
 529                  u32 data]
 530         */
 531
 532         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 533         /*
 534                 u32 flags
 535                 u32 mask
 536         */
 537
 538         TOCLIENT_HUD_SET_PARAM = 0x4d,
 539         /*
 540                 u16 param
 541                 u16 len
 542                 u8[len] value
 543         */
 544
 545         TOCLIENT_BREATH = 0x4e,
 546         /*
 547                 u16 breath
 548         */
 549
 550         TOCLIENT_SET_SKY = 0x4f,
 551         /*
 552                 u8[4] color (ARGB)
 553                 u8 len
 554                 u8[len] type
 555                 u16 count
 556                 foreach count:
 557                         u8 len
 558                         u8[len] param
 559                 u8 clouds (boolean)
 560         */
 561
 562         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 563         /*
 564                 u8 do_override (boolean)
 565                 u16 day-night ratio 0...65535
 566         */
 567
 568         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 569         /*
 570                 v2s32 stand/idle
 571                 v2s32 walk
 572                 v2s32 dig
 573                 v2s32 walk+dig
 574                 f1000 frame_speed
 575         */
 576
 577         TOCLIENT_EYE_OFFSET = 0x52,
 578         /*
 579                 v3f1000 first
 580                 v3f1000 third
 581         */
 582
 583         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 584         /*
 585                 u32 id
 586         */
 587
 588         TOCLIENT_CLOUD_PARAMS = 0x54,
 589         /*
 590                 f1000 density
 591                 u8[4] color_diffuse (ARGB)
 592                 u8[4] color_ambient (ARGB)
 593                 f1000 height
 594                 f1000 thickness
 595                 v2f1000 speed
 596         */
 597
 598         TOCLIENT_FADE_SOUND = 0x55,
 599         /*
 600                 s32 sound_id
 601                 float step
 602                 float gain
 603         */
 604         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 605         /*
 606                 u8 type
 607                 u16 number of players
 608                 for each player
 609                         u16 len
 610                         u8[len] player name
 611         */
 612
 613         TOCLIENT_SRP_BYTES_S_B = 0x60,
 614         /*
 615                 Belonging to AUTH_MECHANISM_SRP.
 616
 617                 std::string bytes_s
 618                 std::string bytes_B
 619         */
 620
 621         TOCLIENT_NUM_MSG_TYPES = 0x61,
 622 };
 623
 624 enum ToServerCommand
 625 {
 626         TOSERVER_INIT = 0x02,
 627         /*
 628                 Sent first after connected.
 629
 630                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 631                 u16 supported network compression modes
 632                 u16 minimum supported network protocol version
 633                 u16 maximum supported network protocol version
 634                 std::string player name
 635         */
 636
 637         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 638
 639         TOSERVER_INIT2 = 0x11,
 640         /*
 641                 Sent as an ACK for TOCLIENT_INIT.
 642                 After this, the server can send data.
 643
 644                 [0] u16 TOSERVER_INIT2
 645         */
 646
 647         TOSERVER_GETBLOCK = 0x20, // Obsolete
 648         TOSERVER_ADDNODE = 0x21, // Obsolete
 649         TOSERVER_REMOVENODE = 0x22, // Obsolete
 650
 651         TOSERVER_PLAYERPOS = 0x23,
 652         /*
 653                 [0] u16 command
 654                 [2] v3s32 position*100
 655                 [2+12] v3s32 speed*100
 656                 [2+12+12] s32 pitch*100
 657                 [2+12+12+4] s32 yaw*100
 658                 [2+12+12+4+4] u32 keyPressed
 659                 [2+12+12+4+4+1] u8 fov*80
 660                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 661         */
 662
 663         TOSERVER_GOTBLOCKS = 0x24,
 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_DELETEDBLOCKS = 0x25,
 673         /*
 674                 [0] u16 command
 675                 [2] u8 count
 676                 [3] v3s16 pos_0
 677                 [3+6] v3s16 pos_1
 678                 ...
 679         */
 680
 681         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 682         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 683         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 684         TOSERVER_RELEASE = 0x29, // Obsolete
 685         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 686
 687         TOSERVER_INVENTORY_ACTION = 0x31,
 688         /*
 689                 See InventoryAction in inventorymanager.h
 690         */
 691
 692         TOSERVER_CHAT_MESSAGE = 0x32,
 693         /*
 694                 u16 length
 695                 wstring message
 696         */
 697
 698         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 699         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 700
 701         TOSERVER_DAMAGE = 0x35,
 702         /*
 703                 u8 amount
 704         */
 705
 706         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 707
 708         TOSERVER_PLAYERITEM = 0x37,
 709         /*
 710                 Sent to change selected item.
 711
 712                 [0] u16 TOSERVER_PLAYERITEM
 713                 [2] u16 item
 714         */
 715
 716         TOSERVER_RESPAWN = 0x38,
 717         /*
 718                 u16 TOSERVER_RESPAWN
 719         */
 720
 721         TOSERVER_INTERACT = 0x39,
 722         /*
 723                 [0] u16 command
 724                 [2] u8 action
 725                 [3] u16 item
 726                 [5] u32 length of the next item
 727                 [9] serialized PointedThing
 728                 actions:
 729                 0: start digging (from undersurface) or use
 730                 1: stop digging (all parameters ignored)
 731                 2: digging completed
 732                 3: place block or item (to abovesurface)
 733                 4: use item
 734         */
 735
 736         TOSERVER_REMOVED_SOUNDS = 0x3a,
 737         /*
 738                 u16 len
 739                 s32[len] sound_id
 740         */
 741
 742         TOSERVER_NODEMETA_FIELDS = 0x3b,
 743         /*
 744                 v3s16 p
 745                 u16 len
 746                 u8[len] form name (reserved for future use)
 747                 u16 number of fields
 748                 for each field:
 749                         u16 len
 750                         u8[len] field name
 751                         u32 len
 752                         u8[len] field value
 753         */
 754
 755         TOSERVER_INVENTORY_FIELDS = 0x3c,
 756         /*
 757                 u16 len
 758                 u8[len] form name (reserved for future use)
 759                 u16 number of fields
 760                 for each field:
 761                         u16 len
 762                         u8[len] field name
 763                         u32 len
 764                         u8[len] field value
 765         */
 766
 767         TOSERVER_REQUEST_MEDIA = 0x40,
 768         /*
 769                 u16 number of files requested
 770                 for each file {
 771                         u16 length of name
 772                         string name
 773                 }
 774         */
 775
 776         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 777         TOSERVER_BREATH = 0x42, // Obsolete
 778
 779         TOSERVER_CLIENT_READY = 0x43,
 780         /*
 781                 u8 major
 782                 u8 minor
 783                 u8 patch
 784                 u8 reserved
 785                 u16 len
 786                 u8[len] full_version_string
 787         */
 788
 789         TOSERVER_FIRST_SRP = 0x50,
 790         /*
 791                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 792
 793                 std::string srp salt
 794                 std::string srp verification key
 795                 u8 is_empty (=1 if password is empty, 0 otherwise)
 796         */
 797
 798         TOSERVER_SRP_BYTES_A = 0x51,
 799         /*
 800                 Belonging to AUTH_MECHANISM_SRP,
 801                         depending on current_login_based_on.
 802
 803                 std::string bytes_A
 804                 u8 current_login_based_on : on which version of the password's
 805                                             hash this login is based on (0 legacy hash,
 806                                             or 1 directly the password)
 807         */
 808
 809         TOSERVER_SRP_BYTES_M = 0x52,
 810         /*
 811                 Belonging to AUTH_MECHANISM_SRP.
 812
 813                 std::string bytes_M
 814         */
 815
 816         TOSERVER_NUM_MSG_TYPES = 0x53,
 817 };
 818
 819 enum AuthMechanism
 820 {
 821         // reserved
 822         AUTH_MECHANISM_NONE = 0,
 823
 824         // SRP based on the legacy hash
 825         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 826
 827         // SRP based on the srp verification key
 828         AUTH_MECHANISM_SRP = 1 << 1,
 829
 830         // Establishes a srp verification key, for first login and password changing
 831         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 832 };
 833
 834 enum AccessDeniedCode {
 835         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 836         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 837         SERVER_ACCESSDENIED_SINGLEPLAYER,
 838         SERVER_ACCESSDENIED_WRONG_VERSION,
 839         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 840         SERVER_ACCESSDENIED_WRONG_NAME,
 841         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 842         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 843         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 844         SERVER_ACCESSDENIED_SERVER_FAIL,
 845         SERVER_ACCESSDENIED_CUSTOM_STRING,
 846         SERVER_ACCESSDENIED_SHUTDOWN,
 847         SERVER_ACCESSDENIED_CRASH,
 848         SERVER_ACCESSDENIED_MAX,
 849 };
 850
 851 enum NetProtoCompressionMode {
 852         NETPROTO_COMPRESSION_NONE = 0,
 853 };
 854
 855 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 856         "Invalid password",
 857         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 858         "The server is running in simple singleplayer mode.  You cannot connect.",
 859         "Your client's version is not supported.\nPlease contact server administrator.",
 860         "Player name contains disallowed characters.",
 861         "Player name not allowed.",
 862         "Too many users.",
 863         "Empty passwords are disallowed.  Set a password and try again.",
 864         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 865         "Server authentication failed.  This is likely a server error.",
 866         "",
 867         "Server shutting down.",
 868         "This server has experienced an internal error. You will now be disconnected."
 869 };
 870
 871 enum PlayerListModifer: u8
 872 {
 873         PLAYER_LIST_INIT,
 874         PLAYER_LIST_ADD,
 875         PLAYER_LIST_REMOVE,
 876 };
 877
 878 enum CSMFlavourLimit : u64 {
 879         CSM_FL_NONE = 0x00000000,
 880         CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
 881         CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
 882         CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
 883         CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
 884         CSM_FL_ALL = 0xFFFFFFFF,
 885 };
 886