527 lines
19 KiB
C++
527 lines
19 KiB
C++
/*
|
|
Minetest
|
|
Copyright (C) 2010-2014 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
#ifndef _CLIENTIFACE_H_
|
|
#define _CLIENTIFACE_H_
|
|
|
|
#include "irr_v3d.h" // for irrlicht datatypes
|
|
|
|
#include "constants.h"
|
|
#include "serialization.h" // for SER_FMT_VER_INVALID
|
|
#include "threading/mutex.h"
|
|
#include "network/networkpacket.h"
|
|
#include "util/cpp11_container.h"
|
|
|
|
#include <list>
|
|
#include <vector>
|
|
#include <set>
|
|
|
|
class MapBlock;
|
|
class ServerEnvironment;
|
|
class EmergeManager;
|
|
|
|
/*
|
|
* State Transitions
|
|
|
|
Start
|
|
(peer connect)
|
|
|
|
|
v
|
|
/-----------------\
|
|
| |
|
|
| Created |
|
|
| |
|
|
\-----------------/
|
|
| depending of the incoming packet
|
|
+---------------------------------------
|
|
v v
|
|
+-----------------------------+ +-----------------------------+
|
|
|IN: | |IN: |
|
|
| TOSERVER_INIT_LEGACY |----- | TOSERVER_INIT | invalid playername,
|
|
+-----------------------------+ | +-----------------------------+ password (for _LEGACY),
|
|
| | | or denied by mod
|
|
| Auth ok -------------------+---------------------------------
|
|
v v |
|
|
+-----------------------------+ +-----------------------------+ |
|
|
|OUT: | |OUT: | |
|
|
| TOCLIENT_INIT_LEGACY | | TOCLIENT_HELLO | |
|
|
+-----------------------------+ +-----------------------------+ |
|
|
| | |
|
|
| | |
|
|
v v |
|
|
/-----------------\ /-----------------\ |
|
|
| | | | |
|
|
| AwaitingInit2 |<--------- | HelloSent | |
|
|
| | | | | |
|
|
\-----------------/ | \-----------------/ |
|
|
| | | |
|
|
+-----------------------------+ | *-----------------------------* Auth fails |
|
|
|IN: | | |Authentication, depending on |-----------------+
|
|
| TOSERVER_INIT2 | | | packet sent by client | |
|
|
+-----------------------------+ | *-----------------------------* |
|
|
| | | |
|
|
| | | Authentication |
|
|
v | | successful |
|
|
/-----------------\ | v |
|
|
| | | +-----------------------------+ |
|
|
| InitDone | | |OUT: | |
|
|
| | | | TOCLIENT_AUTH_ACCEPT | |
|
|
\-----------------/ | +-----------------------------+ |
|
|
| | | |
|
|
+-----------------------------+ --------------------- |
|
|
|OUT: | |
|
|
| TOCLIENT_MOVEMENT | |
|
|
| TOCLIENT_ITEMDEF | |
|
|
| TOCLIENT_NODEDEF | |
|
|
| TOCLIENT_ANNOUNCE_MEDIA | |
|
|
| TOCLIENT_DETACHED_INVENTORY | |
|
|
| TOCLIENT_TIME_OF_DAY | |
|
|
+-----------------------------+ |
|
|
| |
|
|
| |
|
|
| ----------------------------- |
|
|
v | | |
|
|
/-----------------\ v |
|
|
| | +-----------------------------+ |
|
|
| DefinitionsSent | |IN: | |
|
|
| | | TOSERVER_REQUEST_MEDIA | |
|
|
\-----------------/ | TOSERVER_RECEIVED_MEDIA | |
|
|
| +-----------------------------+ |
|
|
| ^ | |
|
|
| ----------------------------- |
|
|
v |
|
|
+-----------------------------+ --------------------------------+
|
|
|IN: | | |
|
|
| TOSERVER_CLIENT_READY | v |
|
|
+-----------------------------+ +-------------------------------+ |
|
|
| |OUT: | |
|
|
v | TOCLIENT_ACCESS_DENIED_LEGAGY | |
|
|
+-----------------------------+ +-------------------------------+ |
|
|
|OUT: | | |
|
|
| TOCLIENT_MOVE_PLAYER | v |
|
|
| TOCLIENT_PRIVILEGES | /-----------------\ |
|
|
| TOCLIENT_INVENTORY_FORMSPEC | | | |
|
|
| UpdateCrafting | | Denied | |
|
|
| TOCLIENT_INVENTORY | | | |
|
|
| TOCLIENT_HP (opt) | \-----------------/ |
|
|
| TOCLIENT_BREATH | |
|
|
| TOCLIENT_DEATHSCREEN | |
|
|
+-----------------------------+ |
|
|
| |
|
|
v |
|
|
/-----------------\ async mod action (ban, kick) |
|
|
| |---------------------------------------------------------------
|
|
---->| Active |
|
|
| | |----------------------------------------------
|
|
| \-----------------/ timeout v
|
|
| | | +-----------------------------+
|
|
| | | |OUT: |
|
|
| | | | TOCLIENT_DISCONNECT |
|
|
| | | +-----------------------------+
|
|
| | | |
|
|
| | v v
|
|
| | +-----------------------------+ /-----------------\
|
|
| | |IN: | | |
|
|
| | | TOSERVER_DISCONNECT |------------------->| Disconnecting |
|
|
| | +-----------------------------+ | |
|
|
| | \-----------------/
|
|
| | any auth packet which was
|
|
| | allowed in TOCLIENT_AUTH_ACCEPT
|
|
| v
|
|
| *-----------------------------* Auth +-------------------------------+
|
|
| |Authentication, depending on | succeeds |OUT: |
|
|
| | packet sent by client |---------->| TOCLIENT_ACCEPT_SUDO_MODE |
|
|
| *-----------------------------* +-------------------------------+
|
|
| | |
|
|
| | Auth fails /-----------------\
|
|
| v | |
|
|
| +-------------------------------+ | SudoMode |
|
|
| |OUT: | | |
|
|
| | TOCLIENT_DENY_SUDO_MODE | \-----------------/
|
|
| +-------------------------------+ |
|
|
| | v
|
|
| | +-----------------------------+
|
|
| | sets password accordingly |IN: |
|
|
-------------------+-------------------------------| TOSERVER_FIRST_SRP |
|
|
+-----------------------------+
|
|
|
|
*/
|
|
namespace con {
|
|
class Connection;
|
|
}
|
|
|
|
|
|
// Also make sure to update the ClientInterface::statenames
|
|
// array when modifying these enums
|
|
|
|
enum ClientState
|
|
{
|
|
CS_Invalid,
|
|
CS_Disconnecting,
|
|
CS_Denied,
|
|
CS_Created,
|
|
CS_AwaitingInit2,
|
|
CS_HelloSent,
|
|
CS_InitDone,
|
|
CS_DefinitionsSent,
|
|
CS_Active,
|
|
CS_SudoMode
|
|
};
|
|
|
|
enum ClientStateEvent
|
|
{
|
|
CSE_Hello,
|
|
CSE_AuthAccept,
|
|
CSE_InitLegacy,
|
|
CSE_GotInit2,
|
|
CSE_SetDenied,
|
|
CSE_SetDefinitionsSent,
|
|
CSE_SetClientReady,
|
|
CSE_SudoSuccess,
|
|
CSE_SudoLeave,
|
|
CSE_Disconnect
|
|
};
|
|
|
|
/*
|
|
Used for queueing and sorting block transfers in containers
|
|
|
|
Lower priority number means higher priority.
|
|
*/
|
|
struct PrioritySortedBlockTransfer
|
|
{
|
|
PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
|
|
{
|
|
priority = a_priority;
|
|
pos = a_pos;
|
|
peer_id = a_peer_id;
|
|
}
|
|
bool operator < (const PrioritySortedBlockTransfer &other) const
|
|
{
|
|
return priority < other.priority;
|
|
}
|
|
float priority;
|
|
v3s16 pos;
|
|
u16 peer_id;
|
|
};
|
|
|
|
class RemoteClient
|
|
{
|
|
public:
|
|
// peer_id=0 means this client has no associated peer
|
|
// NOTE: If client is made allowed to exist while peer doesn't,
|
|
// this has to be set to 0 when there is no peer.
|
|
// Also, the client must be moved to some other container.
|
|
u16 peer_id;
|
|
// The serialization version to use with the client
|
|
u8 serialization_version;
|
|
//
|
|
u16 net_proto_version;
|
|
|
|
/* Authentication information */
|
|
std::string enc_pwd;
|
|
bool create_player_on_auth_success;
|
|
AuthMechanism chosen_mech;
|
|
void * auth_data;
|
|
u32 allowed_auth_mechs;
|
|
u32 allowed_sudo_mechs;
|
|
|
|
bool isSudoMechAllowed(AuthMechanism mech)
|
|
{ return allowed_sudo_mechs & mech; }
|
|
bool isMechAllowed(AuthMechanism mech)
|
|
{ return allowed_auth_mechs & mech; }
|
|
|
|
RemoteClient():
|
|
peer_id(PEER_ID_INEXISTENT),
|
|
serialization_version(SER_FMT_VER_INVALID),
|
|
net_proto_version(0),
|
|
create_player_on_auth_success(false),
|
|
chosen_mech(AUTH_MECHANISM_NONE),
|
|
auth_data(NULL),
|
|
m_time_from_building(9999),
|
|
m_pending_serialization_version(SER_FMT_VER_INVALID),
|
|
m_state(CS_Created),
|
|
m_nearest_unsent_d(0),
|
|
m_nearest_unsent_reset_timer(0.0),
|
|
m_excess_gotblocks(0),
|
|
m_nothing_to_send_pause_timer(0.0),
|
|
m_name(""),
|
|
m_version_major(0),
|
|
m_version_minor(0),
|
|
m_version_patch(0),
|
|
m_full_version("unknown"),
|
|
m_deployed_compression(0),
|
|
m_connection_time(getTime(PRECISION_SECONDS))
|
|
{
|
|
}
|
|
~RemoteClient()
|
|
{
|
|
}
|
|
|
|
/*
|
|
Finds block that should be sent next to the client.
|
|
Environment should be locked when this is called.
|
|
dtime is used for resetting send radius at slow interval
|
|
*/
|
|
void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
|
|
float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
|
|
|
|
void GotBlock(v3s16 p);
|
|
|
|
void SentBlock(v3s16 p);
|
|
|
|
void SetBlockNotSent(v3s16 p);
|
|
void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
|
|
|
|
/**
|
|
* tell client about this block being modified right now.
|
|
* this information is required to requeue the block in case it's "on wire"
|
|
* while modification is processed by server
|
|
* @param p position of modified block
|
|
*/
|
|
void ResendBlockIfOnWire(v3s16 p);
|
|
|
|
s32 SendingCount()
|
|
{
|
|
return m_blocks_sending.size();
|
|
}
|
|
|
|
// Increments timeouts and removes timed-out blocks from list
|
|
// NOTE: This doesn't fix the server-not-sending-block bug
|
|
// because it is related to emerging, not sending.
|
|
//void RunSendingTimeouts(float dtime, float timeout);
|
|
|
|
void PrintInfo(std::ostream &o)
|
|
{
|
|
o<<"RemoteClient "<<peer_id<<": "
|
|
<<"m_blocks_sent.size()="<<m_blocks_sent.size()
|
|
<<", m_blocks_sending.size()="<<m_blocks_sending.size()
|
|
<<", m_nearest_unsent_d="<<m_nearest_unsent_d
|
|
<<", m_excess_gotblocks="<<m_excess_gotblocks
|
|
<<std::endl;
|
|
m_excess_gotblocks = 0;
|
|
}
|
|
|
|
// Time from last placing or removing blocks
|
|
float m_time_from_building;
|
|
|
|
/*
|
|
List of active objects that the client knows of.
|
|
*/
|
|
std::set<u16> m_known_objects;
|
|
|
|
ClientState getState()
|
|
{ return m_state; }
|
|
|
|
std::string getName()
|
|
{ return m_name; }
|
|
|
|
void setName(std::string name)
|
|
{ m_name = name; }
|
|
|
|
/* update internal client state */
|
|
void notifyEvent(ClientStateEvent event);
|
|
|
|
/* set expected serialization version */
|
|
void setPendingSerializationVersion(u8 version)
|
|
{ m_pending_serialization_version = version; }
|
|
|
|
void setDeployedCompressionMode(u16 byteFlag)
|
|
{ m_deployed_compression = byteFlag; }
|
|
|
|
void confirmSerializationVersion()
|
|
{ serialization_version = m_pending_serialization_version; }
|
|
|
|
/* get uptime */
|
|
u32 uptime();
|
|
|
|
/* set version information */
|
|
void setVersionInfo(u8 major, u8 minor, u8 patch, std::string full) {
|
|
m_version_major = major;
|
|
m_version_minor = minor;
|
|
m_version_patch = patch;
|
|
m_full_version = full;
|
|
}
|
|
|
|
/* read version information */
|
|
u8 getMajor() { return m_version_major; }
|
|
u8 getMinor() { return m_version_minor; }
|
|
u8 getPatch() { return m_version_patch; }
|
|
std::string getVersion() { return m_full_version; }
|
|
private:
|
|
// Version is stored in here after INIT before INIT2
|
|
u8 m_pending_serialization_version;
|
|
|
|
/* current state of client */
|
|
ClientState m_state;
|
|
|
|
/*
|
|
Blocks that have been sent to client.
|
|
- These don't have to be sent again.
|
|
- A block is cleared from here when client says it has
|
|
deleted it from it's memory
|
|
|
|
List of block positions.
|
|
No MapBlock* is stored here because the blocks can get deleted.
|
|
*/
|
|
std::set<v3s16> m_blocks_sent;
|
|
s16 m_nearest_unsent_d;
|
|
v3s16 m_last_center;
|
|
float m_nearest_unsent_reset_timer;
|
|
|
|
/*
|
|
Blocks that are currently on the line.
|
|
This is used for throttling the sending of blocks.
|
|
- The size of this list is limited to some value
|
|
Block is added when it is sent with BLOCKDATA.
|
|
Block is removed when GOTBLOCKS is received.
|
|
Value is time from sending. (not used at the moment)
|
|
*/
|
|
std::map<v3s16, float> m_blocks_sending;
|
|
|
|
/*
|
|
Blocks that have been modified since last sending them.
|
|
These blocks will not be marked as sent, even if the
|
|
client reports it has received them to account for blocks
|
|
that are being modified while on the line.
|
|
|
|
List of block positions.
|
|
*/
|
|
std::set<v3s16> m_blocks_modified;
|
|
|
|
/*
|
|
Count of excess GotBlocks().
|
|
There is an excess amount because the client sometimes
|
|
gets a block so late that the server sends it again,
|
|
and the client then sends two GOTBLOCKs.
|
|
This is resetted by PrintInfo()
|
|
*/
|
|
u32 m_excess_gotblocks;
|
|
|
|
// CPU usage optimization
|
|
float m_nothing_to_send_pause_timer;
|
|
|
|
/*
|
|
name of player using this client
|
|
*/
|
|
std::string m_name;
|
|
|
|
/*
|
|
client information
|
|
*/
|
|
u8 m_version_major;
|
|
u8 m_version_minor;
|
|
u8 m_version_patch;
|
|
|
|
std::string m_full_version;
|
|
|
|
u16 m_deployed_compression;
|
|
|
|
/*
|
|
time this client was created
|
|
*/
|
|
const u32 m_connection_time;
|
|
};
|
|
|
|
class ClientInterface {
|
|
public:
|
|
|
|
friend class Server;
|
|
|
|
ClientInterface(con::Connection* con);
|
|
~ClientInterface();
|
|
|
|
/* run sync step */
|
|
void step(float dtime);
|
|
|
|
/* get list of active client id's */
|
|
std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
|
|
|
|
/* get list of client player names */
|
|
const std::vector<std::string> &getPlayerNames() const { return m_clients_names; }
|
|
|
|
/* send message to client */
|
|
void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable);
|
|
|
|
/* send to all clients */
|
|
void sendToAll(u16 channelnum, NetworkPacket* pkt, bool reliable);
|
|
|
|
/* delete a client */
|
|
void DeleteClient(u16 peer_id);
|
|
|
|
/* create client */
|
|
void CreateClient(u16 peer_id);
|
|
|
|
/* get a client by peer_id */
|
|
RemoteClient* getClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
|
|
|
|
/* get client by peer_id (make sure you have list lock before!*/
|
|
RemoteClient* lockedGetClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
|
|
|
|
/* get state of client by id*/
|
|
ClientState getClientState(u16 peer_id);
|
|
|
|
/* set client playername */
|
|
void setPlayerName(u16 peer_id,std::string name);
|
|
|
|
/* get protocol version of client */
|
|
u16 getProtocolVersion(u16 peer_id);
|
|
|
|
/* set client version */
|
|
void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
|
|
|
|
/* event to update client state */
|
|
void event(u16 peer_id, ClientStateEvent event);
|
|
|
|
/* Set environment. Do not call this function if environment is already set */
|
|
void setEnv(ServerEnvironment *env)
|
|
{
|
|
assert(m_env == NULL); // pre-condition
|
|
m_env = env;
|
|
}
|
|
|
|
static std::string state2Name(ClientState state);
|
|
|
|
protected:
|
|
//TODO find way to avoid this functions
|
|
void lock() { m_clients_mutex.lock(); }
|
|
void unlock() { m_clients_mutex.unlock(); }
|
|
|
|
UNORDERED_MAP<u16, RemoteClient*>& getClientList() { return m_clients; }
|
|
|
|
private:
|
|
/* update internal player list */
|
|
void UpdatePlayerList();
|
|
|
|
// Connection
|
|
con::Connection* m_con;
|
|
Mutex m_clients_mutex;
|
|
// Connected clients (behind the con mutex)
|
|
UNORDERED_MAP<u16, RemoteClient*> m_clients;
|
|
std::vector<std::string> m_clients_names; //for announcing masterserver
|
|
|
|
// Environment
|
|
ServerEnvironment *m_env;
|
|
Mutex m_env_mutex;
|
|
|
|
float m_print_info_timer;
|
|
|
|
static const char *statenames[];
|
|
};
|
|
|
|
#endif
|