#pragma once
#include "irr_v3d.h"
#include "map.h"
#include "hud_element.h"
#include "gamedef.h"
#include "content/subgames.h"
#include "network/peerhandler.h"
#include "util/thread.h"
#include "util/basic_macros.h"
#include "util/metricsbackend.h"
#include "server/clientiface.h"
#include "threading/ordered_mutex.h"
#include "translation.h"
#include "sound_spec.h"
#include <atomic>
#include <csignal>
#include <string>
#include <list>
#include <vector>
#include <unordered_map>
#include <unordered_set>
#include <optional>
#include <string_view>
#include <shared_mutex>
#include <condition_variable>
class BanManager;
class ChatEvent;
class EmergeManager;
class Inventory;
class IRollbackManager;
class IWritableCraftDefManager;
class IWritableItemDefManager;
class LuaError;
class MetricsBackend;
class ModChannelMgr;
class NodeDefManager;
class Player;
class PlayerSAO;
class RemotePlayer;
class ServerEnvironment;
class ServerInventoryManager;
class ServerModManager;
class ServerScripting;
class ServerThread;
class Settings;
struct ChatEventChat;
struct ChatInterface;
struct ChatMessage;
struct CloudParams;
struct GameParams;
struct Lighting;
struct MoonParams;
struct PackedValue;
struct ParticleParameters;
struct ParticleSpawnerParameters;
struct PlayerHPChangeReason;
struct RollbackAction;
struct SkyboxParams;
struct SoundSpec;
struct StarParams;
struct SunParams;
namespace con {
class IConnection;
class IPeer;
enum rtt_stat_type : int;
}
enum {
AC_DIGGING = 0x01,
AC_INTERACTION = 0x02,
AC_MOVEMENT = 0x04
};
constexpr const static FlagDesc flagdesc_anticheat[] = {
{"digging", AC_DIGGING},
{"interaction", AC_INTERACTION},
{"movement", AC_MOVEMENT},
{NULL, 0}
};
enum ClientDeletionReason {
CDR_LEAVE,
CDR_TIMEOUT,
CDR_DENY
};
struct MediaInfo
{
std::string path;
std::string sha1_digest;
bool no_announce;
bool ephemeral;
bool delete_at_shutdown;
MediaInfo(std::string_view path_,
std::string_view sha1_digest_):
path(path_),
sha1_digest(sha1_digest_),
no_announce(false),
ephemeral(false),
delete_at_shutdown(false)
{
}
};
struct ServerPlayingSound
{
SoundLocation type = SoundLocation::Local;
float gain = 1.0f;
float max_hear_distance = 32 * BS;
v3f pos;
u16 object = 0;
std::string to_player;
std::string exclude_player;
v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
SoundSpec spec;
std::unordered_set<session_t> clients;
};
struct MinimapMode {
MinimapType type = MINIMAP_TYPE_OFF;
std::string label;
u16 size = 0;
std::string texture;
u16 scale = 1;
};
struct ClientInfo {
ClientState state;
Address addr;
u32 uptime;
u8 ser_vers;
u16 prot_vers;
u8 major, minor, patch;
std::string vers_string, lang_code;
};
struct ModIPCStore {
ModIPCStore() = default;
~ModIPCStore();
std::shared_mutex mutex;
std::condition_variable_any condvar;
* Map storing the data
*
* @note Do not store `nil` data in this map, instead remove the whole key.
*/
std::unordered_map<std::string, std::unique_ptr<PackedValue>> map;
inline void signal() { condvar.notify_all(); }
};
class Server : public con::PeerHandler, public MapEventReceiver,
public IGameDef
{
public:
NOTE: Every public method should be thread-safe
*/
Server(
const std::string &path_world,
const SubgameSpec &gamespec,
bool simple_singleplayer_mode,
Address bind_addr,
bool dedicated,
ChatInterface *iface = nullptr,
std::string *shutdown_errmsg = nullptr
);
~Server();
DISABLE_CLASS_COPY(Server);
void start();
void stop();
void step();
void AsyncRunStep(float dtime, bool initial_step = false);
void Receive(float min_time);
void yieldToOtherThreads(float dtime);
PlayerSAO *StageTwoClientInit(session_t peer_id);
* Command Handlers
*/
void handleCommand(NetworkPacket* pkt);
void handleCommand_Null(NetworkPacket* pkt) {};
void handleCommand_Deprecated(NetworkPacket* pkt);
void handleCommand_Init(NetworkPacket* pkt);
void handleCommand_Init2(NetworkPacket* pkt);
void handleCommand_ModChannelJoin(NetworkPacket *pkt);
void handleCommand_ModChannelLeave(NetworkPacket *pkt);
void handleCommand_ModChannelMsg(NetworkPacket *pkt);
void handleCommand_RequestMedia(NetworkPacket* pkt);
void handleCommand_ClientReady(NetworkPacket* pkt);
void handleCommand_GotBlocks(NetworkPacket* pkt);
void handleCommand_PlayerPos(NetworkPacket* pkt);
void handleCommand_DeletedBlocks(NetworkPacket* pkt);
void handleCommand_InventoryAction(NetworkPacket* pkt);
void handleCommand_ChatMessage(NetworkPacket* pkt);
void handleCommand_Damage(NetworkPacket* pkt);
void handleCommand_PlayerItem(NetworkPacket* pkt);
void handleCommand_Interact(NetworkPacket* pkt);
void handleCommand_RemovedSounds(NetworkPacket* pkt);
void handleCommand_NodeMetaFields(NetworkPacket* pkt);
void handleCommand_InventoryFields(NetworkPacket* pkt);
void handleCommand_FirstSrp(NetworkPacket* pkt);
void handleCommand_SrpBytesA(NetworkPacket* pkt);
void handleCommand_SrpBytesM(NetworkPacket* pkt);
void handleCommand_HaveMedia(NetworkPacket *pkt);
void handleCommand_UpdateClientInfo(NetworkPacket *pkt);
void ProcessData(NetworkPacket *pkt);
void Send(NetworkPacket *pkt);
void Send(session_t peer_id, NetworkPacket *pkt);
void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
NetworkPacket *pkt);
void setTimeOfDay(u32 time);
Shall be called with the environment locked.
This is accessed by the map, which is inside the environment,
so it shouldn't be a problem.
*/
void onMapEditEvent(const MapEditEvent &event) override;
std::string getStatusString();
inline double getUptime() const { return m_uptime_counter->get(); }
inline bool isShutdownRequested() const { return m_shutdown_state.is_requested; }
void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
s32 playSound(ServerPlayingSound ¶ms, bool ephemeral=false);
void stopSound(s32 handle);
void fadeSound(s32 handle, float step, float gain);
std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
bool checkPriv(const std::string &name, const std::string &priv);
void reportPrivsModified(const std::string &name="");
void reportInventoryFormspecModified(const std::string &name);
void reportFormspecPrependModified(const std::string &name);
void setIpBanned(const std::string &ip, const std::string &name);
void unsetIpBanned(const std::string &ip_or_name);
std::string getBanDescription(const std::string &ip_or_name);
bool denyIfBanned(session_t peer_id);
void notifyPlayer(const char *name, const std::wstring &msg);
void notifyPlayers(const std::wstring &msg);
void spawnParticle(const std::string &playername,
const ParticleParameters &p);
u32 addParticleSpawner(const ParticleSpawnerParameters &p,
ServerActiveObject *attached, const std::string &to_player,
const std::string &exclude_player);
void deleteParticleSpawner(const std::string &playername, u32 id);
struct DynamicMediaArgs {
std::string filename;
std::optional<std::string> filepath;
std::optional<std::string_view> data;
u32 token;
std::string to_player;
bool ephemeral = false;
bool client_cache = true;
};
bool dynamicAddMedia(const DynamicMediaArgs &args);
ServerInventoryManager *getInventoryMgr() const { return m_inventory_mgr.get(); }
void sendDetachedInventory(Inventory *inventory, const std::string &name, session_t peer_id);
inline ServerScripting *getScriptIface() { return m_script.get(); }
bool rollbackRevertActions(const std::list<RollbackAction> &actions,
std::list<std::string> *log);
bool isClient() override { return false; }
IItemDefManager* getItemDefManager() override;
const NodeDefManager* getNodeDefManager() override;
ICraftDefManager* getCraftDefManager() override;
u16 allocateUnknownNodeId(const std::string &name) override;
IRollbackManager *getRollbackManager() override { return m_rollback; }
EmergeManager *getEmergeManager() { return m_emerge.get(); }
ModStorageDatabase *getModStorageDatabase() override { return m_mod_storage_database; }
IWritableItemDefManager* getWritableItemDefManager();
NodeDefManager* getWritableNodeDefManager();
IWritableCraftDefManager* getWritableCraftDefManager();
const std::vector<ModSpec> &getMods() const override;
const ModSpec* getModSpec(const std::string &modname) const override;
const SubgameSpec* getGameSpec() const override { return &m_gamespec; }
static std::string getBuiltinLuaPath();
std::string getWorldPath() const override { return m_path_world; }
std::string getModDataPath() const override { return m_path_mod_data; }
ModIPCStore *getModIPCStore() override { return &m_ipcstore; }
inline bool isSingleplayer() const
{ return m_simple_singleplayer_mode; }
struct StepSettings {
float steplen;
bool pause;
};
void setStepSettings(StepSettings spdata) { m_step_settings.store(spdata); }
StepSettings getStepSettings() { return m_step_settings.load(); }
void setAsyncFatalError(const std::string &error);
void setAsyncFatalError(const LuaError &e);
void addShutdownError(const ModError &e);
bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
Map &getMap();
ServerEnvironment & getEnv() { return *m_env; }
v3f findSpawnPos();
u32 hudAdd(RemotePlayer *player, std::unique_ptr<HudElement> element);
bool hudRemove(RemotePlayer *player, u32 id);
bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
void hudSetHotbarImage(RemotePlayer *player, const std::string &name);
void hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name);
Address getPeerAddress(session_t peer_id);
void setLocalPlayerAnimations(RemotePlayer *player, v2f animation_frames[4],
f32 frame_speed);
void setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third, v3f third_front);
void setSky(RemotePlayer *player, const SkyboxParams ¶ms);
void setSun(RemotePlayer *player, const SunParams ¶ms);
void setMoon(RemotePlayer *player, const MoonParams ¶ms);
void setStars(RemotePlayer *player, const StarParams ¶ms);
void setClouds(RemotePlayer *player, const CloudParams ¶ms);
void overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
void setLighting(RemotePlayer *player, const Lighting &lighting);
void peerAdded(con::IPeer *peer) override;
void deletingPeer(con::IPeer *peer, bool timeout) override;
void DenySudoAccess(session_t peer_id);
void DenyAccess(session_t peer_id, AccessDeniedCode reason,
std::string_view custom_reason = "", bool reconnect = false);
void kickAllPlayers(AccessDeniedCode reason,
const std::string &str_reason, bool reconnect);
void acceptAuth(session_t peer_id, bool forSudoMode);
void DisconnectPeer(session_t peer_id);
bool getClientConInfo(session_t peer_id, con::rtt_stat_type type, float *retval);
bool getClientInfo(session_t peer_id, ClientInfo &ret);
const ClientDynamicInfo *getClientDynamicInfo(session_t peer_id);
void printToConsoleOnly(const std::string &text);
void HandlePlayerHPChange(PlayerSAO *sao, const PlayerHPChangeReason &reason);
void SendPlayerHP(PlayerSAO *sao, bool effect);
void SendPlayerBreath(PlayerSAO *sao);
void SendInventory(RemotePlayer *player, bool incremental, bool skip_wield_anim = false);
void SendMovePlayer(PlayerSAO *sao);
void SendMovePlayerRel(session_t peer_id, const v3f &added_pos);
void SendPlayerSpeed(session_t peer_id, const v3f &added_vel);
void SendPlayerFov(session_t peer_id);
void SendCamera(session_t peer_id, Player *player);
void SendMinimapModes(session_t peer_id,
std::vector<MinimapMode> &modes,
size_t wanted_mode);
void sendDetachedInventories(session_t peer_id, bool incremental);
bool joinModChannel(const std::string &channel) override;
bool leaveModChannel(const std::string &channel) override;
bool sendModChannelMessage(const std::string &channel, const std::string &message) override;
ModChannel *getModChannel(const std::string &channel) override;
bool SendBlock(session_t peer_id, const v3s16 &blockpos);
Translations *getTranslationLanguage(const std::string &lang_code);
std::unordered_map<std::string, std::string> getMediaList();
static std::vector<std::string> getModStorageDatabaseBackends();
static ModStorageDatabase *openModStorageDatabase(const std::string &world_path);
static ModStorageDatabase *openModStorageDatabase(const std::string &backend,
const std::string &world_path, const Settings &world_mt);
static bool migrateModStorageDatabase(const GameParams &game_params,
const Settings &cmd_args);
static u16 getProtocolVersionMin();
static u16 getProtocolVersionMax();
std::vector<std::pair<std::string, std::string>> m_async_init_files;
std::vector<std::pair<std::string, std::string>> m_mapgen_init_files;
std::unique_ptr<PackedValue> m_lua_globals_data;
Address m_bind_addr;
class EnvAutoLock {
public:
EnvAutoLock(Server *server): m_lock(server->m_env_mutex) {}
private:
std::lock_guard<std::mutex> m_lock;
};
protected:
std::unique_ptr<ServerScripting> m_script;
std::unique_ptr<ServerModManager> m_modmgr;
private:
friend class EmergeThread;
friend class RemoteClient;
friend class TestServerShutdownState;
friend class TestMoveAction;
struct ShutdownState {
friend class TestServerShutdownState;
public:
bool is_requested = false;
bool should_reconnect = false;
std::string message;
void reset();
void trigger(float delay, const std::string &msg, bool reconnect);
void tick(float dtime, Server *server);
std::wstring getShutdownTimerMessage() const;
bool isTimerRunning() const { return m_timer > 0.0f; }
private:
float m_timer = 0.0f;
};
struct PendingDynamicMediaCallback {
std::string filename;
float expiry_timer;
std::unordered_set<session_t> waiting_players;
};
struct SBCHash {
size_t operator() (const std::pair<v3s16, u16> &p) const {
return std::hash<v3s16>()(p.first) ^ p.second;
}
};
typedef std::unordered_map<std::pair<v3s16, u16>, std::string, SBCHash> SerializedBlockCache;
void init();
void SendMovement(session_t peer_id);
void SendHP(session_t peer_id, u16 hp, bool effect);
void SendBreath(session_t peer_id, u16 breath);
void SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
std::string_view custom_reason, bool reconnect = false);
void SendItemDef(session_t peer_id, IItemDefManager *itemdef, u16 protocol_version);
void SendNodeDef(session_t peer_id, const NodeDefManager *nodedef,
u16 protocol_version);
virtual void SendChatMessage(session_t peer_id, const ChatMessage &message);
void SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed);
void SendLocalPlayerAnimations(session_t peer_id, v2f animation_frames[4],
f32 animation_speed);
void SendEyeOffset(session_t peer_id, v3f first, v3f third, v3f third_front);
void SendPlayerPrivileges(session_t peer_id);
void SendPlayerInventoryFormspec(session_t peer_id);
void SendPlayerFormspecPrepend(session_t peer_id);
void SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
const std::string &formname);
void SendHUDAdd(session_t peer_id, u32 id, HudElement *form);
void SendHUDRemove(session_t peer_id, u32 id);
void SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value);
void SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask);
void SendHUDSetParam(session_t peer_id, u16 param, std::string_view value);
void SendSetSky(session_t peer_id, const SkyboxParams ¶ms);
void SendSetSun(session_t peer_id, const SunParams ¶ms);
void SendSetMoon(session_t peer_id, const MoonParams ¶ms);
void SendSetStars(session_t peer_id, const StarParams ¶ms);
void SendCloudParams(session_t peer_id, const CloudParams ¶ms);
void SendOverrideDayNightRatio(session_t peer_id, bool do_override, float ratio);
void SendSetLighting(session_t peer_id, const Lighting &lighting);
void broadcastModChannelMessage(const std::string &channel,
const std::string &message, session_t from_peer);
Send a node removal/addition event to all clients except ignore_id.
Additionally, if far_players!=NULL, players further away than
far_d_nodes are ignored and their peer_ids are added to far_players
*/
void sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players = nullptr,
float far_d_nodes = 100);
void sendAddNode(v3s16 p, MapNode n,
std::unordered_set<u16> *far_players = nullptr,
float far_d_nodes = 100, bool remove_metadata = true);
void sendNodeChangePkt(NetworkPacket &pkt, v3s16 block_pos,
v3f p, float far_d_nodes, std::unordered_set<u16> *far_players);
void sendMetadataChanged(const std::unordered_set<v3s16> &positions,
float far_d_nodes = 100);
void SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver,
u16 net_proto_version, SerializedBlockCache *cache = nullptr);
void SendBlocks(float dtime);
bool addMediaFile(const std::string &filename, const std::string &filepath,
std::string *filedata = nullptr, std::string *digest = nullptr);
void fillMediaCache();
void sendMediaAnnouncement(session_t peer_id, const std::string &lang_code);
void sendRequestedMedia(session_t peer_id,
const std::unordered_set<std::string> &tosend);
void stepPendingDynMediaCallbacks(float dtime);
void SendAddParticleSpawner(const std::string &to_player,
const std::string &exclude_player,
const ParticleSpawnerParameters &p, u16 attached_id, u32 id);
void SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
const ParticleSpawnerParameters &p, u16 attached_id, u32 id);
void SendDeleteParticleSpawner(session_t peer_id, u32 id);
void SendSpawnParticles(RemotePlayer *player,
const std::vector<ParticleParameters> &particles);
void SendSpawnParticles();
void SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao);
void SendActiveObjectMessages(session_t peer_id, const std::string &datas,
bool reliable = true);
void SendCSMRestrictionFlags(session_t peer_id);
Something random
*/
void HandlePlayerDeath(PlayerSAO* sao, const PlayerHPChangeReason &reason);
void DeleteClient(session_t peer_id, ClientDeletionReason reason);
void UpdateCrafting(RemotePlayer *player);
bool checkInteractDistance(RemotePlayer *player, const f32 d, const std::string &what);
void handleChatInterfaceEvent(ChatEvent *evt);
bool checkUserLimit(const std::string &player_name, const std::string &addr_s);
std::wstring handleChat(const std::string &name, std::wstring wmessage_input,
bool check_shout_priv = false, RemotePlayer *player = nullptr);
void handleAdminChat(const ChatEventChat *evt);
RemoteClient* getClient(session_t peer_id, ClientState state_min = CS_Active);
RemoteClient* getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
std::string getPlayerName(session_t peer_id);
PlayerSAO *getPlayerSAO(session_t peer_id);
Get a player from memory or creates one.
If player is already connected, return NULL
Does not verify/modify auth info and password.
Call with env and con locked.
*/
std::unique_ptr<PlayerSAO> emergePlayer(const char *name, session_t peer_id,
u16 proto_version);
Variables
*/
std::mutex m_env_mutex;
std::string m_path_world;
std::string m_path_mod_data;
SubgameSpec m_gamespec;
bool m_simple_singleplayer_mode;
u16 m_max_chatmessage_length;
bool m_dedicated;
Settings *m_game_settings = nullptr;
MutexedVariable<std::string> m_async_fatal_error;
float m_time_of_day_send_timer = 0.0f;
float m_liquid_transform_timer = 0.0f;
float m_liquid_transform_every = 1.0f;
float m_masterserver_timer = 0.0f;
float m_emergethread_trigger_timer = 0.0f;
float m_savemap_timer = 0.0f;
IntervalLimiter m_map_timer_and_unload_interval;
IntervalLimiter m_max_lag_decrease;
ServerEnvironment *m_env = nullptr;
std::shared_ptr<con::IConnection> m_con;
BanManager *m_banmanager = nullptr;
IRollbackManager *m_rollback = nullptr;
std::unique_ptr<EmergeManager> m_emerge;
IWritableItemDefManager *m_itemdef;
NodeDefManager *m_nodedef;
IWritableCraftDefManager *m_craftdef;
std::unordered_map<std::string, Translations> server_translations;
ModIPCStore m_ipcstore;
Threads
*/
std::atomic<StepSettings> m_step_settings{{0.1f, false}};
ServerThread *m_thread = nullptr;
Client interface
*/
ClientInterface m_clients;
std::unordered_map<session_t, std::string> m_formspec_state_data;
Random stuff
*/
ShutdownState m_shutdown_state;
ChatInterface *m_admin_chat;
std::string m_admin_nick;
std::string *const m_shutdown_errmsg;
Map edit event queue. Automatically receives all map edits.
The constructor of this class registers us to receive them through
onMapEditEvent
NOTE: Should these be moved to actually be members of
ServerEnvironment?
*/
Queue of map edits from the environment for sending to the clients
This is behind m_env_mutex
*/
std::queue<MapEditEvent*> m_unsent_map_edit_queue;
If a non-empty area, map edit events contained within are left
unsent. Done at map generation time to speed up editing of the
generated area, as it will be sent anyway.
This is behind m_env_mutex
*/
VoxelArea m_ignore_map_edit_events_area;
std::unordered_map<std::string, MediaInfo> m_media;
std::unordered_map<u32, PendingDynamicMediaCallback> m_pending_dyn_media;
float m_step_pending_dyn_media_timer = 0.0f;
Sounds
*/
std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
s32 m_playing_sounds_id_last_used = 0;
s32 nextSoundId();
ModStorageDatabase *m_mod_storage_database = nullptr;
float m_mod_storage_save_timer = 10.0f;
u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
u32 m_csm_restriction_noderange = 8;
std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
std::unique_ptr<ServerInventoryManager> m_inventory_mgr;
std::unique_ptr<MetricsBackend> m_metrics_backend;
MetricCounterPtr m_uptime_counter;
MetricGaugePtr m_player_gauge;
MetricGaugePtr m_timeofday_gauge;
MetricGaugePtr m_lag_gauge;
MetricCounterPtr m_aom_buffer_counter[2];
MetricCounterPtr m_packet_recv_counter;
MetricCounterPtr m_packet_recv_processed_counter;
MetricCounterPtr m_map_edit_event_counter;
std::unordered_map<std::string, std::vector<ParticleParameters>> m_particles_to_send;
};
Runs a simple dedicated server loop.
Shuts down when kill is set to true.
*/
void dedicated_server_loop(Server &server, volatile std::sig_atomic_t &kill);