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