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_RESTRICTION_FLAGS to define which CSM features 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                 Add glow to object properties
 183                 Change TileDef serialization format.
 184                 Add world-aligned tiles.
 185                 Mod channels
 186                 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
 187                         'zoom_fov'.
 188                 Nodebox version 5
 189                 Add disconnected nodeboxes
 190                 Add TOCLIENT_FORMSPEC_PREPEND
 191         PROTOCOL VERSION 37:
 192                 Redo detached inventory sending
 193                 Add TOCLIENT_NODEMETA_CHANGED
 194 */
 195
 196 #define LATEST_PROTOCOL_VERSION 37
 197 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
 198
 199 // Server's supported network protocol range
 200 #define SERVER_PROTOCOL_VERSION_MIN 37
 201 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 202
 203 // Client's supported network protocol range
 204 // The minimal version depends on whether
 205 // send_pre_v25_init is enabled or not
 206 #define CLIENT_PROTOCOL_VERSION_MIN 37
 207 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 208
 209 // Constant that differentiates the protocol from random data and other protocols
 210 #define PROTOCOL_ID 0x4f457403
 211
 212 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 213                                // base64-encoded SHA-1 (27+\0).
 214
 215 #define FORMSPEC_API_VERSION 1
 216 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 217
 218 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 219
 220 typedef u16 session_t;
 221
 222 enum ToClientCommand
 223 {
 224         TOCLIENT_HELLO = 0x02,
 225         /*
 226                 Sent after TOSERVER_INIT.
 227
 228                 u8 deployed serialisation version
 229                 u16 deployed network compression mode
 230                 u16 deployed protocol version
 231                 u32 supported auth methods
 232                 std::string username that should be used for legacy hash (for proper casing)
 233         */
 234         TOCLIENT_AUTH_ACCEPT = 0x03,
 235         /*
 236                 Message from server to accept auth.
 237
 238                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 239                 u64 map seed
 240                 f1000 recommended send interval
 241                 u32 : supported auth methods for sudo mode
 242                       (where the user can change their password)
 243         */
 244         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 245         /*
 246                 Sent to client to show it is in sudo mode now.
 247         */
 248         TOCLIENT_DENY_SUDO_MODE = 0x05,
 249         /*
 250                 Signals client that sudo mode auth failed.
 251         */
 252         TOCLIENT_ACCESS_DENIED = 0x0A,
 253         /*
 254                 u8 reason
 255                 std::string custom reason (if needed, otherwise "")
 256                 u8 (bool) reconnect
 257         */
 258
 259         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 260
 261         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 262         TOCLIENT_ADDNODE = 0x21,
 263         /*
 264                 v3s16 position
 265                 serialized mapnode
 266                 u8 keep_metadata // Added in protocol version 22
 267         */
 268         TOCLIENT_REMOVENODE = 0x22,
 269
 270         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 271         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 272         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 273         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 274
 275         TOCLIENT_INVENTORY = 0x27,
 276         /*
 277                 [0] u16 command
 278                 [2] serialized inventory
 279         */
 280
 281         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 282
 283         TOCLIENT_TIME_OF_DAY = 0x29,
 284         /*
 285                 u16 time (0-23999)
 286                 Added in a later version:
 287                 f1000 time_speed
 288         */
 289
 290         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 291         /*
 292                 u32 CSMRestrictionFlags byteflag
 293          */
 294
 295         // (oops, there is some gap here)
 296
 297         TOCLIENT_CHAT_MESSAGE = 0x2F,
 298         /*
 299                 u8 version
 300                 u8 message_type
 301                 u16 sendername length
 302                 wstring sendername
 303                 u16 length
 304                 wstring message
 305         */
 306
 307         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 308
 309         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 310         /*
 311                 u16 count of removed objects
 312                 for all removed objects {
 313                         u16 id
 314                 }
 315                 u16 count of added objects
 316                 for all added objects {
 317                         u16 id
 318                         u8 type
 319                         u32 initialization data length
 320                         string initialization data
 321                 }
 322         */
 323
 324         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 325         /*
 326                 for all objects
 327                 {
 328                         u16 id
 329                         u16 message length
 330                         string message
 331                 }
 332         */
 333
 334         TOCLIENT_HP = 0x33,
 335         /*
 336                 u8 hp
 337         */
 338
 339         TOCLIENT_MOVE_PLAYER = 0x34,
 340         /*
 341                 v3f1000 player position
 342                 f1000 player pitch
 343                 f1000 player yaw
 344         */
 345
 346         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 347         /*
 348                 u16 reason_length
 349                 wstring reason
 350         */
 351
 352         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 353
 354         TOCLIENT_DEATHSCREEN = 0x37,
 355         /*
 356                 u8 bool set camera point target
 357                 v3f1000 camera point target (to point the death cause or whatever)
 358         */
 359
 360         TOCLIENT_MEDIA = 0x38,
 361         /*
 362                 u16 total number of texture bunches
 363                 u16 index of this bunch
 364                 u32 number of files in this bunch
 365                 for each file {
 366                         u16 length of name
 367                         string name
 368                         u32 length of data
 369                         data
 370                 }
 371                 u16 length of remote media server url (if applicable)
 372                 string url
 373         */
 374
 375         TOCLIENT_TOOLDEF = 0x39,
 376         /*
 377                 u32 length of the next item
 378                 serialized ToolDefManager
 379         */
 380
 381         TOCLIENT_NODEDEF = 0x3a,
 382         /*
 383                 u32 length of the next item
 384                 serialized NodeDefManager
 385         */
 386
 387         TOCLIENT_CRAFTITEMDEF = 0x3b,
 388         /*
 389                 u32 length of the next item
 390                 serialized CraftiItemDefManager
 391         */
 392
 393         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 394
 395         /*
 396                 u32 number of files
 397                 for each texture {
 398                         u16 length of name
 399                         string name
 400                         u16 length of sha1_digest
 401                         string sha1_digest
 402                 }
 403         */
 404
 405         TOCLIENT_ITEMDEF = 0x3d,
 406         /*
 407                 u32 length of next item
 408                 serialized ItemDefManager
 409         */
 410
 411         TOCLIENT_PLAY_SOUND = 0x3f,
 412         /*
 413                 s32 sound_id
 414                 u16 len
 415                 u8[len] sound name
 416                 s32 gain*1000
 417                 u8 type (0=local, 1=positional, 2=object)
 418                 s32[3] pos_nodes*10000
 419                 u16 object_id
 420                 u8 loop (bool)
 421         */
 422
 423         TOCLIENT_STOP_SOUND = 0x40,
 424         /*
 425                 s32 sound_id
 426         */
 427
 428         TOCLIENT_PRIVILEGES = 0x41,
 429         /*
 430                 u16 number of privileges
 431                 for each privilege
 432                         u16 len
 433                         u8[len] privilege
 434         */
 435
 436         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 437         /*
 438                 u32 len
 439                 u8[len] formspec
 440         */
 441
 442         TOCLIENT_DETACHED_INVENTORY = 0x43,
 443         /*
 444                 [0] u16 command
 445                 u16 len
 446                 u8[len] name
 447                 [2] serialized inventory
 448         */
 449
 450         TOCLIENT_SHOW_FORMSPEC = 0x44,
 451         /*
 452                 [0] u16 command
 453                 u32 len
 454                 u8[len] formspec
 455                 u16 len
 456                 u8[len] formname
 457         */
 458
 459         TOCLIENT_MOVEMENT = 0x45,
 460         /*
 461                 f1000 movement_acceleration_default
 462                 f1000 movement_acceleration_air
 463                 f1000 movement_acceleration_fast
 464                 f1000 movement_speed_walk
 465                 f1000 movement_speed_crouch
 466                 f1000 movement_speed_fast
 467                 f1000 movement_speed_climb
 468                 f1000 movement_speed_jump
 469                 f1000 movement_liquid_fluidity
 470                 f1000 movement_liquid_fluidity_smooth
 471                 f1000 movement_liquid_sink
 472                 f1000 movement_gravity
 473         */
 474
 475         TOCLIENT_SPAWN_PARTICLE = 0x46,
 476         /*
 477                 v3f1000 pos
 478                 v3f1000 velocity
 479                 v3f1000 acceleration
 480                 f1000 expirationtime
 481                 f1000 size
 482                 u8 bool collisiondetection
 483                 u32 len
 484                 u8[len] texture
 485                 u8 bool vertical
 486                 u8 collision_removal
 487                 TileAnimation animation
 488                 u8 glow
 489                 u8 object_collision
 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                 u32 len
 508                 u8[len] texture
 509                 u8 bool vertical
 510                 u8 collision_removal
 511                 u32 id
 512                 TileAnimation animation
 513                 u8 glow
 514                 u8 object_collision
 515         */
 516
 517         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 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                 u8 clouds (boolean)
 581         */
 582
 583         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 584         /*
 585                 u8 do_override (boolean)
 586                 u16 day-night ratio 0...65535
 587         */
 588
 589         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 590         /*
 591                 v2s32 stand/idle
 592                 v2s32 walk
 593                 v2s32 dig
 594                 v2s32 walk+dig
 595                 f1000 frame_speed
 596         */
 597
 598         TOCLIENT_EYE_OFFSET = 0x52,
 599         /*
 600                 v3f1000 first
 601                 v3f1000 third
 602         */
 603
 604         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 605         /*
 606                 u32 id
 607         */
 608
 609         TOCLIENT_CLOUD_PARAMS = 0x54,
 610         /*
 611                 f1000 density
 612                 u8[4] color_diffuse (ARGB)
 613                 u8[4] color_ambient (ARGB)
 614                 f1000 height
 615                 f1000 thickness
 616                 v2f1000 speed
 617         */
 618
 619         TOCLIENT_FADE_SOUND = 0x55,
 620         /*
 621                 s32 sound_id
 622                 float step
 623                 float gain
 624         */
 625         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 626         /*
 627                 u8 type
 628                 u16 number of players
 629                 for each player
 630                         u16 len
 631                         u8[len] player name
 632         */
 633
 634         TOCLIENT_MODCHANNEL_MSG = 0x57,
 635         /*
 636                 u16 channel name length
 637                 std::string channel name
 638                 u16 channel name sender
 639                 std::string channel name
 640                 u16 message length
 641                 std::string message
 642         */
 643
 644         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 645         /*
 646                 u8 signal id
 647                 u16 channel name length
 648                 std::string channel name
 649         */
 650
 651         TOCLIENT_NODEMETA_CHANGED = 0x59,
 652         /*
 653                 serialized and compressed node metadata
 654         */
 655
 656         TOCLIENT_SRP_BYTES_S_B = 0x60,
 657         /*
 658                 Belonging to AUTH_MECHANISM_SRP.
 659
 660                 std::string bytes_s
 661                 std::string bytes_B
 662         */
 663
 664         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 665         /*
 666                 u16 len
 667                 u8[len] formspec
 668         */
 669
 670         TOCLIENT_NUM_MSG_TYPES = 0x62,
 671 };
 672
 673 enum ToServerCommand
 674 {
 675         TOSERVER_INIT = 0x02,
 676         /*
 677                 Sent first after connected.
 678
 679                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 680                 u16 supported network compression modes
 681                 u16 minimum supported network protocol version
 682                 u16 maximum supported network protocol version
 683                 std::string player name
 684         */
 685
 686         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 687
 688         TOSERVER_INIT2 = 0x11,
 689         /*
 690                 Sent as an ACK for TOCLIENT_INIT.
 691                 After this, the server can send data.
 692
 693                 [0] u16 TOSERVER_INIT2
 694         */
 695
 696         TOSERVER_MODCHANNEL_JOIN = 0x17,
 697         /*
 698                 u16 channel name length
 699                 std::string channel name
 700          */
 701
 702         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 703         /*
 704                 u16 channel name length
 705                 std::string channel name
 706          */
 707
 708         TOSERVER_MODCHANNEL_MSG = 0x19,
 709         /*
 710                 u16 channel name length
 711                 std::string channel name
 712                 u16 message length
 713                 std::string message
 714          */
 715
 716         TOSERVER_GETBLOCK = 0x20, // Obsolete
 717         TOSERVER_ADDNODE = 0x21, // Obsolete
 718         TOSERVER_REMOVENODE = 0x22, // Obsolete
 719
 720         TOSERVER_PLAYERPOS = 0x23,
 721         /*
 722                 [0] u16 command
 723                 [2] v3s32 position*100
 724                 [2+12] v3s32 speed*100
 725                 [2+12+12] s32 pitch*100
 726                 [2+12+12+4] s32 yaw*100
 727                 [2+12+12+4+4] u32 keyPressed
 728                 [2+12+12+4+4+1] u8 fov*80
 729                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 730         */
 731
 732         TOSERVER_GOTBLOCKS = 0x24,
 733         /*
 734                 [0] u16 command
 735                 [2] u8 count
 736                 [3] v3s16 pos_0
 737                 [3+6] v3s16 pos_1
 738                 ...
 739         */
 740
 741         TOSERVER_DELETEDBLOCKS = 0x25,
 742         /*
 743                 [0] u16 command
 744                 [2] u8 count
 745                 [3] v3s16 pos_0
 746                 [3+6] v3s16 pos_1
 747                 ...
 748         */
 749
 750         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 751         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 752         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 753         TOSERVER_RELEASE = 0x29, // Obsolete
 754         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 755
 756         TOSERVER_INVENTORY_ACTION = 0x31,
 757         /*
 758                 See InventoryAction in inventorymanager.h
 759         */
 760
 761         TOSERVER_CHAT_MESSAGE = 0x32,
 762         /*
 763                 u16 length
 764                 wstring message
 765         */
 766
 767         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 768         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 769
 770         TOSERVER_DAMAGE = 0x35,
 771         /*
 772                 u8 amount
 773         */
 774
 775         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 776
 777         TOSERVER_PLAYERITEM = 0x37,
 778         /*
 779                 Sent to change selected item.
 780
 781                 [0] u16 TOSERVER_PLAYERITEM
 782                 [2] u16 item
 783         */
 784
 785         TOSERVER_RESPAWN = 0x38,
 786         /*
 787                 u16 TOSERVER_RESPAWN
 788         */
 789
 790         TOSERVER_INTERACT = 0x39,
 791         /*
 792                 [0] u16 command
 793                 [2] u8 action
 794                 [3] u16 item
 795                 [5] u32 length of the next item
 796                 [9] serialized PointedThing
 797                 actions:
 798                 0: start digging (from undersurface) or use
 799                 1: stop digging (all parameters ignored)
 800                 2: digging completed
 801                 3: place block or item (to abovesurface)
 802                 4: use item
 803         */
 804
 805         TOSERVER_REMOVED_SOUNDS = 0x3a,
 806         /*
 807                 u16 len
 808                 s32[len] sound_id
 809         */
 810
 811         TOSERVER_NODEMETA_FIELDS = 0x3b,
 812         /*
 813                 v3s16 p
 814                 u16 len
 815                 u8[len] form name (reserved for future use)
 816                 u16 number of fields
 817                 for each field:
 818                         u16 len
 819                         u8[len] field name
 820                         u32 len
 821                         u8[len] field value
 822         */
 823
 824         TOSERVER_INVENTORY_FIELDS = 0x3c,
 825         /*
 826                 u16 len
 827                 u8[len] form name (reserved for future use)
 828                 u16 number of fields
 829                 for each field:
 830                         u16 len
 831                         u8[len] field name
 832                         u32 len
 833                         u8[len] field value
 834         */
 835
 836         TOSERVER_REQUEST_MEDIA = 0x40,
 837         /*
 838                 u16 number of files requested
 839                 for each file {
 840                         u16 length of name
 841                         string name
 842                 }
 843         */
 844
 845         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 846         TOSERVER_BREATH = 0x42, // Obsolete
 847
 848         TOSERVER_CLIENT_READY = 0x43,
 849         /*
 850                 u8 major
 851                 u8 minor
 852                 u8 patch
 853                 u8 reserved
 854                 u16 len
 855                 u8[len] full_version_string
 856         */
 857
 858         TOSERVER_FIRST_SRP = 0x50,
 859         /*
 860                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 861
 862                 std::string srp salt
 863                 std::string srp verification key
 864                 u8 is_empty (=1 if password is empty, 0 otherwise)
 865         */
 866
 867         TOSERVER_SRP_BYTES_A = 0x51,
 868         /*
 869                 Belonging to AUTH_MECHANISM_SRP,
 870                         depending on current_login_based_on.
 871
 872                 std::string bytes_A
 873                 u8 current_login_based_on : on which version of the password's
 874                                             hash this login is based on (0 legacy hash,
 875                                             or 1 directly the password)
 876         */
 877
 878         TOSERVER_SRP_BYTES_M = 0x52,
 879         /*
 880                 Belonging to AUTH_MECHANISM_SRP.
 881
 882                 std::string bytes_M
 883         */
 884
 885         TOSERVER_NUM_MSG_TYPES = 0x53,
 886 };
 887
 888 enum AuthMechanism
 889 {
 890         // reserved
 891         AUTH_MECHANISM_NONE = 0,
 892
 893         // SRP based on the legacy hash
 894         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 895
 896         // SRP based on the srp verification key
 897         AUTH_MECHANISM_SRP = 1 << 1,
 898
 899         // Establishes a srp verification key, for first login and password changing
 900         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 901 };
 902
 903 enum AccessDeniedCode {
 904         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 905         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 906         SERVER_ACCESSDENIED_SINGLEPLAYER,
 907         SERVER_ACCESSDENIED_WRONG_VERSION,
 908         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 909         SERVER_ACCESSDENIED_WRONG_NAME,
 910         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 911         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 912         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 913         SERVER_ACCESSDENIED_SERVER_FAIL,
 914         SERVER_ACCESSDENIED_CUSTOM_STRING,
 915         SERVER_ACCESSDENIED_SHUTDOWN,
 916         SERVER_ACCESSDENIED_CRASH,
 917         SERVER_ACCESSDENIED_MAX,
 918 };
 919
 920 enum NetProtoCompressionMode {
 921         NETPROTO_COMPRESSION_NONE = 0,
 922 };
 923
 924 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 925         "Invalid password",
 926         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 927         "The server is running in simple singleplayer mode.  You cannot connect.",
 928         "Your client's version is not supported.\nPlease contact server administrator.",
 929         "Player name contains disallowed characters.",
 930         "Player name not allowed.",
 931         "Too many users.",
 932         "Empty passwords are disallowed.  Set a password and try again.",
 933         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 934         "Server authentication failed.  This is likely a server error.",
 935         "",
 936         "Server shutting down.",
 937         "This server has experienced an internal error. You will now be disconnected."
 938 };
 939
 940 enum PlayerListModifer: u8
 941 {
 942         PLAYER_LIST_INIT,
 943         PLAYER_LIST_ADD,
 944         PLAYER_LIST_REMOVE,
 945 };
 946
 947 enum CSMRestrictionFlags : u64 {
 948         CSM_RF_NONE = 0x00000000,
 949         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Disable mods provided by clients
 950         CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
 951         CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
 952         CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
 953         CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
 954         CSM_RF_ALL = 0xFFFFFFFF,
 955 };