Add ModStorageAPI to client side modding (#5396)
[oweals/minetest.git] / src / server.h
index fa732010a6d0e7616843270f0112bc8d467d0245..e1e8f84dc658d035c131d6b80f03b0a7a9f32b00 100644 (file)
@@ -29,30 +29,31 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "mods.h"
 #include "inventorymanager.h"
 #include "subgame.h"
+#include "tileanimation.h" // struct TileAnimationParams
 #include "util/numeric.h"
 #include "util/thread.h"
-#include "environment.h"
+#include "util/basic_macros.h"
+#include "serverenvironment.h"
+#include "chat_interface.h"
 #include "clientiface.h"
+#include "remoteplayer.h"
 #include "network/networkpacket.h"
 #include <string>
 #include <list>
 #include <map>
 #include <vector>
 
-#define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
-
 class IWritableItemDefManager;
 class IWritableNodeDefManager;
 class IWritableCraftDefManager;
 class BanManager;
 class EventManager;
 class Inventory;
-class Player;
 class PlayerSAO;
 class IRollbackManager;
 struct RollbackAction;
 class EmergeManager;
-class GameScripting;
+class ServerScripting;
 class ServerEnvironment;
 struct SimpleSoundSpec;
 class ServerThread;
@@ -63,31 +64,6 @@ enum ClientDeletionReason {
        CDR_DENY
 };
 
-class MapEditEventIgnorer
-{
-public:
-       MapEditEventIgnorer(bool *flag):
-               m_flag(flag)
-       {
-               if(*m_flag == false)
-                       *m_flag = true;
-               else
-                       m_flag = NULL;
-       }
-
-       ~MapEditEventIgnorer()
-       {
-               if(m_flag)
-               {
-                       assert(*m_flag);
-                       *m_flag = false;
-               }
-       }
-
-private:
-       bool *m_flag;
-};
-
 class MapEditEventAreaIgnorer
 {
 public:
@@ -156,7 +132,7 @@ struct ServerSoundParams
 struct ServerPlayingSound
 {
        ServerSoundParams params;
-       std::set<u16> clients; // peer ids
+       UNORDERED_SET<u16> clients; // peer ids
 };
 
 class Server : public con::PeerHandler, public MapEventReceiver,
@@ -171,7 +147,8 @@ public:
                const std::string &path_world,
                const SubgameSpec &gamespec,
                bool simple_singleplayer_mode,
-               bool ipv6
+               bool ipv6,
+               ChatInterface *iface = NULL
        );
        ~Server();
        void start(Address bind_addr);
@@ -204,7 +181,6 @@ public:
        void handleCommand_InventoryAction(NetworkPacket* pkt);
        void handleCommand_ChatMessage(NetworkPacket* pkt);
        void handleCommand_Damage(NetworkPacket* pkt);
-       void handleCommand_Breath(NetworkPacket* pkt);
        void handleCommand_Password(NetworkPacket* pkt);
        void handleCommand_PlayerItem(NetworkPacket* pkt);
        void handleCommand_Respawn(NetworkPacket* pkt);
@@ -220,10 +196,13 @@ public:
 
        void Send(NetworkPacket* pkt);
 
+       // Helper for handleCommand_PlayerPos and handleCommand_Interact
+       void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
+               NetworkPacket *pkt);
+
        // Both setter and getter need no envlock,
        // can be called freely from threads
        void setTimeOfDay(u32 time);
