src/client/client.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include "clientenvironment.h"
  23 #include "irrlichttypes_extrabloated.h"
  24 #include <ostream>
  25 #include <map>
  26 #include <set>
  27 #include <vector>
  28 #include <unordered_set>
  29 #include "clientobject.h"
  30 #include "gamedef.h"
  31 #include "inventorymanager.h"
  32 #include "localplayer.h"
  33 #include "client/hud.h"
  34 #include "particles.h"
  35 #include "mapnode.h"
  36 #include "tileanimation.h"
  37 #include "mesh_generator_thread.h"
  38 #include "network/address.h"
  39 #include "network/peerhandler.h"
  40 #include <fstream>
  41
  42 #define CLIENT_CHAT_MESSAGE_LIMIT_PER_10S 10.0f
  43
  44 struct ClientEvent;
  45 struct MeshMakeData;
  46 struct ChatMessage;
  47 class MapBlockMesh;
  48 class IWritableTextureSource;
  49 class IWritableShaderSource;
  50 class IWritableItemDefManager;
  51 class ISoundManager;
  52 class NodeDefManager;
  53 //class IWritableCraftDefManager;
  54 class ClientMediaDownloader;
  55 struct MapDrawControl;
  56 class ModChannelMgr;
  57 class MtEventManager;
  58 struct PointedThing;
  59 class MapDatabase;
  60 class Minimap;
  61 struct MinimapMapblock;
  62 class Camera;
  63 class NetworkPacket;
  64 namespace con {
  65 class Connection;
  66 }
  67
  68 enum LocalClientState {
  69         LC_Created,
  70         LC_Init,
  71         LC_Ready
  72 };
  73
  74 /*
  75         Packet counter
  76 */
  77
  78 class PacketCounter
  79 {
  80 public:
  81         PacketCounter() = default;
  82
  83         void add(u16 command)
  84         {
  85                 auto n = m_packets.find(command);
  86                 if (n == m_packets.end())
  87                         m_packets[command] = 1;
  88                 else
  89                         n->second++;
  90         }
  91
  92         void clear()
  93         {
  94                 m_packets.clear();
  95         }
  96
  97         u32 sum() const;
  98         void print(std::ostream &o) const;
  99
 100 private:
 101         // command, count
 102         std::map<u16, u32> m_packets;
 103 };
 104
 105 class ClientScripting;
 106 class GameUI;
 107
 108 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 109 {
 110 public:
 111         /*
 112                 NOTE: Nothing is thread-safe here.
 113         */
 114
 115         Client(
 116                         const char *playername,
 117                         const std::string &password,
 118                         const std::string &address_name,
 119                         MapDrawControl &control,
 120                         IWritableTextureSource *tsrc,
 121                         IWritableShaderSource *shsrc,
 122                         IWritableItemDefManager *itemdef,
 123                         NodeDefManager *nodedef,
 124                         ISoundManager *sound,
 125                         MtEventManager *event,
 126                         bool ipv6,
 127                         GameUI *game_ui
 128         );
 129
 130         ~Client();
 131         DISABLE_CLASS_COPY(Client);
 132
 133         // Load local mods into memory
 134         void scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
 135                                 std::string mod_subpath);
 136         inline void scanModIntoMemory(const std::string &mod_name, const std::string &mod_path)
 137         {
 138                 scanModSubfolder(mod_name, mod_path, "");
 139         }
 140
 141         /*
 142          request all threads managed by client to be stopped
 143          */
 144         void Stop();
 145
 146
 147         bool isShutdown();
 148
 149         /*
 150                 The name of the local player should already be set when
 151                 calling this, as it is sent in the initialization.
 152         */
 153         void connect(Address address, bool is_local_server);
 154
 155         /*
 156                 Stuff that references the environment is valid only as
 157                 long as this is not called. (eg. Players)
 158                 If this throws a PeerNotFoundException, the connection has
 159                 timed out.
 160         */
 161         void step(float dtime);
 162
 163         /*
 164          * Command Handlers
 165          */
 166
 167         void handleCommand(NetworkPacket* pkt);
 168
 169         void handleCommand_Null(NetworkPacket* pkt) {};
 170         void handleCommand_Deprecated(NetworkPacket* pkt);
 171         void handleCommand_Hello(NetworkPacket* pkt);
 172         void handleCommand_AuthAccept(NetworkPacket* pkt);
 173         void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
 174         void handleCommand_DenySudoMode(NetworkPacket* pkt);
 175         void handleCommand_AccessDenied(NetworkPacket* pkt);
 176         void handleCommand_RemoveNode(NetworkPacket* pkt);
 177         void handleCommand_AddNode(NetworkPacket* pkt);
 178         void handleCommand_NodemetaChanged(NetworkPacket *pkt);
 179         void handleCommand_BlockData(NetworkPacket* pkt);
 180         void handleCommand_Inventory(NetworkPacket* pkt);
 181         void handleCommand_TimeOfDay(NetworkPacket* pkt);
 182         void handleCommand_ChatMessage(NetworkPacket *pkt);
 183         void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
 184         void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
 185         void handleCommand_Movement(NetworkPacket* pkt);
 186         void handleCommand_Fov(NetworkPacket *pkt);
 187         void handleCommand_HP(NetworkPacket* pkt);
 188         void handleCommand_Breath(NetworkPacket* pkt);
 189         void handleCommand_MovePlayer(NetworkPacket* pkt);
 190         void handleCommand_DeathScreen(NetworkPacket* pkt);
 191         void handleCommand_AnnounceMedia(NetworkPacket* pkt);
 192         void handleCommand_Media(NetworkPacket* pkt);
 193         void handleCommand_NodeDef(NetworkPacket* pkt);
 194         void handleCommand_ItemDef(NetworkPacket* pkt);
 195         void handleCommand_PlaySound(NetworkPacket* pkt);
 196         void handleCommand_StopSound(NetworkPacket* pkt);
 197         void handleCommand_FadeSound(NetworkPacket *pkt);
 198         void handleCommand_Privileges(NetworkPacket* pkt);
 199         void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
 200         void handleCommand_DetachedInventory(NetworkPacket* pkt);
 201         void handleCommand_ShowFormSpec(NetworkPacket* pkt);
 202         void handleCommand_SpawnParticle(NetworkPacket* pkt);
 203         void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
 204         void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
 205         void handleCommand_HudAdd(NetworkPacket* pkt);
 206         void handleCommand_HudRemove(NetworkPacket* pkt);
 207         void handleCommand_HudChange(NetworkPacket* pkt);
 208         void handleCommand_HudSetFlags(NetworkPacket* pkt);
 209         void handleCommand_HudSetParam(NetworkPacket* pkt);
 210         void handleCommand_HudSetSky(NetworkPacket* pkt);
 211         void handleCommand_HudSetSun(NetworkPacket* pkt);
 212         void handleCommand_HudSetMoon(NetworkPacket* pkt);
 213         void handleCommand_HudSetStars(NetworkPacket* pkt);
 214         void handleCommand_CloudParams(NetworkPacket* pkt);
 215         void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
 216         void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
 217         void handleCommand_EyeOffset(NetworkPacket* pkt);
 218         void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
 219         void handleCommand_ModChannelMsg(NetworkPacket *pkt);
 220         void handleCommand_ModChannelSignal(NetworkPacket *pkt);
 221         void handleCommand_SrpBytesSandB(NetworkPacket *pkt);
 222         void handleCommand_FormspecPrepend(NetworkPacket *pkt);
 223         void handleCommand_CSMRestrictionFlags(NetworkPacket *pkt);
 224         void handleCommand_PlayerSpeed(NetworkPacket *pkt);
 225
 226         void ProcessData(NetworkPacket *pkt);
 227
 228         void Send(NetworkPacket* pkt);
 229
 230         void interact(InteractAction action, const PointedThing &pointed);
 231
 232         void sendNodemetaFields(v3s16 p, const std::string &formname,
 233                 const StringMap &fields);
 234         void sendInventoryFields(const std::string &formname,
 235                 const StringMap &fields);
 236         void sendInventoryAction(InventoryAction *a);
 237         void sendChatMessage(const std::wstring &message);
 238         void clearOutChatQueue();
 239         void sendChangePassword(const std::string &oldpassword,
 240                 const std::string &newpassword);
 241         void sendDamage(u16 damage);
 242         void sendRespawn();
 243         void sendReady();
 244
 245         ClientEnvironment& getEnv() { return m_env; }
 246         ITextureSource *tsrc() { return getTextureSource(); }
 247         ISoundManager *sound() { return getSoundManager(); }
 248         static const std::string &getBuiltinLuaPath();
 249         static const std::string &getClientModsLuaPath();
 250
 251         const std::vector<ModSpec> &getMods() const override;
 252         const ModSpec* getModSpec(const std::string &modname) const override;
 253
 254         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 255         void removeNode(v3s16 p);
 256
 257         // helpers to enforce CSM restrictions
 258         MapNode CSMGetNode(v3s16 p, bool *is_valid_position);
 259         int CSMClampRadius(v3s16 pos, int radius);
 260         v3s16 CSMClampPos(v3s16 pos);
 261
 262         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 263
 264         void setPlayerControl(PlayerControl &control);
 265
 266         // Returns true if the inventory of the local player has been
 267         // updated from the server. If it is true, it is set to false.
 268         bool updateWieldedItem();
 269
 270         /* InventoryManager interface */
 271         Inventory* getInventory(const InventoryLocation &loc) override;
 272         void inventoryAction(InventoryAction *a) override;
 273
 274         // Send the item number 'item' as player item to the server
 275         void setPlayerItem(u16 item);
 276
 277         const std::list<std::string> &getConnectedPlayerNames()
 278         {
 279                 return m_env.getPlayerNames();
 280         }
 281
 282         float getAnimationTime();
 283
 284         int getCrackLevel();
 285         v3s16 getCrackPos();
 286         void setCrack(int level, v3s16 pos);
 287
 288         u16 getHP();
 289
 290         bool checkPrivilege(const std::string &priv) const
 291         { return (m_privileges.count(priv) != 0); }
 292
 293         const std::unordered_set<std::string> &getPrivilegeList() const
 294         { return m_privileges; }
 295
 296         bool getChatMessage(std::wstring &message);
 297         void typeChatMessage(const std::wstring& message);
 298
 299         u64 getMapSeed(){ return m_map_seed; }
 300
 301         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 302         // Including blocks at appropriate edges
 303         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 304         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 305
 306         void updateCameraOffset(v3s16 camera_offset)
 307         { m_mesh_update_thread.m_camera_offset = camera_offset; }
 308
 309         bool hasClientEvents() const { return !m_client_event_queue.empty(); }
 310         // Get event from queue. If queue is empty, it triggers an assertion failure.
 311         ClientEvent * getClientEvent();
 312
 313         bool accessDenied() const { return m_access_denied; }
 314
 315         bool reconnectRequested() const { return m_access_denied_reconnect; }
 316
 317         void setFatalError(const std::string &reason)
 318         {
 319                 m_access_denied = true;
 320                 m_access_denied_reason = reason;
 321         }
 322
 323         // Renaming accessDeniedReason to better name could be good as it's used to
 324         // disconnect client when CSM failed.
 325         const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 326
 327         const bool itemdefReceived() const
 328         { return m_itemdef_received; }
 329         const bool nodedefReceived() const
 330         { return m_nodedef_received; }
 331         const bool mediaReceived() const
 332         { return !m_media_downloader; }
 333         const bool activeObjectsReceived() const
 334         { return m_activeobjects_received; }
 335
 336         u16 getProtoVersion()
 337         { return m_proto_ver; }
 338
 339         bool connectedToServer();
 340         void confirmRegistration();
 341         bool m_is_registration_confirmation_state = false;
 342         bool m_simple_singleplayer_mode;
 343
 344         float mediaReceiveProgress();
 345
 346         void afterContentReceived();
 347
 348         float getRTT();
 349         float getCurRate();
 350
 351         Minimap* getMinimap() { return m_minimap; }
 352         void setCamera(Camera* camera) { m_camera = camera; }
 353
 354         Camera* getCamera () { return m_camera; }
 355
 356         bool shouldShowMinimap() const;
 357
 358         // IGameDef interface
 359         IItemDefManager* getItemDefManager() override;
 360         const NodeDefManager* getNodeDefManager() override;
 361         ICraftDefManager* getCraftDefManager() override;
 362         ITextureSource* getTextureSource();
 363         virtual IWritableShaderSource* getShaderSource();
 364         u16 allocateUnknownNodeId(const std::string &name) override;
 365         virtual ISoundManager* getSoundManager();
 366         MtEventManager* getEventManager();
 367         virtual ParticleManager* getParticleManager();
 368         bool checkLocalPrivilege(const std::string &priv)
 369         { return checkPrivilege(priv); }
 370         virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
 371         const std::string* getModFile(std::string filename);
 372
 373         std::string getModStoragePath() const override;
 374         bool registerModStorage(ModMetadata *meta) override;
 375         void unregisterModStorage(const std::string &name) override;
 376
 377         // The following set of functions is used by ClientMediaDownloader
 378         // Insert a media file appropriately into the appropriate manager
 379         bool loadMedia(const std::string &data, const std::string &filename);
 380         // Send a request for conventional media transfer
 381         void request_media(const std::vector<std::string> &file_requests);
 382
 383         LocalClientState getState() { return m_state; }
 384
 385         void makeScreenshot();
 386
 387         inline void pushToChatQueue(ChatMessage *cec)
 388         {
 389                 m_chat_queue.push(cec);
 390         }
 391
 392         ClientScripting *getScript() { return m_script; }
 393         const bool modsLoaded() const { return m_mods_loaded; }
 394
 395         void pushToEventQueue(ClientEvent *event);
 396
 397         void showMinimap(bool show = true);
 398
 399         const Address getServerAddress();
 400
 401         const std::string &getAddressName() const
 402         {
 403                 return m_address_name;
 404         }
 405
 406         inline u64 getCSMRestrictionFlags() const
 407         {
 408                 return m_csm_restriction_flags;
 409         }
 410
 411         inline bool checkCSMRestrictionFlag(CSMRestrictionFlags flag) const
 412         {
 413                 return m_csm_restriction_flags & flag;
 414         }
 415
 416         u32 getCSMNodeRangeLimit() const
 417         {
 418                 return m_csm_restriction_noderange;
 419         }
 420
 421         inline std::unordered_map<u32, u32> &getHUDTranslationMap()
 422         {
 423                 return m_hud_server_to_client;
 424         }
 425
 426         bool joinModChannel(const std::string &channel) override;
 427         bool leaveModChannel(const std::string &channel) override;
 428         bool sendModChannelMessage(const std::string &channel,
 429                         const std::string &message) override;
 430         ModChannel *getModChannel(const std::string &channel) override;
 431
 432         const std::string &getFormspecPrepend() const
 433         {
 434                 return m_env.getLocalPlayer()->formspec_prepend;
 435         }
 436 private:
 437         void loadMods();
 438         bool checkBuiltinIntegrity();
 439
 440         // Virtual methods from con::PeerHandler
 441         void peerAdded(con::Peer *peer) override;
 442         void deletingPeer(con::Peer *peer, bool timeout) override;
 443
 444         void initLocalMapSaving(const Address &address,
 445                         const std::string &hostname,
 446                         bool is_local_server);
 447
 448         void ReceiveAll();
 449
 450         void sendPlayerPos();
 451
 452         void deleteAuthData();
 453         // helper method shared with clientpackethandler
 454         static AuthMechanism choseAuthMech(const u32 mechs);
 455
 456         void sendInit(const std::string &playerName);
 457         void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
 458         void startAuth(AuthMechanism chosen_auth_mechanism);
 459         void sendDeletedBlocks(std::vector<v3s16> &blocks);
 460         void sendGotBlocks(const std::vector<v3s16> &blocks);
 461         void sendRemovedSounds(std::vector<s32> &soundList);
 462
 463         // Helper function
 464         inline std::string getPlayerName()
 465         { return m_env.getLocalPlayer()->getName(); }
 466
 467         bool canSendChatMessage() const;
 468
 469         float m_packetcounter_timer = 0.0f;
 470         float m_connection_reinit_timer = 0.1f;
 471         float m_avg_rtt_timer = 0.0f;
 472         float m_playerpos_send_timer = 0.0f;
 473         IntervalLimiter m_map_timer_and_unload_interval;
 474
 475         IWritableTextureSource *m_tsrc;
 476         IWritableShaderSource *m_shsrc;
 477         IWritableItemDefManager *m_itemdef;
 478         NodeDefManager *m_nodedef;
 479         ISoundManager *m_sound;
 480         MtEventManager *m_event;
 481
 482
 483         MeshUpdateThread m_mesh_update_thread;
 484         ClientEnvironment m_env;
 485         ParticleManager m_particle_manager;
 486         std::unique_ptr<con::Connection> m_con;
 487         std::string m_address_name;
 488         Camera *m_camera = nullptr;
 489         Minimap *m_minimap = nullptr;
 490         bool m_minimap_disabled_by_server = false;
 491         // Server serialization version
 492         u8 m_server_ser_ver;
 493
 494         // Used version of the protocol with server
 495         // Values smaller than 25 only mean they are smaller than 25,
 496         // and aren't accurate. We simply just don't know, because
 497         // the server didn't send the version back then.
 498         // If 0, server init hasn't been received yet.
 499         u16 m_proto_ver = 0;
 500
 501         bool m_update_wielded_item = false;
 502         Inventory *m_inventory_from_server = nullptr;
 503         float m_inventory_from_server_age = 0.0f;
 504         PacketCounter m_packetcounter;
 505         // Block mesh animation parameters
 506         float m_animation_time = 0.0f;
 507         int m_crack_level = -1;
 508         v3s16 m_crack_pos;
 509         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 510         //s32 m_daynight_i;
 511         //u32 m_daynight_ratio;
 512         std::queue<std::wstring> m_out_chat_queue;
 513         u32 m_last_chat_message_sent;
 514         float m_chat_message_allowance = 5.0f;
 515         std::queue<ChatMessage *> m_chat_queue;
 516
 517         // The authentication methods we can use to enter sudo mode (=change password)
 518         u32 m_sudo_auth_methods;
 519
 520         // The seed returned by the server in TOCLIENT_INIT is stored here
 521         u64 m_map_seed = 0;
 522
 523         // Auth data
 524         std::string m_playername;
 525         std::string m_password;
 526         // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
 527         std::string m_new_password;
 528         // Usable by auth mechanisms.
 529         AuthMechanism m_chosen_auth_mech;
 530         void *m_auth_data = nullptr;
 531
 532
 533         bool m_access_denied = false;
 534         bool m_access_denied_reconnect = false;
 535         std::string m_access_denied_reason = "";
 536         std::queue<ClientEvent *> m_client_event_queue;
 537         bool m_itemdef_received = false;
 538         bool m_nodedef_received = false;
 539         bool m_activeobjects_received = false;
 540         bool m_mods_loaded = false;
 541         ClientMediaDownloader *m_media_downloader;
 542
 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;
 547
 548         // An interval for generally sending object positions and stuff
 549         float m_recommended_send_interval = 0.1f;
 550
 551         // Sounds
 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;
 559
 560         // Map server hud ids to client hud ids
 561         std::unordered_map<u32, u32> m_hud_server_to_client;
 562
 563         // Privileges
 564         std::unordered_set<std::string> m_privileges;
 565
 566         // Detached inventories
 567         // key = name
 568         std::unordered_map<std::string, Inventory*> m_detached_inventories;
 569
 570         // Storage for mesh data for creating multiple instances of the same mesh
 571         StringMap m_mesh_data;
 572
 573         // own state
 574         LocalClientState m_state;
 575
 576         GameUI *m_game_ui;
 577
 578         // Used for saving server map to disk client-side
 579         MapDatabase *m_localdb = nullptr;
 580         IntervalLimiter m_localdb_save_interval;
 581         u16 m_cache_save_interval;
 582
 583         // Client modding
 584         ClientScripting *m_script = nullptr;
 585         bool m_modding_enabled;
 586         std::unordered_map<std::string, ModMetadata *> m_mod_storages;
 587         float m_mod_storage_save_timer = 10.0f;
 588         std::vector<ModSpec> m_mods;
 589         StringMap m_mod_vfs;
 590
 591         bool m_shutdown = false;
 592
 593         // CSM restrictions byteflag
 594         u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
 595         u32 m_csm_restriction_noderange = 8;
 596
 597         std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
 598 };