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 bool isSudoMechAllowed(AuthMechanism mech)
247 { return allowed_sudo_mechs & mech; }
248 bool isMechAllowed(AuthMechanism mech)
249 { return allowed_auth_mechs & mech; }
252 ~RemoteClient() = default;
255 Finds block that should be sent next to the client.
256 Environment should be locked when this is called.
257 dtime is used for resetting send radius at slow interval
259 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
260 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
262 void GotBlock(v3s16 p);
264 void SentBlock(v3s16 p);
266 void SetBlockNotSent(v3s16 p);
267 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
270 * tell client about this block being modified right now.
271 * this information is required to requeue the block in case it's "on wire"
272 * while modification is processed by server
273 * @param p position of modified block
275 void ResendBlockIfOnWire(v3s16 p);
277 u32 getSendingCount() const { return m_blocks_sending.size(); }
279 bool isBlockSent(v3s16 p) const
281 return m_blocks_sent.find(p) != m_blocks_sent.end();
284 // Increments timeouts and removes timed-out blocks from list
285 // NOTE: This doesn't fix the server-not-sending-block bug
286 // because it is related to emerging, not sending.
287 //void RunSendingTimeouts(float dtime, float timeout);
289 void PrintInfo(std::ostream &o)
291 o<<"RemoteClient "<<peer_id<<": "
292 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
293 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
294 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
295 <<", m_excess_gotblocks="<<m_excess_gotblocks
297 m_excess_gotblocks = 0;
300 // Time from last placing or removing blocks
301 float m_time_from_building = 9999;
304 List of active objects that the client knows of.
306 std::set<u16> m_known_objects;
308 ClientState getState() const { return m_state; }
310 std::string getName() const { return m_name; }
312 void setName(const std::string &name) { m_name = name; }
314 /* update internal client state */
315 void notifyEvent(ClientStateEvent event);
317 /* set expected serialization version */
318 void setPendingSerializationVersion(u8 version)
319 { m_pending_serialization_version = version; }
321 void setDeployedCompressionMode(u16 byteFlag)
322 { m_deployed_compression = byteFlag; }
324 void confirmSerializationVersion()
325 { serialization_version = m_pending_serialization_version; }
330 /* set version information */
331 void setVersionInfo(u8 major, u8 minor, u8 patch, const std::string &full)
333 m_version_major = major;
334 m_version_minor = minor;
335 m_version_patch = patch;
336 m_full_version = full;
339 /* read version information */
340 u8 getMajor() const { return m_version_major; }
341 u8 getMinor() const { return m_version_minor; }
342 u8 getPatch() const { return m_version_patch; }
343 const std::string &getFullVer() const { return m_full_version; }
345 void setLangCode(const std::string &code) { m_lang_code = code; }
346 const std::string &getLangCode() const { return m_lang_code; }
348 void setCachedAddress(const Address &addr) { m_addr = addr; }
349 const Address &getAddress() const { return m_addr; }
352 // Version is stored in here after INIT before INIT2
353 u8 m_pending_serialization_version = SER_FMT_VER_INVALID;
355 /* current state of client */
356 ClientState m_state = CS_Created;
358 // Cached here so retrieval doesn't have to go to connection API
361 // Client sent language code
362 std::string m_lang_code;
365 Blocks that have been sent to client.
366 - These don't have to be sent again.
367 - A block is cleared from here when client says it has
368 deleted it from it's memory
370 List of block positions.
371 No MapBlock* is stored here because the blocks can get deleted.
373 std::set<v3s16> m_blocks_sent;
374 s16 m_nearest_unsent_d = 0;
376 v3f m_last_camera_dir;
378 const u16 m_max_simul_sends;
379 const float m_min_time_from_building;
380 const s16 m_max_send_distance;
381 const s16 m_block_optimize_distance;
382 const s16 m_max_gen_distance;
383 const bool m_occ_cull;
386 Blocks that are currently on the line.
387 This is used for throttling the sending of blocks.
388 - The size of this list is limited to some value
389 Block is added when it is sent with BLOCKDATA.
390 Block is removed when GOTBLOCKS is received.
391 Value is time from sending. (not used at the moment)
393 std::map<v3s16, float> m_blocks_sending;
396 Blocks that have been modified since blocks were
397 sent to the client last (getNextBlocks()).
398 This is used to reset the unsent distance, so that
399 modified blocks are resent to the client.
401 List of block positions.
403 std::set<v3s16> m_blocks_modified;
406 Count of excess GotBlocks().
407 There is an excess amount because the client sometimes
408 gets a block so late that the server sends it again,
409 and the client then sends two GOTBLOCKs.
410 This is resetted by PrintInfo()
412 u32 m_excess_gotblocks = 0;
414 // CPU usage optimization
415 float m_nothing_to_send_pause_timer = 0.0f;
418 name of player using this client
420 std::string m_name = "";
425 u8 m_version_major = 0;
426 u8 m_version_minor = 0;
427 u8 m_version_patch = 0;
429 std::string m_full_version = "unknown";
431 u16 m_deployed_compression = 0;
434 time this client was created
436 const u64 m_connection_time = porting::getTimeS();
439 typedef std::unordered_map<u16, RemoteClient*> RemoteClientMap;
441 class ClientInterface {
446 ClientInterface(const std::shared_ptr<con::Connection> &con);
450 void step(float dtime);
452 /* get list of active client id's */
453 std::vector<session_t> getClientIDs(ClientState min_state=CS_Active);
455 /* mark block as not sent to active client sessions */
456 void markBlockposAsNotSent(const v3s16 &pos);
458 /* verify is server user limit was reached */
459 bool isUserLimitReached();
461 /* get list of client player names */
462 const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
464 /* send message to client */
465 void send(session_t peer_id, u8 channelnum, NetworkPacket *pkt, bool reliable);
467 /* send to all clients */
468 void sendToAll(NetworkPacket *pkt);
470 /* delete a client */
471 void DeleteClient(session_t peer_id);
474 void CreateClient(session_t peer_id);
476 /* get a client by peer_id */
477 RemoteClient *getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
479 /* get client by peer_id (make sure you have list lock before!*/
480 RemoteClient *lockedGetClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
482 /* get state of client by id*/
483 ClientState getClientState(session_t peer_id);
485 /* set client playername */
486 void setPlayerName(session_t peer_id, const std::string &name);
488 /* get protocol version of client */
489 u16 getProtocolVersion(session_t peer_id);
491 /* set client version */
492 void setClientVersion(session_t peer_id, u8 major, u8 minor, u8 patch,
493 const std::string &full);
495 /* event to update client state */
496 void event(session_t peer_id, ClientStateEvent event);
498 /* Set environment. Do not call this function if environment is already set */
499 void setEnv(ServerEnvironment *env)
501 assert(m_env == NULL); // pre-condition
505 static std::string state2Name(ClientState state);
509 AutoLock(ClientInterface &iface): m_lock(iface.m_clients_mutex) {}
512 RecursiveMutexAutoLock m_lock;
515 RemoteClientMap& getClientList() { return m_clients; }
518 /* update internal player list */
519 void UpdatePlayerList();
522 std::shared_ptr<con::Connection> m_con;
523 std::recursive_mutex m_clients_mutex;
524 // Connected clients (behind the con mutex)
525 RemoteClientMap m_clients;
526 std::vector<std::string> m_clients_names; //for announcing masterserver
529 ServerEnvironment *m_env;
531 float m_print_info_timer;
533 static const char *statenames[];