]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/client.h
[CSM] Add minimap API modifiers (#5399)
[dragonfireclient.git] / src / client.h
index 9f36a257fe2f73074d68c677cedddc27f30edf01..5c8a0ae25d33128c11ea313a67fd395b9cc67178 100644 (file)
@@ -20,10 +20,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef CLIENT_HEADER
 #define CLIENT_HEADER
 
-#include "connection.h"
-#include "environment.h"
+#include "network/connection.h"
+#include "clientenvironment.h"
 #include "irrlichttypes_extrabloated.h"
-#include "jthread/jmutex.h"
+#include "threading/mutex.h"
 #include <ostream>
 #include <map>
 #include <set>
@@ -34,6 +34,8 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "localplayer.h"
 #include "hud.h"
 #include "particles.h"
+#include "mapnode.h"
+#include "tileanimation.h"
 
 struct MeshMakeData;
 class MapBlockMesh;
@@ -47,7 +49,10 @@ struct MapDrawControl;
 class MtEventManager;
 struct PointedThing;
 class Database;
-class Server;
+class Minimap;
+struct MinimapMapblock;
+class Camera;
+class NetworkPacket;
 
 struct QueuedMeshUpdate
 {
@@ -74,7 +79,7 @@ class MeshUpdateQueue
        MeshUpdateQueue();
 
        ~MeshUpdateQueue();
-       
+
        /*
                peer_id=0 adds with nobody to send to
        */
@@ -87,14 +92,14 @@ class MeshUpdateQueue
 
        u32 size()
        {
-               JMutexAutoLock lock(m_mutex);
+               MutexAutoLock lock(m_mutex);
                return m_queue.size();
        }
-       
+
 private:
        std::vector<QueuedMeshUpdate*> m_queue;
        std::set<v3s16> m_urgents;
-       JMutex m_mutex;
+       Mutex m_mutex;
 };
 
 struct MeshUpdateResult
@@ -111,23 +116,22 @@ struct MeshUpdateResult
        }
 };
 
-class MeshUpdateThread : public JThread
+class MeshUpdateThread : public UpdateThread
 {
-public:
+private:
+       MeshUpdateQueue m_queue_in;
 
-       MeshUpdateThread(IGameDef *gamedef):
-               m_gamedef(gamedef)
-       {
-       }
+protected:
+       virtual void doUpdate();
 
-       void * Thread();
+public:
 
-       MeshUpdateQueue m_queue_in;
+       MeshUpdateThread() : UpdateThread("Mesh") {}
 
+       void enqueueUpdate(v3s16 p, MeshMakeData *data,
+                       bool ack_block_to_server, bool urgent);
        MutexedQueue<MeshUpdateResult> m_queue_out;
 
-       IGameDef *m_gamedef;
-       
        v3s16 m_camera_offset;
 };
 
@@ -138,6 +142,7 @@ enum ClientEventType
        CE_PLAYER_FORCE_MOVE,
        CE_DEATHSCREEN,
        CE_SHOW_FORMSPEC,
+       CE_SHOW_LOCAL_FORMSPEC,
        CE_SPAWN_PARTICLE,
        CE_ADD_PARTICLESPAWNER,
        CE_DELETE_PARTICLESPAWNER,
