3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
23 #include "connection.h"
24 #include "environment.h"
25 #include "irrlichttypes_bloated.h"
29 #include "inventory.h"
32 #include "serialization.h" // For SER_FMT_VER_INVALID
34 #include "inventorymanager.h"
37 #include "util/thread.h"
38 #include "util/string.h"
41 typedef struct lua_State lua_State;
42 class IWritableItemDefManager;
43 class IWritableNodeDefManager;
44 class IWritableCraftDefManager;
48 class ServerError : public std::exception
51 ServerError(const std::string &s)
53 m_s = "ServerError: ";
56 virtual ~ServerError() throw()
58 virtual const char * what() const throw()
68 v3f findSpawnPos(ServerMap &map);
71 A structure containing the data needed for queueing the fetching
74 struct QueuedBlockEmerge
77 // key = peer_id, value = flags
78 core::map<u16, u8> peer_ids;
82 This is a thread-safe class.
84 class BlockEmergeQueue
94 JMutexAutoLock lock(m_mutex);
96 core::list<QueuedBlockEmerge*>::Iterator i;
97 for(i=m_queue.begin(); i!=m_queue.end(); i++)
99 QueuedBlockEmerge *q = *i;
105 peer_id=0 adds with nobody to send to
107 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
109 DSTACK(__FUNCTION_NAME);
111 JMutexAutoLock lock(m_mutex);
116 Find if block is already in queue.
117 If it is, update the peer to it and quit.
119 core::list<QueuedBlockEmerge*>::Iterator i;
120 for(i=m_queue.begin(); i!=m_queue.end(); i++)
122 QueuedBlockEmerge *q = *i;
125 q->peer_ids[peer_id] = flags;
134 QueuedBlockEmerge *q = new QueuedBlockEmerge;
137 q->peer_ids[peer_id] = flags;
138 m_queue.push_back(q);
141 // Returned pointer must be deleted
142 // Returns NULL if queue is empty
143 QueuedBlockEmerge * pop()
145 JMutexAutoLock lock(m_mutex);
147 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
148 if(i == m_queue.end())
150 QueuedBlockEmerge *q = *i;
157 JMutexAutoLock lock(m_mutex);
158 return m_queue.size();
161 u32 peerItemCount(u16 peer_id)
163 JMutexAutoLock lock(m_mutex);
167 core::list<QueuedBlockEmerge*>::Iterator i;
168 for(i=m_queue.begin(); i!=m_queue.end(); i++)
170 QueuedBlockEmerge *q = *i;
171 if(q->peer_ids.find(peer_id) != NULL)
179 core::list<QueuedBlockEmerge*> m_queue;
185 class ServerThread : public SimpleThread
191 ServerThread(Server *server):
200 class EmergeThread : public SimpleThread
206 EmergeThread(Server *server):
217 if(IsRunning() == false)
227 char name[PLAYERNAME_SIZE];
233 void PrintLine(std::ostream *s);
237 Used for queueing and sorting block transfers in containers
239 Lower priority number means higher priority.
241 struct PrioritySortedBlockTransfer
243 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
245 priority = a_priority;
249 bool operator < (PrioritySortedBlockTransfer &other)
251 return priority < other.priority;
262 MediaRequest(const std::string &name_=""):
270 std::string sha1_digest;
272 MediaInfo(const std::string path_="",
273 const std::string sha1_digest_=""):
275 sha1_digest(sha1_digest_)
280 struct ServerSoundParams
283 std::string to_player;
291 float max_hear_distance;
300 max_hear_distance(32*BS),
304 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
307 struct ServerPlayingSound
309 ServerSoundParams params;
310 std::set<u16> clients; // peer ids
316 // peer_id=0 means this client has no associated peer
317 // NOTE: If client is made allowed to exist while peer doesn't,
318 // this has to be set to 0 when there is no peer.
319 // Also, the client must be moved to some other container.
321 // The serialization version to use with the client
322 u8 serialization_version;
324 u16 net_proto_version;
325 // Version is stored in here after INIT before INIT2
326 u8 pending_serialization_version;
328 bool definitions_sent;
331 m_time_from_building(9999),
332 m_excess_gotblocks(0)
335 serialization_version = SER_FMT_VER_INVALID;
336 net_proto_version = 0;
337 pending_serialization_version = SER_FMT_VER_INVALID;
338 definitions_sent = false;
339 m_nearest_unsent_d = 0;
340 m_nearest_unsent_reset_timer = 0.0;
341 m_nothing_to_send_counter = 0;
342 m_nothing_to_send_pause_timer = 0;
349 Finds block that should be sent next to the client.
350 Environment should be locked when this is called.
351 dtime is used for resetting send radius at slow interval
353 void GetNextBlocks(Server *server, float dtime,
354 core::array<PrioritySortedBlockTransfer> &dest);
356 void GotBlock(v3s16 p);
358 void SentBlock(v3s16 p);
360 void SetBlockNotSent(v3s16 p);
361 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
365 return m_blocks_sending.size();
368 // Increments timeouts and removes timed-out blocks from list
369 // NOTE: This doesn't fix the server-not-sending-block bug
370 // because it is related to emerging, not sending.
371 //void RunSendingTimeouts(float dtime, float timeout);
373 void PrintInfo(std::ostream &o)
375 o<<"RemoteClient "<<peer_id<<": "
376 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
377 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
378 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
379 <<", m_excess_gotblocks="<<m_excess_gotblocks
381 m_excess_gotblocks = 0;
384 // Time from last placing or removing blocks
385 float m_time_from_building;
387 /*JMutex m_dig_mutex;
388 float m_dig_time_remaining;
391 v3s16 m_dig_position;*/
394 List of active objects that the client knows of.
397 core::map<u16, bool> m_known_objects;
401 Blocks that have been sent to client.
402 - These don't have to be sent again.
403 - A block is cleared from here when client says it has
404 deleted it from it's memory
406 Key is position, value is dummy.
407 No MapBlock* is stored here because the blocks can get deleted.
409 core::map<v3s16, bool> m_blocks_sent;
410 s16 m_nearest_unsent_d;
412 float m_nearest_unsent_reset_timer;
415 Blocks that are currently on the line.
416 This is used for throttling the sending of blocks.
417 - The size of this list is limited to some value
418 Block is added when it is sent with BLOCKDATA.
419 Block is removed when GOTBLOCKS is received.
420 Value is time from sending. (not used at the moment)
422 core::map<v3s16, float> m_blocks_sending;
425 Count of excess GotBlocks().
426 There is an excess amount because the client sometimes
427 gets a block so late that the server sends it again,
428 and the client then sends two GOTBLOCKs.
429 This is resetted by PrintInfo()
431 u32 m_excess_gotblocks;
433 // CPU usage optimization
434 u32 m_nothing_to_send_counter;
435 float m_nothing_to_send_pause_timer;
438 class Server : public con::PeerHandler, public MapEventReceiver,
439 public InventoryManager, public IGameDef,
440 public IBackgroundBlockEmerger
444 NOTE: Every public method should be thread-safe
448 const std::string &path_world,
449 const std::string &path_config,
450 const SubgameSpec &gamespec,
451 bool simple_singleplayer_mode
454 void start(unsigned short port);
456 // This is mainly a way to pass the time to the server.
457 // Actual processing is done in an another thread.
458 void step(float dtime);
459 // This is run by ServerThread and does the actual processing
462 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
464 core::list<PlayerInfo> getPlayerInfo();
466 // Environment must be locked when called
467 void setTimeOfDay(u32 time)
469 m_env->setTimeOfDay(time);
470 m_time_of_day_send_timer = 0;
473 bool getShutdownRequested()
475 return m_shutdown_requested;
479 Shall be called with the environment locked.
480 This is accessed by the map, which is inside the environment,
481 so it shouldn't be a problem.
483 void onMapEditEvent(MapEditEvent *event);
486 Shall be called with the environment and the connection locked.
488 Inventory* getInventory(const InventoryLocation &loc);
489 void setInventoryModified(const InventoryLocation &loc);
491 // Connection must be locked when called
492 std::wstring getStatusString();
494 void requestShutdown(void)
496 m_shutdown_requested = true;
499 // Returns -1 if failed, sound handle on success
501 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
502 void stopSound(s32 handle);
505 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
506 bool checkPriv(const std::string &name, const std::string &priv);
507 void reportPrivsModified(const std::string &name=""); // ""=all
508 void reportInventoryFormspecModified(const std::string &name);
510 // Saves g_settings to configpath given at initialization
513 void setIpBanned(const std::string &ip, const std::string &name)
515 m_banmanager.add(ip, name);
519 void unsetIpBanned(const std::string &ip_or_name)
521 m_banmanager.remove(ip_or_name);
525 std::string getBanDescription(const std::string &ip_or_name)
527 return m_banmanager.getBanDescription(ip_or_name);
530 Address getPeerAddress(u16 peer_id)
532 return m_con.GetPeerAddress(peer_id);
535 // Envlock and conlock should be locked when calling this
536 void notifyPlayer(const char *name, const std::wstring msg);
537 void notifyPlayers(const std::wstring msg);
539 void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
541 // Creates or resets inventory
542 Inventory* createDetachedInventory(const std::string &name);
544 // Envlock and conlock should be locked when using Lua
545 lua_State *getLua(){ return m_lua; }
547 // IGameDef interface
549 virtual IItemDefManager* getItemDefManager();
550 virtual INodeDefManager* getNodeDefManager();
551 virtual ICraftDefManager* getCraftDefManager();
552 virtual ITextureSource* getTextureSource();
553 virtual u16 allocateUnknownNodeId(const std::string &name);
554 virtual ISoundManager* getSoundManager();
555 virtual MtEventManager* getEventManager();
557 IWritableItemDefManager* getWritableItemDefManager();
558 IWritableNodeDefManager* getWritableNodeDefManager();
559 IWritableCraftDefManager* getWritableCraftDefManager();
561 const ModSpec* getModSpec(const std::string &modname);
562 void getModNames(core::list<std::string> &modlist);
563 std::string getBuiltinLuaPath();
565 std::string getWorldPath(){ return m_path_world; }
567 bool isSingleplayer(){ return m_simple_singleplayer_mode; }
569 void setAsyncFatalError(const std::string &error)
571 m_async_fatal_error.set(error);
576 // con::PeerHandler implementation.
577 // These queue stuff to be processed by handlePeerChanges().
578 // As of now, these create and remove clients and players.
579 void peerAdded(con::Peer *peer);
580 void deletingPeer(con::Peer *peer, bool timeout);
586 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
587 static void SendAccessDenied(con::Connection &con, u16 peer_id,
588 const std::wstring &reason);
589 static void SendDeathscreen(con::Connection &con, u16 peer_id,
590 bool set_camera_point_target, v3f camera_point_target);
591 static void SendItemDef(con::Connection &con, u16 peer_id,
592 IItemDefManager *itemdef);
593 static void SendNodeDef(con::Connection &con, u16 peer_id,
594 INodeDefManager *nodedef);
597 Non-static send methods.
598 Conlock should be always used.
599 Envlock usage is documented badly but it's easy to figure out
600 which ones access the environment.
603 // Envlock and conlock should be locked when calling these
604 void SendInventory(u16 peer_id);
605 void SendChatMessage(u16 peer_id, const std::wstring &message);
606 void BroadcastChatMessage(const std::wstring &message);
607 void SendPlayerHP(u16 peer_id);
608 void SendMovePlayer(u16 peer_id);
609 void SendPlayerPrivileges(u16 peer_id);
610 void SendPlayerInventoryFormspec(u16 peer_id);
612 Send a node removal/addition event to all clients except ignore_id.
613 Additionally, if far_players!=NULL, players further away than
614 far_d_nodes are ignored and their peer_ids are added to far_players
616 // Envlock and conlock should be locked when calling these
617 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
618 core::list<u16> *far_players=NULL, float far_d_nodes=100);
619 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
620 core::list<u16> *far_players=NULL, float far_d_nodes=100);
621 void setBlockNotSent(v3s16 p);
623 // Environment and Connection must be locked when called
624 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
626 // Sends blocks to clients (locks env and con on its own)
627 void SendBlocks(float dtime);
629 void fillMediaCache();
630 void sendMediaAnnouncement(u16 peer_id);
631 void sendRequestedMedia(u16 peer_id,
632 const core::list<MediaRequest> &tosend);
634 void sendDetachedInventory(const std::string &name, u16 peer_id);
635 void sendDetachedInventoryToAll(const std::string &name);
636 void sendDetachedInventories(u16 peer_id);
642 void DiePlayer(u16 peer_id);
643 void RespawnPlayer(u16 peer_id);
645 void UpdateCrafting(u16 peer_id);
647 // When called, connection mutex should be locked
648 RemoteClient* getClient(u16 peer_id);
650 // When called, environment mutex should be locked
651 std::string getPlayerName(u16 peer_id)
653 Player *player = m_env->getPlayer(peer_id);
655 return "[id="+itos(peer_id)+"]";
656 return player->getName();
659 // When called, environment mutex should be locked
660 PlayerSAO* getPlayerSAO(u16 peer_id)
662 Player *player = m_env->getPlayer(peer_id);
665 return player->getPlayerSAO();
669 Get a player from memory or creates one.
670 If player is already connected, return NULL
671 Does not verify/modify auth info and password.
673 Call with env and con locked.
675 PlayerSAO *emergePlayer(const char *name, u16 peer_id);
677 // Locks environment and connection by its own
679 void handlePeerChange(PeerChange &c);
680 void handlePeerChanges();
687 std::string m_path_world;
688 // Path to user's configuration file ("" = no configuration file)
689 std::string m_path_config;
690 // Subgame specification
691 SubgameSpec m_gamespec;
692 // If true, do not allow multiple players and hide some multiplayer
694 bool m_simple_singleplayer_mode;
696 // Thread can set; step() will throw as ServerError
697 MutexedVariable<std::string> m_async_fatal_error;
700 float m_liquid_transform_timer;
701 float m_print_info_timer;
702 float m_objectdata_timer;
703 float m_emergethread_trigger_timer;
704 float m_savemap_timer;
705 IntervalLimiter m_map_timer_and_unload_interval;
707 // NOTE: If connection and environment are both to be locked,
708 // environment shall be locked first.
711 ServerEnvironment *m_env;
715 con::Connection m_con;
717 // Connected clients (behind the con mutex)
718 core::map<u16, RemoteClient*> m_clients;
721 BanManager m_banmanager;
724 // Envlock and conlock should be locked when using Lua
727 // Item definition manager
728 IWritableItemDefManager *m_itemdef;
730 // Node definition manager
731 IWritableNodeDefManager *m_nodedef;
733 // Craft definition manager
734 IWritableCraftDefManager *m_craftdef;
737 EventManager *m_event;
740 core::list<ModSpec> m_mods;
746 // A buffer for time steps
747 // step() increments and AsyncRunStep() run by m_thread reads it.
749 JMutex m_step_dtime_mutex;
751 // The server mainly operates in this thread
752 ServerThread m_thread;
753 // This thread fetches and generates map
754 EmergeThread m_emergethread;
755 // Queue of block coordinates to be processed by the emerge thread
756 BlockEmergeQueue m_emerge_queue;
762 // Timer for sending time of day over network
763 float m_time_of_day_send_timer;
764 // Uptime of server in seconds
765 MutexedVariable<double> m_uptime;
769 Queues stuff from peerAdded() and deletingPeer() to
783 Queue<PeerChange> m_peer_change_queue;
789 // Mod parent directory paths
790 core::list<std::string> m_modspaths;
792 bool m_shutdown_requested;
795 Map edit event queue. Automatically receives all map edits.
796 The constructor of this class registers us to receive them through
799 NOTE: Should these be moved to actually be members of
804 Queue of map edits from the environment for sending to the clients
805 This is behind m_env_mutex
807 Queue<MapEditEvent*> m_unsent_map_edit_queue;
809 Set to true when the server itself is modifying the map and does
810 all sending of information by itself.
811 This is behind m_env_mutex
813 bool m_ignore_map_edit_events;
815 If a non-empty area, map edit events contained within are left
816 unsent. Done at map generation time to speed up editing of the
817 generated area, as it will be sent anyway.
818 This is behind m_env_mutex
820 VoxelArea m_ignore_map_edit_events_area;
822 If set to !=0, the incoming MapEditEvents are modified to have
823 this peed id as the disabled recipient
824 This is behind m_env_mutex
826 u16 m_ignore_map_edit_events_peer_id;
828 friend class EmergeThread;
829 friend class RemoteClient;
831 std::map<std::string,MediaInfo> m_media;
836 std::map<s32, ServerPlayingSound> m_playing_sounds;
840 Detached inventories (behind m_env_mutex)
843 std::map<std::string, Inventory*> m_detached_inventories;
847 Runs a simple dedicated server loop.
849 Shuts down when run is set to false.
851 void dedicated_server_loop(Server &server, bool &run);