Update Copyright Years
[oweals/minetest.git] / src / client.h
index 0616cc914d153aef1de5b7a3eb3b0f9e087b4451..809e98b81c136fffb010542e215e2f95945a7056 100644 (file)
@@ -1,18 +1,18 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
@@ -20,14 +20,34 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef CLIENT_HEADER
 #define CLIENT_HEADER
 
-#ifndef SERVER
-
 #include "connection.h"
 #include "environment.h"
-#include "common_irrlicht.h"
+#include "irrlichttypes_extrabloated.h"
 #include "jmutex.h"
 #include <ostream>
+#include <set>
+#include <vector>
 #include "clientobject.h"
+#include "gamedef.h"
+#include "inventorymanager.h"
+#include "filesys.h"
+#include "filecache.h"
+#include "localplayer.h"
+#include "server.h"
+#include "particles.h"
+#include "util/pointedthing.h"
+
+struct MeshMakeData;
+class MapBlockMesh;
+class IGameDef;
+class IWritableTextureSource;
+class IWritableShaderSource;
+class IWritableItemDefManager;
+class IWritableNodeDefManager;
+//class IWritableCraftDefManager;
+class ClientEnvironment;
+struct MapDrawControl;
+class MtEventManager;
 
 class ClientNotReadyException : public BaseException
 {
@@ -43,18 +63,8 @@ struct QueuedMeshUpdate
        MeshMakeData *data;
        bool ack_block_to_server;
 
-       QueuedMeshUpdate():
-               p(-1337,-1337,-1337),
-               data(NULL),
-               ack_block_to_server(false)
-       {
-       }
-       
-       ~QueuedMeshUpdate()
-       {
-               if(data)
-                       delete data;
-       }
+       QueuedMeshUpdate();
+       ~QueuedMeshUpdate();
 };
 
 /*
@@ -63,76 +73,19 @@ struct QueuedMeshUpdate
 class MeshUpdateQueue
 {
 public:
-       MeshUpdateQueue()
-       {
-               m_mutex.Init();
-       }
-
-       ~MeshUpdateQueue()
-       {
-               JMutexAutoLock lock(m_mutex);
+       MeshUpdateQueue();
 
-               core::list<QueuedMeshUpdate*>::Iterator i;
-               for(i=m_queue.begin(); i!=m_queue.end(); i++)
-               {
-                       QueuedMeshUpdate *q = *i;
-                       delete q;
-               }
-       }
+       ~MeshUpdateQueue();
        
        /*
                peer_id=0 adds with nobody to send to
        */
-       void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server)
-       {
-               DSTACK(__FUNCTION_NAME);
-
-               assert(data);
-       
-               JMutexAutoLock lock(m_mutex);
-
-               /*
-                       Find if block is already in queue.
-                       If it is, update the data and quit.
-               */
-               core::list<QueuedMeshUpdate*>::Iterator i;
-               for(i=m_queue.begin(); i!=m_queue.end(); i++)
-               {
-                       QueuedMeshUpdate *q = *i;
-                       if(q->p == p)
-                       {
-                               if(q->data)
-                                       delete q->data;
-                               q->data = data;
-                               if(ack_block_to_server)
-                                       q->ack_block_to_server = true;
-                               return;
-                       }
-               }
-               
-               /*
-                       Add the block
-               */
-               QueuedMeshUpdate *q = new QueuedMeshUpdate;
-               q->p = p;
-               q->data = data;
-               q->ack_block_to_server = ack_block_to_server;
-               m_queue.push_back(q);
-       }
+       void addBlock(v3s16 p, MeshMakeData *data,
+                       bool ack_block_to_server, bool urgent);
 
        // Returned pointer must be deleted
        // Returns NULL if queue is empty
-       QueuedMeshUpdate * pop()
-       {
-               JMutexAutoLock lock(m_mutex);
-
-               core::list<QueuedMeshUpdate*>::Iterator i = m_queue.begin();
-               if(i == m_queue.end())
-                       return NULL;
-               QueuedMeshUpdate *q = *i;
-               m_queue.erase(i);
-               return q;
-       }
+       QueuedMeshUpdate * pop();
 
        u32 size()
        {
@@ -141,14 +94,15 @@ public:
        }
        
 private:
