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
  35 struct MeshMakeData;
  36 class IGameDef;
  37 class IWritableTextureSource;
  38 class IWritableToolDefManager;
  39 class IWritableNodeDefManager;
  40 //class IWritableCraftDefManager;
  41 class IWritableCraftItemDefManager;
  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                         IWritableToolDefManager *tooldef,
 170                         IWritableNodeDefManager *nodedef,
 171                         IWritableCraftItemDefManager *craftitemdef
 172         );
 173
 174         ~Client();
 175         /*
 176                 The name of the local player should already be set when
 177                 calling this, as it is sent in the initialization.
 178         */
 179         void connect(Address address);
 180         /*
 181                 returns true when
 182                         m_con.Connected() == true
 183                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 184                 throws con::PeerNotFoundException if connection has been deleted,
 185                 eg. timed out.
 186         */
 187         bool connectedAndInitialized();
 188         /*
 189                 Stuff that references the environment is valid only as
 190                 long as this is not called. (eg. Players)
 191                 If this throws a PeerNotFoundException, the connection has
 192                 timed out.
 193         */
 194         void step(float dtime);
 195
 196         // Called from updater thread
 197         // Returns dtime
 198         //float asyncStep();
 199
 200         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 201         // Returns true if something was received
 202         bool AsyncProcessPacket();
 203         bool AsyncProcessData();
 204         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 205
 206         // Pops out a packet from the packet queue
 207         //IncomingPacket getPacket();
 208
 209         void interact(u8 action, const PointedThing& pointed);
 210
 211         void sendSignNodeText(v3s16 p, std::string text);
 212         void sendInventoryAction(InventoryAction *a);
 213         void sendChatMessage(const std::wstring &message);
 214         void sendChangePassword(const std::wstring oldpassword,
 215                 const std::wstring newpassword);
 216         void sendDamage(u8 damage);
 217         void sendRespawn();
 218
 219         // locks envlock
 220         void removeNode(v3s16 p);
 221         // locks envlock
 222         void addNode(v3s16 p, MapNode n);
 223
 224         void updateCamera(v3f pos, v3f dir, f32 fov);
 225
 226         void renderPostFx();
 227
 228         // Returns InvalidPositionException if not found
 229         MapNode getNode(v3s16 p);
 230         // Wrapper to Map
 231         NodeMetadata* getNodeMetadata(v3s16 p);
 232
 233         LocalPlayer* getLocalPlayer();
 234
 235         void setPlayerControl(PlayerControl &control);
 236
 237         void selectPlayerItem(u16 item);
 238         u16 getPlayerItem() const
 239         { return m_playeritem; }
 240
 241         // Returns true if the inventory of the local player has been
 242         // updated from the server. If it is true, it is set to false.
 243         bool getLocalInventoryUpdated();
 244         // Copies the inventory of the local player to parameter
 245         void getLocalInventory(Inventory &dst);
 246
 247         InventoryContext *getInventoryContext();
 248
 249         /* InventoryManager interface */
 250         Inventory* getInventory(const InventoryLocation &loc);
 251         //Inventory* getInventory(InventoryContext *c, std::string id);
 252         void inventoryAction(InventoryAction *a);
 253
 254         // Gets closest object pointed by the shootline
 255         // Returns NULL if not found
 256         ClientActiveObject * getSelectedActiveObject(
 257                         f32 max_d,
 258                         v3f from_pos_f_on_map,
 259                         core::line3d<f32> shootline_on_map
 260         );
 261
 262         // Prints a line or two of info
 263         void printDebugInfo(std::ostream &os);
 264
 265         u32 getDayNightRatio();
 266
 267         u16 getHP();
 268
 269         void setTempMod(v3s16 p, NodeMod mod);
 270         void clearTempMod(v3s16 p);
 271
 272         float getAvgRtt()
 273         {
 274                 try{
 275                         return m_con.GetPeerAvgRTT(PEER_ID_SERVER);
 276                 } catch(con::PeerNotFoundException){
 277                         return 1337;
 278                 }
 279         }
 280
 281         bool getChatMessage(std::wstring &message)
 282         {
 283                 if(m_chat_queue.size() == 0)
 284                         return false;
 285                 message = m_chat_queue.pop_front();
 286                 return true;
 287         }
 288
 289         void addChatMessage(const std::wstring &message)
 290         {
 291                 if (message[0] == L'/') {
 292                         m_chat_queue.push_back(
 293                                 (std::wstring)L"issued command: "+message);
 294                         return;
 295                 }
 296
 297                 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
 298                 LocalPlayer *player = m_env.getLocalPlayer();
 299                 assert(player != NULL);
 300                 std::wstring name = narrow_to_wide(player->getName());
 301                 m_chat_queue.push_back(
 302                                 (std::wstring)L"<"+name+L"> "+message);
 303         }
 304
 305         u64 getMapSeed(){ return m_map_seed; }
 306
 307         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
 308         // Including blocks at appropriate edges
 309         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
 310
 311         // Get event from queue. CE_NONE is returned if queue is empty.
 312         ClientEvent getClientEvent();
 313
 314         bool accessDenied()
 315         { return m_access_denied; }
 316
 317         std::wstring accessDeniedReason()
 318         { return m_access_denied_reason; }
 319
 320         float textureReceiveProgress()
 321         { return m_texture_receive_progress; }
 322
 323         bool texturesReceived()
 324         { return m_textures_received; }
 325         bool tooldefReceived()
 326         { return m_tooldef_received; }
 327         bool nodedefReceived()
 328         { return m_nodedef_received; }
 329         bool craftitemdefReceived()
 330         { return m_craftitemdef_received; }
 331
 332         float getRTT(void);
 333
 334         // IGameDef interface
 335         virtual IToolDefManager* getToolDefManager();
 336         virtual INodeDefManager* getNodeDefManager();
 337         virtual ICraftDefManager* getCraftDefManager();
 338         virtual ICraftItemDefManager* getCraftItemDefManager();
 339         virtual ITextureSource* getTextureSource();
 340         virtual u16 allocateUnknownNodeId(const std::string &name);
 341
 342 private:
 343
 344         // Virtual methods from con::PeerHandler
 345         void peerAdded(con::Peer *peer);
 346         void deletingPeer(con::Peer *peer, bool timeout);
 347
 348         void ReceiveAll();
 349         void Receive();
 350
 351         void sendPlayerPos();
 352         // This sends the player's current name etc to the server
 353         void sendPlayerInfo();
 354         // Send the item number 'item' as player item to the server
 355         void sendPlayerItem(u16 item);
 356
 357         float m_packetcounter_timer;
 358         float m_connection_reinit_timer;
 359         float m_avg_rtt_timer;
 360         float m_playerpos_send_timer;
 361         float m_ignore_damage_timer; // Used after server moves player
 362         IntervalLimiter m_map_timer_and_unload_interval;
 363
 364         IWritableTextureSource *m_tsrc;
 365         IWritableToolDefManager *m_tooldef;
 366         IWritableNodeDefManager *m_nodedef;
 367         IWritableCraftItemDefManager *m_craftitemdef;
 368         MeshUpdateThread m_mesh_update_thread;
 369         ClientEnvironment m_env;
 370         con::Connection m_con;
 371         IrrlichtDevice *m_device;
 372         // Server serialization version
 373         u8 m_server_ser_ver;
 374         u16 m_playeritem;
 375         bool m_inventory_updated;
 376         core::map<v3s16, bool> m_active_blocks;
 377         PacketCounter m_packetcounter;
 378         // Received from the server. 0-23999
 379         u32 m_time_of_day;
 380         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 381         //s32 m_daynight_i;
 382         //u32 m_daynight_ratio;
 383         Queue<std::wstring> m_chat_queue;
 384         // The seed returned by the server in TOCLIENT_INIT is stored here
 385         u64 m_map_seed;
 386         std::string m_password;
 387         bool m_access_denied;
 388         std::wstring m_access_denied_reason;
 389         InventoryContext m_inventory_context;
 390         Queue<ClientEvent> m_client_event_queue;
 391         float m_texture_receive_progress;
 392         bool m_textures_received;
 393         bool m_tooldef_received;
 394         bool m_nodedef_received;
 395         bool m_craftitemdef_received;
 396         friend class FarMesh;
 397 };
 398
 399 #endif // !SERVER
 400
 401 #endif // !CLIENT_HEADER
 402