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