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 "network/connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_extrabloated.h"
26 #include "jthread/jmutex.h"
31 #include "clientobject.h"
33 #include "inventorymanager.h"
34 #include "localplayer.h"
36 #include "particles.h"
37 #include "network/networkpacket.h"
41 class IWritableTextureSource;
42 class IWritableShaderSource;
43 class IWritableItemDefManager;
44 class IWritableNodeDefManager;
45 //class IWritableCraftDefManager;
46 class ClientMediaDownloader;
47 struct MapDrawControl;
52 struct QueuedMeshUpdate
56 bool ack_block_to_server;
62 enum LocalClientState {
69 A thread-safe queue of mesh update tasks
79 peer_id=0 adds with nobody to send to
81 void addBlock(v3s16 p, MeshMakeData *data,
82 bool ack_block_to_server, bool urgent);
84 // Returned pointer must be deleted
85 // Returns NULL if queue is empty
86 QueuedMeshUpdate * pop();
90 JMutexAutoLock lock(m_mutex);
91 return m_queue.size();
95 std::vector<QueuedMeshUpdate*> m_queue;
96 std::set<v3s16> m_urgents;
100 struct MeshUpdateResult
104 bool ack_block_to_server;
107 p(-1338,-1338,-1338),
109 ack_block_to_server(false)
114 class MeshUpdateThread : public JThread
118 MeshUpdateThread(IGameDef *gamedef):
125 MeshUpdateQueue m_queue_in;
127 MutexedQueue<MeshUpdateResult> m_queue_out;
131 v3s16 m_camera_offset;
138 CE_PLAYER_FORCE_MOVE,
142 CE_ADD_PARTICLESPAWNER,
143 CE_DELETE_PARTICLESPAWNER,
148 CE_OVERRIDE_DAY_NIGHT_RATIO,
153 ClientEventType type;
165 bool set_camera_point_target;
166 f32 camera_point_target_x;
167 f32 camera_point_target_y;
168 f32 camera_point_target_z;
171 std::string *formspec;
172 std::string *formname;
175 //} textures_updated;
182 bool collisiondetection;
184 std::string *texture;
199 bool collisiondetection;
201 std::string *texture;
203 } add_particlespawner;
206 } delete_particlespawner;
235 video::SColor *bgcolor;
237 std::vector<std::string> *params;
242 } override_day_night_ratio;
257 void add(u16 command)
259 std::map<u16, u16>::iterator n = m_packets.find(command);
260 if(n == m_packets.end())
262 m_packets[command] = 1;
272 for(std::map<u16, u16>::iterator
273 i = m_packets.begin();
274 i != m_packets.end(); ++i)
280 void print(std::ostream &o)
282 for(std::map<u16, u16>::iterator
283 i = m_packets.begin();
284 i != m_packets.end(); ++i)
287 <<" count "<<i->second
294 std::map<u16, u16> m_packets;
297 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
301 NOTE: Nothing is thread-safe here.
305 IrrlichtDevice *device,
306 const char *playername,
307 std::string password,
308 MapDrawControl &control,
309 IWritableTextureSource *tsrc,
310 IWritableShaderSource *shsrc,
311 IWritableItemDefManager *itemdef,
312 IWritableNodeDefManager *nodedef,
313 ISoundManager *sound,
314 MtEventManager *event,
321 request all threads managed by client to be stopped
329 The name of the local player should already be set when
330 calling this, as it is sent in the initialization.
332 void connect(Address address,
333 const std::string &address_name,
334 bool is_local_server);
337 Stuff that references the environment is valid only as
338 long as this is not called. (eg. Players)
339 If this throws a PeerNotFoundException, the connection has
342 void step(float dtime);
348 void handleCommand(NetworkPacket* pkt);
350 void handleCommand_Null(NetworkPacket* pkt) {};
351 void handleCommand_Deprecated(NetworkPacket* pkt);
352 void handleCommand_Hello(NetworkPacket* pkt);
353 void handleCommand_AuthAccept(NetworkPacket* pkt);
354 void handleCommand_InitLegacy(NetworkPacket* pkt);
355 void handleCommand_AccessDenied(NetworkPacket* pkt);
356 void handleCommand_RemoveNode(NetworkPacket* pkt);
357 void handleCommand_AddNode(NetworkPacket* pkt);
358 void handleCommand_BlockData(NetworkPacket* pkt);
359 void handleCommand_Inventory(NetworkPacket* pkt);
360 void handleCommand_TimeOfDay(NetworkPacket* pkt);
361 void handleCommand_ChatMessage(NetworkPacket* pkt);
362 void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
363 void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
364 void handleCommand_Movement(NetworkPacket* pkt);
365 void handleCommand_HP(NetworkPacket* pkt);
366 void handleCommand_Breath(NetworkPacket* pkt);
367 void handleCommand_MovePlayer(NetworkPacket* pkt);
368 void handleCommand_PlayerItem(NetworkPacket* pkt);
369 void handleCommand_DeathScreen(NetworkPacket* pkt);
370 void handleCommand_AnnounceMedia(NetworkPacket* pkt);
371 void handleCommand_Media(NetworkPacket* pkt);
372 void handleCommand_ToolDef(NetworkPacket* pkt);
373 void handleCommand_NodeDef(NetworkPacket* pkt);
374 void handleCommand_CraftItemDef(NetworkPacket* pkt);
375 void handleCommand_ItemDef(NetworkPacket* pkt);
376 void handleCommand_PlaySound(NetworkPacket* pkt);
377 void handleCommand_StopSound(NetworkPacket* pkt);
378 void handleCommand_Privileges(NetworkPacket* pkt);
379 void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
380 void handleCommand_DetachedInventory(NetworkPacket* pkt);
381 void handleCommand_ShowFormSpec(NetworkPacket* pkt);
382 void handleCommand_SpawnParticle(NetworkPacket* pkt);
383 void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
384 void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
385 void handleCommand_HudAdd(NetworkPacket* pkt);
386 void handleCommand_HudRemove(NetworkPacket* pkt);
387 void handleCommand_HudChange(NetworkPacket* pkt);
388 void handleCommand_HudSetFlags(NetworkPacket* pkt);
389 void handleCommand_HudSetParam(NetworkPacket* pkt);
390 void handleCommand_HudSetSky(NetworkPacket* pkt);
391 void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
392 void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
393 void handleCommand_EyeOffset(NetworkPacket* pkt);
395 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
397 // Returns true if something was received
398 bool AsyncProcessPacket();
399 bool AsyncProcessData();
400 void Send(NetworkPacket* pkt);
402 void interact(u8 action, const PointedThing& pointed);
404 void sendNodemetaFields(v3s16 p, const std::string &formname,
405 const std::map<std::string, std::string> &fields);
406 void sendInventoryFields(const std::string &formname,
407 const std::map<std::string, std::string> &fields);
408 void sendInventoryAction(InventoryAction *a);
409 void sendChatMessage(const std::wstring &message);
410 void sendChangePassword(const std::wstring &oldpassword,
411 const std::wstring &newpassword);
412 void sendDamage(u8 damage);
413 void sendBreath(u16 breath);
417 ClientEnvironment& getEnv()
420 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
421 void removeNode(v3s16 p);
422 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
424 void setPlayerControl(PlayerControl &control);
426 void selectPlayerItem(u16 item);
427 u16 getPlayerItem() const
428 { return m_playeritem; }
430 // Returns true if the inventory of the local player has been
431 // updated from the server. If it is true, it is set to false.
432 bool getLocalInventoryUpdated();
433 // Copies the inventory of the local player to parameter
434 void getLocalInventory(Inventory &dst);
436 /* InventoryManager interface */
437 Inventory* getInventory(const InventoryLocation &loc);
438 void inventoryAction(InventoryAction *a);
440 // Gets closest object pointed by the shootline
441 // Returns NULL if not found
442 ClientActiveObject * getSelectedActiveObject(
444 v3f from_pos_f_on_map,
445 core::line3d<f32> shootline_on_map
448 std::list<std::string> getConnectedPlayerNames();
450 float getAnimationTime();
453 void setCrack(int level, v3s16 pos);
455 void setHighlighted(v3s16 pos, bool show_higlighted);
456 v3s16 getHighlighted(){ return m_highlighted_pos; }
461 bool checkPrivilege(const std::string &priv)
462 { return (m_privileges.count(priv) != 0); }
464 bool getChatMessage(std::wstring &message);
465 void typeChatMessage(const std::wstring& message);
467 u64 getMapSeed(){ return m_map_seed; }
469 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
470 // Including blocks at appropriate edges
471 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
472 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
474 void updateCameraOffset(v3s16 camera_offset)
475 { m_mesh_update_thread.m_camera_offset = camera_offset; }
477 // Get event from queue. CE_NONE is returned if queue is empty.
478 ClientEvent getClientEvent();
481 { return m_access_denied; }
483 std::wstring accessDeniedReason()
484 { return m_access_denied_reason; }
486 bool itemdefReceived()
487 { return m_itemdef_received; }
488 bool nodedefReceived()
489 { return m_nodedef_received; }
491 { return m_media_downloader == NULL; }
493 float mediaReceiveProgress();
495 void afterContentReceived(IrrlichtDevice *device);
498 float getCurRate(void);
499 float getAvgRate(void);
501 // IGameDef interface
502 virtual IItemDefManager* getItemDefManager();
503 virtual INodeDefManager* getNodeDefManager();
504 virtual ICraftDefManager* getCraftDefManager();
505 virtual ITextureSource* getTextureSource();
506 virtual IShaderSource* getShaderSource();
507 virtual scene::ISceneManager* getSceneManager();
508 virtual u16 allocateUnknownNodeId(const std::string &name);
509 virtual ISoundManager* getSoundManager();
510 virtual MtEventManager* getEventManager();
511 virtual ParticleManager* getParticleManager();
512 virtual bool checkLocalPrivilege(const std::string &priv)
513 { return checkPrivilege(priv); }
514 virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
516 // The following set of functions is used by ClientMediaDownloader
517 // Insert a media file appropriately into the appropriate manager
518 bool loadMedia(const std::string &data, const std::string &filename);
519 // Send a request for conventional media transfer
520 void request_media(const std::vector<std::string> &file_requests);
521 // Send a notification that no conventional media transfer is needed
522 void received_media();
524 LocalClientState getState() { return m_state; }
526 void makeScreenshot(IrrlichtDevice *device);
530 // Virtual methods from con::PeerHandler
531 void peerAdded(con::Peer *peer);
532 void deletingPeer(con::Peer *peer, bool timeout);
534 void initLocalMapSaving(const Address &address,
535 const std::string &hostname,
536 bool is_local_server);
541 void sendPlayerPos();
542 // Send the item number 'item' as player item to the server
543 void sendPlayerItem(u16 item);
545 float m_packetcounter_timer;
546 float m_connection_reinit_timer;
547 float m_avg_rtt_timer;
548 float m_playerpos_send_timer;
549 float m_ignore_damage_timer; // Used after server moves player
550 IntervalLimiter m_map_timer_and_unload_interval;
552 IWritableTextureSource *m_tsrc;
553 IWritableShaderSource *m_shsrc;
554 IWritableItemDefManager *m_itemdef;
555 IWritableNodeDefManager *m_nodedef;
556 ISoundManager *m_sound;
557 MtEventManager *m_event;
560 MeshUpdateThread m_mesh_update_thread;
561 ClientEnvironment m_env;
562 ParticleManager m_particle_manager;
563 con::Connection m_con;
564 IrrlichtDevice *m_device;
565 // Server serialization version
568 bool m_inventory_updated;
569 Inventory *m_inventory_from_server;
570 float m_inventory_from_server_age;
571 std::set<v3s16> m_active_blocks;
572 PacketCounter m_packetcounter;
573 bool m_show_highlighted;
574 // Block mesh animation parameters
575 float m_animation_time;
578 v3s16 m_highlighted_pos;
579 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
581 //u32 m_daynight_ratio;
582 std::queue<std::wstring> m_chat_queue;
583 // The seed returned by the server in TOCLIENT_INIT is stored here
585 std::string m_password;
586 bool m_access_denied;
587 std::wstring m_access_denied_reason;
588 std::queue<ClientEvent> m_client_event_queue;
589 bool m_itemdef_received;
590 bool m_nodedef_received;
591 ClientMediaDownloader *m_media_downloader;
593 // time_of_day speed approximation for old protocol
594 bool m_time_of_day_set;
595 float m_last_time_of_day_f;
596 float m_time_of_day_update_timer;
598 // An interval for generally sending object positions and stuff
599 float m_recommended_send_interval;
602 float m_removed_sounds_check_timer;
603 // Mapping from server sound ids to our sound ids
604 std::map<s32, int> m_sounds_server_to_client;
605 // And the other way!
606 std::map<int, s32> m_sounds_client_to_server;
607 // And relations to objects
608 std::map<int, u16> m_sounds_to_objects;
611 std::set<std::string> m_privileges;
613 // Detached inventories
615 std::map<std::string, Inventory*> m_detached_inventories;
617 // Storage for mesh data for creating multiple instances of the same mesh
618 std::map<std::string, std::string> m_mesh_data;
621 LocalClientState m_state;
623 // Used for saving server map to disk client-side
625 IntervalLimiter m_localdb_save_interval;
626 u16 m_cache_save_interval;
628 // TODO: Add callback to update these when g_settings changes
629 bool m_cache_smooth_lighting;
630 bool m_cache_enable_shaders;
633 #endif // !CLIENT_HEADER