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 RenderingEngine;
49 class IWritableTextureSource;
50 class IWritableShaderSource;
51 class IWritableItemDefManager;
54 //class IWritableCraftDefManager;
55 class ClientMediaDownloader;
56 struct MapDrawControl;
62 struct MinimapMapblock;
69 enum LocalClientState {
82 PacketCounter() = default;
86 auto n = m_packets.find(command);
87 if (n == m_packets.end())
88 m_packets[command] = 1;
99 void print(std::ostream &o) const;
103 std::map<u16, u32> m_packets;
106 class ClientScripting;
109 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
113 NOTE: Nothing is thread-safe here.
117 const char *playername,
118 const std::string &password,
119 const std::string &address_name,
120 MapDrawControl &control,
121 IWritableTextureSource *tsrc,
122 IWritableShaderSource *shsrc,
123 IWritableItemDefManager *itemdef,
124 NodeDefManager *nodedef,
125 ISoundManager *sound,
126 MtEventManager *event,
127 RenderingEngine *rendering_engine,
133 DISABLE_CLASS_COPY(Client);
135 // Load local mods into memory
136 void scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
137 std::string mod_subpath);
138 inline void scanModIntoMemory(const std::string &mod_name, const std::string &mod_path)
140 scanModSubfolder(mod_name, mod_path, "");
144 request all threads managed by client to be stopped
152 The name of the local player should already be set when
153 calling this, as it is sent in the initialization.
155 void connect(Address address, bool is_local_server);
158 Stuff that references the environment is valid only as
159 long as this is not called. (eg. Players)
160 If this throws a PeerNotFoundException, the connection has
163 void step(float dtime);
169 void handleCommand(NetworkPacket* pkt);
171 void handleCommand_Null(NetworkPacket* pkt) {};
172 void handleCommand_Deprecated(NetworkPacket* pkt);
173 void handleCommand_Hello(NetworkPacket* pkt);
174 void handleCommand_AuthAccept(NetworkPacket* pkt);
175 void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
176 void handleCommand_DenySudoMode(NetworkPacket* pkt);
177 void handleCommand_AccessDenied(NetworkPacket* pkt);
178 void handleCommand_RemoveNode(NetworkPacket* pkt);
179 void handleCommand_AddNode(NetworkPacket* pkt);
180 void handleCommand_NodemetaChanged(NetworkPacket *pkt);
181 void handleCommand_BlockData(NetworkPacket* pkt);
182 void handleCommand_Inventory(NetworkPacket* pkt);
183 void handleCommand_TimeOfDay(NetworkPacket* pkt);
184 void handleCommand_ChatMessage(NetworkPacket *pkt);
185 void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
186 void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
187 void handleCommand_Movement(NetworkPacket* pkt);
188 void handleCommand_Fov(NetworkPacket *pkt);
189 void handleCommand_HP(NetworkPacket* pkt);
190 void handleCommand_Breath(NetworkPacket* pkt);
191 void handleCommand_MovePlayer(NetworkPacket* pkt);
192 void handleCommand_DeathScreen(NetworkPacket* pkt);
193 void handleCommand_AnnounceMedia(NetworkPacket* pkt);
194 void handleCommand_Media(NetworkPacket* pkt);
195 void handleCommand_NodeDef(NetworkPacket* pkt);
196 void handleCommand_ItemDef(NetworkPacket* pkt);
197 void handleCommand_PlaySound(NetworkPacket* pkt);
198 void handleCommand_StopSound(NetworkPacket* pkt);
199 void handleCommand_FadeSound(NetworkPacket *pkt);
200 void handleCommand_Privileges(NetworkPacket* pkt);
201 void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
202 void handleCommand_DetachedInventory(NetworkPacket* pkt);
203 void handleCommand_ShowFormSpec(NetworkPacket* pkt);
204 void handleCommand_SpawnParticle(NetworkPacket* pkt);
205 void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
206 void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
207 void handleCommand_HudAdd(NetworkPacket* pkt);
208 void handleCommand_HudRemove(NetworkPacket* pkt);
209 void handleCommand_HudChange(NetworkPacket* pkt);
210 void handleCommand_HudSetFlags(NetworkPacket* pkt);
211 void handleCommand_HudSetParam(NetworkPacket* pkt);
212 void handleCommand_HudSetSky(NetworkPacket* pkt);
213 void handleCommand_HudSetSun(NetworkPacket* pkt);
214 void handleCommand_HudSetMoon(NetworkPacket* pkt);
215 void handleCommand_HudSetStars(NetworkPacket* pkt);
216 void handleCommand_CloudParams(NetworkPacket* pkt);
217 void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
218 void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
219 void handleCommand_EyeOffset(NetworkPacket* pkt);
220 void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
221 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
222 void handleCommand_ModChannelSignal(NetworkPacket *pkt);
223 void handleCommand_SrpBytesSandB(NetworkPacket *pkt);
224 void handleCommand_FormspecPrepend(NetworkPacket *pkt);
225 void handleCommand_CSMRestrictionFlags(NetworkPacket *pkt);
226 void handleCommand_PlayerSpeed(NetworkPacket *pkt);
227 void handleCommand_MediaPush(NetworkPacket *pkt);
228 void handleCommand_MinimapModes(NetworkPacket *pkt);
230 void ProcessData(NetworkPacket *pkt);
232 void Send(NetworkPacket* pkt);
234 void interact(InteractAction action, const PointedThing &pointed);
236 void sendNodemetaFields(v3s16 p, const std::string &formname,
237 const StringMap &fields);
238 void sendInventoryFields(const std::string &formname,
239 const StringMap &fields);
240 void sendInventoryAction(InventoryAction *a);
241 void sendChatMessage(const std::wstring &message);
242 void clearOutChatQueue();
243 void sendChangePassword(const std::string &oldpassword,
244 const std::string &newpassword);
245 void sendDamage(u16 damage);
249 ClientEnvironment& getEnv() { return m_env; }
250 ITextureSource *tsrc() { return getTextureSource(); }
251 ISoundManager *sound() { return getSoundManager(); }
252 static const std::string &getBuiltinLuaPath();
253 static const std::string &getClientModsLuaPath();
255 const std::vector<ModSpec> &getMods() const override;
256 const ModSpec* getModSpec(const std::string &modname) const override;
258 // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
259 void removeNode(v3s16 p);
261 // helpers to enforce CSM restrictions
262 MapNode CSMGetNode(v3s16 p, bool *is_valid_position);
263 int CSMClampRadius(v3s16 pos, int radius);
264 v3s16 CSMClampPos(v3s16 pos);
266 void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
268 void setPlayerControl(PlayerControl &control);
270 // Returns true if the inventory of the local player has been
271 // updated from the server. If it is true, it is set to false.
272 bool updateWieldedItem();
274 /* InventoryManager interface */
275 Inventory* getInventory(const InventoryLocation &loc) override;
276 void inventoryAction(InventoryAction *a) override;
278 // Send the item number 'item' as player item to the server
279 void setPlayerItem(u16 item);
281 const std::list<std::string> &getConnectedPlayerNames()
283 return m_env.getPlayerNames();
286 float getAnimationTime();
290 void setCrack(int level, v3s16 pos);
294 bool checkPrivilege(const std::string &priv) const
295 { return (m_privileges.count(priv) != 0); }
297 const std::unordered_set<std::string> &getPrivilegeList() const
298 { return m_privileges; }
300 bool getChatMessage(std::wstring &message);
301 void typeChatMessage(const std::wstring& message);
303 u64 getMapSeed(){ return m_map_seed; }
305 void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
306 // Including blocks at appropriate edges
307 void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
308 void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
310 void updateCameraOffset(v3s16 camera_offset)
311 { m_mesh_update_thread.m_camera_offset = camera_offset; }
313 bool hasClientEvents() const { return !m_client_event_queue.empty(); }
314 // Get event from queue. If queue is empty, it triggers an assertion failure.
315 ClientEvent * getClientEvent();
317 bool accessDenied() const { return m_access_denied; }
319 bool reconnectRequested() const { return m_access_denied_reconnect; }
321 void setFatalError(const std::string &reason)
323 m_access_denied = true;
324 m_access_denied_reason = reason;
327 // Renaming accessDeniedReason to better name could be good as it's used to
328 // disconnect client when CSM failed.
329 const std::string &accessDeniedReason() const { return m_access_denied_reason; }
331 const bool itemdefReceived() const
332 { return m_itemdef_received; }
333 const bool nodedefReceived() const
334 { return m_nodedef_received; }
335 const bool mediaReceived() const
336 { return !m_media_downloader; }
337 const bool activeObjectsReceived() const
338 { return m_activeobjects_received; }
340 u16 getProtoVersion()
341 { return m_proto_ver; }
343 void confirmRegistration();
344 bool m_is_registration_confirmation_state = false;
345 bool m_simple_singleplayer_mode;
347 float mediaReceiveProgress();
349 void afterContentReceived();
350 void showUpdateProgressTexture(void *args, u32 progress, u32 max_progress);
355 Minimap* getMinimap() { return m_minimap; }
356 void setCamera(Camera* camera) { m_camera = camera; }
358 Camera* getCamera () { return m_camera; }
359 scene::ISceneManager *getSceneManager();
361 bool shouldShowMinimap() const;
363 // IGameDef interface
364 IItemDefManager* getItemDefManager() override;
365 const NodeDefManager* getNodeDefManager() override;
366 ICraftDefManager* getCraftDefManager() override;
367 ITextureSource* getTextureSource();
368 virtual IWritableShaderSource* getShaderSource();
369 u16 allocateUnknownNodeId(const std::string &name) override;
370 virtual ISoundManager* getSoundManager();
371 MtEventManager* getEventManager();
372 virtual ParticleManager* getParticleManager();
373 bool checkLocalPrivilege(const std::string &priv)
374 { return checkPrivilege(priv); }
375 virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
376 const std::string* getModFile(std::string filename);
378 std::string getModStoragePath() const override;
379 bool registerModStorage(ModMetadata *meta) override;
380 void unregisterModStorage(const std::string &name) override;
382 // The following set of functions is used by ClientMediaDownloader
383 // Insert a media file appropriately into the appropriate manager
384 bool loadMedia(const std::string &data, const std::string &filename,
385 bool from_media_push = false);
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 bool joinModChannel(const std::string &channel) override;
424 bool leaveModChannel(const std::string &channel) override;
425 bool sendModChannelMessage(const std::string &channel,
426 const std::string &message) override;
427 ModChannel *getModChannel(const std::string &channel) override;
429 const std::string &getFormspecPrepend() const
431 return m_env.getLocalPlayer()->formspec_prepend;
436 // Virtual methods from con::PeerHandler
437 void peerAdded(con::Peer *peer) override;
438 void deletingPeer(con::Peer *peer, bool timeout) override;
440 void initLocalMapSaving(const Address &address,
441 const std::string &hostname,
442 bool is_local_server);
446 void sendPlayerPos();
448 void deleteAuthData();
449 // helper method shared with clientpackethandler
450 static AuthMechanism choseAuthMech(const u32 mechs);
452 void sendInit(const std::string &playerName);
453 void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
454 void startAuth(AuthMechanism chosen_auth_mechanism);
455 void sendDeletedBlocks(std::vector<v3s16> &blocks);
456 void sendGotBlocks(const std::vector<v3s16> &blocks);
457 void sendRemovedSounds(std::vector<s32> &soundList);
460 inline std::string getPlayerName()
461 { return m_env.getLocalPlayer()->getName(); }
463 bool canSendChatMessage() const;
465 float m_packetcounter_timer = 0.0f;
466 float m_connection_reinit_timer = 0.1f;
467 float m_avg_rtt_timer = 0.0f;
468 float m_playerpos_send_timer = 0.0f;
469 IntervalLimiter m_map_timer_and_unload_interval;
471 IWritableTextureSource *m_tsrc;
472 IWritableShaderSource *m_shsrc;
473 IWritableItemDefManager *m_itemdef;
474 NodeDefManager *m_nodedef;
475 ISoundManager *m_sound;
476 MtEventManager *m_event;
477 RenderingEngine *m_rendering_engine;
480 MeshUpdateThread m_mesh_update_thread;
481 ClientEnvironment m_env;
482 ParticleManager m_particle_manager;
483 std::unique_ptr<con::Connection> m_con;
484 std::string m_address_name;
485 Camera *m_camera = nullptr;
486 Minimap *m_minimap = nullptr;
487 bool m_minimap_disabled_by_server = false;
489 // Server serialization version
492 // Used version of the protocol with server
493 // Values smaller than 25 only mean they are smaller than 25,
494 // and aren't accurate. We simply just don't know, because
495 // the server didn't send the version back then.
496 // If 0, server init hasn't been received yet.
499 bool m_update_wielded_item = false;
500 Inventory *m_inventory_from_server = nullptr;
501 float m_inventory_from_server_age = 0.0f;
502 PacketCounter m_packetcounter;
503 // Block mesh animation parameters
504 float m_animation_time = 0.0f;
505 int m_crack_level = -1;
507 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
509 //u32 m_daynight_ratio;
510 std::queue<std::wstring> m_out_chat_queue;
511 u32 m_last_chat_message_sent;
512 float m_chat_message_allowance = 5.0f;
513 std::queue<ChatMessage *> m_chat_queue;
515 // The authentication methods we can use to enter sudo mode (=change password)
516 u32 m_sudo_auth_methods;
518 // The seed returned by the server in TOCLIENT_INIT is stored here
522 std::string m_playername;
523 std::string m_password;
524 // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
525 std::string m_new_password;
526 // Usable by auth mechanisms.
527 AuthMechanism m_chosen_auth_mech;
528 void *m_auth_data = nullptr;
530 bool m_access_denied = false;
531 bool m_access_denied_reconnect = false;
532 std::string m_access_denied_reason = "";
533 std::queue<ClientEvent *> m_client_event_queue;
534 bool m_itemdef_received = false;
535 bool m_nodedef_received = false;
536 bool m_activeobjects_received = false;
537 bool m_mods_loaded = false;
539 ClientMediaDownloader *m_media_downloader;
540 // Set of media filenames pushed by server at runtime
541 std::unordered_set<std::string> m_media_pushed_files;
543 // time_of_day speed approximation for old protocol
544 bool m_time_of_day_set = false;
545 float m_last_time_of_day_f = -1.0f;
546 float m_time_of_day_update_timer = 0.0f;
548 // An interval for generally sending object positions and stuff
549 float m_recommended_send_interval = 0.1f;
552 float m_removed_sounds_check_timer = 0.0f;
553 // Mapping from server sound ids to our sound ids
554 std::unordered_map<s32, int> m_sounds_server_to_client;
555 // And the other way!
556 std::unordered_map<int, s32> m_sounds_client_to_server;
557 // Relation of client id to object id
558 std::unordered_map<int, u16> m_sounds_to_objects;
561 std::unordered_set<std::string> m_privileges;
563 // Detached inventories
565 std::unordered_map<std::string, Inventory*> m_detached_inventories;
567 // Storage for mesh data for creating multiple instances of the same mesh
568 StringMap m_mesh_data;
571 LocalClientState m_state;
575 // Used for saving server map to disk client-side
576 MapDatabase *m_localdb = nullptr;
577 IntervalLimiter m_localdb_save_interval;
578 u16 m_cache_save_interval;
581 ClientScripting *m_script = nullptr;
582 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
583 float m_mod_storage_save_timer = 10.0f;
584 std::vector<ModSpec> m_mods;
587 bool m_shutdown = false;
589 // CSM restrictions byteflag
590 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
591 u32 m_csm_restriction_noderange = 8;
593 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;