]> git.lizzy.rs Git - minetest.git/blobdiff - src/server.h
Exposing the zoom key to Lua API (#9903)
[minetest.git] / src / server.h
index 86f558d544048aef0f2175c498c890dc73f8621d..f44716531f2d3c6cf49576f6ee2f64ed8bc42ac7 100644 (file)
@@ -24,15 +24,17 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "hud.h"
 #include "gamedef.h"
 #include "serialization.h" // For SER_FMT_VER_INVALID
-#include "mods.h"
+#include "content/mods.h"
 #include "inventorymanager.h"
-#include "subgame.h"
-#include "tileanimation.h" // struct TileAnimationParams
+#include "content/subgames.h"
+#include "tileanimation.h" // TileAnimationParams
+#include "particles.h" // ParticleParams
 #include "network/peerhandler.h"
 #include "network/address.h"
 #include "util/numeric.h"
 #include "util/thread.h"
 #include "util/basic_macros.h"
+#include "util/metricsbackend.h"
 #include "serverenvironment.h"
 #include "clientiface.h"
 #include "chatmessage.h"
@@ -45,7 +47,7 @@ class ChatEvent;
 struct ChatEventChat;
 struct ChatInterface;
 class IWritableItemDefManager;
-class IWritableNodeDefManager;
+class NodeDefManager;
 class IWritableCraftDefManager;
 class BanManager;
 class EventManager;
@@ -53,13 +55,21 @@ class Inventory;
 class ModChannelMgr;
 class RemotePlayer;
 class PlayerSAO;
+struct PlayerHPChangeReason;
 class IRollbackManager;
 struct RollbackAction;
 class EmergeManager;
 class ServerScripting;
 class ServerEnvironment;
 struct SimpleSoundSpec;
+struct CloudParams;
+struct SkyboxParams;
+struct SunParams;
+struct MoonParams;
+struct StarParams;
 class ServerThread;
+class ServerModManager;
+class ServerInventoryManager;
 
 enum ClientDeletionReason {
        CDR_LEAVE,
@@ -95,6 +105,7 @@ struct ServerSoundParams
        v3f pos;
        u16 object = 0;
        std::string to_player = "";
+       std::string exclude_player = "";
 
        v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
 };
@@ -107,7 +118,7 @@ struct ServerPlayingSound
 };
 
 class Server : public con::PeerHandler, public MapEventReceiver,
-               public InventoryManager, public IGameDef
+               public IGameDef
 {
 public:
        /*
@@ -156,7 +167,6 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        void handleCommand_InventoryAction(NetworkPacket* pkt);
        void handleCommand_ChatMessage(NetworkPacket* pkt);
        void handleCommand_Damage(NetworkPacket* pkt);
-       void handleCommand_Password(NetworkPacket* pkt);
        void handleCommand_PlayerItem(NetworkPacket* pkt);
        void handleCommand_Respawn(NetworkPacket* pkt);
        void handleCommand_Interact(NetworkPacket* pkt);
@@ -185,27 +195,22 @@ class Server : public con::PeerHandler, public MapEventReceiver,
                This is accessed by the map, which is inside the environment,
                so it shouldn't be a problem.
        */
-       void onMapEditEvent(MapEditEvent *event);
-
-       /*
-               Shall be called with the environment and the connection locked.
-       */
-       Inventory* getInventory(const InventoryLocation &loc);
-       void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
+       void onMapEditEvent(const MapEditEvent &event);
 
        // Connection must be locked when called
        std::wstring getStatusString();
-       inline double getUptime() const { return m_uptime.m_value; }
+       inline double getUptime() const { return m_uptime_counter->get(); }
 
        // read shutdown state
-       inline bool getShutdownRequested() const { return m_shutdown_requested; }
+       inline bool isShutdownRequested() const { return m_shutdown_state.is_requested; }
 
        // request server to shutdown
        void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
 
        // Returns -1 if failed, sound handle on success
        // Envlock
-       s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
+       s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params,
+                       bool ephemeral=false);
        void stopSound(s32 handle);
        void fadeSound(s32 handle, float step, float gain);
 
