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 General Public License as published by
   7 the Free Software Foundation; either version 2 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 General Public License for more details.
  14
  15 You should have received a copy of the GNU 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 #ifndef SERVER
  24
  25 #include "connection.h"
  26 #include "environment.h"
  27 #include "common_irrlicht.h"
  28 #include "jmutex.h"
  29 #include <ostream>
  30 #include "clientobject.h"
  31 #include "utility.h" // For IntervalLimiter
  32 #include "gamedef.h"
  33 #include "inventorymanager.h"
  34 #include "filesys.h"
  35
  36 struct MeshMakeData;
  37 class IGameDef;
  38 class IWritableTextureSource;
  39 class IWritableItemDefManager;
  40 class IWritableNodeDefManager;
  41 //class IWritableCraftDefManager;
  42
  43 class ClientNotReadyException : public BaseException
  44 {
  45 public:
  46         ClientNotReadyException(const char *s):
  47                 BaseException(s)
  48         {}
  49 };
  50
  51 struct QueuedMeshUpdate
  52 {
  53         v3s16 p;
  54         MeshMakeData *data;
  55         bool ack_block_to_server;
  56
  57         QueuedMeshUpdate();
  58         ~QueuedMeshUpdate();
  59 };
  60
  61 /*
  62         A thread-safe queue of mesh update tasks
  63 */
  64 class MeshUpdateQueue
  65 {
  66 public:
  67         MeshUpdateQueue();
  68
  69         ~MeshUpdateQueue();
  70
  71         /*
  72                 peer_id=0 adds with nobody to send to
  73         */
  74         void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
  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         core::list<QueuedMeshUpdate*> m_queue;
  88         JMutex m_mutex;
  89 };
  90
  91 struct MeshUpdateResult
  92 {
  93         v3s16 p;
  94         scene::SMesh *mesh;
  95         bool ack_block_to_server;
  96
  97         MeshUpdateResult():
  98                 p(-1338,-1338,-1338),
  99                 mesh(NULL),
 100                 ack_block_to_server(false)
 101         {
 102         }
 103 };
 104
 105 class MeshUpdateThread : public SimpleThread
 106 {
 107 public:
 108
 109         MeshUpdateThread(IGameDef *gamedef):
 110                 m_gamedef(gamedef)
 111         {
 112         }
 113
 114         void * Thread();
 115
 116         MeshUpdateQueue m_queue_in;
 117
 118         MutexedQueue<MeshUpdateResult> m_queue_out;
 119
 120         IGameDef *m_gamedef;
 121 };
 122
 123 enum ClientEventType
 124 {
 125         CE_NONE,
 126         CE_PLAYER_DAMAGE,
 127         CE_PLAYER_FORCE_MOVE,
 128         CE_DEATHSCREEN,
 129         CE_TEXTURES_UPDATED
 130 };
 131
 132 struct ClientEvent
 133 {
 134         ClientEventType type;
 135         union{
 136                 struct{
 137                 } none;
 138                 struct{
 139                         u8 amount;
 140                 } player_damage;
 141                 struct{
 142                         f32 pitch;
 143                         f32 yaw;
 144                 } player_force_move;
 145                 struct{
 146                         bool set_camera_point_target;
 147                         f32 camera_point_target_x;
 148                         f32 camera_point_target_y;
 149                         f32 camera_point_target_z;
 150                 } deathscreen;
 151                 struct{
 152                 } textures_updated;
 153         };
 154 };
 155
 156 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 157 {
 158 public:
 159         /*
 160                 NOTE: Nothing is thread-safe here.
 161         */
 162
 163         Client(
 164                         IrrlichtDevice *device,
 165                         const char *playername,
 166                         std::string password,
 167                         MapDrawControl &control,
 168                         IWritableTextureSource *tsrc,
 169                         IWritableItemDefManager *itemdef,
 170                         IWritableNodeDefManager *nodedef
 171         );
 172
 173         ~Client();
 174         /*
 175                 The name of the local player should already be set when
 176                 calling this, as it is sent in the initialization.
 177         */
 178         void connect(Address address);
 179         /*
 180                 returns true when
 181                         m_con.Connected() == true
 182                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 183                 throws con::PeerNotFoundException if connection has been deleted,
 184                 eg. timed out.
 185         */
 186         bool connectedAndInitialized();
 187         /*
 188                 Stuff that references the environment is valid only as
 189                 long as this is not called. (eg. Players)
 190                 If this throws a PeerNotFoundException, the connection has
 191                 timed out.
 192         */
 193         void step(float dtime);
 194
 195         // Called from updater thread
 196         // Returns dtime
 197         //float asyncStep();
 198
 199         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 200         // Returns true if something was received
 201         bool AsyncProcessPacket();
 202         bool AsyncProcessData();
 203         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 204
 205         // Pops out a packet from the packet queue
 206         //IncomingPacket getPacket();
 207
 208         void interact(u8 action, const PointedThing& pointed);
 209
 210         void sendSignNodeText(v3s16 p, std::string text);
 211         void sendInventoryAction(InventoryAction *a);
 212         void sendChatMessage(const std::wstring &message);
 213         void sendChangePassword(const std::wstring oldpassword,
 214                 const std::wstring newpassword);
 215         void sendDamage(u8 damage);
 216         void sendRespawn();
 217
 218         // locks envlock
 219         void removeNode(v3s16 p);
 220         // locks envlock
 221         void addNode(v3s16 p, MapNode n);
 222
 223         void updateCamera(v3f pos, v3f dir, f32 fov);
 224
 225         void renderPostFx();
 226
 227         // Returns InvalidPositionException if not found
 228         MapNode getNode(v3s16 p);
 229         // Wrapper to Map
 230         NodeMetadata* getNodeMetadata(v3s16 p);
 231
 232         LocalPlayer* getLocalPlayer();
 233
 234         void setPlayerControl(PlayerControl &control);
 235
 236         void selectPlayerItem(u16 item);
 237         u16 getPlayerItem() const
 238         { return m_playeritem; }
 239
 240         // Returns true if the inventory of the local player has been
 241         // updated from the server. If it is true, it is set to false.
 242         bool getLocalInventoryUpdated();
 243         // Copies the inventory of the local player to parameter
 244         void getLocalInventory(Inventory &dst);
 245
 246         /* InventoryManager interface */
 247         Inventory* getInventory(const InventoryLocation &loc);
 248         void inventoryAction(InventoryAction *a);
 249
 250         // Gets closest object pointed by the shootline
 251         // Returns NULL if not found
 252         ClientActiveObject * getSelectedActiveObject(
 253                         f32 max_d,
 254                         v3f from_pos_f_on_map,
 255                         core::line3d<f32> shootline_on_map
 256         );
 257
 258         // Prints a line or two of info
 259         void printDebugInfo(std::ostream &os);
 260
 261         u32 getDayNightRatio();
 262
 263         u16 getHP();
 264
 265         void setTempMod(v3s16 p, NodeMod mod);
 266         void clearTempMod(v3s16 p);
 267
 268         float getAvgRtt()
 269         {
 270                 try{
 271                         return m_con.GetPeerAvgRTT(PEER_ID_SERVER);
 272                 } catch(con::PeerNotFoundException &){
 273                         return 1337;
 274                 }
 275         }
 276
 277         bool getChatMessage(std::wstring &message)
 278         {
 279                 if(m_chat_queue.size() == 0)
 280                         return false;
 281                 message = m_chat_queue.pop_front();
 282                 return true;
 283         }
 284
 285         void addChatMessage(const std::wstring &message)
 286         {
 287                 if (message[0] == L'/') {
 288                         m_chat_queue.push_back(
 289                                 (std::wstring)L"issued command: "+message);
 290                         return;
 291                 }
 292
 293                 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
 294                 LocalPlayer *player = m_env.getLocalPlayer();
 295                 assert(player != NULL);
 296                 std::wstring name = narrow_to_wide(player->getName());
 297                 m_chat_queue.push_back(
 298                                 (std::wstring)L"<"+name+L"> "+message);
 299         }
 300
 301         u64 getMapSeed(){ return m_map_seed; }
 302
 303         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
 304         // Including blocks at appropriate edges
 305         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
 306
 307         // Get event from queue. CE_NONE is returned if queue is empty.
 308         ClientEvent getClientEvent();
 309
 310         bool accessDenied()
 311         { return m_access_denied; }
 312
 313         std::wstring accessDeniedReason()
 314         { return m_access_denied_reason; }
 315
 316         float textureReceiveProgress()
 317         { return m_texture_receive_progress; }
 318
 319         bool texturesReceived()
 320         { return m_textures_received; }
 321         bool itemdefReceived()
 322         { return m_itemdef_received; }
 323         bool nodedefReceived()
 324         { return m_nodedef_received; }
 325
 326         void afterContentReceived();
 327
 328         float getRTT(void);
 329
 330         // IGameDef interface
 331         virtual IItemDefManager* getItemDefManager();
 332         virtual INodeDefManager* getNodeDefManager();
 333         virtual ICraftDefManager* getCraftDefManager();
 334         virtual ITextureSource* getTextureSource();
 335         virtual u16 allocateUnknownNodeId(const std::string &name);
 336
 337 private:
 338
 339         // Virtual methods from con::PeerHandler
 340         void peerAdded(con::Peer *peer);
 341         void deletingPeer(con::Peer *peer, bool timeout);
 342
 343         void ReceiveAll();
 344         void Receive();
 345
 346         void sendPlayerPos();
 347         // This sends the player's current name etc to the server
 348         void sendPlayerInfo();
 349         // Send the item number 'item' as player item to the server
 350         void sendPlayerItem(u16 item);
 351
 352         float m_packetcounter_timer;
 353         float m_connection_reinit_timer;
 354         float m_avg_rtt_timer;
 355         float m_playerpos_send_timer;
 356         float m_ignore_damage_timer; // Used after server moves player
 357         IntervalLimiter m_map_timer_and_unload_interval;
 358
 359         IWritableTextureSource *m_tsrc;
 360         IWritableItemDefManager *m_itemdef;
 361         IWritableNodeDefManager *m_nodedef;
 362         MeshUpdateThread m_mesh_update_thread;
 363         ClientEnvironment m_env;
 364         con::Connection m_con;
 365         IrrlichtDevice *m_device;
 366         // Server serialization version
 367         u8 m_server_ser_ver;
 368         u16 m_playeritem;
 369         bool m_inventory_updated;
 370         Inventory *m_inventory_from_server;
 371         float m_inventory_from_server_age;
 372         core::map<v3s16, bool> m_active_blocks;
 373         PacketCounter m_packetcounter;
 374         // Received from the server. 0-23999
 375         u32 m_time_of_day;
 376         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 377         //s32 m_daynight_i;
 378         //u32 m_daynight_ratio;
 379         Queue<std::wstring> m_chat_queue;
 380         // The seed returned by the server in TOCLIENT_INIT is stored here
 381         u64 m_map_seed;
 382         std::string m_password;
 383         bool m_access_denied;
 384         std::wstring m_access_denied_reason;
 385         Queue<ClientEvent> m_client_event_queue;
 386         float m_texture_receive_progress;
 387         bool m_textures_received;
 388         bool m_itemdef_received;
 389         bool m_nodedef_received;
 390         friend class FarMesh;
 391 };
 392
 393 #endif // !SERVER
 394
 395 #endif // !CLIENT_HEADER
 396