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 "connection.h"
  24 #include "environment.h"
  25 #include "irrlichttypes_extrabloated.h"
  26 #include "jthread/jmutex.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
  38 struct MeshMakeData;
  39 class MapBlockMesh;
  40 class IWritableTextureSource;
  41 class IWritableShaderSource;
  42 class IWritableItemDefManager;
  43 class IWritableNodeDefManager;
  44 //class IWritableCraftDefManager;
  45 class ClientMediaDownloader;
  46 struct MapDrawControl;
  47 class MtEventManager;
  48 struct PointedThing;
  49
  50 struct QueuedMeshUpdate
  51 {
  52         v3s16 p;
  53         MeshMakeData *data;
  54         bool ack_block_to_server;
  55
  56         QueuedMeshUpdate();
  57         ~QueuedMeshUpdate();
  58 };
  59
  60 /*
  61         A thread-safe queue of mesh update tasks
  62 */
  63 class MeshUpdateQueue
  64 {
  65 public:
  66         MeshUpdateQueue();
  67
  68         ~MeshUpdateQueue();
  69
  70         /*
  71                 peer_id=0 adds with nobody to send to
  72         */
  73         void addBlock(v3s16 p, MeshMakeData *data,
  74                         bool ack_block_to_server, bool urgent);
  75
  76         // Returned pointer must be deleted
  77         // Returns NULL if queue is empty
  78         QueuedMeshUpdate * pop();
  79
  80         u32 size()
  81         {
  82                 JMutexAutoLock lock(m_mutex);
  83                 return m_queue.size();
  84         }
  85
  86 private:
  87         std::vector<QueuedMeshUpdate*> m_queue;
  88         std::set<v3s16> m_urgents;
  89         JMutex m_mutex;
  90 };
  91
  92 struct MeshUpdateResult
  93 {
  94         v3s16 p;
  95         MapBlockMesh *mesh;
  96         bool ack_block_to_server;
  97
  98         MeshUpdateResult():
  99                 p(-1338,-1338,-1338),
 100                 mesh(NULL),
 101                 ack_block_to_server(false)
 102         {
 103         }
 104 };
 105
 106 class MeshUpdateThread : public JThread
 107 {
 108 public:
 109
 110         MeshUpdateThread(IGameDef *gamedef):
 111                 m_gamedef(gamedef)
 112         {
 113         }
 114
 115         void * Thread();
 116
 117         MeshUpdateQueue m_queue_in;
 118
 119         MutexedQueue<MeshUpdateResult> m_queue_out;
 120
 121         IGameDef *m_gamedef;
 122 };
 123
 124 enum ClientEventType
 125 {
 126         CE_NONE,
 127         CE_PLAYER_DAMAGE,
 128         CE_PLAYER_FORCE_MOVE,
 129         CE_DEATHSCREEN,
 130         CE_SHOW_FORMSPEC,
 131         CE_SPAWN_PARTICLE,
 132         CE_ADD_PARTICLESPAWNER,
 133         CE_DELETE_PARTICLESPAWNER,
 134         CE_HUDADD,
 135         CE_HUDRM,
 136         CE_HUDCHANGE,
 137         CE_SET_SKY,
 138         CE_OVERRIDE_DAY_NIGHT_RATIO,
 139 };
 140
 141 struct ClientEvent
 142 {
 143         ClientEventType type;
 144         union{
 145                 struct{
 146                 } none;
 147                 struct{
 148                         u8 amount;
 149                 } player_damage;
 150                 struct{
 151                         f32 pitch;
 152                         f32 yaw;
 153                 } player_force_move;
 154                 struct{
 155                         bool set_camera_point_target;
 156                         f32 camera_point_target_x;
 157                         f32 camera_point_target_y;
 158                         f32 camera_point_target_z;
 159                 } deathscreen;
 160                 struct{
 161                         std::string *formspec;
 162                         std::string *formname;
 163                 } show_formspec;
 164                 struct{
 165                 } textures_updated;
 166                 struct{
 167                         v3f *pos;
 168                         v3f *vel;
 169                         v3f *acc;
 170                         f32 expirationtime;
 171                         f32 size;
 172                         bool collisiondetection;
 173                         bool vertical;
 174                         std::string *texture;
 175                 } spawn_particle;
 176                 struct{
 177                         u16 amount;
 178                         f32 spawntime;
 179                         v3f *minpos;
 180                         v3f *maxpos;
 181                         v3f *minvel;
 182                         v3f *maxvel;
 183                         v3f *minacc;
 184                         v3f *maxacc;
 185                         f32 minexptime;
 186                         f32 maxexptime;
 187                         f32 minsize;
 188                         f32 maxsize;
 189                         bool collisiondetection;
 190                         bool vertical;
 191                         std::string *texture;
 192                         u32 id;
 193                 } add_particlespawner;
 194                 struct{
 195                         u32 id;
 196                 } delete_particlespawner;
 197                 struct{
 198                         u32 id;
 199                         u8 type;
 200                         v2f *pos;
 201                         std::string *name;
 202                         v2f *scale;
 203                         std::string *text;
 204                         u32 number;
 205                         u32 item;
 206                         u32 dir;
 207                         v2f *align;
 208                         v2f *offset;
 209                         v3f *world_pos;
 210                 } hudadd;
 211                 struct{
 212                         u32 id;
 213                 } hudrm;
 214                 struct{
 215                         u32 id;
 216                         HudElementStat stat;
 217                         v2f *v2fdata;
 218                         std::string *sdata;
 219                         u32 data;
 220                         v3f *v3fdata;
 221                 } hudchange;
 222                 struct{
 223                         video::SColor *bgcolor;
 224                         std::string *type;
 225                         std::vector<std::string> *params;
 226                 } set_sky;
 227                 struct{
 228                         bool do_override;
 229                         float ratio_f;
 230                 } override_day_night_ratio;
 231         };
 232 };
 233
 234 /*
 235         Packet counter
 236 */
 237
 238 class PacketCounter
 239 {
 240 public:
 241         PacketCounter()
 242         {
 243         }
 244
 245         void add(u16 command)
 246         {
 247                 std::map<u16, u16>::iterator n = m_packets.find(command);
 248                 if(n == m_packets.end())
 249                 {
 250                         m_packets[command] = 1;
 251                 }
 252                 else
 253                 {
 254                         n->second++;
 255                 }
 256         }
 257
 258         void clear()
 259         {
 260                 for(std::map<u16, u16>::iterator
 261                                 i = m_packets.begin();
 262                                 i != m_packets.end(); ++i)
 263                 {
 264                         i->second = 0;
 265                 }
 266         }
 267
 268         void print(std::ostream &o)
 269         {
 270                 for(std::map<u16, u16>::iterator
 271                                 i = m_packets.begin();
 272                                 i != m_packets.end(); ++i)
 273                 {
 274                         o<<"cmd "<<i->first
 275                                         <<" count "<<i->second
 276                                         <<std::endl;
 277                 }
 278         }
 279
 280 private:
 281         // command, count
 282         std::map<u16, u16> m_packets;
 283 };
 284
 285 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 286 {
 287 public:
 288         /*
 289                 NOTE: Nothing is thread-safe here.
 290         */
 291
 292         Client(
 293                         IrrlichtDevice *device,
 294                         const char *playername,
 295                         std::string password,
 296                         MapDrawControl &control,
 297                         IWritableTextureSource *tsrc,
 298                         IWritableShaderSource *shsrc,
 299                         IWritableItemDefManager *itemdef,
 300                         IWritableNodeDefManager *nodedef,
 301                         ISoundManager *sound,
 302                         MtEventManager *event,
 303                         bool ipv6
 304         );
 305
 306         ~Client();
 307
 308         /*
 309          request all threads managed by client to be stopped
 310          */
 311         void Stop();
 312
 313
 314         bool isShutdown();
 315         /*
 316                 The name of the local player should already be set when
 317                 calling this, as it is sent in the initialization.
 318         */
 319         void connect(Address address);
 320         /*
 321                 returns true when
 322                         m_con.Connected() == true
 323                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 324                 throws con::PeerNotFoundException if connection has been deleted,
 325                 eg. timed out.
 326         */
 327         bool connectedAndInitialized();
 328         /*
 329                 Stuff that references the environment is valid only as
 330                 long as this is not called. (eg. Players)
 331                 If this throws a PeerNotFoundException, the connection has
 332                 timed out.
 333         */
 334         void step(float dtime);
 335
 336         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 337         // Returns true if something was received
 338         bool AsyncProcessPacket();
 339         bool AsyncProcessData();
 340         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 341
 342         void interact(u8 action, const PointedThing& pointed);
 343
 344         void sendNodemetaFields(v3s16 p, const std::string &formname,
 345                         const std::map<std::string, std::string> &fields);
 346         void sendInventoryFields(const std::string &formname,
 347                         const std::map<std::string, std::string> &fields);
 348         void sendInventoryAction(InventoryAction *a);
 349         void sendChatMessage(const std::wstring &message);
 350         void sendChangePassword(const std::wstring oldpassword,
 351                         const std::wstring newpassword);
 352         void sendDamage(u8 damage);
 353         void sendBreath(u16 breath);
 354         void sendRespawn();
 355
 356         ClientEnvironment& getEnv()
 357         { return m_env; }
 358
 359         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 360         void removeNode(v3s16 p);
 361         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
 362
 363         void setPlayerControl(PlayerControl &control);
 364
 365         void selectPlayerItem(u16 item);
 366         u16 getPlayerItem() const
 367         { return m_playeritem; }
 368
 369         // Returns true if the inventory of the local player has been
 370         // updated from the server. If it is true, it is set to false.
 371         bool getLocalInventoryUpdated();
 372         // Copies the inventory of the local player to parameter
 373         void getLocalInventory(Inventory &dst);
 374
 375         /* InventoryManager interface */
 376         Inventory* getInventory(const InventoryLocation &loc);
 377         void inventoryAction(InventoryAction *a);
 378
 379         // Gets closest object pointed by the shootline
 380         // Returns NULL if not found
 381         ClientActiveObject * getSelectedActiveObject(
 382                         f32 max_d,
 383                         v3f from_pos_f_on_map,
 384                         core::line3d<f32> shootline_on_map
 385         );
 386
 387         // Prints a line or two of info
 388         void printDebugInfo(std::ostream &os);
 389
 390         std::list<std::string> getConnectedPlayerNames();
 391
 392         float getAnimationTime();
 393
 394         int getCrackLevel();
 395         void setCrack(int level, v3s16 pos);
 396
 397         u16 getHP();
 398         u16 getBreath();
 399
 400         bool checkPrivilege(const std::string &priv)
 401         { return (m_privileges.count(priv) != 0); }
 402
 403         bool getChatMessage(std::wstring &message);
 404         void typeChatMessage(const std::wstring& message);
 405
 406         u64 getMapSeed(){ return m_map_seed; }
 407
 408         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 409         // Including blocks at appropriate edges
 410         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 411         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 412
 413         // Get event from queue. CE_NONE is returned if queue is empty.
 414         ClientEvent getClientEvent();
 415
 416         bool accessDenied()
 417         { return m_access_denied; }
 418
 419         std::wstring accessDeniedReason()
 420         { return m_access_denied_reason; }
 421
 422         bool itemdefReceived()
 423         { return m_itemdef_received; }
 424         bool nodedefReceived()
 425         { return m_nodedef_received; }
 426         bool mediaReceived()
 427         { return m_media_downloader == NULL; }
 428
 429         float mediaReceiveProgress();
 430
 431         void afterContentReceived(IrrlichtDevice *device, gui::IGUIFont* font);
 432
 433         float getRTT(void);
 434
 435         // IGameDef interface
 436         virtual IItemDefManager* getItemDefManager();
 437         virtual INodeDefManager* getNodeDefManager();
 438         virtual ICraftDefManager* getCraftDefManager();
 439         virtual ITextureSource* getTextureSource();
 440         virtual IShaderSource* getShaderSource();
 441         virtual u16 allocateUnknownNodeId(const std::string &name);
 442         virtual ISoundManager* getSoundManager();
 443         virtual MtEventManager* getEventManager();
 444         virtual bool checkLocalPrivilege(const std::string &priv)
 445         { return checkPrivilege(priv); }
 446         virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
 447
 448         // The following set of functions is used by ClientMediaDownloader
 449         // Insert a media file appropriately into the appropriate manager
 450         bool loadMedia(const std::string &data, const std::string &filename);
 451         // Send a request for conventional media transfer
 452         void request_media(const std::list<std::string> &file_requests);
 453         // Send a notification that no conventional media transfer is needed
 454         void received_media();
 455
 456 private:
 457
 458         // Virtual methods from con::PeerHandler
 459         void peerAdded(con::Peer *peer);
 460         void deletingPeer(con::Peer *peer, bool timeout);
 461
 462         void ReceiveAll();
 463         void Receive();
 464
 465         void sendPlayerPos();
 466         // Send the item number 'item' as player item to the server
 467         void sendPlayerItem(u16 item);
 468
 469         float m_packetcounter_timer;
 470         float m_connection_reinit_timer;
 471         float m_avg_rtt_timer;
 472         float m_playerpos_send_timer;
 473         float m_ignore_damage_timer; // Used after server moves player
 474         IntervalLimiter m_map_timer_and_unload_interval;
 475
 476         IWritableTextureSource *m_tsrc;
 477         IWritableShaderSource *m_shsrc;
 478         IWritableItemDefManager *m_itemdef;
 479         IWritableNodeDefManager *m_nodedef;
 480         ISoundManager *m_sound;
 481         MtEventManager *m_event;
 482
 483         MeshUpdateThread m_mesh_update_thread;
 484         ClientEnvironment m_env;
 485         con::Connection m_con;
 486         IrrlichtDevice *m_device;
 487         // Server serialization version
 488         u8 m_server_ser_ver;
 489         u16 m_playeritem;
 490         bool m_inventory_updated;
 491         Inventory *m_inventory_from_server;
 492         float m_inventory_from_server_age;
 493         std::set<v3s16> m_active_blocks;
 494         PacketCounter m_packetcounter;
 495         // Block mesh animation parameters
 496         float m_animation_time;
 497         int m_crack_level;
 498         v3s16 m_crack_pos;
 499         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 500         //s32 m_daynight_i;
 501         //u32 m_daynight_ratio;
 502         Queue<std::wstring> m_chat_queue;
 503         // The seed returned by the server in TOCLIENT_INIT is stored here
 504         u64 m_map_seed;
 505         std::string m_password;
 506         bool m_access_denied;
 507         std::wstring m_access_denied_reason;
 508         Queue<ClientEvent> m_client_event_queue;
 509         bool m_itemdef_received;
 510         bool m_nodedef_received;
 511         ClientMediaDownloader *m_media_downloader;
 512
 513         // time_of_day speed approximation for old protocol
 514         bool m_time_of_day_set;
 515         float m_last_time_of_day_f;
 516         float m_time_of_day_update_timer;
 517
 518         // An interval for generally sending object positions and stuff
 519         float m_recommended_send_interval;
 520
 521         // Sounds
 522         float m_removed_sounds_check_timer;
 523         // Mapping from server sound ids to our sound ids
 524         std::map<s32, int> m_sounds_server_to_client;
 525         // And the other way!
 526         std::map<int, s32> m_sounds_client_to_server;
 527         // And relations to objects
 528         std::map<int, u16> m_sounds_to_objects;
 529
 530         // Privileges
 531         std::set<std::string> m_privileges;
 532
 533         // Detached inventories
 534         // key = name
 535         std::map<std::string, Inventory*> m_detached_inventories;
 536
 537         // Storage for mesh data for creating multiple instances of the same mesh
 538         std::map<std::string, std::string> m_mesh_data;
 539 };
 540
 541 #endif // !CLIENT_HEADER
 542