src/client.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 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 "jmutex.h"
  27 #include <ostream>
  28 #include <set>
  29 #include <vector>
  30 #include "clientobject.h"
  31 #include "gamedef.h"
  32 #include "inventorymanager.h"
  33 #include "filesys.h"
  34 #include "filecache.h"
  35 #include "localplayer.h"
  36 #include "server.h"
  37 #include "util/pointedthing.h"
  38
  39 struct MeshMakeData;
  40 class MapBlockMesh;
  41 class IGameDef;
  42 class IWritableTextureSource;
  43 class IWritableShaderSource;
  44 class IWritableItemDefManager;
  45 class IWritableNodeDefManager;
  46 //class IWritableCraftDefManager;
  47 class ClientEnvironment;
  48 struct MapDrawControl;
  49 class MtEventManager;
  50
  51 class ClientNotReadyException : public BaseException
  52 {
  53 public:
  54         ClientNotReadyException(const char *s):
  55                 BaseException(s)
  56         {}
  57 };
  58
  59 struct QueuedMeshUpdate
  60 {
  61         v3s16 p;
  62         MeshMakeData *data;
  63         bool ack_block_to_server;
  64
  65         QueuedMeshUpdate();
  66         ~QueuedMeshUpdate();
  67 };
  68
  69 /*
  70         A thread-safe queue of mesh update tasks
  71 */
  72 class MeshUpdateQueue
  73 {
  74 public:
  75         MeshUpdateQueue();
  76
  77         ~MeshUpdateQueue();
  78
  79         /*
  80                 peer_id=0 adds with nobody to send to
  81         */
  82         void addBlock(v3s16 p, MeshMakeData *data,
  83                         bool ack_block_to_server, bool urgent);
  84
  85         // Returned pointer must be deleted
  86         // Returns NULL if queue is empty
  87         QueuedMeshUpdate * pop();
  88
  89         u32 size()
  90         {
  91                 JMutexAutoLock lock(m_mutex);
  92                 return m_queue.size();
  93         }
  94
  95 private:
  96         std::vector<QueuedMeshUpdate*> m_queue;
  97         std::set<v3s16> m_urgents;
  98         JMutex m_mutex;
  99 };
 100
 101 struct MeshUpdateResult
 102 {
 103         v3s16 p;
 104         MapBlockMesh *mesh;
 105         bool ack_block_to_server;
 106
 107         MeshUpdateResult():
 108                 p(-1338,-1338,-1338),
 109                 mesh(NULL),
 110                 ack_block_to_server(false)
 111         {
 112         }
 113 };
 114
 115 class MeshUpdateThread : public SimpleThread
 116 {
 117 public:
 118
 119         MeshUpdateThread(IGameDef *gamedef):
 120                 m_gamedef(gamedef)
 121         {
 122         }
 123
 124         void * Thread();
 125
 126         MeshUpdateQueue m_queue_in;
 127
 128         MutexedQueue<MeshUpdateResult> m_queue_out;
 129
 130         IGameDef *m_gamedef;
 131 };
 132
 133 class MediaFetchThread : public SimpleThread
 134 {
 135 public:
 136
 137         MediaFetchThread(IGameDef *gamedef):
 138                 m_gamedef(gamedef)
 139         {
 140         }
 141
 142         void * Thread();
 143
 144         core::list<MediaRequest> m_file_requests;
 145         MutexedQueue<std::pair<std::string, std::string> > m_file_data;
 146         core::list<MediaRequest> m_failed;
 147         std::string m_remote_url;
 148         IGameDef *m_gamedef;
 149 };
 150
 151 enum ClientEventType
 152 {
 153         CE_NONE,
 154         CE_PLAYER_DAMAGE,
 155         CE_PLAYER_FORCE_MOVE,
 156         CE_DEATHSCREEN,
 157         CE_TEXTURES_UPDATED
 158 };
 159
 160 struct ClientEvent
 161 {
 162         ClientEventType type;
 163         union{
 164                 struct{
 165                 } none;
 166                 struct{
 167                         u8 amount;
 168                 } player_damage;
 169                 struct{
 170                         f32 pitch;
 171                         f32 yaw;
 172                 } player_force_move;
 173                 struct{
 174                         bool set_camera_point_target;
 175                         f32 camera_point_target_x;
 176                         f32 camera_point_target_y;
 177                         f32 camera_point_target_z;
 178                 } deathscreen;
 179                 struct{
 180                 } textures_updated;
 181         };
 182 };
 183
 184 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 185 {
 186 public:
 187         /*
 188                 NOTE: Nothing is thread-safe here.
 189         */
 190
 191         Client(
 192                         IrrlichtDevice *device,
 193                         const char *playername,
 194                         std::string password,
 195                         MapDrawControl &control,
 196                         IWritableTextureSource *tsrc,
 197                         IWritableShaderSource *shsrc,
 198                         IWritableItemDefManager *itemdef,
 199                         IWritableNodeDefManager *nodedef,
 200                         ISoundManager *sound,
 201                         MtEventManager *event
 202         );
 203
 204         ~Client();
 205         /*
 206                 The name of the local player should already be set when
 207                 calling this, as it is sent in the initialization.
 208         */
 209         void connect(Address address);
 210         /*
 211                 returns true when
 212                         m_con.Connected() == true
 213                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 214                 throws con::PeerNotFoundException if connection has been deleted,
 215                 eg. timed out.
 216         */
 217         bool connectedAndInitialized();
 218         /*
 219                 Stuff that references the environment is valid only as
 220                 long as this is not called. (eg. Players)
 221                 If this throws a PeerNotFoundException, the connection has
 222                 timed out.
 223         */
 224         void step(float dtime);
 225
 226         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 227         // Returns true if something was received
 228         bool AsyncProcessPacket();
 229         bool AsyncProcessData();
 230         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 231
 232         void interact(u8 action, const PointedThing& pointed);
 233
 234         void sendNodemetaFields(v3s16 p, const std::string &formname,
 235                         const std::map<std::string, std::string> &fields);
 236         void sendInventoryFields(const std::string &formname,
 237                         const std::map<std::string, std::string> &fields);
 238         void sendInventoryAction(InventoryAction *a);
 239         void sendChatMessage(const std::wstring &message);
 240         void sendChangePassword(const std::wstring oldpassword,
 241                         const std::wstring newpassword);
 242         void sendDamage(u8 damage);
 243         void sendRespawn();
 244
 245         ClientEnvironment& getEnv()
 246         { return m_env; }
 247
 248         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 249         void removeNode(v3s16 p);
 250         void addNode(v3s16 p, MapNode n);
 251
 252         void setPlayerControl(PlayerControl &control);
 253
 254         void selectPlayerItem(u16 item);
 255         u16 getPlayerItem() const
 256         { return m_playeritem; }
 257
 258         // Returns true if the inventory of the local player has been
 259         // updated from the server. If it is true, it is set to false.
 260         bool getLocalInventoryUpdated();
 261         // Copies the inventory of the local player to parameter
 262         void getLocalInventory(Inventory &dst);
 263
 264         /* InventoryManager interface */
 265         Inventory* getInventory(const InventoryLocation &loc);
 266         void inventoryAction(InventoryAction *a);
 267
 268         // Gets closest object pointed by the shootline
 269         // Returns NULL if not found
 270         ClientActiveObject * getSelectedActiveObject(
 271                         f32 max_d,
 272                         v3f from_pos_f_on_map,
 273                         core::line3d<f32> shootline_on_map
 274         );
 275
 276         // Prints a line or two of info
 277         void printDebugInfo(std::ostream &os);
 278
 279         core::list<std::wstring> getConnectedPlayerNames();
 280
 281         float getAnimationTime();
 282
 283         int getCrackLevel();
 284         void setCrack(int level, v3s16 pos);
 285
 286         u16 getHP();
 287
 288         bool checkPrivilege(const std::string &priv)
 289         { return (m_privileges.count(priv) != 0); }
 290
 291         bool getChatMessage(std::wstring &message);
 292         void typeChatMessage(const std::wstring& message);
 293
 294         u64 getMapSeed(){ return m_map_seed; }
 295
 296         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 297         // Including blocks at appropriate edges
 298         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 299         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 300
 301         // Get event from queue. CE_NONE is returned if queue is empty.
 302         ClientEvent getClientEvent();
 303
 304         bool accessDenied()
 305         { return m_access_denied; }
 306
 307         std::wstring accessDeniedReason()
 308         { return m_access_denied_reason; }
 309
 310         float mediaReceiveProgress()
 311         {
 312                 if (!m_media_receive_started) return 0;
 313                 return 1.0 * m_media_received_count / m_media_count;
 314         }
 315
 316         bool texturesReceived()
 317         { return m_media_receive_started && m_media_received_count == m_media_count; }
 318         bool itemdefReceived()
 319         { return m_itemdef_received; }
 320         bool nodedefReceived()
 321         { return m_nodedef_received; }
 322
 323         void afterContentReceived();
 324
 325         float getRTT(void);
 326
 327         // IGameDef interface
 328         virtual IItemDefManager* getItemDefManager();
 329         virtual INodeDefManager* getNodeDefManager();
 330         virtual ICraftDefManager* getCraftDefManager();
 331         virtual ITextureSource* getTextureSource();
 332         virtual IShaderSource* getShaderSource();
 333         virtual u16 allocateUnknownNodeId(const std::string &name);
 334         virtual ISoundManager* getSoundManager();
 335         virtual MtEventManager* getEventManager();
 336         virtual bool checkLocalPrivilege(const std::string &priv)
 337         { return checkPrivilege(priv); }
 338
 339 private:
 340
 341         // Insert a media file appropriately into the appropriate manager
 342         bool loadMedia(const std::string &data, const std::string &filename);
 343
 344         void request_media(const core::list<MediaRequest> &file_requests);
 345
 346         // Virtual methods from con::PeerHandler
 347         void peerAdded(con::Peer *peer);
 348         void deletingPeer(con::Peer *peer, bool timeout);
 349
 350         void ReceiveAll();
 351         void Receive();
 352
 353         void sendPlayerPos();
 354         // This sends the player's current name etc to the server
 355         void sendPlayerInfo();
 356         // Send the item number 'item' as player item to the server
 357         void sendPlayerItem(u16 item);
 358
 359         float m_packetcounter_timer;
 360         float m_connection_reinit_timer;
 361         float m_avg_rtt_timer;
 362         float m_playerpos_send_timer;
 363         float m_ignore_damage_timer; // Used after server moves player
 364         IntervalLimiter m_map_timer_and_unload_interval;
 365
 366         IWritableTextureSource *m_tsrc;
 367         IWritableShaderSource *m_shsrc;
 368         IWritableItemDefManager *m_itemdef;
 369         IWritableNodeDefManager *m_nodedef;
 370         ISoundManager *m_sound;
 371         MtEventManager *m_event;
 372
 373         MeshUpdateThread m_mesh_update_thread;
 374         core::list<MediaFetchThread> m_media_fetch_threads;
 375         ClientEnvironment m_env;
 376         con::Connection m_con;
 377         IrrlichtDevice *m_device;
 378         // Server serialization version
 379         u8 m_server_ser_ver;
 380         u16 m_playeritem;
 381         bool m_inventory_updated;
 382         Inventory *m_inventory_from_server;
 383         float m_inventory_from_server_age;
 384         core::map<v3s16, bool> m_active_blocks;
 385         PacketCounter m_packetcounter;
 386         // Block mesh animation parameters
 387         float m_animation_time;
 388         int m_crack_level;
 389         v3s16 m_crack_pos;
 390         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 391         //s32 m_daynight_i;
 392         //u32 m_daynight_ratio;
 393         Queue<std::wstring> m_chat_queue;
 394         // The seed returned by the server in TOCLIENT_INIT is stored here
 395         u64 m_map_seed;
 396         std::string m_password;
 397         bool m_access_denied;
 398         std::wstring m_access_denied_reason;
 399         Queue<ClientEvent> m_client_event_queue;
 400         FileCache m_media_cache;
 401         // Mapping from media file name to SHA1 checksum
 402         core::map<std::string, std::string> m_media_name_sha1_map;
 403         bool m_media_receive_started;
 404         u32 m_media_count;
 405         u32 m_media_received_count;
 406         bool m_itemdef_received;
 407         bool m_nodedef_received;
 408         friend class FarMesh;
 409
 410         // time_of_day speed approximation for old protocol
 411         bool m_time_of_day_set;
 412         float m_last_time_of_day_f;
 413         float m_time_of_day_update_timer;
 414
 415         // An interval for generally sending object positions and stuff
 416         float m_recommended_send_interval;
 417
 418         // Sounds
 419         float m_removed_sounds_check_timer;
 420         // Mapping from server sound ids to our sound ids
 421         std::map<s32, int> m_sounds_server_to_client;
 422         // And the other way!
 423         std::map<int, s32> m_sounds_client_to_server;
 424         // And relations to objects
 425         std::map<int, u16> m_sounds_to_objects;
 426
 427         // Privileges
 428         std::set<std::string> m_privileges;
 429
 430         // Detached inventories
 431         // key = name
 432         std::map<std::string, Inventory*> m_detached_inventories;
 433 };
 434
 435 #endif // !CLIENT_HEADER
 436