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 #ifndef _CLIENTIFACE_H_
  20 #define _CLIENTIFACE_H_
  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 "threading/mutex.h"
  27 #include "network/networkpacket.h"
  28 #include "util/cpp11_container.h"
  29 #include "porting.h"
  30
  31 #include <list>
  32 #include <vector>
  33 #include <set>
  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, 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;
 231         // The serialization version to use with the client
 232         u8 serialization_version;
 233         //
 234         u16 net_proto_version;
 235
 236         /* Authentication information */
 237         std::string enc_pwd;
 238         bool create_player_on_auth_success;
 239         AuthMechanism chosen_mech;
 240         void * auth_data;
 241         u32 allowed_auth_mechs;
 242         u32 allowed_sudo_mechs;
 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():
 250                 peer_id(PEER_ID_INEXISTENT),
 251                 serialization_version(SER_FMT_VER_INVALID),
 252                 net_proto_version(0),
 253                 create_player_on_auth_success(false),
 254                 chosen_mech(AUTH_MECHANISM_NONE),
 255                 auth_data(NULL),
 256                 m_time_from_building(9999),
 257                 m_pending_serialization_version(SER_FMT_VER_INVALID),
 258                 m_state(CS_Created),
 259                 m_nearest_unsent_d(0),
 260                 m_nearest_unsent_reset_timer(0.0),
 261                 m_excess_gotblocks(0),
 262                 m_nothing_to_send_pause_timer(0.0),
 263                 m_name(""),
 264                 m_version_major(0),
 265                 m_version_minor(0),
 266                 m_version_patch(0),
 267                 m_full_version("unknown"),
 268                 m_deployed_compression(0),
 269                 m_connection_time(porting::getTimeS())
 270         {
 271         }
 272         ~RemoteClient()
 273         {
 274         }
 275
 276         /*
 277                 Finds block that should be sent next to the client.
 278                 Environment should be locked when this is called.
 279                 dtime is used for resetting send radius at slow interval
 280         */
 281         void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
 282                         float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
 283
 284         void GotBlock(v3s16 p);
 285
 286         void SentBlock(v3s16 p);
 287
 288         void SetBlockNotSent(v3s16 p);
 289         void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
 290
 291         /**
 292          * tell client about this block being modified right now.
 293          * this information is required to requeue the block in case it's "on wire"
 294          * while modification is processed by server
 295          * @param p position of modified block
 296          */
 297         void ResendBlockIfOnWire(v3s16 p);
 298
 299         s32 SendingCount()
 300         {
 301                 return m_blocks_sending.size();
 302         }
 303
 304         // Increments timeouts and removes timed-out blocks from list
 305         // NOTE: This doesn't fix the server-not-sending-block bug
 306         //       because it is related to emerging, not sending.
 307         //void RunSendingTimeouts(float dtime, float timeout);
 308
 309         void PrintInfo(std::ostream &o)
 310         {
 311                 o<<"RemoteClient "<<peer_id<<": "
 312                                 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
 313                                 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
 314                                 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
 315                                 <<", m_excess_gotblocks="<<m_excess_gotblocks
 316                                 <<std::endl;
 317                 m_excess_gotblocks = 0;
 318         }
 319
 320         // Time from last placing or removing blocks
 321         float m_time_from_building;
 322
 323         /*
 324                 List of active objects that the client knows of.
 325         */
 326         std::set<u16> m_known_objects;
 327
 328         ClientState getState() const { return m_state; }
 329
 330         std::string getName() const { return m_name; }
 331
 332         void setName(const std::string &name) { m_name = name; }
 333
 334         /* update internal client state */
 335         void notifyEvent(ClientStateEvent event);
 336
 337         /* set expected serialization version */
 338         void setPendingSerializationVersion(u8 version)
 339                 { m_pending_serialization_version = version; }
 340
 341         void setDeployedCompressionMode(u16 byteFlag)
 342                 { m_deployed_compression = byteFlag; }
 343
 344         void confirmSerializationVersion()
 345                 { serialization_version = m_pending_serialization_version; }
 346
 347         /* get uptime */
 348         u64 uptime() const;
 349
 350         /* set version information */
 351         void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
 352         {
 353                 m_version_major = major;
 354                 m_version_minor = minor;
 355                 m_version_patch = patch;
 356                 m_full_version = full;
 357         }
 358
 359         /* read version information */
 360         u8 getMajor() const { return m_version_major; }
 361         u8 getMinor() const { return m_version_minor; }
 362         u8 getPatch() const { return m_version_patch; }
 363 private:
 364         // Version is stored in here after INIT before INIT2
 365         u8 m_pending_serialization_version;
 366
 367         /* current state of client */
 368         ClientState m_state;
 369
 370         /*
 371                 Blocks that have been sent to client.
 372                 - These don't have to be sent again.
 373                 - A block is cleared from here when client says it has
 374                   deleted it from it's memory
 375
 376                 List of block positions.
 377                 No MapBlock* is stored here because the blocks can get deleted.
 378         */
 379         std::set<v3s16> m_blocks_sent;
 380         s16 m_nearest_unsent_d;
 381         v3s16 m_last_center;
 382         float m_nearest_unsent_reset_timer;
 383
 384         /*
 385                 Blocks that are currently on the line.
 386                 This is used for throttling the sending of blocks.
 387                 - The size of this list is limited to some value
 388                 Block is added when it is sent with BLOCKDATA.
 389                 Block is removed when GOTBLOCKS is received.
 390                 Value is time from sending. (not used at the moment)
 391         */
 392         std::map<v3s16, float> m_blocks_sending;
 393
 394         /*
 395                 Blocks that have been modified since last sending them.
 396                 These blocks will not be marked as sent, even if the
 397                 client reports it has received them to account for blocks
 398                 that are being modified while on the line.
 399
 400                 List of block positions.
 401         */
 402         std::set<v3s16> m_blocks_modified;
 403
 404         /*
 405                 Count of excess GotBlocks().
 406                 There is an excess amount because the client sometimes
 407                 gets a block so late that the server sends it again,
 408                 and the client then sends two GOTBLOCKs.
 409                 This is resetted by PrintInfo()
 410         */
 411         u32 m_excess_gotblocks;
 412
 413         // CPU usage optimization
 414         float m_nothing_to_send_pause_timer;
 415
 416         /*
 417                 name of player using this client
 418         */
 419         std::string m_name;
 420
 421         /*
 422                 client information
 423          */
 424         u8 m_version_major;
 425         u8 m_version_minor;
 426         u8 m_version_patch;
 427
 428         std::string m_full_version;
 429
 430         u16 m_deployed_compression;
 431
 432         /*
 433                 time this client was created
 434          */
 435         const u64 m_connection_time;
 436 };
 437
 438 class ClientInterface {
 439 public:
 440
 441         friend class Server;
 442
 443         ClientInterface(con::Connection* con);
 444         ~ClientInterface();
 445
 446         /* run sync step */
 447         void step(float dtime);
 448
 449         /* get list of active client id's */
 450         std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
 451
 452         /* get list of client player names */
 453         const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
 454
 455         /* send message to client */
 456         void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
 457
 458         /* send to all clients */
 459         void sendToAll(NetworkPacket *pkt);
 460
 461         /* delete a client */
 462         void DeleteClient(u16 peer_id);
 463
 464         /* create client */
 465         void CreateClient(u16 peer_id);
 466
 467         /* get a client by peer_id */
 468         RemoteClient* getClientNoEx(u16 peer_id,  ClientState state_min=CS_Active);
 469
 470         /* get client by peer_id (make sure you have list lock before!*/
 471         RemoteClient* lockedGetClientNoEx(u16 peer_id,  ClientState state_min=CS_Active);
 472
 473         /* get state of client by id*/
 474         ClientState getClientState(u16 peer_id);
 475
 476         /* set client playername */
 477         void setPlayerName(u16 peer_id,std::string name);
 478
 479         /* get protocol version of client */
 480         u16 getProtocolVersion(u16 peer_id);
 481
 482         /* set client version */
 483         void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
 484
 485         /* event to update client state */
 486         void event(u16 peer_id, ClientStateEvent event);
 487
 488         /* Set environment. Do not call this function if environment is already set */
 489         void setEnv(ServerEnvironment *env)
 490         {
 491                 assert(m_env == NULL); // pre-condition
 492                 m_env = env;
 493         }
 494
 495         static std::string state2Name(ClientState state);
 496
 497 protected:
 498         //TODO find way to avoid this functions
 499         void lock() { m_clients_mutex.lock(); }
 500         void unlock() { m_clients_mutex.unlock(); }
 501
 502         UNORDERED_MAP<u16, RemoteClient*>& getClientList() { return m_clients; }
 503
 504 private:
 505         /* update internal player list */
 506         void UpdatePlayerList();
 507
 508         // Connection
 509         con::Connection* m_con;
 510         Mutex m_clients_mutex;
 511         // Connected clients (behind the con mutex)
 512         UNORDERED_MAP<u16, RemoteClient*> m_clients;
 513         std::vector<std::string> m_clients_names; //for announcing masterserver
 514
 515         // Environment
 516         ServerEnvironment *m_env;
 517         Mutex m_env_mutex;
 518
 519         float m_print_info_timer;
 520
 521         static const char *statenames[];
 522 };
 523
 524 #endif