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                                      v
  54 +-----------------------------+        +-----------------------------+
  55 |IN:                          |        |IN:                          |
  56 | TOSERVER_INIT_LEGACY        |-----   | TOSERVER_INIT               |      invalid playername,
  57 +-----------------------------+    |   +-----------------------------+  password (for _LEGACY),
  58                |                   |                  |                       or denied by mod
  59                | Auth ok           -------------------+---------------------------------
  60                v                                      v                                |
  61 +-----------------------------+        +-----------------------------+                 |
  62 |OUT:                         |        |OUT:                         |                 |
  63 | TOCLIENT_INIT_LEGACY        |        | TOCLIENT_HELLO              |                 |
  64 +-----------------------------+        +-----------------------------+                 |
  65                |                                      |                                |
  66                |                                      |                                |
  67                v                                      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       \-----------------/             | TOSERVER_RECEIVED_MEDIA     |                  |
 105                |                      +-----------------------------+                  |
 106                |      ^                           |                                    |
 107                |      -----------------------------                                    |
 108                v                                                                       |
 109 +-----------------------------+                        --------------------------------+
 110 |IN:                          |                        |                               |
 111 | TOSERVER_CLIENT_READY       |                        v                               |
 112 +-----------------------------+        +-------------------------------+               |
 113                |                       |OUT:                           |               |
 114                v                       | TOCLIENT_ACCESS_DENIED_LEGAGY |               |
 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, u16 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         u16 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         u16 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         s32 SendingCount()
 276         {
 277                 return m_blocks_sending.size();
 278         }
 279
 280         // Increments timeouts and removes timed-out blocks from list
 281         // NOTE: This doesn't fix the server-not-sending-block bug
 282         //       because it is related to emerging, not sending.
 283         //void RunSendingTimeouts(float dtime, float timeout);
 284
 285         void PrintInfo(std::ostream &o)
 286         {
 287                 o<<"RemoteClient "<<peer_id<<": "
 288                                 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
 289                                 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
 290                                 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
 291                                 <<", m_excess_gotblocks="<<m_excess_gotblocks
 292                                 <<std::endl;
 293                 m_excess_gotblocks = 0;
 294         }
 295
 296         // Time from last placing or removing blocks
 297         float m_time_from_building = 9999;
 298
 299         /*
 300                 List of active objects that the client knows of.
 301         */
 302         std::set<u16> m_known_objects;
 303
 304         ClientState getState() const { return m_state; }
 305
 306         std::string getName() const { return m_name; }
 307
 308         void setName(const std::string &name) { m_name = name; }
 309
 310         /* update internal client state */
 311         void notifyEvent(ClientStateEvent event);
 312
 313         /* set expected serialization version */
 314         void setPendingSerializationVersion(u8 version)
 315                 { m_pending_serialization_version = version; }
 316
 317         void setDeployedCompressionMode(u16 byteFlag)
 318                 { m_deployed_compression = byteFlag; }
 319
 320         void confirmSerializationVersion()
 321                 { serialization_version = m_pending_serialization_version; }
 322
 323         /* get uptime */
 324         u64 uptime() const;
 325
 326         /* set version information */
 327         void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
 328         {
 329                 m_version_major = major;
 330                 m_version_minor = minor;
 331                 m_version_patch = patch;
 332                 m_full_version = full;
 333         }
 334
 335         /* read version information */
 336         u8 getMajor() const { return m_version_major; }
 337         u8 getMinor() const { return m_version_minor; }
 338         u8 getPatch() const { return m_version_patch; }
 339 private:
 340         // Version is stored in here after INIT before INIT2
 341         u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
 342
 343         /* current state of client */
 344         ClientState m_state = CS_Created;
 345
 346         /*
 347                 Blocks that have been sent to client.
 348                 - These don't have to be sent again.
 349                 - A block is cleared from here when client says it has
 350                   deleted it from it's memory
 351
 352                 List of block positions.
 353                 No MapBlock* is stored here because the blocks can get deleted.
 354         */
 355         std::set<v3s16> m_blocks_sent;
 356         s16 m_nearest_unsent_d = 0;
 357         v3s16 m_last_center;
 358         float m_nearest_unsent_reset_timer = 0.0f;
 359
 360         /*
 361                 Blocks that are currently on the line.
 362                 This is used for throttling the sending of blocks.
 363                 - The size of this list is limited to some value
 364                 Block is added when it is sent with BLOCKDATA.
 365                 Block is removed when GOTBLOCKS is received.
 366                 Value is time from sending. (not used at the moment)
 367         */
 368         std::map<v3s16, float> m_blocks_sending;
 369
 370         /*
 371                 Blocks that have been modified since last sending them.
 372                 These blocks will not be marked as sent, even if the
 373                 client reports it has received them to account for blocks
 374                 that are being modified while on the line.
 375
 376                 List of block positions.
 377         */
 378         std::set<v3s16> m_blocks_modified;
 379
 380         /*
 381                 Count of excess GotBlocks().
 382                 There is an excess amount because the client sometimes
 383                 gets a block so late that the server sends it again,
 384                 and the client then sends two GOTBLOCKs.
 385                 This is resetted by PrintInfo()
 386         */
 387         u32 m_excess_gotblocks = 0;
 388
 389         // CPU usage optimization
 390         float m_nothing_to_send_pause_timer = 0.0f;
 391
 392         /*
 393                 name of player using this client
 394         */
 395         std::string m_name = "";
 396
 397         /*
 398                 client information
 399          */
 400         u8 m_version_major = 0;
 401         u8 m_version_minor = 0;
 402         u8 m_version_patch = 0;
 403
 404         std::string m_full_version = "unknown";
 405
 406         u16 m_deployed_compression = 0;
 407
 408         /*
 409                 time this client was created
 410          */
 411         const u64 m_connection_time = porting::getTimeS();
 412 };
 413
 414 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
 415
 416 class ClientInterface {
 417 public:
 418
 419         friend class Server;
 420
 421         ClientInterface(con::Connection* con);
 422         ~ClientInterface();
 423
 424         /* run sync step */
 425         void step(float dtime);
 426
 427         /* get list of active client id's */
 428         std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
 429
 430         /* verify is server user limit was reached */
 431         bool isUserLimitReached();
 432
 433         /* get list of client player names */
 434         const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
 435
 436         /* send message to client */
 437         void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
 438
 439         /* send to all clients */
 440         void sendToAll(NetworkPacket *pkt);
 441         void sendToAllCompat(NetworkPacket *pkt, NetworkPacket *legacypkt, u16 min_proto_ver);
 442
 443         /* delete a client */
 444         void DeleteClient(u16 peer_id);
 445
 446         /* create client */
 447         void CreateClient(u16 peer_id);
 448
 449         /* get a client by peer_id */
 450         RemoteClient* getClientNoEx(u16 peer_id,  ClientState state_min=CS_Active);
 451
 452         /* get client by peer_id (make sure you have list lock before!*/
 453         RemoteClient* lockedGetClientNoEx(u16 peer_id,  ClientState state_min=CS_Active);
 454
 455         /* get state of client by id*/
 456         ClientState getClientState(u16 peer_id);
 457
 458         /* set client playername */
 459         void setPlayerName(u16 peer_id,std::string name);
 460
 461         /* get protocol version of client */
 462         u16 getProtocolVersion(u16 peer_id);
 463
 464         /* set client version */
 465         void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
 466
 467         /* event to update client state */
 468         void event(u16 peer_id, ClientStateEvent event);
 469
 470         /* Set environment. Do not call this function if environment is already set */
 471         void setEnv(ServerEnvironment *env)
 472         {
 473                 assert(m_env == NULL); // pre-condition
 474                 m_env = env;
 475         }
 476
 477         static std::string state2Name(ClientState state);
 478 protected:
 479         //TODO find way to avoid this functions
 480         void lock() { m_clients_mutex.lock(); }
 481         void unlock() { m_clients_mutex.unlock(); }
 482
 483         RemoteClientMap& getClientList() { return m_clients; }
 484
 485 private:
 486         /* update internal player list */
 487         void UpdatePlayerList();
 488
 489         // Connection
 490         con::Connection* m_con;
 491         std::mutex m_clients_mutex;
 492         // Connected clients (behind the con mutex)
 493         RemoteClientMap m_clients;
 494         std::vector<std::string> m_clients_names; //for announcing masterserver
 495
 496         // Environment
 497         ServerEnvironment *m_env;
 498
 499         float m_print_info_timer;
 500
 501         static const char *statenames[];
 502 };