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