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
  31 class ClientNotReadyException : public BaseException
  32 {
  33 public:
  34         ClientNotReadyException(const char *s):
  35                 BaseException(s)
  36         {}
  37 };
  38
  39 class Client;
  40
  41 class ClientUpdateThread : public SimpleThread
  42 {
  43         Client *m_client;
  44
  45 public:
  46
  47         ClientUpdateThread(Client *client):
  48                         SimpleThread(),
  49                         m_client(client)
  50         {
  51         }
  52
  53         void * Thread();
  54 };
  55
  56 struct IncomingPacket
  57 {
  58         IncomingPacket()
  59         {
  60                 m_data = NULL;
  61                 m_datalen = 0;
  62                 m_refcount = NULL;
  63         }
  64         IncomingPacket(const IncomingPacket &a)
  65         {
  66                 m_data = a.m_data;
  67                 m_datalen = a.m_datalen;
  68                 m_refcount = a.m_refcount;
  69                 if(m_refcount != NULL)
  70                         (*m_refcount)++;
  71         }
  72         IncomingPacket(u8 *data, u32 datalen)
  73         {
  74                 m_data = new u8[datalen];
  75                 memcpy(m_data, data, datalen);
  76                 m_datalen = datalen;
  77                 m_refcount = new s32(1);
  78         }
  79         ~IncomingPacket()
  80         {
  81                 if(m_refcount != NULL){
  82                         assert(*m_refcount > 0);
  83                         (*m_refcount)--;
  84                         if(*m_refcount == 0){
  85                                 if(m_data != NULL)
  86                                         delete[] m_data;
  87                                 delete m_refcount;
  88                         }
  89                 }
  90         }
  91         /*IncomingPacket & operator=(IncomingPacket a)
  92         {
  93                 m_data = a.m_data;
  94                 m_datalen = a.m_datalen;
  95                 m_refcount = a.m_refcount;
  96                 (*m_refcount)++;
  97                 return *this;
  98         }*/
  99         u8 *m_data;
 100         u32 m_datalen;
 101         s32 *m_refcount;
 102 };
 103
 104 class Client : public con::PeerHandler
 105 {
 106 public:
 107         /*
 108                 NOTE: Every public method should be thread-safe
 109         */
 110         Client(
 111                         IrrlichtDevice *device,
 112                         const char *playername,
 113                         JMutex &range_mutex,
 114                         float &viewing_range_nodes,
 115                         bool &viewing_range_all
 116                         );
 117
 118         ~Client();
 119         /*
 120                 The name of the local player should already be set when
 121                 calling this, as it is sent in the initialization.
 122         */
 123         void connect(Address address);
 124         /*
 125                 returns true when
 126                         m_con.Connected() == true
 127                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 128                 throws con::PeerNotFoundException if connection has been deleted,
 129                 eg. timed out.
 130         */
 131         bool connectedAndInitialized();
 132         /*
 133                 Stuff that references the environment is valid only as
 134                 long as this is not called. (eg. Players)
 135                 If this throws a PeerNotFoundException, the connection has
 136                 timed out.
 137         */
 138         void step(float dtime);
 139
 140         // Called from updater thread
 141         // Returns dtime
 142         float asyncStep();
 143
 144         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 145         // Returns true if something was received
 146         bool AsyncProcessPacket();
 147         bool AsyncProcessData();
 148         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 149
 150         //TODO: Remove
 151         bool isFetchingBlocks();
 152
 153         // Pops out a packet from the packet queue
 154         IncomingPacket getPacket();
 155
 156         void groundAction(u8 action, v3s16 nodepos_undersurface,
 157                         v3s16 nodepos_oversurface, u16 item);
 158         void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
 159
 160         void sendSignText(v3s16 blockpos, s16 id, std::string text);
 161         void sendInventoryAction(InventoryAction *a);
 162         void sendChatMessage(const std::wstring &message);
 163
 164         // locks envlock
 165         void removeNode(v3s16 p);
 166         // locks envlock
 167         void addNode(v3s16 p, MapNode n);
 168
 169         void updateCamera(v3f pos, v3f dir);
 170
 171         // Returns InvalidPositionException if not found
 172         MapNode getNode(v3s16 p);
 173         // Returns InvalidPositionException if not found
 174         //void setNode(v3s16 p, MapNode n);
 175
 176         // Returns InvalidPositionException if not found
 177         //f32 getGroundHeight(v2s16 p);
 178
 179         v3f getPlayerPosition();
 180
 181         void setPlayerControl(PlayerControl &control);
 182
 183         // Returns true if the inventory of the local player has been
 184         // updated from the server. If it is true, it is set to false.
 185         bool getLocalInventoryUpdated();
 186         // Copies the inventory of the local player to parameter
 187         void getLocalInventory(Inventory &dst);
 188
 189         // Gets closest object pointed by the shootline
 190         // Returns NULL if not found
 191         MapBlockObject * getSelectedObject(
 192                         f32 max_d,
 193                         v3f from_pos_f_on_map,
 194                         core::line3d<f32> shootline_on_map
 195         );
 196
 197         // Prints a line or two of info
 198         void printDebugInfo(std::ostream &os);
 199
 200         //s32 getDayNightIndex();
 201         u32 getDayNightRatio();
 202
 203         //void updateSomeExpiredMeshes();
 204
 205         void setTempMod(v3s16 p, NodeMod mod)
 206         {
 207                 JMutexAutoLock envlock(m_env_mutex);
 208                 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
 209                 v3s16 blockpos = ((ClientMap&)m_env.getMap()).setTempMod(p, mod);
 210                 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
 211         }
 212         void clearTempMod(v3s16 p)
 213         {
 214                 JMutexAutoLock envlock(m_env_mutex);
 215                 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
 216                 v3s16 blockpos = ((ClientMap&)m_env.getMap()).clearTempMod(p);
 217                 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
 218         }
 219
 220         float getAvgRtt()
 221         {
 222                 JMutexAutoLock lock(m_con_mutex);
 223                 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
 224                 if(peer == NULL)
 225                         return 0.0;
 226                 return peer->avg_rtt;
 227         }
 228
 229         bool getChatMessage(std::wstring &message)
 230         {
 231                 if(m_chat_queue.size() == 0)
 232                         return false;
 233                 message = m_chat_queue.pop_front();
 234                 return true;
 235         }
 236
 237         void addChatMessage(const std::wstring &message)
 238         {
 239                 JMutexAutoLock envlock(m_env_mutex);
 240                 LocalPlayer *player = m_env.getLocalPlayer();
 241                 assert(player != NULL);
 242                 std::wstring name = narrow_to_wide(player->getName());
 243                 m_chat_queue.push_back(
 244                                 (std::wstring)L"<"+name+L"> "+message);
 245         }
 246
 247 private:
 248
 249         // Virtual methods from con::PeerHandler
 250         void peerAdded(con::Peer *peer);
 251         void deletingPeer(con::Peer *peer, bool timeout);
 252
 253         void ReceiveAll();
 254         void Receive();
 255
 256         void sendPlayerPos();
 257         // This sends the player's current name etc to the server
 258         void sendPlayerInfo();
 259
 260         float m_packetcounter_timer;
 261         float m_delete_unused_sectors_timer;
 262         float m_connection_reinit_timer;
 263         float m_avg_rtt_timer;
 264         float m_playerpos_send_timer;
 265
 266         ClientUpdateThread m_thread;
 267
 268         // NOTE: If connection and environment are both to be locked,
 269         // environment shall be locked first.
 270
 271         Environment m_env;
 272         JMutex m_env_mutex;
 273
 274         con::Connection m_con;
 275         JMutex m_con_mutex;
 276
 277         /*core::map<v3s16, float> m_fetchblock_history;
 278         JMutex m_fetchblock_mutex;*/
 279
 280         core::list<IncomingPacket> m_incoming_queue;
 281         JMutex m_incoming_queue_mutex;
 282
 283         IrrlichtDevice *m_device;
 284
 285         v3f camera_position;
 286         v3f camera_direction;
 287
 288         // Server serialization version
 289         u8 m_server_ser_ver;
 290
 291         float m_step_dtime;
 292         JMutex m_step_dtime_mutex;
 293
 294         // This is behind m_env_mutex.
 295         bool m_inventory_updated;
 296
 297         core::map<v3s16, bool> m_active_blocks;
 298
 299         PacketCounter m_packetcounter;
 300
 301         // Received from the server. 0-23999
 302         MutexedVariable<u32> m_time_of_day;
 303
 304         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 305         //s32 m_daynight_i;
 306         //u32 m_daynight_ratio;
 307
 308         Queue<std::wstring> m_chat_queue;
 309 };
 310
 311 #endif // !SERVER
 312
 313 #endif // !CLIENT_HEADER
 314