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