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"
30 #include "inventory.h"
37 v3f findSpawnPos(ServerMap &map);
40 A structure containing the data needed for queueing the fetching
43 struct QueuedBlockEmerge
46 // key = peer_id, value = flags
47 core::map<u16, u8> peer_ids;
51 This is a thread-safe class.
53 class BlockEmergeQueue
63 JMutexAutoLock lock(m_mutex);
65 core::list<QueuedBlockEmerge*>::Iterator i;
66 for(i=m_queue.begin(); i!=m_queue.end(); i++)
68 QueuedBlockEmerge *q = *i;
74 peer_id=0 adds with nobody to send to
76 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
78 DSTACK(__FUNCTION_NAME);
80 JMutexAutoLock lock(m_mutex);
85 Find if block is already in queue.
86 If it is, update the peer to it and quit.
88 core::list<QueuedBlockEmerge*>::Iterator i;
89 for(i=m_queue.begin(); i!=m_queue.end(); i++)
91 QueuedBlockEmerge *q = *i;
94 q->peer_ids[peer_id] = flags;
103 QueuedBlockEmerge *q = new QueuedBlockEmerge;
106 q->peer_ids[peer_id] = flags;
107 m_queue.push_back(q);
110 // Returned pointer must be deleted
111 // Returns NULL if queue is empty
112 QueuedBlockEmerge * pop()
114 JMutexAutoLock lock(m_mutex);
116 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
117 if(i == m_queue.end())
119 QueuedBlockEmerge *q = *i;
126 JMutexAutoLock lock(m_mutex);
127 return m_queue.size();
130 u32 peerItemCount(u16 peer_id)
132 JMutexAutoLock lock(m_mutex);
136 core::list<QueuedBlockEmerge*>::Iterator i;
137 for(i=m_queue.begin(); i!=m_queue.end(); i++)
139 QueuedBlockEmerge *q = *i;
140 if(q->peer_ids.find(peer_id) != NULL)
148 core::list<QueuedBlockEmerge*> m_queue;
154 class ServerThread : public SimpleThread
160 ServerThread(Server *server):
169 class EmergeThread : public SimpleThread
175 EmergeThread(Server *server):
186 if(IsRunning() == false)
196 char name[PLAYERNAME_SIZE];
202 void PrintLine(std::ostream *s);
205 u32 PIChecksum(core::list<PlayerInfo> &l);
208 Used for queueing and sorting block transfers in containers
210 Lower priority number means higher priority.
212 struct PrioritySortedBlockTransfer
214 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
216 priority = a_priority;
220 bool operator < (PrioritySortedBlockTransfer &other)
222 return priority < other.priority;
232 // peer_id=0 means this client has no associated peer
233 // NOTE: If client is made allowed to exist while peer doesn't,
234 // this has to be set to 0 when there is no peer.
235 // Also, the client must be moved to some other container.
237 // The serialization version to use with the client
238 u8 serialization_version;
240 u16 net_proto_version;
241 // Version is stored in here after INIT before INIT2
242 u8 pending_serialization_version;
245 m_time_from_building(9999),
246 m_excess_gotblocks(0)
249 serialization_version = SER_FMT_VER_INVALID;
250 net_proto_version = 0;
251 pending_serialization_version = SER_FMT_VER_INVALID;
252 m_nearest_unsent_d = 0;
253 m_nearest_unsent_reset_timer = 0.0;
254 m_nothing_to_send_counter = 0;
255 m_nothing_to_send_pause_timer = 0;
262 Finds block that should be sent next to the client.
263 Environment should be locked when this is called.
264 dtime is used for resetting send radius at slow interval
266 void GetNextBlocks(Server *server, float dtime,
267 core::array<PrioritySortedBlockTransfer> &dest);
270 Connection and environment should be locked when this is called.
271 steps() objects of blocks not found in active_blocks, then
272 adds those blocks to active_blocks
277 core::map<v3s16, bool> &stepped_blocks
280 void GotBlock(v3s16 p);
282 void SentBlock(v3s16 p);
284 void SetBlockNotSent(v3s16 p);
285 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
289 return m_blocks_sending.size();
292 // Increments timeouts and removes timed-out blocks from list
293 // NOTE: This doesn't fix the server-not-sending-block bug
294 // because it is related to emerging, not sending.
295 //void RunSendingTimeouts(float dtime, float timeout);
297 void PrintInfo(std::ostream &o)
299 o<<"RemoteClient "<<peer_id<<": "
300 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
301 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
302 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
303 <<", m_excess_gotblocks="<<m_excess_gotblocks
305 m_excess_gotblocks = 0;
308 // Time from last placing or removing blocks
309 float m_time_from_building;
311 /*JMutex m_dig_mutex;
312 float m_dig_time_remaining;
315 v3s16 m_dig_position;*/
318 List of active objects that the client knows of.
321 core::map<u16, bool> m_known_objects;
325 Blocks that have been sent to client.
326 - These don't have to be sent again.
327 - A block is cleared from here when client says it has
328 deleted it from it's memory
330 Key is position, value is dummy.
331 No MapBlock* is stored here because the blocks can get deleted.
333 core::map<v3s16, bool> m_blocks_sent;
334 s16 m_nearest_unsent_d;
336 float m_nearest_unsent_reset_timer;
339 Blocks that are currently on the line.
340 This is used for throttling the sending of blocks.
341 - The size of this list is limited to some value
342 Block is added when it is sent with BLOCKDATA.
343 Block is removed when GOTBLOCKS is received.
344 Value is time from sending. (not used at the moment)
346 core::map<v3s16, float> m_blocks_sending;
349 Count of excess GotBlocks().
350 There is an excess amount because the client sometimes
351 gets a block so late that the server sends it again,
352 and the client then sends two GOTBLOCKs.
353 This is resetted by PrintInfo()
355 u32 m_excess_gotblocks;
357 // CPU usage optimization
358 u32 m_nothing_to_send_counter;
359 float m_nothing_to_send_pause_timer;
362 class Server : public con::PeerHandler, public MapEventReceiver,
363 public InventoryManager
367 NOTE: Every public method should be thread-safe
371 std::string mapsavedir,
372 std::string configpath
375 void start(unsigned short port);
377 // This is mainly a way to pass the time to the server.
378 // Actual processing is done in an another thread.
379 void step(float dtime);
380 // This is run by ServerThread and does the actual processing
383 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
385 core::list<PlayerInfo> getPlayerInfo();
387 /*u32 getDayNightRatio()
389 return time_to_daynight_ratio(m_time_of_day.get());
392 // Environment must be locked when called
393 void setTimeOfDay(u32 time)
395 m_env.setTimeOfDay(time);
396 m_time_of_day_send_timer = 0;
399 bool getShutdownRequested()
401 return m_shutdown_requested;
405 Shall be called with the environment locked.
406 This is accessed by the map, which is inside the environment,
407 so it shouldn't be a problem.
409 void onMapEditEvent(MapEditEvent *event);
412 Shall be called with the environment and the connection locked.
414 Inventory* getInventory(InventoryContext *c, std::string id);
415 void inventoryModified(InventoryContext *c, std::string id);
417 // Connection must be locked when called
418 std::wstring getStatusString();
420 void requestShutdown(void)
422 m_shutdown_requested = true;
426 // Envlock and conlock should be locked when calling this
427 void SendMovePlayer(Player *player);
429 u64 getPlayerAuthPrivs(const std::string &name)
432 return m_authmanager.getPrivs(name);
434 catch(AuthNotFoundException &e)
436 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
441 void setPlayerAuthPrivs(const std::string &name, u64 privs)
444 return m_authmanager.setPrivs(name, privs);
446 catch(AuthNotFoundException &e)
448 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
452 // Saves g_settings to configpath given at initialization
455 if(m_configpath != "")
456 g_settings.updateConfigFile(m_configpath.c_str());
459 void setIpBanned(const std::string &ip, const std::string &name)
461 m_banmanager.add(ip, name);
465 void unsetIpBanned(const std::string &ip_or_name)
467 m_banmanager.remove(ip_or_name);
471 std::string getBanDescription(const std::string &ip_or_name)
473 return m_banmanager.getBanDescription(ip_or_name);
476 con::Peer* getPeerNoEx(u16 peer_id)
478 return m_con.GetPeerNoEx(peer_id);
483 // con::PeerHandler implementation.
484 // These queue stuff to be processed by handlePeerChanges().
485 // As of now, these create and remove clients and players.
486 void peerAdded(con::Peer *peer);
487 void deletingPeer(con::Peer *peer, bool timeout);
493 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
494 static void SendAccessDenied(con::Connection &con, u16 peer_id,
495 const std::wstring &reason);
498 Non-static send methods
501 // Envlock and conlock should be locked when calling these
502 void SendObjectData(float dtime);
503 void SendPlayerInfos();
504 void SendInventory(u16 peer_id);
505 // send wielded item info about player to all
506 void SendWieldedItem(const Player *player);
507 // send wielded item info about all players to all players
508 void SendPlayerItems();
509 void SendChatMessage(u16 peer_id, const std::wstring &message);
510 void BroadcastChatMessage(const std::wstring &message);
511 void SendPlayerHP(Player *player);
513 Send a node removal/addition event to all clients except ignore_id.
514 Additionally, if far_players!=NULL, players further away than
515 far_d_nodes are ignored and their peer_ids are added to far_players
517 // Envlock and conlock should be locked when calling these
518 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
519 core::list<u16> *far_players=NULL, float far_d_nodes=100);
520 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
521 core::list<u16> *far_players=NULL, float far_d_nodes=100);
522 void setBlockNotSent(v3s16 p);
524 // Environment and Connection must be locked when called
525 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
527 // Sends blocks to clients (locks env and con on its own)
528 void SendBlocks(float dtime);
534 void UpdateCrafting(u16 peer_id);
536 // When called, connection mutex should be locked
537 RemoteClient* getClient(u16 peer_id);
539 // When called, environment mutex should be locked
540 std::string getPlayerName(u16 peer_id)
542 Player *player = m_env.getPlayer(peer_id);
544 return "[id="+itos(peer_id);
545 return player->getName();
549 Get a player from memory or creates one.
550 If player is already connected, return NULL
551 The password is not checked here - it is only used to
552 set the password if a new player is created.
554 Call with env and con locked.
556 Player *emergePlayer(const char *name, const char *password, u16 peer_id);
558 // Locks environment and connection by its own
560 void handlePeerChange(PeerChange &c);
561 void handlePeerChanges();
563 u64 getPlayerPrivs(Player *player);
570 float m_liquid_transform_timer;
571 float m_print_info_timer;
572 float m_objectdata_timer;
573 float m_emergethread_trigger_timer;
574 float m_savemap_timer;
575 IntervalLimiter m_map_timer_and_unload_interval;
577 // NOTE: If connection and environment are both to be locked,
578 // environment shall be locked first.
581 ServerEnvironment m_env;
585 con::Connection m_con;
587 // Connected clients (behind the con mutex)
588 core::map<u16, RemoteClient*> m_clients;
590 // User authentication
591 AuthManager m_authmanager;
594 BanManager m_banmanager;
600 // A buffer for time steps
601 // step() increments and AsyncRunStep() run by m_thread reads it.
603 JMutex m_step_dtime_mutex;
605 // The server mainly operates in this thread
606 ServerThread m_thread;
607 // This thread fetches and generates map
608 EmergeThread m_emergethread;
609 // Queue of block coordinates to be processed by the emerge thread
610 BlockEmergeQueue m_emerge_queue;
617 //MutexedVariable<u32> m_time_of_day;
618 // Used to buffer dtime for adding to m_time_of_day
619 float m_time_counter;
620 // Timer for sending time of day over network
621 float m_time_of_day_send_timer;
622 // Uptime of server in seconds
623 MutexedVariable<double> m_uptime;
627 Queues stuff from peerAdded() and deletingPeer() to
641 Queue<PeerChange> m_peer_change_queue;
648 std::string m_mapsavedir;
650 // Configuration path ("" = no configuration file)
651 std::string m_configpath;
653 bool m_shutdown_requested;
656 Map edit event queue. Automatically receives all map edits.
657 The constructor of this class registers us to receive them through
660 NOTE: Should these be moved to actually be members of
665 Queue of map edits from the environment for sending to the clients
666 This is behind m_env_mutex
668 Queue<MapEditEvent*> m_unsent_map_edit_queue;
670 Set to true when the server itself is modifying the map and does
671 all sending of information by itself.
672 This is behind m_env_mutex
674 bool m_ignore_map_edit_events;
676 If set to !=0, the incoming MapEditEvents are modified to have
677 this peed id as the disabled recipient
678 This is behind m_env_mutex
680 u16 m_ignore_map_edit_events_peer_id;
682 Profiler *m_profiler;
684 friend class EmergeThread;
685 friend class RemoteClient;
689 Runs a simple dedicated server loop.
691 Shuts down when run is set to false.
693 void dedicated_server_loop(Server &server, bool &run);