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