@@ -214,6 +219,7 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        bool checkPriv(const std::string &name, const std::string &priv);
        void reportPrivsModified(const std::string &name=""); // ""=all
        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);
@@ -221,29 +227,19 @@ class Server : public con::PeerHandler, public MapEventReceiver,
 
        void notifyPlayer(const char *name, const std::wstring &msg);
        void notifyPlayers(const std::wstring &msg);
+
        void spawnParticle(const std::string &playername,
-               v3f pos, v3f velocity, v3f acceleration,
-               float expirationtime, float size,
-               bool collisiondetection, bool collision_removal,
-               bool vertical, const std::string &texture,
-               const struct TileAnimationParams &animation, u8 glow);
-
-       u32 addParticleSpawner(u16 amount, float spawntime,
-               v3f minpos, v3f maxpos,
-               v3f minvel, v3f maxvel,
-               v3f minacc, v3f maxacc,
-               float minexptime, float maxexptime,
-               float minsize, float maxsize,
-               bool collisiondetection, bool collision_removal,
-               ServerActiveObject *attached,
-               bool vertical, const std::string &texture,
-               const std::string &playername, const struct TileAnimationParams &animation,
-               u8 glow);
+               const ParticleParameters &p);
+
+       u32 addParticleSpawner(const ParticleSpawnerParameters &p,
+               ServerActiveObject *attached, const std::string &playername);
 
        void deleteParticleSpawner(const std::string &playername, u32 id);
 
-       // Creates or resets inventory
-       Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
+       bool dynamicAddMedia(const std::string &filepath);
+
+       ServerInventoryManager *getInventoryMgr() const { return m_inventory_mgr.get(); }
+       void sendDetachedInventory(Inventory *inventory, const std::string &name, session_t peer_id);
 
        // Envlock and conlock should be locked when using scriptapi
        ServerScripting *getScriptIface(){ return m_script; }
@@ -256,18 +252,17 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        // IGameDef interface
        // Under envlock
        virtual IItemDefManager* getItemDefManager();
-       virtual INodeDefManager* getNodeDefManager();
+       virtual const NodeDefManager* getNodeDefManager();
        virtual ICraftDefManager* getCraftDefManager();
        virtual u16 allocateUnknownNodeId(const std::string &name);
-       virtual MtEventManager* getEventManager();
        IRollbackManager *getRollbackManager() { return m_rollback; }
        virtual EmergeManager *getEmergeManager() { return m_emerge; }
 
        IWritableItemDefManager* getWritableItemDefManager();
-       IWritableNodeDefManager* getWritableNodeDefManager();
+       NodeDefManager* getWritableNodeDefManager();
        IWritableCraftDefManager* getWritableCraftDefManager();
 
-       virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
+       virtual const std::vector<ModSpec> &getMods() const;
        virtual const ModSpec* getModSpec(const std::string &modname) const;
        void getModNames(std::vector<std::string> &modlist);
        std::string getBuiltinLuaPath();
@@ -290,29 +285,23 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        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);
-       s32 hudGetHotbarItemcount(RemotePlayer *player) const;
-       void hudSetHotbarImage(RemotePlayer *player, std::string name);
-       std::string hudGetHotbarImage(RemotePlayer *player);
-       void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
-       const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const;
+       void hudSetHotbarImage(RemotePlayer *player, const std::string &name);
+       void hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name);
 
        Address getPeerAddress(session_t peer_id);
 
-       bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
+       void setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
                        f32 frame_speed);
-       bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
+       void setPlayerEyeOffset(RemotePlayer *player, const v3f &first, const v3f &third);
 
