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 typedef struct lua_State lua_State;
38 v3f findSpawnPos(ServerMap &map);
41 A structure containing the data needed for queueing the fetching
44 struct QueuedBlockEmerge
47 // key = peer_id, value = flags
48 core::map<u16, u8> peer_ids;
52 This is a thread-safe class.
54 class BlockEmergeQueue
64 JMutexAutoLock lock(m_mutex);
66 core::list<QueuedBlockEmerge*>::Iterator i;
67 for(i=m_queue.begin(); i!=m_queue.end(); i++)
69 QueuedBlockEmerge *q = *i;
75 peer_id=0 adds with nobody to send to
77 void addBlock(u16 peer_id, v3s16 pos, u8 flags)
79 DSTACK(__FUNCTION_NAME);
81 JMutexAutoLock lock(m_mutex);
86 Find if block is already in queue.
87 If it is, update the peer to it and quit.
89 core::list<QueuedBlockEmerge*>::Iterator i;
90 for(i=m_queue.begin(); i!=m_queue.end(); i++)
92 QueuedBlockEmerge *q = *i;
95 q->peer_ids[peer_id] = flags;
104 QueuedBlockEmerge *q = new QueuedBlockEmerge;
107 q->peer_ids[peer_id] = flags;
108 m_queue.push_back(q);
111 // Returned pointer must be deleted
112 // Returns NULL if queue is empty
113 QueuedBlockEmerge * pop()
115 JMutexAutoLock lock(m_mutex);
117 core::list<QueuedBlockEmerge*>::Iterator i = m_queue.begin();
118 if(i == m_queue.end())
120 QueuedBlockEmerge *q = *i;
127 JMutexAutoLock lock(m_mutex);
128 return m_queue.size();
131 u32 peerItemCount(u16 peer_id)
133 JMutexAutoLock lock(m_mutex);
137 core::list<QueuedBlockEmerge*>::Iterator i;
138 for(i=m_queue.begin(); i!=m_queue.end(); i++)
140 QueuedBlockEmerge *q = *i;
141 if(q->peer_ids.find(peer_id) != NULL)
149 core::list<QueuedBlockEmerge*> m_queue;
155 class ServerThread : public SimpleThread
161 ServerThread(Server *server):
170 class EmergeThread : public SimpleThread
176 EmergeThread(Server *server):
187 if(IsRunning() == false)
197 char name[PLAYERNAME_SIZE];
203 void PrintLine(std::ostream *s);
206 u32 PIChecksum(core::list<PlayerInfo> &l);
209 Used for queueing and sorting block transfers in containers
211 Lower priority number means higher priority.
213 struct PrioritySortedBlockTransfer
215 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
217 priority = a_priority;
221 bool operator < (PrioritySortedBlockTransfer &other)
223 return priority < other.priority;
233 // peer_id=0 means this client has no associated peer
234 // NOTE: If client is made allowed to exist while peer doesn't,
235 // this has to be set to 0 when there is no peer.
236 // Also, the client must be moved to some other container.
238 // The serialization version to use with the client
239 u8 serialization_version;
241 u16 net_proto_version;
242 // Version is stored in here after INIT before INIT2
243 u8 pending_serialization_version;
246 m_time_from_building(9999),
247 m_excess_gotblocks(0)
250 serialization_version = SER_FMT_VER_INVALID;
251 net_proto_version = 0;
252 pending_serialization_version = SER_FMT_VER_INVALID;
253 m_nearest_unsent_d = 0;
254 m_nearest_unsent_reset_timer = 0.0;
255 m_nothing_to_send_counter = 0;
256 m_nothing_to_send_pause_timer = 0;
263 Finds block that should be sent next to the client.
264 Environment should be locked when this is called.
265 dtime is used for resetting send radius at slow interval
267 void GetNextBlocks(Server *server, float dtime,
268 core::array<PrioritySortedBlockTransfer> &dest);
271 Connection and environment should be locked when this is called.
272 steps() objects of blocks not found in active_blocks, then
273 adds those blocks to active_blocks
278 core::map<v3s16, bool> &stepped_blocks
281 void GotBlock(v3s16 p);
283 void SentBlock(v3s16 p);
285 void SetBlockNotSent(v3s16 p);
286 void SetBlocksNotSent(core::map<v3s16, MapBlock*> &blocks);
290 return m_blocks_sending.size();
293 // Increments timeouts and removes timed-out blocks from list
294 // NOTE: This doesn't fix the server-not-sending-block bug
295 // because it is related to emerging, not sending.
296 //void RunSendingTimeouts(float dtime, float timeout);
298 void PrintInfo(std::ostream &o)
300 o<<"RemoteClient "<<peer_id<<": "
301 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
302 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
303 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
304 <<", m_excess_gotblocks="<<m_excess_gotblocks
306 m_excess_gotblocks = 0;
309 // Time from last placing or removing blocks
310 float m_time_from_building;
312 /*JMutex m_dig_mutex;
313 float m_dig_time_remaining;
316 v3s16 m_dig_position;*/
319 List of active objects that the client knows of.
322 core::map<u16, bool> m_known_objects;
326 Blocks that have been sent to client.
327 - These don't have to be sent again.
328 - A block is cleared from here when client says it has
329 deleted it from it's memory
331 Key is position, value is dummy.
332 No MapBlock* is stored here because the blocks can get deleted.
334 core::map<v3s16, bool> m_blocks_sent;
335 s16 m_nearest_unsent_d;
337 float m_nearest_unsent_reset_timer;
340 Blocks that are currently on the line.
341 This is used for throttling the sending of blocks.
342 - The size of this list is limited to some value
343 Block is added when it is sent with BLOCKDATA.
344 Block is removed when GOTBLOCKS is received.
345 Value is time from sending. (not used at the moment)
347 core::map<v3s16, float> m_blocks_sending;
350 Count of excess GotBlocks().
351 There is an excess amount because the client sometimes
352 gets a block so late that the server sends it again,
353 and the client then sends two GOTBLOCKs.
354 This is resetted by PrintInfo()
356 u32 m_excess_gotblocks;
358 // CPU usage optimization
359 u32 m_nothing_to_send_counter;
360 float m_nothing_to_send_pause_timer;
363 class Server : public con::PeerHandler, public MapEventReceiver,
364 public InventoryManager
368 NOTE: Every public method should be thread-safe
372 std::string mapsavedir,
373 std::string configpath
376 void start(unsigned short port);
378 // This is mainly a way to pass the time to the server.
379 // Actual processing is done in an another thread.
380 void step(float dtime);
381 // This is run by ServerThread and does the actual processing
384 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
386 core::list<PlayerInfo> getPlayerInfo();
388 /*u32 getDayNightRatio()
390 return time_to_daynight_ratio(m_time_of_day.get());
393 // Environment must be locked when called
394 void setTimeOfDay(u32 time)
396 m_env->setTimeOfDay(time);
397 m_time_of_day_send_timer = 0;
400 bool getShutdownRequested()
402 return m_shutdown_requested;
406 Shall be called with the environment locked.
407 This is accessed by the map, which is inside the environment,
408 so it shouldn't be a problem.
410 void onMapEditEvent(MapEditEvent *event);
413 Shall be called with the environment and the connection locked.
415 Inventory* getInventory(InventoryContext *c, std::string id);
416 void inventoryModified(InventoryContext *c, std::string id);
418 // Connection must be locked when called
419 std::wstring getStatusString();
421 void requestShutdown(void)
423 m_shutdown_requested = true;
427 // Envlock and conlock should be locked when calling this
428 void SendMovePlayer(Player *player);
430 u64 getPlayerAuthPrivs(const std::string &name)
433 return m_authmanager.getPrivs(name);
435 catch(AuthNotFoundException &e)
437 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
442 void setPlayerAuthPrivs(const std::string &name, u64 privs)
445 return m_authmanager.setPrivs(name, privs);
447 catch(AuthNotFoundException &e)
449 dstream<<"WARNING: Auth not found for "<<name<<std::endl;
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 // Envlock and conlock should be locked when using Lua
483 lua_State *getLua(){ return m_lua; }
487 // con::PeerHandler implementation.
488 // These queue stuff to be processed by handlePeerChanges().
489 // As of now, these create and remove clients and players.
490 void peerAdded(con::Peer *peer);
491 void deletingPeer(con::Peer *peer, bool timeout);
497 static void SendHP(con::Connection &con, u16 peer_id, u8 hp);
498 static void SendAccessDenied(con::Connection &con, u16 peer_id,
499 const std::wstring &reason);
500 static void SendDeathscreen(con::Connection &con, u16 peer_id,
501 bool set_camera_point_target, v3f camera_point_target);
504 Non-static send methods
507 // Envlock and conlock should be locked when calling these
508 void SendObjectData(float dtime);
509 void SendPlayerInfos();
510 void SendInventory(u16 peer_id);
511 // send wielded item info about player to all
512 void SendWieldedItem(const Player *player);
513 // send wielded item info about all players to all players
514 void SendPlayerItems();
515 void SendChatMessage(u16 peer_id, const std::wstring &message);
516 void BroadcastChatMessage(const std::wstring &message);
517 void SendPlayerHP(Player *player);
519 Send a node removal/addition event to all clients except ignore_id.
520 Additionally, if far_players!=NULL, players further away than
521 far_d_nodes are ignored and their peer_ids are added to far_players
523 // Envlock and conlock should be locked when calling these
524 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
525 core::list<u16> *far_players=NULL, float far_d_nodes=100);
526 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
527 core::list<u16> *far_players=NULL, float far_d_nodes=100);
528 void setBlockNotSent(v3s16 p);
530 // Environment and Connection must be locked when called
531 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver);
533 // Sends blocks to clients (locks env and con on its own)
534 void SendBlocks(float dtime);
540 void HandlePlayerHP(Player *player, s16 damage);
541 void RespawnPlayer(Player *player);
543 void UpdateCrafting(u16 peer_id);
545 // When called, connection mutex should be locked
546 RemoteClient* getClient(u16 peer_id);
548 // When called, environment mutex should be locked
549 std::string getPlayerName(u16 peer_id)
551 Player *player = m_env->getPlayer(peer_id);
553 return "[id="+itos(peer_id);
554 return player->getName();
558 Get a player from memory or creates one.
559 If player is already connected, return NULL
560 The password is not checked here - it is only used to
561 set the password if a new player is created.
563 Call with env and con locked.
565 Player *emergePlayer(const char *name, const char *password, u16 peer_id);
567 // Locks environment and connection by its own
569 void handlePeerChange(PeerChange &c);
570 void handlePeerChanges();
572 u64 getPlayerPrivs(Player *player);
579 float m_liquid_transform_timer;
580 float m_print_info_timer;
581 float m_objectdata_timer;
582 float m_emergethread_trigger_timer;
583 float m_savemap_timer;
584 IntervalLimiter m_map_timer_and_unload_interval;
586 // NOTE: If connection and environment are both to be locked,
587 // environment shall be locked first.
590 ServerEnvironment *m_env;
594 con::Connection m_con;
596 // Connected clients (behind the con mutex)
597 core::map<u16, RemoteClient*> m_clients;
599 // User authentication
600 AuthManager m_authmanager;
603 BanManager m_banmanager;
606 // Envlock and conlock should be locked when using Lua
613 // A buffer for time steps
614 // step() increments and AsyncRunStep() run by m_thread reads it.
616 JMutex m_step_dtime_mutex;
618 // The server mainly operates in this thread
619 ServerThread m_thread;
620 // This thread fetches and generates map
621 EmergeThread m_emergethread;
622 // Queue of block coordinates to be processed by the emerge thread
623 BlockEmergeQueue m_emerge_queue;
630 //MutexedVariable<u32> m_time_of_day;
631 // Used to buffer dtime for adding to m_time_of_day
632 float m_time_counter;
633 // Timer for sending time of day over network
634 float m_time_of_day_send_timer;
635 // Uptime of server in seconds
636 MutexedVariable<double> m_uptime;
640 Queues stuff from peerAdded() and deletingPeer() to
654 Queue<PeerChange> m_peer_change_queue;
661 std::string m_mapsavedir;
663 // Configuration path ("" = no configuration file)
664 std::string m_configpath;
666 bool m_shutdown_requested;
669 Map edit event queue. Automatically receives all map edits.
670 The constructor of this class registers us to receive them through
673 NOTE: Should these be moved to actually be members of
678 Queue of map edits from the environment for sending to the clients
679 This is behind m_env_mutex
681 Queue<MapEditEvent*> m_unsent_map_edit_queue;
683 Set to true when the server itself is modifying the map and does
684 all sending of information by itself.
685 This is behind m_env_mutex
687 bool m_ignore_map_edit_events;
689 If set to !=0, the incoming MapEditEvents are modified to have
690 this peed id as the disabled recipient
691 This is behind m_env_mutex
693 u16 m_ignore_map_edit_events_peer_id;
695 Profiler *m_profiler;
697 friend class EmergeThread;
698 friend class RemoteClient;
702 Runs a simple dedicated server loop.
704 Shuts down when run is set to false.
706 void dedicated_server_loop(Server &server, bool &run);