-       inline u32 getTimeOfDay();
 
        /*
                Shall be called with the environment locked.
@@ -240,13 +219,12 @@ public:
 
        // Connection must be locked when called
        std::wstring getStatusString();
+       inline double getUptime() const { return m_uptime.m_value; }
 
        // read shutdown state
-       inline bool getShutdownRequested()
-                       { return m_shutdown_requested; }
+       inline bool getShutdownRequested() const { return m_shutdown_requested; }
 
        // request server to shutdown
-       inline void requestShutdown() { m_shutdown_requested = true; }
        void requestShutdown(const std::string &msg, bool reconnect)
        {
                m_shutdown_requested = true;
@@ -274,7 +252,9 @@ public:
        void spawnParticle(const std::string &playername,
                v3f pos, v3f velocity, v3f acceleration,
                float expirationtime, float size,
-               bool collisiondetection, bool vertical, const std::string &texture);
+               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,
@@ -282,16 +262,19 @@ public:
                v3f minacc, v3f maxacc,
                float minexptime, float maxexptime,
                float minsize, float maxsize,
-               bool collisiondetection, bool vertical, const std::string &texture,
-               const std::string &playername);
+               bool collisiondetection, bool collision_removal,
+               ServerActiveObject *attached,
+               bool vertical, const std::string &texture,
+               const std::string &playername, const struct TileAnimationParams &animation,
+               u8 glow);
 
        void deleteParticleSpawner(const std::string &playername, u32 id);
 
        // Creates or resets inventory
-       Inventory* createDetachedInventory(const std::string &name);
+       Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
 
        // Envlock and conlock should be locked when using scriptapi
-       GameScripting *getScriptIface(){ return m_script; }
+       ServerScripting *getScriptIface(){ return m_script; }
 
        // actions: time-reversed list
        // Return value: success/failure
@@ -303,24 +286,21 @@ public:
        virtual IItemDefManager* getItemDefManager();
        virtual INodeDefManager* getNodeDefManager();
        virtual ICraftDefManager* getCraftDefManager();
-       virtual ITextureSource* getTextureSource();
-       virtual IShaderSource* getShaderSource();
        virtual u16 allocateUnknownNodeId(const std::string &name);
-       virtual ISoundManager* getSoundManager();
        virtual MtEventManager* getEventManager();
-       virtual scene::ISceneManager* getSceneManager();
-       virtual IRollbackManager *getRollbackManager() { return m_rollback; }
+       IRollbackManager *getRollbackManager() { return m_rollback; }
        virtual EmergeManager *getEmergeManager() { return m_emerge; }
 
        IWritableItemDefManager* getWritableItemDefManager();
        IWritableNodeDefManager* getWritableNodeDefManager();
        IWritableCraftDefManager* getWritableCraftDefManager();
 
-       const ModSpec* getModSpec(const std::string &modname) const;
+       virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
+       virtual const ModSpec* getModSpec(const std::string &modname) const;
        void getModNames(std::vector<std::string> &modlist);
        std::string getBuiltinLuaPath();
-       inline std::string getWorldPath() const
-                       { return m_path_world; }
+       virtual std::string getWorldPath() const { return m_path_world; }
+       virtual std::string getModStoragePath() const;
 
        inline bool isSingleplayer()
                        { return m_simple_singleplayer_mode; }
@@ -332,28 +312,32 @@ public:
        Map & getMap() { return m_env->getMap(); }
        ServerEnvironment & getEnv() { return *m_env; }
 
-       u32 hudAdd(Player *player, HudElement *element);
-       bool hudRemove(Player *player, u32 id);
-       bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
-       bool hudSetFlags(Player *player, u32 flags, u32 mask);
-       bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
-       s32 hudGetHotbarItemcount(Player *player);
-       void hudSetHotbarImage(Player *player, std::string name);
-       std::string hudGetHotbarImage(Player *player);
-       void hudSetHotbarSelectedImage(Player *player, std::string name);
-       std::string hudGetHotbarSelectedImage(Player *player);
+       u32 hudAdd(RemotePlayer *player, 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);
+       s32 hudGetHotbarItemcount(RemotePlayer *player) const
+                       { return player->getHotbarItemcount(); }
+       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
+       {
+               return player->getHotbarSelectedImage();
+       }
 
        inline Address getPeerAddress(u16 peer_id)
                        { return m_con.GetPeerAddress(peer_id); }
 
-       bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
-       bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
+       bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
+                       f32 frame_speed);
+       bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
 
-       bool setSky(Player *player, const video::SColor &bgcolor,
+       bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
                        const std::string &type, const std::vector<std::string> &params);
 
-       bool overrideDayNightRatio(Player *player, bool do_override,
-                       float brightness);
+       bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
 
        /* con::PeerHandler implementation. */
        void peerAdded(con::Peer *peer);
@@ -370,14 +354,22 @@ public:
                        u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
                        std::string* vers_string);
 
+       void printToConsoleOnly(const std::string &text);
+
        void SendPlayerHPOrDie(PlayerSAO *player);
-       void SendPlayerBreath(u16 peer_id);
+       void SendPlayerBreath(PlayerSAO *sao);
        void SendInventory(PlayerSAO* playerSAO);
        void SendMovePlayer(u16 peer_id);
 
