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