3 Copyright (C) 2013 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"
31 #include "clientobject.h"
33 #include "inventorymanager.h"
34 #include "filecache.h"
35 #include "localplayer.h"
37 #include "particles.h"
38 #include "util/pointedthing.h"
44 class IWritableTextureSource;
45 class IWritableShaderSource;
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 //class IWritableCraftDefManager;
49 class ClientEnvironment;
50 struct MapDrawControl;
53 class ClientNotReadyException : public BaseException
56 ClientNotReadyException(const char *s):
61 struct QueuedMeshUpdate
65 bool ack_block_to_server;
72 A thread-safe queue of mesh update tasks
82 peer_id=0 adds with nobody to send to
84 void addBlock(v3s16 p, MeshMakeData *data,
85 bool ack_block_to_server, bool urgent);
87 // Returned pointer must be deleted
88 // Returns NULL if queue is empty
89 QueuedMeshUpdate * pop();
93 JMutexAutoLock lock(m_mutex);
94 return m_queue.size();
98 std::vector<QueuedMeshUpdate*> m_queue;
99 std::set<v3s16> m_urgents;
103 struct MeshUpdateResult
107 bool ack_block_to_server;
110 p(-1338,-1338,-1338),
112 ack_block_to_server(false)
117 class MeshUpdateThread : public SimpleThread
121 MeshUpdateThread(IGameDef *gamedef):
128 MeshUpdateQueue m_queue_in;
130 MutexedQueue<MeshUpdateResult> m_queue_out;
135 class MediaFetchThread : public SimpleThread
139 MediaFetchThread(IGameDef *gamedef):
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;
157 CE_PLAYER_FORCE_MOVE,
162 CE_ADD_PARTICLESPAWNER,
163 CE_DELETE_PARTICLESPAWNER,
171 ClientEventType type;
183 bool set_camera_point_target;
184 f32 camera_point_target_x;
185 f32 camera_point_target_y;
186 f32 camera_point_target_z;
189 std::string *formspec;
190 std::string *formname;
200 bool collisiondetection;
201 std::string *texture;
216 bool collisiondetection;
217 std::string *texture;
219 } add_particlespawner;
222 } delete_particlespawner;
260 void add(u16 command)
262 std::map<u16, u16>::iterator n = m_packets.find(command);
263 if(n == m_packets.end())
265 m_packets[command] = 1;
275 for(std::map<u16, u16>::iterator
276 i = m_packets.begin();
277 i != m_packets.end(); ++i)
283 void print(std::ostream &o)
285 for(std::map<u16, u16>::iterator
286 i = m_packets.begin();
287 i != m_packets.end(); ++i)
290 <<" count "<<i->second
297 std::map<u16, u16> m_packets;
300 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
304 NOTE: Nothing is thread-safe here.
308 IrrlichtDevice *device,
309 const char *playername,
310 std::string password,
311 MapDrawControl &control,
312 IWritableTextureSource *tsrc,
313 IWritableShaderSource *shsrc,
314 IWritableItemDefManager *itemdef,
315 IWritableNodeDefManager *nodedef,
316 ISoundManager *sound,
317 MtEventManager *event,
323 The name of the local player should already be set when
324 calling this, as it is sent in the initialization.
326 void connect(Address address);
329 m_con.Connected() == true
330 AND m_server_ser_ver != SER_FMT_VER_INVALID
331 throws con::PeerNotFoundException if connection has been deleted,
334 bool connectedAndInitialized();
336 Stuff that references the environment is valid only as
337 long as this is not called. (eg. Players)
338 If this throws a PeerNotFoundException, the connection has
341 void step(float dtime);
343 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
344 // Returns true if something was received
345 bool AsyncProcessPacket();
346 bool AsyncProcessData();
347 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
349 void interact(u8 action, const PointedThing& pointed);
351 void sendNodemetaFields(v3s16 p, const std::string &formname,
352 const std::map<std::string, std::string> &fields);
353 void sendInventoryFields(const std::string &formname,
354 const std::map<std::string, std::string> &fields);
355 void sendInventoryAction(InventoryAction *a);
356 void sendChatMessage(const std::wstring &message);
357 void sendChangePassword(const std::wstring oldpassword,
358 const std::wstring newpassword);
359 void sendDamage(u8 damage);
360 void sendBreath(u16 breath);
363 ClientEnvironment& getEnv()
366 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
367 void removeNode(v3s16 p);
368 void addNode(v3s16 p, MapNode n);
370 void setPlayerControl(PlayerControl &control);
372 void selectPlayerItem(u16 item);
373 u16 getPlayerItem() const
374 { return m_playeritem; }
376 // Returns true if the inventory of the local player has been
377 // updated from the server. If it is true, it is set to false.
378 bool getLocalInventoryUpdated();
379 // Copies the inventory of the local player to parameter
380 void getLocalInventory(Inventory &dst);
382 /* InventoryManager interface */
383 Inventory* getInventory(const InventoryLocation &loc);
384 void inventoryAction(InventoryAction *a);
386 // Gets closest object pointed by the shootline
387 // Returns NULL if not found
388 ClientActiveObject * getSelectedActiveObject(
390 v3f from_pos_f_on_map,
391 core::line3d<f32> shootline_on_map
394 // Prints a line or two of info
395 void printDebugInfo(std::ostream &os);
397 std::list<std::string> getConnectedPlayerNames();
399 float getAnimationTime();
402 void setCrack(int level, v3s16 pos);
407 bool checkPrivilege(const std::string &priv)
408 { return (m_privileges.count(priv) != 0); }
410 bool getChatMessage(std::wstring &message);
411 void typeChatMessage(const std::wstring& message);
413 u64 getMapSeed(){ return m_map_seed; }
415 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
416 // Including blocks at appropriate edges
417 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
418 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
420 // Get event from queue. CE_NONE is returned if queue is empty.
421 ClientEvent getClientEvent();
424 { return m_access_denied; }
426 std::wstring accessDeniedReason()
427 { return m_access_denied_reason; }
429 float mediaReceiveProgress()
431 if (!m_media_receive_started) return 0;
432 return 1.0 * m_media_received_count / m_media_count;
435 bool texturesReceived()
436 { return m_media_receive_started && m_media_received_count == m_media_count; }
437 bool itemdefReceived()
438 { return m_itemdef_received; }
439 bool nodedefReceived()
440 { return m_nodedef_received; }
442 void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
446 // IGameDef interface
447 virtual IItemDefManager* getItemDefManager();
448 virtual INodeDefManager* getNodeDefManager();
449 virtual ICraftDefManager* getCraftDefManager();
450 virtual ITextureSource* getTextureSource();
451 virtual IShaderSource* getShaderSource();
452 virtual u16 allocateUnknownNodeId(const std::string &name);
453 virtual ISoundManager* getSoundManager();
454 virtual MtEventManager* getEventManager();
455 virtual bool checkLocalPrivilege(const std::string &priv)
456 { return checkPrivilege(priv); }
460 // Insert a media file appropriately into the appropriate manager
461 bool loadMedia(const std::string &data, const std::string &filename);
463 void request_media(const std::list<MediaRequest> &file_requests);
465 // Virtual methods from con::PeerHandler
466 void peerAdded(con::Peer *peer);
467 void deletingPeer(con::Peer *peer, bool timeout);
472 void sendPlayerPos();
473 // Send the item number 'item' as player item to the server
474 void sendPlayerItem(u16 item);
476 float m_packetcounter_timer;
477 float m_connection_reinit_timer;
478 float m_avg_rtt_timer;
479 float m_playerpos_send_timer;
480 float m_ignore_damage_timer; // Used after server moves player
481 IntervalLimiter m_map_timer_and_unload_interval;
483 IWritableTextureSource *m_tsrc;
484 IWritableShaderSource *m_shsrc;
485 IWritableItemDefManager *m_itemdef;
486 IWritableNodeDefManager *m_nodedef;
487 ISoundManager *m_sound;
488 MtEventManager *m_event;
490 MeshUpdateThread m_mesh_update_thread;
491 std::list<MediaFetchThread*> m_media_fetch_threads;
492 ClientEnvironment m_env;
493 con::Connection m_con;
494 IrrlichtDevice *m_device;
495 // Server serialization version
498 bool m_inventory_updated;
499 Inventory *m_inventory_from_server;
500 float m_inventory_from_server_age;
501 std::set<v3s16> m_active_blocks;
502 PacketCounter m_packetcounter;
503 // Block mesh animation parameters
504 float m_animation_time;
507 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
509 //u32 m_daynight_ratio;
510 Queue<std::wstring> m_chat_queue;
511 // The seed returned by the server in TOCLIENT_INIT is stored here
513 std::string m_password;
514 bool m_access_denied;
515 std::wstring m_access_denied_reason;
516 Queue<ClientEvent> m_client_event_queue;
517 FileCache m_media_cache;
518 // Mapping from media file name to SHA1 checksum
519 std::map<std::string, std::string> m_media_name_sha1_map;
520 bool m_media_receive_started;
522 u32 m_media_received_count;
523 bool m_itemdef_received;
524 bool m_nodedef_received;
526 // time_of_day speed approximation for old protocol
527 bool m_time_of_day_set;
528 float m_last_time_of_day_f;
529 float m_time_of_day_update_timer;
531 // An interval for generally sending object positions and stuff
532 float m_recommended_send_interval;
535 float m_removed_sounds_check_timer;
536 // Mapping from server sound ids to our sound ids
537 std::map<s32, int> m_sounds_server_to_client;
538 // And the other way!
539 std::map<int, s32> m_sounds_client_to_server;
540 // And relations to objects
541 std::map<int, u16> m_sounds_to_objects;
544 std::set<std::string> m_privileges;
546 // Detached inventories
548 std::map<std::string, Inventory*> m_detached_inventories;
551 #endif // !CLIENT_HEADER