-       core::list<QueuedMeshUpdate*> m_queue;
+       std::vector<QueuedMeshUpdate*> m_queue;
+       std::set<v3s16> m_urgents;
        JMutex m_mutex;
 };
 
 struct MeshUpdateResult
 {
        v3s16 p;
-       scene::SMesh *mesh;
+       MapBlockMesh *mesh;
        bool ack_block_to_server;
 
        MeshUpdateResult():
@@ -163,7 +117,8 @@ class MeshUpdateThread : public SimpleThread
 {
 public:
 
-       MeshUpdateThread()
+       MeshUpdateThread(IGameDef *gamedef):
+               m_gamedef(gamedef)
        {
        }
 
@@ -172,59 +127,67 @@ public:
        MeshUpdateQueue m_queue_in;
 
        MutexedQueue<MeshUpdateResult> m_queue_out;
+
+       IGameDef *m_gamedef;
 };
 
-#if 0
-struct IncomingPacket
+class MediaFetchThread : public SimpleThread
 {
-       IncomingPacket()
-       {
-               m_data = NULL;
-               m_datalen = 0;
-               m_refcount = NULL;
-       }
-       IncomingPacket(const IncomingPacket &a)
-       {
-               m_data = a.m_data;
-               m_datalen = a.m_datalen;
-               m_refcount = a.m_refcount;
-               if(m_refcount != NULL)
-                       (*m_refcount)++;
-       }
-       IncomingPacket(u8 *data, u32 datalen)
-       {
-               m_data = new u8[datalen];
-               memcpy(m_data, data, datalen);
-               m_datalen = datalen;
-               m_refcount = new s32(1);
-       }
-       ~IncomingPacket()
+public:
+
+       MediaFetchThread(IGameDef *gamedef):
+               m_gamedef(gamedef)
        {
-               if(m_refcount != NULL){
-                       assert(*m_refcount > 0);
-                       (*m_refcount)--;
-                       if(*m_refcount == 0){
-                               if(m_data != NULL)
-                                       delete[] m_data;
-                               delete m_refcount;
-                       }
-               }
        }
-       /*IncomingPacket & operator=(IncomingPacket a)
-       {
-               m_data = a.m_data;
-               m_datalen = a.m_datalen;
-               m_refcount = a.m_refcount;
-               (*m_refcount)++;
-               return *this;
-       }*/
-       u8 *m_data;
-       u32 m_datalen;
-       s32 *m_refcount;
+
+       void * Thread();
+
+       core::list<MediaRequest> m_file_requests;
+       MutexedQueue<std::pair<std::string, std::string> > m_file_data;
+       core::list<MediaRequest> m_failed;
+       std::string m_remote_url;
+       IGameDef *m_gamedef;
+};
+
+enum ClientEventType
+{
+       CE_NONE,
+       CE_PLAYER_DAMAGE,
+       CE_PLAYER_FORCE_MOVE,
+       CE_DEATHSCREEN,
+       CE_TEXTURES_UPDATED,
+       CE_SHOW_FORMSPEC
+};
+
+struct ClientEvent
+{
+       ClientEventType type;
+       union{
+               struct{
+               } none;
+               struct{
+                       u8 amount;
+               } player_damage;
+               struct{
+                       f32 pitch;
+                       f32 yaw;
+               } player_force_move;
+               struct{
+                       bool set_camera_point_target;
+                       f32 camera_point_target_x;
+                       f32 camera_point_target_y;
+                       f32 camera_point_target_z;
+               } deathscreen;
+               struct{
+                       std::string* formspec;
+                       std::string* formname;
+               } show_formspec;
+               struct{
+               } textures_updated;
+       };
 };
-#endif
 
-class Client : public con::PeerHandler, public InventoryManager
+class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 {
 public:
        /*
@@ -234,8 +197,15 @@ public:
        Client(
                        IrrlichtDevice *device,
                        const char *playername,
-                       MapDrawControl &control
-                       );
+                       std::string password,
+                       MapDrawControl &control,
+                       IWritableTextureSource *tsrc,
+                       IWritableShaderSource *shsrc,
+                       IWritableItemDefManager *itemdef,
+                       IWritableNodeDefManager *nodedef,
+                       ISoundManager *sound,
+                       MtEventManager *event
+       );
        
        ~Client();
        /*
@@ -259,63 +229,48 @@ public:
        */
        void step(float dtime);
 
-       // Called from updater thread
-       // Returns dtime
-       //float asyncStep();
-
        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);
 
-       // Pops out a packet from the packet queue
-       //IncomingPacket getPacket();
-
-       void groundAction(u8 action, v3s16 nodepos_undersurface,
-                       v3s16 nodepos_oversurface, u16 item);
-       void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
+       void interact(u8 action, const PointedThing& pointed);
 
-       void sendSignText(v3s16 blockpos, s16 id, std::string text);
-       void sendSignNodeText(v3s16 p, std::string text);
+       void sendNodemetaFields(v3s16 p, const std::string &formname,
+                       const std::map<std::string, std::string> &fields);
+       void sendInventoryFields(const std::string &formname,
+                       const std::map<std::string, std::string> &fields);
        void sendInventoryAction(InventoryAction *a);
        void sendChatMessage(const std::wstring &message);
+       void sendChangePassword(const std::wstring oldpassword,
+                       const std::wstring newpassword);
+       void sendDamage(u8 damage);
+       void sendRespawn();
+
+       ClientEnvironment& getEnv()
+       { return m_env; }
        
-       // locks envlock
+       // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
        void removeNode(v3s16 p);
-       // locks envlock
        void addNode(v3s16 p, MapNode n);
        
-       void updateCamera(v3f pos, v3f dir);
-       
-       // Returns InvalidPositionException if not found
-       MapNode getNode(v3s16 p);
-       // Wrapper to Map
-       NodeMetadata* getNodeMetadata(v3s16 p);
+       void setPlayerControl(PlayerControl &control);
 
-       v3f getPlayerPosition();
+       void selectPlayerItem(u16 item);
+       u16 getPlayerItem() const
+       { return m_playeritem; }
 
-       void setPlayerControl(PlayerControl &control);
-       
        // Returns true if the inventory of the local player has been
        // updated from the server. If it is true, it is set to false.
        bool getLocalInventoryUpdated();
        // Copies the inventory of the local player to parameter
        void getLocalInventory(Inventory &dst);
        
-       InventoryContext *getInventoryContext();
-
-       Inventory* getInventory(InventoryContext *c, std::string id);
+       /* InventoryManager interface */
+       Inventory* getInventory(const InventoryLocation &loc);
        void inventoryAction(InventoryAction *a);
 
-       // Gets closest object pointed by the shootline
-       // Returns NULL if not found
-       MapBlockObject * getSelectedObject(
-                       f32 max_d,
-                       v3f from_pos_f_on_map,
-                       core::line3d<f32> shootline_on_map
-       );
-
        // Gets closest object pointed by the shootline
        // Returns NULL if not found
        ClientActiveObject * getSelectedActiveObject(
@@ -327,81 +282,73 @@ public:
        // Prints a line or two of info
        void printDebugInfo(std::ostream &os);
 
-       u32 getDayNightRatio();
+       core::list<std::wstring> getConnectedPlayerNames();
 
-       //void updateSomeExpiredMeshes();
-       
-       void setTempMod(v3s16 p, NodeMod mod)
-       {
-               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
-               assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
-
-               core::map<v3s16, MapBlock*> affected_blocks;
-               ((ClientMap&)m_env.getMap()).setTempMod(p, mod,
-                               &affected_blocks);
-
-               for(core::map<v3s16, MapBlock*>::Iterator
-                               i = affected_blocks.getIterator();
-                               i.atEnd() == false; i++)
-               {
-                       i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
-               }
-       }
-       void clearTempMod(v3s16 p)
-       {
-               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
-               assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
-
-               core::map<v3s16, MapBlock*> affected_blocks;
-               ((ClientMap&)m_env.getMap()).clearTempMod(p,
-                               &affected_blocks);
-
-               for(core::map<v3s16, MapBlock*>::Iterator
-                               i = affected_blocks.getIterator();
-                               i.atEnd() == false; i++)
-               {
-                       i.getNode()->getValue()->updateMesh(m_env.getDayNightRatio());
-               }
-       }
+       float getAnimationTime();
 
-       float getAvgRtt()
-       {
-               //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
-               con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
-               if(peer == NULL)
-                       return 0.0;
-               return peer->avg_rtt;
-       }
+       int getCrackLevel();
+       void setCrack(int level, v3s16 pos);
 
-       bool getChatMessage(std::wstring &message)
-       {
-               if(m_chat_queue.size() == 0)
-                       return false;
-               message = m_chat_queue.pop_front();
-               return true;
-       }
+       u16 getHP();
 
-       void addChatMessage(const std::wstring &message)
-       {
-               //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
-               LocalPlayer *player = m_env.getLocalPlayer();
-               assert(player != NULL);
-               std::wstring name = narrow_to_wide(player->getName());
-               m_chat_queue.push_back(
-                               (std::wstring)L"<"+name+L"> "+message);
-       }
+       bool checkPrivilege(const std::string &priv)
+       { return (m_privileges.count(priv) != 0); }
+
+       bool getChatMessage(std::wstring &message);
+       void typeChatMessage(const std::wstring& message);
 
        u64 getMapSeed(){ return m_map_seed; }
 
-       /*
-               These are not thread-safe
-       */
-       void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
+       void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
        // Including blocks at appropriate edges
-       void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
+       void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
+       void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
+
+       // 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; }
+
+       float mediaReceiveProgress()
+       {
+               if (!m_media_receive_started) return 0;
+               return 1.0 * m_media_received_count / m_media_count;
+       }
+
+       bool texturesReceived()
+       { return m_media_receive_started && m_media_received_count == m_media_count; }
+       bool itemdefReceived()
+       { return m_itemdef_received; }
+       bool nodedefReceived()
+       { return m_nodedef_received; }
+       
+       void afterContentReceived();
+
+       float getRTT(void);
+
+       // IGameDef interface
+       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 bool checkLocalPrivilege(const std::string &priv)
+       { return checkPrivilege(priv); }
 
 private:
        
+       // Insert a media file appropriately into the appropriate manager
+       bool loadMedia(const std::string &data, const std::string &filename);
+
+       void request_media(const core::list<MediaRequest> &file_requests);
+
        // Virtual methods from con::PeerHandler
        void peerAdded(con::Peer *peer);
        void deletingPeer(con::Peer *peer, bool timeout);
@@ -412,50 +359,84 @@ private:
        void sendPlayerPos();
        // This sends the player's current name etc to the server
        void sendPlayerInfo();
+       // Send the item number 'item' as player item to the server
+       void sendPlayerItem(u16 item);
        
        float m_packetcounter_timer;
-       float m_delete_unused_sectors_timer;
        float m_connection_reinit_timer;
        float m_avg_rtt_timer;
        float m_playerpos_send_timer;
+       float m_ignore_damage_timer; // Used after server moves player
+       IntervalLimiter m_map_timer_and_unload_interval;
+
+       IWritableTextureSource *m_tsrc;
+       IWritableShaderSource *m_shsrc;
+       IWritableItemDefManager *m_itemdef;
+       IWritableNodeDefManager *m_nodedef;
+       ISoundManager *m_sound;
+       MtEventManager *m_event;
 
        MeshUpdateThread m_mesh_update_thread;
-       
+       core::list<MediaFetchThread*> m_media_fetch_threads;
        ClientEnvironment m_env;
-       
        con::Connection m_con;
-
        IrrlichtDevice *m_device;
-
-       v3f camera_position;
-       v3f camera_direction;
-       
        // Server serialization version
        u8 m_server_ser_ver;
-
-       // This is behind m_env_mutex.
+       u16 m_playeritem;
        bool m_inventory_updated;
-
+       Inventory *m_inventory_from_server;
+       float m_inventory_from_server_age;
        core::map<v3s16, bool> m_active_blocks;
-
        PacketCounter m_packetcounter;
-       
-       // Received from the server. 0-23999
-       u32 m_time_of_day;
-       
+       // Block mesh animation parameters
+       float m_animation_time;
+       int m_crack_level;
+       v3s16 m_crack_pos;
        // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
        //s32 m_daynight_i;
        //u32 m_daynight_ratio;
-
        Queue<std::wstring> m_chat_queue;
-       
        // The seed returned by the server in TOCLIENT_INIT is stored here
        u64 m_map_seed;
-       
-       InventoryContext m_inventory_context;
+       std::string m_password;
+       bool m_access_denied;
+       std::wstring m_access_denied_reason;
+       Queue<ClientEvent> m_client_event_queue;
+       FileCache m_media_cache;
+       // Mapping from media file name to SHA1 checksum
+       core::map<std::string, std::string> m_media_name_sha1_map;
+       bool m_media_receive_started;
+       u32 m_media_count;
+       u32 m_media_received_count;
+       bool m_itemdef_received;
+       bool m_nodedef_received;
+       friend class FarMesh;
+
+       // time_of_day speed approximation for old protocol
+       bool m_time_of_day_set;
+       float m_last_time_of_day_f;
+       float m_time_of_day_update_timer;
+
+       // An interval for generally sending object positions and stuff
+       float m_recommended_send_interval;
+
+       // 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;
+       // And the other way!
+       std::map<int, s32> m_sounds_client_to_server;
+       // And relations to objects
+       std::map<int, u16> m_sounds_to_objects;
+
+       // Privileges
+       std::set<std::string> m_privileges;
+
+       // Detached inventories
+       // key = name
+       std::map<std::string, Inventory*> m_detached_inventories;
 };
 
-#endif // !SERVER
-
 #endif // !CLIENT_HEADER