src/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 "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 IWritableNodeDefManager;
  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                 std::map<u16, u16>::iterator n = m_packets.find(command);
  85                 if(n == m_packets.end())
  86                 {
  87                         m_packets[command] = 1;
  88                 }
  89                 else
  90                 {
  91                         n->second++;
  92                 }
  93         }
  94
  95         void clear()
  96         {
  97                 for (auto &m_packet : m_packets) {
  98                         m_packet.second = 0;
  99                 }
 100         }
 101
 102         void print(std::ostream &o)
 103         {
 104                 for (const auto &m_packet : m_packets) {
 105                         o << "cmd "<< m_packet.first <<" count "<< m_packet.second << std::endl;
 106                 }
 107         }
 108
 109 private:
 110         // command, count
 111         std::map<u16, u16> m_packets;
 112 };
 113
 114 class ClientScripting;
 115 struct GameUIFlags;
 116
 117 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 118 {
 119 public:
 120         /*
 121                 NOTE: Nothing is thread-safe here.
 122         */
 123
 124         Client(
 125                         const char *playername,
 126                         const std::string &password,
 127                         const std::string &address_name,
 128                         MapDrawControl &control,
 129                         IWritableTextureSource *tsrc,
 130                         IWritableShaderSource *shsrc,
 131                         IWritableItemDefManager *itemdef,
 132                         IWritableNodeDefManager *nodedef,
 133                         ISoundManager *sound,
 134                         MtEventManager *event,
 135                         bool ipv6,
 136                         GameUIFlags *game_ui_flags
 137         );
 138
 139         ~Client();
 140         DISABLE_CLASS_COPY(Client);
 141
 142         // Load local mods into memory
 143         void loadMods();
 144         void scanModSubfolder(const std::string &mod_name, const std::string &mod_path,
 145                                 std::string mod_subpath);
 146         inline void scanModIntoMemory(const std::string &mod_name, const std::string &mod_path)
 147         {
 148                 scanModSubfolder(mod_name, mod_path, "");
 149         }
 150
 151         // Initizle the mods
 152         void initMods();
 153
 154         /*
 155          request all threads managed by client to be stopped
 156          */
 157         void Stop();
 158
 159
 160         bool isShutdown();
 161
 162         /*
 163                 The name of the local player should already be set when
 164                 calling this, as it is sent in the initialization.
 165         */
 166         void connect(Address address, bool is_local_server);
 167
 168         /*
 169                 Stuff that references the environment is valid only as
 170                 long as this is not called. (eg. Players)
 171                 If this throws a PeerNotFoundException, the connection has
 172                 timed out.
 173         */
 174         void step(float dtime);
 175
 176         /*
 177          * Command Handlers
 178          */
 179
 180         void handleCommand(NetworkPacket* pkt);
 181
 182         void handleCommand_Null(NetworkPacket* pkt) {};
 183         void handleCommand_Deprecated(NetworkPacket* pkt);
 184         void handleCommand_Hello(NetworkPacket* pkt);
 185         void handleCommand_AuthAccept(NetworkPacket* pkt);
 186         void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
 187         void handleCommand_DenySudoMode(NetworkPacket* pkt);
 188         void handleCommand_AccessDenied(NetworkPacket* pkt);
 189         void handleCommand_RemoveNode(NetworkPacket* pkt);
 190         void handleCommand_AddNode(NetworkPacket* pkt);
 191         void handleCommand_BlockData(NetworkPacket* pkt);
 192         void handleCommand_Inventory(NetworkPacket* pkt);
 193         void handleCommand_TimeOfDay(NetworkPacket* pkt);
 194         void handleCommand_ChatMessageOld(NetworkPacket *pkt);
 195         void handleCommand_ChatMessage(NetworkPacket *pkt);
 196         void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
 197         void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
 198         void handleCommand_Movement(NetworkPacket* pkt);
 199         void handleCommand_HP(NetworkPacket* pkt);
 200         void handleCommand_Breath(NetworkPacket* pkt);
 201         void handleCommand_MovePlayer(NetworkPacket* pkt);
 202         void handleCommand_DeathScreen(NetworkPacket* pkt);
 203         void handleCommand_AnnounceMedia(NetworkPacket* pkt);
 204         void handleCommand_Media(NetworkPacket* pkt);
 205         void handleCommand_NodeDef(NetworkPacket* pkt);
 206         void handleCommand_ItemDef(NetworkPacket* pkt);
 207         void handleCommand_PlaySound(NetworkPacket* pkt);
 208         void handleCommand_StopSound(NetworkPacket* pkt);
 209         void handleCommand_FadeSound(NetworkPacket *pkt);
 210         void handleCommand_Privileges(NetworkPacket* pkt);
 211         void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
 212         void handleCommand_DetachedInventory(NetworkPacket* pkt);
 213         void handleCommand_ShowFormSpec(NetworkPacket* pkt);
 214         void handleCommand_SpawnParticle(NetworkPacket* pkt);
 215         void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
 216         void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
 217         void handleCommand_HudAdd(NetworkPacket* pkt);
 218         void handleCommand_HudRemove(NetworkPacket* pkt);
 219         void handleCommand_HudChange(NetworkPacket* pkt);
 220         void handleCommand_HudSetFlags(NetworkPacket* pkt);
 221         void handleCommand_HudSetParam(NetworkPacket* pkt);
 222         void handleCommand_HudSetSky(NetworkPacket* pkt);
 223         void handleCommand_CloudParams(NetworkPacket* pkt);
 224         void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
 225         void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
 226         void handleCommand_EyeOffset(NetworkPacket* pkt);
 227         void handleCommand_UpdatePlayerList(NetworkPacket* pkt);
 228         void handleCommand_ModChannelMsg(NetworkPacket *pkt);
 229         void handleCommand_ModChannelSignal(NetworkPacket *pkt);
 230         void handleCommand_SrpBytesSandB(NetworkPacket* pkt);
 231         void handleCommand_CSMFlavourLimits(NetworkPacket *pkt);
 232
 233         void ProcessData(NetworkPacket *pkt);
 234
 235         void Send(NetworkPacket* pkt);
 236
 237         void interact(u8 action, const PointedThing& pointed);
 238
 239         void sendNodemetaFields(v3s16 p, const std::string &formname,
 240                 const StringMap &fields);
 241         void sendInventoryFields(const std::string &formname,
 242                 const StringMap &fields);
 243         void sendInventoryAction(InventoryAction *a);
 244         void sendChatMessage(const std::wstring &message);
 245         void clearOutChatQueue();
 246         void sendChangePassword(const std::string &oldpassword,
 247                 const std::string &newpassword);
 248         void sendDamage(u8 damage);
 249         void sendRespawn();
 250         void sendReady();
 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         virtual const std::vector<ModSpec> &getMods() const;
 259         virtual const ModSpec* getModSpec(const std::string &modname) const;
 260
 261         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 262         void removeNode(v3s16 p);
 263
 264         /**
 265          * Helper function for Client Side Modding
 266          * Flavour is applied there, this should not be used for core engine
 267          * @param p
 268          * @param is_valid_position
 269          * @return
 270          */
 271         MapNode getNode(v3s16 p, bool *is_valid_position);
 272         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 273
 274         void setPlayerControl(PlayerControl &control);
 275
 276         void selectPlayerItem(u16 item);
 277         u16 getPlayerItem() const
 278         { return m_playeritem; }
 279
 280         // Returns true if the inventory of the local player has been
 281         // updated from the server. If it is true, it is set to false.
 282         bool getLocalInventoryUpdated();
 283         // Copies the inventory of the local player to parameter
 284         void getLocalInventory(Inventory &dst);
 285
 286         /* InventoryManager interface */
 287         Inventory* getInventory(const InventoryLocation &loc);
 288         void inventoryAction(InventoryAction *a);
 289
 290         const std::list<std::string> &getConnectedPlayerNames()
 291         {
 292                 return m_env.getPlayerNames();
 293         }
 294
 295         float getAnimationTime();
 296
 297         int getCrackLevel();
 298         v3s16 getCrackPos();
 299         void setCrack(int level, v3s16 pos);
 300
 301         u16 getHP();
 302
 303         bool checkPrivilege(const std::string &priv) const
 304         { return (m_privileges.count(priv) != 0); }
 305
 306         const std::unordered_set<std::string> &getPrivilegeList() const
 307         { return m_privileges; }
 308
 309         bool getChatMessage(std::wstring &message);
 310         void typeChatMessage(const std::wstring& message);
 311
 312         u64 getMapSeed(){ return m_map_seed; }
 313
 314         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 315         // Including blocks at appropriate edges
 316         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 317         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 318
 319         void updateCameraOffset(v3s16 camera_offset)
 320         { m_mesh_update_thread.m_camera_offset = camera_offset; }
 321
 322         bool hasClientEvents() const { return !m_client_event_queue.empty(); }
 323         // Get event from queue. If queue is empty, it triggers an assertion failure.
 324         ClientEvent * getClientEvent();
 325
 326         bool accessDenied() const { return m_access_denied; }
 327
 328         bool reconnectRequested() const { return m_access_denied_reconnect; }
 329
 330         void setFatalError(const std::string &reason)
 331         {
 332                 m_access_denied = true;
 333                 m_access_denied_reason = reason;
 334         }
 335
 336         // Renaming accessDeniedReason to better name could be good as it's used to
 337         // disconnect client when CSM failed.
 338         const std::string &accessDeniedReason() const { return m_access_denied_reason; }
 339
 340         bool itemdefReceived()
 341         { return m_itemdef_received; }
 342         bool nodedefReceived()
 343         { return m_nodedef_received; }
 344         bool mediaReceived()
 345         { return !m_media_downloader; }
 346
 347         u8 getProtoVersion()
 348         { return m_proto_ver; }
 349
 350         bool connectedToServer();
 351
 352         float mediaReceiveProgress();
 353
 354         void afterContentReceived();
 355
 356         float getRTT();
 357         float getCurRate();
 358
 359         Minimap* getMinimap() { return m_minimap; }
 360         void setCamera(Camera* camera) { m_camera = camera; }
 361
 362         Camera* getCamera () { return m_camera; }
 363
 364         bool shouldShowMinimap() const;
 365
 366         // IGameDef interface
 367         virtual IItemDefManager* getItemDefManager();
 368         virtual INodeDefManager* getNodeDefManager();
 369         virtual ICraftDefManager* getCraftDefManager();
 370         ITextureSource* getTextureSource();
 371         virtual IShaderSource* getShaderSource();
 372         IShaderSource *shsrc() { return getShaderSource(); }
 373         virtual u16 allocateUnknownNodeId(const std::string &name);
 374         virtual ISoundManager* getSoundManager();
 375         virtual MtEventManager* getEventManager();
 376         virtual ParticleManager* getParticleManager();
 377         bool checkLocalPrivilege(const std::string &priv)
 378         { return checkPrivilege(priv); }
 379         virtual scene::IAnimatedMesh* getMesh(const std::string &filename, bool cache = false);
 380         const std::string* getModFile(const std::string &filename);
 381
 382         virtual std::string getModStoragePath() const;
 383         virtual bool registerModStorage(ModMetadata *meta);
 384         virtual void unregisterModStorage(const std::string &name);
 385
 386         // The following set of functions is used by ClientMediaDownloader
 387         // Insert a media file appropriately into the appropriate manager
 388         bool loadMedia(const std::string &data, const std::string &filename);
 389         // Send a request for conventional media transfer
 390         void request_media(const std::vector<std::string> &file_requests);
 391
 392         LocalClientState getState() { return m_state; }
 393
 394         void makeScreenshot();
 395
 396         inline void pushToChatQueue(ChatMessage *cec)
 397         {
 398                 m_chat_queue.push(cec);
 399         }
 400
 401         ClientScripting *getScript() { return m_script; }
 402         const bool moddingEnabled() const { return m_modding_enabled; }
 403
 404         void pushToEventQueue(ClientEvent *event);
 405
 406         void showGameChat(bool show = true);
 407         void showGameHud(bool show = true);
 408         void showMinimap(bool show = true);
 409         void showProfiler(bool show = true);
 410         void showGameFog(bool show = true);
 411         void showGameDebug(bool show = true);
 412
 413         const Address getServerAddress();
 414
 415         const std::string &getAddressName() const
 416         {
 417                 return m_address_name;
 418         }
 419
 420         inline bool checkCSMFlavourLimit(CSMFlavourLimit flag) const
 421         {
 422                 return m_csm_flavour_limits & flag;
 423         }
 424
 425         u32 getCSMNodeRangeLimit() const
 426         {
 427                 return m_csm_noderange_limit;
 428         }
 429
 430         bool joinModChannel(const std::string &channel);
 431         bool leaveModChannel(const std::string &channel);
 432         bool sendModChannelMessage(const std::string &channel, const std::string &message);
 433         ModChannel *getModChannel(const std::string &channel);
 434
 435 private:
 436
 437         // Virtual methods from con::PeerHandler
 438         void peerAdded(con::Peer *peer);
 439         void deletingPeer(con::Peer *peer, bool timeout);
 440
 441         void initLocalMapSaving(const Address &address,
 442                         const std::string &hostname,
 443                         bool is_local_server);
 444
 445         void ReceiveAll();
 446         void Receive();
 447
 448         void sendPlayerPos();
 449         // Send the item number 'item' as player item to the server
 450         void sendPlayerItem(u16 item);
 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 startAuth(AuthMechanism chosen_auth_mechanism);
 458         void sendDeletedBlocks(std::vector<v3s16> &blocks);
 459         void sendGotBlocks(v3s16 block);
 460         void sendRemovedSounds(std::vector<s32> &soundList);
 461
 462         // Helper function
 463         inline std::string getPlayerName()
 464         { return m_env.getLocalPlayer()->getName(); }
 465
 466         bool canSendChatMessage() const;
 467
 468         float m_packetcounter_timer = 0.0f;
 469         float m_connection_reinit_timer = 0.1f;
 470         float m_avg_rtt_timer = 0.0f;
 471         float m_playerpos_send_timer = 0.0f;
 472         IntervalLimiter m_map_timer_and_unload_interval;
 473
 474         IWritableTextureSource *m_tsrc;
 475         IWritableShaderSource *m_shsrc;
 476         IWritableItemDefManager *m_itemdef;
 477         IWritableNodeDefManager *m_nodedef;
 478         ISoundManager *m_sound;
 479         MtEventManager *m_event;
 480
 481
 482         MeshUpdateThread m_mesh_update_thread;
 483         ClientEnvironment m_env;
 484         ParticleManager m_particle_manager;
 485         std::unique_ptr<con::Connection> m_con;
 486         std::string m_address_name;
 487         Camera *m_camera = nullptr;
 488         Minimap *m_minimap = nullptr;
 489         bool m_minimap_disabled_by_server = false;
 490         // Server serialization version
 491         u8 m_server_ser_ver;
 492
 493         // Used version of the protocol with server
 494         // Values smaller than 25 only mean they are smaller than 25,
 495         // and aren't accurate. We simply just don't know, because
 496         // the server didn't send the version back then.
 497         // If 0, server init hasn't been received yet.
 498         u8 m_proto_ver = 0;
 499
 500         u16 m_playeritem = 0;
 501         bool m_inventory_updated = 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         ClientMediaDownloader *m_media_downloader;
 540
 541         // time_of_day speed approximation for old protocol
 542         bool m_time_of_day_set = false;
 543         float m_last_time_of_day_f = -1.0f;
 544         float m_time_of_day_update_timer = 0.0f;
 545
 546         // An interval for generally sending object positions and stuff
 547         float m_recommended_send_interval = 0.1f;
 548
 549         // Sounds
 550         float m_removed_sounds_check_timer = 0.0f;
 551         // Mapping from server sound ids to our sound ids
 552         std::unordered_map<s32, int> m_sounds_server_to_client;
 553         // And the other way!
 554         std::unordered_map<int, s32> m_sounds_client_to_server;
 555         // And relations to objects
 556         std::unordered_map<int, u16> m_sounds_to_objects;
 557
 558         // Privileges
 559         std::unordered_set<std::string> m_privileges;
 560
 561         // Detached inventories
 562         // key = name
 563         std::unordered_map<std::string, Inventory*> m_detached_inventories;
 564
 565         // Storage for mesh data for creating multiple instances of the same mesh
 566         StringMap m_mesh_data;
 567
 568         StringMap m_mod_files;
 569
 570         // own state
 571         LocalClientState m_state;
 572
 573         // Used for saving server map to disk client-side
 574         MapDatabase *m_localdb = nullptr;
 575         IntervalLimiter m_localdb_save_interval;
 576         u16 m_cache_save_interval;
 577
 578         ClientScripting *m_script = nullptr;
 579         bool m_modding_enabled;
 580         std::unordered_map<std::string, ModMetadata *> m_mod_storages;
 581         float m_mod_storage_save_timer = 10.0f;
 582         std::vector<ModSpec> m_mods;
 583         GameUIFlags *m_game_ui_flags;
 584
 585         bool m_shutdown = false;
 586
 587         // CSM flavour limits byteflag
 588         u64 m_csm_flavour_limits = CSMFlavourLimit::CSM_FL_NONE;
 589         u32 m_csm_noderange_limit = 8;
 590
 591         std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
 592 };