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"
28 #include "network/address.h"
30 #include "threading/mutex_auto_lock.h"
39 class ServerEnvironment;
54 | depending of the incoming packet
55 ----------------------------------------
57 +-----------------------------+
60 +-----------------------------+
64 +-----------------------------+
67 +-----------------------------+
71 /-----------------\ /-----------------\
73 | AwaitingInit2 |<--------- | HelloSent |
75 \-----------------/ | \-----------------/
77 +-----------------------------+ | *-----------------------------* Auth fails
78 |IN: | | |Authentication, depending on |------------------
79 | TOSERVER_INIT2 | | | packet sent by client | |
80 +-----------------------------+ | *-----------------------------* |
82 | | | Authentication |
84 /-----------------\ | v |
85 | | | +-----------------------------+ |
86 | InitDone | | |OUT: | |
87 | | | | TOCLIENT_AUTH_ACCEPT | |
88 \-----------------/ | +-----------------------------+ |
90 +-----------------------------+ --------------------- |
92 | TOCLIENT_MOVEMENT | |
93 | TOCLIENT_ITEMDEF | |
94 | TOCLIENT_NODEDEF | |
95 | TOCLIENT_ANNOUNCE_MEDIA | |
96 | TOCLIENT_DETACHED_INVENTORY | |
97 | TOCLIENT_TIME_OF_DAY | |
98 +-----------------------------+ |
101 | ----------------------------- |
103 /-----------------\ v |
104 | | +-----------------------------+ |
105 | DefinitionsSent | |IN: | |
106 | | | TOSERVER_REQUEST_MEDIA | |
107 \-----------------/ | | |
108 | +-----------------------------+ |
110 | ----------------------------- |
112 +-----------------------------+ --------------------------------+
114 | TOSERVER_CLIENT_READY | v |
115 +-----------------------------+ +------------------------+ |
117 v | TOCLIENT_ACCESS_DENIED | |
118 +-----------------------------+ +------------------------+ |
120 | TOCLIENT_MOVE_PLAYER | v |
121 | TOCLIENT_PRIVILEGES | /-----------------\ |
122 | TOCLIENT_INVENTORY_FORMSPEC | | | |
123 | UpdateCrafting | | Denied | |
124 | TOCLIENT_INVENTORY | | | |
125 | TOCLIENT_HP (opt) | \-----------------/ |
126 | TOCLIENT_BREATH | |
127 | TOCLIENT_DEATHSCREEN | |
128 +-----------------------------+ |
131 /-----------------\ async mod action (ban, kick) |
132 | |---------------------------------------------------------------
134 | | |----------------------------------------------
135 | \-----------------/ timeout v
136 | | | +-----------------------------+
138 | | | | TOCLIENT_DISCONNECT |
139 | | | +-----------------------------+
142 | | +-----------------------------+ /-----------------\
144 | | | TOSERVER_DISCONNECT |------------------->| Disconnecting |
145 | | +-----------------------------+ | |
146 | | \-----------------/
147 | | any auth packet which was
148 | | allowed in TOCLIENT_AUTH_ACCEPT
150 | *-----------------------------* Auth +-------------------------------+
151 | |Authentication, depending on | succeeds |OUT: |
152 | | packet sent by client |---------->| TOCLIENT_ACCEPT_SUDO_MODE |
153 | *-----------------------------* +-------------------------------+
155 | | Auth fails /-----------------\
157 | +-------------------------------+ | SudoMode |
159 | | TOCLIENT_DENY_SUDO_MODE | \-----------------/
160 | +-------------------------------+ |
162 | | +-----------------------------+
163 | | sets password accordingly |IN: |
164 -------------------+-------------------------------| TOSERVER_FIRST_SRP |
165 +-----------------------------+
173 // Also make sure to update the ClientInterface::statenames
174 // array when modifying these enums
190 enum ClientStateEvent
196 CSE_SetDefinitionsSent,
204 Used for queueing and sorting block transfers in containers
206 Lower priority number means higher priority.
208 struct PrioritySortedBlockTransfer
210 PrioritySortedBlockTransfer(float a_priority, const v3s16 &a_pos, session_t a_peer_id)
212 priority = a_priority;
216 bool operator < (const PrioritySortedBlockTransfer &other) const
218 return priority < other.priority;
228 // peer_id=0 means this client has no associated peer
229 // NOTE: If client is made allowed to exist while peer doesn't,
230 // this has to be set to 0 when there is no peer.
231 // Also, the client must be moved to some other container.
232 session_t peer_id = PEER_ID_INEXISTENT;
233 // The serialization version to use with the client
234 u8 serialization_version = SER_FMT_VER_INVALID;
236 u16 net_proto_version = 0;
238 /* Authentication information */
239 std::string enc_pwd = "";
240 bool create_player_on_auth_success = false;
241 AuthMechanism chosen_mech = AUTH_MECHANISM_NONE;
242 void *auth_data = nullptr;
243 u32 allowed_auth_mechs = 0;
244 u32 allowed_sudo_mechs = 0;
246 void resetChosenMech();
248 bool isSudoMechAllowed(AuthMechanism mech)
249 { return allowed_sudo_mechs & mech; }
250 bool isMechAllowed(AuthMechanism mech)
251 { return allowed_auth_mechs & mech; }
254 ~RemoteClient() = default;
257 Finds block that should be sent next to the client.
258 Environment should be locked when this is called.
259 dtime is used for resetting send radius at slow interval
261 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
262 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
264 void GotBlock(v3s16 p);
266 void SentBlock(v3s16 p);
268 void SetBlockNotSent(v3s16 p);
269 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
272 * tell client about this block being modified right now.
273 * this information is required to requeue the block in case it's "on wire"
274 * while modification is processed by server
275 * @param p position of modified block
277 void ResendBlockIfOnWire(v3s16 p);
279 u32 getSendingCount() const { return m_blocks_sending.size(); }
281 bool isBlockSent(v3s16 p) const
283 return m_blocks_sent.find(p) != m_blocks_sent.end();
286 // Increments timeouts and removes timed-out blocks from list
287 // NOTE: This doesn't fix the server-not-sending-block bug
288 // because it is related to emerging, not sending.
289 //void RunSendingTimeouts(float dtime, float timeout);
291 void PrintInfo(std::ostream &o)
293 o<<"RemoteClient "<<peer_id<<": "
294 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
295 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
296 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
297 <<", m_excess_gotblocks="<<m_excess_gotblocks
299 m_excess_gotblocks = 0;
302 // Time from last placing or removing blocks
303 float m_time_from_building = 9999;
306 List of active objects that the client knows of.
308 std::set<u16> m_known_objects;
310 ClientState getState() const { return m_state; }
312 std::string getName() const { return m_name; }
314 void setName(const std::string &name) { m_name = name; }
316 /* update internal client state */
317 void notifyEvent(ClientStateEvent event);
319 /* set expected serialization version */
320 void setPendingSerializationVersion(u8 version)
321 { m_pending_serialization_version = version; }
323 void setDeployedCompressionMode(u16 byteFlag)
324 { m_deployed_compression = byteFlag; }
326 void confirmSerializationVersion()
327 { serialization_version = m_pending_serialization_version; }
332 /* set version information */
333 void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
335 m_version_major = major;
336 m_version_minor = minor;
337 m_version_patch = patch;
338 m_full_version = full;
341 /* read version information */
342 u8 getMajor() const { return m_version_major; }
343 u8 getMinor() const { return m_version_minor; }
344 u8 getPatch() const { return m_version_patch; }
345 const std::string &getFullVer() const { return m_full_version; }
347 void setLangCode(const std::string &code) { m_lang_code = code; }
348 const std::string &getLangCode() const { return m_lang_code; }
350 void setCachedAddress(const Address &addr) { m_addr = addr; }
351 const Address &getAddress() const { return m_addr; }
354 // Version is stored in here after INIT before INIT2
355 u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
357 /* current state of client */
358 ClientState m_state = CS_Created;
360 // Cached here so retrieval doesn't have to go to connection API
363 // Client sent language code
364 std::string m_lang_code;
367 Blocks that have been sent to client.
368 - These don't have to be sent again.
369 - A block is cleared from here when client says it has
370 deleted it from it's memory
372 List of block positions.
373 No MapBlock* is stored here because the blocks can get deleted.
375 std::set<v3s16> m_blocks_sent;
376 s16 m_nearest_unsent_d = 0;
378 v3f m_last_camera_dir;
380 const u16 m_max_simul_sends;
381 const float m_min_time_from_building;
382 const s16 m_max_send_distance;
383 const s16 m_block_optimize_distance;
384 const s16 m_max_gen_distance;
385 const bool m_occ_cull;
388 Blocks that are currently on the line.
389 This is used for throttling the sending of blocks.
390 - The size of this list is limited to some value
391 Block is added when it is sent with BLOCKDATA.
392 Block is removed when GOTBLOCKS is received.
393 Value is time from sending. (not used at the moment)
395 std::map<v3s16, float> m_blocks_sending;
398 Blocks that have been modified since blocks were
399 sent to the client last (getNextBlocks()).
400 This is used to reset the unsent distance, so that
401 modified blocks are resent to the client.
403 List of block positions.
405 std::set<v3s16> m_blocks_modified;
408 Count of excess GotBlocks().
409 There is an excess amount because the client sometimes
410 gets a block so late that the server sends it again,
411 and the client then sends two GOTBLOCKs.
412 This is resetted by PrintInfo()
414 u32 m_excess_gotblocks = 0;
416 // CPU usage optimization
417 float m_nothing_to_send_pause_timer = 0.0f;
420 name of player using this client
422 std::string m_name = "";
427 u8 m_version_major = 0;
428 u8 m_version_minor = 0;
429 u8 m_version_patch = 0;
431 std::string m_full_version = "unknown";
433 u16 m_deployed_compression = 0;
436 time this client was created
438 const u64 m_connection_time = porting::getTimeS();
441 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
443 class ClientInterface {
448 ClientInterface(const std::shared_ptr<con::Connection> &con);
452 void step(float dtime);
454 /* get list of active client id's */
455 std::vector<session_t> getClientIDs(ClientState min_state=CS_Active);
457 /* mark block as not sent to active client sessions */
458 void markBlockposAsNotSent(const v3s16 &pos);
460 /* verify is server user limit was reached */
461 bool isUserLimitReached();
463 /* get list of client player names */
464 const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
466 /* send message to client */
467 void send(session_t peer_id, u8 channelnum, NetworkPacket *pkt, bool reliable);
469 /* send to all clients */
470 void sendToAll(NetworkPacket *pkt);
472 /* delete a client */
473 void DeleteClient(session_t peer_id);
476 void CreateClient(session_t peer_id);
478 /* get a client by peer_id */
479 RemoteClient *getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
481 /* get client by peer_id (make sure you have list lock before!*/
482 RemoteClient *lockedGetClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
484 /* get state of client by id*/
485 ClientState getClientState(session_t peer_id);
487 /* set client playername */
488 void setPlayerName(session_t peer_id, const std::string &name);
490 /* get protocol version of client */
491 u16 getProtocolVersion(session_t peer_id);
493 /* set client version */
494 void setClientVersion(session_t peer_id, u8 major, u8 minor, u8 patch,
495 const std::string &full);
497 /* event to update client state */
498 void event(session_t peer_id, ClientStateEvent event);
500 /* Set environment. Do not call this function if environment is already set */
501 void setEnv(ServerEnvironment *env)
503 assert(m_env == NULL); // pre-condition
507 static std::string state2Name(ClientState state);
511 AutoLock(ClientInterface &iface): m_lock(iface.m_clients_mutex) {}
514 RecursiveMutexAutoLock m_lock;
517 RemoteClientMap& getClientList() { return m_clients; }
520 /* update internal player list */
521 void UpdatePlayerList();
524 std::shared_ptr<con::Connection> m_con;
525 std::recursive_mutex m_clients_mutex;
526 // Connected clients (behind the con mutex)
527 RemoteClientMap m_clients;
528 std::vector<std::string> m_clients_names; //for announcing masterserver
531 ServerEnvironment *m_env;
533 float m_print_info_timer;
535 static const char *statenames[];