3 Copyright (C) 2010-2014 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
19 #ifndef _CLIENTIFACE_H_
20 #define _CLIENTIFACE_H_
22 #include "irr_v3d.h" // for irrlicht datatypes
24 #include "constants.h"
25 #include "serialization.h" // for SER_FMT_VER_INVALID
26 #include "network/networkpacket.h"
27 #include "network/networkprotocol.h"
36 class ServerEnvironment;
51 | depending of the incoming packet
52 +---------------------------------------
54 +-----------------------------+ +-----------------------------+
56 | TOSERVER_INIT_LEGACY |----- | TOSERVER_INIT | invalid playername,
57 +-----------------------------+ | +-----------------------------+ password (for _LEGACY),
58 | | | or denied by mod
59 | Auth ok -------------------+---------------------------------
61 +-----------------------------+ +-----------------------------+ |
63 | TOCLIENT_INIT_LEGACY | | TOCLIENT_HELLO | |
64 +-----------------------------+ +-----------------------------+ |
68 /-----------------\ /-----------------\ |
70 | AwaitingInit2 |<--------- | HelloSent | |
72 \-----------------/ | \-----------------/ |
74 +-----------------------------+ | *-----------------------------* Auth fails |
75 |IN: | | |Authentication, depending on |-----------------+
76 | TOSERVER_INIT2 | | | packet sent by client | |
77 +-----------------------------+ | *-----------------------------* |
79 | | | Authentication |
81 /-----------------\ | v |
82 | | | +-----------------------------+ |
83 | InitDone | | |OUT: | |
84 | | | | TOCLIENT_AUTH_ACCEPT | |
85 \-----------------/ | +-----------------------------+ |
87 +-----------------------------+ --------------------- |
89 | TOCLIENT_MOVEMENT | |
90 | TOCLIENT_ITEMDEF | |
91 | TOCLIENT_NODEDEF | |
92 | TOCLIENT_ANNOUNCE_MEDIA | |
93 | TOCLIENT_DETACHED_INVENTORY | |
94 | TOCLIENT_TIME_OF_DAY | |
95 +-----------------------------+ |
98 | ----------------------------- |
100 /-----------------\ v |
101 | | +-----------------------------+ |
102 | DefinitionsSent | |IN: | |
103 | | | TOSERVER_REQUEST_MEDIA | |
104 \-----------------/ | TOSERVER_RECEIVED_MEDIA | |
105 | +-----------------------------+ |
107 | ----------------------------- |
109 +-----------------------------+ --------------------------------+
111 | TOSERVER_CLIENT_READY | v |
112 +-----------------------------+ +-------------------------------+ |
114 v | TOCLIENT_ACCESS_DENIED_LEGAGY | |
115 +-----------------------------+ +-------------------------------+ |
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 +-----------------------------+ |
128 /-----------------\ async mod action (ban, kick) |
129 | |---------------------------------------------------------------
131 | | |----------------------------------------------
132 | \-----------------/ timeout v
133 | | | +-----------------------------+
135 | | | | TOCLIENT_DISCONNECT |
136 | | | +-----------------------------+
139 | | +-----------------------------+ /-----------------\
141 | | | TOSERVER_DISCONNECT |------------------->| Disconnecting |
142 | | +-----------------------------+ | |
143 | | \-----------------/
144 | | any auth packet which was
145 | | allowed in TOCLIENT_AUTH_ACCEPT
147 | *-----------------------------* Auth +-------------------------------+
148 | |Authentication, depending on | succeeds |OUT: |
149 | | packet sent by client |---------->| TOCLIENT_ACCEPT_SUDO_MODE |
150 | *-----------------------------* +-------------------------------+
152 | | Auth fails /-----------------\
154 | +-------------------------------+ | SudoMode |
156 | | TOCLIENT_DENY_SUDO_MODE | \-----------------/
157 | +-------------------------------+ |
159 | | +-----------------------------+
160 | | sets password accordingly |IN: |
161 -------------------+-------------------------------| TOSERVER_FIRST_SRP |
162 +-----------------------------+
170 // Also make sure to update the ClientInterface::statenames
171 // array when modifying these enums
187 enum ClientStateEvent
194 CSE_SetDefinitionsSent,
202 Used for queueing and sorting block transfers in containers
204 Lower priority number means higher priority.
206 struct PrioritySortedBlockTransfer
208 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
210 priority = a_priority;
214 bool operator < (const PrioritySortedBlockTransfer &other) const
216 return priority < other.priority;
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;
234 u16 net_proto_version = 0;
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;
244 bool isSudoMechAllowed(AuthMechanism mech)
245 { return allowed_sudo_mechs & mech; }
246 bool isMechAllowed(AuthMechanism mech)
247 { return allowed_auth_mechs & mech; }
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
257 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
258 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
260 void GotBlock(v3s16 p);
262 void SentBlock(v3s16 p);
264 void SetBlockNotSent(v3s16 p);
265 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
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
273 void ResendBlockIfOnWire(v3s16 p);
277 return m_blocks_sending.size();
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);
285 void PrintInfo(std::ostream &o)
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
293 m_excess_gotblocks = 0;
296 // Time from last placing or removing blocks
297 float m_time_from_building = 9999;
300 List of active objects that the client knows of.
302 std::set<u16> m_known_objects;
304 ClientState getState() const { return m_state; }
306 std::string getName() const { return m_name; }
308 void setName(const std::string &name) { m_name = name; }
310 /* update internal client state */
311 void notifyEvent(ClientStateEvent event);
313 /* set expected serialization version */
314 void setPendingSerializationVersion(u8 version)
315 { m_pending_serialization_version = version; }
317 void setDeployedCompressionMode(u16 byteFlag)
318 { m_deployed_compression = byteFlag; }
320 void confirmSerializationVersion()
321 { serialization_version = m_pending_serialization_version; }
326 /* set version information */
327 void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
329 m_version_major = major;
330 m_version_minor = minor;
331 m_version_patch = patch;
332 m_full_version = full;
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; }
340 // Version is stored in here after INIT before INIT2
341 u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
343 /* current state of client */
344 ClientState m_state = CS_Created;
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
352 List of block positions.
353 No MapBlock* is stored here because the blocks can get deleted.
355 std::set<v3s16> m_blocks_sent;
356 s16 m_nearest_unsent_d = 0;
358 float m_nearest_unsent_reset_timer = 0.0f;
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)
368 std::map<v3s16, float> m_blocks_sending;
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.
376 List of block positions.
378 std::set<v3s16> m_blocks_modified;
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()
387 u32 m_excess_gotblocks = 0;
389 // CPU usage optimization
390 float m_nothing_to_send_pause_timer = 0.0f;
393 name of player using this client
395 std::string m_name = "";
400 u8 m_version_major = 0;
401 u8 m_version_minor = 0;
402 u8 m_version_patch = 0;
404 std::string m_full_version = "unknown";
406 u16 m_deployed_compression = 0;
409 time this client was created
411 const u64 m_connection_time = porting::getTimeS();
414 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
416 class ClientInterface {
421 ClientInterface(con::Connection* con);
425 void step(float dtime);
427 /* get list of active client id's */
428 std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
430 /* get list of client player names */
431 const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
433 /* send message to client */
434 void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
436 /* send to all clients */
437 void sendToAll(NetworkPacket *pkt);
438 void sendToAllCompat(NetworkPacket *pkt, NetworkPacket *legacypkt, u16 min_proto_ver);
440 /* delete a client */
441 void DeleteClient(u16 peer_id);
444 void CreateClient(u16 peer_id);
446 /* get a client by peer_id */
447 RemoteClient* getClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
449 /* get client by peer_id (make sure you have list lock before!*/
450 RemoteClient* lockedGetClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
452 /* get state of client by id*/
453 ClientState getClientState(u16 peer_id);
455 /* set client playername */
456 void setPlayerName(u16 peer_id,std::string name);
458 /* get protocol version of client */
459 u16 getProtocolVersion(u16 peer_id);
461 /* set client version */
462 void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
464 /* event to update client state */
465 void event(u16 peer_id, ClientStateEvent event);
467 /* Set environment. Do not call this function if environment is already set */
468 void setEnv(ServerEnvironment *env)
470 assert(m_env == NULL); // pre-condition
474 static std::string state2Name(ClientState state);
477 //TODO find way to avoid this functions
478 void lock() { m_clients_mutex.lock(); }
479 void unlock() { m_clients_mutex.unlock(); }
481 RemoteClientMap& getClientList() { return m_clients; }
484 /* update internal player list */
485 void UpdatePlayerList();
488 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
495 ServerEnvironment *m_env;
496 std::mutex m_env_mutex;
498 float m_print_info_timer;
500 static const char *statenames[];