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 typedef struct lua_State lua_State;
36 class IWritableToolDefManager;
37 class IWritableNodeDefManager;
38 class IWritableCraftDefManager;
39 class IWritableCraftItemDefManager;
44 v3f findSpawnPos(ServerMap &map);
47 A structure containing the data needed for queueing the fetching
50 struct QueuedBlockEmerge
53 // key = peer_id, value = flags
54 core::map<u16, u8> peer_ids;
58 This is a thread-safe class.
60 class BlockEmergeQueue
70 JMutexAutoLock lock(m_mutex);
72 core::list<QueuedBlockEmerge*>::Iterator i;
73 for(i=m_queue.begin(); i!=m_queue.end(); i++)
75 QueuedBlockEmerge *q = *i;
81 peer_id=0 adds with nobody to send to
83 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
85 DSTACK(__FUNCTION_NAME);
87 JMutexAutoLock lock(m_mutex);
92 Find if block is already in queue.
93 If it is, update the peer to it and quit.
95 core::list<QueuedBlockEmerge*>::Iterator i;
96 for(i=m_queue.begin(); i!=m_queue.end(); i++)
98 QueuedBlockEmerge *q = *i;
101 q->peer_ids[peer_id] = flags;
110 QueuedBlockEmerge *q = new QueuedBlockEmerge;
113 q->peer_ids[peer_id] = flags;
114 m_queue.push_back(q);
117 // Returned pointer must be deleted
118 // Returns NULL if queue is empty
119 QueuedBlockEmerge * pop()
121 JMutexAutoLock lock(m_mutex);
123 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
124 if(i == m_queue.end())
126 QueuedBlockEmerge *q = *i;
133 JMutexAutoLock lock(m_mutex);
134 return m_queue.size();
137 u32 peerItemCount(u16 peer_id)
139 JMutexAutoLock lock(m_mutex);
143 core::list<QueuedBlockEmerge*>::Iterator i;
144 for(i=m_queue.begin(); i!=m_queue.end(); i++)
146 QueuedBlockEmerge *q = *i;
147 if(q->peer_ids.find(peer_id) != NULL)
155 core::list<QueuedBlockEmerge*> m_queue;
161 class ServerThread : public SimpleThread
167 ServerThread(Server *server):
176 class EmergeThread : public SimpleThread
182 EmergeThread(Server *server):
193 if(IsRunning() == false)
203 char name[PLAYERNAME_SIZE];
209 void PrintLine(std::ostream *s);
212 u32 PIChecksum(core::list<PlayerInfo> &l);
215 Used for queueing and sorting block transfers in containers
217 Lower priority number means higher priority.
219 struct PrioritySortedBlockTransfer
221 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
223 priority = a_priority;
227 bool operator < (PrioritySortedBlockTransfer &other)
229 return priority < other.priority;
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.
244 // The serialization version to use with the client
245 u8 serialization_version;
247 u16 net_proto_version;
248 // Version is stored in here after INIT before INIT2
249 u8 pending_serialization_version;
252 m_time_from_building(9999),
253 m_excess_gotblocks(0)
256 serialization_version = SER_FMT_VER_INVALID;
257 net_proto_version = 0;
258 pending_serialization_version = SER_FMT_VER_INVALID;
259 m_nearest_unsent_d = 0;
260 m_nearest_unsent_reset_timer = 0.0;
261 m_nothing_to_send_counter = 0;
262 m_nothing_to_send_pause_timer = 0;
269 Finds block that should be sent next to the client.
270 Environment should be locked when this is called.
271 dtime is used for resetting send radius at slow interval
273 void GetNextBlocks(Server *server, float dtime,
274 core::array<PrioritySortedBlockTransfer> &dest);
276 void GotBlock(v3s16 p);
278 void SentBlock(v3s16 p);
280 void SetBlockNotSent(v3s16 p);
281 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
285 return m_blocks_sending.size();
288 // Increments timeouts and removes timed-out blocks from list
289 // NOTE: This doesn't fix the server-not-sending-block bug
290 // because it is related to emerging, not sending.
291 //void RunSendingTimeouts(float dtime, float timeout);
293 void PrintInfo(std::ostream &o)
295 o<<"RemoteClient "<<peer_id<<": "
296 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
297 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
298 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
299 <<", m_excess_gotblocks="<<m_excess_gotblocks
301 m_excess_gotblocks = 0;
304 // Time from last placing or removing blocks
305 float m_time_from_building;
307 /*JMutex m_dig_mutex;
308 float m_dig_time_remaining;
311 v3s16 m_dig_position;*/
314 List of active objects that the client knows of.
317 core::map<u16, bool> m_known_objects;
321 Blocks that have been sent to client.
322 - These don't have to be sent again.
323 - A block is cleared from here when client says it has
324 deleted it from it's memory
326 Key is position, value is dummy.
327 No MapBlock* is stored here because the blocks can get deleted.
329 core::map<v3s16, bool> m_blocks_sent;
330 s16 m_nearest_unsent_d;
332 float m_nearest_unsent_reset_timer;
335 Blocks that are currently on the line.
336 This is used for throttling the sending of blocks.
337 - The size of this list is limited to some value
338 Block is added when it is sent with BLOCKDATA.
339 Block is removed when GOTBLOCKS is received.
340 Value is time from sending. (not used at the moment)
342 core::map<v3s16, float> m_blocks_sending;
345 Count of excess GotBlocks().
346 There is an excess amount because the client sometimes
347 gets a block so late that the server sends it again,
348 and the client then sends two GOTBLOCKs.
349 This is resetted by PrintInfo()
351 u32 m_excess_gotblocks;
353 // CPU usage optimization
354 u32 m_nothing_to_send_counter;
355 float m_nothing_to_send_pause_timer;
358 class Server : public con::PeerHandler, public MapEventReceiver,
359 public InventoryManager, public IGameDef,
360 public IBackgroundBlockEmerger
364 NOTE: Every public method should be thread-safe
368 std::string mapsavedir,
369 std::string configpath
372 void start(unsigned short port);
374 // This is mainly a way to pass the time to the server.
375 // Actual processing is done in an another thread.
376 void step(float dtime);
377 // This is run by ServerThread and does the actual processing
380 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
382 core::list<PlayerInfo> getPlayerInfo();
384 /*u32 getDayNightRatio()
386 return time_to_daynight_ratio(m_time_of_day.get());
389 // Environment must be locked when called
390 void setTimeOfDay(u32 time)
392 m_env->setTimeOfDay(time);
393 m_time_of_day_send_timer = 0;
396 bool getShutdownRequested()
398 return m_shutdown_requested;
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.
406 void onMapEditEvent(MapEditEvent *event);
409 Shall be called with the environment and the connection locked.
411 Inventory* getInventory(InventoryContext *c, std::string id);
412 void inventoryModified(InventoryContext *c, std::string id);
414 // Connection must be locked when called
415 std::wstring getStatusString();
417 void requestShutdown(void)
419 m_shutdown_requested = true;
423 // Envlock and conlock should be locked when calling this
424 void SendMovePlayer(Player *player);
426 u64 getPlayerAuthPrivs(const std::string &name)
429 return m_authmanager.getPrivs(name);
431 catch(AuthNotFoundException &e)
433 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
438 void setPlayerAuthPrivs(const std::string &name, u64 privs)
441 return m_authmanager.setPrivs(name, privs);
443 catch(AuthNotFoundException &e)
445 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
449 // Changes a player's password, password must be given as plaintext
450 // If the player doesn't exist, a new entry is added to the auth manager
451 void setPlayerPassword(const std::string &name, const std::wstring &password);
453 // Saves g_settings to configpath given at initialization
456 void setIpBanned(const std::string &ip, const std::string &name)
458 m_banmanager.add(ip, name);
462 void unsetIpBanned(const std::string &ip_or_name)
464 m_banmanager.remove(ip_or_name);
468 std::string getBanDescription(const std::string &ip_or_name)
470 return m_banmanager.getBanDescription(ip_or_name);
473 Address getPeerAddress(u16 peer_id)
475 return m_con.GetPeerAddress(peer_id);
478 // Envlock and conlock should be locked when calling this
479 void notifyPlayer(const char *name, const std::wstring msg);
480 void notifyPlayers(const std::wstring msg);
482 void queueBlockEmerge(v3s16 blockpos, bool allow_generate);
484 // Envlock and conlock should be locked when using Lua
485 lua_State *getLua(){ return m_lua; }
487 // IGameDef interface
489 virtual IToolDefManager* getToolDefManager();
490 virtual INodeDefManager* getNodeDefManager();
491 virtual ICraftDefManager* getCraftDefManager();
492 virtual ICraftItemDefManager* getCraftItemDefManager();
493 virtual ITextureSource* getTextureSource();
494 virtual u16 allocateUnknownNodeId(const std::string &name);
496 IWritableToolDefManager* getWritableToolDefManager();
497 IWritableNodeDefManager* getWritableNodeDefManager();
498 IWritableCraftDefManager* getWritableCraftDefManager();
499 IWritableCraftItemDefManager* getWritableCraftItemDefManager();
503 // con::PeerHandler implementation.
504 // These queue stuff to be processed by handlePeerChanges().
505 // As of now, these create and remove clients and players.
506 void peerAdded(con::Peer *peer);
507 void deletingPeer(con::Peer *peer, bool timeout);
513 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
514 static void SendAccessDenied(con::Connection &con, u16 peer_id,
515 const std::wstring &reason);
516 static void SendDeathscreen(con::Connection &con, u16 peer_id,
517 bool set_camera_point_target, v3f camera_point_target);
518 static void SendToolDef(con::Connection &con, u16 peer_id,
519 IToolDefManager *tooldef);
520 static void SendNodeDef(con::Connection &con, u16 peer_id,
521 INodeDefManager *nodedef);
522 static void SendCraftItemDef(con::Connection &con, u16 peer_id,
523 ICraftItemDefManager *nodedef);
526 Non-static send methods.
527 Conlock should be always used.
528 Envlock usage is documented badly but it's easy to figure out
529 which ones access the environment.
532 // Envlock and conlock should be locked when calling these
533 void SendInventory(u16 peer_id);
534 // send wielded item info about player to all
535 void SendWieldedItem(const Player *player);
536 // send wielded item info about all players to all players
537 void SendPlayerItems();
538 void SendChatMessage(u16 peer_id, const std::wstring &message);
539 void BroadcastChatMessage(const std::wstring &message);
540 void SendPlayerHP(Player *player);
542 Send a node removal/addition event to all clients except ignore_id.
543 Additionally, if far_players!=NULL, players further away than
544 far_d_nodes are ignored and their peer_ids are added to far_players
546 // Envlock and conlock should be locked when calling these
547 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
548 core::list<u16> *far_players=NULL, float far_d_nodes=100);
549 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
550 core::list<u16> *far_players=NULL, float far_d_nodes=100);
551 void setBlockNotSent(v3s16 p);
553 // Environment and Connection must be locked when called
554 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
556 // Sends blocks to clients (locks env and con on its own)
557 void SendBlocks(float dtime);
559 void SendTextures(u16 peer_id);
565 void HandlePlayerHP(Player *player, s16 damage);
566 void RespawnPlayer(Player *player);
568 void UpdateCrafting(u16 peer_id);
570 // When called, connection mutex should be locked
571 RemoteClient* getClient(u16 peer_id);
573 // When called, environment mutex should be locked
574 std::string getPlayerName(u16 peer_id)
576 Player *player = m_env->getPlayer(peer_id);
578 return "[id="+itos(peer_id);
579 return player->getName();
583 Get a player from memory or creates one.
584 If player is already connected, return NULL
585 Does not verify/modify auth info and password.
587 Call with env and con locked.
589 ServerRemotePlayer *emergePlayer(const char *name, u16 peer_id);
591 // Locks environment and connection by its own
593 void handlePeerChange(PeerChange &c);
594 void handlePeerChanges();
596 u64 getPlayerPrivs(Player *player);
603 float m_liquid_transform_timer;
604 float m_print_info_timer;
605 float m_objectdata_timer;
606 float m_emergethread_trigger_timer;
607 float m_savemap_timer;
608 IntervalLimiter m_map_timer_and_unload_interval;
610 // NOTE: If connection and environment are both to be locked,
611 // environment shall be locked first.
614 ServerEnvironment *m_env;
618 con::Connection m_con;
620 // Connected clients (behind the con mutex)
621 core::map<u16, RemoteClient*> m_clients;
623 // User authentication
624 AuthManager m_authmanager;
627 BanManager m_banmanager;
630 // Envlock and conlock should be locked when using Lua
633 // Tool definition manager
634 IWritableToolDefManager *m_toolmgr;
636 // Node definition manager
637 IWritableNodeDefManager *m_nodedef;
639 // Craft definition manager
640 IWritableCraftDefManager *m_craftdef;
642 // CraftItem definition manager
643 IWritableCraftItemDefManager *m_craftitemdef;
649 // A buffer for time steps
650 // step() increments and AsyncRunStep() run by m_thread reads it.
652 JMutex m_step_dtime_mutex;
654 // The server mainly operates in this thread
655 ServerThread m_thread;
656 // This thread fetches and generates map
657 EmergeThread m_emergethread;
658 // Queue of block coordinates to be processed by the emerge thread
659 BlockEmergeQueue m_emerge_queue;
666 //MutexedVariable<u32> m_time_of_day;
667 // Used to buffer dtime for adding to m_time_of_day
668 float m_time_counter;
669 // Timer for sending time of day over network
670 float m_time_of_day_send_timer;
671 // Uptime of server in seconds
672 MutexedVariable<double> m_uptime;
676 Queues stuff from peerAdded() and deletingPeer() to
690 Queue<PeerChange> m_peer_change_queue;
697 std::string m_mapsavedir;
699 // Configuration path ("" = no configuration file)
700 std::string m_configpath;
702 // Mod parent directory paths
703 core::list<std::string> m_modspaths;
705 bool m_shutdown_requested;
708 Map edit event queue. Automatically receives all map edits.
709 The constructor of this class registers us to receive them through
712 NOTE: Should these be moved to actually be members of
717 Queue of map edits from the environment for sending to the clients
718 This is behind m_env_mutex
720 Queue<MapEditEvent*> m_unsent_map_edit_queue;
722 Set to true when the server itself is modifying the map and does
723 all sending of information by itself.
724 This is behind m_env_mutex
726 bool m_ignore_map_edit_events;
728 If set to !=0, the incoming MapEditEvents are modified to have
729 this peed id as the disabled recipient
730 This is behind m_env_mutex
732 u16 m_ignore_map_edit_events_peer_id;
734 friend class EmergeThread;
735 friend class RemoteClient;
739 Runs a simple dedicated server loop.
741 Shuts down when run is set to false.
743 void dedicated_server_loop(Server &server, bool &run);