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.
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 +-----------------------------+
57 +-----------------------------+
61 +-----------------------------+
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 \-----------------/ | | |
105 | +-----------------------------+ |
107 | ----------------------------- |
109 +-----------------------------+ --------------------------------+
111 | TOSERVER_CLIENT_READY | v |
112 +-----------------------------+ +------------------------+ |
114 v | TOCLIENT_ACCESS_DENIED | |
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, const v3s16 &a_pos, session_t 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 session_t 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; }
250 ~RemoteClient() = default;
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);
275 u32 getSendingCount() const { return m_blocks_sending.size(); }
277 bool isBlockSent(v3s16 p) const
279 return m_blocks_sent.find(p) != m_blocks_sent.end();
282 // Increments timeouts and removes timed-out blocks from list
283 // NOTE: This doesn't fix the server-not-sending-block bug
284 // because it is related to emerging, not sending.
285 //void RunSendingTimeouts(float dtime, float timeout);
287 void PrintInfo(std::ostream &o)
289 o<<"RemoteClient "<<peer_id<<": "
290 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
291 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
292 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
293 <<", m_excess_gotblocks="<<m_excess_gotblocks
295 m_excess_gotblocks = 0;
298 // Time from last placing or removing blocks
299 float m_time_from_building = 9999;
302 List of active objects that the client knows of.
304 std::set<u16> m_known_objects;
306 ClientState getState() const { return m_state; }
308 std::string getName() const { return m_name; }
310 void setName(const std::string &name) { m_name = name; }
312 /* update internal client state */
313 void notifyEvent(ClientStateEvent event);
315 /* set expected serialization version */
316 void setPendingSerializationVersion(u8 version)
317 { m_pending_serialization_version = version; }
319 void setDeployedCompressionMode(u16 byteFlag)
320 { m_deployed_compression = byteFlag; }
322 void confirmSerializationVersion()
323 { serialization_version = m_pending_serialization_version; }
328 /* set version information */
329 void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
331 m_version_major = major;
332 m_version_minor = minor;
333 m_version_patch = patch;
334 m_full_version = full;
337 /* read version information */
338 u8 getMajor() const { return m_version_major; }
339 u8 getMinor() const { return m_version_minor; }
340 u8 getPatch() const { return m_version_patch; }
341 const std::string &getFull() const { return m_full_version; }
343 // Version is stored in here after INIT before INIT2
344 u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
346 /* current state of client */
347 ClientState m_state = CS_Created;
350 Blocks that have been sent to client.
351 - These don't have to be sent again.
352 - A block is cleared from here when client says it has
353 deleted it from it's memory
355 List of block positions.
356 No MapBlock* is stored here because the blocks can get deleted.
358 std::set<v3s16> m_blocks_sent;
359 s16 m_nearest_unsent_d = 0;
361 float m_nearest_unsent_reset_timer = 0.0f;
363 const u16 m_max_simul_sends;
364 const float m_min_time_from_building;
365 const s16 m_max_send_distance;
366 const s16 m_block_optimize_distance;
367 const s16 m_max_gen_distance;
368 const bool m_occ_cull;
371 Blocks that are currently on the line.
372 This is used for throttling the sending of blocks.
373 - The size of this list is limited to some value
374 Block is added when it is sent with BLOCKDATA.
375 Block is removed when GOTBLOCKS is received.
376 Value is time from sending. (not used at the moment)
378 std::map<v3s16, float> m_blocks_sending;
381 Blocks that have been modified since last sending them.
382 These blocks will not be marked as sent, even if the
383 client reports it has received them to account for blocks
384 that are being modified while on the line.
386 List of block positions.
388 std::set<v3s16> m_blocks_modified;
391 Count of excess GotBlocks().
392 There is an excess amount because the client sometimes
393 gets a block so late that the server sends it again,
394 and the client then sends two GOTBLOCKs.
395 This is resetted by PrintInfo()
397 u32 m_excess_gotblocks = 0;
399 // CPU usage optimization
400 float m_nothing_to_send_pause_timer = 0.0f;
403 name of player using this client
405 std::string m_name = "";
410 u8 m_version_major = 0;
411 u8 m_version_minor = 0;
412 u8 m_version_patch = 0;
414 std::string m_full_version = "unknown";
416 u16 m_deployed_compression = 0;
419 time this client was created
421 const u64 m_connection_time = porting::getTimeS();
424 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
426 class ClientInterface {
431 ClientInterface(const std::shared_ptr<con::Connection> &con);
435 void step(float dtime);
437 /* get list of active client id's */
438 std::vector<session_t> getClientIDs(ClientState min_state=CS_Active);
440 /* mark block as not sent to active client sessions */
441 void markBlockposAsNotSent(const v3s16 &pos);
443 /* verify is server user limit was reached */
444 bool isUserLimitReached();
446 /* get list of client player names */
447 const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
449 /* send message to client */
450 void send(session_t peer_id, u8 channelnum, NetworkPacket *pkt, bool reliable);
452 /* send to all clients */
453 void sendToAll(NetworkPacket *pkt);
454 void sendToAllCompat(NetworkPacket *pkt, NetworkPacket *legacypkt, u16 min_proto_ver);
456 /* delete a client */
457 void DeleteClient(session_t peer_id);
460 void CreateClient(session_t peer_id);
462 /* get a client by peer_id */
463 RemoteClient *getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
465 /* get client by peer_id (make sure you have list lock before!*/
466 RemoteClient *lockedGetClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
468 /* get state of client by id*/
469 ClientState getClientState(session_t peer_id);
471 /* set client playername */
472 void setPlayerName(session_t peer_id, const std::string &name);
474 /* get protocol version of client */
475 u16 getProtocolVersion(session_t peer_id);
477 /* set client version */
478 void setClientVersion(session_t peer_id, u8 major, u8 minor, u8 patch,
479 const std::string &full);
481 /* event to update client state */
482 void event(session_t peer_id, ClientStateEvent event);
484 /* Set environment. Do not call this function if environment is already set */
485 void setEnv(ServerEnvironment *env)
487 assert(m_env == NULL); // pre-condition
491 static std::string state2Name(ClientState state);
493 //TODO find way to avoid this functions
494 void lock() { m_clients_mutex.lock(); }
495 void unlock() { m_clients_mutex.unlock(); }
497 RemoteClientMap& getClientList() { return m_clients; }
500 /* update internal player list */
501 void UpdatePlayerList();
504 std::shared_ptr<con::Connection> m_con;
505 std::recursive_mutex m_clients_mutex;
506 // Connected clients (behind the con mutex)
507 RemoteClientMap m_clients;
508 std::vector<std::string> m_clients_names; //for announcing masterserver
511 ServerEnvironment *m_env;
513 float m_print_info_timer;
515 static const char *statenames[];