src/clientiface.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2014 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 "irr_v3d.h"                   // for irrlicht datatypes
  23
  24 #include "constants.h"
  25 #include "serialization.h"             // for SER_FMT_VER_INVALID
  26 #include "network/networkpacket.h"
  27 #include "network/networkprotocol.h"
  28 #include "porting.h"
  29
  30 #include <list>
  31 #include <vector>
  32 #include <set>
  33 #include <mutex>
  34
  35 class MapBlock;
  36 class ServerEnvironment;
  37 class EmergeManager;
  38
  39 /*
  40  * State Transitions
  41
  42       Start
  43   (peer connect)
  44         |
  45         v
  46       /-----------------\
  47       |                 |
  48       |    Created      |
  49       |                 |
  50       \-----------------/
  51                |                  depending of the incoming packet
  52                ----------------------------------------
  53                                                       v
  54                                        +-----------------------------+
  55                                        |IN:                          |
  56                                        | TOSERVER_INIT               |
  57                                        +-----------------------------+
  58                                                       | invalid playername
  59                                                       | or denied by mod
  60                                                       v
  61                                        +-----------------------------+
  62                                        |OUT:                         |
  63                                        | TOCLIENT_HELLO              |
  64                                        +-----------------------------+
  65                                                       |
  66                                                       |
  67                                                       v
  68       /-----------------\                    /-----------------\
  69       |                 |                    |                 |
  70       |  AwaitingInit2  |<---------          |    HelloSent    |
  71       |                 |         |          |                 |
  72       \-----------------/         |          \-----------------/
  73                |                  |                   |
  74 +-----------------------------+   |    *-----------------------------*     Auth fails
  75 |IN:                          |   |    |Authentication, depending on |------------------
  76 | TOSERVER_INIT2              |   |    | packet sent by client       |                 |
  77 +-----------------------------+   |    *-----------------------------*                 |
  78                |                  |                   |                                |
  79                |                  |                   | Authentication                 |
  80                v                  |                   |  successful                    |
  81       /-----------------\         |                   v                                |
  82       |                 |         |    +-----------------------------+                 |
  83       |    InitDone     |         |    |OUT:                         |                 |
  84       |                 |         |    | TOCLIENT_AUTH_ACCEPT        |                 |
  85       \-----------------/         |    +-----------------------------+                 |
  86                |                  |                   |                                |
  87 +-----------------------------+   ---------------------                                |
  88 |OUT:                         |                                                        |
  89 | TOCLIENT_MOVEMENT           |                                                        |
  90 | TOCLIENT_ITEMDEF            |                                                        |
  91 | TOCLIENT_NODEDEF            |                                                        |
  92 | TOCLIENT_ANNOUNCE_MEDIA     |                                                        |
  93 | TOCLIENT_DETACHED_INVENTORY |                                                        |
  94 | TOCLIENT_TIME_OF_DAY        |                                                        |
  95 +-----------------------------+                                                        |
  96                |                                                                       |
  97                |                                                                       |
  98                |      -----------------------------                                    |
  99                v      |                           |                                    |
 100       /-----------------\                         v                                    |
 101       |                 |             +-----------------------------+                  |
 102       | DefinitionsSent |             |IN:                          |                  |
 103       |                 |             | TOSERVER_REQUEST_MEDIA      |                  |
 104       \-----------------/             |                             |                  |
 105                |                      +-----------------------------+                  |
 106                |      ^                           |                                    |
 107                |      -----------------------------                                    |
 108                v                                                                       v
 109 +-----------------------------+                        --------------------------------+
 110 |IN:                          |                        |                               ^
 111 | TOSERVER_CLIENT_READY       |                        v                               |
 112 +-----------------------------+            +------------------------+                  |
 113                |                           |OUT:                    |                  |
 114                v                           | TOCLIENT_ACCESS_DENIED |                  |
 115 +-----------------------------+            +------------------------+                  |
 116 |OUT:                         |                        |                               |
 117 | TOCLIENT_MOVE_PLAYER        |                        v                               |
 118 | TOCLIENT_PRIVILEGES         |                /-----------------\                     |
 119 | TOCLIENT_INVENTORY_FORMSPEC |                |                 |                     |
 120 | UpdateCrafting              |                |     Denied      |                     |
 121 | TOCLIENT_INVENTORY          |                |                 |                     |
 122 | TOCLIENT_HP (opt)           |                \-----------------/                     |
 123 | TOCLIENT_BREATH             |                                                        |
 124 | TOCLIENT_DEATHSCREEN        |                                                        |
 125 +-----------------------------+                                                        |
 126               |                                                                        |
 127               v                                                                        |
 128       /-----------------\      async mod action (ban, kick)                            |
 129       |                 |---------------------------------------------------------------
 130  ---->|     Active      |
 131  |    |                 |----------------------------------------------
 132  |    \-----------------/      timeout                                v
 133  |       |           |                                  +-----------------------------+
 134  |       |           |                                  |OUT:                         |
 135  |       |           |                                  | TOCLIENT_DISCONNECT         |
 136  |       |           |                                  +-----------------------------+
 137  |       |           |                                                |
 138  |       |           v                                                v
 139  |       |  +-----------------------------+                    /-----------------\
 140  |       |  |IN:                          |                    |                 |
 141  |       |  | TOSERVER_DISCONNECT         |------------------->|  Disconnecting  |
 142  |       |  +-----------------------------+                    |                 |
 143  |       |                                                     \-----------------/
 144  |       | any auth packet which was
 145  |       | allowed in TOCLIENT_AUTH_ACCEPT
 146  |       v
 147  |    *-----------------------------* Auth      +-------------------------------+
 148  |    |Authentication, depending on | succeeds  |OUT:                           |
 149  |    | packet sent by client       |---------->| TOCLIENT_ACCEPT_SUDO_MODE     |
 150  |    *-----------------------------*           +-------------------------------+
 151  |                  |                                            |
 152  |                  | Auth fails                        /-----------------\
 153  |                  v                                   |                 |
 154  |    +-------------------------------+                 |    SudoMode     |
 155  |    |OUT:                           |                 |                 |
 156  |    | TOCLIENT_DENY_SUDO_MODE       |                 \-----------------/
 157  |    +-------------------------------+                          |
 158  |                  |                                            v
 159  |                  |                               +-----------------------------+
 160  |                  |    sets password accordingly  |IN:                          |
 161  -------------------+-------------------------------| TOSERVER_FIRST_SRP          |
 162                                                     +-----------------------------+
 163
 164 */
 165 namespace con {
 166         class Connection;
 167 }
 168
 169
 170 // Also make sure to update the ClientInterface::statenames
 171 // array when modifying these enums
 172
 173 enum ClientState
 174 {
 175         CS_Invalid,
 176         CS_Disconnecting,
 177         CS_Denied,
 178         CS_Created,
 179         CS_AwaitingInit2,
 180         CS_HelloSent,
 181         CS_InitDone,
 182         CS_DefinitionsSent,
 183         CS_Active,
 184         CS_SudoMode
 185 };
 186
 187 enum ClientStateEvent
 188 {
 189         CSE_Hello,
 190         CSE_AuthAccept,
 191         CSE_InitLegacy,
 192         CSE_GotInit2,
 193         CSE_SetDenied,
 194         CSE_SetDefinitionsSent,
 195         CSE_SetClientReady,
 196         CSE_SudoSuccess,
 197         CSE_SudoLeave,
 198         CSE_Disconnect
 199 };
 200
 201 /*
 202         Used for queueing and sorting block transfers in containers
 203
 204         Lower priority number means higher priority.
 205 */
 206 struct PrioritySortedBlockTransfer
 207 {
 208         PrioritySortedBlockTransfer(float a_priority, const v3s16 &a_pos, session_t a_peer_id)
 209         {
 210                 priority = a_priority;
 211                 pos = a_pos;
 212                 peer_id = a_peer_id;
 213         }
 214         bool operator < (const PrioritySortedBlockTransfer &other) const
 215         {
 216                 return priority < other.priority;
 217         }
 218         float priority;
 219         v3s16 pos;
 220         session_t peer_id;
 221 };
 222
 223 class RemoteClient
 224 {
 225 public:
 226         // peer_id=0 means this client has no associated peer
 227         // NOTE: If client is made allowed to exist while peer doesn't,
 228         //       this has to be set to 0 when there is no peer.
 229         //       Also, the client must be moved to some other container.
 230         session_t peer_id = PEER_ID_INEXISTENT;
 231         // The serialization version to use with the client
 232         u8 serialization_version = SER_FMT_VER_INVALID;
 233         //
 234         u16 net_proto_version = 0;
 235
 236         /* Authentication information */
 237         std::string enc_pwd = "";
 238         bool create_player_on_auth_success = false;
 239         AuthMechanism chosen_mech  = AUTH_MECHANISM_NONE;
 240         void *auth_data = nullptr;
 241         u32 allowed_auth_mechs = 0;
 242         u32 allowed_sudo_mechs = 0;
 243
 244         bool isSudoMechAllowed(AuthMechanism mech)
 245         { return allowed_sudo_mechs & mech; }
 246         bool isMechAllowed(AuthMechanism mech)
 247         { return allowed_auth_mechs & mech; }
 248
 249         RemoteClient() = default;
 250         ~RemoteClient() = default;
 251
 252         /*
 253                 Finds block that should be sent next to the client.
 254                 Environment should be locked when this is called.
 255                 dtime is used for resetting send radius at slow interval
 256         */
 257         void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
 258                         float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
 259
 260         void GotBlock(v3s16 p);
 261
 262         void SentBlock(v3s16 p);
 263
 264         void SetBlockNotSent(v3s16 p);
 265         void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
 266
 267         /**
 268          * tell client about this block being modified right now.
 269          * this information is required to requeue the block in case it's "on wire"
 270          * while modification is processed by server
 271          * @param p position of modified block
 272          */
 273         void ResendBlockIfOnWire(v3s16 p);
 274
 275         u32 getSendingCount() const { return m_blocks_sending.size(); }
 276
 277         // Increments timeouts and removes timed-out blocks from list
 278         // NOTE: This doesn't fix the server-not-sending-block bug
 279         //       because it is related to emerging, not sending.
 280         //void RunSendingTimeouts(float dtime, float timeout);
 281
 282         void PrintInfo(std::ostream &o)
 283         {
 284                 o<<"RemoteClient "<<peer_id<<": "
 285                                 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
 286                                 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
 287                                 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
 288                                 <<", m_excess_gotblocks="<<m_excess_gotblocks
 289                                 <<std::endl;
 290                 m_excess_gotblocks = 0;
 291         }
 292
 293         // Time from last placing or removing blocks
 294         float m_time_from_building = 9999;
 295
 296         /*
 297                 List of active objects that the client knows of.
 298         */
 299         std::set<u16> m_known_objects;
 300
 301         ClientState getState() const { return m_state; }
 302
 303         std::string getName() const { return m_name; }
 304
 305         void setName(const std::string &name) { m_name = name; }
 306
 307         /* update internal client state */
 308         void notifyEvent(ClientStateEvent event);
 309
 310         /* set expected serialization version */
 311         void setPendingSerializationVersion(u8 version)
 312                 { m_pending_serialization_version = version; }
 313
 314         void setDeployedCompressionMode(u16 byteFlag)
 315                 { m_deployed_compression = byteFlag; }
 316
 317         void confirmSerializationVersion()
 318                 { serialization_version = m_pending_serialization_version; }
 319
 320         /* get uptime */
 321         u64 uptime() const;
 322
 323         /* set version information */
 324         void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
 325         {
 326                 m_version_major = major;
 327                 m_version_minor = minor;
 328                 m_version_patch = patch;
 329                 m_full_version = full;
 330         }
 331
 332         /* read version information */
 333         u8 getMajor() const { return m_version_major; }
 334         u8 getMinor() const { return m_version_minor; }
 335         u8 getPatch() const { return m_version_patch; }
 336 private:
 337         // Version is stored in here after INIT before INIT2
 338         u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
 339
 340         /* current state of client */
 341         ClientState m_state = CS_Created;
 342
 343         /*
 344                 Blocks that have been sent to client.
 345                 - These don't have to be sent again.
 346                 - A block is cleared from here when client says it has
 347                   deleted it from it's memory
 348
 349                 List of block positions.
 350                 No MapBlock* is stored here because the blocks can get deleted.
 351         */
 352         std::set<v3s16> m_blocks_sent;
 353         s16 m_nearest_unsent_d = 0;
 354         v3s16 m_last_center;
 355         float m_nearest_unsent_reset_timer = 0.0f;
 356
 357         /*
 358                 Blocks that are currently on the line.
 359                 This is used for throttling the sending of blocks.
 360                 - The size of this list is limited to some value
 361                 Block is added when it is sent with BLOCKDATA.
 362                 Block is removed when GOTBLOCKS is received.
 363                 Value is time from sending. (not used at the moment)
 364         */
 365         std::map<v3s16, float> m_blocks_sending;
 366
 367         /*
 368                 Blocks that have been modified since last sending them.
 369                 These blocks will not be marked as sent, even if the
 370                 client reports it has received them to account for blocks
 371                 that are being modified while on the line.
 372
 373                 List of block positions.
 374         */
 375         std::set<v3s16> m_blocks_modified;
 376
 377         /*
 378                 Count of excess GotBlocks().
 379                 There is an excess amount because the client sometimes
 380                 gets a block so late that the server sends it again,
 381                 and the client then sends two GOTBLOCKs.
 382                 This is resetted by PrintInfo()
 383         */
 384         u32 m_excess_gotblocks = 0;
 385
 386         // CPU usage optimization
 387         float m_nothing_to_send_pause_timer = 0.0f;
 388
 389         /*
 390                 name of player using this client
 391         */
 392         std::string m_name = "";
 393
 394         /*
 395                 client information
 396          */
 397         u8 m_version_major = 0;
 398         u8 m_version_minor = 0;
 399         u8 m_version_patch = 0;
 400
 401         std::string m_full_version = "unknown";
 402
 403         u16 m_deployed_compression = 0;
 404
 405         /*
 406                 time this client was created
 407          */
 408         const u64 m_connection_time = porting::getTimeS();
 409 };
 410
 411 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
 412
 413 class ClientInterface {
 414 public:
 415
 416         friend class Server;
 417
 418         ClientInterface(const std::shared_ptr<con::Connection> &con);
 419         ~ClientInterface();
 420
 421         /* run sync step */
 422         void step(float dtime);
 423
 424         /* get list of active client id's */
 425         std::vector<session_t> getClientIDs(ClientState min_state=CS_Active);
 426
 427         /* verify is server user limit was reached */
 428         bool isUserLimitReached();
 429
 430         /* get list of client player names */
 431         const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
 432
 433         /* send message to client */
 434         void send(session_t peer_id, u8 channelnum, NetworkPacket *pkt, bool reliable);
 435
 436         /* send to all clients */
 437         void sendToAll(NetworkPacket *pkt);
 438         void sendToAllCompat(NetworkPacket *pkt, NetworkPacket *legacypkt, u16 min_proto_ver);
 439
 440         /* delete a client */
 441         void DeleteClient(session_t peer_id);
 442
 443         /* create client */
 444         void CreateClient(session_t peer_id);
 445
 446         /* get a client by peer_id */
 447         RemoteClient *getClientNoEx(session_t peer_id,  ClientState state_min = CS_Active);
 448
 449         /* get client by peer_id (make sure you have list lock before!*/
 450         RemoteClient *lockedGetClientNoEx(session_t peer_id,  ClientState state_min = CS_Active);
 451
 452         /* get state of client by id*/
 453         ClientState getClientState(session_t peer_id);
 454
 455         /* set client playername */
 456         void setPlayerName(session_t peer_id, const std::string &name);
 457
 458         /* get protocol version of client */
 459         u16 getProtocolVersion(session_t peer_id);
 460
 461         /* set client version */
 462         void setClientVersion(session_t peer_id, u8 major, u8 minor, u8 patch,
 463                         const std::string &full);
 464
 465         /* event to update client state */
 466         void event(session_t peer_id, ClientStateEvent event);
 467
 468         /* Set environment. Do not call this function if environment is already set */
 469         void setEnv(ServerEnvironment *env)
 470         {
 471                 assert(m_env == NULL); // pre-condition
 472                 m_env = env;
 473         }
 474
 475         static std::string state2Name(ClientState state);
 476 protected:
 477         //TODO find way to avoid this functions
 478         void lock() { m_clients_mutex.lock(); }
 479         void unlock() { m_clients_mutex.unlock(); }
 480
 481         RemoteClientMap& getClientList() { return m_clients; }
 482
 483 private:
 484         /* update internal player list */
 485         void UpdatePlayerList();
 486
 487         // Connection
 488         std::shared_ptr<con::Connection> m_con;
 489         std::mutex m_clients_mutex;
 490         // Connected clients (behind the con mutex)
 491         RemoteClientMap m_clients;
 492         std::vector<std::string> m_clients_names; //for announcing masterserver
 493
 494         // Environment
 495         ServerEnvironment *m_env;
 496
 497         float m_print_info_timer;
 498
 499         static const char *statenames[];
 500 };