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_HP(NetworkPacket* pkt);
197 void handleCommand_Breath(NetworkPacket* pkt);
198 void handleCommand_MovePlayer(NetworkPacket* pkt);
199 void handleCommand_DeathScreen(NetworkPacket* pkt);
200 void handleCommand_AnnounceMedia(NetworkPacket* pkt);
201 void handleCommand_Media(NetworkPacket* pkt);
202 void handleCommand_NodeDef(NetworkPacket* pkt);
203 void handleCommand_ItemDef(NetworkPacket* pkt);
204 void handleCommand_PlaySound(NetworkPacket* pkt);
205 void handleCommand_StopSound(NetworkPacket* pkt);
206 void handleCommand_FadeSound(NetworkPacket *pkt);
207 void handleCommand_Privileges(NetworkPacket* pkt);
208 void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
209 void handleCommand_DetachedInventory(NetworkPacket* pkt);
210 void handleCommand_ShowFormSpec(NetworkPacket* pkt);
211 void handleCommand_SpawnParticle(NetworkPacket* pkt);
212 void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
213 void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
214 void handleCommand_HudAdd(NetworkPacket* pkt);
215 void handleCommand_HudRemove(NetworkPacket* pkt);
216 void handleCommand_HudChange(NetworkPacket* pkt);
217 void handleCommand_HudSetFlags(NetworkPacket* pkt);
218 void handleCommand_HudSetParam(NetworkPacket* pkt);
219 void handleCommand_HudSetSky(NetworkPacket* pkt);
220 void handleCommand_CloudParams(NetworkPacket* pkt);
221 void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
222 void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
223 void handleCommand_EyeOffset(NetworkPacket* pkt);
224 void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
225 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
226 void handleCommand_ModChannelSignal(NetworkPacket *pkt);
227 void handleCommand_SrpBytesSandB(NetworkPacket *pkt);
228 void handleCommand_FormspecPrepend(NetworkPacket *pkt);
229 void handleCommand_CSMRestrictionFlags(NetworkPacket *pkt);
230 void handleCommand_PlayerSpeed(NetworkPacket *pkt);
232 void ProcessData(NetworkPacket *pkt);
234 void Send(NetworkPacket* pkt);
236 void interact(InteractAction action, const PointedThing &pointed);
238 void sendNodemetaFields(v3s16 p, const std::string &formname,
239 const StringMap &fields);
240 void sendInventoryFields(const std::string &formname,
241 const StringMap &fields);
242 void sendInventoryAction(InventoryAction *a);
243 void sendChatMessage(const std::wstring &message);
244 void clearOutChatQueue();
245 void sendChangePassword(const std::string &oldpassword,
246 const std::string &newpassword);
247 void sendDamage(u16 damage);
251 ClientEnvironment& getEnv() { return m_env; }
252 ITextureSource *tsrc() { return getTextureSource(); }
253 ISoundManager *sound() { return getSoundManager(); }
254 static const std::string &getBuiltinLuaPath();
255 static const std::string &getClientModsLuaPath();
257 const std::vector<ModSpec> &getMods() const override;
258 const ModSpec* getModSpec(const std::string &modname) const override;
260 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
261 void removeNode(v3s16 p);
264 * Helper function for Client Side Modding
265 * CSM restrictions are applied there, this should not be used for core engine
267 * @param is_valid_position
270 MapNode getNode(v3s16 p, bool *is_valid_position);
271 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
273 void setPlayerControl(PlayerControl &control);
275 // Returns true if the inventory of the local player has been
276 // updated from the server. If it is true, it is set to false.
277 bool updateWieldedItem();
279 /* InventoryManager interface */
280 Inventory* getInventory(const InventoryLocation &loc) override;
281 void inventoryAction(InventoryAction *a) override;
283 // Send the item number 'item' as player item to the server
284 void setPlayerItem(u16 item);
286 const std::list<std::string> &getConnectedPlayerNames()
288 return m_env.getPlayerNames();
291 float getAnimationTime();
295 void setCrack(int level, v3s16 pos);
299 bool checkPrivilege(const std::string &priv) const
300 { return (m_privileges.count(priv) != 0); }
302 const std::unordered_set<std::string> &getPrivilegeList() const
303 { return m_privileges; }
305 bool getChatMessage(std::wstring &message);
306 void typeChatMessage(const std::wstring& message);
308 u64 getMapSeed(){ return m_map_seed; }
310 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
311 // Including blocks at appropriate edges
312 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
313 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
315 void updateCameraOffset(v3s16 camera_offset)
316 { m_mesh_update_thread.m_camera_offset = camera_offset; }
318 bool hasClientEvents() const { return !m_client_event_queue.empty(); }
319 // Get event from queue. If queue is empty, it triggers an assertion failure.
320 ClientEvent * getClientEvent();
322 bool accessDenied() const { return m_access_denied; }
324 bool reconnectRequested() const { return m_access_denied_reconnect; }
326 void setFatalError(const std::string &reason)
328 m_access_denied = true;
329 m_access_denied_reason = reason;
332 // Renaming accessDeniedReason to better name could be good as it's used to
333 // disconnect client when CSM failed.
334 const std::string &accessDeniedReason() const { return m_access_denied_reason; }
336 bool itemdefReceived()
337 { return m_itemdef_received; }
338 bool nodedefReceived()
339 { return m_nodedef_received; }
341 { return !m_media_downloader; }
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(const 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 moddingEnabled() const { return m_modding_enabled; }
401 const bool modsLoaded() const { return m_mods_loaded; }
403 void pushToEventQueue(ClientEvent *event);
405 void showMinimap(bool show = true);
407 const Address getServerAddress();
409 const std::string &getAddressName() const
411 return m_address_name;
414 inline bool checkCSMRestrictionFlag(CSMRestrictionFlags flag) const
416 return m_csm_restriction_flags & flag;
419 u32 getCSMNodeRangeLimit() const
421 return m_csm_restriction_noderange;
424 inline std::unordered_map<u32, u32> &getHUDTranslationMap()
426 return m_hud_server_to_client;
429 bool joinModChannel(const std::string &channel) override;
430 bool leaveModChannel(const std::string &channel) override;
431 bool sendModChannelMessage(const std::string &channel,
432 const std::string &message) override;
433 ModChannel *getModChannel(const std::string &channel) override;
435 const std::string &getFormspecPrepend() const
437 return m_env.getLocalPlayer()->formspec_prepend;
441 bool checkBuiltinIntegrity();
443 // Virtual methods from con::PeerHandler
444 void peerAdded(con::Peer *peer) override;
445 void deletingPeer(con::Peer *peer, bool timeout) override;
447 void initLocalMapSaving(const Address &address,
448 const std::string &hostname,
449 bool is_local_server);
454 void sendPlayerPos();
456 void deleteAuthData();
457 // helper method shared with clientpackethandler
458 static AuthMechanism choseAuthMech(const u32 mechs);
460 void sendInit(const std::string &playerName);
461 void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
462 void startAuth(AuthMechanism chosen_auth_mechanism);
463 void sendDeletedBlocks(std::vector<v3s16> &blocks);
464 void sendGotBlocks(const std::vector<v3s16> &blocks);
465 void sendRemovedSounds(std::vector<s32> &soundList);
468 inline std::string getPlayerName()
469 { return m_env.getLocalPlayer()->getName(); }
471 bool canSendChatMessage() const;
473 float m_packetcounter_timer = 0.0f;
474 float m_connection_reinit_timer = 0.1f;
475 float m_avg_rtt_timer = 0.0f;
476 float m_playerpos_send_timer = 0.0f;
477 IntervalLimiter m_map_timer_and_unload_interval;
479 IWritableTextureSource *m_tsrc;
480 IWritableShaderSource *m_shsrc;
481 IWritableItemDefManager *m_itemdef;
482 NodeDefManager *m_nodedef;
483 ISoundManager *m_sound;
484 MtEventManager *m_event;
487 MeshUpdateThread m_mesh_update_thread;
488 ClientEnvironment m_env;
489 ParticleManager m_particle_manager;
490 std::unique_ptr<con::Connection> m_con;
491 std::string m_address_name;
492 Camera *m_camera = nullptr;
493 Minimap *m_minimap = nullptr;
494 bool m_minimap_disabled_by_server = false;
495 // Server serialization version
498 // Used version of the protocol with server
499 // Values smaller than 25 only mean they are smaller than 25,
500 // and aren't accurate. We simply just don't know, because
501 // the server didn't send the version back then.
502 // If 0, server init hasn't been received yet.
505 bool m_update_wielded_item = false;
506 Inventory *m_inventory_from_server = nullptr;
507 float m_inventory_from_server_age = 0.0f;
508 PacketCounter m_packetcounter;
509 // Block mesh animation parameters
510 float m_animation_time = 0.0f;
511 int m_crack_level = -1;
513 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
515 //u32 m_daynight_ratio;
516 std::queue<std::wstring> m_out_chat_queue;
517 u32 m_last_chat_message_sent;
518 float m_chat_message_allowance = 5.0f;
519 std::queue<ChatMessage *> m_chat_queue;
521 // The authentication methods we can use to enter sudo mode (=change password)
522 u32 m_sudo_auth_methods;
524 // The seed returned by the server in TOCLIENT_INIT is stored here
528 std::string m_playername;
529 std::string m_password;
530 // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
531 std::string m_new_password;
532 // Usable by auth mechanisms.
533 AuthMechanism m_chosen_auth_mech;
534 void *m_auth_data = nullptr;
537 bool m_access_denied = false;
538 bool m_access_denied_reconnect = false;
539 std::string m_access_denied_reason = "";
540 std::queue<ClientEvent *> m_client_event_queue;
541 bool m_itemdef_received = false;
542 bool m_nodedef_received = false;
543 bool m_mods_loaded = false;
544 ClientMediaDownloader *m_media_downloader;
546 // time_of_day speed approximation for old protocol
547 bool m_time_of_day_set = false;
548 float m_last_time_of_day_f = -1.0f;
549 float m_time_of_day_update_timer = 0.0f;
551 // An interval for generally sending object positions and stuff
552 float m_recommended_send_interval = 0.1f;
555 float m_removed_sounds_check_timer = 0.0f;
556 // Mapping from server sound ids to our sound ids
557 std::unordered_map<s32, int> m_sounds_server_to_client;
558 // And the other way!
559 std::unordered_map<int, s32> m_sounds_client_to_server;
560 // And relations to objects
561 std::unordered_map<int, u16> m_sounds_to_objects;
563 // Map server hud ids to client hud ids
564 std::unordered_map<u32, u32> m_hud_server_to_client;
567 std::unordered_set<std::string> m_privileges;
569 // Detached inventories
571 std::unordered_map<std::string, Inventory*> m_detached_inventories;
573 // Storage for mesh data for creating multiple instances of the same mesh
574 StringMap m_mesh_data;
576 StringMap m_mod_files;
579 LocalClientState m_state;
583 // Used for saving server map to disk client-side
584 MapDatabase *m_localdb = nullptr;
585 IntervalLimiter m_localdb_save_interval;
586 u16 m_cache_save_interval;
588 ClientScripting *m_script = nullptr;
589 bool m_modding_enabled;
590 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
591 float m_mod_storage_save_timer = 10.0f;
592 std::vector<ModSpec> m_mods;
594 bool m_shutdown = false;
596 // CSM restrictions byteflag
597 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
598 u32 m_csm_restriction_noderange = 8;
600 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;