-       bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
-                       const std::string &type, const std::vector<std::string> &params,
-                       bool &clouds);
-       bool setClouds(RemotePlayer *player, float density,
-                       const video::SColor &color_bright,
-                       const video::SColor &color_ambient,
-                       float height,
-                       float thickness,
-                       const v2f &speed);
+       void setSky(RemotePlayer *player, const SkyboxParams &params);
+       void setSun(RemotePlayer *player, const SunParams &params);
+       void setMoon(RemotePlayer *player, const MoonParams &params);
+       void setStars(RemotePlayer *player, const StarParams &params);
 
-       bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
+       void setClouds(RemotePlayer *player, const CloudParams &params);
+
+       void overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
 
        /* con::PeerHandler implementation. */
        void peerAdded(con::Peer *peer);
@@ -329,14 +318,18 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        bool getClientConInfo(session_t peer_id, con::rtt_stat_type type, float *retval);
        bool getClientInfo(session_t peer_id, ClientState *state, u32 *uptime,
                        u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
-                       std::string* vers_string);
+                       std::string* vers_string, std::string* lang_code);
 
        void printToConsoleOnly(const std::string &text);
 
-       void SendPlayerHPOrDie(PlayerSAO *player);
+       void SendPlayerHPOrDie(PlayerSAO *player, const PlayerHPChangeReason &reason);
        void SendPlayerBreath(PlayerSAO *sao);
-       void SendInventory(PlayerSAO* playerSAO);
+       void SendInventory(PlayerSAO *playerSAO, bool incremental);
        void SendMovePlayer(session_t peer_id);
+       void SendPlayerSpeed(session_t peer_id, const v3f &added_vel);
+       void SendPlayerFov(session_t peer_id);
+
+       void sendDetachedInventories(session_t peer_id, bool incremental);
 
        virtual bool registerModStorage(ModMetadata *storage);
        virtual void unregisterModStorage(const std::string &name);
@@ -346,6 +339,12 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        bool sendModChannelMessage(const std::string &channel, const std::string &message);
        ModChannel *getModChannel(const std::string &channel);
 
+       // Send block to specific player only
+       bool SendBlock(session_t peer_id, const v3s16 &blockpos);
+
+       // Load translations for a language
+       void loadTranslationLanguage(const std::string &lang_code);
+
        // Bind address
        Address m_bind_addr;
 
@@ -353,9 +352,27 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        std::mutex m_env_mutex;
 
 private:
-
        friend class EmergeThread;
        friend class RemoteClient;
+       friend class TestServerShutdownState;
+
+       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;
+       };
+
+       void init();
 
        void SendMovement(session_t peer_id);
        void SendHP(session_t peer_id, u16 hp);
@@ -366,13 +383,14 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        void SendDeathscreen(session_t peer_id, bool set_camera_point_target,
                v3f camera_point_target);
        void SendItemDef(session_t peer_id, IItemDefManager *itemdef, u16 protocol_version);
-       void SendNodeDef(session_t peer_id, INodeDefManager *nodedef, u16 protocol_version);
+       void SendNodeDef(session_t peer_id, const NodeDefManager *nodedef,
+               u16 protocol_version);
 
        /* mark blocks not sent for all clients */
        void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
 
 
-       void SendChatMessage(session_t peer_id, const ChatMessage &message);
+       virtual void SendChatMessage(session_t peer_id, const ChatMessage &message);
        void SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed);
        void SendPlayerHP(session_t peer_id);
 
@@ -381,6 +399,7 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        void SendEyeOffset(session_t peer_id, v3f first, v3f third);
        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);
@@ -388,15 +407,11 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        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, const std::string &value);
-       void SendSetSky(session_t peer_id, const video::SColor &bgcolor,
-                       const std::string &type, const std::vector<std::string> &params,
-                       bool &clouds);
-       void SendCloudParams(session_t peer_id, float density,
-                       const video::SColor &color_bright,
-                       const video::SColor &color_ambient,
-                       float height,
-                       float thickness,
-                       const v2f &speed);
+       void SendSetSky(session_t peer_id, const SkyboxParams &params);
+       void SendSetSun(session_t peer_id, const SunParams &params);
+       void SendSetMoon(session_t peer_id, const MoonParams &params);
+       void SendSetStars(session_t peer_id, const StarParams &params);
+       void SendCloudParams(session_t peer_id, const CloudParams &params);
        void SendOverrideDayNightRatio(session_t peer_id, bool do_override, float ratio);
        void broadcastModChannelMessage(const std::string &channel,
                        const std::string &message, session_t from_peer);
