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
34 #include "serverremoteplayer.h"
36 #include "inventorymanager.h"
39 typedef struct lua_State lua_State;
40 class IWritableItemDefManager;
41 class IWritableNodeDefManager;
42 class IWritableCraftDefManager;
44 class ServerError : public std::exception
47 ServerError(const std::string &s)
49 m_s = "ServerError: ";
52 virtual ~ServerError() throw()
54 virtual const char * what() const throw()
64 v3f findSpawnPos(ServerMap &map);
67 A structure containing the data needed for queueing the fetching
70 struct QueuedBlockEmerge
73 // key = peer_id, value = flags
74 core::map<u16, u8> peer_ids;
78 This is a thread-safe class.
80 class BlockEmergeQueue
90 JMutexAutoLock lock(m_mutex);
92 core::list<QueuedBlockEmerge*>::Iterator i;
93 for(i=m_queue.begin(); i!=m_queue.end(); i++)
95 QueuedBlockEmerge *q = *i;
101 peer_id=0 adds with nobody to send to
103 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
105 DSTACK(__FUNCTION_NAME);
107 JMutexAutoLock lock(m_mutex);
112 Find if block is already in queue.
113 If it is, update the peer to it and quit.
115 core::list<QueuedBlockEmerge*>::Iterator i;
116 for(i=m_queue.begin(); i!=m_queue.end(); i++)
118 QueuedBlockEmerge *q = *i;
121 q->peer_ids[peer_id] = flags;
130 QueuedBlockEmerge *q = new QueuedBlockEmerge;
133 q->peer_ids[peer_id] = flags;
134 m_queue.push_back(q);
137 // Returned pointer must be deleted
138 // Returns NULL if queue is empty
139 QueuedBlockEmerge * pop()
141 JMutexAutoLock lock(m_mutex);
143 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
144 if(i == m_queue.end())
146 QueuedBlockEmerge *q = *i;
153 JMutexAutoLock lock(m_mutex);
154 return m_queue.size();
157 u32 peerItemCount(u16 peer_id)
159 JMutexAutoLock lock(m_mutex);
163 core::list<QueuedBlockEmerge*>::Iterator i;
164 for(i=m_queue.begin(); i!=m_queue.end(); i++)
166 QueuedBlockEmerge *q = *i;
167 if(q->peer_ids.find(peer_id) != NULL)
175 core::list<QueuedBlockEmerge*> m_queue;
181 class ServerThread : public SimpleThread
187 ServerThread(Server *server):
196 class EmergeThread : public SimpleThread
202 EmergeThread(Server *server):
213 if(IsRunning() == false)
223 char name[PLAYERNAME_SIZE];
229 void PrintLine(std::ostream *s);
233 Used for queueing and sorting block transfers in containers
235 Lower priority number means higher priority.
237 struct PrioritySortedBlockTransfer
239 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
241 priority = a_priority;
245 bool operator < (PrioritySortedBlockTransfer &other)
247 return priority < other.priority;
254 struct TextureRequest
258 TextureRequest(const std::string &name_=""):
263 struct TextureInformation
266 std::string sha1_digest;
268 TextureInformation(const std::string path_="",
269 const std::string sha1_digest_=""):
271 sha1_digest(sha1_digest_)
279 // peer_id=0 means this client has no associated peer
280 // NOTE: If client is made allowed to exist while peer doesn't,
281 // this has to be set to 0 when there is no peer.
282 // Also, the client must be moved to some other container.
284 // The serialization version to use with the client
285 u8 serialization_version;
287 u16 net_proto_version;
288 // Version is stored in here after INIT before INIT2
289 u8 pending_serialization_version;
291 bool definitions_sent;
294 m_time_from_building(9999),
295 m_excess_gotblocks(0)
298 serialization_version = SER_FMT_VER_INVALID;
299 net_proto_version = 0;
300 pending_serialization_version = SER_FMT_VER_INVALID;
301 definitions_sent = false;
302 m_nearest_unsent_d = 0;
303 m_nearest_unsent_reset_timer = 0.0;
304 m_nothing_to_send_counter = 0;
305 m_nothing_to_send_pause_timer = 0;
312 Finds block that should be sent next to the client.
313 Environment should be locked when this is called.
314 dtime is used for resetting send radius at slow interval
316 void GetNextBlocks(Server *server, float dtime,
317 core::array<PrioritySortedBlockTransfer> &dest);
319 void GotBlock(v3s16 p);
321 void SentBlock(v3s16 p);
323 void SetBlockNotSent(v3s16 p);
324 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
328 return m_blocks_sending.size();
331 // Increments timeouts and removes timed-out blocks from list
332 // NOTE: This doesn't fix the server-not-sending-block bug
333 // because it is related to emerging, not sending.
334 //void RunSendingTimeouts(float dtime, float timeout);
336 void PrintInfo(std::ostream &o)
338 o<<"RemoteClient "<<peer_id<<": "
339 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
340 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
341 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
342 <<", m_excess_gotblocks="<<m_excess_gotblocks
344 m_excess_gotblocks = 0;
347 // Time from last placing or removing blocks
348 float m_time_from_building;
350 /*JMutex m_dig_mutex;
351 float m_dig_time_remaining;
354 v3s16 m_dig_position;*/
357 List of active objects that the client knows of.
360 core::map<u16, bool> m_known_objects;
364 Blocks that have been sent to client.
365 - These don't have to be sent again.
366 - A block is cleared from here when client says it has
367 deleted it from it's memory
369 Key is position, value is dummy.
370 No MapBlock* is stored here because the blocks can get deleted.
372 core::map<v3s16, bool> m_blocks_sent;
373 s16 m_nearest_unsent_d;
375 float m_nearest_unsent_reset_timer;
378 Blocks that are currently on the line.
379 This is used for throttling the sending of blocks.
380 - The size of this list is limited to some value
381 Block is added when it is sent with BLOCKDATA.
382 Block is removed when GOTBLOCKS is received.
383 Value is time from sending. (not used at the moment)
385 core::map<v3s16, float> m_blocks_sending;
388 Count of excess GotBlocks().
389 There is an excess amount because the client sometimes
390 gets a block so late that the server sends it again,
391 and the client then sends two GOTBLOCKs.
392 This is resetted by PrintInfo()
394 u32 m_excess_gotblocks;
396 // CPU usage optimization
397 u32 m_nothing_to_send_counter;
398 float m_nothing_to_send_pause_timer;
401 class Server : public con::PeerHandler, public MapEventReceiver,
402 public InventoryManager, public IGameDef,
403 public IBackgroundBlockEmerger
407 NOTE: Every public method should be thread-safe
411 const std::string &path_world,
412 const std::string &path_config,
413 const SubgameSpec &gamespec,
414 bool simple_singleplayer_mode
417 void start(unsigned short port);
419 // This is mainly a way to pass the time to the server.
420 // Actual processing is done in an another thread.
421 void step(float dtime);
422 // This is run by ServerThread and does the actual processing
425 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
427 core::list<PlayerInfo> getPlayerInfo();
429 // Environment must be locked when called
430 void setTimeOfDay(u32 time)
432 m_env->setTimeOfDay(time);
433 m_time_of_day_send_timer = 0;
436 bool getShutdownRequested()
438 return m_shutdown_requested;
442 Shall be called with the environment locked.
443 This is accessed by the map, which is inside the environment,
444 so it shouldn't be a problem.
446 void onMapEditEvent(MapEditEvent *event);
449 Shall be called with the environment and the connection locked.
451 Inventory* getInventory(const InventoryLocation &loc);
452 std::string getInventoryOwner(const InventoryLocation &loc);
453 void setInventoryModified(const InventoryLocation &loc);
455 // Connection must be locked when called
456 std::wstring getStatusString();
458 void requestShutdown(void)
460 m_shutdown_requested = true;
463 // Envlock and conlock should be locked when calling this
464 void SendMovePlayer(Player *player);
467 u64 getPlayerAuthPrivs(const std::string &name);
468 void setPlayerAuthPrivs(const std::string &name, u64 privs);
469 u64 getPlayerEffectivePrivs(const std::string &name);
471 // Changes a player's password, password must be given as plaintext
472 // If the player doesn't exist, a new entry is added to the auth manager
473 void setPlayerPassword(const std::string &name, const std::wstring &password);
475 // Saves g_settings to configpath given at initialization
478 void setIpBanned(const std::string &ip, const std::string &name)
480 m_banmanager.add(ip, name);
484 void unsetIpBanned(const std::string &ip_or_name)
486 m_banmanager.remove(ip_or_name);
490 std::string getBanDescription(const std::string &ip_or_name)
492 return m_banmanager.getBanDescription(ip_or_name);
495 Address getPeerAddress(u16 peer_id)
497 return m_con.GetPeerAddress(peer_id);
500 // Envlock and conlock should be locked when calling this
501 void notifyPlayer(const char *name, const std::wstring msg);
502 void notifyPlayers(const std::wstring msg);
504 void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
506 // Envlock and conlock should be locked when using Lua
507 lua_State *getLua(){ return m_lua; }
509 // IGameDef interface
511 virtual IItemDefManager* getItemDefManager();
512 virtual INodeDefManager* getNodeDefManager();
513 virtual ICraftDefManager* getCraftDefManager();
514 virtual ITextureSource* getTextureSource();
515 virtual u16 allocateUnknownNodeId(const std::string &name);
517 IWritableItemDefManager* getWritableItemDefManager();
518 IWritableNodeDefManager* getWritableNodeDefManager();
519 IWritableCraftDefManager* getWritableCraftDefManager();
521 const ModSpec* getModSpec(const std::string &modname);
523 std::string getWorldPath(){ return m_path_world; }
525 void setAsyncFatalError(const std::string &error)
527 m_async_fatal_error.set(error);
532 // con::PeerHandler implementation.
533 // These queue stuff to be processed by handlePeerChanges().
534 // As of now, these create and remove clients and players.
535 void peerAdded(con::Peer *peer);
536 void deletingPeer(con::Peer *peer, bool timeout);
542 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
543 static void SendAccessDenied(con::Connection &con, u16 peer_id,
544 const std::wstring &reason);
545 static void SendDeathscreen(con::Connection &con, u16 peer_id,
546 bool set_camera_point_target, v3f camera_point_target);
547 static void SendItemDef(con::Connection &con, u16 peer_id,
548 IItemDefManager *itemdef);
549 static void SendNodeDef(con::Connection &con, u16 peer_id,
550 INodeDefManager *nodedef);
553 Non-static send methods.
554 Conlock should be always used.
555 Envlock usage is documented badly but it's easy to figure out
556 which ones access the environment.
559 // Envlock and conlock should be locked when calling these
560 void SendInventory(u16 peer_id);
561 // send wielded item info about player to all
562 void SendWieldedItem(const ServerRemotePlayer *srp);
563 // send wielded item info about all players to all players
564 void SendPlayerItems();
565 void SendChatMessage(u16 peer_id, const std::wstring &message);
566 void BroadcastChatMessage(const std::wstring &message);
567 void SendPlayerHP(Player *player);
569 Send a node removal/addition event to all clients except ignore_id.
570 Additionally, if far_players!=NULL, players further away than
571 far_d_nodes are ignored and their peer_ids are added to far_players
573 // Envlock and conlock should be locked when calling these
574 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
575 core::list<u16> *far_players=NULL, float far_d_nodes=100);
576 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
577 core::list<u16> *far_players=NULL, float far_d_nodes=100);
578 void setBlockNotSent(v3s16 p);
580 // Environment and Connection must be locked when called
581 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
583 // Sends blocks to clients (locks env and con on its own)
584 void SendBlocks(float dtime);
586 void PrepareTextures();
588 void SendTextureAnnouncement(u16 peer_id);
590 void SendTexturesRequested(u16 peer_id,core::list<TextureRequest> tosend);
596 void DiePlayer(Player *player);
597 void RespawnPlayer(Player *player);
599 void UpdateCrafting(u16 peer_id);
601 // When called, connection mutex should be locked
602 RemoteClient* getClient(u16 peer_id);
604 // When called, environment mutex should be locked
605 std::string getPlayerName(u16 peer_id)
607 Player *player = m_env->getPlayer(peer_id);
609 return "[id="+itos(peer_id)+"]";
610 return player->getName();
614 Get a player from memory or creates one.
615 If player is already connected, return NULL
616 Does not verify/modify auth info and password.
618 Call with env and con locked.
620 ServerRemotePlayer *emergePlayer(const char *name, u16 peer_id);
622 // Locks environment and connection by its own
624 void handlePeerChange(PeerChange &c);
625 void handlePeerChanges();
627 u64 getPlayerPrivs(Player *player);
634 std::string m_path_world;
635 // Path to user's configuration file ("" = no configuration file)
636 std::string m_path_config;
637 // Subgame specification
638 SubgameSpec m_gamespec;
639 // If true, do not allow multiple players and hide some multiplayer
641 bool m_simple_singleplayer_mode;
643 // Thread can set; step() will throw as ServerError
644 MutexedVariable<std::string> m_async_fatal_error;
647 float m_liquid_transform_timer;
648 float m_print_info_timer;
649 float m_objectdata_timer;
650 float m_emergethread_trigger_timer;
651 float m_savemap_timer;
652 IntervalLimiter m_map_timer_and_unload_interval;
654 // NOTE: If connection and environment are both to be locked,
655 // environment shall be locked first.
658 ServerEnvironment *m_env;
662 con::Connection m_con;
664 // Connected clients (behind the con mutex)
665 core::map<u16, RemoteClient*> m_clients;
667 // User authentication
668 AuthManager m_authmanager;
671 BanManager m_banmanager;
674 // Envlock and conlock should be locked when using Lua
677 // Item definition manager
678 IWritableItemDefManager *m_itemdef;
680 // Node definition manager
681 IWritableNodeDefManager *m_nodedef;
683 // Craft definition manager
684 IWritableCraftDefManager *m_craftdef;
687 core::list<ModSpec> m_mods;
693 // A buffer for time steps
694 // step() increments and AsyncRunStep() run by m_thread reads it.
696 JMutex m_step_dtime_mutex;
698 // The server mainly operates in this thread
699 ServerThread m_thread;
700 // This thread fetches and generates map
701 EmergeThread m_emergethread;
702 // Queue of block coordinates to be processed by the emerge thread
703 BlockEmergeQueue m_emerge_queue;
709 // Timer for sending time of day over network
710 float m_time_of_day_send_timer;
711 // Uptime of server in seconds
712 MutexedVariable<double> m_uptime;
716 Queues stuff from peerAdded() and deletingPeer() to
730 Queue<PeerChange> m_peer_change_queue;
736 // Mod parent directory paths
737 core::list<std::string> m_modspaths;
739 bool m_shutdown_requested;
742 Map edit event queue. Automatically receives all map edits.
743 The constructor of this class registers us to receive them through
746 NOTE: Should these be moved to actually be members of
751 Queue of map edits from the environment for sending to the clients
752 This is behind m_env_mutex
754 Queue<MapEditEvent*> m_unsent_map_edit_queue;
756 Set to true when the server itself is modifying the map and does
757 all sending of information by itself.
758 This is behind m_env_mutex
760 bool m_ignore_map_edit_events;
762 If set to !=0, the incoming MapEditEvents are modified to have
763 this peed id as the disabled recipient
764 This is behind m_env_mutex
766 u16 m_ignore_map_edit_events_peer_id;
768 friend class EmergeThread;
769 friend class RemoteClient;
771 std::map<std::string,TextureInformation> m_Textures;
775 Runs a simple dedicated server loop.
777 Shuts down when run is set to false.
779 void dedicated_server_loop(Server &server, bool &run);