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