Fix sound direction and add experimental:soundblock alias sb in minimal for testing
[oweals/minetest.git] / src / server.h
index 6bee106855b98efb6c527c01df2a6a4479a9ebc3..9cbefa6440295bc87c0d19747cc98637ba892b9c 100644 (file)
@@ -17,10 +17,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-/*
-(c) 2010 Perttu Ahola <celeron55@gmail.com>
-*/
-
 #ifndef SERVER_HEADER
 #define SERVER_HEADER
 
@@ -28,11 +24,40 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "environment.h"
 #include "common_irrlicht.h"
 #include <string>
-#include "utility.h"
 #include "porting.h"
 #include "map.h"
 #include "inventory.h"
-#include "auth.h"
+#include "ban.h"
+#include "gamedef.h"
+#include "serialization.h" // For SER_FMT_VER_INVALID
+#include "mods.h"
+#include "inventorymanager.h"
+#include "subgame.h"
+#include "sound.h"
+struct LuaState;
+typedef struct lua_State lua_State;
+class IWritableItemDefManager;
+class IWritableNodeDefManager;
+class IWritableCraftDefManager;
+class EventManager;
+class PlayerSAO;
+
+class ServerError : public std::exception
+{
+public:
+       ServerError(const std::string &s)
+       {
+               m_s = "ServerError: ";
+               m_s += s;
+       }
+       virtual ~ServerError() throw()
+       {}
+       virtual const char * what() const throw()
+       {
+               return m_s.c_str();
+       }
+       std::string m_s;
+};
 
 /*
        Some random functions
@@ -205,8 +230,6 @@ struct PlayerInfo
        void PrintLine(std::ostream *s);
 };
 
-u32 PIChecksum(core::list<PlayerInfo> &l);
-
 /*
        Used for queueing and sorting block transfers in containers
        
@@ -229,6 +252,61 @@ struct PrioritySortedBlockTransfer
        u16 peer_id;
 };
 
+struct MediaRequest
+{
+       std::string name;
+
+       MediaRequest(const std::string &name_=""):
+               name(name_)
+       {}
+};
+
+struct MediaInfo
+{
+       std::string path;
+       std::string sha1_digest;
+
+       MediaInfo(const std::string path_="",
+                       const std::string sha1_digest_=""):
+               path(path_),
+               sha1_digest(sha1_digest_)
+       {
+       }
+};
+
+struct ServerSoundParams
+{
+       float gain;
+       std::string to_player;
+       enum Type{
+               SSP_LOCAL=0,
+               SSP_POSITIONAL=1,
+               SSP_OBJECT=2
+       } type;
+       v3f pos;
+       u16 object;
+       float max_hear_distance;
+       bool loop;
+
+       ServerSoundParams():
+               gain(1.0),
+               to_player(""),
+               type(SSP_LOCAL),
+               pos(0,0,0),
+               object(0),
+               max_hear_distance(32*BS),
+               loop(false)
+       {}
+       
+       v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
+};
+
+struct ServerPlayingSound
+{
+       ServerSoundParams params;
+       std::set<u16> clients; // peer ids
+};
+
 class RemoteClient
 {
 public:
@@ -239,16 +317,22 @@ public:
        u16 peer_id;
        // The serialization version to use with the client
        u8 serialization_version;
+       //
+       u16 net_proto_version;
        // Version is stored in here after INIT before INIT2
        u8 pending_serialization_version;
 
+       bool definitions_sent;
+
        RemoteClient():
                m_time_from_building(9999),
                m_excess_gotblocks(0)
        {
                peer_id = 0;
                serialization_version = SER_FMT_VER_INVALID;
+               net_proto_version = 0;
                pending_serialization_version = SER_FMT_VER_INVALID;
+               definitions_sent = false;
                m_nearest_unsent_d = 0;
                m_nearest_unsent_reset_timer = 0.0;
                m_nothing_to_send_counter = 0;
@@ -266,17 +350,6 @@ public:
        void GetNextBlocks(Server *server, float dtime,
                        core::array<PrioritySortedBlockTransfer> &dest);
 
-       /*
-               Connection and environment should be locked when this is called.
-               steps() objects of blocks not found in active_blocks, then
-               adds those blocks to active_blocks
-       */
-       void SendObjectData(
-                       Server *server,
-                       float dtime,
-                       core::map<v3s16, bool> &stepped_blocks
-               );
-
        void GotBlock(v3s16 p);
 
        void SentBlock(v3s16 p);
