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 "threading/mutex.h"
27 #include "network/networkpacket.h"
28 #include "util/cpp11_container.h"
35 class ServerEnvironment;
50 | depending of the incoming packet
51 +---------------------------------------
53 +-----------------------------+ +-----------------------------+
55 | TOSERVER_INIT_LEGACY |----- | TOSERVER_INIT | invalid playername,
56 +-----------------------------+ | +-----------------------------+ password (for _LEGACY),
57 | | | or denied by mod
58 | Auth ok -------------------+---------------------------------
60 +-----------------------------+ +-----------------------------+ |
62 | TOCLIENT_INIT_LEGACY | | TOCLIENT_HELLO | |
63 +-----------------------------+ +-----------------------------+ |
67 /-----------------\ /-----------------\ |
69 | AwaitingInit2 |<--------- | HelloSent | |
71 \-----------------/ | \-----------------/ |
73 +-----------------------------+ | *-----------------------------* Auth fails |
74 |IN: | | |Authentication, depending on |-----------------+
75 | TOSERVER_INIT2 | | | packet sent by client | |
76 +-----------------------------+ | *-----------------------------* |
78 | | | Authentication |
80 /-----------------\ | v |
81 | | | +-----------------------------+ |
82 | InitDone | | |OUT: | |
83 | | | | TOCLIENT_AUTH_ACCEPT | |
84 \-----------------/ | +-----------------------------+ |
86 +-----------------------------+ --------------------- |
88 | TOCLIENT_MOVEMENT | |
89 | TOCLIENT_ITEMDEF | |
90 | TOCLIENT_NODEDEF | |
91 | TOCLIENT_ANNOUNCE_MEDIA | |
92 | TOCLIENT_DETACHED_INVENTORY | |
93 | TOCLIENT_TIME_OF_DAY | |
94 +-----------------------------+ |
97 | ----------------------------- |
99 /-----------------\ v |
100 | | +-----------------------------+ |
101 | DefinitionsSent | |IN: | |
102 | | | TOSERVER_REQUEST_MEDIA | |
103 \-----------------/ | TOSERVER_RECEIVED_MEDIA | |
104 | +-----------------------------+ |
106 | ----------------------------- |
108 +-----------------------------+ --------------------------------+
110 | TOSERVER_CLIENT_READY | v |
111 +-----------------------------+ +-------------------------------+ |
113 v | TOCLIENT_ACCESS_DENIED_LEGAGY | |
114 +-----------------------------+ +-------------------------------+ |
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 +-----------------------------+ |
127 /-----------------\ async mod action (ban, kick) |
128 | |---------------------------------------------------------------
130 | | |----------------------------------------------
131 | \-----------------/ timeout v
132 | | | +-----------------------------+
134 | | | | TOCLIENT_DISCONNECT |
135 | | | +-----------------------------+
138 | | +-----------------------------+ /-----------------\
140 | | | TOSERVER_DISCONNECT |------------------->| Disconnecting |
141 | | +-----------------------------+ | |
142 | | \-----------------/
143 | | any auth packet which was
144 | | allowed in TOCLIENT_AUTH_ACCEPT
146 | *-----------------------------* Auth +-------------------------------+
147 | |Authentication, depending on | succeeds |OUT: |
148 | | packet sent by client |---------->| TOCLIENT_ACCEPT_SUDO_MODE |
149 | *-----------------------------* +-------------------------------+
151 | | Auth fails /-----------------\
153 | +-------------------------------+ | SudoMode |
155 | | TOCLIENT_DENY_SUDO_MODE | \-----------------/
156 | +-------------------------------+ |
158 | | +-----------------------------+
159 | | sets password accordingly |IN: |
160 -------------------+-------------------------------| TOSERVER_FIRST_SRP |
161 +-----------------------------+
169 // Also make sure to update the ClientInterface::statenames
170 // array when modifying these enums
186 enum ClientStateEvent
193 CSE_SetDefinitionsSent,
201 Used for queueing and sorting block transfers in containers
203 Lower priority number means higher priority.
205 struct PrioritySortedBlockTransfer
207 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
209 priority = a_priority;
213 bool operator < (const PrioritySortedBlockTransfer &other) const
215 return priority < other.priority;
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.
230 // The serialization version to use with the client
231 u8 serialization_version;
233 u16 net_proto_version;
235 /* Authentication information */
237 bool create_player_on_auth_success;
238 AuthMechanism chosen_mech;
240 u32 allowed_auth_mechs;
241 u32 allowed_sudo_mechs;
243 bool isSudoMechAllowed(AuthMechanism mech)
244 { return allowed_sudo_mechs & mech; }
245 bool isMechAllowed(AuthMechanism mech)
246 { return allowed_auth_mechs & mech; }
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),
255 m_time_from_building(9999),
256 m_pending_serialization_version(SER_FMT_VER_INVALID),
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),
266 m_full_version("unknown"),
267 m_deployed_compression(0),
268 m_connection_time(getTime(PRECISION_SECONDS))
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
280 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
281 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
283 void GotBlock(v3s16 p);
285 void SentBlock(v3s16 p);
287 void SetBlockNotSent(v3s16 p);
288 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
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
296 void ResendBlockIfOnWire(v3s16 p);
300 return m_blocks_sending.size();
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);
308 void PrintInfo(std::ostream &o)
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
316 m_excess_gotblocks = 0;
319 // Time from last placing or removing blocks
320 float m_time_from_building;
323 List of active objects that the client knows of.
325 std::set<u16> m_known_objects;
327 ClientState getState()
330 std::string getName()
333 void setName(std::string name)
336 /* update internal client state */
337 void notifyEvent(ClientStateEvent event);
339 /* set expected serialization version */
340 void setPendingSerializationVersion(u8 version)
341 { m_pending_serialization_version = version; }
343 void setDeployedCompressionMode(u16 byteFlag)
344 { m_deployed_compression = byteFlag; }
346 void confirmSerializationVersion()
347 { serialization_version = m_pending_serialization_version; }
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;
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; }
366 // Version is stored in here after INIT before INIT2
367 u8 m_pending_serialization_version;
369 /* current state of client */
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
378 List of block positions.
379 No MapBlock* is stored here because the blocks can get deleted.
381 std::set<v3s16> m_blocks_sent;
382 s16 m_nearest_unsent_d;
384 float m_nearest_unsent_reset_timer;
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)
394 std::map<v3s16, float> m_blocks_sending;
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.
402 List of block positions.
404 std::set<v3s16> m_blocks_modified;
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()
413 u32 m_excess_gotblocks;
415 // CPU usage optimization
416 float m_nothing_to_send_pause_timer;
419 name of player using this client
430 std::string m_full_version;
432 u16 m_deployed_compression;
435 time this client was created
437 const u32 m_connection_time;
440 class ClientInterface {
445 ClientInterface(con::Connection* con);
449 void step(float dtime);
451 /* get list of active client id's */
452 std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
454 /* get list of client player names */
455 const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
457 /* send message to client */
458 void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
460 /* send to all clients */
461 void sendToAll(NetworkPacket *pkt);
463 /* delete a client */
464 void DeleteClient(u16 peer_id);
467 void CreateClient(u16 peer_id);
469 /* get a client by peer_id */
470 RemoteClient* getClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
472 /* get client by peer_id (make sure you have list lock before!*/
473 RemoteClient* lockedGetClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
475 /* get state of client by id*/
476 ClientState getClientState(u16 peer_id);
478 /* set client playername */
479 void setPlayerName(u16 peer_id,std::string name);
481 /* get protocol version of client */
482 u16 getProtocolVersion(u16 peer_id);
484 /* set client version */
485 void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
487 /* event to update client state */
488 void event(u16 peer_id, ClientStateEvent event);
490 /* Set environment. Do not call this function if environment is already set */
491 void setEnv(ServerEnvironment *env)
493 assert(m_env == NULL); // pre-condition
497 static std::string state2Name(ClientState state);
500 //TODO find way to avoid this functions
501 void lock() { m_clients_mutex.lock(); }
502 void unlock() { m_clients_mutex.unlock(); }
504 UNORDERED_MAP<u16, RemoteClient*>& getClientList() { return m_clients; }
507 /* update internal player list */
508 void UpdatePlayerList();
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
518 ServerEnvironment *m_env;
521 float m_print_info_timer;
523 static const char *statenames[];