@@ -152,8 +157,8 @@ struct ClientEvent
 {
        ClientEventType type;
        union{
-               struct{
-               } none;
+               //struct{
+               //} none;
                struct{
                        u8 amount;
                } player_damage;
@@ -171,8 +176,8 @@ struct ClientEvent
                        std::string *formspec;
                        std::string *formname;
                } show_formspec;
-               struct{
-               } textures_updated;
+               //struct{
+               //} textures_updated;
                struct{
                        v3f *pos;
                        v3f *vel;
@@ -180,8 +185,11 @@ struct ClientEvent
                        f32 expirationtime;
                        f32 size;
                        bool collisiondetection;
+                       bool collision_removal;
                        bool vertical;
                        std::string *texture;
+                       struct TileAnimationParams animation;
+                       u8 glow;
                } spawn_particle;
                struct{
                        u16 amount;
@@ -197,9 +205,13 @@ struct ClientEvent
                        f32 minsize;
                        f32 maxsize;
                        bool collisiondetection;
+                       bool collision_removal;
+                       u16 attached_id;
                        bool vertical;
                        std::string *texture;
                        u32 id;
+                       struct TileAnimationParams animation;
+                       u8 glow;
                } add_particlespawner;
                struct{
                        u32 id;
@@ -294,6 +306,8 @@ class PacketCounter
        std::map<u16, u16> m_packets;
 };
 
+class ClientScripting;
+
 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 {
 public:
@@ -305,7 +319,6 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
                        IrrlichtDevice *device,
                        const char *playername,
                        std::string password,
-                       bool is_simple_singleplayer_game,
                        MapDrawControl &control,
                        IWritableTextureSource *tsrc,
                        IWritableShaderSource *shsrc,
@@ -315,9 +328,11 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
                        MtEventManager *event,
                        bool ipv6
        );
-       
+
        ~Client();
 
+       void initMods();
+
        /*
         request all threads managed by client to be stopped
         */
@@ -325,11 +340,14 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
 
        bool isShutdown();
+
        /*
                The name of the local player should already be set when
                calling this, as it is sent in the initialization.
        */
-       void connect(Address address);
+       void connect(Address address,
+                       const std::string &address_name,
+                       bool is_local_server);
 
        /*
                Stuff that references the environment is valid only as
@@ -339,34 +357,93 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        */
        void step(float dtime);
 
-       void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
-       // Returns true if something was received
-       bool AsyncProcessPacket();
-       bool AsyncProcessData();
-       void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
+       /*
+        * Command Handlers
+        */
+
+       void handleCommand(NetworkPacket* pkt);
+
+       void handleCommand_Null(NetworkPacket* pkt) {};
+       void handleCommand_Deprecated(NetworkPacket* pkt);
+       void handleCommand_Hello(NetworkPacket* pkt);
+       void handleCommand_AuthAccept(NetworkPacket* pkt);
+       void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
+       void handleCommand_DenySudoMode(NetworkPacket* pkt);
+       void handleCommand_InitLegacy(NetworkPacket* pkt);
+       void handleCommand_AccessDenied(NetworkPacket* pkt);
+       void handleCommand_RemoveNode(NetworkPacket* pkt);
+       void handleCommand_AddNode(NetworkPacket* pkt);
+       void handleCommand_BlockData(NetworkPacket* pkt);
+       void handleCommand_Inventory(NetworkPacket* pkt);
+       void handleCommand_TimeOfDay(NetworkPacket* pkt);
+       void handleCommand_ChatMessage(NetworkPacket* pkt);
+       void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
+       void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
+       void handleCommand_Movement(NetworkPacket* pkt);
+       void handleCommand_HP(NetworkPacket* pkt);
+       void handleCommand_Breath(NetworkPacket* pkt);
+       void handleCommand_MovePlayer(NetworkPacket* pkt);
+       void handleCommand_PlayerItem(NetworkPacket* pkt);
+       void handleCommand_DeathScreen(NetworkPacket* pkt);
+       void handleCommand_AnnounceMedia(NetworkPacket* pkt);
+       void handleCommand_Media(NetworkPacket* pkt);
+       void handleCommand_ToolDef(NetworkPacket* pkt);
+       void handleCommand_NodeDef(NetworkPacket* pkt);
+       void handleCommand_CraftItemDef(NetworkPacket* pkt);
+       void handleCommand_ItemDef(NetworkPacket* pkt);
+       void handleCommand_PlaySound(NetworkPacket* pkt);
+       void handleCommand_StopSound(NetworkPacket* pkt);
+       void handleCommand_Privileges(NetworkPacket* pkt);
+       void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
+       void handleCommand_DetachedInventory(NetworkPacket* pkt);
+       void handleCommand_ShowFormSpec(NetworkPacket* pkt);
+       void handleCommand_SpawnParticle(NetworkPacket* pkt);
+       void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
+       void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
+       void handleCommand_HudAdd(NetworkPacket* pkt);
+       void handleCommand_HudRemove(NetworkPacket* pkt);
+       void handleCommand_HudChange(NetworkPacket* pkt);
+       void handleCommand_HudSetFlags(NetworkPacket* pkt);
+       void handleCommand_HudSetParam(NetworkPacket* pkt);
+       void handleCommand_HudSetSky(NetworkPacket* pkt);
+       void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
+       void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
+       void handleCommand_EyeOffset(NetworkPacket* pkt);
+       void handleCommand_SrpBytesSandB(NetworkPacket* pkt);
+
+       void ProcessData(NetworkPacket *pkt);
+
+       void Send(NetworkPacket* pkt);
 
        void interact(u8 action, const PointedThing& pointed);
 
        void sendNodemetaFields(v3s16 p, const std::string &formname,
-                       const std::map<std::string, std::string> &fields);
+               const StringMap &fields);
        void sendInventoryFields(const std::string &formname,
-                       const std::map<std::string, std::string> &fields);
+               const StringMap &fields);
        void sendInventoryAction(InventoryAction *a);
        void sendChatMessage(const std::wstring &message);
