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