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 #ifndef CLIENT_HEADER
  21 #define CLIENT_HEADER
  22
  23 #include "network/connection.h"
  24 #include "environment.h"
  25 #include "irrlichttypes_extrabloated.h"
  26 #include "threading/mutex.h"
  27 #include <ostream>
  28 #include <map>
  29 #include <set>
  30 #include <vector>
  31 #include "clientobject.h"
  32 #include "gamedef.h"
  33 #include "inventorymanager.h"
  34 #include "localplayer.h"
  35 #include "hud.h"
  36 #include "particles.h"
  37 #include "network/networkpacket.h"
  38
  39 struct MeshMakeData;
  40 class MapBlockMesh;
  41 class IWritableTextureSource;
  42 class IWritableShaderSource;
  43 class IWritableItemDefManager;
  44 class IWritableNodeDefManager;
  45 //class IWritableCraftDefManager;
  46 class ClientMediaDownloader;
  47 struct MapDrawControl;
  48 class MtEventManager;
  49 struct PointedThing;
  50 class Database;
  51 class Mapper;
  52 struct MinimapMapblock;
  53
  54 struct QueuedMeshUpdate
  55 {
  56         v3s16 p;
  57         MeshMakeData *data;
  58         bool ack_block_to_server;
  59
  60         QueuedMeshUpdate();
  61         ~QueuedMeshUpdate();
  62 };
  63
  64 enum LocalClientState {
  65         LC_Created,
  66         LC_Init,
  67         LC_Ready
  68 };
  69
  70 /*
  71         A thread-safe queue of mesh update tasks
  72 */
  73 class MeshUpdateQueue
  74 {
  75 public:
  76         MeshUpdateQueue();
  77
  78         ~MeshUpdateQueue();
  79
  80         /*
  81                 peer_id=0 adds with nobody to send to
  82         */
  83         void addBlock(v3s16 p, MeshMakeData *data,
  84                         bool ack_block_to_server, bool urgent);
  85
  86         // Returned pointer must be deleted
  87         // Returns NULL if queue is empty
  88         QueuedMeshUpdate * pop();
  89
  90         u32 size()
  91         {
  92                 MutexAutoLock lock(m_mutex);
  93                 return m_queue.size();
  94         }
  95
  96 private:
  97         std::vector<QueuedMeshUpdate*> m_queue;
  98         std::set<v3s16> m_urgents;
  99         Mutex m_mutex;
 100 };
 101
 102 struct MeshUpdateResult
 103 {
 104         v3s16 p;
 105         MapBlockMesh *mesh;
 106         bool ack_block_to_server;
 107
 108         MeshUpdateResult():
 109                 p(-1338,-1338,-1338),
 110                 mesh(NULL),
 111                 ack_block_to_server(false)
 112         {
 113         }
 114 };
 115
 116 class MeshUpdateThread : public UpdateThread
 117 {
 118 private:
 119         MeshUpdateQueue m_queue_in;
 120
 121 protected:
 122         virtual void doUpdate();
 123
 124 public:
 125
 126         MeshUpdateThread() : UpdateThread("Mesh") {}
 127
 128         void enqueueUpdate(v3s16 p, MeshMakeData *data,
 129                         bool ack_block_to_server, bool urgent);
 130         MutexedQueue<MeshUpdateResult> m_queue_out;
 131
 132         v3s16 m_camera_offset;
 133 };
 134
 135 enum ClientEventType
 136 {
 137         CE_NONE,
 138         CE_PLAYER_DAMAGE,
 139         CE_PLAYER_FORCE_MOVE,
 140         CE_DEATHSCREEN,
 141         CE_SHOW_FORMSPEC,
 142         CE_SPAWN_PARTICLE,
 143         CE_ADD_PARTICLESPAWNER,
 144         CE_DELETE_PARTICLESPAWNER,
 145         CE_HUDADD,
 146         CE_HUDRM,
 147         CE_HUDCHANGE,
 148         CE_SET_SKY,
 149         CE_OVERRIDE_DAY_NIGHT_RATIO,
 150 };
 151
 152 struct ClientEvent
 153 {
 154         ClientEventType type;
 155         union{
 156                 //struct{
 157                 //} none;
 158                 struct{
 159                         u8 amount;
 160                 } player_damage;
 161                 struct{
 162                         f32 pitch;
 163                         f32 yaw;
 164                 } player_force_move;
 165                 struct{
 166                         bool set_camera_point_target;
 167                         f32 camera_point_target_x;
 168                         f32 camera_point_target_y;
 169                         f32 camera_point_target_z;
 170                 } deathscreen;
 171                 struct{
 172                         std::string *formspec;
 173                         std::string *formname;
 174                 } show_formspec;
 175                 //struct{
 176                 //} textures_updated;
 177                 struct{
 178                         v3f *pos;
 179                         v3f *vel;
 180                         v3f *acc;
 181                         f32 expirationtime;
 182                         f32 size;
 183                         bool collisiondetection;
 184                         bool vertical;
 185                         std::string *texture;
 186                 } spawn_particle;
 187                 struct{
 188                         u16 amount;
 189                         f32 spawntime;
 190                         v3f *minpos;
 191                         v3f *maxpos;
 192                         v3f *minvel;
 193                         v3f *maxvel;
 194                         v3f *minacc;
 195                         v3f *maxacc;
 196                         f32 minexptime;
 197                         f32 maxexptime;
 198                         f32 minsize;
 199                         f32 maxsize;
 200                         bool collisiondetection;
 201                         bool vertical;
 202                         std::string *texture;
 203                         u32 id;
 204                 } add_particlespawner;
 205                 struct{
 206                         u32 id;
 207                 } delete_particlespawner;
 208                 struct{
 209                         u32 id;
 210                         u8 type;
 211                         v2f *pos;
 212                         std::string *name;
 213                         v2f *scale;
 214                         std::string *text;
 215                         u32 number;
 216                         u32 item;
 217                         u32 dir;
 218                         v2f *align;
 219                         v2f *offset;
 220                         v3f *world_pos;
 221                         v2s32 * size;
 222                 } hudadd;
 223                 struct{
 224                         u32 id;
 225                 } hudrm;
 226                 struct{
 227                         u32 id;
 228                         HudElementStat stat;
 229                         v2f *v2fdata;
 230                         std::string *sdata;
 231                         u32 data;
 232                         v3f *v3fdata;
 233                         v2s32 * v2s32data;
 234                 } hudchange;
 235                 struct{
 236                         video::SColor *bgcolor;
 237                         std::string *type;
 238                         std::vector<std::string> *params;
 239                 } set_sky;
 240                 struct{
 241                         bool do_override;
 242                         float ratio_f;
 243                 } override_day_night_ratio;
 244         };
 245 };
 246
 247 /*
 248         Packet counter
 249 */
 250
 251 class PacketCounter
 252 {
 253 public:
 254         PacketCounter()
 255         {
 256         }
 257
 258         void add(u16 command)
 259         {
 260                 std::map<u16, u16>::iterator n = m_packets.find(command);
 261                 if(n == m_packets.end())
 262                 {
 263                         m_packets[command] = 1;
 264                 }
 265                 else
 266                 {
 267                         n->second++;
 268                 }
 269         }
 270
 271         void clear()
 272         {
 273                 for(std::map<u16, u16>::iterator
 274                                 i = m_packets.begin();
 275                                 i != m_packets.end(); ++i)
 276                 {
 277                         i->second = 0;
 278                 }
 279         }
 280
 281         void print(std::ostream &o)
 282         {
 283                 for(std::map<u16, u16>::iterator
 284                                 i = m_packets.begin();
 285                                 i != m_packets.end(); ++i)
 286                 {
 287                         o<<"cmd "<<i->first
 288                                         <<" count "<<i->second
 289                                         <<std::endl;
 290                 }
 291         }
 292
 293 private:
 294         // command, count
 295         std::map<u16, u16> m_packets;
 296 };
 297
 298 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 299 {
 300 public:
 301         /*
 302                 NOTE: Nothing is thread-safe here.
 303         */
 304
 305         Client(
 306                         IrrlichtDevice *device,
 307                         const char *playername,
 308                         std::string password,
 309                         MapDrawControl &control,
 310                         IWritableTextureSource *tsrc,
 311                         IWritableShaderSource *shsrc,
 312                         IWritableItemDefManager *itemdef,
 313                         IWritableNodeDefManager *nodedef,
 314                         ISoundManager *sound,
 315                         MtEventManager *event,
 316                         bool ipv6
 317         );
 318
 319         ~Client();
 320
 321         /*
 322          request all threads managed by client to be stopped
 323          */
 324         void Stop();
 325
 326
 327         bool isShutdown();
 328
 329         /*
 330                 The name of the local player should already be set when
 331                 calling this, as it is sent in the initialization.
 332         */
 333         void connect(Address address,
 334                         const std::string &address_name,
 335                         bool is_local_server);
 336
 337         /*
 338                 Stuff that references the environment is valid only as
 339                 long as this is not called. (eg. Players)
 340                 If this throws a PeerNotFoundException, the connection has
 341                 timed out.
 342         */
 343         void step(float dtime);
 344
 345         /*
 346          * Command Handlers
 347          */
 348
 349         void handleCommand(NetworkPacket* pkt);
 350
 351         void handleCommand_Null(NetworkPacket* pkt) {};
 352         void handleCommand_Deprecated(NetworkPacket* pkt);
 353         void handleCommand_Hello(NetworkPacket* pkt);
 354         void handleCommand_AuthAccept(NetworkPacket* pkt);
 355         void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
 356         void handleCommand_DenySudoMode(NetworkPacket* pkt);
 357         void handleCommand_InitLegacy(NetworkPacket* pkt);
 358         void handleCommand_AccessDenied(NetworkPacket* pkt);
 359         void handleCommand_RemoveNode(NetworkPacket* pkt);
 360         void handleCommand_AddNode(NetworkPacket* pkt);
 361         void handleCommand_BlockData(NetworkPacket* pkt);
 362         void handleCommand_Inventory(NetworkPacket* pkt);
 363         void handleCommand_TimeOfDay(NetworkPacket* pkt);
 364         void handleCommand_ChatMessage(NetworkPacket* pkt);
 365         void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
 366         void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
 367         void handleCommand_Movement(NetworkPacket* pkt);
 368         void handleCommand_HP(NetworkPacket* pkt);
 369         void handleCommand_Breath(NetworkPacket* pkt);
 370         void handleCommand_MovePlayer(NetworkPacket* pkt);
 371         void handleCommand_PlayerItem(NetworkPacket* pkt);
 372         void handleCommand_DeathScreen(NetworkPacket* pkt);
 373         void handleCommand_AnnounceMedia(NetworkPacket* pkt);
 374         void handleCommand_Media(NetworkPacket* pkt);
 375         void handleCommand_ToolDef(NetworkPacket* pkt);
 376         void handleCommand_NodeDef(NetworkPacket* pkt);
 377         void handleCommand_CraftItemDef(NetworkPacket* pkt);
 378         void handleCommand_ItemDef(NetworkPacket* pkt);
 379         void handleCommand_PlaySound(NetworkPacket* pkt);
 380         void handleCommand_StopSound(NetworkPacket* pkt);
 381         void handleCommand_Privileges(NetworkPacket* pkt);
 382         void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
 383         void handleCommand_DetachedInventory(NetworkPacket* pkt);
 384         void handleCommand_ShowFormSpec(NetworkPacket* pkt);
 385         void handleCommand_SpawnParticle(NetworkPacket* pkt);
 386         void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
 387         void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
 388         void handleCommand_HudAdd(NetworkPacket* pkt);
 389         void handleCommand_HudRemove(NetworkPacket* pkt);
 390         void handleCommand_HudChange(NetworkPacket* pkt);
 391         void handleCommand_HudSetFlags(NetworkPacket* pkt);
 392         void handleCommand_HudSetParam(NetworkPacket* pkt);
 393         void handleCommand_HudSetSky(NetworkPacket* pkt);
 394         void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
 395         void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
 396         void handleCommand_EyeOffset(NetworkPacket* pkt);
 397         void handleCommand_SrpBytesSandB(NetworkPacket* pkt);
 398
 399         void ProcessData(NetworkPacket *pkt);
 400
 401         // Returns true if something was received
 402         bool AsyncProcessPacket();
 403         bool AsyncProcessData();
 404         void Send(NetworkPacket* pkt);
 405
 406         void interact(u8 action, const PointedThing& pointed);
 407
 408         void sendNodemetaFields(v3s16 p, const std::string &formname,
 409                 const StringMap &fields);
 410         void sendInventoryFields(const std::string &formname,
 411                 const StringMap &fields);
 412         void sendInventoryAction(InventoryAction *a);
 413         void sendChatMessage(const std::wstring &message);
 414         void sendChangePassword(const std::string &oldpassword,
 415                 const std::string &newpassword);
 416         void sendDamage(u8 damage);
 417         void sendBreath(u16 breath);
 418         void sendRespawn();
 419         void sendReady();
 420
 421         ClientEnvironment& getEnv()
 422         { return m_env; }
 423
 424         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 425         void removeNode(v3s16 p);
 426         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 427
 428         void setPlayerControl(PlayerControl &control);
 429
 430         void selectPlayerItem(u16 item);
 431         u16 getPlayerItem() const
 432         { return m_playeritem; }
 433
 434         // Returns true if the inventory of the local player has been
 435         // updated from the server. If it is true, it is set to false.
 436         bool getLocalInventoryUpdated();
 437         // Copies the inventory of the local player to parameter
 438         void getLocalInventory(Inventory &dst);
 439
 440         /* InventoryManager interface */
 441         Inventory* getInventory(const InventoryLocation &loc);
 442         void inventoryAction(InventoryAction *a);
 443
 444         // Gets closest object pointed by the shootline
 445         // Returns NULL if not found
 446         ClientActiveObject * getSelectedActiveObject(
 447                         f32 max_d,
 448                         v3f from_pos_f_on_map,
 449                         core::line3d<f32> shootline_on_map
 450         );
 451
 452         std::list<std::string> getConnectedPlayerNames();
 453
 454         float getAnimationTime();
 455
 456         int getCrackLevel();
 457         void setCrack(int level, v3s16 pos);
 458
 459         u16 getHP();
 460         u16 getBreath();
 461
 462         bool checkPrivilege(const std::string &priv)
 463         { return (m_privileges.count(priv) != 0); }
 464
 465         bool getChatMessage(std::wstring &message);
 466         void typeChatMessage(const std::wstring& message);
 467
 468         u64 getMapSeed(){ return m_map_seed; }
 469
 470         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 471         // Including blocks at appropriate edges
 472         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 473         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 474
 475         void updateCameraOffset(v3s16 camera_offset)
 476         { m_mesh_update_thread.m_camera_offset = camera_offset; }
 477
 478         // Get event from queue. CE_NONE is returned if queue is empty.
 479         ClientEvent getClientEvent();
 480
 481         bool accessDenied()
 482         { return m_access_denied; }
 483
 484         bool reconnectRequested() { return m_access_denied_reconnect; }
 485
 486         std::string accessDeniedReason()
 487         { return m_access_denied_reason; }
 488
 489         bool itemdefReceived()
 490         { return m_itemdef_received; }
 491         bool nodedefReceived()
 492         { return m_nodedef_received; }
 493         bool mediaReceived()
 494         { return m_media_downloader == NULL; }
 495
 496         u8 getProtoVersion()
 497         { return m_proto_ver; }
 498
 499         float mediaReceiveProgress();
 500
 501         void afterContentReceived(IrrlichtDevice *device);
 502
 503         float getRTT(void);
 504         float getCurRate(void);
 505         float getAvgRate(void);
 506
 507         Mapper* getMapper ()
 508         { return m_mapper; }
 509
 510         bool isMinimapDisabledByServer()
 511         { return m_minimap_disabled_by_server; }
 512
 513         // IGameDef interface
 514         virtual IItemDefManager* getItemDefManager();
 515         virtual INodeDefManager* getNodeDefManager();
 516         virtual ICraftDefManager* getCraftDefManager();
 517         virtual ITextureSource* getTextureSource();
 518         virtual IShaderSource* getShaderSource();
 519         virtual scene::ISceneManager* getSceneManager();
 520         virtual u16 allocateUnknownNodeId(const std::string &name);
 521         virtual ISoundManager* getSoundManager();
 522         virtual MtEventManager* getEventManager();
 523         virtual ParticleManager* getParticleManager();
 524         virtual bool checkLocalPrivilege(const std::string &priv)
 525         { return checkPrivilege(priv); }
 526         virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
 527
 528         // The following set of functions is used by ClientMediaDownloader
 529         // Insert a media file appropriately into the appropriate manager
 530         bool loadMedia(const std::string &data, const std::string &filename);
 531         // Send a request for conventional media transfer
 532         void request_media(const std::vector<std::string> &file_requests);
 533         // Send a notification that no conventional media transfer is needed
 534         void received_media();
 535
 536         LocalClientState getState() { return m_state; }
 537
 538         void makeScreenshot(IrrlichtDevice *device);
 539
 540 private:
 541
 542         // Virtual methods from con::PeerHandler
 543         void peerAdded(con::Peer *peer);
 544         void deletingPeer(con::Peer *peer, bool timeout);
 545
 546         void initLocalMapSaving(const Address &address,
 547                         const std::string &hostname,
 548                         bool is_local_server);
 549
 550         void ReceiveAll();
 551         void Receive();
 552
 553         void sendPlayerPos();
 554         // Send the item number 'item' as player item to the server
 555         void sendPlayerItem(u16 item);
 556
 557         void deleteAuthData();
 558         // helper method shared with clientpackethandler
 559         static AuthMechanism choseAuthMech(const u32 mechs);
 560
 561         void sendLegacyInit(const char* playerName, const char* playerPassword);
 562         void sendInit(const std::string &playerName);
 563         void startAuth(AuthMechanism chosen_auth_mechanism);
 564         void sendDeletedBlocks(std::vector<v3s16> &blocks);
 565         void sendGotBlocks(v3s16 block);
 566         void sendRemovedSounds(std::vector<s32> &soundList);
 567
 568         // Helper function
 569         inline std::string getPlayerName()
 570         { return m_env.getLocalPlayer()->getName(); }
 571
 572         float m_packetcounter_timer;
 573         float m_connection_reinit_timer;
 574         float m_avg_rtt_timer;
 575         float m_playerpos_send_timer;
 576         float m_ignore_damage_timer; // Used after server moves player
 577         IntervalLimiter m_map_timer_and_unload_interval;
 578
 579         IWritableTextureSource *m_tsrc;
 580         IWritableShaderSource *m_shsrc;
 581         IWritableItemDefManager *m_itemdef;
 582         IWritableNodeDefManager *m_nodedef;
 583         ISoundManager *m_sound;
 584         MtEventManager *m_event;
 585
 586
 587         MeshUpdateThread m_mesh_update_thread;
 588         ClientEnvironment m_env;
 589         ParticleManager m_particle_manager;
 590         con::Connection m_con;
 591         IrrlichtDevice *m_device;
 592         Mapper *m_mapper;
 593         bool m_minimap_disabled_by_server;
 594         // Server serialization version
 595         u8 m_server_ser_ver;
 596
 597         // Used version of the protocol with server
 598         // Values smaller than 25 only mean they are smaller than 25,
 599         // and aren't accurate. We simply just don't know, because
 600         // the server didn't send the version back then.
 601         // If 0, server init hasn't been received yet.
 602         u8 m_proto_ver;
 603
 604         u16 m_playeritem;
 605         bool m_inventory_updated;
 606         Inventory *m_inventory_from_server;
 607         float m_inventory_from_server_age;
 608         PacketCounter m_packetcounter;
 609         // Block mesh animation parameters
 610         float m_animation_time;
 611         int m_crack_level;
 612         v3s16 m_crack_pos;
 613         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 614         //s32 m_daynight_i;
 615         //u32 m_daynight_ratio;
 616         std::queue<std::wstring> m_chat_queue;
 617
 618         // The authentication methods we can use to enter sudo mode (=change password)
 619         u32 m_sudo_auth_methods;
 620
 621         // The seed returned by the server in TOCLIENT_INIT is stored here
 622         u64 m_map_seed;
 623
 624         // Auth data
 625         std::string m_playername;
 626         std::string m_password;
 627         // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
 628         std::string m_new_password;
 629         // Usable by auth mechanisms.
 630         AuthMechanism m_chosen_auth_mech;
 631         void * m_auth_data;
 632
 633
 634         bool m_access_denied;
 635         bool m_access_denied_reconnect;
 636         std::string m_access_denied_reason;
 637         std::queue<ClientEvent> m_client_event_queue;
 638         bool m_itemdef_received;
 639         bool m_nodedef_received;
 640         ClientMediaDownloader *m_media_downloader;
 641
 642         // time_of_day speed approximation for old protocol
 643         bool m_time_of_day_set;
 644         float m_last_time_of_day_f;
 645         float m_time_of_day_update_timer;
 646
 647         // An interval for generally sending object positions and stuff
 648         float m_recommended_send_interval;
 649
 650         // Sounds
 651         float m_removed_sounds_check_timer;
 652         // Mapping from server sound ids to our sound ids
 653         std::map<s32, int> m_sounds_server_to_client;
 654         // And the other way!
 655         std::map<int, s32> m_sounds_client_to_server;
 656         // And relations to objects
 657         std::map<int, u16> m_sounds_to_objects;
 658
 659         // Privileges
 660         std::set<std::string> m_privileges;
 661
 662         // Detached inventories
 663         // key = name
 664         std::map<std::string, Inventory*> m_detached_inventories;
 665
 666         // Storage for mesh data for creating multiple instances of the same mesh
 667         StringMap m_mesh_data;
 668
 669         // own state
 670         LocalClientState m_state;
 671
 672         // Used for saving server map to disk client-side
 673         Database *m_localdb;
 674         IntervalLimiter m_localdb_save_interval;
 675         u16 m_cache_save_interval;
 676
 677         // TODO: Add callback to update these when g_settings changes
 678         bool m_cache_smooth_lighting;
 679         bool m_cache_enable_shaders;
 680
 681         DISABLE_CLASS_COPY(Client);
 682 };
 683
 684 #endif // !CLIENT_HEADER