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.
22 #include "clientenvironment.h"
23 #include "irrlichttypes_extrabloated.h"
28 #include <unordered_set>
29 #include "clientobject.h"
31 #include "inventorymanager.h"
32 #include "localplayer.h"
33 #include "client/hud.h"
34 #include "particles.h"
36 #include "tileanimation.h"
37 #include "mesh_generator_thread.h"
38 #include "network/address.h"
39 #include "network/peerhandler.h"
42 #define CLIENT_CHAT_MESSAGE_LIMIT_PER_10S 10.0f
48 class IWritableTextureSource;
49 class IWritableShaderSource;
50 class IWritableItemDefManager;
53 //class IWritableCraftDefManager;
54 class ClientMediaDownloader;
55 struct MapDrawControl;
61 struct MinimapMapblock;
68 enum LocalClientState {
81 PacketCounter() = default;
85 std::map<u16, u16>::iterator n = m_packets.find(command);
86 if(n == m_packets.end())
88 m_packets[command] = 1;
98 for (auto &m_packet : m_packets) {
103 void print(std::ostream &o)
105 for (const auto &m_packet : m_packets) {
106 o << "cmd "<< m_packet.first <<" count "<< m_packet.second << std::endl;
112 std::map<u16, u16> m_packets;
115 class ClientScripting;
118 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
122 NOTE: Nothing is thread-safe here.
126 const char *playername,
127 const std::string &password,
128 const std::string &address_name,
129 MapDrawControl &control,
130 IWritableTextureSource *tsrc,
131 IWritableShaderSource *shsrc,
132 IWritableItemDefManager *itemdef,
133 NodeDefManager *nodedef,
134 ISoundManager *sound,
135 MtEventManager *event,
141 DISABLE_CLASS_COPY(Client);
143 // Load local mods into memory
144 void scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
145 std::string mod_subpath);
146 inline void scanModIntoMemory(const std::string &mod_name, const std::string &mod_path)
148 scanModSubfolder(mod_name, mod_path, "");
152 request all threads managed by client to be stopped
160 The name of the local player should already be set when
161 calling this, as it is sent in the initialization.
163 void connect(Address address, bool is_local_server);
166 Stuff that references the environment is valid only as
167 long as this is not called. (eg. Players)
168 If this throws a PeerNotFoundException, the connection has
171 void step(float dtime);
177 void handleCommand(NetworkPacket* pkt);
179 void handleCommand_Null(NetworkPacket* pkt) {};
180 void handleCommand_Deprecated(NetworkPacket* pkt);
181 void handleCommand_Hello(NetworkPacket* pkt);
182 void handleCommand_AuthAccept(NetworkPacket* pkt);
183 void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
184 void handleCommand_DenySudoMode(NetworkPacket* pkt);
185 void handleCommand_AccessDenied(NetworkPacket* pkt);
186 void handleCommand_RemoveNode(NetworkPacket* pkt);
187 void handleCommand_AddNode(NetworkPacket* pkt);
188 void handleCommand_NodemetaChanged(NetworkPacket *pkt);
189 void handleCommand_BlockData(NetworkPacket* pkt);
190 void handleCommand_Inventory(NetworkPacket* pkt);
191 void handleCommand_TimeOfDay(NetworkPacket* pkt);
192 void handleCommand_ChatMessage(NetworkPacket *pkt);
193 void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
194 void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
195 void handleCommand_Movement(NetworkPacket* pkt);
196 void handleCommand_Fov(NetworkPacket *pkt);
197 void handleCommand_HP(NetworkPacket* pkt);
198 void handleCommand_Breath(NetworkPacket* pkt);
199 void handleCommand_MovePlayer(NetworkPacket* pkt);
200 void handleCommand_DeathScreen(NetworkPacket* pkt);
201 void handleCommand_AnnounceMedia(NetworkPacket* pkt);
202 void handleCommand_Media(NetworkPacket* pkt);
203 void handleCommand_NodeDef(NetworkPacket* pkt);
204 void handleCommand_ItemDef(NetworkPacket* pkt);
205 void handleCommand_PlaySound(NetworkPacket* pkt);
206 void handleCommand_StopSound(NetworkPacket* pkt);
207 void handleCommand_FadeSound(NetworkPacket *pkt);
208 void handleCommand_Privileges(NetworkPacket* pkt);
209 void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
210 void handleCommand_DetachedInventory(NetworkPacket* pkt);
211 void handleCommand_ShowFormSpec(NetworkPacket* pkt);
212 void handleCommand_SpawnParticle(NetworkPacket* pkt);
213 void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
214 void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
215 void handleCommand_HudAdd(NetworkPacket* pkt);
216 void handleCommand_HudRemove(NetworkPacket* pkt);
217 void handleCommand_HudChange(NetworkPacket* pkt);
218 void handleCommand_HudSetFlags(NetworkPacket* pkt);
219 void handleCommand_HudSetParam(NetworkPacket* pkt);
220 void handleCommand_HudSetSky(NetworkPacket* pkt);
221 void handleCommand_CloudParams(NetworkPacket* pkt);
222 void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
223 void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
224 void handleCommand_EyeOffset(NetworkPacket* pkt);
225 void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
226 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
227 void handleCommand_ModChannelSignal(NetworkPacket *pkt);
228 void handleCommand_SrpBytesSandB(NetworkPacket *pkt);
229 void handleCommand_FormspecPrepend(NetworkPacket *pkt);
230 void handleCommand_CSMRestrictionFlags(NetworkPacket *pkt);
231 void handleCommand_PlayerSpeed(NetworkPacket *pkt);
233 void ProcessData(NetworkPacket *pkt);
235 void Send(NetworkPacket* pkt);
237 void interact(InteractAction action, const PointedThing &pointed);
239 void sendNodemetaFields(v3s16 p, const std::string &formname,
240 const StringMap &fields);
241 void sendInventoryFields(const std::string &formname,
242 const StringMap &fields);
243 void sendInventoryAction(InventoryAction *a);
244 void sendChatMessage(const std::wstring &message);
245 void clearOutChatQueue();
246 void sendChangePassword(const std::string &oldpassword,
247 const std::string &newpassword);
248 void sendDamage(u16 damage);
252 ClientEnvironment& getEnv() { return m_env; }
253 ITextureSource *tsrc() { return getTextureSource(); }
254 ISoundManager *sound() { return getSoundManager(); }
255 static const std::string &getBuiltinLuaPath();
256 static const std::string &getClientModsLuaPath();
258 const std::vector<ModSpec> &getMods() const override;
259 const ModSpec* getModSpec(const std::string &modname) const override;
261 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
262 void removeNode(v3s16 p);
264 // helpers to enforce CSM restrictions
265 MapNode CSMGetNode(v3s16 p, bool *is_valid_position);
266 int CSMClampRadius(v3s16 pos, int radius);
267 v3s16 CSMClampPos(v3s16 pos);
269 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
271 void setPlayerControl(PlayerControl &control);
273 // Returns true if the inventory of the local player has been
274 // updated from the server. If it is true, it is set to false.
275 bool updateWieldedItem();
277 /* InventoryManager interface */
278 Inventory* getInventory(const InventoryLocation &loc) override;
279 void inventoryAction(InventoryAction *a) override;
281 // Send the item number 'item' as player item to the server
282 void setPlayerItem(u16 item);
284 const std::list<std::string> &getConnectedPlayerNames()
286 return m_env.getPlayerNames();
289 float getAnimationTime();
293 void setCrack(int level, v3s16 pos);
297 bool checkPrivilege(const std::string &priv) const
298 { return (m_privileges.count(priv) != 0); }
300 const std::unordered_set<std::string> &getPrivilegeList() const
301 { return m_privileges; }
303 bool getChatMessage(std::wstring &message);
304 void typeChatMessage(const std::wstring& message);
306 u64 getMapSeed(){ return m_map_seed; }
308 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
309 // Including blocks at appropriate edges
310 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
311 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
313 void updateCameraOffset(v3s16 camera_offset)
314 { m_mesh_update_thread.m_camera_offset = camera_offset; }
316 bool hasClientEvents() const { return !m_client_event_queue.empty(); }
317 // Get event from queue. If queue is empty, it triggers an assertion failure.
318 ClientEvent * getClientEvent();
320 bool accessDenied() const { return m_access_denied; }
322 bool reconnectRequested() const { return m_access_denied_reconnect; }
324 void setFatalError(const std::string &reason)
326 m_access_denied = true;
327 m_access_denied_reason = reason;
330 // Renaming accessDeniedReason to better name could be good as it's used to
331 // disconnect client when CSM failed.
332 const std::string &accessDeniedReason() const { return m_access_denied_reason; }
334 const bool itemdefReceived() const
335 { return m_itemdef_received; }
336 const bool nodedefReceived() const
337 { return m_nodedef_received; }
338 const bool mediaReceived() const
339 { return !m_media_downloader; }
340 const bool activeObjectsReceived() const
341 { return m_activeobjects_received; }
343 u16 getProtoVersion()
344 { return m_proto_ver; }
346 bool connectedToServer();
347 void confirmRegistration();
348 bool m_is_registration_confirmation_state = false;
349 bool m_simple_singleplayer_mode;
351 float mediaReceiveProgress();
353 void afterContentReceived();
358 Minimap* getMinimap() { return m_minimap; }
359 void setCamera(Camera* camera) { m_camera = camera; }
361 Camera* getCamera () { return m_camera; }
363 bool shouldShowMinimap() const;
365 // IGameDef interface
366 IItemDefManager* getItemDefManager() override;
367 const NodeDefManager* getNodeDefManager() override;
368 ICraftDefManager* getCraftDefManager() override;
369 ITextureSource* getTextureSource();
370 virtual IShaderSource* getShaderSource();
371 u16 allocateUnknownNodeId(const std::string &name) override;
372 virtual ISoundManager* getSoundManager();
373 MtEventManager* getEventManager();
374 virtual ParticleManager* getParticleManager();
375 bool checkLocalPrivilege(const std::string &priv)
376 { return checkPrivilege(priv); }
377 virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
378 const std::string* getModFile(std::string filename);
380 std::string getModStoragePath() const override;
381 bool registerModStorage(ModMetadata *meta) override;
382 void unregisterModStorage(const std::string &name) override;
384 // The following set of functions is used by ClientMediaDownloader
385 // Insert a media file appropriately into the appropriate manager
386 bool loadMedia(const std::string &data, const std::string &filename);
387 // Send a request for conventional media transfer
388 void request_media(const std::vector<std::string> &file_requests);
390 LocalClientState getState() { return m_state; }
392 void makeScreenshot();
394 inline void pushToChatQueue(ChatMessage *cec)
396 m_chat_queue.push(cec);
399 ClientScripting *getScript() { return m_script; }
400 const bool modsLoaded() const { return m_mods_loaded; }
402 void pushToEventQueue(ClientEvent *event);
404 void showMinimap(bool show = true);
406 const Address getServerAddress();
408 const std::string &getAddressName() const
410 return m_address_name;
413 inline u64 getCSMRestrictionFlags() const
415 return m_csm_restriction_flags;
418 inline bool checkCSMRestrictionFlag(CSMRestrictionFlags flag) const
420 return m_csm_restriction_flags & flag;
423 u32 getCSMNodeRangeLimit() const
425 return m_csm_restriction_noderange;
428 inline std::unordered_map<u32, u32> &getHUDTranslationMap()
430 return m_hud_server_to_client;
433 bool joinModChannel(const std::string &channel) override;
434 bool leaveModChannel(const std::string &channel) override;
435 bool sendModChannelMessage(const std::string &channel,
436 const std::string &message) override;
437 ModChannel *getModChannel(const std::string &channel) override;
439 const std::string &getFormspecPrepend() const
441 return m_env.getLocalPlayer()->formspec_prepend;
445 bool checkBuiltinIntegrity();
447 // Virtual methods from con::PeerHandler
448 void peerAdded(con::Peer *peer) override;
449 void deletingPeer(con::Peer *peer, bool timeout) override;
451 void initLocalMapSaving(const Address &address,
452 const std::string &hostname,
453 bool is_local_server);
458 void sendPlayerPos();
460 void deleteAuthData();
461 // helper method shared with clientpackethandler
462 static AuthMechanism choseAuthMech(const u32 mechs);
464 void sendInit(const std::string &playerName);
465 void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
466 void startAuth(AuthMechanism chosen_auth_mechanism);
467 void sendDeletedBlocks(std::vector<v3s16> &blocks);
468 void sendGotBlocks(const std::vector<v3s16> &blocks);
469 void sendRemovedSounds(std::vector<s32> &soundList);
472 inline std::string getPlayerName()
473 { return m_env.getLocalPlayer()->getName(); }
475 bool canSendChatMessage() const;
477 float m_packetcounter_timer = 0.0f;
478 float m_connection_reinit_timer = 0.1f;
479 float m_avg_rtt_timer = 0.0f;
480 float m_playerpos_send_timer = 0.0f;
481 IntervalLimiter m_map_timer_and_unload_interval;
483 IWritableTextureSource *m_tsrc;
484 IWritableShaderSource *m_shsrc;
485 IWritableItemDefManager *m_itemdef;
486 NodeDefManager *m_nodedef;
487 ISoundManager *m_sound;
488 MtEventManager *m_event;
491 MeshUpdateThread m_mesh_update_thread;
492 ClientEnvironment m_env;
493 ParticleManager m_particle_manager;
494 std::unique_ptr<con::Connection> m_con;
495 std::string m_address_name;
496 Camera *m_camera = nullptr;
497 Minimap *m_minimap = nullptr;
498 bool m_minimap_disabled_by_server = false;
499 // Server serialization version
502 // Used version of the protocol with server
503 // Values smaller than 25 only mean they are smaller than 25,
504 // and aren't accurate. We simply just don't know, because
505 // the server didn't send the version back then.
506 // If 0, server init hasn't been received yet.
509 bool m_update_wielded_item = false;
510 Inventory *m_inventory_from_server = nullptr;
511 float m_inventory_from_server_age = 0.0f;
512 PacketCounter m_packetcounter;
513 // Block mesh animation parameters
514 float m_animation_time = 0.0f;
515 int m_crack_level = -1;
517 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
519 //u32 m_daynight_ratio;
520 std::queue<std::wstring> m_out_chat_queue;
521 u32 m_last_chat_message_sent;
522 float m_chat_message_allowance = 5.0f;
523 std::queue<ChatMessage *> m_chat_queue;
525 // The authentication methods we can use to enter sudo mode (=change password)
526 u32 m_sudo_auth_methods;
528 // The seed returned by the server in TOCLIENT_INIT is stored here
532 std::string m_playername;
533 std::string m_password;
534 // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
535 std::string m_new_password;
536 // Usable by auth mechanisms.
537 AuthMechanism m_chosen_auth_mech;
538 void *m_auth_data = nullptr;
541 bool m_access_denied = false;
542 bool m_access_denied_reconnect = false;
543 std::string m_access_denied_reason = "";
544 std::queue<ClientEvent *> m_client_event_queue;
545 bool m_itemdef_received = false;
546 bool m_nodedef_received = false;
547 bool m_activeobjects_received = false;
548 bool m_mods_loaded = false;
549 ClientMediaDownloader *m_media_downloader;
551 // time_of_day speed approximation for old protocol
552 bool m_time_of_day_set = false;
553 float m_last_time_of_day_f = -1.0f;
554 float m_time_of_day_update_timer = 0.0f;
556 // An interval for generally sending object positions and stuff
557 float m_recommended_send_interval = 0.1f;
560 float m_removed_sounds_check_timer = 0.0f;
561 // Mapping from server sound ids to our sound ids
562 std::unordered_map<s32, int> m_sounds_server_to_client;
563 // And the other way!
564 std::unordered_map<int, s32> m_sounds_client_to_server;
565 // And relations to objects
566 std::unordered_map<int, u16> m_sounds_to_objects;
568 // Map server hud ids to client hud ids
569 std::unordered_map<u32, u32> m_hud_server_to_client;
572 std::unordered_set<std::string> m_privileges;
574 // Detached inventories
576 std::unordered_map<std::string, Inventory*> m_detached_inventories;
578 // Storage for mesh data for creating multiple instances of the same mesh
579 StringMap m_mesh_data;
582 LocalClientState m_state;
586 // Used for saving server map to disk client-side
587 MapDatabase *m_localdb = nullptr;
588 IntervalLimiter m_localdb_save_interval;
589 u16 m_cache_save_interval;
592 ClientScripting *m_script = nullptr;
593 bool m_modding_enabled;
594 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
595 float m_mod_storage_save_timer = 10.0f;
596 std::vector<ModSpec> m_mods;
599 bool m_shutdown = false;
601 // CSM restrictions byteflag
602 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
603 u32 m_csm_restriction_noderange = 8;
605 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;