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         CE_SHOW_FORMSPEC
 159 };
 160
 161 struct ClientEvent
 162 {
 163         ClientEventType type;
 164         union{
 165                 struct{
 166                 } none;
 167                 struct{
 168                         u8 amount;
 169                 } player_damage;
 170                 struct{
 171                         f32 pitch;
 172                         f32 yaw;
 173                 } player_force_move;
 174                 struct{
 175                         bool set_camera_point_target;
 176                         f32 camera_point_target_x;
 177                         f32 camera_point_target_y;
 178                         f32 camera_point_target_z;
 179                 } deathscreen;
 180                 struct{
 181                         std::string* formspec;
 182                 } show_formspec;
 183                 struct{
 184                 } textures_updated;
 185         };
 186 };
 187
 188 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 189 {
 190 public:
 191         /*
 192                 NOTE: Nothing is thread-safe here.
 193         */
 194
 195         Client(
 196                         IrrlichtDevice *device,
 197                         const char *playername,
 198                         std::string password,
 199                         MapDrawControl &control,
 200                         IWritableTextureSource *tsrc,
 201                         IWritableShaderSource *shsrc,
 202                         IWritableItemDefManager *itemdef,
 203                         IWritableNodeDefManager *nodedef,
 204                         ISoundManager *sound,
 205                         MtEventManager *event
 206         );
 207
 208         ~Client();
 209         /*
 210                 The name of the local player should already be set when
 211                 calling this, as it is sent in the initialization.
 212         */
 213         void connect(Address address);
 214         /*
 215                 returns true when
 216                         m_con.Connected() == true
 217                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 218                 throws con::PeerNotFoundException if connection has been deleted,
 219                 eg. timed out.
 220         */
 221         bool connectedAndInitialized();
 222         /*
 223                 Stuff that references the environment is valid only as
 224                 long as this is not called. (eg. Players)
 225                 If this throws a PeerNotFoundException, the connection has
 226                 timed out.
 227         */
 228         void step(float dtime);
 229
 230         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 231         // Returns true if something was received
 232         bool AsyncProcessPacket();
 233         bool AsyncProcessData();
 234         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 235
 236         void interact(u8 action, const PointedThing& pointed);
 237
 238         void sendNodemetaFields(v3s16 p, const std::string &formname,
 239                         const std::map<std::string, std::string> &fields);
 240         void sendInventoryFields(const std::string &formname,
 241                         const std::map<std::string, std::string> &fields);
 242         void sendInventoryAction(InventoryAction *a);
 243         void sendChatMessage(const std::wstring &message);
 244         void sendChangePassword(const std::wstring oldpassword,
 245                         const std::wstring newpassword);
 246         void sendDamage(u8 damage);
 247         void sendRespawn();
 248
 249         ClientEnvironment& getEnv()
 250         { return m_env; }
 251
 252         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
 253         void removeNode(v3s16 p);
 254         void addNode(v3s16 p, MapNode n);
 255
 256         void setPlayerControl(PlayerControl &control);
 257
 258         void selectPlayerItem(u16 item);
 259         u16 getPlayerItem() const
 260         { return m_playeritem; }
 261
 262         // Returns true if the inventory of the local player has been
 263         // updated from the server. If it is true, it is set to false.
 264         bool getLocalInventoryUpdated();
 265         // Copies the inventory of the local player to parameter
 266         void getLocalInventory(Inventory &dst);
 267
 268         /* InventoryManager interface */
 269         Inventory* getInventory(const InventoryLocation &loc);
 270         void inventoryAction(InventoryAction *a);
 271
 272         // Gets closest object pointed by the shootline
 273         // Returns NULL if not found
 274         ClientActiveObject * getSelectedActiveObject(
 275                         f32 max_d,
 276                         v3f from_pos_f_on_map,
 277                         core::line3d<f32> shootline_on_map
 278         );
 279
 280         // Prints a line or two of info
 281         void printDebugInfo(std::ostream &os);
 282
 283         core::list<std::wstring> getConnectedPlayerNames();
 284
 285         float getAnimationTime();
 286
 287         int getCrackLevel();
 288         void setCrack(int level, v3s16 pos);
 289
 290         u16 getHP();
 291
 292         bool checkPrivilege(const std::string &priv)
 293         { return (m_privileges.count(priv) != 0); }
 294
 295         bool getChatMessage(std::wstring &message);
 296         void typeChatMessage(const std::wstring& message);
 297
 298         u64 getMapSeed(){ return m_map_seed; }
 299
 300         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 301         // Including blocks at appropriate edges
 302         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
 303         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
 304
 305         // Get event from queue. CE_NONE is returned if queue is empty.
 306         ClientEvent getClientEvent();
 307
 308         bool accessDenied()
 309         { return m_access_denied; }
 310
 311         std::wstring accessDeniedReason()
 312         { return m_access_denied_reason; }
 313
 314         float mediaReceiveProgress()
 315         {
 316                 if (!m_media_receive_started) return 0;
 317                 return 1.0 * m_media_received_count / m_media_count;
 318         }
 319
 320         bool texturesReceived()
 321         { return m_media_receive_started && m_media_received_count == m_media_count; }
 322         bool itemdefReceived()
 323         { return m_itemdef_received; }
 324         bool nodedefReceived()
 325         { return m_nodedef_received; }
 326
 327         void afterContentReceived();
 328
 329         float getRTT(void);
 330
 331         // IGameDef interface
 332         virtual IItemDefManager* getItemDefManager();
 333         virtual INodeDefManager* getNodeDefManager();
 334         virtual ICraftDefManager* getCraftDefManager();
 335         virtual ITextureSource* getTextureSource();
 336         virtual IShaderSource* getShaderSource();
 337         virtual u16 allocateUnknownNodeId(const std::string &name);
 338         virtual ISoundManager* getSoundManager();
 339         virtual MtEventManager* getEventManager();
 340         virtual bool checkLocalPrivilege(const std::string &priv)
 341         { return checkPrivilege(priv); }
 342
 343 private:
 344
 345         // Insert a media file appropriately into the appropriate manager
 346         bool loadMedia(const std::string &data, const std::string &filename);
 347
 348         void request_media(const core::list<MediaRequest> &file_requests);
 349
 350         // Virtual methods from con::PeerHandler
 351         void peerAdded(con::Peer *peer);
 352         void deletingPeer(con::Peer *peer, bool timeout);
 353
 354         void ReceiveAll();
 355         void Receive();
 356
 357         void sendPlayerPos();
 358         // This sends the player's current name etc to the server
 359         void sendPlayerInfo();
 360         // Send the item number 'item' as player item to the server
 361         void sendPlayerItem(u16 item);
 362
 363         float m_packetcounter_timer;
 364         float m_connection_reinit_timer;
 365         float m_avg_rtt_timer;
 366         float m_playerpos_send_timer;
 367         float m_ignore_damage_timer; // Used after server moves player
 368         IntervalLimiter m_map_timer_and_unload_interval;
 369
 370         IWritableTextureSource *m_tsrc;
 371         IWritableShaderSource *m_shsrc;
 372         IWritableItemDefManager *m_itemdef;
 373         IWritableNodeDefManager *m_nodedef;
 374         ISoundManager *m_sound;
 375         MtEventManager *m_event;
 376
 377         MeshUpdateThread m_mesh_update_thread;
 378         core::list<MediaFetchThread*> m_media_fetch_threads;
 379         ClientEnvironment m_env;
 380         con::Connection m_con;
 381         IrrlichtDevice *m_device;
 382         // Server serialization version
 383         u8 m_server_ser_ver;
 384         u16 m_playeritem;
 385         bool m_inventory_updated;
 386         Inventory *m_inventory_from_server;
 387         float m_inventory_from_server_age;
 388         core::map<v3s16, bool> m_active_blocks;
 389         PacketCounter m_packetcounter;
 390         // Block mesh animation parameters
 391         float m_animation_time;
 392         int m_crack_level;
 393         v3s16 m_crack_pos;
 394         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 395         //s32 m_daynight_i;
 396         //u32 m_daynight_ratio;
 397         Queue<std::wstring> m_chat_queue;
 398         // The seed returned by the server in TOCLIENT_INIT is stored here
 399         u64 m_map_seed;
 400         std::string m_password;
 401         bool m_access_denied;
 402         std::wstring m_access_denied_reason;
 403         Queue<ClientEvent> m_client_event_queue;
 404         FileCache m_media_cache;
 405         // Mapping from media file name to SHA1 checksum
 406         core::map<std::string, std::string> m_media_name_sha1_map;
 407         bool m_media_receive_started;
 408         u32 m_media_count;
 409         u32 m_media_received_count;
 410         bool m_itemdef_received;
 411         bool m_nodedef_received;
 412         friend class FarMesh;
 413
 414         // time_of_day speed approximation for old protocol
 415         bool m_time_of_day_set;
 416         float m_last_time_of_day_f;
 417         float m_time_of_day_update_timer;
 418
 419         // An interval for generally sending object positions and stuff
 420         float m_recommended_send_interval;
 421
 422         // Sounds
 423         float m_removed_sounds_check_timer;
 424         // Mapping from server sound ids to our sound ids
 425         std::map<s32, int> m_sounds_server_to_client;
 426         // And the other way!
 427         std::map<int, s32> m_sounds_client_to_server;
 428         // And relations to objects
 429         std::map<int, u16> m_sounds_to_objects;
 430
 431         // Privileges
 432         std::set<std::string> m_privileges;
 433
 434         // Detached inventories
 435         // key = name
 436         std::map<std::string, Inventory*> m_detached_inventories;
 437 };
 438
 439 #endif // !CLIENT_HEADER
 440