-       void sendChangePassword(const std::wstring &oldpassword,
-                               const std::wstring &newpassword);
+       void sendChangePassword(const std::string &oldpassword,
+               const std::string &newpassword);
        void sendDamage(u8 damage);
        void sendBreath(u16 breath);
        void sendRespawn();
        void sendReady();
 
-       ClientEnvironment& getEnv()
-       { return m_env; }
-       
+       ClientEnvironment& getEnv() { return m_env; }
+       ITextureSource *tsrc() { return getTextureSource(); }
+       ISoundManager *sound() { return getSoundManager(); }
+       static const std::string &getBuiltinLuaPath();
+       static const std::string &getClientModsLuaPath();
+
+       virtual const std::vector<ModSpec> &getMods() const;
+       virtual const ModSpec* getModSpec(const std::string &modname) const;
+
        // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
        void removeNode(v3s16 p);
+       MapNode getNode(v3s16 p, bool *is_valid_position);
        void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
-       
+
        void setPlayerControl(PlayerControl &control);
 
        void selectPlayerItem(u16 item);
@@ -378,33 +455,24 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        bool getLocalInventoryUpdated();
        // Copies the inventory of the local player to parameter
        void getLocalInventory(Inventory &dst);
-       
+
        /* InventoryManager interface */
        Inventory* getInventory(const InventoryLocation &loc);
        void inventoryAction(InventoryAction *a);
 
-       // Gets closest object pointed by the shootline
-       // Returns NULL if not found
-       ClientActiveObject * getSelectedActiveObject(
-                       f32 max_d,
-                       v3f from_pos_f_on_map,
-                       core::line3d<f32> shootline_on_map
-       );
-
-       std::list<std::string> getConnectedPlayerNames();
+       const std::list<std::string> &getConnectedPlayerNames()
+       {
+               return m_env.getPlayerNames();
+       }
 
        float getAnimationTime();
 
        int getCrackLevel();
        void setCrack(int level, v3s16 pos);
 
-       void setHighlighted(v3s16 pos, bool show_higlighted);
-       v3s16 getHighlighted(){ return m_highlighted_pos; }
-
        u16 getHP();
-       u16 getBreath();
 
-       bool checkPrivilege(const std::string &priv)
+       bool checkPrivilege(const std::string &priv) const
        { return (m_privileges.count(priv) != 0); }
 
        bool getChatMessage(std::wstring &message);
@@ -416,18 +484,26 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        // Including blocks at appropriate edges
        void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
        void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
-       
+
        void updateCameraOffset(v3s16 camera_offset)
        { m_mesh_update_thread.m_camera_offset = camera_offset; }
 
        // Get event from queue. CE_NONE is returned if queue is empty.
        ClientEvent getClientEvent();
-       
-       bool accessDenied()
-       { return m_access_denied; }
 
-       std::wstring accessDeniedReason()
-       { return m_access_denied_reason; }
+       bool accessDenied() const { return m_access_denied; }
+
+       bool reconnectRequested() const { return m_access_denied_reconnect; }
+
+       void setFatalError(const std::string &reason)
+       {
+               m_access_denied = true;
+               m_access_denied_reason = reason;
+       }
+
+       // Renaming accessDeniedReason to better name could be good as it's used to
+       // disconnect client when CSM failed.
+       const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 
        bool itemdefReceived()
        { return m_itemdef_received; }