@@ -360,15 +433,19 @@ private:
 };
 
 class Server : public con::PeerHandler, public MapEventReceiver,
-               public InventoryManager
+               public InventoryManager, public IGameDef,
+               public IBackgroundBlockEmerger
 {
 public:
        /*
                NOTE: Every public method should be thread-safe
        */
-
+       
        Server(
-               std::string mapsavedir
+               const std::string &path_world,
+               const std::string &path_config,
+               const SubgameSpec &gamespec,
+               bool simple_singleplayer_mode
        );
        ~Server();
        void start(unsigned short port);
@@ -383,15 +460,10 @@ public:
 
        core::list<PlayerInfo> getPlayerInfo();
 
-       /*u32 getDayNightRatio()
-       {
-               return time_to_daynight_ratio(m_time_of_day.get());
-       }*/
-       
        // Environment must be locked when called
        void setTimeOfDay(u32 time)
        {
-               m_env.setTimeOfDay(time);
+               m_env->setTimeOfDay(time);
                m_time_of_day_send_timer = 0;
        }
 
@@ -410,8 +482,9 @@ public:
        /*
                Shall be called with the environment and the connection locked.
        */
-       Inventory* getInventory(InventoryContext *c, std::string id);
-       void inventoryModified(InventoryContext *c, std::string id);
+       Inventory* getInventory(const InventoryLocation &loc);
+       std::string getInventoryOwner(const InventoryLocation &loc);
+       void setInventoryModified(const InventoryLocation &loc);
 
        // Connection must be locked when called
        std::wstring getStatusString();
@@ -421,31 +494,74 @@ public:
                m_shutdown_requested = true;
        }
 
-
-       // Envlock and conlock should be locked when calling this
-       void SendMovePlayer(Player *player);
+       // Returns -1 if failed, sound handle on success
+       // Envlock + conlock
+       s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
+       void stopSound(s32 handle);
        
-       u64 getPlayerAuthPrivs(const std::string &name)
+       // Envlock + conlock
+       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=""); // ""=all
+
+       // Saves g_settings to configpath given at initialization
+       void saveConfig();
+
+       void setIpBanned(const std::string &ip, const std::string &name)
        {
-               try{
-                       return m_authmanager.getPrivs(name);
-               }
-               catch(AuthNotFoundException &e)
-               {
-                       dstream<<"WARNING: Auth not found for "<<name<<std::endl;
-                       return 0;
-               }
+               m_banmanager.add(ip, name);
+               return;
        }
 