@@ -407,12 +422,14 @@ class Server : public con::PeerHandler, public MapEventReceiver,
                far_d_nodes are ignored and their peer_ids are added to far_players
        */
        // Envlock and conlock should be locked when calling these
-       void sendRemoveNode(v3s16 p, u16 ignore_id=0,
-                       std::vector<u16> *far_players=NULL, float far_d_nodes=100);
-       void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
-                       std::vector<u16> *far_players=NULL, float far_d_nodes=100,
-                       bool remove_metadata=true);
-       void setBlockNotSent(v3s16 p);
+       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 sendMetadataChanged(const std::list<v3s16> &meta_updates,
+                       float far_d_nodes = 100);
 
        // Environment and Connection must be locked when called
        void SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
@@ -420,50 +437,37 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        // Sends blocks to clients (locks env and con on its own)
        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::vector<std::string> &tosend);
 
-       void sendDetachedInventory(const std::string &name, session_t peer_id);
-       void sendDetachedInventories(session_t peer_id);
-
        // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
        void SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
-               u16 amount, float spawntime,
-               v3f minpos, v3f maxpos,
-               v3f minvel, v3f maxvel,
-               v3f minacc, v3f maxacc,
-               float minexptime, float maxexptime,
-               float minsize, float maxsize,
-               bool collisiondetection, bool collision_removal,
-               u16 attached_id,
-               bool vertical, const std::string &texture, u32 id,
-               const struct TileAnimationParams &animation, u8 glow);
+               const ParticleSpawnerParameters &p, u16 attached_id, u32 id);
 
        void SendDeleteParticleSpawner(session_t peer_id, u32 id);
 
        // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
        void SendSpawnParticle(session_t peer_id, u16 protocol_version,
-               v3f pos, v3f velocity, v3f acceleration,
-               float expirationtime, float size,
-               bool collisiondetection, bool collision_removal,
-               bool vertical, const std::string &texture,
-               const struct TileAnimationParams &animation, u8 glow);
+               const ParticleParameters &p);
 
-       u32 SendActiveObjectRemoveAdd(session_t peer_id, const std::string &datas);
+       void SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao);
        void SendActiveObjectMessages(session_t peer_id, const std::string &datas,
                bool reliable = true);
-       void SendCSMFlavourLimits(session_t peer_id);
+       void SendCSMRestrictionFlags(session_t peer_id);
 
        /*
                Something random
        */
 
-       void DiePlayer(session_t peer_id);
+       void DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason);
        void RespawnPlayer(session_t peer_id);
        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);
 
@@ -496,7 +500,6 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        /*
                Variables
        */
-
        // World directory
        std::string m_path_world;
        // Subgame specification
@@ -530,7 +533,6 @@ class Server : public con::PeerHandler, public MapEventReceiver,
 
        // Rollback manager (behind m_env_mutex)
        IRollbackManager *m_rollback = nullptr;
-       bool m_enable_rollback_recording = false; // Updated once in a while
 
        // Emerge manager
        EmergeManager *m_emerge = nullptr;
@@ -543,7 +545,7 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        IWritableItemDefManager *m_itemdef;
 
        // Node definition manager
-       IWritableNodeDefManager *m_nodedef;
+       NodeDefManager *m_nodedef;
 
        // Craft definition manager
        IWritableCraftDefManager *m_craftdef;
@@ -552,34 +554,28 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        EventManager *m_event;
 
        // Mods
-       std::vector<ModSpec> m_mods;
+       std::unique_ptr<ServerModManager> m_modmgr;
 
        /*
                Threads
        */