@@ -436,33 +512,53 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        bool mediaReceived()
        { return m_media_downloader == NULL; }
 
+       u8 getProtoVersion()
+       { return m_proto_ver; }
+
+       bool connectedToServer()
+       { return m_con.Connected(); }
+
        float mediaReceiveProgress();
 
-       void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
+       void afterContentReceived(IrrlichtDevice *device);
+
+       float getRTT();
+       float getCurRate();
 
-       float getRTT(void);
-       float getCurRate(void);
-       float getAvgRate(void);
+       Minimap* getMinimap() { return m_minimap; }
+       void setCamera(Camera* camera) { m_camera = camera; }
+
+       Camera* getCamera ()
+       { return m_camera; }
+
+       bool shouldShowMinimap() const;
+       void setMinimapShownByMod(bool state) { m_minimap_shown_by_mod = state; }
 
        // IGameDef interface
        virtual IItemDefManager* getItemDefManager();
        virtual INodeDefManager* getNodeDefManager();
        virtual ICraftDefManager* getCraftDefManager();
-       virtual ITextureSource* getTextureSource();
+       ITextureSource* getTextureSource();
        virtual IShaderSource* getShaderSource();
-       virtual scene::ISceneManager* getSceneManager();
+       IShaderSource *shsrc() { return getShaderSource(); }
+       scene::ISceneManager* getSceneManager();
        virtual u16 allocateUnknownNodeId(const std::string &name);
        virtual ISoundManager* getSoundManager();
        virtual MtEventManager* getEventManager();
-       virtual bool checkLocalPrivilege(const std::string &priv)
+       virtual ParticleManager* getParticleManager();
+       bool checkLocalPrivilege(const std::string &priv)
        { return checkPrivilege(priv); }
        virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
 
+       virtual std::string getModStoragePath() const;
+       virtual bool registerModStorage(ModMetadata *meta);
+       virtual void unregisterModStorage(const std::string &name);
+
        // The following set of functions is used by ClientMediaDownloader
        // Insert a media file appropriately into the appropriate manager
        bool loadMedia(const std::string &data, const std::string &filename);
        // Send a request for conventional media transfer
-       void request_media(const std::list<std::string> &file_requests);
+       void request_media(const std::vector<std::string> &file_requests);
        // Send a notification that no conventional media transfer is needed
        void received_media();
 
@@ -470,19 +566,51 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 
        void makeScreenshot(IrrlichtDevice *device);
 
+       inline void pushToChatQueue(const std::wstring &input)
+       {
+               m_chat_queue.push(input);
+       }
+
+       ClientScripting *getScript() { return m_script; }
+       const bool moddingEnabled() const { return m_modding_enabled; }
+
+       inline void pushToEventQueue(const ClientEvent &event)
+       {
+               m_client_event_queue.push(event);
+       }
+
 private:
 
        // Virtual methods from con::PeerHandler
        void peerAdded(con::Peer *peer);
        void deletingPeer(con::Peer *peer, bool timeout);
-       
+
+       void initLocalMapSaving(const Address &address,
+                       const std::string &hostname,
+                       bool is_local_server);
+
        void ReceiveAll();
        void Receive();
-       
+
        void sendPlayerPos();
        // Send the item number 'item' as player item to the server
        void sendPlayerItem(u16 item);
-       
+
+       void deleteAuthData();
+       // helper method shared with clientpackethandler
+       static AuthMechanism choseAuthMech(const u32 mechs);
+
+       void sendLegacyInit(const char* playerName, const char* playerPassword);
+       void sendInit(const std::string &playerName);
+       void startAuth(AuthMechanism chosen_auth_mechanism);
+       void sendDeletedBlocks(std::vector<v3s16> &blocks);
+       void sendGotBlocks(v3s16 block);
+       void sendRemovedSounds(std::vector<s32> &soundList);
+
+       // Helper function
+       inline std::string getPlayerName()
+       { return m_env.getLocalPlayer()->getName(); }
+
        float m_packetcounter_timer;
        float m_connection_reinit_timer;
        float m_avg_rtt_timer;
