Tolerate packet reordering in the early init process
[oweals/minetest.git] / src / server.h
1 /*
2 Minetest
3 Copyright (C) 2010-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 SERVER_HEADER
21 #define SERVER_HEADER
22
23 #include "network/connection.h"
24 #include "irr_v3d.h"
25 #include "map.h"
26 #include "hud.h"
27 #include "gamedef.h"
28 #include "serialization.h" // For SER_FMT_VER_INVALID
29 #include "mods.h"
30 #include "inventorymanager.h"
31 #include "subgame.h"
32 #include "util/numeric.h"
33 #include "util/thread.h"
34 #include "environment.h"
35 #include "chat_interface.h"
36 #include "clientiface.h"
37 #include "network/networkpacket.h"
38 #include <string>
39 #include <list>
40 #include <map>
41 #include <vector>
42
43 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
44
45 class IWritableItemDefManager;
46 class IWritableNodeDefManager;
47 class IWritableCraftDefManager;
48 class BanManager;
49 class EventManager;
50 class Inventory;
51 class Player;
52 class PlayerSAO;
53 class IRollbackManager;
54 struct RollbackAction;
55 class EmergeManager;
56 class GameScripting;
57 class ServerEnvironment;
58 struct SimpleSoundSpec;
59 class ServerThread;
60
61 enum ClientDeletionReason {
62         CDR_LEAVE,
63         CDR_TIMEOUT,
64         CDR_DENY
65 };
66
67 class MapEditEventIgnorer
68 {
69 public:
70         MapEditEventIgnorer(bool *flag):
71                 m_flag(flag)
72         {
73                 if(*m_flag == false)
74                         *m_flag = true;
75                 else
76                         m_flag = NULL;
77         }
78
79         ~MapEditEventIgnorer()
80         {
81                 if(m_flag)
82                 {
83                         assert(*m_flag);
84                         *m_flag = false;
85                 }
86         }
87
88 private:
89         bool *m_flag;
90 };
91
92 class MapEditEventAreaIgnorer
93 {
94 public:
95         MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
96                 m_ignorevariable(ignorevariable)
97         {
98                 if(m_ignorevariable->getVolume() == 0)
99                         *m_ignorevariable = a;
100                 else
101                         m_ignorevariable = NULL;
102         }
103
104         ~MapEditEventAreaIgnorer()
105         {
106                 if(m_ignorevariable)
107                 {
108                         assert(m_ignorevariable->getVolume() != 0);
109                         *m_ignorevariable = VoxelArea();
110                 }
111         }
112
113 private:
114         VoxelArea *m_ignorevariable;
115 };
116
117 struct MediaInfo
118 {
119         std::string path;
120         std::string sha1_digest;
121
122         MediaInfo(const std::string &path_="",
123                   const std::string &sha1_digest_=""):
124                 path(path_),
125                 sha1_digest(sha1_digest_)
126         {
127         }
128 };
129
130 struct ServerSoundParams
131 {
132         float gain;
133         std::string to_player;
134         enum Type{
135                 SSP_LOCAL=0,
136                 SSP_POSITIONAL=1,
137                 SSP_OBJECT=2
138         } type;
139         v3f pos;
140         u16 object;
141         float max_hear_distance;
142         bool loop;
143
144         ServerSoundParams():
145                 gain(1.0),
146                 to_player(""),
147                 type(SSP_LOCAL),
148                 pos(0,0,0),
149                 object(0),
150                 max_hear_distance(32*BS),
151                 loop(false)
152         {}
153
154         v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
155 };
156
157 struct ServerPlayingSound
158 {
159         ServerSoundParams params;
160         std::set<u16> clients; // peer ids
161 };
162
163 class Server : public con::PeerHandler, public MapEventReceiver,
164                 public InventoryManager, public IGameDef
165 {
166 public:
167         /*
168                 NOTE: Every public method should be thread-safe
169         */
170
171         Server(
172                 const std::string &path_world,
173                 const SubgameSpec &gamespec,
174                 bool simple_singleplayer_mode,
175                 bool ipv6,
176                 ChatInterface *iface = NULL
177         );
178         ~Server();
179         void start(Address bind_addr);
180         void stop();
181         // This is mainly a way to pass the time to the server.
182         // Actual processing is done in an another thread.
183         void step(float dtime);
184         // This is run by ServerThread and does the actual processing
185         void AsyncRunStep(bool initial_step=false);
186         void Receive();
187         PlayerSAO* StageTwoClientInit(u16 peer_id);
188
189         /*
190          * Command Handlers
191          */
192
193         void handleCommand(NetworkPacket* pkt);
194
195         void handleCommand_Null(NetworkPacket* pkt) {};
196         void handleCommand_Deprecated(NetworkPacket* pkt);
197         void handleCommand_Init(NetworkPacket* pkt);
198         void handleCommand_Init_Legacy(NetworkPacket* pkt);
199         void handleCommand_Init2(NetworkPacket* pkt);
200         void handleCommand_RequestMedia(NetworkPacket* pkt);
201         void handleCommand_ReceivedMedia(NetworkPacket* pkt);
202         void handleCommand_ClientReady(NetworkPacket* pkt);
203         void handleCommand_GotBlocks(NetworkPacket* pkt);
204         void handleCommand_PlayerPos(NetworkPacket* pkt);
205         void handleCommand_DeletedBlocks(NetworkPacket* pkt);
206         void handleCommand_InventoryAction(NetworkPacket* pkt);
207         void handleCommand_ChatMessage(NetworkPacket* pkt);
208         void handleCommand_Damage(NetworkPacket* pkt);
209         void handleCommand_Breath(NetworkPacket* pkt);
210         void handleCommand_Password(NetworkPacket* pkt);
211         void handleCommand_PlayerItem(NetworkPacket* pkt);
212         void handleCommand_Respawn(NetworkPacket* pkt);
213         void handleCommand_Interact(NetworkPacket* pkt);
214         void handleCommand_RemovedSounds(NetworkPacket* pkt);
215         void handleCommand_NodeMetaFields(NetworkPacket* pkt);
216         void handleCommand_InventoryFields(NetworkPacket* pkt);
217         void handleCommand_FirstSrp(NetworkPacket* pkt);
218         void handleCommand_SrpBytesA(NetworkPacket* pkt);
219         void handleCommand_SrpBytesM(NetworkPacket* pkt);
220
221         void ProcessData(NetworkPacket *pkt);
222
223         void Send(NetworkPacket* pkt);
224
225         // Both setter and getter need no envlock,
226         // can be called freely from threads
227         void setTimeOfDay(u32 time);
228
229         /*
230                 Shall be called with the environment locked.
231                 This is accessed by the map, which is inside the environment,
232                 so it shouldn't be a problem.
233         */
234         void onMapEditEvent(MapEditEvent *event);
235
236         /*
237                 Shall be called with the environment and the connection locked.
238         */
239         Inventory* getInventory(const InventoryLocation &loc);
240         void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
241
242         // Connection must be locked when called
243         std::wstring getStatusString();
244
245         // read shutdown state
246         inline bool getShutdownRequested()
247                         { return m_shutdown_requested; }
248
249         // request server to shutdown
250         inline void requestShutdown() { m_shutdown_requested = true; }
251         void requestShutdown(const std::string &msg, bool reconnect)
252         {
253                 m_shutdown_requested = true;
254                 m_shutdown_msg = msg;
255                 m_shutdown_ask_reconnect = reconnect;
256         }
257
258         // Returns -1 if failed, sound handle on success
259         // Envlock
260         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
261         void stopSound(s32 handle);
262
263         // Envlock
264         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
265         bool checkPriv(const std::string &name, const std::string &priv);
266         void reportPrivsModified(const std::string &name=""); // ""=all
267         void reportInventoryFormspecModified(const std::string &name);
268
269         void setIpBanned(const std::string &ip, const std::string &name);
270         void unsetIpBanned(const std::string &ip_or_name);
271         std::string getBanDescription(const std::string &ip_or_name);
272
273         void notifyPlayer(const char *name, const std::wstring &msg);
274         void notifyPlayers(const std::wstring &msg);
275         void spawnParticle(const std::string &playername,
276                 v3f pos, v3f velocity, v3f acceleration,
277                 float expirationtime, float size,
278                 bool collisiondetection, bool vertical, const std::string &texture);
279
280         u32 addParticleSpawner(u16 amount, float spawntime,
281                 v3f minpos, v3f maxpos,
282                 v3f minvel, v3f maxvel,
283                 v3f minacc, v3f maxacc,
284                 float minexptime, float maxexptime,
285                 float minsize, float maxsize,
286                 bool collisiondetection, bool vertical, const std::string &texture,
287                 const std::string &playername);
288
289         void deleteParticleSpawner(const std::string &playername, u32 id);
290         void deleteParticleSpawnerAll(u32 id);
291
292         // Creates or resets inventory
293         Inventory* createDetachedInventory(const std::string &name);
294
295         // Envlock and conlock should be locked when using scriptapi
296         GameScripting *getScriptIface(){ return m_script; }
297
298         // actions: time-reversed list
299         // Return value: success/failure
300         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
301                         std::list<std::string> *log);
302
303         // IGameDef interface
304         // Under envlock
305         virtual IItemDefManager* getItemDefManager();
306         virtual INodeDefManager* getNodeDefManager();
307         virtual ICraftDefManager* getCraftDefManager();
308         virtual ITextureSource* getTextureSource();
309         virtual IShaderSource* getShaderSource();
310         virtual u16 allocateUnknownNodeId(const std::string &name);
311         virtual ISoundManager* getSoundManager();
312         virtual MtEventManager* getEventManager();
313         virtual scene::ISceneManager* getSceneManager();
314         virtual IRollbackManager *getRollbackManager() { return m_rollback; }
315         virtual EmergeManager *getEmergeManager() { return m_emerge; }
316
317         IWritableItemDefManager* getWritableItemDefManager();
318         IWritableNodeDefManager* getWritableNodeDefManager();
319         IWritableCraftDefManager* getWritableCraftDefManager();
320
321         const ModSpec* getModSpec(const std::string &modname) const;
322         void getModNames(std::vector<std::string> &modlist);
323         std::string getBuiltinLuaPath();
324         inline std::string getWorldPath() const
325                         { return m_path_world; }
326
327         inline bool isSingleplayer()
328                         { return m_simple_singleplayer_mode; }
329
330         inline void setAsyncFatalError(const std::string &error)
331                         { m_async_fatal_error.set(error); }
332
333         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
334         Map & getMap() { return m_env->getMap(); }
335         ServerEnvironment & getEnv() { return *m_env; }
336
337         u32 hudAdd(Player *player, HudElement *element);
338         bool hudRemove(Player *player, u32 id);
339         bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
340         bool hudSetFlags(Player *player, u32 flags, u32 mask);
341         bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
342         s32 hudGetHotbarItemcount(Player *player);
343         void hudSetHotbarImage(Player *player, std::string name);
344         std::string hudGetHotbarImage(Player *player);
345         void hudSetHotbarSelectedImage(Player *player, std::string name);
346         std::string hudGetHotbarSelectedImage(Player *player);
347
348         inline Address getPeerAddress(u16 peer_id)
349                         { return m_con.GetPeerAddress(peer_id); }
350
351         bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
352         bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
353
354         bool setSky(Player *player, const video::SColor &bgcolor,
355                         const std::string &type, const std::vector<std::string> &params);
356
357         bool overrideDayNightRatio(Player *player, bool do_override,
358                         float brightness);
359
360         /* con::PeerHandler implementation. */
361         void peerAdded(con::Peer *peer);
362         void deletingPeer(con::Peer *peer, bool timeout);
363
364         void DenySudoAccess(u16 peer_id);
365         void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
366                 const std::string &str_reason = "", bool reconnect = false);
367         void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
368         void acceptAuth(u16 peer_id, bool forSudoMode);
369         void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
370         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
371         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
372                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
373                         std::string* vers_string);
374
375         void printToConsoleOnly(const std::string &text);
376
377         void SendPlayerHPOrDie(PlayerSAO *player);
378         void SendPlayerBreath(u16 peer_id);
379         void SendInventory(PlayerSAO* playerSAO);
380         void SendMovePlayer(u16 peer_id);
381
382         // Bind address
383         Address m_bind_addr;
384
385         // Environment mutex (envlock)
386         Mutex m_env_mutex;
387
388 private:
389
390         friend class EmergeThread;
391         friend class RemoteClient;
392
393         void SendMovement(u16 peer_id);
394         void SendHP(u16 peer_id, u8 hp);
395         void SendBreath(u16 peer_id, u16 breath);
396         void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
397                 const std::string &custom_reason, bool reconnect = false);
398         void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
399         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
400         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
401         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
402
403         /* mark blocks not sent for all clients */
404         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
405
406
407         void SendChatMessage(u16 peer_id, const std::wstring &message);
408         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
409         void SendPlayerHP(u16 peer_id);
410
411         void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
412         void SendEyeOffset(u16 peer_id, v3f first, v3f third);
413         void SendPlayerPrivileges(u16 peer_id);
414         void SendPlayerInventoryFormspec(u16 peer_id);
415         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
416         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
417         void SendHUDRemove(u16 peer_id, u32 id);
418         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
419         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
420         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
421         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
422                         const std::string &type, const std::vector<std::string> &params);
423         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
424
425         /*
426                 Send a node removal/addition event to all clients except ignore_id.
427                 Additionally, if far_players!=NULL, players further away than
428                 far_d_nodes are ignored and their peer_ids are added to far_players
429         */
430         // Envlock and conlock should be locked when calling these
431         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
432                         std::vector<u16> *far_players=NULL, float far_d_nodes=100);
433         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
434                         std::vector<u16> *far_players=NULL, float far_d_nodes=100,
435                         bool remove_metadata=true);
436         void setBlockNotSent(v3s16 p);
437
438         // Environment and Connection must be locked when called
439         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
440
441         // Sends blocks to clients (locks env and con on its own)
442         void SendBlocks(float dtime);
443
444         void fillMediaCache();
445         void sendMediaAnnouncement(u16 peer_id);
446         void sendRequestedMedia(u16 peer_id,
447                         const std::vector<std::string> &tosend);
448
449         void sendDetachedInventory(const std::string &name, u16 peer_id);
450         void sendDetachedInventories(u16 peer_id);
451
452         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
453         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
454                 v3f minpos, v3f maxpos,
455                 v3f minvel, v3f maxvel,
456                 v3f minacc, v3f maxacc,
457                 float minexptime, float maxexptime,
458                 float minsize, float maxsize,
459                 bool collisiondetection, bool vertical, std::string texture, u32 id);
460
461         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
462
463         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
464         void SendSpawnParticle(u16 peer_id,
465                 v3f pos, v3f velocity, v3f acceleration,
466                 float expirationtime, float size,
467                 bool collisiondetection, bool vertical, std::string texture);
468
469         u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
470         void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
471         /*
472                 Something random
473         */
474
475         void DiePlayer(u16 peer_id);
476         void RespawnPlayer(u16 peer_id);
477         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
478         void UpdateCrafting(Player *player);
479
480         void handleChatInterfaceEvent(ChatEvent *evt);
481
482         // This returns the answer to the sender of wmessage, or "" if there is none
483         std::wstring handleChat(const std::string &name, const std::wstring &wname,
484                 const std::wstring &wmessage,
485                 bool check_shout_priv = false,
486                 u16 peer_id_to_avoid_sending = PEER_ID_INEXISTENT);
487         void handleAdminChat(const ChatEventChat *evt);
488
489         v3f findSpawnPos();
490
491         // When called, connection mutex should be locked
492         RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
493         RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
494
495         // When called, environment mutex should be locked
496         std::string getPlayerName(u16 peer_id);
497         PlayerSAO* getPlayerSAO(u16 peer_id);
498
499         /*
500                 Get a player from memory or creates one.
501                 If player is already connected, return NULL
502                 Does not verify/modify auth info and password.
503
504                 Call with env and con locked.
505         */
506         PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
507
508         void handlePeerChanges();
509
510         /*
511                 Variables
512         */
513
514         // World directory
515         std::string m_path_world;
516         // Subgame specification
517         SubgameSpec m_gamespec;
518         // If true, do not allow multiple players and hide some multiplayer
519         // functionality
520         bool m_simple_singleplayer_mode;
521
522         // Thread can set; step() will throw as ServerError
523         MutexedVariable<std::string> m_async_fatal_error;
524
525         // Some timers
526         float m_liquid_transform_timer;
527         float m_liquid_transform_every;
528         float m_print_info_timer;
529         float m_masterserver_timer;
530         float m_objectdata_timer;
531         float m_emergethread_trigger_timer;
532         float m_savemap_timer;
533         IntervalLimiter m_map_timer_and_unload_interval;
534
535         // Environment
536         ServerEnvironment *m_env;
537
538         // server connection
539         con::Connection m_con;
540
541         // Ban checking
542         BanManager *m_banmanager;
543
544         // Rollback manager (behind m_env_mutex)
545         IRollbackManager *m_rollback;
546         bool m_enable_rollback_recording; // Updated once in a while
547
548         // Emerge manager
549         EmergeManager *m_emerge;
550
551         // Scripting
552         // Envlock and conlock should be locked when using Lua
553         GameScripting *m_script;
554
555         // Item definition manager
556         IWritableItemDefManager *m_itemdef;
557
558         // Node definition manager
559         IWritableNodeDefManager *m_nodedef;
560
561         // Craft definition manager
562         IWritableCraftDefManager *m_craftdef;
563
564         // Event manager
565         EventManager *m_event;
566
567         // Mods
568         std::vector<ModSpec> m_mods;
569
570         /*
571                 Threads
572         */
573
574         // A buffer for time steps
575         // step() increments and AsyncRunStep() run by m_thread reads it.
576         float m_step_dtime;
577         Mutex m_step_dtime_mutex;
578
579         // current server step lag counter
580         float m_lag;
581
582         // The server mainly operates in this thread
583         ServerThread *m_thread;
584
585         /*
586                 Time related stuff
587         */
588
589         // Timer for sending time of day over network
590         float m_time_of_day_send_timer;
591         // Uptime of server in seconds
592         MutexedVariable<double> m_uptime;
593
594         /*
595          Client interface
596          */
597         ClientInterface m_clients;
598
599         /*
600                 Peer change queue.
601                 Queues stuff from peerAdded() and deletingPeer() to
602                 handlePeerChanges()
603         */
604         std::queue<con::PeerChange> m_peer_change_queue;
605
606         /*
607                 Random stuff
608         */
609
610         bool m_shutdown_requested;
611         std::string m_shutdown_msg;
612         bool m_shutdown_ask_reconnect;
613
614         ChatInterface *m_admin_chat;
615         std::string m_admin_nick;
616
617         /*
618                 Map edit event queue. Automatically receives all map edits.
619                 The constructor of this class registers us to receive them through
620                 onMapEditEvent
621
622                 NOTE: Should these be moved to actually be members of
623                 ServerEnvironment?
624         */
625
626         /*
627                 Queue of map edits from the environment for sending to the clients
628                 This is behind m_env_mutex
629         */
630         std::queue<MapEditEvent*> m_unsent_map_edit_queue;
631         /*
632                 Set to true when the server itself is modifying the map and does
633                 all sending of information by itself.
634                 This is behind m_env_mutex
635         */
636         bool m_ignore_map_edit_events;
637         /*
638                 If a non-empty area, map edit events contained within are left
639                 unsent. Done at map generation time to speed up editing of the
640                 generated area, as it will be sent anyway.
641                 This is behind m_env_mutex
642         */
643         VoxelArea m_ignore_map_edit_events_area;
644         /*
645                 If set to !=0, the incoming MapEditEvents are modified to have
646                 this peed id as the disabled recipient
647                 This is behind m_env_mutex
648         */
649         u16 m_ignore_map_edit_events_peer_id;
650
651         // media files known to server
652         std::map<std::string,MediaInfo> m_media;
653
654         /*
655                 Sounds
656         */
657         std::map<s32, ServerPlayingSound> m_playing_sounds;
658         s32 m_next_sound_id;
659
660         /*
661                 Detached inventories (behind m_env_mutex)
662         */
663         // key = name
664         std::map<std::string, Inventory*> m_detached_inventories;
665
666         DISABLE_CLASS_COPY(Server);
667 };
668
669 /*
670         Runs a simple dedicated server loop.
671
672         Shuts down when kill is set to true.
673 */
674 void dedicated_server_loop(Server &server, bool &kill);
675
676 #endif
677