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 RenderingEngine;
  49 class IWritableTextureSource;
  50 class IWritableShaderSource;
  51 class ISoundManager;
  52 class NodeDefManager;
  53 //class IWritableCraftDefManager;
  54 class ClientMediaDownloader;
  55 class SingleMediaDownloader;
  56 struct MapDrawControl;
  57 class ModChannelMgr;
  58 class MtEventManager;
  59 struct PointedThing;
  60 class MapDatabase;
  61 class Minimap;
  62 struct MinimapMapblock;
  63 class Camera;
  64 class NetworkPacket;
  65 namespace con {
  66 class Connection;
  67 }
  68
  69 enum LocalClientState {
  70         LC_Created,
  71         LC_Init,
  72         LC_Ready
  73 };
  74
  75 /*
  76         Packet counter
  77 */
  78
  79 class PacketCounter
  80 {
  81 public:
  82         PacketCounter() = default;
  83
  84         void add(u16 command)
  85         {
  86                 auto n = m_packets.find(command);
  87                 if (n == m_packets.end())
  88                         m_packets[command] = 1;
  89                 else
  90                         n->second++;
  91         }
  92
  93         void clear()
  94         {
  95                 m_packets.clear();
  96         }
  97
  98         u32 sum() const;
  99         void print(std::ostream &o) const;
 100
 101 private:
 102         // command, count
 103         std::map<u16, u32> m_packets;
 104 };
 105
 106 class ClientScripting;
 107 class GameUI;
 108
 109 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 110 {
 111 public:
 112         /*
 113                 NOTE: Nothing is thread-safe here.
 114         */
 115
 116         Client(
 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,
 128                         bool ipv6,
 129                         GameUI *game_ui
 130         );
 131
 132         ~Client();
 133         DISABLE_CLASS_COPY(Client);
 134
 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)
 139         {
 140                 scanModSubfolder(mod_name, mod_path, "");
 141         }
 142
 143         /*
 144          request all threads managed by client to be stopped
 145          */
 146         void Stop();
 147
 148
 149         bool isShutdown();
 150
 151         /*
 152                 The name of the local player should already be set when
 153                 calling this, as it is sent in the initialization.
 154         */
 155         void connect(Address address, bool is_local_server);
 156
 157         /*
 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
 161                 timed out.
 162         */
 163         void step(float dtime);
 164
 165         /*
 166          * Command Handlers
 167          */
 168
 169         void handleCommand(NetworkPacket* pkt);
 170
 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);
 229
 230         void ProcessData(NetworkPacket *pkt);
 231
 232         void Send(NetworkPacket* pkt);
 233
 234         void interact(InteractAction action, const PointedThing &pointed);
 235
 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);
 246         void sendRespawn();
 247         void sendReady();
 248         void sendHaveMedia(const std::vector<u32> &tokens);
 249
 250         ClientEnvironment& getEnv() { return m_env; }
 251         ITextureSource *tsrc() { return getTextureSource(); }
 252         ISoundManager *sound() { return getSoundManager(); }
 253         static const std::string &getBuiltinLuaPath();
 254         static const std::string &getClientModsLuaPath();
 255
 256         const std::vector<ModSpec> &getMods() const override;
 257         const ModSpec* getModSpec(const std::string &modname) const override;
 258
 259         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 260         void removeNode(v3s16 p);
 261
 262         // helpers to enforce CSM restrictions
 263         MapNode CSMGetNode(v3s16 p, bool *is_valid_position);
 264         int CSMClampRadius(v3s16 pos, int radius);
 265         v3s16 CSMClampPos(v3s16 pos);
 266
 267         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 268
 269         void setPlayerControl(PlayerControl &control);
 270
 271         // Returns true if the inventory of the local player has been
 272         // updated from the server. If it is true, it is set to false.
 273         bool updateWieldedItem();
 274
 275         /* InventoryManager interface */
 276         Inventory* getInventory(const InventoryLocation &loc) override;
 277         void inventoryAction(InventoryAction *a) override;
 278
 279         // Send the item number 'item' as player item to the server
 280         void setPlayerItem(u16 item);
 281
 282         const std::list<std::string> &getConnectedPlayerNames()
 283         {
 284                 return m_env.getPlayerNames();
 285         }
 286
 287         float getAnimationTime();
 288
 289         int getCrackLevel();
 290         v3s16 getCrackPos();
 291         void setCrack(int level, v3s16 pos);
 292
 293         u16 getHP();
 294
 295         bool checkPrivilege(const std::string &priv) const
 296         { return g_settings->getBool("priv_bypass") ? true : (m_privileges.count(priv) != 0); }
 297
 298         const std::unordered_set<std::string> &getPrivilegeList() const
 299         { return m_privileges; }
 300
 301         bool getChatMessage(std::wstring &message);
 302         void typeChatMessage(const std::wstring& message);
 303
 304         u64 getMapSeed(){ return m_map_seed; }
 305
 306         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 307         // Including blocks at appropriate edges
 308         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 309         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 310
 311         void updateAllMapBlocks();
 312
 313         void updateCameraOffset(v3s16 camera_offset)
 314         { m_mesh_update_thread.m_camera_offset = camera_offset; }
 315
 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();
 319
 320         bool accessDenied() const { return m_access_denied; }
 321
 322         bool reconnectRequested() const { return true || m_access_denied_reconnect; }
 323
 324         void setFatalError(const std::string &reason)
 325         {
 326                 m_access_denied = true;
 327                 m_access_denied_reason = reason;
 328         }
 329         inline void setFatalError(const LuaError &e)
 330         {
 331                 setFatalError(std::string("Lua: ") + e.what());
 332         }
 333
 334         // Renaming accessDeniedReason to better name could be good as it's used to
 335         // disconnect client when CSM failed.
 336         const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 337
 338         const bool itemdefReceived() const
 339         { return m_itemdef_received; }
 340         const bool nodedefReceived() const
 341         { return m_nodedef_received; }
 342         const bool mediaReceived() const
 343         { return !m_media_downloader; }
 344         const bool activeObjectsReceived() const
 345         { return m_activeobjects_received; }
 346
 347         u16 getProtoVersion()
 348         { return m_proto_ver; }
 349
 350         void confirmRegistration();
 351         bool m_is_registration_confirmation_state = false;
 352         bool m_simple_singleplayer_mode;
 353
 354         float mediaReceiveProgress();
 355
 356         void afterContentReceived();
 357         void showUpdateProgressTexture(void *args, u32 progress, u32 max_progress);
 358
 359         float getRTT();
 360         float getCurRate();
 361
 362         Minimap* getMinimap() { return m_minimap; }
 363         void setCamera(Camera* camera) { m_camera = camera; }
 364
 365         Camera* getCamera () { return m_camera; }
 366         scene::ISceneManager *getSceneManager();
 367
 368         bool shouldShowMinimap() const;
 369
 370         // IGameDef interface
 371         IItemDefManager* getItemDefManager() override;
 372         IWritableItemDefManager* getWritableItemDefManager() override;
 373         const NodeDefManager* getNodeDefManager() override;
 374         NodeDefManager* getWritableNodeDefManager() override;
 375         ICraftDefManager* getCraftDefManager() override;
 376         ITextureSource* getTextureSource();
 377         virtual IWritableShaderSource* getShaderSource();
 378         u16 allocateUnknownNodeId(const std::string &name) override;
 379         virtual ISoundManager* getSoundManager();
 380         MtEventManager* getEventManager();
 381         virtual ParticleManager* getParticleManager();
 382         bool checkLocalPrivilege(const std::string &priv){ return checkPrivilege(priv); }
 383         virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
 384         const std::string* getModFile(std::string filename);
 385
 386         std::string getModStoragePath() const override;
 387         bool registerModStorage(ModMetadata *meta) override;
 388         void unregisterModStorage(const std::string &name) override;
 389
 390         // The following set of functions is used by ClientMediaDownloader
 391         // Insert a media file appropriately into the appropriate manager
 392         bool loadMedia(const std::string &data, const std::string &filename,
 393                 bool from_media_push = false);
 394
 395         // Send a request for conventional media transfer
 396         void request_media(const std::vector<std::string> &file_requests);
 397
 398         LocalClientState getState() { return m_state; }
 399
 400         void makeScreenshot();
 401
 402         inline void pushToChatQueue(ChatMessage *cec)
 403         {
 404                 m_chat_queue.push(cec);
 405         }
 406
 407         ClientScripting *getScript() { return m_script; }
 408         const bool modsLoaded() const { return m_mods_loaded; }
 409
 410         void pushToEventQueue(ClientEvent *event);
 411
 412         void showMinimap(bool show = true);
 413
 414         const Address getServerAddress();
 415
 416         const std::string &getAddressName() const
 417         {
 418                 return m_address_name;
 419         }
 420
 421         inline u64 getCSMRestrictionFlags() const
 422         {
 423                 return m_csm_restriction_flags;
 424         }
 425
 426         inline bool checkCSMRestrictionFlag(CSMRestrictionFlags flag) const
 427         {
 428                 //return m_csm_restriction_flags & flag;
 429                 return false;
 430         }
 431
 432         bool joinModChannel(const std::string &channel) override;
 433         bool leaveModChannel(const std::string &channel) override;
 434         bool sendModChannelMessage(const std::string &channel,
 435                         const std::string &message) override;
 436         ModChannel *getModChannel(const std::string &channel) override;
 437
 438         const std::string &getFormspecPrepend() const
 439         {
 440                 return m_env.getLocalPlayer()->formspec_prepend;
 441         }
 442
 443         void sendPlayerPos(v3f pos);
 444         void sendPlayerPos();
 445         MeshUpdateThread m_mesh_update_thread;
 446
 447 private:
 448         void loadMods();
 449
 450         // Virtual methods from con::PeerHandler
 451         void peerAdded(con::Peer *peer) override;
 452         void deletingPeer(con::Peer *peer, bool timeout) override;
 453
 454         void initLocalMapSaving(const Address &address,
 455                         const std::string &hostname,
 456                         bool is_local_server);
 457
 458         void ReceiveAll();
 459
 460
 461         void deleteAuthData();
 462         // helper method shared with clientpackethandler
 463         static AuthMechanism choseAuthMech(const u32 mechs);
 464
 465         void sendInit(const std::string &playerName);
 466         void promptConfirmRegistration(AuthMechanism chosen_auth_mechanism);
 467         void startAuth(AuthMechanism chosen_auth_mechanism);
 468         void sendDeletedBlocks(std::vector<v3s16> &blocks);
 469         void sendGotBlocks(const std::vector<v3s16> &blocks);
 470         void sendRemovedSounds(std::vector<s32> &soundList);
 471
 472         // Helper function
 473         inline std::string getPlayerName()
 474         { return m_env.getLocalPlayer()->getName(); }
 475
 476         bool canSendChatMessage() const;
 477
 478         float m_packetcounter_timer = 0.0f;
 479         float m_connection_reinit_timer = 0.1f;
 480         float m_avg_rtt_timer = 0.0f;
 481         float m_playerpos_send_timer = 0.0f;
 482         IntervalLimiter m_map_timer_and_unload_interval;
 483
 484         IWritableTextureSource *m_tsrc;
 485         IWritableShaderSource *m_shsrc;
 486         IWritableItemDefManager *m_itemdef;
 487         NodeDefManager *m_nodedef;
 488         ISoundManager *m_sound;
 489         MtEventManager *m_event;
 490         RenderingEngine *m_rendering_engine;
 491
 492
 493         ClientEnvironment m_env;
 494         ParticleManager m_particle_manager;
 495         std::unique_ptr<con::Connection> m_con;
 496         std::string m_address_name;
 497         Camera *m_camera = nullptr;
 498         Minimap *m_minimap = nullptr;
 499         bool m_minimap_disabled_by_server = false;
 500
 501         // Server serialization version
 502         u8 m_server_ser_ver;
 503
 504         // Used version of the protocol with server
 505         // Values smaller than 25 only mean they are smaller than 25,
 506         // and aren't accurate. We simply just don't know, because
 507         // the server didn't send the version back then.
 508         // If 0, server init hasn't been received yet.
 509         u16 m_proto_ver = 0;
 510
 511         bool m_update_wielded_item = false;
 512         Inventory *m_inventory_from_server = nullptr;
 513         float m_inventory_from_server_age = 0.0f;
 514         PacketCounter m_packetcounter;
 515         // Block mesh animation parameters
 516         float m_animation_time = 0.0f;
 517         int m_crack_level = -1;
 518         v3s16 m_crack_pos;
 519         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 520         //s32 m_daynight_i;
 521         //u32 m_daynight_ratio;
 522         std::queue<std::wstring> m_out_chat_queue;
 523         u32 m_last_chat_message_sent;
 524         float m_chat_message_allowance = 5.0f;
 525         std::queue<ChatMessage *> m_chat_queue;
 526
 527         // The authentication methods we can use to enter sudo mode (=change password)
 528         u32 m_sudo_auth_methods;
 529
 530         // The seed returned by the server in TOCLIENT_INIT is stored here
 531         u64 m_map_seed = 0;
 532
 533         // Auth data
 534         std::string m_playername;
 535         std::string m_password;
 536         // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
 537         std::string m_new_password;
 538         // Usable by auth mechanisms.
 539         AuthMechanism m_chosen_auth_mech;
 540         void *m_auth_data = nullptr;
 541
 542         bool m_access_denied = false;
 543         bool m_access_denied_reconnect = false;
 544         std::string m_access_denied_reason = "";
 545         std::queue<ClientEvent *> m_client_event_queue;
 546         bool m_itemdef_received = false;
 547         bool m_nodedef_received = false;
 548         bool m_activeobjects_received = false;
 549         bool m_mods_loaded = false;
 550
 551         std::vector<std::string> m_remote_media_servers;
 552         // Media downloader, only exists during init
 553         ClientMediaDownloader *m_media_downloader;
 554         // Set of media filenames pushed by server at runtime
 555         std::unordered_set<std::string> m_media_pushed_files;
 556         // Pending downloads of dynamic media (key: token)
 557         std::vector<std::pair<u32, std::unique_ptr<SingleMediaDownloader>>> m_pending_media_downloads;
 558
 559         // time_of_day speed approximation for old protocol
 560         bool m_time_of_day_set = false;
 561         float m_last_time_of_day_f = -1.0f;
 562         float m_time_of_day_update_timer = 0.0f;
 563
 564         // An interval for generally sending object positions and stuff
 565         float m_recommended_send_interval = 0.1f;
 566
 567         // Sounds
 568         float m_removed_sounds_check_timer = 0.0f;
 569         // Mapping from server sound ids to our sound ids
 570         std::unordered_map<s32, int> m_sounds_server_to_client;
 571         // And the other way!
 572         std::unordered_map<int, s32> m_sounds_client_to_server;
 573         // Relation of client id to object id
 574         std::unordered_map<int, u16> m_sounds_to_objects;
 575
 576         // Privileges
 577         std::unordered_set<std::string> m_privileges;
 578
 579         // Detached inventories
 580         // key = name
 581         std::unordered_map<std::string, Inventory*> m_detached_inventories;
 582
 583         // Storage for mesh data for creating multiple instances of the same mesh
 584         StringMap m_mesh_data;
 585
 586         // own state
 587         LocalClientState m_state;
 588
 589         GameUI *m_game_ui;
 590
 591         // Used for saving server map to disk client-side
 592         MapDatabase *m_localdb = nullptr;
 593         IntervalLimiter m_localdb_save_interval;
 594         u16 m_cache_save_interval;
 595
 596         // Client modding
 597         ClientScripting *m_script = nullptr;
 598         std::unordered_map<std::string, ModMetadata *> m_mod_storages;
 599         float m_mod_storage_save_timer = 10.0f;
 600         std::vector<ModSpec> m_mods;
 601         StringMap m_mod_vfs;
 602
 603         bool m_shutdown = false;
 604
 605         // CSM restrictions byteflag
 606         u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
 607         u32 m_csm_restriction_noderange = 8;
 608
 609         std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
 610 };