3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_extrabloated.h"
30 #include "clientobject.h"
32 #include "inventorymanager.h"
34 #include "filecache.h"
35 #include "localplayer.h"
37 #include "util/pointedthing.h"
42 class IWritableTextureSource;
43 class IWritableShaderSource;
44 class IWritableItemDefManager;
45 class IWritableNodeDefManager;
46 //class IWritableCraftDefManager;
47 class ClientEnvironment;
48 struct MapDrawControl;
51 class ClientNotReadyException : public BaseException
54 ClientNotReadyException(const char *s):
59 struct QueuedMeshUpdate
63 bool ack_block_to_server;
70 A thread-safe queue of mesh update tasks
80 peer_id=0 adds with nobody to send to
82 void addBlock(v3s16 p, MeshMakeData *data,
83 bool ack_block_to_server, bool urgent);
85 // Returned pointer must be deleted
86 // Returns NULL if queue is empty
87 QueuedMeshUpdate * pop();
91 JMutexAutoLock lock(m_mutex);
92 return m_queue.size();
96 std::vector<QueuedMeshUpdate*> m_queue;
97 std::set<v3s16> m_urgents;
101 struct MeshUpdateResult
105 bool ack_block_to_server;
108 p(-1338,-1338,-1338),
110 ack_block_to_server(false)
115 class MeshUpdateThread : public SimpleThread
119 MeshUpdateThread(IGameDef *gamedef):
126 MeshUpdateQueue m_queue_in;
128 MutexedQueue<MeshUpdateResult> m_queue_out;
133 class MediaFetchThread : public SimpleThread
137 MediaFetchThread(IGameDef *gamedef):
144 core::list<MediaRequest> m_file_requests;
145 MutexedQueue<std::pair<std::string, std::string> > m_file_data;
146 core::list<MediaRequest> m_failed;
147 std::string m_remote_url;
155 CE_PLAYER_FORCE_MOVE,
163 ClientEventType type;
175 bool set_camera_point_target;
176 f32 camera_point_target_x;
177 f32 camera_point_target_y;
178 f32 camera_point_target_z;
181 std::string* formspec;
182 std::string* formname;
189 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
193 NOTE: Nothing is thread-safe here.
197 IrrlichtDevice *device,
198 const char *playername,
199 std::string password,
200 MapDrawControl &control,
201 IWritableTextureSource *tsrc,
202 IWritableShaderSource *shsrc,
203 IWritableItemDefManager *itemdef,
204 IWritableNodeDefManager *nodedef,
205 ISoundManager *sound,
206 MtEventManager *event
211 The name of the local player should already be set when
212 calling this, as it is sent in the initialization.
214 void connect(Address address);
217 m_con.Connected() == true
218 AND m_server_ser_ver != SER_FMT_VER_INVALID
219 throws con::PeerNotFoundException if connection has been deleted,
222 bool connectedAndInitialized();
224 Stuff that references the environment is valid only as
225 long as this is not called. (eg. Players)
226 If this throws a PeerNotFoundException, the connection has
229 void step(float dtime);
231 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
232 // Returns true if something was received
233 bool AsyncProcessPacket();
234 bool AsyncProcessData();
235 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
237 void interact(u8 action, const PointedThing& pointed);
239 void sendNodemetaFields(v3s16 p, const std::string &formname,
240 const std::map<std::string, std::string> &fields);
241 void sendInventoryFields(const std::string &formname,
242 const std::map<std::string, std::string> &fields);
243 void sendInventoryAction(InventoryAction *a);
244 void sendChatMessage(const std::wstring &message);
245 void sendChangePassword(const std::wstring oldpassword,
246 const std::wstring newpassword);
247 void sendDamage(u8 damage);
250 ClientEnvironment& getEnv()
253 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
254 void removeNode(v3s16 p);
255 void addNode(v3s16 p, MapNode n);
257 void setPlayerControl(PlayerControl &control);
259 void selectPlayerItem(u16 item);
260 u16 getPlayerItem() const
261 { return m_playeritem; }
263 // Returns true if the inventory of the local player has been
264 // updated from the server. If it is true, it is set to false.
265 bool getLocalInventoryUpdated();
266 // Copies the inventory of the local player to parameter
267 void getLocalInventory(Inventory &dst);
269 /* InventoryManager interface */
270 Inventory* getInventory(const InventoryLocation &loc);
271 void inventoryAction(InventoryAction *a);
273 // Gets closest object pointed by the shootline
274 // Returns NULL if not found
275 ClientActiveObject * getSelectedActiveObject(
277 v3f from_pos_f_on_map,
278 core::line3d<f32> shootline_on_map
281 // Prints a line or two of info
282 void printDebugInfo(std::ostream &os);
284 core::list<std::wstring> getConnectedPlayerNames();
286 float getAnimationTime();
289 void setCrack(int level, v3s16 pos);
293 bool checkPrivilege(const std::string &priv)
294 { return (m_privileges.count(priv) != 0); }
296 bool getChatMessage(std::wstring &message);
297 void typeChatMessage(const std::wstring& message);
299 u64 getMapSeed(){ return m_map_seed; }
301 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
302 // Including blocks at appropriate edges
303 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
304 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
306 // Get event from queue. CE_NONE is returned if queue is empty.
307 ClientEvent getClientEvent();
310 { return m_access_denied; }
312 std::wstring accessDeniedReason()
313 { return m_access_denied_reason; }
315 float mediaReceiveProgress()
317 if (!m_media_receive_started) return 0;
318 return 1.0 * m_media_received_count / m_media_count;
321 bool texturesReceived()
322 { return m_media_receive_started && m_media_received_count == m_media_count; }
323 bool itemdefReceived()
324 { return m_itemdef_received; }
325 bool nodedefReceived()
326 { return m_nodedef_received; }
328 void afterContentReceived();
332 // IGameDef interface
333 virtual IItemDefManager* getItemDefManager();
334 virtual INodeDefManager* getNodeDefManager();
335 virtual ICraftDefManager* getCraftDefManager();
336 virtual ITextureSource* getTextureSource();
337 virtual IShaderSource* getShaderSource();
338 virtual u16 allocateUnknownNodeId(const std::string &name);
339 virtual ISoundManager* getSoundManager();
340 virtual MtEventManager* getEventManager();
341 virtual bool checkLocalPrivilege(const std::string &priv)
342 { return checkPrivilege(priv); }
346 // Insert a media file appropriately into the appropriate manager
347 bool loadMedia(const std::string &data, const std::string &filename);
349 void request_media(const core::list<MediaRequest> &file_requests);
351 // Virtual methods from con::PeerHandler
352 void peerAdded(con::Peer *peer);
353 void deletingPeer(con::Peer *peer, bool timeout);
358 void sendPlayerPos();
359 // This sends the player's current name etc to the server
360 void sendPlayerInfo();
361 // Send the item number 'item' as player item to the server
362 void sendPlayerItem(u16 item);
364 float m_packetcounter_timer;
365 float m_connection_reinit_timer;
366 float m_avg_rtt_timer;
367 float m_playerpos_send_timer;
368 float m_ignore_damage_timer; // Used after server moves player
369 IntervalLimiter m_map_timer_and_unload_interval;
371 IWritableTextureSource *m_tsrc;
372 IWritableShaderSource *m_shsrc;
373 IWritableItemDefManager *m_itemdef;
374 IWritableNodeDefManager *m_nodedef;
375 ISoundManager *m_sound;
376 MtEventManager *m_event;
378 MeshUpdateThread m_mesh_update_thread;
379 core::list<MediaFetchThread*> m_media_fetch_threads;
380 ClientEnvironment m_env;
381 con::Connection m_con;
382 IrrlichtDevice *m_device;
383 // Server serialization version
386 bool m_inventory_updated;
387 Inventory *m_inventory_from_server;
388 float m_inventory_from_server_age;
389 core::map<v3s16, bool> m_active_blocks;
390 PacketCounter m_packetcounter;
391 // Block mesh animation parameters
392 float m_animation_time;
395 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
397 //u32 m_daynight_ratio;
398 Queue<std::wstring> m_chat_queue;
399 // The seed returned by the server in TOCLIENT_INIT is stored here
401 std::string m_password;
402 bool m_access_denied;
403 std::wstring m_access_denied_reason;
404 Queue<ClientEvent> m_client_event_queue;
405 FileCache m_media_cache;
406 // Mapping from media file name to SHA1 checksum
407 core::map<std::string, std::string> m_media_name_sha1_map;
408 bool m_media_receive_started;
410 u32 m_media_received_count;
411 bool m_itemdef_received;
412 bool m_nodedef_received;
413 friend class FarMesh;
415 // time_of_day speed approximation for old protocol
416 bool m_time_of_day_set;
417 float m_last_time_of_day_f;
418 float m_time_of_day_update_timer;
420 // An interval for generally sending object positions and stuff
421 float m_recommended_send_interval;
424 float m_removed_sounds_check_timer;
425 // Mapping from server sound ids to our sound ids
426 std::map<s32, int> m_sounds_server_to_client;
427 // And the other way!
428 std::map<int, s32> m_sounds_client_to_server;
429 // And relations to objects
430 std::map<int, u16> m_sounds_to_objects;
433 std::set<std::string> m_privileges;
435 // Detached inventories
437 std::map<std::string, Inventory*> m_detached_inventories;
440 #endif // !CLIENT_HEADER