dcd007d23f3e19a1f2993bd74dec472c28afed32
[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 "connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_bloated.h"
26 #include <string>
27 #include "porting.h"
28 #include "map.h"
29 #include "inventory.h"
30 #include "ban.h"
31 #include "hud.h"
32 #include "gamedef.h"
33 #include "serialization.h" // For SER_FMT_VER_INVALID
34 #include "mods.h"
35 #include "inventorymanager.h"
36 #include "subgame.h"
37 #include "sound.h"
38 #include "util/thread.h"
39 #include "util/string.h"
40 #include "rollback_interface.h" // Needed for rollbackRevertActions()
41 #include <list> // Needed for rollbackRevertActions()
42 #include <algorithm>
43
44 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
45
46 struct LuaState;
47 typedef struct lua_State lua_State;
48 class IWritableItemDefManager;
49 class IWritableNodeDefManager;
50 class IWritableCraftDefManager;
51 class EventManager;
52 class PlayerSAO;
53 class IRollbackManager;
54 class EmergeManager;
55 //struct HudElement;
56
57 class ServerError : public std::exception
58 {
59 public:
60         ServerError(const std::string &s)
61         {
62                 m_s = "ServerError: ";
63                 m_s += s;
64         }
65         virtual ~ServerError() throw()
66         {}
67         virtual const char * what() const throw()
68         {
69                 return m_s.c_str();
70         }
71         std::string m_s;
72 };
73
74 /*
75         Some random functions
76 */
77 v3f findSpawnPos(ServerMap &map);
78
79
80 class MapEditEventIgnorer
81 {
82 public:
83         MapEditEventIgnorer(bool *flag):
84                 m_flag(flag)
85         {
86                 if(*m_flag == false)
87                         *m_flag = true;
88                 else
89                         m_flag = NULL;
90         }
91
92         ~MapEditEventIgnorer()
93         {
94                 if(m_flag)
95                 {
96                         assert(*m_flag);
97                         *m_flag = false;
98                 }
99         }
100
101 private:
102         bool *m_flag;
103 };
104
105 class MapEditEventAreaIgnorer
106 {
107 public:
108         MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
109                 m_ignorevariable(ignorevariable)
110         {
111                 if(m_ignorevariable->getVolume() == 0)
112                         *m_ignorevariable = a;
113                 else
114                         m_ignorevariable = NULL;
115         }
116
117         ~MapEditEventAreaIgnorer()
118         {
119                 if(m_ignorevariable)
120                 {
121                         assert(m_ignorevariable->getVolume() != 0);
122                         *m_ignorevariable = VoxelArea();
123                 }
124         }
125
126 private:
127         VoxelArea *m_ignorevariable;
128 };
129
130 class Server;
131
132 class ServerThread : public SimpleThread
133 {
134         Server *m_server;
135
136 public:
137
138         ServerThread(Server *server):
139                 SimpleThread(),
140                 m_server(server)
141         {
142         }
143
144         void * Thread();
145 };
146
147 struct PlayerInfo
148 {
149         u16 id;
150         char name[PLAYERNAME_SIZE];
151         v3f position;
152         Address address;
153         float avg_rtt;
154
155         PlayerInfo();
156         void PrintLine(std::ostream *s);
157 };
158
159 /*
160         Used for queueing and sorting block transfers in containers
161
162         Lower priority number means higher priority.
163 */
164 struct PrioritySortedBlockTransfer
165 {
166         PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
167         {
168                 priority = a_priority;
169                 pos = a_pos;
170                 peer_id = a_peer_id;
171         }
172         bool operator < (const PrioritySortedBlockTransfer &other) const
173         {
174                 return priority < other.priority;
175         }
176         float priority;
177         v3s16 pos;
178         u16 peer_id;
179 };
180
181 struct MediaRequest
182 {
183         std::string name;
184
185         MediaRequest(const std::string &name_=""):
186                 name(name_)
187         {}
188 };
189
190 struct MediaInfo
191 {
192         std::string path;
193         std::string sha1_digest;
194
195         MediaInfo(const std::string path_="",
196                         const std::string sha1_digest_=""):
197                 path(path_),
198                 sha1_digest(sha1_digest_)
199         {
200         }
201 };
202
203 struct ServerSoundParams
204 {
205         float gain;
206         std::string to_player;
207         enum Type{
208                 SSP_LOCAL=0,
209                 SSP_POSITIONAL=1,
210                 SSP_OBJECT=2
211         } type;
212         v3f pos;
213         u16 object;
214         float max_hear_distance;
215         bool loop;
216
217         ServerSoundParams():
218                 gain(1.0),
219                 to_player(""),
220                 type(SSP_LOCAL),
221                 pos(0,0,0),
222                 object(0),
223                 max_hear_distance(32*BS),
224                 loop(false)
225         {}
226
227         v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
228 };
229
230 struct ServerPlayingSound
231 {
232         ServerSoundParams params;
233         std::set<u16> clients; // peer ids
234 };
235
236 class RemoteClient
237 {
238 public:
239         // peer_id=0 means this client has no associated peer
240         // NOTE: If client is made allowed to exist while peer doesn't,
241         //       this has to be set to 0 when there is no peer.
242         //       Also, the client must be moved to some other container.
243         u16 peer_id;
244         // The serialization version to use with the client
245         u8 serialization_version;
246         //
247         u16 net_proto_version;
248         // Version is stored in here after INIT before INIT2
249         u8 pending_serialization_version;
250
251         bool definitions_sent;
252
253         RemoteClient():
254                 m_time_from_building(9999),
255                 m_excess_gotblocks(0)
256         {
257                 peer_id = 0;
258                 serialization_version = SER_FMT_VER_INVALID;
259                 net_proto_version = 0;
260                 pending_serialization_version = SER_FMT_VER_INVALID;
261                 definitions_sent = false;
262                 m_nearest_unsent_d = 0;
263                 m_nearest_unsent_reset_timer = 0.0;
264                 m_nothing_to_send_counter = 0;
265                 m_nothing_to_send_pause_timer = 0;
266         }
267         ~RemoteClient()
268         {
269         }
270
271         /*
272                 Finds block that should be sent next to the client.
273                 Environment should be locked when this is called.
274                 dtime is used for resetting send radius at slow interval
275         */
276         void GetNextBlocks(Server *server, float dtime,
277                         std::vector<PrioritySortedBlockTransfer> &dest);
278
279         void GotBlock(v3s16 p);
280
281         void SentBlock(v3s16 p);
282
283         void SetBlockNotSent(v3s16 p);
284         void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
285
286         s32 SendingCount()
287         {
288                 return m_blocks_sending.size();
289         }
290
291         // Increments timeouts and removes timed-out blocks from list
292         // NOTE: This doesn't fix the server-not-sending-block bug
293         //       because it is related to emerging, not sending.
294         //void RunSendingTimeouts(float dtime, float timeout);
295
296         void PrintInfo(std::ostream &o)
297         {
298                 o<<"RemoteClient "<<peer_id<<": "
299                                 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
300                                 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
301                                 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
302                                 <<", m_excess_gotblocks="<<m_excess_gotblocks
303                                 <<std::endl;
304                 m_excess_gotblocks = 0;
305         }
306
307         // Time from last placing or removing blocks
308         float m_time_from_building;
309
310         /*JMutex m_dig_mutex;
311         float m_dig_time_remaining;
312         // -1 = not digging
313         s16 m_dig_tool_item;
314         v3s16 m_dig_position;*/
315
316         /*
317                 List of active objects that the client knows of.
318                 Value is dummy.
319         */
320         std::set<u16> m_known_objects;
321
322 private:
323         /*
324                 Blocks that have been sent to client.
325                 - These don't have to be sent again.
326                 - A block is cleared from here when client says it has
327                   deleted it from it's memory
328
329                 Key is position, value is dummy.
330                 No MapBlock* is stored here because the blocks can get deleted.
331         */
332         std::set<v3s16> m_blocks_sent;
333         s16 m_nearest_unsent_d;
334         v3s16 m_last_center;
335         float m_nearest_unsent_reset_timer;
336
337         /*
338                 Blocks that are currently on the line.
339                 This is used for throttling the sending of blocks.
340                 - The size of this list is limited to some value
341                 Block is added when it is sent with BLOCKDATA.
342                 Block is removed when GOTBLOCKS is received.
343                 Value is time from sending. (not used at the moment)
344         */
345         std::map<v3s16, float> m_blocks_sending;
346
347         /*
348                 Count of excess GotBlocks().
349                 There is an excess amount because the client sometimes
350                 gets a block so late that the server sends it again,
351                 and the client then sends two GOTBLOCKs.
352                 This is resetted by PrintInfo()
353         */
354         u32 m_excess_gotblocks;
355
356         // CPU usage optimization
357         u32 m_nothing_to_send_counter;
358         float m_nothing_to_send_pause_timer;
359 };
360
361 class Server : public con::PeerHandler, public MapEventReceiver,
362                 public InventoryManager, public IGameDef,
363                 public IBackgroundBlockEmerger
364 {
365 public:
366         /*
367                 NOTE: Every public method should be thread-safe
368         */
369
370         Server(
371                 const std::string &path_world,
372                 const std::string &path_config,
373                 const SubgameSpec &gamespec,
374                 bool simple_singleplayer_mode
375         );
376         ~Server();
377         void start(unsigned short port);
378         void stop();
379         // This is mainly a way to pass the time to the server.
380         // Actual processing is done in an another thread.
381         void step(float dtime);
382         // This is run by ServerThread and does the actual processing
383         void AsyncRunStep();
384         void Receive();
385         void ProcessData(u8 *data, u32 datasize, u16 peer_id);
386
387         std::list<PlayerInfo> getPlayerInfo();
388
389         // Environment must be locked when called
390         void setTimeOfDay(u32 time)
391         {
392                 m_env->setTimeOfDay(time);
393                 m_time_of_day_send_timer = 0;
394         }
395
396         bool getShutdownRequested()
397         {
398                 return m_shutdown_requested;
399         }
400
401         /*
402                 Shall be called with the environment locked.
403                 This is accessed by the map, which is inside the environment,
404                 so it shouldn't be a problem.
405         */
406         void onMapEditEvent(MapEditEvent *event);
407
408         /*
409                 Shall be called with the environment and the connection locked.
410         */
411         Inventory* getInventory(const InventoryLocation &loc);
412         void setInventoryModified(const InventoryLocation &loc);
413
414         // Connection must be locked when called
415         std::wstring getStatusString();
416
417         void requestShutdown(void)
418         {
419                 m_shutdown_requested = true;
420         }
421
422         // Returns -1 if failed, sound handle on success
423         // Envlock + conlock
424         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
425         void stopSound(s32 handle);
426
427         // Envlock + conlock
428         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
429         bool checkPriv(const std::string &name, const std::string &priv);
430         void reportPrivsModified(const std::string &name=""); // ""=all
431         void reportInventoryFormspecModified(const std::string &name);
432
433         // Saves g_settings to configpath given at initialization
434         void saveConfig();
435
436         void setIpBanned(const std::string &ip, const std::string &name)
437         {
438                 m_banmanager.add(ip, name);
439                 return;
440         }
441
442         void unsetIpBanned(const std::string &ip_or_name)
443         {
444                 m_banmanager.remove(ip_or_name);
445                 return;
446         }
447
448         std::string getBanDescription(const std::string &ip_or_name)
449         {
450                 return m_banmanager.getBanDescription(ip_or_name);
451         }
452
453         Address getPeerAddress(u16 peer_id)
454         {
455                 return m_con.GetPeerAddress(peer_id);
456         }
457
458         // Envlock and conlock should be locked when calling this
459         void notifyPlayer(const char *name, const std::wstring msg, const bool prepend);
460         void notifyPlayers(const std::wstring msg);
461         void spawnParticle(const char *playername,
462                 v3f pos, v3f velocity, v3f acceleration,
463                 float expirationtime, float size,
464                 bool collisiondetection, std::string texture);
465
466         void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
467                 float expirationtime, float size,
468                 bool collisiondetection, std::string texture);
469
470         u32 addParticleSpawner(const char *playername,
471                 u16 amount, float spawntime,
472                 v3f minpos, v3f maxpos,
473                 v3f minvel, v3f maxvel,
474                 v3f minacc, v3f maxacc,
475                 float minexptime, float maxexptime,
476                 float minsize, float maxsize,
477                 bool collisiondetection, std::string texture);
478
479         u32 addParticleSpawnerAll(u16 amount, float spawntime,
480                 v3f minpos, v3f maxpos,
481                 v3f minvel, v3f maxvel,
482                 v3f minacc, v3f maxacc,
483                 float minexptime, float maxexptime,
484                 float minsize, float maxsize,
485                 bool collisiondetection, std::string texture);
486
487         void deleteParticleSpawner(const char *playername, u32 id);
488         void deleteParticleSpawnerAll(u32 id);
489
490         void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
491
492         // Creates or resets inventory
493         Inventory* createDetachedInventory(const std::string &name);
494
495         // Envlock and conlock should be locked when using Lua
496         lua_State *getLua(){ return m_lua; }
497
498         // Envlock should be locked when using the rollback manager
499         IRollbackManager *getRollbackManager(){ return m_rollback; }
500
501         //TODO: determine what (if anything) should be locked to access EmergeManager
502         EmergeManager *getEmergeManager(){ return m_emerge; }
503
504         // actions: time-reversed list
505         // Return value: success/failure
506         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
507                         std::list<std::string> *log);
508
509         // IGameDef interface
510         // Under envlock
511         virtual IItemDefManager* getItemDefManager();
512         virtual INodeDefManager* getNodeDefManager();
513         virtual ICraftDefManager* getCraftDefManager();
514         virtual ITextureSource* getTextureSource();
515         virtual IShaderSource* getShaderSource();
516         virtual u16 allocateUnknownNodeId(const std::string &name);
517         virtual ISoundManager* getSoundManager();
518         virtual MtEventManager* getEventManager();
519         virtual IRollbackReportSink* getRollbackReportSink();
520
521         IWritableItemDefManager* getWritableItemDefManager();
522         IWritableNodeDefManager* getWritableNodeDefManager();
523         IWritableCraftDefManager* getWritableCraftDefManager();
524
525         const ModSpec* getModSpec(const std::string &modname);
526         void getModNames(std::list<std::string> &modlist);
527         std::string getBuiltinLuaPath();
528
529         std::string getWorldPath(){ return m_path_world; }
530
531         bool isSingleplayer(){ return m_simple_singleplayer_mode; }
532
533         void setAsyncFatalError(const std::string &error)
534         {
535                 m_async_fatal_error.set(error);
536         }
537
538         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
539         
540         u32 hudAdd(Player *player, HudElement *element);
541         bool hudRemove(Player *player, u32 id);
542         bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
543         bool hudSetFlags(Player *player, u32 flags, u32 mask);
544         
545 private:
546
547         // con::PeerHandler implementation.
548         // These queue stuff to be processed by handlePeerChanges().
549         // As of now, these create and remove clients and players.
550         void peerAdded(con::Peer *peer);
551         void deletingPeer(con::Peer *peer, bool timeout);
552
553         /*
554                 Static send methods
555         */
556
557         static void SendMovement(con::Connection &con, u16 peer_id);
558         static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
559         static void SendAccessDenied(con::Connection &con, u16 peer_id,
560                         const std::wstring &reason);
561         static void SendDeathscreen(con::Connection &con, u16 peer_id,
562                         bool set_camera_point_target, v3f camera_point_target);
563         static void SendItemDef(con::Connection &con, u16 peer_id,
564                         IItemDefManager *itemdef, u16 protocol_version);
565         static void SendNodeDef(con::Connection &con, u16 peer_id,
566                         INodeDefManager *nodedef, u16 protocol_version);
567
568         /*
569                 Non-static send methods.
570                 Conlock should be always used.
571                 Envlock usage is documented badly but it's easy to figure out
572                 which ones access the environment.
573         */
574
575         // Envlock and conlock should be locked when calling these
576         void SendInventory(u16 peer_id);
577         void SendChatMessage(u16 peer_id, const std::wstring &message);
578         void BroadcastChatMessage(const std::wstring &message);
579         void SendPlayerHP(u16 peer_id);
580         void SendMovePlayer(u16 peer_id);
581         void SendPlayerPrivileges(u16 peer_id);
582         void SendPlayerInventoryFormspec(u16 peer_id);
583         void SendShowFormspecMessage(u16 peer_id, const std::string formspec, const std::string formname);
584         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
585         void SendHUDRemove(u16 peer_id, u32 id);
586         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
587         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
588         
589         /*
590                 Send a node removal/addition event to all clients except ignore_id.
591                 Additionally, if far_players!=NULL, players further away than
592                 far_d_nodes are ignored and their peer_ids are added to far_players
593         */
594         // Envlock and conlock should be locked when calling these
595         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
596                         std::list<u16> *far_players=NULL, float far_d_nodes=100);
597         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
598                         std::list<u16> *far_players=NULL, float far_d_nodes=100);
599         void setBlockNotSent(v3s16 p);
600
601         // Environment and Connection must be locked when called
602         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
603
604         // Sends blocks to clients (locks env and con on its own)
605         void SendBlocks(float dtime);
606
607         void fillMediaCache();
608         void sendMediaAnnouncement(u16 peer_id);
609         void sendRequestedMedia(u16 peer_id,
610                         const std::list<MediaRequest> &tosend);
611
612         void sendDetachedInventory(const std::string &name, u16 peer_id);
613         void sendDetachedInventoryToAll(const std::string &name);
614         void sendDetachedInventories(u16 peer_id);
615
616         // Adds a ParticleSpawner on peer with peer_id
617         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
618                 v3f minpos, v3f maxpos,
619                 v3f minvel, v3f maxvel,
620                 v3f minacc, v3f maxacc,
621                 float minexptime, float maxexptime,
622                 float minsize, float maxsize,
623                 bool collisiondetection, std::string texture, u32 id);
624
625         // Adds a ParticleSpawner on all peers
626         void SendAddParticleSpawnerAll(u16 amount, float spawntime,
627                 v3f minpos, v3f maxpos,
628                 v3f minvel, v3f maxvel,
629                 v3f minacc, v3f maxacc,
630                 float minexptime, float maxexptime,
631                 float minsize, float maxsize,
632                 bool collisiondetection, std::string texture, u32 id);
633
634         // Deletes ParticleSpawner on a single client
635         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
636
637         // Deletes ParticleSpawner on all clients
638         void SendDeleteParticleSpawnerAll(u32 id);
639
640         // Spawns particle on single client
641         void SendSpawnParticle(u16 peer_id,
642                 v3f pos, v3f velocity, v3f acceleration,
643                 float expirationtime, float size,
644                 bool collisiondetection, std::string texture);
645
646         // Spawns particle on all clients
647         void SendSpawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
648                 float expirationtime, float size,
649                 bool collisiondetection, std::string texture);
650
651         /*
652                 Something random
653         */
654
655         void DiePlayer(u16 peer_id);
656         void RespawnPlayer(u16 peer_id);
657
658         void UpdateCrafting(u16 peer_id);
659
660         // When called, connection mutex should be locked
661         RemoteClient* getClient(u16 peer_id);
662
663         // When called, environment mutex should be locked
664         std::string getPlayerName(u16 peer_id)
665         {
666                 Player *player = m_env->getPlayer(peer_id);
667                 if(player == NULL)
668                         return "[id="+itos(peer_id)+"]";
669                 return player->getName();
670         }
671
672         // When called, environment mutex should be locked
673         PlayerSAO* getPlayerSAO(u16 peer_id)
674         {
675                 Player *player = m_env->getPlayer(peer_id);
676                 if(player == NULL)
677                         return NULL;
678                 return player->getPlayerSAO();
679         }
680
681         /*
682                 Get a player from memory or creates one.
683                 If player is already connected, return NULL
684                 Does not verify/modify auth info and password.
685
686                 Call with env and con locked.
687         */
688         PlayerSAO *emergePlayer(const char *name, u16 peer_id);
689
690         // Locks environment and connection by its own
691         struct PeerChange;
692         void handlePeerChange(PeerChange &c);
693         void handlePeerChanges();
694
695         /*
696                 Variables
697         */
698
699         // World directory
700         std::string m_path_world;
701         // Path to user's configuration file ("" = no configuration file)
702         std::string m_path_config;
703         // Subgame specification
704         SubgameSpec m_gamespec;
705         // If true, do not allow multiple players and hide some multiplayer
706         // functionality
707         bool m_simple_singleplayer_mode;
708
709         // Thread can set; step() will throw as ServerError
710         MutexedVariable<std::string> m_async_fatal_error;
711
712         // Some timers
713         float m_liquid_transform_timer;
714         float m_liquid_transform_every;
715         float m_print_info_timer;
716         float m_masterserver_timer;
717         float m_objectdata_timer;
718         float m_emergethread_trigger_timer;
719         float m_savemap_timer;
720         IntervalLimiter m_map_timer_and_unload_interval;
721
722         // NOTE: If connection and environment are both to be locked,
723         // environment shall be locked first.
724
725         // Environment
726         ServerEnvironment *m_env;
727         JMutex m_env_mutex;
728
729         // Connection
730         con::Connection m_con;
731         JMutex m_con_mutex;
732         // Connected clients (behind the con mutex)
733         std::map<u16, RemoteClient*> m_clients;
734         u16 m_clients_number; //for announcing masterserver
735
736         // Bann checking
737         BanManager m_banmanager;
738
739         // Rollback manager (behind m_env_mutex)
740         IRollbackManager *m_rollback;
741         bool m_rollback_sink_enabled;
742         bool m_enable_rollback_recording; // Updated once in a while
743
744         // Emerge manager
745         EmergeManager *m_emerge;
746
747         // Scripting
748         // Envlock and conlock should be locked when using Lua
749         lua_State *m_lua;
750
751         // Item definition manager
752         IWritableItemDefManager *m_itemdef;
753
754         // Node definition manager
755         IWritableNodeDefManager *m_nodedef;
756
757         // Craft definition manager
758         IWritableCraftDefManager *m_craftdef;
759
760         // Event manager
761         EventManager *m_event;
762
763         // Mods
764         std::vector<ModSpec> m_mods;
765
766         /*
767                 Threads
768         */
769
770         // A buffer for time steps
771         // step() increments and AsyncRunStep() run by m_thread reads it.
772         float m_step_dtime;
773         JMutex m_step_dtime_mutex;
774
775         // The server mainly operates in this thread
776         ServerThread m_thread;
777
778         /*
779                 Time related stuff
780         */
781
782         // Timer for sending time of day over network
783         float m_time_of_day_send_timer;
784         // Uptime of server in seconds
785         MutexedVariable<double> m_uptime;
786
787         /*
788                 Peer change queue.
789                 Queues stuff from peerAdded() and deletingPeer() to
790                 handlePeerChanges()
791         */
792         enum PeerChangeType
793         {
794                 PEER_ADDED,
795                 PEER_REMOVED
796         };
797         struct PeerChange
798         {
799                 PeerChangeType type;
800                 u16 peer_id;
801                 bool timeout;
802         };
803         Queue<PeerChange> m_peer_change_queue;
804
805         /*
806                 Random stuff
807         */
808
809         // Mod parent directory paths
810         std::list<std::string> m_modspaths;
811
812         bool m_shutdown_requested;
813
814         /*
815                 Map edit event queue. Automatically receives all map edits.
816                 The constructor of this class registers us to receive them through
817                 onMapEditEvent
818
819                 NOTE: Should these be moved to actually be members of
820                 ServerEnvironment?
821         */
822
823         /*
824                 Queue of map edits from the environment for sending to the clients
825                 This is behind m_env_mutex
826         */
827         Queue<MapEditEvent*> m_unsent_map_edit_queue;
828         /*
829                 Set to true when the server itself is modifying the map and does
830                 all sending of information by itself.
831                 This is behind m_env_mutex
832         */
833         bool m_ignore_map_edit_events;
834         /*
835                 If a non-empty area, map edit events contained within are left
836                 unsent. Done at map generation time to speed up editing of the
837                 generated area, as it will be sent anyway.
838                 This is behind m_env_mutex
839         */
840         VoxelArea m_ignore_map_edit_events_area;
841         /*
842                 If set to !=0, the incoming MapEditEvents are modified to have
843                 this peed id as the disabled recipient
844                 This is behind m_env_mutex
845         */
846         u16 m_ignore_map_edit_events_peer_id;
847
848         friend class EmergeThread;
849         friend class RemoteClient;
850
851         std::map<std::string,MediaInfo> m_media;
852
853         /*
854                 Sounds
855         */
856         std::map<s32, ServerPlayingSound> m_playing_sounds;
857         s32 m_next_sound_id;
858
859         /*
860                 Detached inventories (behind m_env_mutex)
861         */
862         // key = name
863         std::map<std::string, Inventory*> m_detached_inventories;
864
865         /*
866                 Particles
867         */
868         std::vector<u32> m_particlespawner_ids;
869 };
870
871 /*
872         Runs a simple dedicated server loop.
873
874         Shuts down when run is set to false.
875 */
876 void dedicated_server_loop(Server &server, bool &run);
877
878 #endif
879