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
  33 struct MeshMakeData;
  34
  35 class ClientNotReadyException : public BaseException
  36 {
  37 public:
  38         ClientNotReadyException(const char *s):
  39                 BaseException(s)
  40         {}
  41 };
  42
  43 struct QueuedMeshUpdate
  44 {
  45         v3s16 p;
  46         MeshMakeData *data;
  47         bool ack_block_to_server;
  48
  49         QueuedMeshUpdate();
  50         ~QueuedMeshUpdate();
  51 };
  52
  53 /*
  54         A thread-safe queue of mesh update tasks
  55 */
  56 class MeshUpdateQueue
  57 {
  58 public:
  59         MeshUpdateQueue();
  60
  61         ~MeshUpdateQueue();
  62
  63         /*
  64                 peer_id=0 adds with nobody to send to
  65         */
  66         void addBlock(v3s16 p, MeshMakeData *data, bool ack_block_to_server);
  67
  68         // Returned pointer must be deleted
  69         // Returns NULL if queue is empty
  70         QueuedMeshUpdate * pop();
  71
  72         u32 size()
  73         {
  74                 JMutexAutoLock lock(m_mutex);
  75                 return m_queue.size();
  76         }
  77
  78 private:
  79         core::list<QueuedMeshUpdate*> m_queue;
  80         JMutex m_mutex;
  81 };
  82
  83 struct MeshUpdateResult
  84 {
  85         v3s16 p;
  86         scene::SMesh *mesh;
  87         bool ack_block_to_server;
  88
  89         MeshUpdateResult():
  90                 p(-1338,-1338,-1338),
  91                 mesh(NULL),
  92                 ack_block_to_server(false)
  93         {
  94         }
  95 };
  96
  97 class MeshUpdateThread : public SimpleThread
  98 {
  99 public:
 100
 101         MeshUpdateThread()
 102         {
 103         }
 104
 105         void * Thread();
 106
 107         MeshUpdateQueue m_queue_in;
 108
 109         MutexedQueue<MeshUpdateResult> m_queue_out;
 110 };
 111
 112 enum ClientEventType
 113 {
 114         CE_NONE,
 115         CE_PLAYER_DAMAGE,
 116         CE_PLAYER_FORCE_MOVE
 117 };
 118
 119 struct ClientEvent
 120 {
 121         ClientEventType type;
 122         union{
 123                 struct{
 124                 } none;
 125                 struct{
 126                         u8 amount;
 127                 } player_damage;
 128                 struct{
 129                         f32 pitch;
 130                         f32 yaw;
 131                 } player_force_move;
 132         };
 133 };
 134
 135 class Client : public con::PeerHandler, public InventoryManager
 136 {
 137 public:
 138         /*
 139                 NOTE: Nothing is thread-safe here.
 140         */
 141
 142         Client(
 143                         IrrlichtDevice *device,
 144                         const char *playername,
 145                         std::string password,
 146                         MapDrawControl &control
 147                         );
 148
 149         ~Client();
 150         /*
 151                 The name of the local player should already be set when
 152                 calling this, as it is sent in the initialization.
 153         */
 154         void connect(Address address);
 155         /*
 156                 returns true when
 157                         m_con.Connected() == true
 158                         AND m_server_ser_ver != SER_FMT_VER_INVALID
 159                 throws con::PeerNotFoundException if connection has been deleted,
 160                 eg. timed out.
 161         */
 162         bool connectedAndInitialized();
 163         /*
 164                 Stuff that references the environment is valid only as
 165                 long as this is not called. (eg. Players)
 166                 If this throws a PeerNotFoundException, the connection has
 167                 timed out.
 168         */
 169         void step(float dtime);
 170
 171         // Called from updater thread
 172         // Returns dtime
 173         //float asyncStep();
 174
 175         void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
 176         // Returns true if something was received
 177         bool AsyncProcessPacket();
 178         bool AsyncProcessData();
 179         void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
 180
 181         // Pops out a packet from the packet queue
 182         //IncomingPacket getPacket();
 183
 184         void groundAction(u8 action, v3s16 nodepos_undersurface,
 185                         v3s16 nodepos_oversurface, u16 item);
 186         void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
 187         void clickActiveObject(u8 button, u16 id, u16 item);
 188
 189         void sendSignText(v3s16 blockpos, s16 id, std::string text);
 190         void sendSignNodeText(v3s16 p, std::string text);
 191         void sendInventoryAction(InventoryAction *a);
 192         void sendChatMessage(const std::wstring &message);
 193         void sendChangePassword(const std::wstring oldpassword,
 194                 const std::wstring newpassword);
 195         void sendDamage(u8 damage);
 196
 197         // locks envlock
 198         void removeNode(v3s16 p);
 199         // locks envlock
 200         void addNode(v3s16 p, MapNode n);
 201
 202         void updateCamera(v3f pos, v3f dir);
 203
 204         // Returns InvalidPositionException if not found
 205         MapNode getNode(v3s16 p);
 206         // Wrapper to Map
 207         NodeMetadata* getNodeMetadata(v3s16 p);
 208
 209         v3f getPlayerPosition();
 210
 211         void setPlayerControl(PlayerControl &control);
 212
 213         // Returns true if the inventory of the local player has been
 214         // updated from the server. If it is true, it is set to false.
 215         bool getLocalInventoryUpdated();
 216         // Copies the inventory of the local player to parameter
 217         void getLocalInventory(Inventory &dst);
 218
 219         InventoryContext *getInventoryContext();
 220
 221         Inventory* getInventory(InventoryContext *c, std::string id);
 222         void inventoryAction(InventoryAction *a);
 223
 224         // Gets closest object pointed by the shootline
 225         // Returns NULL if not found
 226         MapBlockObject * getSelectedObject(
 227                         f32 max_d,
 228                         v3f from_pos_f_on_map,
 229                         core::line3d<f32> shootline_on_map
 230         );
 231
 232         // Gets closest object pointed by the shootline
 233         // Returns NULL if not found
 234         ClientActiveObject * getSelectedActiveObject(
 235                         f32 max_d,
 236                         v3f from_pos_f_on_map,
 237                         core::line3d<f32> shootline_on_map
 238         );
 239
 240         // Prints a line or two of info
 241         void printDebugInfo(std::ostream &os);
 242
 243         u32 getDayNightRatio();
 244
 245         u16 getHP();
 246
 247         void setTempMod(v3s16 p, NodeMod mod);
 248         void clearTempMod(v3s16 p);
 249
 250         float getAvgRtt()
 251         {
 252                 //JMutexAutoLock lock(m_con_mutex); //bulk comment-out
 253                 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
 254                 if(peer == NULL)
 255                         return 0.0;
 256                 return peer->avg_rtt;
 257         }
 258
 259         bool getChatMessage(std::wstring &message)
 260         {
 261                 if(m_chat_queue.size() == 0)
 262                         return false;
 263                 message = m_chat_queue.pop_front();
 264                 return true;
 265         }
 266
 267         void addChatMessage(const std::wstring &message)
 268         {
 269                 //JMutexAutoLock envlock(m_env_mutex); //bulk comment-out
 270                 LocalPlayer *player = m_env.getLocalPlayer();
 271                 assert(player != NULL);
 272                 std::wstring name = narrow_to_wide(player->getName());
 273                 m_chat_queue.push_back(
 274                                 (std::wstring)L"<"+name+L"> "+message);
 275         }
 276
 277         u64 getMapSeed(){ return m_map_seed; }
 278
 279         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false);
 280         // Including blocks at appropriate edges
 281         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false);
 282
 283         // Get event from queue. CE_NONE is returned if queue is empty.
 284         ClientEvent getClientEvent();
 285
 286         inline bool accessDenied()
 287         {
 288                 return m_access_denied;
 289         }
 290
 291         inline std::wstring accessDeniedReason()
 292         {
 293                 return m_access_denied_reason;
 294         }
 295
 296         /*
 297                 This should only be used for calling the special drawing stuff in
 298                 ClientEnvironment
 299         */
 300         ClientEnvironment * getEnv()
 301         {
 302                 return &m_env;
 303         }
 304
 305 private:
 306
 307         // Virtual methods from con::PeerHandler
 308         void peerAdded(con::Peer *peer);
 309         void deletingPeer(con::Peer *peer, bool timeout);
 310
 311         void ReceiveAll();
 312         void Receive();
 313
 314         void sendPlayerPos();
 315         // This sends the player's current name etc to the server
 316         void sendPlayerInfo();
 317
 318         float m_packetcounter_timer;
 319         float m_connection_reinit_timer;
 320         float m_avg_rtt_timer;
 321         float m_playerpos_send_timer;
 322         float m_ignore_damage_timer; // Used after server moves player
 323         IntervalLimiter m_map_timer_and_unload_interval;
 324
 325         MeshUpdateThread m_mesh_update_thread;
 326
 327         ClientEnvironment m_env;
 328
 329         con::Connection m_con;
 330
 331         IrrlichtDevice *m_device;
 332
 333         v3f camera_position;
 334         v3f camera_direction;
 335
 336         // Server serialization version
 337         u8 m_server_ser_ver;
 338
 339         // This is behind m_env_mutex.
 340         bool m_inventory_updated;
 341
 342         core::map<v3s16, bool> m_active_blocks;
 343
 344         PacketCounter m_packetcounter;
 345
 346         // Received from the server. 0-23999
 347         u32 m_time_of_day;
 348
 349         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
 350         //s32 m_daynight_i;
 351         //u32 m_daynight_ratio;
 352
 353         Queue<std::wstring> m_chat_queue;
 354
 355         // The seed returned by the server in TOCLIENT_INIT is stored here
 356         u64 m_map_seed;
 357
 358         std::string m_password;
 359         bool m_access_denied;
 360         std::wstring m_access_denied_reason;
 361
 362         InventoryContext m_inventory_context;
 363
 364         Queue<ClientEvent> m_client_event_queue;
 365
 366         friend class FarMesh;
 367 };
 368
 369 #endif // !SERVER
 370
 371 #endif // !CLIENT_HEADER
 372