-       void setPlayerAuthPrivs(const std::string &name, u64 privs)
+       void unsetIpBanned(const std::string &ip_or_name)
        {
-               try{
-                       return m_authmanager.setPrivs(name, privs);
-               }
-               catch(AuthNotFoundException &e)
-               {
-                       dstream<<"WARNING: Auth not found for "<<name<<std::endl;
-               }
+               m_banmanager.remove(ip_or_name);
+               return;
+       }
+
+       std::string getBanDescription(const std::string &ip_or_name)
+       {
+               return m_banmanager.getBanDescription(ip_or_name);
+       }
+
+       Address getPeerAddress(u16 peer_id)
+       {
+               return m_con.GetPeerAddress(peer_id);
+       }
+       
+       // Envlock and conlock should be locked when calling this
+       void notifyPlayer(const char *name, const std::wstring msg);
+       void notifyPlayers(const std::wstring msg);
+
+       void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
+       
+       // Envlock and conlock should be locked when using Lua
+       lua_State *getLua(){ return m_lua; }
+       
+       // IGameDef interface
+       // Under envlock
+       virtual IItemDefManager* getItemDefManager();
+       virtual INodeDefManager* getNodeDefManager();
+       virtual ICraftDefManager* getCraftDefManager();
+       virtual ITextureSource* getTextureSource();
+       virtual u16 allocateUnknownNodeId(const std::string &name);
+       virtual ISoundManager* getSoundManager();
+       virtual MtEventManager* getEventManager();
+       
+       IWritableItemDefManager* getWritableItemDefManager();
+       IWritableNodeDefManager* getWritableNodeDefManager();
+       IWritableCraftDefManager* getWritableCraftDefManager();
+
+       const ModSpec* getModSpec(const std::string &modname);
+       std::string getBuiltinLuaPath();
+       
+       std::string getWorldPath(){ return m_path_world; }
+
+       bool isSingleplayer(){ return m_simple_singleplayer_mode; }
+
+       void setAsyncFatalError(const std::string &error)
+       {
+               m_async_fatal_error.set(error);
        }
 
 private:
@@ -463,38 +579,57 @@ private:
        static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
        static void SendAccessDenied(con::Connection &con, u16 peer_id,
                        const std::wstring &reason);
+       static void SendDeathscreen(con::Connection &con, u16 peer_id,
+                       bool set_camera_point_target, v3f camera_point_target);
+       static void SendItemDef(con::Connection &con, u16 peer_id,
+                       IItemDefManager *itemdef);
+       static void SendNodeDef(con::Connection &con, u16 peer_id,
+                       INodeDefManager *nodedef);
        
        /*
-               Non-static send methods
+               Non-static send methods.
+               Conlock should be always used.
+               Envlock usage is documented badly but it's easy to figure out
+               which ones access the environment.
        */
 
        // Envlock and conlock should be locked when calling these
-       void SendObjectData(float dtime);
-       void SendPlayerInfos();
        void SendInventory(u16 peer_id);
        void SendChatMessage(u16 peer_id, const std::wstring &message);
        void BroadcastChatMessage(const std::wstring &message);
-       void SendPlayerHP(Player *player);
+       void SendPlayerHP(u16 peer_id);
+       void SendMovePlayer(u16 peer_id);
+       void SendPlayerPrivileges(u16 peer_id);
        /*
                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
        */
+       // Envlock and conlock should be locked when calling these
        void sendRemoveNode(v3s16 p, u16 ignore_id=0,
                        core::list<u16> *far_players=NULL, float far_d_nodes=100);
        void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
                        core::list<u16> *far_players=NULL, float far_d_nodes=100);
+       void setBlockNotSent(v3s16 p);
        
        // Environment and Connection must be locked when called
        void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
        
-       // Sends blocks to clients
+       // Sends blocks to clients (locks env and con on its own)
        void SendBlocks(float dtime);
+       
+       void fillMediaCache();
+       void sendMediaAnnouncement(u16 peer_id);
+       void sendRequestedMedia(u16 peer_id,
+                       const core::list<MediaRequest> &tosend);
 
        /*
                Something random
        */
        
+       void DiePlayer(u16 peer_id);
+       void RespawnPlayer(u16 peer_id);
+       
        void UpdateCrafting(u16 peer_id);
        
        // When called, connection mutex should be locked
@@ -503,45 +638,65 @@ private:
        // When called, environment mutex should be locked
        std::string getPlayerName(u16 peer_id)
        {
-               Player *player = m_env.getPlayer(peer_id);
+               Player *player = m_env->getPlayer(peer_id);
                if(player == NULL)
-                       return "[id="+itos(peer_id);
+                       return "[id="+itos(peer_id)+"]";
                return player->getName();
        }
 
