Re-add jungles, apple trees
[oweals/minetest.git] / src / client.h
1 /*
2 Minetest
3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifndef CLIENT_HEADER
21 #define CLIENT_HEADER
22
23 #include "connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_extrabloated.h"
26 #include "jmutex.h"
27 #include <ostream>
28 #include <set>
29 #include <vector>
30 #include "clientobject.h"
31 #include "gamedef.h"
32 #include "inventorymanager.h"
33 #include "filesys.h"
34 #include "filecache.h"
35 #include "localplayer.h"
36 #include "server.h"
37 #include "particles.h"
38 #include "util/pointedthing.h"
39 #include <algorithm>
40
41 struct MeshMakeData;
42 class MapBlockMesh;
43 class IGameDef;
44 class IWritableTextureSource;
45 class IWritableShaderSource;
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 //class IWritableCraftDefManager;
49 class ClientEnvironment;
50 struct MapDrawControl;
51 class MtEventManager;
52
53 class ClientNotReadyException : public BaseException
54 {
55 public:
56         ClientNotReadyException(const char *s):
57                 BaseException(s)
58         {}
59 };
60
61 struct QueuedMeshUpdate
62 {
63         v3s16 p;
64         MeshMakeData *data;
65         bool ack_block_to_server;
66
67         QueuedMeshUpdate();
68         ~QueuedMeshUpdate();
69 };
70
71 /*
72         A thread-safe queue of mesh update tasks
73 */
74 class MeshUpdateQueue
75 {
76 public:
77         MeshUpdateQueue();
78
79         ~MeshUpdateQueue();
80         
81         /*
82                 peer_id=0 adds with nobody to send to
83         */
84         void addBlock(v3s16 p, MeshMakeData *data,
85                         bool ack_block_to_server, bool urgent);
86
87         // Returned pointer must be deleted
88         // Returns NULL if queue is empty
89         QueuedMeshUpdate * pop();
90
91         u32 size()
92         {
93                 JMutexAutoLock lock(m_mutex);
94                 return m_queue.size();
95         }
96         
97 private:
98         std::vector<QueuedMeshUpdate*> m_queue;
99         std::set<v3s16> m_urgents;
100         JMutex m_mutex;
101 };
102
103 struct MeshUpdateResult
104 {
105         v3s16 p;
106         MapBlockMesh *mesh;
107         bool ack_block_to_server;
108
109         MeshUpdateResult():
110                 p(-1338,-1338,-1338),
111                 mesh(NULL),
112                 ack_block_to_server(false)
113         {
114         }
115 };
116
117 class MeshUpdateThread : public SimpleThread
118 {
119 public:
120
121         MeshUpdateThread(IGameDef *gamedef):
122                 m_gamedef(gamedef)
123         {
124         }
125
126         void * Thread();
127
128         MeshUpdateQueue m_queue_in;
129
130         MutexedQueue<MeshUpdateResult> m_queue_out;
131
132         IGameDef *m_gamedef;
133 };
134
135 class MediaFetchThread : public SimpleThread
136 {
137 public:
138
139         MediaFetchThread(IGameDef *gamedef):
140                 m_gamedef(gamedef)
141         {
142         }
143
144         void * Thread();
145
146         std::list<MediaRequest> m_file_requests;
147         MutexedQueue<std::pair<std::string, std::string> > m_file_data;
148         std::list<MediaRequest> m_failed;
149         std::string m_remote_url;
150         IGameDef *m_gamedef;
151 };
152
153 enum ClientEventType
154 {
155         CE_NONE,
156         CE_PLAYER_DAMAGE,
157         CE_PLAYER_FORCE_MOVE,
158         CE_DEATHSCREEN,
159         CE_TEXTURES_UPDATED,
160         CE_SHOW_FORMSPEC
161 };
162
163 struct ClientEvent
164 {
165         ClientEventType type;
166         union{
167                 struct{
168                 } none;
169                 struct{
170                         u8 amount;
171                 } player_damage;
172                 struct{
173                         f32 pitch;
174                         f32 yaw;
175                 } player_force_move;
176                 struct{
177                         bool set_camera_point_target;
178                         f32 camera_point_target_x;
179                         f32 camera_point_target_y;
180                         f32 camera_point_target_z;
181                 } deathscreen;
182                 struct{
183                         std::string* formspec;
184                         std::string* formname;
185                 } show_formspec;
186                 struct{
187                 } textures_updated;
188         };
189 };
190
191 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
192 {
193 public:
194         /*
195                 NOTE: Nothing is thread-safe here.
196         */
197
198         Client(
199                         IrrlichtDevice *device,
200                         const char *playername,
201                         std::string password,
202                         MapDrawControl &control,
203                         IWritableTextureSource *tsrc,
204                         IWritableShaderSource *shsrc,
205                         IWritableItemDefManager *itemdef,
206                         IWritableNodeDefManager *nodedef,
207                         ISoundManager *sound,
208                         MtEventManager *event
209         );
210         
211         ~Client();
212         /*
213                 The name of the local player should already be set when
214                 calling this, as it is sent in the initialization.
215         */
216         void connect(Address address);
217         /*
218                 returns true when
219                         m_con.Connected() == true
220                         AND m_server_ser_ver != SER_FMT_VER_INVALID
221                 throws con::PeerNotFoundException if connection has been deleted,
222                 eg. timed out.
223         */
224         bool connectedAndInitialized();
225         /*
226                 Stuff that references the environment is valid only as
227                 long as this is not called. (eg. Players)
228                 If this throws a PeerNotFoundException, the connection has
229                 timed out.
230         */
231         void step(float dtime);
232
233         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
234         // Returns true if something was received
235         bool AsyncProcessPacket();
236         bool AsyncProcessData();
237         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
238
239         void interact(u8 action, const PointedThing& pointed);
240
241         void sendNodemetaFields(v3s16 p, const std::string &formname,
242                         const std::map<std::string, std::string> &fields);
243         void sendInventoryFields(const std::string &formname,
244                         const std::map<std::string, std::string> &fields);
245         void sendInventoryAction(InventoryAction *a);
246         void sendChatMessage(const std::wstring &message);
247         void sendChangePassword(const std::wstring oldpassword,
248                         const std::wstring newpassword);
249         void sendDamage(u8 damage);
250         void sendRespawn();
251
252         ClientEnvironment& getEnv()
253         { return m_env; }
254         
255         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
256         void removeNode(v3s16 p);
257         void addNode(v3s16 p, MapNode n);
258         
259         void setPlayerControl(PlayerControl &control);
260
261         void selectPlayerItem(u16 item);
262         u16 getPlayerItem() const
263         { return m_playeritem; }
264
265         // Returns true if the inventory of the local player has been
266         // updated from the server. If it is true, it is set to false.
267         bool getLocalInventoryUpdated();
268         // Copies the inventory of the local player to parameter
269         void getLocalInventory(Inventory &dst);
270         
271         /* InventoryManager interface */
272         Inventory* getInventory(const InventoryLocation &loc);
273         void inventoryAction(InventoryAction *a);
274
275         // Gets closest object pointed by the shootline
276         // Returns NULL if not found
277         ClientActiveObject * getSelectedActiveObject(
278                         f32 max_d,
279                         v3f from_pos_f_on_map,
280                         core::line3d<f32> shootline_on_map
281         );
282
283         // Prints a line or two of info
284         void printDebugInfo(std::ostream &os);
285
286         std::list<std::wstring> getConnectedPlayerNames();
287
288         float getAnimationTime();
289
290         int getCrackLevel();
291         void setCrack(int level, v3s16 pos);
292
293         u16 getHP();
294
295         bool checkPrivilege(const std::string &priv)
296         { return (m_privileges.count(priv) != 0); }
297
298         bool getChatMessage(std::wstring &message);
299         void typeChatMessage(const std::wstring& message);
300
301         u64 getMapSeed(){ return m_map_seed; }
302
303         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
304         // Including blocks at appropriate edges
305         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
306         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
307
308         // Get event from queue. CE_NONE is returned if queue is empty.
309         ClientEvent getClientEvent();
310         
311         bool accessDenied()
312         { return m_access_denied; }
313
314         std::wstring accessDeniedReason()
315         { return m_access_denied_reason; }
316
317         float mediaReceiveProgress()
318         {
319                 if (!m_media_receive_started) return 0;
320                 return 1.0 * m_media_received_count / m_media_count;
321         }
322
323         bool texturesReceived()
324         { return m_media_receive_started && m_media_received_count == m_media_count; }
325         bool itemdefReceived()
326         { return m_itemdef_received; }
327         bool nodedefReceived()
328         { return m_nodedef_received; }
329         
330         void afterContentReceived();
331
332         float getRTT(void);
333
334         // IGameDef interface
335         virtual IItemDefManager* getItemDefManager();
336         virtual INodeDefManager* getNodeDefManager();
337         virtual ICraftDefManager* getCraftDefManager();
338         virtual ITextureSource* getTextureSource();
339         virtual IShaderSource* getShaderSource();
340         virtual u16 allocateUnknownNodeId(const std::string &name);
341         virtual ISoundManager* getSoundManager();
342         virtual MtEventManager* getEventManager();
343         virtual bool checkLocalPrivilege(const std::string &priv)
344         { return checkPrivilege(priv); }
345
346 private:
347         
348         // Insert a media file appropriately into the appropriate manager
349         bool loadMedia(const std::string &data, const std::string &filename);
350
351         void request_media(const std::list<MediaRequest> &file_requests);
352
353         // Virtual methods from con::PeerHandler
354         void peerAdded(con::Peer *peer);
355         void deletingPeer(con::Peer *peer, bool timeout);
356         
357         void ReceiveAll();
358         void Receive();
359         
360         void sendPlayerPos();
361         // This sends the player's current name etc to the server
362         void sendPlayerInfo();
363         // Send the item number 'item' as player item to the server
364         void sendPlayerItem(u16 item);
365         
366         float m_packetcounter_timer;
367         float m_connection_reinit_timer;
368         float m_avg_rtt_timer;
369         float m_playerpos_send_timer;
370         float m_ignore_damage_timer; // Used after server moves player
371         IntervalLimiter m_map_timer_and_unload_interval;
372
373         IWritableTextureSource *m_tsrc;
374         IWritableShaderSource *m_shsrc;
375         IWritableItemDefManager *m_itemdef;
376         IWritableNodeDefManager *m_nodedef;
377         ISoundManager *m_sound;
378         MtEventManager *m_event;
379
380         MeshUpdateThread m_mesh_update_thread;
381         std::list<MediaFetchThread*> m_media_fetch_threads;
382         ClientEnvironment m_env;
383         con::Connection m_con;
384         IrrlichtDevice *m_device;
385         // Server serialization version
386         u8 m_server_ser_ver;
387         u16 m_playeritem;
388         bool m_inventory_updated;
389         Inventory *m_inventory_from_server;
390         float m_inventory_from_server_age;
391         std::set<v3s16> m_active_blocks;
392         PacketCounter m_packetcounter;
393         // Block mesh animation parameters
394         float m_animation_time;
395         int m_crack_level;
396         v3s16 m_crack_pos;
397         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
398         //s32 m_daynight_i;
399         //u32 m_daynight_ratio;
400         Queue<std::wstring> m_chat_queue;
401         // The seed returned by the server in TOCLIENT_INIT is stored here
402         u64 m_map_seed;
403         std::string m_password;
404         bool m_access_denied;
405         std::wstring m_access_denied_reason;
406         Queue<ClientEvent> m_client_event_queue;
407         FileCache m_media_cache;
408         // Mapping from media file name to SHA1 checksum
409         std::map<std::string, std::string> m_media_name_sha1_map;
410         bool m_media_receive_started;
411         u32 m_media_count;
412         u32 m_media_received_count;
413         bool m_itemdef_received;
414         bool m_nodedef_received;
415         friend class FarMesh;
416
417         // time_of_day speed approximation for old protocol
418         bool m_time_of_day_set;
419         float m_last_time_of_day_f;
420         float m_time_of_day_update_timer;
421
422         // An interval for generally sending object positions and stuff
423         float m_recommended_send_interval;
424
425         // Sounds
426         float m_removed_sounds_check_timer;
427         // Mapping from server sound ids to our sound ids
428         std::map<s32, int> m_sounds_server_to_client;
429         // And the other way!
430         std::map<int, s32> m_sounds_client_to_server;
431         // And relations to objects
432         std::map<int, u16> m_sounds_to_objects;
433
434         // Privileges
435         std::set<std::string> m_privileges;
436
437         // Detached inventories
438         // key = name
439         std::map<std::string, Inventory*> m_detached_inventories;
440 };
441
442 #endif // !CLIENT_HEADER
443