-
        // A buffer for time steps
        // step() increments and AsyncRunStep() run by m_thread reads it.
        float m_step_dtime = 0.0f;
        std::mutex m_step_dtime_mutex;
 
-       // current server step lag counter
-       float m_lag;
-
        // The server mainly operates in this thread
        ServerThread *m_thread = nullptr;
 
        /*
                Time related stuff
        */
-
        // Timer for sending time of day over network
        float m_time_of_day_send_timer = 0.0f;
-       // Uptime of server in seconds
-       MutexedVariable<double> m_uptime;
+
        /*
-        Client interface
-        */
+               Client interface
+       */
        ClientInterface m_clients;
 
        /*
@@ -589,14 +585,13 @@ class Server : public con::PeerHandler, public MapEventReceiver,
        */
        std::queue<con::PeerChange> m_peer_change_queue;
 
+       std::unordered_map<session_t, std::string> m_formspec_state_data;
+
        /*
                Random stuff
        */
 
-       bool m_shutdown_requested = false;
-       std::string m_shutdown_msg;
-       bool m_shutdown_ask_reconnect = false;
-       float m_shutdown_timer = 0.0f;
+       ShutdownState m_shutdown_state;
 
        ChatInterface *m_admin_chat;
        std::string m_admin_nick;
@@ -615,12 +610,6 @@ class Server : public con::PeerHandler, public MapEventReceiver,
                This is behind m_env_mutex
        */
        std::queue<MapEditEvent*> m_unsent_map_edit_queue;
-       /*
-               Set to true when the server itself is modifying the map and does
-               all sending of information by itself.
-               This is behind m_env_mutex
-       */
-       bool m_ignore_map_edit_events = false;
        /*
                If a non-empty area, map edit events contained within are left
                unsent. Done at map generation time to speed up editing of the
@@ -628,12 +617,6 @@ class Server : public con::PeerHandler, public MapEventReceiver,
                This is behind m_env_mutex
        */
        VoxelArea m_ignore_map_edit_events_area;
-       /*
-               If set to !=0, the incoming MapEditEvents are modified to have
-               this peed id as the disabled recipient
-               This is behind m_env_mutex
-       */
-       session_t m_ignore_map_edit_events_peer_id = 0;
 
        // media files known to server
        std::unordered_map<std::string, MediaInfo> m_media;
@@ -642,25 +625,34 @@ class Server : public con::PeerHandler, public MapEventReceiver,
                Sounds
        */
        std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
-       s32 m_next_sound_id = 0;
-
-       /*
-               Detached inventories (behind m_env_mutex)
-       */
-       // key = name
-       std::map<std::string, Inventory*> m_detached_inventories;
-       // value = "" (visible to all players) or player name
-       std::map<std::string, std::string> m_detached_inventories_player;
+       s32 m_next_sound_id = 0; // positive values only
+       s32 nextSoundId();
 
        std::unordered_map<std::string, ModMetadata *> m_mod_storages;
        float m_mod_storage_save_timer = 10.0f;
 
-       // CSM flavour limits byteflag
-       u64 m_csm_flavour_limits = CSMFlavourLimit::CSM_FL_NONE;
-       u32 m_csm_noderange_limit = 8;
+       // CSM restrictions byteflag
+       u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
+       u32 m_csm_restriction_noderange = 8;
 
        // ModChannel manager
        std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
+
+       // Inventory manager
+       std::unique_ptr<ServerInventoryManager> m_inventory_mgr;
+
+       // Global server metrics backend
+       std::unique_ptr<MetricsBackend> m_metrics_backend;
+
+       // Server metrics
+       MetricCounterPtr m_uptime_counter;
+       MetricGaugePtr m_player_gauge;
+       MetricGaugePtr m_timeofday_gauge;
+       // current server step lag
+       MetricGaugePtr m_lag_gauge;
+       MetricCounterPtr m_aom_buffer_counter;
+       MetricCounterPtr m_packet_recv_counter;
+       MetricCounterPtr m_packet_recv_processed_counter;
 };
 
 /*