Add callback parameter for core.emerge_area()
[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 "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         inline u32 getTimeOfDay();
227
228         /*
229                 Shall be called with the environment locked.
230                 This is accessed by the map, which is inside the environment,
231                 so it shouldn't be a problem.
232         */
233         void onMapEditEvent(MapEditEvent *event);
234
235         /*
236                 Shall be called with the environment and the connection locked.
237         */
238         Inventory* getInventory(const InventoryLocation &loc);
239         void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
240
241         // Connection must be locked when called
242         std::wstring getStatusString();
243
244         // read shutdown state
245         inline bool getShutdownRequested()
246                         { return m_shutdown_requested; }
247
248         // request server to shutdown
249         inline void requestShutdown() { m_shutdown_requested = true; }
250         void requestShutdown(const std::string &msg, bool reconnect)
251         {
252                 m_shutdown_requested = true;
253                 m_shutdown_msg = msg;
254                 m_shutdown_ask_reconnect = reconnect;
255         }
256
257         // Returns -1 if failed, sound handle on success
258         // Envlock
259         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
260         void stopSound(s32 handle);
261
262         // Envlock
263         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
264         bool checkPriv(const std::string &name, const std::string &priv);
265         void reportPrivsModified(const std::string &name=""); // ""=all
266         void reportInventoryFormspecModified(const std::string &name);
267
268         void setIpBanned(const std::string &ip, const std::string &name);
269         void unsetIpBanned(const std::string &ip_or_name);
270         std::string getBanDescription(const std::string &ip_or_name);
271
272         void notifyPlayer(const char *name, const std::wstring &msg);
273         void notifyPlayers(const std::wstring &msg);
274         void spawnParticle(const std::string &playername,
275                 v3f pos, v3f velocity, v3f acceleration,
276                 float expirationtime, float size,
277                 bool collisiondetection, bool vertical, const std::string &texture);
278
279         u32 addParticleSpawner(u16 amount, float spawntime,
280                 v3f minpos, v3f maxpos,
281                 v3f minvel, v3f maxvel,
282                 v3f minacc, v3f maxacc,
283                 float minexptime, float maxexptime,
284                 float minsize, float maxsize,
285                 bool collisiondetection, bool vertical, const std::string &texture,
286                 const std::string &playername);
287
288         void deleteParticleSpawner(const std::string &playername, u32 id);
289
290         // Creates or resets inventory
291         Inventory* createDetachedInventory(const std::string &name);
292
293         // Envlock and conlock should be locked when using scriptapi
294         GameScripting *getScriptIface(){ return m_script; }
295
296         // actions: time-reversed list
297         // Return value: success/failure
298         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
299                         std::list<std::string> *log);
300
301         // IGameDef interface
302         // Under envlock
303         virtual IItemDefManager* getItemDefManager();
304         virtual INodeDefManager* getNodeDefManager();
305         virtual ICraftDefManager* getCraftDefManager();
306         virtual ITextureSource* getTextureSource();
307         virtual IShaderSource* getShaderSource();
308         virtual u16 allocateUnknownNodeId(const std::string &name);
309         virtual ISoundManager* getSoundManager();
310         virtual MtEventManager* getEventManager();
311         virtual scene::ISceneManager* getSceneManager();
312         virtual IRollbackManager *getRollbackManager() { return m_rollback; }
313         virtual EmergeManager *getEmergeManager() { return m_emerge; }
314
315         IWritableItemDefManager* getWritableItemDefManager();
316         IWritableNodeDefManager* getWritableNodeDefManager();
317         IWritableCraftDefManager* getWritableCraftDefManager();
318
319         const ModSpec* getModSpec(const std::string &modname) const;
320         void getModNames(std::vector<std::string> &modlist);
321         std::string getBuiltinLuaPath();
322         inline std::string getWorldPath() const
323                         { return m_path_world; }
324
325         inline bool isSingleplayer()
326                         { return m_simple_singleplayer_mode; }
327
328         inline void setAsyncFatalError(const std::string &error)
329                         { m_async_fatal_error.set(error); }
330
331         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
332         Map & getMap() { return m_env->getMap(); }
333         ServerEnvironment & getEnv() { return *m_env; }
334
335         u32 hudAdd(Player *player, HudElement *element);
336         bool hudRemove(Player *player, u32 id);
337         bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
338         bool hudSetFlags(Player *player, u32 flags, u32 mask);
339         bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
340         s32 hudGetHotbarItemcount(Player *player);
341         void hudSetHotbarImage(Player *player, std::string name);
342         std::string hudGetHotbarImage(Player *player);
343         void hudSetHotbarSelectedImage(Player *player, std::string name);
344         std::string hudGetHotbarSelectedImage(Player *player);
345
346         inline Address getPeerAddress(u16 peer_id)
347                         { return m_con.GetPeerAddress(peer_id); }
348
349         bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
350         bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
351
352         bool setSky(Player *player, const video::SColor &bgcolor,
353                         const std::string &type, const std::vector<std::string> &params);
354
355         bool overrideDayNightRatio(Player *player, bool do_override,
356                         float brightness);
357
358         /* con::PeerHandler implementation. */
359         void peerAdded(con::Peer *peer);
360         void deletingPeer(con::Peer *peer, bool timeout);
361
362         void DenySudoAccess(u16 peer_id);
363         void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
364                 const std::string &str_reason = "", bool reconnect = false);
365         void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
366         void acceptAuth(u16 peer_id, bool forSudoMode);
367         void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
368         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
369         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
370                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
371                         std::string* vers_string);
372
373         void SendPlayerHPOrDie(PlayerSAO *player);
374         void SendPlayerBreath(u16 peer_id);
375         void SendInventory(PlayerSAO* playerSAO);
376         void SendMovePlayer(u16 peer_id);
377
378         // Bind address
379         Address m_bind_addr;
380
381         // Environment mutex (envlock)
382         Mutex m_env_mutex;
383
384 private:
385
386         friend class EmergeThread;
387         friend class RemoteClient;
388
389         void SendMovement(u16 peer_id);
390         void SendHP(u16 peer_id, u8 hp);
391         void SendBreath(u16 peer_id, u16 breath);
392         void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
393                 const std::string &custom_reason, bool reconnect = false);
394         void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
395         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
396         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
397         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
398
399         /* mark blocks not sent for all clients */
400         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
401
402
403         void SendChatMessage(u16 peer_id, const std::wstring &message);
404         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
405         void SendPlayerHP(u16 peer_id);
406
407         void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
408         void SendEyeOffset(u16 peer_id, v3f first, v3f third);
409         void SendPlayerPrivileges(u16 peer_id);
410         void SendPlayerInventoryFormspec(u16 peer_id);
411         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
412         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
413         void SendHUDRemove(u16 peer_id, u32 id);
414         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
415         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
416         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
417         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
418                         const std::string &type, const std::vector<std::string> &params);
419         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
420
421         /*
422                 Send a node removal/addition event to all clients except ignore_id.
423                 Additionally, if far_players!=NULL, players further away than
424                 far_d_nodes are ignored and their peer_ids are added to far_players
425         */
426         // Envlock and conlock should be locked when calling these
427         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
428                         std::vector<u16> *far_players=NULL, float far_d_nodes=100);
429         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
430                         std::vector<u16> *far_players=NULL, float far_d_nodes=100,
431                         bool remove_metadata=true);
432         void setBlockNotSent(v3s16 p);
433
434         // Environment and Connection must be locked when called
435         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
436
437         // Sends blocks to clients (locks env and con on its own)
438         void SendBlocks(float dtime);
439
440         void fillMediaCache();
441         void sendMediaAnnouncement(u16 peer_id);
442         void sendRequestedMedia(u16 peer_id,
443                         const std::vector<std::string> &tosend);
444
445         void sendDetachedInventory(const std::string &name, u16 peer_id);
446         void sendDetachedInventories(u16 peer_id);
447
448         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
449         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
450                 v3f minpos, v3f maxpos,
451                 v3f minvel, v3f maxvel,
452                 v3f minacc, v3f maxacc,
453                 float minexptime, float maxexptime,
454                 float minsize, float maxsize,
455                 bool collisiondetection, bool vertical, std::string texture, u32 id);
456
457         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
458
459         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
460         void SendSpawnParticle(u16 peer_id,
461                 v3f pos, v3f velocity, v3f acceleration,
462                 float expirationtime, float size,
463                 bool collisiondetection, bool vertical, std::string texture);
464
465         u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
466         void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
467         /*
468                 Something random
469         */
470
471         void DiePlayer(u16 peer_id);
472         void RespawnPlayer(u16 peer_id);
473         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
474         void UpdateCrafting(Player *player);
475
476         v3f findSpawnPos();
477
478         // When called, connection mutex should be locked
479         RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
480         RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
481
482         // When called, environment mutex should be locked
483         std::string getPlayerName(u16 peer_id);
484         PlayerSAO* getPlayerSAO(u16 peer_id);
485
486         /*
487                 Get a player from memory or creates one.
488                 If player is already connected, return NULL
489                 Does not verify/modify auth info and password.
490
491                 Call with env and con locked.
492         */
493         PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
494
495         void handlePeerChanges();
496
497         /*
498                 Variables
499         */
500
501         // World directory
502         std::string m_path_world;
503         // Subgame specification
504         SubgameSpec m_gamespec;
505         // If true, do not allow multiple players and hide some multiplayer
506         // functionality
507         bool m_simple_singleplayer_mode;
508
509         // Thread can set; step() will throw as ServerError
510         MutexedVariable<std::string> m_async_fatal_error;
511
512         // Some timers
513         float m_liquid_transform_timer;
514         float m_liquid_transform_every;
515         float m_print_info_timer;
516         float m_masterserver_timer;
517         float m_objectdata_timer;
518         float m_emergethread_trigger_timer;
519         float m_savemap_timer;
520         IntervalLimiter m_map_timer_and_unload_interval;
521
522         // Environment
523         ServerEnvironment *m_env;
524
525         // server connection
526         con::Connection m_con;
527
528         // Ban checking
529         BanManager *m_banmanager;
530
531         // Rollback manager (behind m_env_mutex)
532         IRollbackManager *m_rollback;
533         bool m_enable_rollback_recording; // Updated once in a while
534
535         // Emerge manager
536         EmergeManager *m_emerge;
537
538         // Scripting
539         // Envlock and conlock should be locked when using Lua
540         GameScripting *m_script;
541
542         // Item definition manager
543         IWritableItemDefManager *m_itemdef;
544
545         // Node definition manager
546         IWritableNodeDefManager *m_nodedef;
547
548         // Craft definition manager
549         IWritableCraftDefManager *m_craftdef;
550
551         // Event manager
552         EventManager *m_event;
553
554         // Mods
555         std::vector<ModSpec> m_mods;
556
557         /*
558                 Threads
559         */
560
561         // A buffer for time steps
562         // step() increments and AsyncRunStep() run by m_thread reads it.
563         float m_step_dtime;
564         Mutex m_step_dtime_mutex;
565
566         // current server step lag counter
567         float m_lag;
568
569         // The server mainly operates in this thread
570         ServerThread *m_thread;
571
572         /*
573                 Time related stuff
574         */
575
576         // Timer for sending time of day over network
577         float m_time_of_day_send_timer;
578         // Uptime of server in seconds
579         MutexedVariable<double> m_uptime;
580
581         /*
582          Client interface
583          */
584         ClientInterface m_clients;
585
586         /*
587                 Peer change queue.
588                 Queues stuff from peerAdded() and deletingPeer() to
589                 handlePeerChanges()
590         */
591         std::queue<con::PeerChange> m_peer_change_queue;
592
593         /*
594                 Random stuff
595         */
596
597         bool m_shutdown_requested;
598         std::string m_shutdown_msg;
599         bool m_shutdown_ask_reconnect;
600
601         /*
602                 Map edit event queue. Automatically receives all map edits.
603                 The constructor of this class registers us to receive them through
604                 onMapEditEvent
605
606                 NOTE: Should these be moved to actually be members of
607                 ServerEnvironment?
608         */
609
610         /*
611                 Queue of map edits from the environment for sending to the clients
612                 This is behind m_env_mutex
613         */
614         std::queue<MapEditEvent*> m_unsent_map_edit_queue;
615         /*
616                 Set to true when the server itself is modifying the map and does
617                 all sending of information by itself.
618                 This is behind m_env_mutex
619         */
620         bool m_ignore_map_edit_events;
621         /*
622                 If a non-empty area, map edit events contained within are left
623                 unsent. Done at map generation time to speed up editing of the
624                 generated area, as it will be sent anyway.
625                 This is behind m_env_mutex
626         */
627         VoxelArea m_ignore_map_edit_events_area;
628         /*
629                 If set to !=0, the incoming MapEditEvents are modified to have
630                 this peed id as the disabled recipient
631                 This is behind m_env_mutex
632         */
633         u16 m_ignore_map_edit_events_peer_id;
634
635         // media files known to server
636         std::map<std::string,MediaInfo> m_media;
637
638         /*
639                 Sounds
640         */
641         std::map<s32, ServerPlayingSound> m_playing_sounds;
642         s32 m_next_sound_id;
643
644         /*
645                 Detached inventories (behind m_env_mutex)
646         */
647         // key = name
648         std::map<std::string, Inventory*> m_detached_inventories;
649
650         /*
651                 Particles
652         */
653         std::vector<u32> m_particlespawner_ids;
654
655         DISABLE_CLASS_COPY(Server);
656 };
657
658 /*
659         Runs a simple dedicated server loop.
660
661         Shuts down when kill is set to true.
662 */
663 void dedicated_server_loop(Server &server, bool &kill);
664
665 #endif
666