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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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 "common_irrlicht.h"
29 #include "inventory.h"
33 #include "serialization.h" // For SER_FMT_VER_INVALID
35 #include "inventorymanager.h"
39 typedef struct lua_State lua_State;
40 class IWritableItemDefManager;
41 class IWritableNodeDefManager;
42 class IWritableCraftDefManager;
46 class ServerError : public std::exception
49 ServerError(const std::string &s)
51 m_s = "ServerError: ";
54 virtual ~ServerError() throw()
56 virtual const char * what() const throw()
66 v3f findSpawnPos(ServerMap &map);
69 A structure containing the data needed for queueing the fetching
72 struct QueuedBlockEmerge
75 // key = peer_id, value = flags
76 core::map<u16, u8> peer_ids;
80 This is a thread-safe class.
82 class BlockEmergeQueue
92 JMutexAutoLock lock(m_mutex);
94 core::list<QueuedBlockEmerge*>::Iterator i;
95 for(i=m_queue.begin(); i!=m_queue.end(); i++)
97 QueuedBlockEmerge *q = *i;
103 peer_id=0 adds with nobody to send to
105 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
107 DSTACK(__FUNCTION_NAME);
109 JMutexAutoLock lock(m_mutex);
114 Find if block is already in queue.
115 If it is, update the peer to it and quit.
117 core::list<QueuedBlockEmerge*>::Iterator i;
118 for(i=m_queue.begin(); i!=m_queue.end(); i++)
120 QueuedBlockEmerge *q = *i;
123 q->peer_ids[peer_id] = flags;
132 QueuedBlockEmerge *q = new QueuedBlockEmerge;
135 q->peer_ids[peer_id] = flags;
136 m_queue.push_back(q);
139 // Returned pointer must be deleted
140 // Returns NULL if queue is empty
141 QueuedBlockEmerge * pop()
143 JMutexAutoLock lock(m_mutex);
145 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
146 if(i == m_queue.end())
148 QueuedBlockEmerge *q = *i;
155 JMutexAutoLock lock(m_mutex);
156 return m_queue.size();
159 u32 peerItemCount(u16 peer_id)
161 JMutexAutoLock lock(m_mutex);
165 core::list<QueuedBlockEmerge*>::Iterator i;
166 for(i=m_queue.begin(); i!=m_queue.end(); i++)
168 QueuedBlockEmerge *q = *i;
169 if(q->peer_ids.find(peer_id) != NULL)
177 core::list<QueuedBlockEmerge*> m_queue;
183 class ServerThread : public SimpleThread
189 ServerThread(Server *server):
198 class EmergeThread : public SimpleThread
204 EmergeThread(Server *server):
215 if(IsRunning() == false)
225 char name[PLAYERNAME_SIZE];
231 void PrintLine(std::ostream *s);
235 Used for queueing and sorting block transfers in containers
237 Lower priority number means higher priority.
239 struct PrioritySortedBlockTransfer
241 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
243 priority = a_priority;
247 bool operator < (PrioritySortedBlockTransfer &other)
249 return priority < other.priority;
260 MediaRequest(const std::string &name_=""):
268 std::string sha1_digest;
270 MediaInfo(const std::string path_="",
271 const std::string sha1_digest_=""):
273 sha1_digest(sha1_digest_)
278 struct ServerSoundParams
281 std::string to_player;
289 float max_hear_distance;
298 max_hear_distance(32*BS),
302 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
305 struct ServerPlayingSound
307 ServerSoundParams params;
308 std::set<u16> clients; // peer ids
314 // peer_id=0 means this client has no associated peer
315 // NOTE: If client is made allowed to exist while peer doesn't,
316 // this has to be set to 0 when there is no peer.
317 // Also, the client must be moved to some other container.
319 // The serialization version to use with the client
320 u8 serialization_version;
322 u16 net_proto_version;
323 // Version is stored in here after INIT before INIT2
324 u8 pending_serialization_version;
326 bool definitions_sent;
329 m_time_from_building(9999),
330 m_excess_gotblocks(0)
333 serialization_version = SER_FMT_VER_INVALID;
334 net_proto_version = 0;
335 pending_serialization_version = SER_FMT_VER_INVALID;
336 definitions_sent = false;
337 m_nearest_unsent_d = 0;
338 m_nearest_unsent_reset_timer = 0.0;
339 m_nothing_to_send_counter = 0;
340 m_nothing_to_send_pause_timer = 0;
347 Finds block that should be sent next to the client.
348 Environment should be locked when this is called.
349 dtime is used for resetting send radius at slow interval
351 void GetNextBlocks(Server *server, float dtime,
352 core::array<PrioritySortedBlockTransfer> &dest);
354 void GotBlock(v3s16 p);
356 void SentBlock(v3s16 p);
358 void SetBlockNotSent(v3s16 p);
359 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
363 return m_blocks_sending.size();
366 // Increments timeouts and removes timed-out blocks from list
367 // NOTE: This doesn't fix the server-not-sending-block bug
368 // because it is related to emerging, not sending.
369 //void RunSendingTimeouts(float dtime, float timeout);
371 void PrintInfo(std::ostream &o)
373 o<<"RemoteClient "<<peer_id<<": "
374 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
375 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
376 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
377 <<", m_excess_gotblocks="<<m_excess_gotblocks
379 m_excess_gotblocks = 0;
382 // Time from last placing or removing blocks
383 float m_time_from_building;
385 /*JMutex m_dig_mutex;
386 float m_dig_time_remaining;
389 v3s16 m_dig_position;*/
392 List of active objects that the client knows of.
395 core::map<u16, bool> m_known_objects;
399 Blocks that have been sent to client.
400 - These don't have to be sent again.
401 - A block is cleared from here when client says it has
402 deleted it from it's memory
404 Key is position, value is dummy.
405 No MapBlock* is stored here because the blocks can get deleted.
407 core::map<v3s16, bool> m_blocks_sent;
408 s16 m_nearest_unsent_d;
410 float m_nearest_unsent_reset_timer;
413 Blocks that are currently on the line.
414 This is used for throttling the sending of blocks.
415 - The size of this list is limited to some value
416 Block is added when it is sent with BLOCKDATA.
417 Block is removed when GOTBLOCKS is received.
418 Value is time from sending. (not used at the moment)
420 core::map<v3s16, float> m_blocks_sending;
423 Count of excess GotBlocks().
424 There is an excess amount because the client sometimes
425 gets a block so late that the server sends it again,
426 and the client then sends two GOTBLOCKs.
427 This is resetted by PrintInfo()
429 u32 m_excess_gotblocks;
431 // CPU usage optimization
432 u32 m_nothing_to_send_counter;
433 float m_nothing_to_send_pause_timer;
436 class Server : public con::PeerHandler, public MapEventReceiver,
437 public InventoryManager, public IGameDef,
438 public IBackgroundBlockEmerger
442 NOTE: Every public method should be thread-safe
446 const std::string &path_world,
447 const std::string &path_config,
448 const SubgameSpec &gamespec,
449 bool simple_singleplayer_mode
452 void start(unsigned short port);
454 // This is mainly a way to pass the time to the server.
455 // Actual processing is done in an another thread.
456 void step(float dtime);
457 // This is run by ServerThread and does the actual processing
460 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
462 core::list<PlayerInfo> getPlayerInfo();
464 // Environment must be locked when called
465 void setTimeOfDay(u32 time)
467 m_env->setTimeOfDay(time);
468 m_time_of_day_send_timer = 0;
471 bool getShutdownRequested()
473 return m_shutdown_requested;
477 Shall be called with the environment locked.
478 This is accessed by the map, which is inside the environment,
479 so it shouldn't be a problem.
481 void onMapEditEvent(MapEditEvent *event);
484 Shall be called with the environment and the connection locked.
486 Inventory* getInventory(const InventoryLocation &loc);
487 std::string getInventoryOwner(const InventoryLocation &loc);
488 void setInventoryModified(const InventoryLocation &loc);
490 // Connection must be locked when called
491 std::wstring getStatusString();
493 void requestShutdown(void)
495 m_shutdown_requested = true;
498 // Returns -1 if failed, sound handle on success
500 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
501 void stopSound(s32 handle);
504 u64 getPlayerAuthPrivs(const std::string &name);
505 void setPlayerAuthPrivs(const std::string &name, u64 privs);
506 u64 getPlayerEffectivePrivs(const std::string &name);
508 // Changes a player's password, password must be given as plaintext
509 // If the player doesn't exist, a new entry is added to the auth manager
510 void setPlayerPassword(const std::string &name, const std::wstring &password);
512 // Saves g_settings to configpath given at initialization
515 void setIpBanned(const std::string &ip, const std::string &name)
517 m_banmanager.add(ip, name);
521 void unsetIpBanned(const std::string &ip_or_name)
523 m_banmanager.remove(ip_or_name);
527 std::string getBanDescription(const std::string &ip_or_name)
529 return m_banmanager.getBanDescription(ip_or_name);
532 Address getPeerAddress(u16 peer_id)
534 return m_con.GetPeerAddress(peer_id);
537 // Envlock and conlock should be locked when calling this
538 void notifyPlayer(const char *name, const std::wstring msg);
539 void notifyPlayers(const std::wstring msg);
541 void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
543 // Envlock and conlock should be locked when using Lua
544 lua_State *getLua(){ return m_lua; }
546 // IGameDef interface
548 virtual IItemDefManager* getItemDefManager();
549 virtual INodeDefManager* getNodeDefManager();
550 virtual ICraftDefManager* getCraftDefManager();
551 virtual ITextureSource* getTextureSource();
552 virtual u16 allocateUnknownNodeId(const std::string &name);
553 virtual ISoundManager* getSoundManager();
554 virtual MtEventManager* getEventManager();
556 IWritableItemDefManager* getWritableItemDefManager();
557 IWritableNodeDefManager* getWritableNodeDefManager();
558 IWritableCraftDefManager* getWritableCraftDefManager();
560 const ModSpec* getModSpec(const std::string &modname);
562 std::string getWorldPath(){ return m_path_world; }
564 bool isSingleplayer(){ return m_simple_singleplayer_mode; }
566 void setAsyncFatalError(const std::string &error)
568 m_async_fatal_error.set(error);
573 // con::PeerHandler implementation.
574 // These queue stuff to be processed by handlePeerChanges().
575 // As of now, these create and remove clients and players.
576 void peerAdded(con::Peer *peer);
577 void deletingPeer(con::Peer *peer, bool timeout);
583 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
584 static void SendAccessDenied(con::Connection &con, u16 peer_id,
585 const std::wstring &reason);
586 static void SendDeathscreen(con::Connection &con, u16 peer_id,
587 bool set_camera_point_target, v3f camera_point_target);
588 static void SendItemDef(con::Connection &con, u16 peer_id,
589 IItemDefManager *itemdef);
590 static void SendNodeDef(con::Connection &con, u16 peer_id,
591 INodeDefManager *nodedef);
594 Non-static send methods.
595 Conlock should be always used.
596 Envlock usage is documented badly but it's easy to figure out
597 which ones access the environment.
600 // Envlock and conlock should be locked when calling these
601 void SendMovePlayer(u16 peer_id);
602 void SendInventory(u16 peer_id);
603 void SendChatMessage(u16 peer_id, const std::wstring &message);
604 void BroadcastChatMessage(const std::wstring &message);
605 void SendPlayerHP(u16 peer_id);
607 Send a node removal/addition event to all clients except ignore_id.
608 Additionally, if far_players!=NULL, players further away than
609 far_d_nodes are ignored and their peer_ids are added to far_players
611 // Envlock and conlock should be locked when calling these
612 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
613 core::list<u16> *far_players=NULL, float far_d_nodes=100);
614 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
615 core::list<u16> *far_players=NULL, float far_d_nodes=100);
616 void setBlockNotSent(v3s16 p);
618 // Environment and Connection must be locked when called
619 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
621 // Sends blocks to clients (locks env and con on its own)
622 void SendBlocks(float dtime);
624 void fillMediaCache();
625 void sendMediaAnnouncement(u16 peer_id);
626 void sendRequestedMedia(u16 peer_id,
627 const core::list<MediaRequest> &tosend);
633 void DiePlayer(u16 peer_id);
634 void RespawnPlayer(u16 peer_id);
636 void UpdateCrafting(u16 peer_id);
638 // When called, connection mutex should be locked
639 RemoteClient* getClient(u16 peer_id);
641 // When called, environment mutex should be locked
642 std::string getPlayerName(u16 peer_id)
644 Player *player = m_env->getPlayer(peer_id);
646 return "[id="+itos(peer_id)+"]";
647 return player->getName();
650 // When called, environment mutex should be locked
651 PlayerSAO* getPlayerSAO(u16 peer_id)
653 Player *player = m_env->getPlayer(peer_id);
656 return player->getPlayerSAO();
660 Get a player from memory or creates one.
661 If player is already connected, return NULL
662 Does not verify/modify auth info and password.
664 Call with env and con locked.
666 PlayerSAO *emergePlayer(const char *name, u16 peer_id);
668 // Locks environment and connection by its own
670 void handlePeerChange(PeerChange &c);
671 void handlePeerChanges();
673 u64 getPlayerPrivs(Player *player);
680 std::string m_path_world;
681 // Path to user's configuration file ("" = no configuration file)
682 std::string m_path_config;
683 // Subgame specification
684 SubgameSpec m_gamespec;
685 // If true, do not allow multiple players and hide some multiplayer
687 bool m_simple_singleplayer_mode;
689 // Thread can set; step() will throw as ServerError
690 MutexedVariable<std::string> m_async_fatal_error;
693 float m_liquid_transform_timer;
694 float m_print_info_timer;
695 float m_objectdata_timer;
696 float m_emergethread_trigger_timer;
697 float m_savemap_timer;
698 IntervalLimiter m_map_timer_and_unload_interval;
700 // NOTE: If connection and environment are both to be locked,
701 // environment shall be locked first.
704 ServerEnvironment *m_env;
708 con::Connection m_con;
710 // Connected clients (behind the con mutex)
711 core::map<u16, RemoteClient*> m_clients;
713 // User authentication
714 AuthManager m_authmanager;
717 BanManager m_banmanager;
720 // Envlock and conlock should be locked when using Lua
723 // Item definition manager
724 IWritableItemDefManager *m_itemdef;
726 // Node definition manager
727 IWritableNodeDefManager *m_nodedef;
729 // Craft definition manager
730 IWritableCraftDefManager *m_craftdef;
733 EventManager *m_event;
736 core::list<ModSpec> m_mods;
742 // A buffer for time steps
743 // step() increments and AsyncRunStep() run by m_thread reads it.
745 JMutex m_step_dtime_mutex;
747 // The server mainly operates in this thread
748 ServerThread m_thread;
749 // This thread fetches and generates map
750 EmergeThread m_emergethread;
751 // Queue of block coordinates to be processed by the emerge thread
752 BlockEmergeQueue m_emerge_queue;
758 // Timer for sending time of day over network
759 float m_time_of_day_send_timer;
760 // Uptime of server in seconds
761 MutexedVariable<double> m_uptime;
765 Queues stuff from peerAdded() and deletingPeer() to
779 Queue<PeerChange> m_peer_change_queue;
785 // Mod parent directory paths
786 core::list<std::string> m_modspaths;
788 bool m_shutdown_requested;
791 Map edit event queue. Automatically receives all map edits.
792 The constructor of this class registers us to receive them through
795 NOTE: Should these be moved to actually be members of
800 Queue of map edits from the environment for sending to the clients
801 This is behind m_env_mutex
803 Queue<MapEditEvent*> m_unsent_map_edit_queue;
805 Set to true when the server itself is modifying the map and does
806 all sending of information by itself.
807 This is behind m_env_mutex
809 bool m_ignore_map_edit_events;
811 If a non-empty area, map edit events contained within are left
812 unsent. Done at map generation time to speed up editing of the
813 generated area, as it will be sent anyway.
814 This is behind m_env_mutex
816 VoxelArea m_ignore_map_edit_events_area;
818 If set to !=0, the incoming MapEditEvents are modified to have
819 this peed id as the disabled recipient
820 This is behind m_env_mutex
822 u16 m_ignore_map_edit_events_peer_id;
824 friend class EmergeThread;
825 friend class RemoteClient;
827 std::map<std::string,MediaInfo> m_media;
832 std::map<s32, ServerPlayingSound> m_playing_sounds;
837 Runs a simple dedicated server loop.
839 Shuts down when run is set to false.
841 void dedicated_server_loop(Server &server, bool &run);