]> git.lizzy.rs Git - dragonfireclient.git/blob - src/server.h
Fix a little regression on SendActiveObjectMessages which send all TOCLIENT_ACTIVE_OB...
[dragonfireclient.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 /*
67         Some random functions
68 */
69 v3f findSpawnPos(ServerMap &map);
70
71 class MapEditEventIgnorer
72 {
73 public:
74         MapEditEventIgnorer(bool *flag):
75                 m_flag(flag)
76         {
77                 if(*m_flag == false)
78                         *m_flag = true;
79                 else
80                         m_flag = NULL;
81         }
82
83         ~MapEditEventIgnorer()
84         {
85                 if(m_flag)
86                 {
87                         assert(*m_flag);
88                         *m_flag = false;
89                 }
90         }
91
92 private:
93         bool *m_flag;
94 };
95
96 class MapEditEventAreaIgnorer
97 {
98 public:
99         MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
100                 m_ignorevariable(ignorevariable)
101         {
102                 if(m_ignorevariable->getVolume() == 0)
103                         *m_ignorevariable = a;
104                 else
105                         m_ignorevariable = NULL;
106         }
107
108         ~MapEditEventAreaIgnorer()
109         {
110                 if(m_ignorevariable)
111                 {
112                         assert(m_ignorevariable->getVolume() != 0);
113                         *m_ignorevariable = VoxelArea();
114                 }
115         }
116
117 private:
118         VoxelArea *m_ignorevariable;
119 };
120
121 struct MediaInfo
122 {
123         std::string path;
124         std::string sha1_digest;
125
126         MediaInfo(const std::string &path_="",
127                   const std::string &sha1_digest_=""):
128                 path(path_),
129                 sha1_digest(sha1_digest_)
130         {
131         }
132 };
133
134 struct ServerSoundParams
135 {
136         float gain;
137         std::string to_player;
138         enum Type{
139                 SSP_LOCAL=0,
140                 SSP_POSITIONAL=1,
141                 SSP_OBJECT=2
142         } type;
143         v3f pos;
144         u16 object;
145         float max_hear_distance;
146         bool loop;
147
148         ServerSoundParams():
149                 gain(1.0),
150                 to_player(""),
151                 type(SSP_LOCAL),
152                 pos(0,0,0),
153                 object(0),
154                 max_hear_distance(32*BS),
155                 loop(false)
156         {}
157
158         v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
159 };
160
161 struct ServerPlayingSound
162 {
163         ServerSoundParams params;
164         std::set<u16> clients; // peer ids
165 };
166
167 class Server : public con::PeerHandler, public MapEventReceiver,
168                 public InventoryManager, public IGameDef
169 {
170 public:
171         /*
172                 NOTE: Every public method should be thread-safe
173         */
174
175         Server(
176                 const std::string &path_world,
177                 const SubgameSpec &gamespec,
178                 bool simple_singleplayer_mode,
179                 bool ipv6
180         );
181         ~Server();
182         void start(Address bind_addr);
183         void stop();
184         // This is mainly a way to pass the time to the server.
185         // Actual processing is done in an another thread.
186         void step(float dtime);
187         // This is run by ServerThread and does the actual processing
188         void AsyncRunStep(bool initial_step=false);
189         void Receive();
190         PlayerSAO* StageTwoClientInit(u16 peer_id);
191
192         /*
193          * Command Handlers
194          */
195
196         void handleCommand(NetworkPacket* pkt);
197
198         void handleCommand_Null(NetworkPacket* pkt) {};
199         void handleCommand_Deprecated(NetworkPacket* pkt);
200         void handleCommand_Init(NetworkPacket* pkt);
201         void handleCommand_Auth(NetworkPacket* pkt);
202         void handleCommand_Init_Legacy(NetworkPacket* pkt);
203         void handleCommand_Init2(NetworkPacket* pkt);
204         void handleCommand_RequestMedia(NetworkPacket* pkt);
205         void handleCommand_ReceivedMedia(NetworkPacket* pkt);
206         void handleCommand_ClientReady(NetworkPacket* pkt);
207         void handleCommand_GotBlocks(NetworkPacket* pkt);
208         void handleCommand_PlayerPos(NetworkPacket* pkt);
209         void handleCommand_DeletedBlocks(NetworkPacket* pkt);
210         void handleCommand_InventoryAction(NetworkPacket* pkt);
211         void handleCommand_ChatMessage(NetworkPacket* pkt);
212         void handleCommand_Damage(NetworkPacket* pkt);
213         void handleCommand_Breath(NetworkPacket* pkt);
214         void handleCommand_Password(NetworkPacket* pkt);
215         void handleCommand_PlayerItem(NetworkPacket* pkt);
216         void handleCommand_Respawn(NetworkPacket* pkt);
217         void handleCommand_Interact(NetworkPacket* pkt);
218         void handleCommand_RemovedSounds(NetworkPacket* pkt);
219         void handleCommand_NodeMetaFields(NetworkPacket* pkt);
220         void handleCommand_InventoryFields(NetworkPacket* pkt);
221
222         void ProcessData(u8 *data, u32 datasize, u16 peer_id);
223
224         void Send(NetworkPacket* pkt);
225
226         // Environment must be locked when called
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);
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(void)
251                         { m_shutdown_requested = true; }
252
253         // Returns -1 if failed, sound handle on success
254         // Envlock
255         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
256         void stopSound(s32 handle);
257
258         // Envlock
259         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
260         bool checkPriv(const std::string &name, const std::string &priv);
261         void reportPrivsModified(const std::string &name=""); // ""=all
262         void reportInventoryFormspecModified(const std::string &name);
263
264         void setIpBanned(const std::string &ip, const std::string &name);
265         void unsetIpBanned(const std::string &ip_or_name);
266         std::string getBanDescription(const std::string &ip_or_name);
267
268         void notifyPlayer(const char *name, const std::wstring &msg);
269         void notifyPlayers(const std::wstring &msg);
270         void spawnParticle(const char *playername,
271                 v3f pos, v3f velocity, v3f acceleration,
272                 float expirationtime, float size,
273                 bool collisiondetection, bool vertical, std::string texture);
274
275         void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
276                 float expirationtime, float size,
277                 bool collisiondetection, bool vertical, std::string texture);
278
279         u32 addParticleSpawner(const char *playername,
280                 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, std::string texture);
287
288         u32 addParticleSpawnerAll(u16 amount, float spawntime,
289                 v3f minpos, v3f maxpos,
290                 v3f minvel, v3f maxvel,
291                 v3f minacc, v3f maxacc,
292                 float minexptime, float maxexptime,
293                 float minsize, float maxsize,
294                 bool collisiondetection, bool vertical, std::string texture);
295
296         void deleteParticleSpawner(const char *playername, u32 id);
297         void deleteParticleSpawnerAll(u32 id);
298
299         // Creates or resets inventory
300         Inventory* createDetachedInventory(const std::string &name);
301
302         // Envlock and conlock should be locked when using scriptapi
303         GameScripting *getScriptIface(){ return m_script; }
304
305         //TODO: determine what (if anything) should be locked to access EmergeManager
306         EmergeManager *getEmergeManager(){ return m_emerge; }
307
308         // actions: time-reversed list
309         // Return value: success/failure
310         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
311                         std::list<std::string> *log);
312
313         // IGameDef interface
314         // Under envlock
315         virtual IItemDefManager* getItemDefManager();
316         virtual INodeDefManager* getNodeDefManager();
317         virtual ICraftDefManager* getCraftDefManager();
318         virtual ITextureSource* getTextureSource();
319         virtual IShaderSource* getShaderSource();
320         virtual u16 allocateUnknownNodeId(const std::string &name);
321         virtual ISoundManager* getSoundManager();
322         virtual MtEventManager* getEventManager();
323         virtual scene::ISceneManager* getSceneManager();
324         virtual IRollbackManager *getRollbackManager() { return m_rollback; }
325
326
327         IWritableItemDefManager* getWritableItemDefManager();
328         IWritableNodeDefManager* getWritableNodeDefManager();
329         IWritableCraftDefManager* getWritableCraftDefManager();
330
331         const ModSpec* getModSpec(const std::string &modname);
332         void getModNames(std::vector<std::string> &modlist);
333         std::string getBuiltinLuaPath();
334         inline std::string getWorldPath()
335                         { return m_path_world; }
336
337         inline bool isSingleplayer()
338                         { return m_simple_singleplayer_mode; }
339
340         inline void setAsyncFatalError(const std::string &error)
341                         { m_async_fatal_error.set(error); }
342
343         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
344         Map & getMap() { return m_env->getMap(); }
345         ServerEnvironment & getEnv() { return *m_env; }
346
347         u32 hudAdd(Player *player, HudElement *element);
348         bool hudRemove(Player *player, u32 id);
349         bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
350         bool hudSetFlags(Player *player, u32 flags, u32 mask);
351         bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
352         void hudSetHotbarImage(Player *player, std::string name);
353         void hudSetHotbarSelectedImage(Player *player, std::string name);
354
355         inline Address getPeerAddress(u16 peer_id)
356                         { return m_con.GetPeerAddress(peer_id); }
357
358         bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
359         bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
360
361         bool setSky(Player *player, const video::SColor &bgcolor,
362                         const std::string &type, const std::vector<std::string> &params);
363
364         bool overrideDayNightRatio(Player *player, bool do_override,
365                         float brightness);
366
367         /* con::PeerHandler implementation. */
368         void peerAdded(con::Peer *peer);
369         void deletingPeer(con::Peer *peer, bool timeout);
370
371         void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason=NULL);
372         void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
373         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
374         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
375                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
376                         std::string* vers_string);
377
378         void SendPlayerHPOrDie(u16 peer_id, bool die) { die ? DiePlayer(peer_id) : SendPlayerHP(peer_id); }
379         void SendPlayerBreath(u16 peer_id);
380         void SendInventory(PlayerSAO* playerSAO);
381         void SendMovePlayer(u16 peer_id);
382
383         // Bind address
384         Address m_bind_addr;
385
386 private:
387
388         friend class EmergeThread;
389         friend class RemoteClient;
390
391         void SendMovement(u16 peer_id);
392         void SendHP(u16 peer_id, u8 hp);
393         void SendBreath(u16 peer_id, u16 breath);
394         void SendAccessDenied(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason);
395         void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
396         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
397         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
398         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
399
400         /* mark blocks not sent for all clients */
401         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
402
403
404         void SendChatMessage(u16 peer_id, const std::wstring &message);
405         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
406         void SendPlayerHP(u16 peer_id);
407
408         void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
409         void SendEyeOffset(u16 peer_id, v3f first, v3f third);
410         void SendPlayerPrivileges(u16 peer_id);
411         void SendPlayerInventoryFormspec(u16 peer_id);
412         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
413         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
414         void SendHUDRemove(u16 peer_id, u32 id);
415         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
416         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
417         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
418         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
419                         const std::string &type, const std::vector<std::string> &params);
420         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
421
422         /*
423                 Send a node removal/addition event to all clients except ignore_id.
424                 Additionally, if far_players!=NULL, players further away than
425                 far_d_nodes are ignored and their peer_ids are added to far_players
426         */
427         // Envlock and conlock should be locked when calling these
428         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
429                         std::vector<u16> *far_players=NULL, float far_d_nodes=100);
430         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
431                         std::vector<u16> *far_players=NULL, float far_d_nodes=100,
432                         bool remove_metadata=true);
433         void setBlockNotSent(v3s16 p);
434
435         // Environment and Connection must be locked when called
436         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
437
438         // Sends blocks to clients (locks env and con on its own)
439         void SendBlocks(float dtime);
440
441         void fillMediaCache();
442         void sendMediaAnnouncement(u16 peer_id);
443         void sendRequestedMedia(u16 peer_id,
444                         const std::vector<std::string> &tosend);
445
446         void sendDetachedInventory(const std::string &name, u16 peer_id);
447         void sendDetachedInventories(u16 peer_id);
448
449         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
450         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
451                 v3f minpos, v3f maxpos,
452                 v3f minvel, v3f maxvel,
453                 v3f minacc, v3f maxacc,
454                 float minexptime, float maxexptime,
455                 float minsize, float maxsize,
456                 bool collisiondetection, bool vertical, std::string texture, u32 id);
457
458         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
459
460         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
461         void SendSpawnParticle(u16 peer_id,
462                 v3f pos, v3f velocity, v3f acceleration,
463                 float expirationtime, float size,
464                 bool collisiondetection, bool vertical, std::string texture);
465
466         u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
467         void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
468         /*
469                 Something random
470         */
471
472         void DiePlayer(u16 peer_id);
473         void RespawnPlayer(u16 peer_id);
474         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
475         void UpdateCrafting(Player *player);
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);
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         JMutex m_env_mutex;
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         JMutex 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
599         /*
600                 Map edit event queue. Automatically receives all map edits.
601                 The constructor of this class registers us to receive them through
602                 onMapEditEvent
603
604                 NOTE: Should these be moved to actually be members of
605                 ServerEnvironment?
606         */
607
608         /*
609                 Queue of map edits from the environment for sending to the clients
610                 This is behind m_env_mutex
611         */
612         std::queue<MapEditEvent*> m_unsent_map_edit_queue;
613         /*
614                 Set to true when the server itself is modifying the map and does
615                 all sending of information by itself.
616                 This is behind m_env_mutex
617         */
618         bool m_ignore_map_edit_events;
619         /*
620                 If a non-empty area, map edit events contained within are left
621                 unsent. Done at map generation time to speed up editing of the
622                 generated area, as it will be sent anyway.
623                 This is behind m_env_mutex
624         */
625         VoxelArea m_ignore_map_edit_events_area;
626         /*
627                 If set to !=0, the incoming MapEditEvents are modified to have
628                 this peed id as the disabled recipient
629                 This is behind m_env_mutex
630         */
631         u16 m_ignore_map_edit_events_peer_id;
632
633         // media files known to server
634         std::map<std::string,MediaInfo> m_media;
635
636         /*
637                 Sounds
638         */
639         std::map<s32, ServerPlayingSound> m_playing_sounds;
640         s32 m_next_sound_id;
641
642         /*
643                 Detached inventories (behind m_env_mutex)
644         */
645         // key = name
646         std::map<std::string, Inventory*> m_detached_inventories;
647
648         /*
649                 Particles
650         */
651         std::vector<u32> m_particlespawner_ids;
652 };
653
654 /*
655         Runs a simple dedicated server loop.
656
657         Shuts down when run is set to false.
658 */
659 void dedicated_server_loop(Server &server, bool &run);
660
661 #endif
662