+       // When called, environment mutex should be locked
+       PlayerSAO* getPlayerSAO(u16 peer_id)
+       {
+               Player *player = m_env->getPlayer(peer_id);
+               if(player == NULL)
+                       return NULL;
+               return player->getPlayerSAO();
+       }
+
        /*
                Get a player from memory or creates one.
                If player is already connected, return NULL
-               The password is not checked here - it is only used to
-               set the password if a new player is created.
+               Does not verify/modify auth info and password.
 
                Call with env and con locked.
        */
-       Player *emergePlayer(const char *name, const char *password, u16 peer_id);
+       PlayerSAO *emergePlayer(const char *name, u16 peer_id);
        
        // Locks environment and connection by its own
        struct PeerChange;
        void handlePeerChange(PeerChange &c);
        void handlePeerChanges();
 
-       u64 getPlayerPrivs(Player *player);
-
        /*
                Variables
        */
        
+       // World directory
+       std::string m_path_world;
+       // Path to user's configuration file ("" = no configuration file)
+       std::string m_path_config;
+       // Subgame specification
+       SubgameSpec m_gamespec;
+       // If true, do not allow multiple players and hide some multiplayer
+       // functionality
+       bool m_simple_singleplayer_mode;
+
+       // Thread can set; step() will throw as ServerError
+       MutexedVariable<std::string> m_async_fatal_error;
+       
        // Some timers
        float m_liquid_transform_timer;
        float m_print_info_timer;
        float m_objectdata_timer;
        float m_emergethread_trigger_timer;
        float m_savemap_timer;
+       IntervalLimiter m_map_timer_and_unload_interval;
        
        // NOTE: If connection and environment are both to be locked,
        // environment shall be locked first.
 
        // Environment
-       ServerEnvironment m_env;
+       ServerEnvironment *m_env;
        JMutex m_env_mutex;
        
        // Connection
@@ -550,8 +705,27 @@ private:
        // Connected clients (behind the con mutex)
        core::map<u16, RemoteClient*> m_clients;
 
-       // User authentication
-       AuthManager m_authmanager;
+       // Bann checking
+       BanManager m_banmanager;
+
+       // Scripting
+       // Envlock and conlock should be locked when using Lua
+       lua_State *m_lua;
+
+       // Item definition manager
+       IWritableItemDefManager *m_itemdef;
+       
+       // Node definition manager
+       IWritableNodeDefManager *m_nodedef;
+       
+       // Craft definition manager
+       IWritableCraftDefManager *m_craftdef;
+       
+       // Event manager
+       EventManager *m_event;
+       
+       // Mods
+       core::list<ModSpec> m_mods;
        
        /*
                Threads
@@ -573,10 +747,6 @@ private:
                Time related stuff
        */
 
-       // 0-23999
-       //MutexedVariable<u32> m_time_of_day;
-       // Used to buffer dtime for adding to m_time_of_day
-       float m_time_counter;
        // Timer for sending time of day over network
        float m_time_of_day_send_timer;
        // Uptime of server in seconds
@@ -603,12 +773,12 @@ private:
        /*
                Random stuff
        */
-
-       // Map directory
-       std::string m_mapsavedir;
+       
+       // Mod parent directory paths
+       core::list<std::string> m_modspaths;
 
        bool m_shutdown_requested;
-       
+
        /*
                Map edit event queue. Automatically receives all map edits.
                The constructor of this class registers us to receive them through
@@ -629,6 +799,13 @@ private:
                This is behind m_env_mutex
        */
        bool m_ignore_map_edit_events;
+       /*
+               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;
        /*
                If set to !=0, the incoming MapEditEvents are modified to have
                this peed id as the disabled recipient
@@ -636,10 +813,16 @@ private:
        */
        u16 m_ignore_map_edit_events_peer_id;
 
-       Profiler *m_profiler;
-
        friend class EmergeThread;
        friend class RemoteClient;
+
+       std::map<std::string,MediaInfo> m_media;
+
+       /*
+               Sounds
+       */
+       std::map<s32, ServerPlayingSound> m_playing_sounds;
+       s32 m_next_sound_id;
 };
 
 /*