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 "jthread/jmutex.h"
27 #include "network/networkpacket.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 +-----------------------------+
168 #define CI_ARRAYSIZE(a) (sizeof(a) / sizeof((a)[0]))
184 enum ClientStateEvent
191 CSE_SetDefinitionsSent,
199 Used for queueing and sorting block transfers in containers
201 Lower priority number means higher priority.
203 struct PrioritySortedBlockTransfer
205 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
207 priority = a_priority;
211 bool operator < (const PrioritySortedBlockTransfer &other) const
213 return priority < other.priority;
223 // peer_id=0 means this client has no associated peer
224 // NOTE: If client is made allowed to exist while peer doesn't,
225 // this has to be set to 0 when there is no peer.
226 // Also, the client must be moved to some other container.
228 // The serialization version to use with the client
229 u8 serialization_version;
231 u16 net_proto_version;
233 /* Authentication information */
235 AuthMechanism chosen_mech;
237 u32 allowed_auth_mechs;
238 u32 allowed_sudo_mechs;
240 bool isSudoMechAllowed(AuthMechanism mech)
241 { return allowed_sudo_mechs & mech; }
242 bool isMechAllowed(AuthMechanism mech)
243 { return allowed_auth_mechs & mech; }
246 peer_id(PEER_ID_INEXISTENT),
247 serialization_version(SER_FMT_VER_INVALID),
248 net_proto_version(0),
249 chosen_mech(AUTH_MECHANISM_NONE),
251 m_time_from_building(9999),
252 m_pending_serialization_version(SER_FMT_VER_INVALID),
254 m_nearest_unsent_d(0),
255 m_nearest_unsent_reset_timer(0.0),
256 m_excess_gotblocks(0),
257 m_nothing_to_send_pause_timer(0.0),
262 m_full_version("unknown"),
263 m_deployed_compression(0),
264 m_connection_time(getTime(PRECISION_SECONDS))
272 Finds block that should be sent next to the client.
273 Environment should be locked when this is called.
274 dtime is used for resetting send radius at slow interval
276 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
277 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
279 void GotBlock(v3s16 p);
281 void SentBlock(v3s16 p);
283 void SetBlockNotSent(v3s16 p);
284 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
287 * tell client about this block being modified right now.
288 * this information is required to requeue the block in case it's "on wire"
289 * while modification is processed by server
290 * @param p position of modified block
292 void ResendBlockIfOnWire(v3s16 p);
296 return m_blocks_sending.size();
299 // Increments timeouts and removes timed-out blocks from list
300 // NOTE: This doesn't fix the server-not-sending-block bug
301 // because it is related to emerging, not sending.
302 //void RunSendingTimeouts(float dtime, float timeout);
304 void PrintInfo(std::ostream &o)
306 o<<"RemoteClient "<<peer_id<<": "
307 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
308 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
309 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
310 <<", m_excess_gotblocks="<<m_excess_gotblocks
312 m_excess_gotblocks = 0;
315 // Time from last placing or removing blocks
316 float m_time_from_building;
319 List of active objects that the client knows of.
322 std::set<u16> m_known_objects;
324 ClientState getState()
327 std::string getName()
330 void setName(std::string name)
333 /* update internal client state */
334 void notifyEvent(ClientStateEvent event);
336 /* set expected serialization version */
337 void setPendingSerializationVersion(u8 version)
338 { m_pending_serialization_version = version; }
340 void setDeployedCompressionMode(u16 byteFlag)
341 { m_deployed_compression = byteFlag; }
343 void confirmSerializationVersion()
344 { serialization_version = m_pending_serialization_version; }
349 /* set version information */
350 void setVersionInfo(u8 major, u8 minor, u8 patch, std::string full) {
351 m_version_major = major;
352 m_version_minor = minor;
353 m_version_patch = patch;
354 m_full_version = full;
357 /* read version information */
358 u8 getMajor() { return m_version_major; }
359 u8 getMinor() { return m_version_minor; }
360 u8 getPatch() { return m_version_patch; }
361 std::string getVersion() { return m_full_version; }
363 // Version is stored in here after INIT before INIT2
364 u8 m_pending_serialization_version;
366 /* current state of client */
370 Blocks that have been sent to client.
371 - These don't have to be sent again.
372 - A block is cleared from here when client says it has
373 deleted it from it's memory
375 Key is position, value is dummy.
376 No MapBlock* is stored here because the blocks can get deleted.
378 std::set<v3s16> m_blocks_sent;
379 s16 m_nearest_unsent_d;
381 float m_nearest_unsent_reset_timer;
384 Blocks that are currently on the line.
385 This is used for throttling the sending of blocks.
386 - The size of this list is limited to some value
387 Block is added when it is sent with BLOCKDATA.
388 Block is removed when GOTBLOCKS is received.
389 Value is time from sending. (not used at the moment)
391 std::map<v3s16, float> m_blocks_sending;
394 Count of excess GotBlocks().
395 There is an excess amount because the client sometimes
396 gets a block so late that the server sends it again,
397 and the client then sends two GOTBLOCKs.
398 This is resetted by PrintInfo()
400 u32 m_excess_gotblocks;
402 // CPU usage optimization
403 float m_nothing_to_send_pause_timer;
406 name of player using this client
417 std::string m_full_version;
419 u16 m_deployed_compression;
422 time this client was created
424 const u32 m_connection_time;
427 class ClientInterface {
432 ClientInterface(con::Connection* con);
436 void step(float dtime);
438 /* get list of active client id's */
439 std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
441 /* get list of client player names */
442 std::vector<std::string> getPlayerNames();
444 /* send message to client */
445 void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
447 /* send to all clients */
448 void sendToAll(u16 channelnum, NetworkPacket* pkt, bool reliable);
450 /* delete a client */
451 void DeleteClient(u16 peer_id);
454 void CreateClient(u16 peer_id);
456 /* get a client by peer_id */
457 RemoteClient* getClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
459 /* get client by peer_id (make sure you have list lock before!*/
460 RemoteClient* lockedGetClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
462 /* get state of client by id*/
463 ClientState getClientState(u16 peer_id);
465 /* set client playername */
466 void setPlayerName(u16 peer_id,std::string name);
468 /* get protocol version of client */
469 u16 getProtocolVersion(u16 peer_id);
471 /* set client version */
472 void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
474 /* event to update client state */
475 void event(u16 peer_id, ClientStateEvent event);
477 /* Set environment. Do not call this function if environment is already set */
478 void setEnv(ServerEnvironment *env)
480 assert(m_env == NULL); // pre-condition
484 static std::string state2Name(ClientState state);
487 //TODO find way to avoid this functions
489 { m_clients_mutex.Lock(); }
491 { m_clients_mutex.Unlock(); }
493 std::map<u16, RemoteClient*>& getClientList()
494 { return m_clients; }
497 /* update internal player list */
498 void UpdatePlayerList();
501 con::Connection* m_con;
502 JMutex m_clients_mutex;
503 // Connected clients (behind the con mutex)
504 std::map<u16, RemoteClient*> m_clients;
505 std::vector<std::string> m_clients_names; //for announcing masterserver
508 ServerEnvironment *m_env;
511 float m_print_info_timer;
513 static const char *statenames[];