]> git.lizzy.rs Git - minetest.git/blob - src/client.h
9b7130268be5c78102d682d118a4139b6fa95c1d
[minetest.git] / src / client.h
1 /*
2 Minetest
3 Copyright (C) 2013 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 "network/connection.h"
24 #include "clientenvironment.h"
25 #include "irrlichttypes_extrabloated.h"
26 #include "threading/mutex.h"
27 #include <ostream>
28 #include <map>
29 #include <set>
30 #include <vector>
31 #include "clientobject.h"
32 #include "gamedef.h"
33 #include "inventorymanager.h"
34 #include "localplayer.h"
35 #include "hud.h"
36 #include "particles.h"
37 #include "mapnode.h"
38 #include "tileanimation.h"
39
40 struct MeshMakeData;
41 class MapBlockMesh;
42 class IWritableTextureSource;
43 class IWritableShaderSource;
44 class IWritableItemDefManager;
45 class IWritableNodeDefManager;
46 //class IWritableCraftDefManager;
47 class ClientMediaDownloader;
48 struct MapDrawControl;
49 class MtEventManager;
50 struct PointedThing;
51 class Database;
52 class Mapper;
53 struct MinimapMapblock;
54 class Camera;
55 class NetworkPacket;
56
57 struct QueuedMeshUpdate
58 {
59         v3s16 p;
60         MeshMakeData *data;
61         bool ack_block_to_server;
62
63         QueuedMeshUpdate();
64         ~QueuedMeshUpdate();
65 };
66
67 enum LocalClientState {
68         LC_Created,
69         LC_Init,
70         LC_Ready
71 };
72
73 /*
74         A thread-safe queue of mesh update tasks
75 */
76 class MeshUpdateQueue
77 {
78 public:
79         MeshUpdateQueue();
80
81         ~MeshUpdateQueue();
82
83         /*
84                 peer_id=0 adds with nobody to send to
85         */
86         void addBlock(v3s16 p, MeshMakeData *data,
87                         bool ack_block_to_server, bool urgent);
88
89         // Returned pointer must be deleted
90         // Returns NULL if queue is empty
91         QueuedMeshUpdate * pop();
92
93         u32 size()
94         {
95                 MutexAutoLock lock(m_mutex);
96                 return m_queue.size();
97         }
98
99 private:
100         std::vector<QueuedMeshUpdate*> m_queue;
101         std::set<v3s16> m_urgents;
102         Mutex m_mutex;
103 };
104
105 struct MeshUpdateResult
106 {
107         v3s16 p;
108         MapBlockMesh *mesh;
109         bool ack_block_to_server;
110
111         MeshUpdateResult():
112                 p(-1338,-1338,-1338),
113                 mesh(NULL),
114                 ack_block_to_server(false)
115         {
116         }
117 };
118
119 class MeshUpdateThread : public UpdateThread
120 {
121 private:
122         MeshUpdateQueue m_queue_in;
123
124 protected:
125         virtual void doUpdate();
126
127 public:
128
129         MeshUpdateThread() : UpdateThread("Mesh") {}
130
131         void enqueueUpdate(v3s16 p, MeshMakeData *data,
132                         bool ack_block_to_server, bool urgent);
133         MutexedQueue<MeshUpdateResult> m_queue_out;
134
135         v3s16 m_camera_offset;
136 };
137
138 enum ClientEventType
139 {
140         CE_NONE,
141         CE_PLAYER_DAMAGE,
142         CE_PLAYER_FORCE_MOVE,
143         CE_DEATHSCREEN,
144         CE_SHOW_FORMSPEC,
145         CE_SHOW_LOCAL_FORMSPEC,
146         CE_SPAWN_PARTICLE,
147         CE_ADD_PARTICLESPAWNER,
148         CE_DELETE_PARTICLESPAWNER,
149         CE_HUDADD,
150         CE_HUDRM,
151         CE_HUDCHANGE,
152         CE_SET_SKY,
153         CE_OVERRIDE_DAY_NIGHT_RATIO,
154 };
155
156 struct ClientEvent
157 {
158         ClientEventType type;
159         union{
160                 //struct{
161                 //} none;
162                 struct{
163                         u8 amount;
164                 } player_damage;
165                 struct{
166                         f32 pitch;
167                         f32 yaw;
168                 } player_force_move;
169                 struct{
170                         bool set_camera_point_target;
171                         f32 camera_point_target_x;
172                         f32 camera_point_target_y;
173                         f32 camera_point_target_z;
174                 } deathscreen;
175                 struct{
176                         std::string *formspec;
177                         std::string *formname;
178                 } show_formspec;
179                 //struct{
180                 //} textures_updated;
181                 struct{
182                         v3f *pos;
183                         v3f *vel;
184                         v3f *acc;
185                         f32 expirationtime;
186                         f32 size;
187                         bool collisiondetection;
188                         bool collision_removal;
189                         bool vertical;
190                         std::string *texture;
191                         struct TileAnimationParams animation;
192                         u8 glow;
193                 } spawn_particle;
194                 struct{
195                         u16 amount;
196                         f32 spawntime;
197                         v3f *minpos;
198                         v3f *maxpos;
199                         v3f *minvel;
200                         v3f *maxvel;
201                         v3f *minacc;
202                         v3f *maxacc;
203                         f32 minexptime;
204                         f32 maxexptime;
205                         f32 minsize;
206                         f32 maxsize;
207                         bool collisiondetection;
208                         bool collision_removal;
209                         u16 attached_id;
210                         bool vertical;
211                         std::string *texture;
212                         u32 id;
213                         struct TileAnimationParams animation;
214                         u8 glow;
215                 } add_particlespawner;
216                 struct{
217                         u32 id;
218                 } delete_particlespawner;
219                 struct{
220                         u32 id;
221                         u8 type;
222                         v2f *pos;
223                         std::string *name;
224                         v2f *scale;
225                         std::string *text;
226                         u32 number;
227                         u32 item;
228                         u32 dir;
229                         v2f *align;
230                         v2f *offset;
231                         v3f *world_pos;
232                         v2s32 * size;
233                 } hudadd;
234                 struct{
235                         u32 id;
236                 } hudrm;
237                 struct{
238                         u32 id;
239                         HudElementStat stat;
240                         v2f *v2fdata;
241                         std::string *sdata;
242                         u32 data;
243                         v3f *v3fdata;
244                         v2s32 * v2s32data;
245                 } hudchange;
246                 struct{
247                         video::SColor *bgcolor;
248                         std::string *type;
249                         std::vector<std::string> *params;
250                 } set_sky;
251                 struct{
252                         bool do_override;
253                         float ratio_f;
254                 } override_day_night_ratio;
255         };
256 };
257
258 /*
259         Packet counter
260 */
261
262 class PacketCounter
263 {
264 public:
265         PacketCounter()
266         {
267         }
268
269         void add(u16 command)
270         {
271                 std::map<u16, u16>::iterator n = m_packets.find(command);
272                 if(n == m_packets.end())
273                 {
274                         m_packets[command] = 1;
275                 }
276                 else
277                 {
278                         n->second++;
279                 }
280         }
281
282         void clear()
283         {
284                 for(std::map<u16, u16>::iterator
285                                 i = m_packets.begin();
286                                 i != m_packets.end(); ++i)
287                 {
288                         i->second = 0;
289                 }
290         }
291
292         void print(std::ostream &o)
293         {
294                 for(std::map<u16, u16>::iterator
295                                 i = m_packets.begin();
296                                 i != m_packets.end(); ++i)
297                 {
298                         o<<"cmd "<<i->first
299                                         <<" count "<<i->second
300                                         <<std::endl;
301                 }
302         }
303
304 private:
305         // command, count
306         std::map<u16, u16> m_packets;
307 };
308
309 class ClientScripting;
310
311 class Client : public con::PeerHandler, public InventoryManager, public IGameDef
312 {
313 public:
314         /*
315                 NOTE: Nothing is thread-safe here.
316         */
317
318         Client(
319                         IrrlichtDevice *device,
320                         const char *playername,
321                         std::string password,
322                         MapDrawControl &control,
323                         IWritableTextureSource *tsrc,
324                         IWritableShaderSource *shsrc,
325                         IWritableItemDefManager *itemdef,
326                         IWritableNodeDefManager *nodedef,
327                         ISoundManager *sound,
328                         MtEventManager *event,
329                         bool ipv6
330         );
331
332         ~Client();
333
334         void initMods();
335
336         /*
337          request all threads managed by client to be stopped
338          */
339         void Stop();
340
341
342         bool isShutdown();
343
344         /*
345                 The name of the local player should already be set when
346                 calling this, as it is sent in the initialization.
347         */
348         void connect(Address address,
349                         const std::string &address_name,
350                         bool is_local_server);
351
352         /*
353                 Stuff that references the environment is valid only as
354                 long as this is not called. (eg. Players)
355                 If this throws a PeerNotFoundException, the connection has
356                 timed out.
357         */
358         void step(float dtime);
359
360         /*
361          * Command Handlers
362          */
363
364         void handleCommand(NetworkPacket* pkt);
365
366         void handleCommand_Null(NetworkPacket* pkt) {};
367         void handleCommand_Deprecated(NetworkPacket* pkt);
368         void handleCommand_Hello(NetworkPacket* pkt);
369         void handleCommand_AuthAccept(NetworkPacket* pkt);
370         void handleCommand_AcceptSudoMode(NetworkPacket* pkt);
371         void handleCommand_DenySudoMode(NetworkPacket* pkt);
372         void handleCommand_InitLegacy(NetworkPacket* pkt);
373         void handleCommand_AccessDenied(NetworkPacket* pkt);
374         void handleCommand_RemoveNode(NetworkPacket* pkt);
375         void handleCommand_AddNode(NetworkPacket* pkt);
376         void handleCommand_BlockData(NetworkPacket* pkt);
377         void handleCommand_Inventory(NetworkPacket* pkt);
378         void handleCommand_TimeOfDay(NetworkPacket* pkt);
379         void handleCommand_ChatMessage(NetworkPacket* pkt);
380         void handleCommand_ActiveObjectRemoveAdd(NetworkPacket* pkt);
381         void handleCommand_ActiveObjectMessages(NetworkPacket* pkt);
382         void handleCommand_Movement(NetworkPacket* pkt);
383         void handleCommand_HP(NetworkPacket* pkt);
384         void handleCommand_Breath(NetworkPacket* pkt);
385         void handleCommand_MovePlayer(NetworkPacket* pkt);
386         void handleCommand_PlayerItem(NetworkPacket* pkt);
387         void handleCommand_DeathScreen(NetworkPacket* pkt);
388         void handleCommand_AnnounceMedia(NetworkPacket* pkt);
389         void handleCommand_Media(NetworkPacket* pkt);
390         void handleCommand_ToolDef(NetworkPacket* pkt);
391         void handleCommand_NodeDef(NetworkPacket* pkt);
392         void handleCommand_CraftItemDef(NetworkPacket* pkt);
393         void handleCommand_ItemDef(NetworkPacket* pkt);
394         void handleCommand_PlaySound(NetworkPacket* pkt);
395         void handleCommand_StopSound(NetworkPacket* pkt);
396         void handleCommand_Privileges(NetworkPacket* pkt);
397         void handleCommand_InventoryFormSpec(NetworkPacket* pkt);
398         void handleCommand_DetachedInventory(NetworkPacket* pkt);
399         void handleCommand_ShowFormSpec(NetworkPacket* pkt);
400         void handleCommand_SpawnParticle(NetworkPacket* pkt);
401         void handleCommand_AddParticleSpawner(NetworkPacket* pkt);
402         void handleCommand_DeleteParticleSpawner(NetworkPacket* pkt);
403         void handleCommand_HudAdd(NetworkPacket* pkt);
404         void handleCommand_HudRemove(NetworkPacket* pkt);
405         void handleCommand_HudChange(NetworkPacket* pkt);
406         void handleCommand_HudSetFlags(NetworkPacket* pkt);
407         void handleCommand_HudSetParam(NetworkPacket* pkt);
408         void handleCommand_HudSetSky(NetworkPacket* pkt);
409         void handleCommand_OverrideDayNightRatio(NetworkPacket* pkt);
410         void handleCommand_LocalPlayerAnimations(NetworkPacket* pkt);
411         void handleCommand_EyeOffset(NetworkPacket* pkt);
412         void handleCommand_SrpBytesSandB(NetworkPacket* pkt);
413
414         void ProcessData(NetworkPacket *pkt);
415
416         void Send(NetworkPacket* pkt);
417
418         void interact(u8 action, const PointedThing& pointed);
419
420         void sendNodemetaFields(v3s16 p, const std::string &formname,
421                 const StringMap &fields);
422         void sendInventoryFields(const std::string &formname,
423                 const StringMap &fields);
424         void sendInventoryAction(InventoryAction *a);
425         void sendChatMessage(const std::wstring &message);
426         void sendChangePassword(const std::string &oldpassword,
427                 const std::string &newpassword);
428         void sendDamage(u8 damage);
429         void sendBreath(u16 breath);
430         void sendRespawn();
431         void sendReady();
432
433         ClientEnvironment& getEnv() { return m_env; }
434         ITextureSource *tsrc() { return getTextureSource(); }
435         ISoundManager *sound() { return getSoundManager(); }
436         static const std::string &getBuiltinLuaPath();
437         static const std::string &getClientModsLuaPath();
438
439         virtual const std::vector<ModSpec> &getMods() const;
440         virtual const ModSpec* getModSpec(const std::string &modname) const;
441
442         // Causes urgent mesh updates (unlike Map::add/removeNodeWithEvent)
443         void removeNode(v3s16 p);
444         void addNode(v3s16 p, MapNode n, bool remove_metadata = true);
445
446         void setPlayerControl(PlayerControl &control);
447
448         void selectPlayerItem(u16 item);
449         u16 getPlayerItem() const
450         { return m_playeritem; }
451
452         // Returns true if the inventory of the local player has been
453         // updated from the server. If it is true, it is set to false.
454         bool getLocalInventoryUpdated();
455         // Copies the inventory of the local player to parameter
456         void getLocalInventory(Inventory &dst);
457
458         /* InventoryManager interface */
459         Inventory* getInventory(const InventoryLocation &loc);
460         void inventoryAction(InventoryAction *a);
461
462         const std::list<std::string> &getConnectedPlayerNames()
463         {
464                 return m_env.getPlayerNames();
465         }
466
467         float getAnimationTime();
468
469         int getCrackLevel();
470         void setCrack(int level, v3s16 pos);
471
472         u16 getHP();
473
474         bool checkPrivilege(const std::string &priv) const
475         { return (m_privileges.count(priv) != 0); }
476
477         bool getChatMessage(std::wstring &message);
478         void typeChatMessage(const std::wstring& message);
479
480         u64 getMapSeed(){ return m_map_seed; }
481
482         void addUpdateMeshTask(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
483         // Including blocks at appropriate edges
484         void addUpdateMeshTaskWithEdge(v3s16 blockpos, bool ack_to_server=false, bool urgent=false);
485         void addUpdateMeshTaskForNode(v3s16 nodepos, bool ack_to_server=false, bool urgent=false);
486
487         void updateCameraOffset(v3s16 camera_offset)
488         { m_mesh_update_thread.m_camera_offset = camera_offset; }
489
490         // Get event from queue. CE_NONE is returned if queue is empty.
491         ClientEvent getClientEvent();
492
493         bool accessDenied() const { return m_access_denied; }
494
495         bool reconnectRequested() const { return m_access_denied_reconnect; }
496
497         void setFatalError(const std::string &reason)
498         {
499                 m_access_denied = true;
500                 m_access_denied_reason = reason;
501         }
502
503         // Renaming accessDeniedReason to better name could be good as it's used to
504         // disconnect client when CSM failed.
505         const std::string &accessDeniedReason() const { return m_access_denied_reason; }
506
507         bool itemdefReceived()
508         { return m_itemdef_received; }
509         bool nodedefReceived()
510         { return m_nodedef_received; }
511         bool mediaReceived()
512         { return m_media_downloader == NULL; }
513
514         u8 getProtoVersion()
515         { return m_proto_ver; }
516
517         bool connectedToServer()
518         { return m_con.Connected(); }
519
520         float mediaReceiveProgress();
521
522         void afterContentReceived(IrrlichtDevice *device);
523
524         float getRTT(void);
525         float getCurRate(void);
526         float getAvgRate(void);
527
528         Mapper* getMapper ()
529         { return m_mapper; }
530
531         void setCamera(Camera* camera)
532         { m_camera = camera; }
533
534         Camera* getCamera ()
535         { return m_camera; }
536
537         bool isMinimapDisabledByServer()
538         { return m_minimap_disabled_by_server; }
539
540         // IGameDef interface
541         virtual IItemDefManager* getItemDefManager();
542         virtual INodeDefManager* getNodeDefManager();
543         virtual ICraftDefManager* getCraftDefManager();
544         ITextureSource* getTextureSource();
545         virtual IShaderSource* getShaderSource();
546         IShaderSource *shsrc() { return getShaderSource(); }
547         scene::ISceneManager* getSceneManager();
548         virtual u16 allocateUnknownNodeId(const std::string &name);
549         virtual ISoundManager* getSoundManager();
550         virtual MtEventManager* getEventManager();
551         virtual ParticleManager* getParticleManager();
552         bool checkLocalPrivilege(const std::string &priv)
553         { return checkPrivilege(priv); }
554         virtual scene::IAnimatedMesh* getMesh(const std::string &filename);
555
556         // The following set of functions is used by ClientMediaDownloader
557         // Insert a media file appropriately into the appropriate manager
558         bool loadMedia(const std::string &data, const std::string &filename);
559         // Send a request for conventional media transfer
560         void request_media(const std::vector<std::string> &file_requests);
561         // Send a notification that no conventional media transfer is needed
562         void received_media();
563
564         LocalClientState getState() { return m_state; }
565
566         void makeScreenshot(IrrlichtDevice *device);
567
568         inline void pushToChatQueue(const std::wstring &input)
569         {
570                 m_chat_queue.push(input);
571         }
572
573         ClientScripting *getScript() { return m_script; }
574
575         inline void pushToEventQueue(const ClientEvent &event)
576         {
577                 m_client_event_queue.push(event);
578         }
579
580 private:
581
582         // Virtual methods from con::PeerHandler
583         void peerAdded(con::Peer *peer);
584         void deletingPeer(con::Peer *peer, bool timeout);
585
586         void initLocalMapSaving(const Address &address,
587                         const std::string &hostname,
588                         bool is_local_server);
589
590         void ReceiveAll();
591         void Receive();
592
593         void sendPlayerPos();
594         // Send the item number 'item' as player item to the server
595         void sendPlayerItem(u16 item);
596
597         void deleteAuthData();
598         // helper method shared with clientpackethandler
599         static AuthMechanism choseAuthMech(const u32 mechs);
600
601         void sendLegacyInit(const char* playerName, const char* playerPassword);
602         void sendInit(const std::string &playerName);
603         void startAuth(AuthMechanism chosen_auth_mechanism);
604         void sendDeletedBlocks(std::vector<v3s16> &blocks);
605         void sendGotBlocks(v3s16 block);
606         void sendRemovedSounds(std::vector<s32> &soundList);
607
608         // Helper function
609         inline std::string getPlayerName()
610         { return m_env.getLocalPlayer()->getName(); }
611
612         float m_packetcounter_timer;
613         float m_connection_reinit_timer;
614         float m_avg_rtt_timer;
615         float m_playerpos_send_timer;
616         float m_ignore_damage_timer; // Used after server moves player
617         IntervalLimiter m_map_timer_and_unload_interval;
618
619         IWritableTextureSource *m_tsrc;
620         IWritableShaderSource *m_shsrc;
621         IWritableItemDefManager *m_itemdef;
622         IWritableNodeDefManager *m_nodedef;
623         ISoundManager *m_sound;
624         MtEventManager *m_event;
625
626
627         MeshUpdateThread m_mesh_update_thread;
628         ClientEnvironment m_env;
629         ParticleManager m_particle_manager;
630         con::Connection m_con;
631         IrrlichtDevice *m_device;
632         Camera *m_camera;
633         Mapper *m_mapper;
634         bool m_minimap_disabled_by_server;
635         // Server serialization version
636         u8 m_server_ser_ver;
637
638         // Used version of the protocol with server
639         // Values smaller than 25 only mean they are smaller than 25,
640         // and aren't accurate. We simply just don't know, because
641         // the server didn't send the version back then.
642         // If 0, server init hasn't been received yet.
643         u8 m_proto_ver;
644
645         u16 m_playeritem;
646         bool m_inventory_updated;
647         Inventory *m_inventory_from_server;
648         float m_inventory_from_server_age;
649         PacketCounter m_packetcounter;
650         // Block mesh animation parameters
651         float m_animation_time;
652         int m_crack_level;
653         v3s16 m_crack_pos;
654         // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
655         //s32 m_daynight_i;
656         //u32 m_daynight_ratio;
657         std::queue<std::wstring> m_chat_queue;
658
659         // The authentication methods we can use to enter sudo mode (=change password)
660         u32 m_sudo_auth_methods;
661
662         // The seed returned by the server in TOCLIENT_INIT is stored here
663         u64 m_map_seed;
664
665         // Auth data
666         std::string m_playername;
667         std::string m_password;
668         // If set, this will be sent (and cleared) upon a TOCLIENT_ACCEPT_SUDO_MODE
669         std::string m_new_password;
670         // Usable by auth mechanisms.
671         AuthMechanism m_chosen_auth_mech;
672         void * m_auth_data;
673
674
675         bool m_access_denied;
676         bool m_access_denied_reconnect;
677         std::string m_access_denied_reason;
678         std::queue<ClientEvent> m_client_event_queue;
679         bool m_itemdef_received;
680         bool m_nodedef_received;
681         ClientMediaDownloader *m_media_downloader;
682
683         // time_of_day speed approximation for old protocol
684         bool m_time_of_day_set;
685         float m_last_time_of_day_f;
686         float m_time_of_day_update_timer;
687
688         // An interval for generally sending object positions and stuff
689         float m_recommended_send_interval;
690
691         // Sounds
692         float m_removed_sounds_check_timer;
693         // Mapping from server sound ids to our sound ids
694         UNORDERED_MAP<s32, int> m_sounds_server_to_client;
695         // And the other way!
696         UNORDERED_MAP<int, s32> m_sounds_client_to_server;
697         // And relations to objects
698         UNORDERED_MAP<int, u16> m_sounds_to_objects;
699
700         // Privileges
701         UNORDERED_SET<std::string> m_privileges;
702
703         // Detached inventories
704         // key = name
705         UNORDERED_MAP<std::string, Inventory*> m_detached_inventories;
706
707         // Storage for mesh data for creating multiple instances of the same mesh
708         StringMap m_mesh_data;
709
710         // own state
711         LocalClientState m_state;
712
713         // Used for saving server map to disk client-side
714         Database *m_localdb;
715         IntervalLimiter m_localdb_save_interval;
716         u16 m_cache_save_interval;
717
718         // TODO: Add callback to update these when g_settings changes
719         bool m_cache_smooth_lighting;
720         bool m_cache_enable_shaders;
721         bool m_cache_use_tangent_vertices;
722
723         ClientScripting *m_script;
724
725         DISABLE_CLASS_COPY(Client);
726 };
727
728 #endif // !CLIENT_HEADER