@@ -497,34 +625,60 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        ISoundManager *m_sound;
        MtEventManager *m_event;
 
+
        MeshUpdateThread m_mesh_update_thread;
        ClientEnvironment m_env;
+       ParticleManager m_particle_manager;
        con::Connection m_con;
        IrrlichtDevice *m_device;
+       Camera *m_camera;
+       Minimap *m_minimap;
+       bool m_minimap_disabled_by_server;
+       bool m_minimap_shown_by_mod;
        // Server serialization version
        u8 m_server_ser_ver;
+
+       // Used version of the protocol with server
+       // Values smaller than 25 only mean they are smaller than 25,
+       // and aren't accurate. We simply just don't know, because
+       // the server didn't send the version back then.
+       // If 0, server init hasn't been received yet.
+       u8 m_proto_ver;
+
        u16 m_playeritem;
        bool m_inventory_updated;
        Inventory *m_inventory_from_server;
        float m_inventory_from_server_age;
-       std::set<v3s16> m_active_blocks;
        PacketCounter m_packetcounter;
-       bool m_show_highlighted;
        // Block mesh animation parameters
        float m_animation_time;
        int m_crack_level;
        v3s16 m_crack_pos;
-       v3s16 m_highlighted_pos;
        // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
        //s32 m_daynight_i;
        //u32 m_daynight_ratio;
-       Queue<std::wstring> m_chat_queue;
+       std::queue<std::wstring> m_chat_queue;
+
+       // The authentication methods we can use to enter sudo mode (=change password)
+       u32 m_sudo_auth_methods;
+
        // The seed returned by the server in TOCLIENT_INIT is stored here
        u64 m_map_seed;
+
+       // Auth data
+       std::string m_playername;
        std::string m_password;
+       // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
+       std::string m_new_password;
+       // Usable by auth mechanisms.
+       AuthMechanism m_chosen_auth_mech;
+       void * m_auth_data;
+
+
        bool m_access_denied;
-       std::wstring m_access_denied_reason;
-       Queue<ClientEvent> m_client_event_queue;
+       bool m_access_denied_reconnect;
+       std::string m_access_denied_reason;
+       std::queue<ClientEvent> m_client_event_queue;
        bool m_itemdef_received;
        bool m_nodedef_received;
        ClientMediaDownloader *m_media_downloader;
@@ -540,32 +694,41 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
        // Sounds
        float m_removed_sounds_check_timer;
        // Mapping from server sound ids to our sound ids
-       std::map<s32, int> m_sounds_server_to_client;
+       UNORDERED_MAP<s32, int> m_sounds_server_to_client;
        // And the other way!
-       std::map<int, s32> m_sounds_client_to_server;
+       UNORDERED_MAP<int, s32> m_sounds_client_to_server;
        // And relations to objects
-       std::map<int, u16> m_sounds_to_objects;
+       UNORDERED_MAP<int, u16> m_sounds_to_objects;
 
        // Privileges
-       std::set<std::string> m_privileges;
+       UNORDERED_SET<std::string> m_privileges;
 
        // Detached inventories
        // key = name
-       std::map<std::string, Inventory*> m_detached_inventories;
+       UNORDERED_MAP<std::string, Inventory*> m_detached_inventories;
 
        // Storage for mesh data for creating multiple instances of the same mesh
-       std::map<std::string, std::string> m_mesh_data;
+       StringMap m_mesh_data;
 
        // own state
        LocalClientState m_state;
 
        // Used for saving server map to disk client-side
-       Database *localdb;
-       Server *localserver;
+       Database *m_localdb;
+       IntervalLimiter m_localdb_save_interval;
+       u16 m_cache_save_interval;
 
-       // TODO: Add callback to update this when g_settings changes
+       // TODO: Add callback to update these when g_settings changes
        bool m_cache_smooth_lighting;
+       bool m_cache_enable_shaders;
+       bool m_cache_use_tangent_vertices;
+
+       ClientScripting *m_script;
+       bool m_modding_enabled;
+       UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
+       float m_mod_storage_save_timer;
+
+       DISABLE_CLASS_COPY(Client);
 };
 
 #endif // !CLIENT_HEADER
-