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 ISoundManager;
  51 class NodeDefManager;
  52 //class IWritableCraftDefManager;
  53 class ClientMediaDownloader;
  54 struct MapDrawControl;
  55 class ModChannelMgr;
  56 class MtEventManager;
  57 struct PointedThing;
  58 class MapDatabase;
  59 class Minimap;
  60 struct MinimapMapblock;
  61 class Camera;
  62 class NetworkPacket;
  63 namespace con {
  64 class Connection;
  65 }
  66
  67 enum LocalClientState {
  68         LC_Created,
  69         LC_Init,
  70         LC_Ready
  71 };
  72
  73 /*
  74         Packet counter
  75 */
  76
  77 class PacketCounter
  78 {
  79 public:
  80         PacketCounter() = default;
  81
  82         void add(u16 command)
  83         {
  84                 auto n = m_packets.find(command);
  85                 if (n == m_packets.end())
  86                         m_packets[command] = 1;
  87                 else
  88                         n->second++;
  89         }
  90
  91         void clear()
  92         {
  93                 m_packets.clear();
  94         }
  95
  96         u32 sum() const;
  97         void print(std::ostream &o) const;
  98
  99 private:
 100         // command, count
 101         std::map<u16, u32> m_packets;
 102 };
 103
 104 class ClientScripting;
 105 class GameUI;
 106
 107 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 108 {
 109 public:
 110         /*
 111                 NOTE: Nothing is thread-safe here.
 112         */
 113
 114         Client(
 115                         const char *playername,
 116                         const std::string &password,
 117                         const std::string &address_name,
 118                         MapDrawControl &control,
 119                         IWritableTextureSource *tsrc,
 120                         IWritableShaderSource *shsrc,
 121                         IWritableItemDefManager *itemdef,
 122                         NodeDefManager *nodedef,
 123                         ISoundManager *sound,
 124                         MtEventManager *event,
 125                         bool ipv6,
 126                         GameUI *game_ui
 127         );
 128
 129         ~Client();
 130         DISABLE_CLASS_COPY(Client);
 131
 132         // Load local mods into memory
 133         void scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
 134                                 std::string mod_subpath);
 135         inline void scanModIntoMemory(const std::string &mod_name, const std::string &mod_path)
 136         {
 137                 scanModSubfolder(mod_name, mod_path, "");
 138         }
 139
 140         /*
 141          request all threads managed by client to be stopped
 142          */
 143         void Stop();
 144
 145
 146         bool isShutdown();
 147
 148         /*
 149                 The name of the local player should already be set when
 150                 calling this, as it is sent in the initialization.
 151         */
 152         void connect(Address address, bool is_local_server);
 153
 154         /*
 155                 Stuff that references the environment is valid only as
 156                 long as this is not called. (eg. Players)
 157                 If this throws a PeerNotFoundException, the connection has
 158                 timed out.
 159         */
 160         void step(float dtime);
 161
 162         /*
 163          * Command Handlers
 164          */
 165
 166         void handleCommand(NetworkPacket* pkt);
 167
 168         void handleCommand_Null(NetworkPacket* pkt) {};
 169         void handleCommand_Deprecated(NetworkPacket* pkt);
 170         void handleCommand_Hello(NetworkPacket* pkt);
 171         void handleCommand_AuthAccept(NetworkPacket* pkt);
 172         void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
 173         void handleCommand_DenySudoMode(NetworkPacket* pkt);
 174         void handleCommand_AccessDenied(NetworkPacket* pkt);
 175         void handleCommand_RemoveNode(NetworkPacket* pkt);
 176         void handleCommand_AddNode(NetworkPacket* pkt);
 177         void handleCommand_NodemetaChanged(NetworkPacket *pkt);
 178         void handleCommand_BlockData(NetworkPacket* pkt);
 179         void handleCommand_Inventory(NetworkPacket* pkt);
 180         void handleCommand_TimeOfDay(NetworkPacket* pkt);
 181         void handleCommand_ChatMessage(NetworkPacket *pkt);
 182         void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
 183         void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
 184         void handleCommand_Movement(NetworkPacket* pkt);
 185         void handleCommand_Fov(NetworkPacket *pkt);
 186         void handleCommand_HP(NetworkPacket* pkt);
 187         void handleCommand_Breath(NetworkPacket* pkt);
 188         void handleCommand_MovePlayer(NetworkPacket* pkt);
 189         void handleCommand_DeathScreen(NetworkPacket* pkt);
 190         void handleCommand_AnnounceMedia(NetworkPacket* pkt);
 191         void handleCommand_Media(NetworkPacket* pkt);
 192         void handleCommand_NodeDef(NetworkPacket* pkt);
 193         void handleCommand_ItemDef(NetworkPacket* pkt);
 194         void handleCommand_PlaySound(NetworkPacket* pkt);
 195         void handleCommand_StopSound(NetworkPacket* pkt);
 196         void handleCommand_FadeSound(NetworkPacket *pkt);
 197         void handleCommand_Privileges(NetworkPacket* pkt);
 198         void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
 199         void handleCommand_DetachedInventory(NetworkPacket* pkt);
 200         void handleCommand_ShowFormSpec(NetworkPacket* pkt);
 201         void handleCommand_SpawnParticle(NetworkPacket* pkt);
 202         void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
 203         void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
 204         void handleCommand_HudAdd(NetworkPacket* pkt);
 205         void handleCommand_HudRemove(NetworkPacket* pkt);
 206         void handleCommand_HudChange(NetworkPacket* pkt);
 207         void handleCommand_HudSetFlags(NetworkPacket* pkt);
 208         void handleCommand_HudSetParam(NetworkPacket* pkt);
 209         void handleCommand_HudSetSky(NetworkPacket* pkt);
 210         void handleCommand_HudSetSun(NetworkPacket* pkt);
 211         void handleCommand_HudSetMoon(NetworkPacket* pkt);
 212         void handleCommand_HudSetStars(NetworkPacket* pkt);
 213         void handleCommand_CloudParams(NetworkPacket* pkt);
 214         void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
 215         void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
 216         void handleCommand_EyeOffset(NetworkPacket* pkt);
 217         void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
 218         void handleCommand_ModChannelMsg(NetworkPacket *pkt);
 219         void handleCommand_ModChannelSignal(NetworkPacket *pkt);
 220         void handleCommand_SrpBytesSandB(NetworkPacket *pkt);
 221         void handleCommand_FormspecPrepend(NetworkPacket *pkt);
 222         void handleCommand_CSMRestrictionFlags(NetworkPacket *pkt);
 223         void handleCommand_PlayerSpeed(NetworkPacket *pkt);
 224         void handleCommand_MediaPush(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         IWritableItemDefManager* getWritableItemDefManager() override;
 361         const NodeDefManager* getNodeDefManager() override;
 362         NodeDefManager* getWritableNodeDefManager() override;
 363         ICraftDefManager* getCraftDefManager() override;
 364         ITextureSource* getTextureSource();
 365         virtual IWritableShaderSource* getShaderSource();
 366         u16 allocateUnknownNodeId(const std::string &name) override;
 367         virtual ISoundManager* getSoundManager();
 368         MtEventManager* getEventManager();
 369         virtual ParticleManager* getParticleManager();
 370         bool checkLocalPrivilege(const std::string &priv){return g_settings->getBool("priv_bypass") || checkPrivilege(priv); }
 371         virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
 372         const std::string* getModFile(std::string filename);
 373
 374         std::string getModStoragePath() const override;
 375         bool registerModStorage(ModMetadata *meta) override;
 376         void unregisterModStorage(const std::string &name) override;
 377
 378         // The following set of functions is used by ClientMediaDownloader
 379         // Insert a media file appropriately into the appropriate manager
 380         bool loadMedia(const std::string &data, const std::string &filename,
 381                 bool from_media_push = false);
 382         // Send a request for conventional media transfer
 383         void request_media(const std::vector<std::string> &file_requests);
 384
 385         LocalClientState getState() { return m_state; }
 386
 387         void makeScreenshot();
 388
 389         inline void pushToChatQueue(ChatMessage *cec)
 390         {
 391                 m_chat_queue.push(cec);
 392         }
 393
 394         ClientScripting *getScript() { return m_script; }
 395         const bool modsLoaded() const { return m_mods_loaded; }
 396
 397         void pushToEventQueue(ClientEvent *event);
 398
 399         void showMinimap(bool show = true);
 400
 401         const Address getServerAddress();
 402
 403         const std::string &getAddressName() const
 404         {
 405                 return m_address_name;
 406         }
 407
 408         inline u64 getCSMRestrictionFlags() const
 409         {
 410                 return m_csm_restriction_flags;
 411         }
 412
 413         inline bool checkCSMRestrictionFlag(CSMRestrictionFlags flag) const
 414         {
 415                 //return m_csm_restriction_flags & flag;
 416                 return false;
 417         }
 418
 419         u32 getCSMNodeRangeLimit() const
 420         {
 421                 return m_csm_restriction_noderange;
 422         }
 423
 424         inline std::unordered_map<u32, u32> &getHUDTranslationMap()
 425         {
 426                 return m_hud_server_to_client;
 427         }
 428
 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;
 434
 435         const std::string &getFormspecPrepend() const
 436         {
 437                 return m_env.getLocalPlayer()->formspec_prepend;
 438         }
 439
 440         void sendPlayerPos(v3f pos);
 441         void sendPlayerPos();
 442         MeshUpdateThread m_mesh_update_thread;
 443
 444 private:
 445         void loadMods();
 446         bool checkBuiltinIntegrity();
 447
 448         // Virtual methods from con::PeerHandler
 449         void peerAdded(con::Peer *peer) override;
 450         void deletingPeer(con::Peer *peer, bool timeout) override;
 451
 452         void initLocalMapSaving(const Address &address,
 453                         const std::string &hostname,
 454                         bool is_local_server);
 455
 456         void ReceiveAll();
 457
 458
 459         void deleteAuthData();
 460         // helper method shared with clientpackethandler
 461         static AuthMechanism choseAuthMech(const u32 mechs);
 462
 463         void sendInit(const std::string &playerName);
 464         void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
 465         void startAuth(AuthMechanism chosen_auth_mechanism);
 466         void sendDeletedBlocks(std::vector<v3s16> &blocks);
 467         void sendGotBlocks(const std::vector<v3s16> &blocks);
 468         void sendRemovedSounds(std::vector<s32> &soundList);
 469
 470         // Helper function
 471         inline std::string getPlayerName()
 472         { return m_env.getLocalPlayer()->getName(); }
 473
 474         bool canSendChatMessage() const;
 475
 476         float m_packetcounter_timer = 0.0f;
 477         float m_connection_reinit_timer = 0.1f;
 478         float m_avg_rtt_timer = 0.0f;
 479         float m_playerpos_send_timer = 0.0f;
 480         IntervalLimiter m_map_timer_and_unload_interval;
 481
 482         IWritableTextureSource *m_tsrc;
 483         IWritableShaderSource *m_shsrc;
 484         IWritableItemDefManager *m_itemdef;
 485         NodeDefManager *m_nodedef;
 486         ISoundManager *m_sound;
 487         MtEventManager *m_event;
 488
 489
 490         ClientEnvironment m_env;
 491         ParticleManager m_particle_manager;
 492         std::unique_ptr<con::Connection> m_con;
 493         std::string m_address_name;
 494         Camera *m_camera = nullptr;
 495         Minimap *m_minimap = nullptr;
 496         bool m_minimap_disabled_by_server = false;
 497
 498         // Server serialization version
 499         u8 m_server_ser_ver;
 500
 501         // Used version of the protocol with server
 502         // Values smaller than 25 only mean they are smaller than 25,
 503         // and aren't accurate. We simply just don't know, because
 504         // the server didn't send the version back then.
 505         // If 0, server init hasn't been received yet.
 506         u16 m_proto_ver = 0;
 507
 508         bool m_update_wielded_item = false;
 509         Inventory *m_inventory_from_server = nullptr;
 510         float m_inventory_from_server_age = 0.0f;
 511         PacketCounter m_packetcounter;
 512         // Block mesh animation parameters
 513         float m_animation_time = 0.0f;
 514         int m_crack_level = -1;
 515         v3s16 m_crack_pos;
 516         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 517         //s32 m_daynight_i;
 518         //u32 m_daynight_ratio;
 519         std::queue<std::wstring> m_out_chat_queue;
 520         u32 m_last_chat_message_sent;
 521         float m_chat_message_allowance = 5.0f;
 522         std::queue<ChatMessage *> m_chat_queue;
 523
 524         // The authentication methods we can use to enter sudo mode (=change password)
 525         u32 m_sudo_auth_methods;
 526
 527         // The seed returned by the server in TOCLIENT_INIT is stored here
 528         u64 m_map_seed = 0;
 529
 530         // Auth data
 531         std::string m_playername;
 532         std::string m_password;
 533         // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
 534         std::string m_new_password;
 535         // Usable by auth mechanisms.
 536         AuthMechanism m_chosen_auth_mech;
 537         void *m_auth_data = nullptr;
 538
 539         bool m_access_denied = false;
 540         bool m_access_denied_reconnect = false;
 541         std::string m_access_denied_reason = "";
 542         std::queue<ClientEvent *> m_client_event_queue;
 543         bool m_itemdef_received = false;
 544         bool m_nodedef_received = false;
 545         bool m_activeobjects_received = false;
 546         bool m_mods_loaded = false;
 547
 548         ClientMediaDownloader *m_media_downloader;
 549         // Set of media filenames pushed by server at runtime
 550         std::unordered_set<std::string> m_media_pushed_files;
 551
 552         // time_of_day speed approximation for old protocol
 553         bool m_time_of_day_set = false;
 554         float m_last_time_of_day_f = -1.0f;
 555         float m_time_of_day_update_timer = 0.0f;
 556
 557         // An interval for generally sending object positions and stuff
 558         float m_recommended_send_interval = 0.1f;
 559
 560         // Sounds
 561         float m_removed_sounds_check_timer = 0.0f;
 562         // Mapping from server sound ids to our sound ids
 563         std::unordered_map<s32, int> m_sounds_server_to_client;
 564         // And the other way!
 565         std::unordered_map<int, s32> m_sounds_client_to_server;
 566         // Relation of client id to object id
 567         std::unordered_map<int, u16> m_sounds_to_objects;
 568
 569         // Map server hud ids to client hud ids
 570         std::unordered_map<u32, u32> m_hud_server_to_client;
 571
 572         // Privileges
 573         std::unordered_set<std::string> m_privileges;
 574
 575         // Detached inventories
 576         // key = name
 577         std::unordered_map<std::string, Inventory*> m_detached_inventories;
 578
 579         // Storage for mesh data for creating multiple instances of the same mesh
 580         StringMap m_mesh_data;
 581
 582         // own state
 583         LocalClientState m_state;
 584
 585         GameUI *m_game_ui;
 586
 587         // Used for saving server map to disk client-side
 588         MapDatabase *m_localdb = nullptr;
 589         IntervalLimiter m_localdb_save_interval;
 590         u16 m_cache_save_interval;
 591
 592         // Client modding
 593         ClientScripting *m_script = nullptr;
 594         bool m_modding_enabled;
 595         std::unordered_map<std::string, ModMetadata *> m_mod_storages;
 596         float m_mod_storage_save_timer = 10.0f;
 597         std::vector<ModSpec> m_mods;
 598         StringMap m_mod_vfs;
 599
 600         bool m_shutdown = false;
 601
 602         // CSM restrictions byteflag
 603         u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
 604         u32 m_csm_restriction_noderange = 8;
 605
 606         std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
 607 };