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;
42 v3f findSpawnPos(ServerMap &map);
45 A structure containing the data needed for queueing the fetching
48 struct QueuedBlockEmerge
51 // key = peer_id, value = flags
52 core::map<u16, u8> peer_ids;
56 This is a thread-safe class.
58 class BlockEmergeQueue
68 JMutexAutoLock lock(m_mutex);
70 core::list<QueuedBlockEmerge*>::Iterator i;
71 for(i=m_queue.begin(); i!=m_queue.end(); i++)
73 QueuedBlockEmerge *q = *i;
79 peer_id=0 adds with nobody to send to
81 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
83 DSTACK(__FUNCTION_NAME);
85 JMutexAutoLock lock(m_mutex);
90 Find if block is already in queue.
91 If it is, update the peer to it and quit.
93 core::list<QueuedBlockEmerge*>::Iterator i;
94 for(i=m_queue.begin(); i!=m_queue.end(); i++)
96 QueuedBlockEmerge *q = *i;
99 q->peer_ids[peer_id] = flags;
108 QueuedBlockEmerge *q = new QueuedBlockEmerge;
111 q->peer_ids[peer_id] = flags;
112 m_queue.push_back(q);
115 // Returned pointer must be deleted
116 // Returns NULL if queue is empty
117 QueuedBlockEmerge * pop()
119 JMutexAutoLock lock(m_mutex);
121 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
122 if(i == m_queue.end())
124 QueuedBlockEmerge *q = *i;
131 JMutexAutoLock lock(m_mutex);
132 return m_queue.size();
135 u32 peerItemCount(u16 peer_id)
137 JMutexAutoLock lock(m_mutex);
141 core::list<QueuedBlockEmerge*>::Iterator i;
142 for(i=m_queue.begin(); i!=m_queue.end(); i++)
144 QueuedBlockEmerge *q = *i;
145 if(q->peer_ids.find(peer_id) != NULL)
153 core::list<QueuedBlockEmerge*> m_queue;
159 class ServerThread : public SimpleThread
165 ServerThread(Server *server):
174 class EmergeThread : public SimpleThread
180 EmergeThread(Server *server):
191 if(IsRunning() == false)
201 char name[PLAYERNAME_SIZE];
207 void PrintLine(std::ostream *s);
210 u32 PIChecksum(core::list<PlayerInfo> &l);
213 Used for queueing and sorting block transfers in containers
215 Lower priority number means higher priority.
217 struct PrioritySortedBlockTransfer
219 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
221 priority = a_priority;
225 bool operator < (PrioritySortedBlockTransfer &other)
227 return priority < other.priority;
237 // peer_id=0 means this client has no associated peer
238 // NOTE: If client is made allowed to exist while peer doesn't,
239 // this has to be set to 0 when there is no peer.
240 // Also, the client must be moved to some other container.
242 // The serialization version to use with the client
243 u8 serialization_version;
245 u16 net_proto_version;
246 // Version is stored in here after INIT before INIT2
247 u8 pending_serialization_version;
250 m_time_from_building(9999),
251 m_excess_gotblocks(0)
254 serialization_version = SER_FMT_VER_INVALID;
255 net_proto_version = 0;
256 pending_serialization_version = SER_FMT_VER_INVALID;
257 m_nearest_unsent_d = 0;
258 m_nearest_unsent_reset_timer = 0.0;
259 m_nothing_to_send_counter = 0;
260 m_nothing_to_send_pause_timer = 0;
267 Finds block that should be sent next to the client.
268 Environment should be locked when this is called.
269 dtime is used for resetting send radius at slow interval
271 void GetNextBlocks(Server *server, float dtime,
272 core::array<PrioritySortedBlockTransfer> &dest);
275 Connection and environment should be locked when this is called.
276 steps() objects of blocks not found in active_blocks, then
277 adds those blocks to active_blocks
282 core::map<v3s16, bool> &stepped_blocks
285 void GotBlock(v3s16 p);
287 void SentBlock(v3s16 p);
289 void SetBlockNotSent(v3s16 p);
290 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
294 return m_blocks_sending.size();
297 // Increments timeouts and removes timed-out blocks from list
298 // NOTE: This doesn't fix the server-not-sending-block bug
299 // because it is related to emerging, not sending.
300 //void RunSendingTimeouts(float dtime, float timeout);
302 void PrintInfo(std::ostream &o)
304 o<<"RemoteClient "<<peer_id<<": "
305 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
306 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
307 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
308 <<", m_excess_gotblocks="<<m_excess_gotblocks
310 m_excess_gotblocks = 0;
313 // Time from last placing or removing blocks
314 float m_time_from_building;
316 /*JMutex m_dig_mutex;
317 float m_dig_time_remaining;
320 v3s16 m_dig_position;*/
323 List of active objects that the client knows of.
326 core::map<u16, bool> m_known_objects;
330 Blocks that have been sent to client.
331 - These don't have to be sent again.
332 - A block is cleared from here when client says it has
333 deleted it from it's memory
335 Key is position, value is dummy.
336 No MapBlock* is stored here because the blocks can get deleted.
338 core::map<v3s16, bool> m_blocks_sent;
339 s16 m_nearest_unsent_d;
341 float m_nearest_unsent_reset_timer;
344 Blocks that are currently on the line.
345 This is used for throttling the sending of blocks.
346 - The size of this list is limited to some value
347 Block is added when it is sent with BLOCKDATA.
348 Block is removed when GOTBLOCKS is received.
349 Value is time from sending. (not used at the moment)
351 core::map<v3s16, float> m_blocks_sending;
354 Count of excess GotBlocks().
355 There is an excess amount because the client sometimes
356 gets a block so late that the server sends it again,
357 and the client then sends two GOTBLOCKs.
358 This is resetted by PrintInfo()
360 u32 m_excess_gotblocks;
362 // CPU usage optimization
363 u32 m_nothing_to_send_counter;
364 float m_nothing_to_send_pause_timer;
367 class Server : public con::PeerHandler, public MapEventReceiver,
368 public InventoryManager, public IGameDef
372 NOTE: Every public method should be thread-safe
376 std::string mapsavedir,
377 std::string configpath
380 void start(unsigned short port);
382 // This is mainly a way to pass the time to the server.
383 // Actual processing is done in an another thread.
384 void step(float dtime);
385 // This is run by ServerThread and does the actual processing
388 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
390 core::list<PlayerInfo> getPlayerInfo();
392 /*u32 getDayNightRatio()
394 return time_to_daynight_ratio(m_time_of_day.get());
397 // Environment must be locked when called
398 void setTimeOfDay(u32 time)
400 m_env->setTimeOfDay(time);
401 m_time_of_day_send_timer = 0;
404 bool getShutdownRequested()
406 return m_shutdown_requested;
410 Shall be called with the environment locked.
411 This is accessed by the map, which is inside the environment,
412 so it shouldn't be a problem.
414 void onMapEditEvent(MapEditEvent *event);
417 Shall be called with the environment and the connection locked.
419 Inventory* getInventory(InventoryContext *c, std::string id);
420 void inventoryModified(InventoryContext *c, std::string id);
422 // Connection must be locked when called
423 std::wstring getStatusString();
425 void requestShutdown(void)
427 m_shutdown_requested = true;
431 // Envlock and conlock should be locked when calling this
432 void SendMovePlayer(Player *player);
434 u64 getPlayerAuthPrivs(const std::string &name)
437 return m_authmanager.getPrivs(name);
439 catch(AuthNotFoundException &e)
441 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
446 void setPlayerAuthPrivs(const std::string &name, u64 privs)
449 return m_authmanager.setPrivs(name, privs);
451 catch(AuthNotFoundException &e)
453 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
457 // Saves g_settings to configpath given at initialization
460 void setIpBanned(const std::string &ip, const std::string &name)
462 m_banmanager.add(ip, name);
466 void unsetIpBanned(const std::string &ip_or_name)
468 m_banmanager.remove(ip_or_name);
472 std::string getBanDescription(const std::string &ip_or_name)
474 return m_banmanager.getBanDescription(ip_or_name);
477 Address getPeerAddress(u16 peer_id)
479 return m_con.GetPeerAddress(peer_id);
482 // Envlock and conlock should be locked when calling this
483 void notifyPlayer(const char *name, const std::wstring msg);
484 void notifyPlayers(const std::wstring msg);
486 // Envlock and conlock should be locked when using Lua
487 lua_State *getLua(){ return m_lua; }
489 // IGameDef interface
491 virtual IToolDefManager* getToolDefManager();
492 virtual INodeDefManager* getNodeDefManager();
493 virtual ITextureSource* getTextureSource();
494 virtual u16 allocateUnknownNodeId(const std::string &name);
496 IWritableToolDefManager* getWritableToolDefManager();
497 IWritableNodeDefManager* getWritableNodeDefManager();
501 // con::PeerHandler implementation.
502 // These queue stuff to be processed by handlePeerChanges().
503 // As of now, these create and remove clients and players.
504 void peerAdded(con::Peer *peer);
505 void deletingPeer(con::Peer *peer, bool timeout);
511 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
512 static void SendAccessDenied(con::Connection &con, u16 peer_id,
513 const std::wstring &reason);
514 static void SendDeathscreen(con::Connection &con, u16 peer_id,
515 bool set_camera_point_target, v3f camera_point_target);
516 static void SendToolDef(con::Connection &con, u16 peer_id,
517 IToolDefManager *tooldef);
518 static void SendNodeDef(con::Connection &con, u16 peer_id,
519 INodeDefManager *nodedef);
522 Non-static send methods.
523 Conlock should be always used.
524 Envlock usage is documented badly but it's easy to figure out
525 which ones access the environment.
528 // Envlock and conlock should be locked when calling these
529 void SendObjectData(float dtime);
530 void SendPlayerInfos();
531 void SendInventory(u16 peer_id);
532 // send wielded item info about player to all
533 void SendWieldedItem(const Player *player);
534 // send wielded item info about all players to all players
535 void SendPlayerItems();
536 void SendChatMessage(u16 peer_id, const std::wstring &message);
537 void BroadcastChatMessage(const std::wstring &message);
538 void SendPlayerHP(Player *player);
540 Send a node removal/addition event to all clients except ignore_id.
541 Additionally, if far_players!=NULL, players further away than
542 far_d_nodes are ignored and their peer_ids are added to far_players
544 // Envlock and conlock should be locked when calling these
545 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
546 core::list<u16> *far_players=NULL, float far_d_nodes=100);
547 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
548 core::list<u16> *far_players=NULL, float far_d_nodes=100);
549 void setBlockNotSent(v3s16 p);
551 // Environment and Connection must be locked when called
552 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
554 // Sends blocks to clients (locks env and con on its own)
555 void SendBlocks(float dtime);
557 void SendTextures(u16 peer_id);
563 void HandlePlayerHP(Player *player, s16 damage);
564 void RespawnPlayer(Player *player);
566 void UpdateCrafting(u16 peer_id);
568 // When called, connection mutex should be locked
569 RemoteClient* getClient(u16 peer_id);
571 // When called, environment mutex should be locked
572 std::string getPlayerName(u16 peer_id)
574 Player *player = m_env->getPlayer(peer_id);
576 return "[id="+itos(peer_id);
577 return player->getName();
581 Get a player from memory or creates one.
582 If player is already connected, return NULL
583 The password is not checked here - it is only used to
584 set the password if a new player is created.
586 Call with env and con locked.
588 Player *emergePlayer(const char *name, const char *password, u16 peer_id);
590 // Locks environment and connection by its own
592 void handlePeerChange(PeerChange &c);
593 void handlePeerChanges();
595 u64 getPlayerPrivs(Player *player);
602 float m_liquid_transform_timer;
603 float m_print_info_timer;
604 float m_objectdata_timer;
605 float m_emergethread_trigger_timer;
606 float m_savemap_timer;
607 IntervalLimiter m_map_timer_and_unload_interval;
609 // NOTE: If connection and environment are both to be locked,
610 // environment shall be locked first.
613 ServerEnvironment *m_env;
617 con::Connection m_con;
619 // Connected clients (behind the con mutex)
620 core::map<u16, RemoteClient*> m_clients;
622 // User authentication
623 AuthManager m_authmanager;
626 BanManager m_banmanager;
629 // Envlock and conlock should be locked when using Lua
632 // Tool definition manager
633 IWritableToolDefManager *m_toolmgr;
635 // Node definition manager
636 IWritableNodeDefManager *m_nodemgr;
642 // A buffer for time steps
643 // step() increments and AsyncRunStep() run by m_thread reads it.
645 JMutex m_step_dtime_mutex;
647 // The server mainly operates in this thread
648 ServerThread m_thread;
649 // This thread fetches and generates map
650 EmergeThread m_emergethread;
651 // Queue of block coordinates to be processed by the emerge thread
652 BlockEmergeQueue m_emerge_queue;
659 //MutexedVariable<u32> m_time_of_day;
660 // Used to buffer dtime for adding to m_time_of_day
661 float m_time_counter;
662 // Timer for sending time of day over network
663 float m_time_of_day_send_timer;
664 // Uptime of server in seconds
665 MutexedVariable<double> m_uptime;
669 Queues stuff from peerAdded() and deletingPeer() to
683 Queue<PeerChange> m_peer_change_queue;
690 std::string m_mapsavedir;
692 // Configuration path ("" = no configuration file)
693 std::string m_configpath;
695 // Mod parent directory paths
696 core::list<std::string> m_modspaths;
698 bool m_shutdown_requested;
701 Map edit event queue. Automatically receives all map edits.
702 The constructor of this class registers us to receive them through
705 NOTE: Should these be moved to actually be members of
710 Queue of map edits from the environment for sending to the clients
711 This is behind m_env_mutex
713 Queue<MapEditEvent*> m_unsent_map_edit_queue;
715 Set to true when the server itself is modifying the map and does
716 all sending of information by itself.
717 This is behind m_env_mutex
719 bool m_ignore_map_edit_events;
721 If set to !=0, the incoming MapEditEvents are modified to have
722 this peed id as the disabled recipient
723 This is behind m_env_mutex
725 u16 m_ignore_map_edit_events_peer_id;
727 friend class EmergeThread;
728 friend class RemoteClient;
732 Runs a simple dedicated server loop.
734 Shuts down when run is set to false.
736 void dedicated_server_loop(Server &server, bool &run);