+       virtual bool registerModStorage(ModMetadata *storage);
+       virtual void unregisterModStorage(const std::string &name);
+
        // Bind address
        Address m_bind_addr;
 
+       // Environment mutex (envlock)
+       Mutex m_env_mutex;
+
 private:
 
        friend class EmergeThread;
@@ -443,21 +435,27 @@ private:
        void sendDetachedInventories(u16 peer_id);
 
        // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
-       void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
+       void SendAddParticleSpawner(u16 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 vertical, std::string texture, u32 id);
+               bool collisiondetection, bool collision_removal,
+               u16 attached_id,
+               bool vertical, const std::string &texture, u32 id,
+               const struct TileAnimationParams &animation, u8 glow);
 
        void SendDeleteParticleSpawner(u16 peer_id, u32 id);
 
        // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
-       void SendSpawnParticle(u16 peer_id,
+       void SendSpawnParticle(u16 peer_id, u16 protocol_version,
                v3f pos, v3f velocity, v3f acceleration,
                float expirationtime, float size,
-               bool collisiondetection, bool vertical, std::string texture);
+               bool collisiondetection, bool collision_removal,
+               bool vertical, const std::string &texture,
+               const struct TileAnimationParams &animation, u8 glow);
 
        u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
        void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
@@ -468,7 +466,16 @@ private:
        void DiePlayer(u16 peer_id);
        void RespawnPlayer(u16 peer_id);
        void DeleteClient(u16 peer_id, ClientDeletionReason reason);
-       void UpdateCrafting(Player *player);
+       void UpdateCrafting(RemotePlayer *player);
+
+       void handleChatInterfaceEvent(ChatEvent *evt);
+
+       // This returns the answer to the sender of wmessage, or "" if there is none
+       std::wstring handleChat(const std::string &name, const std::wstring &wname,
+               const std::wstring &wmessage,
+               bool check_shout_priv = false,
+               RemotePlayer *player = NULL);
+       void handleAdminChat(const ChatEventChat *evt);
 
        v3f findSpawnPos();
 
@@ -502,6 +509,7 @@ private:
        // If true, do not allow multiple players and hide some multiplayer
        // functionality
        bool m_simple_singleplayer_mode;
+       u16 m_max_chatmessage_length;
 
        // Thread can set; step() will throw as ServerError
        MutexedVariable<std::string> m_async_fatal_error;
@@ -509,16 +517,13 @@ private:
        // Some timers
        float m_liquid_transform_timer;
        float m_liquid_transform_every;
-       float m_print_info_timer;
        float m_masterserver_timer;
-       float m_objectdata_timer;
        float m_emergethread_trigger_timer;
        float m_savemap_timer;
        IntervalLimiter m_map_timer_and_unload_interval;
 
        // Environment
        ServerEnvironment *m_env;
-       Mutex m_env_mutex;
 
        // server connection
        con::Connection m_con;
@@ -535,7 +540,7 @@ private:
 
        // Scripting
        // Envlock and conlock should be locked when using Lua
-       GameScripting *m_script;
+       ServerScripting *m_script;
 
        // Item definition manager
        IWritableItemDefManager *m_itemdef;
@@ -575,7 +580,6 @@ private:
        float m_time_of_day_send_timer;
        // Uptime of server in seconds
        MutexedVariable<double> m_uptime;
-
        /*
         Client interface
         */
@@ -596,6 +600,9 @@ private:
        std::string m_shutdown_msg;
        bool m_shutdown_ask_reconnect;
 
+       ChatInterface *m_admin_chat;
+       std::string m_admin_nick;
+
        /*
                Map edit event queue. Automatically receives all map edits.
                The constructor of this class registers us to receive them through
@@ -631,12 +638,12 @@ private:
        u16 m_ignore_map_edit_events_peer_id;
 
        // media files known to server
-       std::map<std::string,MediaInfo> m_media;
+       UNORDERED_MAP<std::string, MediaInfo> m_media;
 
        /*
                Sounds
        */
-       std::map<s32, ServerPlayingSound> m_playing_sounds;
+       UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
        s32 m_next_sound_id;
 
        /*
@@ -644,11 +651,13 @@ private:
        */
        // 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;
 
-       /*
-               Particles
-       */
-       std::vector<u32> m_particlespawner_ids;
+       UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
+       float m_mod_storage_save_timer;
+
+       DISABLE_CLASS_COPY(Server);
 };
 
 /*