3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser 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.
24 #include "network/connection.h"
25 #include "network/networkprotocol.h"
26 #include "network/serveropcodes.h"
28 #include "environment.h"
30 #include "threading/mutex_auto_lock.h"
31 #include "constants.h"
37 #include "server/serveractiveobject.h"
41 #include "scripting_server.h"
46 #include "mapgen/mapgen.h"
47 #include "mapgen/mg_biome.h"
48 #include "content_mapnode.h"
49 #include "content_nodemeta.h"
50 #include "content/mods.h"
51 #include "modchannels.h"
52 #include "serverlist.h"
53 #include "util/string.h"
55 #include "util/serialize.h"
56 #include "util/thread.h"
57 #include "defaultsettings.h"
58 #include "server/mods.h"
59 #include "util/base64.h"
60 #include "util/sha1.h"
62 #include "database/database.h"
63 #include "chatmessage.h"
64 #include "chat_interface.h"
65 #include "remoteplayer.h"
66 #include "server/player_sao.h"
67 #include "server/serverinventorymgr.h"
68 #include "translation.h"
70 class ClientNotFoundException : public BaseException
73 ClientNotFoundException(const char *s):
78 class ServerThread : public Thread
82 ServerThread(Server *server):
93 void *ServerThread::run()
95 BEGIN_DEBUG_EXCEPTION_HANDLER
98 * The real business of the server happens on the ServerThread.
100 * AsyncRunStep() runs an actual server step as soon as enough time has
101 * passed (dedicated_server_loop keeps track of that).
102 * Receive() blocks at least(!) 30ms waiting for a packet (so this loop
103 * doesn't busy wait) and will process any remaining packets.
106 m_server->AsyncRunStep(true);
108 while (!stopRequested()) {
110 m_server->AsyncRunStep();
114 } catch (con::PeerNotFoundException &e) {
115 infostream<<"Server: PeerNotFoundException"<<std::endl;
116 } catch (ClientNotFoundException &e) {
117 } catch (con::ConnectionBindFailed &e) {
118 m_server->setAsyncFatalError(e.what());
119 } catch (LuaError &e) {
120 m_server->setAsyncFatalError(
121 "ServerThread::run Lua: " + std::string(e.what()));
125 END_DEBUG_EXCEPTION_HANDLER
130 v3f ServerSoundParams::getPos(ServerEnvironment *env, bool *pos_exists) const
132 if(pos_exists) *pos_exists = false;
137 if(pos_exists) *pos_exists = true;
142 ServerActiveObject *sao = env->getActiveObject(object);
145 if(pos_exists) *pos_exists = true;
146 return sao->getBasePosition(); }
151 void Server::ShutdownState::reset()
155 should_reconnect = false;
156 is_requested = false;
159 void Server::ShutdownState::trigger(float delay, const std::string &msg, bool reconnect)
163 should_reconnect = reconnect;
166 void Server::ShutdownState::tick(float dtime, Server *server)
172 static const float shutdown_msg_times[] =
174 1, 2, 3, 4, 5, 10, 20, 40, 60, 120, 180, 300, 600, 1200, 1800, 3600
177 // Automated messages
178 if (m_timer < shutdown_msg_times[ARRLEN(shutdown_msg_times) - 1]) {
179 for (float t : shutdown_msg_times) {
180 // If shutdown timer matches an automessage, shot it
181 if (m_timer > t && m_timer - dtime < t) {
182 std::wstring periodicMsg = getShutdownTimerMessage();
184 infostream << wide_to_utf8(periodicMsg).c_str() << std::endl;
185 server->SendChatMessage(PEER_ID_INEXISTENT, periodicMsg);
192 if (m_timer < 0.0f) {
198 std::wstring Server::ShutdownState::getShutdownTimerMessage() const
200 std::wstringstream ws;
201 ws << L"*** Server shutting down in "
202 << duration_to_string(myround(m_timer)).c_str() << ".";
211 const std::string &path_world,
212 const SubgameSpec &gamespec,
213 bool simple_singleplayer_mode,
218 m_bind_addr(bind_addr),
219 m_path_world(path_world),
220 m_gamespec(gamespec),
221 m_simple_singleplayer_mode(simple_singleplayer_mode),
222 m_dedicated(dedicated),
223 m_async_fatal_error(""),
224 m_con(std::make_shared<con::Connection>(PROTOCOL_ID,
227 m_bind_addr.isIPv6(),
229 m_itemdef(createItemDefManager()),
230 m_nodedef(createNodeDefManager()),
231 m_craftdef(createCraftDefManager()),
232 m_thread(new ServerThread(this)),
235 m_modchannel_mgr(new ModChannelMgr())
237 if (m_path_world.empty())
238 throw ServerError("Supplied empty world path");
240 if (!gamespec.isValid())
241 throw ServerError("Supplied invalid gamespec");
244 m_metrics_backend = std::unique_ptr<MetricsBackend>(createPrometheusMetricsBackend());
246 m_metrics_backend = std::unique_ptr<MetricsBackend>(new MetricsBackend());
249 m_uptime_counter = m_metrics_backend->addCounter("minetest_core_server_uptime", "Server uptime (in seconds)");
250 m_player_gauge = m_metrics_backend->addGauge("minetest_core_player_number", "Number of connected players");
252 m_timeofday_gauge = m_metrics_backend->addGauge(
253 "minetest_core_timeofday",
254 "Time of day value");
256 m_lag_gauge = m_metrics_backend->addGauge(
257 "minetest_core_latency",
258 "Latency value (in seconds)");
260 m_aom_buffer_counter = m_metrics_backend->addCounter(
261 "minetest_core_aom_generated_count",
262 "Number of active object messages generated");
264 m_packet_recv_counter = m_metrics_backend->addCounter(
265 "minetest_core_server_packet_recv",
266 "Processable packets received");
268 m_packet_recv_processed_counter = m_metrics_backend->addCounter(
269 "minetest_core_server_packet_recv_processed",
270 "Valid received packets processed");
272 m_lag_gauge->set(g_settings->getFloat("dedicated_server_step"));
278 // Send shutdown message
279 SendChatMessage(PEER_ID_INEXISTENT, ChatMessage(CHATMESSAGE_TYPE_ANNOUNCE,
280 L"*** Server shutting down"));
283 MutexAutoLock envlock(m_env_mutex);
285 infostream << "Server: Saving players" << std::endl;
286 m_env->saveLoadedPlayers();
288 infostream << "Server: Kicking players" << std::endl;
289 std::string kick_msg;
290 bool reconnect = false;
291 if (isShutdownRequested()) {
292 reconnect = m_shutdown_state.should_reconnect;
293 kick_msg = m_shutdown_state.message;
295 if (kick_msg.empty()) {
296 kick_msg = g_settings->get("kick_msg_shutdown");
298 m_env->saveLoadedPlayers(true);
299 m_env->kickAllPlayers(SERVER_ACCESSDENIED_SHUTDOWN,
300 kick_msg, reconnect);
303 actionstream << "Server: Shutting down" << std::endl;
305 // Do this before stopping the server in case mapgen callbacks need to access
306 // server-controlled resources (like ModStorages). Also do them before
307 // shutdown callbacks since they may modify state that is finalized in a
310 m_emerge->stopThreads();
313 MutexAutoLock envlock(m_env_mutex);
315 // Execute script shutdown hooks
316 infostream << "Executing shutdown hooks" << std::endl;
317 m_script->on_shutdown();
319 infostream << "Server: Saving environment metadata" << std::endl;
329 // Delete things in the reverse order of creation
338 // Deinitialize scripting
339 infostream << "Server: Deinitializing scripting" << std::endl;
342 while (!m_unsent_map_edit_queue.empty()) {
343 delete m_unsent_map_edit_queue.front();
344 m_unsent_map_edit_queue.pop();
350 infostream << "Server created for gameid \"" << m_gamespec.id << "\"";
351 if (m_simple_singleplayer_mode)
352 infostream << " in simple singleplayer mode" << std::endl;
354 infostream << std::endl;
355 infostream << "- world: " << m_path_world << std::endl;
356 infostream << "- game: " << m_gamespec.path << std::endl;
358 // Create world if it doesn't exist
359 if (!loadGameConfAndInitWorld(m_path_world, m_gamespec))
360 throw ServerError("Failed to initialize world");
362 // Create emerge manager
363 m_emerge = new EmergeManager(this);
365 // Create ban manager
366 std::string ban_path = m_path_world + DIR_DELIM "ipban.txt";
367 m_banmanager = new BanManager(ban_path);
369 m_modmgr = std::unique_ptr<ServerModManager>(new ServerModManager(m_path_world));
370 std::vector<ModSpec> unsatisfied_mods = m_modmgr->getUnsatisfiedMods();
371 // complain about mods with unsatisfied dependencies
372 if (!m_modmgr->isConsistent()) {
373 m_modmgr->printUnsatisfiedModsError();
377 MutexAutoLock envlock(m_env_mutex);
379 // Create the Map (loads map_meta.txt, overriding configured mapgen params)
380 ServerMap *servermap = new ServerMap(m_path_world, this, m_emerge, m_metrics_backend.get());
382 // Initialize scripting
383 infostream << "Server: Initializing Lua" << std::endl;
385 m_script = new ServerScripting(this);
387 // Must be created before mod loading because we have some inventory creation
388 m_inventory_mgr = std::unique_ptr<ServerInventoryManager>(new ServerInventoryManager());
390 m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME);
392 m_modmgr->loadMods(m_script);
394 // Read Textures and calculate sha1 sums
397 // Apply item aliases in the node definition manager
398 m_nodedef->updateAliases(m_itemdef);
400 // Apply texture overrides from texturepack/override.txt
401 std::vector<std::string> paths;
402 fs::GetRecursiveDirs(paths, g_settings->get("texture_path"));
403 fs::GetRecursiveDirs(paths, m_gamespec.path + DIR_DELIM + "textures");
404 for (const std::string &path : paths) {
405 TextureOverrideSource override_source(path + DIR_DELIM + "override.txt");
406 m_nodedef->applyTextureOverrides(override_source.getNodeTileOverrides());
407 m_itemdef->applyTextureOverrides(override_source.getItemTextureOverrides());
410 m_nodedef->setNodeRegistrationStatus(true);
412 // Perform pending node name resolutions
413 m_nodedef->runNodeResolveCallbacks();
415 // unmap node names in cross-references
416 m_nodedef->resolveCrossrefs();
418 // init the recipe hashes to speed up crafting
419 m_craftdef->initHashes(this);
421 // Initialize Environment
422 m_env = new ServerEnvironment(servermap, m_script, this, m_path_world);
424 m_inventory_mgr->setEnv(m_env);
425 m_clients.setEnv(m_env);
427 if (!servermap->settings_mgr.makeMapgenParams())
428 FATAL_ERROR("Couldn't create any mapgen type");
430 // Initialize mapgens
431 m_emerge->initMapgens(servermap->getMapgenParams());
433 if (g_settings->getBool("enable_rollback_recording")) {
434 // Create rollback manager
435 m_rollback = new RollbackManager(m_path_world, this);
438 // Give environment reference to scripting api
439 m_script->initializeEnvironment(m_env);
441 // Register us to receive map edit events
442 servermap->addEventReceiver(this);
446 // Those settings can be overwritten in world.mt, they are
447 // intended to be cached after environment loading.
448 m_liquid_transform_every = g_settings->getFloat("liquid_update");
449 m_max_chatmessage_length = g_settings->getU16("chat_message_max_size");
450 m_csm_restriction_flags = g_settings->getU64("csm_restriction_flags");
451 m_csm_restriction_noderange = g_settings->getU32("csm_restriction_noderange");
458 infostream << "Starting server on " << m_bind_addr.serializeString()
459 << "..." << std::endl;
461 // Stop thread if already running
464 // Initialize connection
465 m_con->SetTimeoutMs(30);
466 m_con->Serve(m_bind_addr);
471 // ASCII art for the win!
473 << " .__ __ __ " << std::endl
474 << " _____ |__| ____ _____/ |_ ____ _______/ |_ " << std::endl
475 << " / \\| |/ \\_/ __ \\ __\\/ __ \\ / ___/\\ __\\" << std::endl
476 << "| Y Y \\ | | \\ ___/| | \\ ___/ \\___ \\ | | " << std::endl
477 << "|__|_| /__|___| /\\___ >__| \\___ >____ > |__| " << std::endl
478 << " \\/ \\/ \\/ \\/ \\/ " << std::endl;
479 actionstream << "World at [" << m_path_world << "]" << std::endl;
480 actionstream << "Server for gameid=\"" << m_gamespec.id
481 << "\" listening on " << m_bind_addr.serializeString() << ":"
482 << m_bind_addr.getPort() << "." << std::endl;
487 infostream<<"Server: Stopping and waiting threads"<<std::endl;
489 // Stop threads (set run=false first so both start stopping)
491 //m_emergethread.setRun(false);
493 //m_emergethread.stop();
495 infostream<<"Server: Threads stopped"<<std::endl;
498 void Server::step(float dtime)
504 MutexAutoLock lock(m_step_dtime_mutex);
505 m_step_dtime += dtime;
507 // Throw if fatal error occurred in thread
508 std::string async_err = m_async_fatal_error.get();
509 if (!async_err.empty()) {
510 if (!m_simple_singleplayer_mode) {
511 m_env->kickAllPlayers(SERVER_ACCESSDENIED_CRASH,
512 g_settings->get("kick_msg_crash"),
513 g_settings->getBool("ask_reconnect_on_crash"));
515 throw ServerError("AsyncErr: " + async_err);
519 void Server::AsyncRunStep(bool initial_step)
524 MutexAutoLock lock1(m_step_dtime_mutex);
525 dtime = m_step_dtime;
529 // Send blocks to clients
533 if((dtime < 0.001) && !initial_step)
536 ScopeProfiler sp(g_profiler, "Server::AsyncRunStep()", SPT_AVG);
539 MutexAutoLock lock1(m_step_dtime_mutex);
540 m_step_dtime -= dtime;
546 m_uptime_counter->increment(dtime);
551 Update time of day and overall game time
553 m_env->setTimeOfDaySpeed(g_settings->getFloat("time_speed"));
556 Send to clients at constant intervals
559 m_time_of_day_send_timer -= dtime;
560 if (m_time_of_day_send_timer < 0.0) {
561 m_time_of_day_send_timer = g_settings->getFloat("time_send_interval");
562 u16 time = m_env->getTimeOfDay();
563 float time_speed = g_settings->getFloat("time_speed");
564 SendTimeOfDay(PEER_ID_INEXISTENT, time, time_speed);
566 m_timeofday_gauge->set(time);
570 MutexAutoLock lock(m_env_mutex);
571 // Figure out and report maximum lag to environment
572 float max_lag = m_env->getMaxLagEstimate();
573 max_lag *= 0.9998; // Decrease slowly (about half per 5 minutes)
575 if(dtime > 0.1 && dtime > max_lag * 2.0)
576 infostream<<"Server: Maximum lag peaked to "<<dtime
580 m_env->reportMaxLagEstimate(max_lag);
585 static const float map_timer_and_unload_dtime = 2.92;
586 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime))
588 MutexAutoLock lock(m_env_mutex);
589 // Run Map's timers and unload unused data
590 ScopeProfiler sp(g_profiler, "Server: map timer and unload");
591 m_env->getMap().timerUpdate(map_timer_and_unload_dtime,
592 g_settings->getFloat("server_unload_unused_data_timeout"),
597 Listen to the admin chat, if available
600 if (!m_admin_chat->command_queue.empty()) {
601 MutexAutoLock lock(m_env_mutex);
602 while (!m_admin_chat->command_queue.empty()) {
603 ChatEvent *evt = m_admin_chat->command_queue.pop_frontNoEx();
604 handleChatInterfaceEvent(evt);
608 m_admin_chat->outgoing_queue.push_back(
609 new ChatEventTimeInfo(m_env->getGameTime(), m_env->getTimeOfDay()));
616 /* Transform liquids */
617 m_liquid_transform_timer += dtime;
618 if(m_liquid_transform_timer >= m_liquid_transform_every)
620 m_liquid_transform_timer -= m_liquid_transform_every;
622 MutexAutoLock lock(m_env_mutex);
624 ScopeProfiler sp(g_profiler, "Server: liquid transform");
626 std::map<v3s16, MapBlock*> modified_blocks;
627 m_env->getMap().transformLiquids(modified_blocks, m_env);
630 Set the modified blocks unsent for all the clients
632 if (!modified_blocks.empty()) {
633 SetBlocksNotSent(modified_blocks);
636 m_clients.step(dtime);
638 m_lag_gauge->increment((m_lag_gauge->get() > dtime ? -1 : 1) * dtime/100);
640 // send masterserver announce
642 float &counter = m_masterserver_timer;
643 if (!isSingleplayer() && (!counter || counter >= 300.0) &&
644 g_settings->getBool("server_announce")) {
645 ServerList::sendAnnounce(counter ? ServerList::AA_UPDATE :
646 ServerList::AA_START,
647 m_bind_addr.getPort(),
648 m_clients.getPlayerNames(),
649 m_uptime_counter->get(),
650 m_env->getGameTime(),
653 Mapgen::getMapgenName(m_emerge->mgparams->mgtype),
663 Check added and deleted active objects
666 //infostream<<"Server: Checking added and deleted active objects"<<std::endl;
667 MutexAutoLock envlock(m_env_mutex);
670 const RemoteClientMap &clients = m_clients.getClientList();
671 ScopeProfiler sp(g_profiler, "Server: update objects within range");
673 m_player_gauge->set(clients.size());
674 for (const auto &client_it : clients) {
675 RemoteClient *client = client_it.second;
677 if (client->getState() < CS_DefinitionsSent)
680 // This can happen if the client times out somehow
681 if (!m_env->getPlayer(client->peer_id))
684 PlayerSAO *playersao = getPlayerSAO(client->peer_id);
688 SendActiveObjectRemoveAdd(client, playersao);
692 // Save mod storages if modified
693 m_mod_storage_save_timer -= dtime;
694 if (m_mod_storage_save_timer <= 0.0f) {
695 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
697 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
698 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
699 if (it->second->isModified()) {
700 it->second->save(getModStoragePath());
705 infostream << "Saved " << n << " modified mod storages." << std::endl;
713 MutexAutoLock envlock(m_env_mutex);
714 ScopeProfiler sp(g_profiler, "Server: send SAO messages");
717 // Value = data sent by object
718 std::unordered_map<u16, std::vector<ActiveObjectMessage>*> buffered_messages;
720 // Get active object messages from environment
722 ActiveObjectMessage aom = m_env->getActiveObjectMessage();
726 std::vector<ActiveObjectMessage>* message_list = nullptr;
727 std::unordered_map<u16, std::vector<ActiveObjectMessage>* >::iterator n;
728 n = buffered_messages.find(aom.id);
729 if (n == buffered_messages.end()) {
730 message_list = new std::vector<ActiveObjectMessage>;
731 buffered_messages[aom.id] = message_list;
734 message_list = n->second;
736 message_list->push_back(aom);
739 m_aom_buffer_counter->increment(buffered_messages.size());
742 const RemoteClientMap &clients = m_clients.getClientList();
743 // Route data to every client
744 for (const auto &client_it : clients) {
745 RemoteClient *client = client_it.second;
746 PlayerSAO *player = getPlayerSAO(client->peer_id);
747 std::string reliable_data;
748 std::string unreliable_data;
749 // Go through all objects in message buffer
750 for (const auto &buffered_message : buffered_messages) {
751 // If object does not exist or is not known by client, skip it
752 u16 id = buffered_message.first;
753 ServerActiveObject *sao = m_env->getActiveObject(id);
754 if (!sao || client->m_known_objects.find(id) == client->m_known_objects.end())
757 // Get message list of object
758 std::vector<ActiveObjectMessage>* list = buffered_message.second;
759 // Go through every message
760 for (const ActiveObjectMessage &aom : *list) {
761 // Send position updates to players who do not see the attachment
762 if (aom.datastring[0] == AO_CMD_UPDATE_POSITION) {
763 if (sao->getId() == player->getId())
766 // Do not send position updates for attached players
767 // as long the parent is known to the client
768 ServerActiveObject *parent = sao->getParent();
769 if (parent && client->m_known_objects.find(parent->getId()) !=
770 client->m_known_objects.end())
773 // Compose the full new data with header
774 std::string new_data;
777 writeU16((u8*)&buf[0], aom.id);
778 new_data.append(buf, 2);
780 new_data += serializeString(aom.datastring);
781 // Add data to buffer
783 reliable_data += new_data;
785 unreliable_data += new_data;
789 reliable_data and unreliable_data are now ready.
792 if (!reliable_data.empty()) {
793 SendActiveObjectMessages(client->peer_id, reliable_data);
796 if (!unreliable_data.empty()) {
797 SendActiveObjectMessages(client->peer_id, unreliable_data, false);
802 // Clear buffered_messages
803 for (auto &buffered_message : buffered_messages) {
804 delete buffered_message.second;
809 Send queued-for-sending map edit events.
812 // We will be accessing the environment
813 MutexAutoLock lock(m_env_mutex);
815 // Don't send too many at a time
818 // Single change sending is disabled if queue size is not small
819 bool disable_single_change_sending = false;
820 if(m_unsent_map_edit_queue.size() >= 4)
821 disable_single_change_sending = true;
823 int event_count = m_unsent_map_edit_queue.size();
825 // We'll log the amount of each
828 std::list<v3s16> node_meta_updates;
830 while (!m_unsent_map_edit_queue.empty()) {
831 MapEditEvent* event = m_unsent_map_edit_queue.front();
832 m_unsent_map_edit_queue.pop();
834 // Players far away from the change are stored here.
835 // Instead of sending the changes, MapBlocks are set not sent
837 std::unordered_set<u16> far_players;
839 switch (event->type) {
842 prof.add("MEET_ADDNODE", 1);
843 sendAddNode(event->p, event->n, &far_players,
844 disable_single_change_sending ? 5 : 30,
845 event->type == MEET_ADDNODE);
847 case MEET_REMOVENODE:
848 prof.add("MEET_REMOVENODE", 1);
849 sendRemoveNode(event->p, &far_players,
850 disable_single_change_sending ? 5 : 30);
852 case MEET_BLOCK_NODE_METADATA_CHANGED: {
853 prof.add("MEET_BLOCK_NODE_METADATA_CHANGED", 1);
854 if (!event->is_private_change) {
855 // Don't send the change yet. Collect them to eliminate dupes.
856 node_meta_updates.remove(event->p);
857 node_meta_updates.push_back(event->p);
860 if (MapBlock *block = m_env->getMap().getBlockNoCreateNoEx(
861 getNodeBlockPos(event->p))) {
862 block->raiseModified(MOD_STATE_WRITE_NEEDED,
863 MOD_REASON_REPORT_META_CHANGE);
868 prof.add("MEET_OTHER", 1);
869 for (const v3s16 &modified_block : event->modified_blocks) {
870 m_clients.markBlockposAsNotSent(modified_block);
874 prof.add("unknown", 1);
875 warningstream << "Server: Unknown MapEditEvent "
876 << ((u32)event->type) << std::endl;
881 Set blocks not sent to far players
883 if (!far_players.empty()) {
884 // Convert list format to that wanted by SetBlocksNotSent
885 std::map<v3s16, MapBlock*> modified_blocks2;
886 for (const v3s16 &modified_block : event->modified_blocks) {
887 modified_blocks2[modified_block] =
888 m_env->getMap().getBlockNoCreateNoEx(modified_block);
891 // Set blocks not sent
892 for (const u16 far_player : far_players) {
893 if (RemoteClient *client = getClient(far_player))
894 client->SetBlocksNotSent(modified_blocks2);
901 if (event_count >= 5) {
902 infostream << "Server: MapEditEvents:" << std::endl;
903 prof.print(infostream);
904 } else if (event_count != 0) {
905 verbosestream << "Server: MapEditEvents:" << std::endl;
906 prof.print(verbosestream);
909 // Send all metadata updates
910 if (node_meta_updates.size())
911 sendMetadataChanged(node_meta_updates);
915 Trigger emergethread (it somehow gets to a non-triggered but
916 bysy state sometimes)
919 float &counter = m_emergethread_trigger_timer;
921 if (counter >= 2.0) {
924 m_emerge->startThreads();
928 // Save map, players and auth stuff
930 float &counter = m_savemap_timer;
932 static thread_local const float save_interval =
933 g_settings->getFloat("server_map_save_interval");
934 if (counter >= save_interval) {
936 MutexAutoLock lock(m_env_mutex);
938 ScopeProfiler sp(g_profiler, "Server: map saving (sum)");
941 if (m_banmanager->isModified()) {
942 m_banmanager->save();
945 // Save changed parts of map
946 m_env->getMap().save(MOD_STATE_WRITE_NEEDED);
949 m_env->saveLoadedPlayers();
951 // Save environment metadata
956 m_shutdown_state.tick(dtime, this);
959 void Server::Receive()
969 In the first iteration *wait* for a packet, afterwards process
970 all packets that are immediately available (no waiting).
973 m_con->Receive(&pkt);
976 if (!m_con->TryReceive(&pkt))
980 peer_id = pkt.getPeerId();
981 m_packet_recv_counter->increment();
983 m_packet_recv_processed_counter->increment();
984 } catch (const con::InvalidIncomingDataException &e) {
985 infostream << "Server::Receive(): InvalidIncomingDataException: what()="
986 << e.what() << std::endl;
987 } catch (const SerializationError &e) {
988 infostream << "Server::Receive(): SerializationError: what()="
989 << e.what() << std::endl;
990 } catch (const ClientStateError &e) {
991 errorstream << "ProcessData: peer=" << peer_id << " what()="
992 << e.what() << std::endl;
993 DenyAccess_Legacy(peer_id, L"Your client sent something server didn't expect."
994 L"Try reconnecting or updating your client");
995 } catch (const con::PeerNotFoundException &e) {
997 } catch (const con::NoIncomingDataException &e) {
1003 PlayerSAO* Server::StageTwoClientInit(session_t peer_id)
1005 std::string playername;
1006 PlayerSAO *playersao = NULL;
1009 RemoteClient* client = m_clients.lockedGetClientNoEx(peer_id, CS_InitDone);
1011 playername = client->getName();
1012 playersao = emergePlayer(playername.c_str(), peer_id, client->net_proto_version);
1014 } catch (std::exception &e) {
1020 RemotePlayer *player = m_env->getPlayer(playername.c_str());
1022 // If failed, cancel
1023 if (!playersao || !player) {
1024 if (player && player->getPeerId() != PEER_ID_INEXISTENT) {
1025 actionstream << "Server: Failed to emerge player \"" << playername
1026 << "\" (player allocated to an another client)" << std::endl;
1027 DenyAccess_Legacy(peer_id, L"Another client is connected with this "
1028 L"name. If your client closed unexpectedly, try again in "
1031 errorstream << "Server: " << playername << ": Failed to emerge player"
1033 DenyAccess_Legacy(peer_id, L"Could not allocate player.");
1039 Send complete position information
1041 SendMovePlayer(peer_id);
1044 SendPlayerPrivileges(peer_id);
1046 // Send inventory formspec
1047 SendPlayerInventoryFormspec(peer_id);
1050 SendInventory(playersao, false);
1052 // Send HP or death screen
1053 if (playersao->isDead())
1054 SendDeathscreen(peer_id, false, v3f(0,0,0));
1056 SendPlayerHPOrDie(playersao,
1057 PlayerHPChangeReason(PlayerHPChangeReason::SET_HP));
1060 SendPlayerBreath(playersao);
1066 Address addr = getPeerAddress(player->getPeerId());
1067 std::string ip_str = addr.serializeString();
1068 const std::vector<std::string> &names = m_clients.getPlayerNames();
1070 actionstream << player->getName() << " [" << ip_str << "] joins game. List of players: ";
1072 for (const std::string &name : names) {
1073 actionstream << name << " ";
1076 actionstream << player->getName() <<std::endl;
1081 inline void Server::handleCommand(NetworkPacket *pkt)
1083 const ToServerCommandHandler &opHandle = toServerCommandTable[pkt->getCommand()];
1084 (this->*opHandle.handler)(pkt);
1087 void Server::ProcessData(NetworkPacket *pkt)
1089 // Environment is locked first.
1090 MutexAutoLock envlock(m_env_mutex);
1092 ScopeProfiler sp(g_profiler, "Server: Process network packet (sum)");
1093 u32 peer_id = pkt->getPeerId();
1096 Address address = getPeerAddress(peer_id);
1097 std::string addr_s = address.serializeString();
1099 if(m_banmanager->isIpBanned(addr_s)) {
1100 std::string ban_name = m_banmanager->getBanName(addr_s);
1101 infostream << "Server: A banned client tried to connect from "
1102 << addr_s << "; banned name was "
1103 << ban_name << std::endl;
1104 // This actually doesn't seem to transfer to the client
1105 DenyAccess_Legacy(peer_id, L"Your ip is banned. Banned name was "
1106 + utf8_to_wide(ban_name));
1110 catch(con::PeerNotFoundException &e) {
1112 * no peer for this packet found
1113 * most common reason is peer timeout, e.g. peer didn't
1114 * respond for some time, your server was overloaded or
1117 infostream << "Server::ProcessData(): Canceling: peer "
1118 << peer_id << " not found" << std::endl;
1123 ToServerCommand command = (ToServerCommand) pkt->getCommand();
1125 // Command must be handled into ToServerCommandHandler
1126 if (command >= TOSERVER_NUM_MSG_TYPES) {
1127 infostream << "Server: Ignoring unknown command "
1128 << command << std::endl;
1132 if (toServerCommandTable[command].state == TOSERVER_STATE_NOT_CONNECTED) {
1137 u8 peer_ser_ver = getClient(peer_id, CS_InitDone)->serialization_version;
1139 if(peer_ser_ver == SER_FMT_VER_INVALID) {
1140 errorstream << "Server::ProcessData(): Cancelling: Peer"
1141 " serialization format invalid or not initialized."
1142 " Skipping incoming command=" << command << std::endl;
1146 /* Handle commands related to client startup */
1147 if (toServerCommandTable[command].state == TOSERVER_STATE_STARTUP) {
1152 if (m_clients.getClientState(peer_id) < CS_Active) {
1153 if (command == TOSERVER_PLAYERPOS) return;
1155 errorstream << "Got packet command: " << command << " for peer id "
1156 << peer_id << " but client isn't active yet. Dropping packet "
1162 } catch (SendFailedException &e) {
1163 errorstream << "Server::ProcessData(): SendFailedException: "
1164 << "what=" << e.what()
1166 } catch (PacketError &e) {
1167 actionstream << "Server::ProcessData(): PacketError: "
1168 << "what=" << e.what()
1173 void Server::setTimeOfDay(u32 time)
1175 m_env->setTimeOfDay(time);
1176 m_time_of_day_send_timer = 0;
1179 void Server::onMapEditEvent(const MapEditEvent &event)
1181 if (m_ignore_map_edit_events_area.contains(event.getArea()))
1184 m_unsent_map_edit_queue.push(new MapEditEvent(event));
1187 void Server::SetBlocksNotSent(std::map<v3s16, MapBlock *>& block)
1189 std::vector<session_t> clients = m_clients.getClientIDs();
1191 // Set the modified blocks unsent for all the clients
1192 for (const session_t client_id : clients) {
1193 if (RemoteClient *client = m_clients.lockedGetClientNoEx(client_id))
1194 client->SetBlocksNotSent(block);
1199 void Server::peerAdded(con::Peer *peer)
1201 verbosestream<<"Server::peerAdded(): peer->id="
1202 <<peer->id<<std::endl;
1204 m_peer_change_queue.push(con::PeerChange(con::PEER_ADDED, peer->id, false));
1207 void Server::deletingPeer(con::Peer *peer, bool timeout)
1209 verbosestream<<"Server::deletingPeer(): peer->id="
1210 <<peer->id<<", timeout="<<timeout<<std::endl;
1212 m_clients.event(peer->id, CSE_Disconnect);
1213 m_peer_change_queue.push(con::PeerChange(con::PEER_REMOVED, peer->id, timeout));
1216 bool Server::getClientConInfo(session_t peer_id, con::rtt_stat_type type, float* retval)
1218 *retval = m_con->getPeerStat(peer_id,type);
1219 return *retval != -1;
1222 bool Server::getClientInfo(
1231 std::string* vers_string,
1232 std::string* lang_code
1235 *state = m_clients.getClientState(peer_id);
1237 RemoteClient* client = m_clients.lockedGetClientNoEx(peer_id, CS_Invalid);
1244 *uptime = client->uptime();
1245 *ser_vers = client->serialization_version;
1246 *prot_vers = client->net_proto_version;
1248 *major = client->getMajor();
1249 *minor = client->getMinor();
1250 *patch = client->getPatch();
1251 *vers_string = client->getFull();
1252 *lang_code = client->getLangCode();
1259 void Server::handlePeerChanges()
1261 while(!m_peer_change_queue.empty())
1263 con::PeerChange c = m_peer_change_queue.front();
1264 m_peer_change_queue.pop();
1266 verbosestream<<"Server: Handling peer change: "
1267 <<"id="<<c.peer_id<<", timeout="<<c.timeout
1272 case con::PEER_ADDED:
1273 m_clients.CreateClient(c.peer_id);
1276 case con::PEER_REMOVED:
1277 DeleteClient(c.peer_id, c.timeout?CDR_TIMEOUT:CDR_LEAVE);
1281 FATAL_ERROR("Invalid peer change event received!");
1287 void Server::printToConsoleOnly(const std::string &text)
1290 m_admin_chat->outgoing_queue.push_back(
1291 new ChatEventChat("", utf8_to_wide(text)));
1293 std::cout << text << std::endl;
1297 void Server::Send(NetworkPacket *pkt)
1299 Send(pkt->getPeerId(), pkt);
1302 void Server::Send(session_t peer_id, NetworkPacket *pkt)
1304 m_clients.send(peer_id,
1305 clientCommandFactoryTable[pkt->getCommand()].channel,
1307 clientCommandFactoryTable[pkt->getCommand()].reliable);
1310 void Server::SendMovement(session_t peer_id)
1312 std::ostringstream os(std::ios_base::binary);
1314 NetworkPacket pkt(TOCLIENT_MOVEMENT, 12 * sizeof(float), peer_id);
1316 pkt << g_settings->getFloat("movement_acceleration_default");
1317 pkt << g_settings->getFloat("movement_acceleration_air");
1318 pkt << g_settings->getFloat("movement_acceleration_fast");
1319 pkt << g_settings->getFloat("movement_speed_walk");
1320 pkt << g_settings->getFloat("movement_speed_crouch");
1321 pkt << g_settings->getFloat("movement_speed_fast");
1322 pkt << g_settings->getFloat("movement_speed_climb");
1323 pkt << g_settings->getFloat("movement_speed_jump");
1324 pkt << g_settings->getFloat("movement_liquid_fluidity");
1325 pkt << g_settings->getFloat("movement_liquid_fluidity_smooth");
1326 pkt << g_settings->getFloat("movement_liquid_sink");
1327 pkt << g_settings->getFloat("movement_gravity");
1332 void Server::SendPlayerHPOrDie(PlayerSAO *playersao, const PlayerHPChangeReason &reason)
1334 if (playersao->isImmortal())
1337 session_t peer_id = playersao->getPeerID();
1338 bool is_alive = playersao->getHP() > 0;
1341 SendPlayerHP(peer_id);
1343 DiePlayer(peer_id, reason);
1346 void Server::SendHP(session_t peer_id, u16 hp)
1348 NetworkPacket pkt(TOCLIENT_HP, 1, peer_id);
1353 void Server::SendBreath(session_t peer_id, u16 breath)
1355 NetworkPacket pkt(TOCLIENT_BREATH, 2, peer_id);
1356 pkt << (u16) breath;
1360 void Server::SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
1361 const std::string &custom_reason, bool reconnect)
1363 assert(reason < SERVER_ACCESSDENIED_MAX);
1365 NetworkPacket pkt(TOCLIENT_ACCESS_DENIED, 1, peer_id);
1367 if (reason == SERVER_ACCESSDENIED_CUSTOM_STRING)
1368 pkt << custom_reason;
1369 else if (reason == SERVER_ACCESSDENIED_SHUTDOWN ||
1370 reason == SERVER_ACCESSDENIED_CRASH)
1371 pkt << custom_reason << (u8)reconnect;
1375 void Server::SendAccessDenied_Legacy(session_t peer_id,const std::wstring &reason)
1377 NetworkPacket pkt(TOCLIENT_ACCESS_DENIED_LEGACY, 0, peer_id);
1382 void Server::SendDeathscreen(session_t peer_id, bool set_camera_point_target,
1383 v3f camera_point_target)
1385 NetworkPacket pkt(TOCLIENT_DEATHSCREEN, 1 + sizeof(v3f), peer_id);
1386 pkt << set_camera_point_target << camera_point_target;
1390 void Server::SendItemDef(session_t peer_id,
1391 IItemDefManager *itemdef, u16 protocol_version)
1393 NetworkPacket pkt(TOCLIENT_ITEMDEF, 0, peer_id);
1397 u32 length of the next item
1398 zlib-compressed serialized ItemDefManager
1400 std::ostringstream tmp_os(std::ios::binary);
1401 itemdef->serialize(tmp_os, protocol_version);
1402 std::ostringstream tmp_os2(std::ios::binary);
1403 compressZlib(tmp_os.str(), tmp_os2);
1404 pkt.putLongString(tmp_os2.str());
1407 verbosestream << "Server: Sending item definitions to id(" << peer_id
1408 << "): size=" << pkt.getSize() << std::endl;
1413 void Server::SendNodeDef(session_t peer_id,
1414 const NodeDefManager *nodedef, u16 protocol_version)
1416 NetworkPacket pkt(TOCLIENT_NODEDEF, 0, peer_id);
1420 u32 length of the next item
1421 zlib-compressed serialized NodeDefManager
1423 std::ostringstream tmp_os(std::ios::binary);
1424 nodedef->serialize(tmp_os, protocol_version);
1425 std::ostringstream tmp_os2(std::ios::binary);
1426 compressZlib(tmp_os.str(), tmp_os2);
1428 pkt.putLongString(tmp_os2.str());
1431 verbosestream << "Server: Sending node definitions to id(" << peer_id
1432 << "): size=" << pkt.getSize() << std::endl;
1438 Non-static send methods
1441 void Server::SendInventory(PlayerSAO *sao, bool incremental)
1443 RemotePlayer *player = sao->getPlayer();
1445 // Do not send new format to old clients
1446 incremental &= player->protocol_version >= 38;
1448 UpdateCrafting(player);
1454 NetworkPacket pkt(TOCLIENT_INVENTORY, 0, sao->getPeerID());
1456 std::ostringstream os(std::ios::binary);
1457 sao->getInventory()->serialize(os, incremental);
1458 sao->getInventory()->setModified(false);
1459 player->setModified(true);
1461 const std::string &s = os.str();
1462 pkt.putRawString(s.c_str(), s.size());
1466 void Server::SendChatMessage(session_t peer_id, const ChatMessage &message)
1468 NetworkPacket pkt(TOCLIENT_CHAT_MESSAGE, 0, peer_id);
1470 u8 type = message.type;
1471 pkt << version << type << std::wstring(L"") << message.message << (u64)message.timestamp;
1473 if (peer_id != PEER_ID_INEXISTENT) {
1474 RemotePlayer *player = m_env->getPlayer(peer_id);
1480 m_clients.sendToAll(&pkt);
1484 void Server::SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
1485 const std::string &formname)
1487 NetworkPacket pkt(TOCLIENT_SHOW_FORMSPEC, 0, peer_id);
1488 if (formspec.empty()){
1489 //the client should close the formspec
1490 //but make sure there wasn't another one open in meantime
1491 const auto it = m_formspec_state_data.find(peer_id);
1492 if (it != m_formspec_state_data.end() && it->second == formname) {
1493 m_formspec_state_data.erase(peer_id);
1495 pkt.putLongString("");
1497 m_formspec_state_data[peer_id] = formname;
1498 pkt.putLongString(formspec);
1505 // Spawns a particle on peer with peer_id
1506 void Server::SendSpawnParticle(session_t peer_id, u16 protocol_version,
1507 const ParticleParameters &p)
1509 static thread_local const float radius =
1510 g_settings->getS16("max_block_send_distance") * MAP_BLOCKSIZE * BS;
1512 if (peer_id == PEER_ID_INEXISTENT) {
1513 std::vector<session_t> clients = m_clients.getClientIDs();
1514 const v3f pos = p.pos * BS;
1515 const float radius_sq = radius * radius;
1517 for (const session_t client_id : clients) {
1518 RemotePlayer *player = m_env->getPlayer(client_id);
1522 PlayerSAO *sao = player->getPlayerSAO();
1526 // Do not send to distant clients
1527 if (sao->getBasePosition().getDistanceFromSQ(pos) > radius_sq)
1530 SendSpawnParticle(client_id, player->protocol_version, p);
1534 assert(protocol_version != 0);
1536 NetworkPacket pkt(TOCLIENT_SPAWN_PARTICLE, 0, peer_id);
1539 // NetworkPacket and iostreams are incompatible...
1540 std::ostringstream oss(std::ios_base::binary);
1541 p.serialize(oss, protocol_version);
1542 pkt.putRawString(oss.str());
1548 // Adds a ParticleSpawner on peer with peer_id
1549 void Server::SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
1550 const ParticleSpawnerParameters &p, u16 attached_id, u32 id)
1552 if (peer_id == PEER_ID_INEXISTENT) {
1553 std::vector<session_t> clients = m_clients.getClientIDs();
1554 for (const session_t client_id : clients) {
1555 RemotePlayer *player = m_env->getPlayer(client_id);
1558 SendAddParticleSpawner(client_id, player->protocol_version,
1559 p, attached_id, id);
1563 assert(protocol_version != 0);
1565 NetworkPacket pkt(TOCLIENT_ADD_PARTICLESPAWNER, 100, peer_id);
1567 pkt << p.amount << p.time << p.minpos << p.maxpos << p.minvel
1568 << p.maxvel << p.minacc << p.maxacc << p.minexptime << p.maxexptime
1569 << p.minsize << p.maxsize << p.collisiondetection;
1571 pkt.putLongString(p.texture);
1573 pkt << id << p.vertical << p.collision_removal << attached_id;
1575 std::ostringstream os(std::ios_base::binary);
1576 p.animation.serialize(os, protocol_version);
1577 pkt.putRawString(os.str());
1579 pkt << p.glow << p.object_collision;
1580 pkt << p.node.param0 << p.node.param2 << p.node_tile;
1585 void Server::SendDeleteParticleSpawner(session_t peer_id, u32 id)
1587 NetworkPacket pkt(TOCLIENT_DELETE_PARTICLESPAWNER, 4, peer_id);
1591 if (peer_id != PEER_ID_INEXISTENT)
1594 m_clients.sendToAll(&pkt);
1598 void Server::SendHUDAdd(session_t peer_id, u32 id, HudElement *form)
1600 NetworkPacket pkt(TOCLIENT_HUDADD, 0 , peer_id);
1602 pkt << id << (u8) form->type << form->pos << form->name << form->scale
1603 << form->text << form->number << form->item << form->dir
1604 << form->align << form->offset << form->world_pos << form->size
1605 << form->z_index << form->text2;
1610 void Server::SendHUDRemove(session_t peer_id, u32 id)
1612 NetworkPacket pkt(TOCLIENT_HUDRM, 4, peer_id);
1617 void Server::SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value)
1619 NetworkPacket pkt(TOCLIENT_HUDCHANGE, 0, peer_id);
1620 pkt << id << (u8) stat;
1624 case HUD_STAT_SCALE:
1625 case HUD_STAT_ALIGN:
1626 case HUD_STAT_OFFSET:
1627 pkt << *(v2f *) value;
1631 case HUD_STAT_TEXT2:
1632 pkt << *(std::string *) value;
1634 case HUD_STAT_WORLD_POS:
1635 pkt << *(v3f *) value;
1638 pkt << *(v2s32 *) value;
1640 case HUD_STAT_NUMBER:
1644 pkt << *(u32 *) value;
1651 void Server::SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask)
1653 NetworkPacket pkt(TOCLIENT_HUD_SET_FLAGS, 4 + 4, peer_id);
1655 flags &= ~(HUD_FLAG_HEALTHBAR_VISIBLE | HUD_FLAG_BREATHBAR_VISIBLE);
1657 pkt << flags << mask;
1662 void Server::SendHUDSetParam(session_t peer_id, u16 param, const std::string &value)
1664 NetworkPacket pkt(TOCLIENT_HUD_SET_PARAM, 0, peer_id);
1665 pkt << param << value;
1669 void Server::SendSetSky(session_t peer_id, const SkyboxParams ¶ms)
1671 NetworkPacket pkt(TOCLIENT_SET_SKY, 0, peer_id);
1673 // Handle prior clients here
1674 if (m_clients.getProtocolVersion(peer_id) < 39) {
1675 pkt << params.bgcolor << params.type << (u16) params.textures.size();
1677 for (const std::string& texture : params.textures)
1680 pkt << params.clouds;
1681 } else { // Handle current clients and future clients
1682 pkt << params.bgcolor << params.type
1683 << params.clouds << params.fog_sun_tint
1684 << params.fog_moon_tint << params.fog_tint_type;
1686 if (params.type == "skybox") {
1687 pkt << (u16) params.textures.size();
1688 for (const std::string &texture : params.textures)
1690 } else if (params.type == "regular") {
1691 pkt << params.sky_color.day_sky << params.sky_color.day_horizon
1692 << params.sky_color.dawn_sky << params.sky_color.dawn_horizon
1693 << params.sky_color.night_sky << params.sky_color.night_horizon
1694 << params.sky_color.indoors;
1701 void Server::SendSetSun(session_t peer_id, const SunParams ¶ms)
1703 NetworkPacket pkt(TOCLIENT_SET_SUN, 0, peer_id);
1704 pkt << params.visible << params.texture
1705 << params.tonemap << params.sunrise
1706 << params.sunrise_visible << params.scale;
1710 void Server::SendSetMoon(session_t peer_id, const MoonParams ¶ms)
1712 NetworkPacket pkt(TOCLIENT_SET_MOON, 0, peer_id);
1714 pkt << params.visible << params.texture
1715 << params.tonemap << params.scale;
1719 void Server::SendSetStars(session_t peer_id, const StarParams ¶ms)
1721 NetworkPacket pkt(TOCLIENT_SET_STARS, 0, peer_id);
1723 pkt << params.visible << params.count
1724 << params.starcolor << params.scale;
1729 void Server::SendCloudParams(session_t peer_id, const CloudParams ¶ms)
1731 NetworkPacket pkt(TOCLIENT_CLOUD_PARAMS, 0, peer_id);
1732 pkt << params.density << params.color_bright << params.color_ambient
1733 << params.height << params.thickness << params.speed;
1737 void Server::SendOverrideDayNightRatio(session_t peer_id, bool do_override,
1740 NetworkPacket pkt(TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO,
1743 pkt << do_override << (u16) (ratio * 65535);
1748 void Server::SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed)
1750 NetworkPacket pkt(TOCLIENT_TIME_OF_DAY, 0, peer_id);
1751 pkt << time << time_speed;
1753 if (peer_id == PEER_ID_INEXISTENT) {
1754 m_clients.sendToAll(&pkt);
1761 void Server::SendPlayerHP(session_t peer_id)
1763 PlayerSAO *playersao = getPlayerSAO(peer_id);
1766 SendHP(peer_id, playersao->getHP());
1767 m_script->player_event(playersao,"health_changed");
1769 // Send to other clients
1770 playersao->sendPunchCommand();
1773 void Server::SendPlayerBreath(PlayerSAO *sao)
1777 m_script->player_event(sao, "breath_changed");
1778 SendBreath(sao->getPeerID(), sao->getBreath());
1781 void Server::SendMovePlayer(session_t peer_id)
1783 RemotePlayer *player = m_env->getPlayer(peer_id);
1785 PlayerSAO *sao = player->getPlayerSAO();
1788 NetworkPacket pkt(TOCLIENT_MOVE_PLAYER, sizeof(v3f) + sizeof(f32) * 2, peer_id);
1789 pkt << sao->getBasePosition() << sao->getLookPitch() << sao->getRotation().Y;
1792 v3f pos = sao->getBasePosition();
1793 verbosestream << "Server: Sending TOCLIENT_MOVE_PLAYER"
1794 << " pos=(" << pos.X << "," << pos.Y << "," << pos.Z << ")"
1795 << " pitch=" << sao->getLookPitch()
1796 << " yaw=" << sao->getRotation().Y
1803 void Server::SendPlayerFov(session_t peer_id)
1805 NetworkPacket pkt(TOCLIENT_FOV, 4 + 1 + 4, peer_id);
1807 PlayerFovSpec fov_spec = m_env->getPlayer(peer_id)->getFov();
1808 pkt << fov_spec.fov << fov_spec.is_multiplier << fov_spec.transition_time;
1813 void Server::SendLocalPlayerAnimations(session_t peer_id, v2s32 animation_frames[4],
1814 f32 animation_speed)
1816 NetworkPacket pkt(TOCLIENT_LOCAL_PLAYER_ANIMATIONS, 0,
1819 pkt << animation_frames[0] << animation_frames[1] << animation_frames[2]
1820 << animation_frames[3] << animation_speed;
1825 void Server::SendEyeOffset(session_t peer_id, v3f first, v3f third)
1827 NetworkPacket pkt(TOCLIENT_EYE_OFFSET, 0, peer_id);
1828 pkt << first << third;
1832 void Server::SendPlayerPrivileges(session_t peer_id)
1834 RemotePlayer *player = m_env->getPlayer(peer_id);
1836 if(player->getPeerId() == PEER_ID_INEXISTENT)
1839 std::set<std::string> privs;
1840 m_script->getAuth(player->getName(), NULL, &privs);
1842 NetworkPacket pkt(TOCLIENT_PRIVILEGES, 0, peer_id);
1843 pkt << (u16) privs.size();
1845 for (const std::string &priv : privs) {
1852 void Server::SendPlayerInventoryFormspec(session_t peer_id)
1854 RemotePlayer *player = m_env->getPlayer(peer_id);
1856 if (player->getPeerId() == PEER_ID_INEXISTENT)
1859 NetworkPacket pkt(TOCLIENT_INVENTORY_FORMSPEC, 0, peer_id);
1860 pkt.putLongString(player->inventory_formspec);
1865 void Server::SendPlayerFormspecPrepend(session_t peer_id)
1867 RemotePlayer *player = m_env->getPlayer(peer_id);
1869 if (player->getPeerId() == PEER_ID_INEXISTENT)
1872 NetworkPacket pkt(TOCLIENT_FORMSPEC_PREPEND, 0, peer_id);
1873 pkt << player->formspec_prepend;
1877 void Server::SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao)
1879 // Radius inside which objects are active
1880 static thread_local const s16 radius =
1881 g_settings->getS16("active_object_send_range_blocks") * MAP_BLOCKSIZE;
1883 // Radius inside which players are active
1884 static thread_local const bool is_transfer_limited =
1885 g_settings->exists("unlimited_player_transfer_distance") &&
1886 !g_settings->getBool("unlimited_player_transfer_distance");
1888 static thread_local const s16 player_transfer_dist =
1889 g_settings->getS16("player_transfer_distance") * MAP_BLOCKSIZE;
1891 s16 player_radius = player_transfer_dist == 0 && is_transfer_limited ?
1892 radius : player_transfer_dist;
1894 s16 my_radius = MYMIN(radius, playersao->getWantedRange() * MAP_BLOCKSIZE);
1898 std::queue<u16> removed_objects, added_objects;
1899 m_env->getRemovedActiveObjects(playersao, my_radius, player_radius,
1900 client->m_known_objects, removed_objects);
1901 m_env->getAddedActiveObjects(playersao, my_radius, player_radius,
1902 client->m_known_objects, added_objects);
1904 int removed_count = removed_objects.size();
1905 int added_count = added_objects.size();
1907 if (removed_objects.empty() && added_objects.empty())
1913 // Handle removed objects
1914 writeU16((u8*)buf, removed_objects.size());
1915 data.append(buf, 2);
1916 while (!removed_objects.empty()) {
1918 u16 id = removed_objects.front();
1919 ServerActiveObject* obj = m_env->getActiveObject(id);
1921 // Add to data buffer for sending
1922 writeU16((u8*)buf, id);
1923 data.append(buf, 2);
1925 // Remove from known objects
1926 client->m_known_objects.erase(id);
1928 if (obj && obj->m_known_by_count > 0)
1929 obj->m_known_by_count--;
1931 removed_objects.pop();
1934 // Handle added objects
1935 writeU16((u8*)buf, added_objects.size());
1936 data.append(buf, 2);
1937 while (!added_objects.empty()) {
1939 u16 id = added_objects.front();
1940 ServerActiveObject *obj = m_env->getActiveObject(id);
1941 added_objects.pop();
1944 warningstream << FUNCTION_NAME << ": NULL object id="
1945 << (int)id << std::endl;
1950 u8 type = obj->getSendType();
1952 // Add to data buffer for sending
1953 writeU16((u8*)buf, id);
1954 data.append(buf, 2);
1955 writeU8((u8*)buf, type);
1956 data.append(buf, 1);
1958 data.append(serializeLongString(
1959 obj->getClientInitializationData(client->net_proto_version)));
1961 // Add to known objects
1962 client->m_known_objects.insert(id);
1964 obj->m_known_by_count++;
1967 NetworkPacket pkt(TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD, data.size(), client->peer_id);
1968 pkt.putRawString(data.c_str(), data.size());
1971 verbosestream << "Server::SendActiveObjectRemoveAdd: "
1972 << removed_count << " removed, " << added_count << " added, "
1973 << "packet size is " << pkt.getSize() << std::endl;
1976 void Server::SendActiveObjectMessages(session_t peer_id, const std::string &datas,
1979 NetworkPacket pkt(TOCLIENT_ACTIVE_OBJECT_MESSAGES,
1980 datas.size(), peer_id);
1982 pkt.putRawString(datas.c_str(), datas.size());
1984 m_clients.send(pkt.getPeerId(),
1985 reliable ? clientCommandFactoryTable[pkt.getCommand()].channel : 1,
1989 void Server::SendCSMRestrictionFlags(session_t peer_id)
1991 NetworkPacket pkt(TOCLIENT_CSM_RESTRICTION_FLAGS,
1992 sizeof(m_csm_restriction_flags) + sizeof(m_csm_restriction_noderange), peer_id);
1993 pkt << m_csm_restriction_flags << m_csm_restriction_noderange;
1997 void Server::SendPlayerSpeed(session_t peer_id, const v3f &added_vel)
1999 NetworkPacket pkt(TOCLIENT_PLAYER_SPEED, 0, peer_id);
2004 inline s32 Server::nextSoundId()
2006 s32 ret = m_next_sound_id;
2007 if (m_next_sound_id == INT32_MAX)
2008 m_next_sound_id = 0; // signed overflow is undefined
2014 s32 Server::playSound(const SimpleSoundSpec &spec,
2015 const ServerSoundParams ¶ms, bool ephemeral)
2017 // Find out initial position of sound
2018 bool pos_exists = false;
2019 v3f pos = params.getPos(m_env, &pos_exists);
2020 // If position is not found while it should be, cancel sound
2021 if(pos_exists != (params.type != ServerSoundParams::SSP_LOCAL))
2024 // Filter destination clients
2025 std::vector<session_t> dst_clients;
2026 if (!params.to_player.empty()) {
2027 RemotePlayer *player = m_env->getPlayer(params.to_player.c_str());
2029 infostream<<"Server::playSound: Player \""<<params.to_player
2030 <<"\" not found"<<std::endl;
2033 if (player->getPeerId() == PEER_ID_INEXISTENT) {
2034 infostream<<"Server::playSound: Player \""<<params.to_player
2035 <<"\" not connected"<<std::endl;
2038 dst_clients.push_back(player->getPeerId());
2040 std::vector<session_t> clients = m_clients.getClientIDs();
2042 for (const session_t client_id : clients) {
2043 RemotePlayer *player = m_env->getPlayer(client_id);
2046 if (!params.exclude_player.empty() &&
2047 params.exclude_player == player->getName())
2050 PlayerSAO *sao = player->getPlayerSAO();
2055 if(sao->getBasePosition().getDistanceFrom(pos) >
2056 params.max_hear_distance)
2059 dst_clients.push_back(client_id);
2063 if(dst_clients.empty())
2068 ServerPlayingSound *psound = nullptr;
2070 id = -1; // old clients will still use this, so pick a reserved ID
2073 // The sound will exist as a reference in m_playing_sounds
2074 m_playing_sounds[id] = ServerPlayingSound();
2075 psound = &m_playing_sounds[id];
2076 psound->params = params;
2077 psound->spec = spec;
2080 float gain = params.gain * spec.gain;
2081 NetworkPacket pkt(TOCLIENT_PLAY_SOUND, 0);
2082 pkt << id << spec.name << gain
2083 << (u8) params.type << pos << params.object
2084 << params.loop << params.fade << params.pitch
2087 bool as_reliable = !ephemeral;
2089 for (const u16 dst_client : dst_clients) {
2091 psound->clients.insert(dst_client);
2092 m_clients.send(dst_client, 0, &pkt, as_reliable);
2096 void Server::stopSound(s32 handle)
2098 // Get sound reference
2099 std::unordered_map<s32, ServerPlayingSound>::iterator i =
2100 m_playing_sounds.find(handle);
2101 if (i == m_playing_sounds.end())
2103 ServerPlayingSound &psound = i->second;
2105 NetworkPacket pkt(TOCLIENT_STOP_SOUND, 4);
2108 for (std::unordered_set<session_t>::const_iterator si = psound.clients.begin();
2109 si != psound.clients.end(); ++si) {
2111 m_clients.send(*si, 0, &pkt, true);
2113 // Remove sound reference
2114 m_playing_sounds.erase(i);
2117 void Server::fadeSound(s32 handle, float step, float gain)
2119 // Get sound reference
2120 std::unordered_map<s32, ServerPlayingSound>::iterator i =
2121 m_playing_sounds.find(handle);
2122 if (i == m_playing_sounds.end())
2125 ServerPlayingSound &psound = i->second;
2126 psound.params.gain = gain;
2128 NetworkPacket pkt(TOCLIENT_FADE_SOUND, 4);
2129 pkt << handle << step << gain;
2131 // Backwards compability
2132 bool play_sound = gain > 0;
2133 ServerPlayingSound compat_psound = psound;
2134 compat_psound.clients.clear();
2136 NetworkPacket compat_pkt(TOCLIENT_STOP_SOUND, 4);
2137 compat_pkt << handle;
2139 for (std::unordered_set<u16>::iterator it = psound.clients.begin();
2140 it != psound.clients.end();) {
2141 if (m_clients.getProtocolVersion(*it) >= 32) {
2143 m_clients.send(*it, 0, &pkt, true);
2146 compat_psound.clients.insert(*it);
2148 m_clients.send(*it, 0, &compat_pkt, true);
2149 psound.clients.erase(it++);
2153 // Remove sound reference
2154 if (!play_sound || psound.clients.empty())
2155 m_playing_sounds.erase(i);
2157 if (play_sound && !compat_psound.clients.empty()) {
2158 // Play new sound volume on older clients
2159 playSound(compat_psound.spec, compat_psound.params);
2163 void Server::sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players,
2166 float maxd = far_d_nodes * BS;
2167 v3f p_f = intToFloat(p, BS);
2168 v3s16 block_pos = getNodeBlockPos(p);
2170 NetworkPacket pkt(TOCLIENT_REMOVENODE, 6);
2173 std::vector<session_t> clients = m_clients.getClientIDs();
2176 for (session_t client_id : clients) {
2177 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id);
2181 RemotePlayer *player = m_env->getPlayer(client_id);
2182 PlayerSAO *sao = player ? player->getPlayerSAO() : nullptr;
2184 // If player is far away, only set modified blocks not sent
2185 if (!client->isBlockSent(block_pos) || (sao &&
2186 sao->getBasePosition().getDistanceFrom(p_f) > maxd)) {
2188 far_players->emplace(client_id);
2190 client->SetBlockNotSent(block_pos);
2195 m_clients.send(client_id, 0, &pkt, true);
2201 void Server::sendAddNode(v3s16 p, MapNode n, std::unordered_set<u16> *far_players,
2202 float far_d_nodes, bool remove_metadata)
2204 float maxd = far_d_nodes * BS;
2205 v3f p_f = intToFloat(p, BS);
2206 v3s16 block_pos = getNodeBlockPos(p);
2208 NetworkPacket pkt(TOCLIENT_ADDNODE, 6 + 2 + 1 + 1 + 1);
2209 pkt << p << n.param0 << n.param1 << n.param2
2210 << (u8) (remove_metadata ? 0 : 1);
2212 std::vector<session_t> clients = m_clients.getClientIDs();
2215 for (session_t client_id : clients) {
2216 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id);
2220 RemotePlayer *player = m_env->getPlayer(client_id);
2221 PlayerSAO *sao = player ? player->getPlayerSAO() : nullptr;
2223 // If player is far away, only set modified blocks not sent
2224 if (!client->isBlockSent(block_pos) || (sao &&
2225 sao->getBasePosition().getDistanceFrom(p_f) > maxd)) {
2227 far_players->emplace(client_id);
2229 client->SetBlockNotSent(block_pos);
2234 m_clients.send(client_id, 0, &pkt, true);
2240 void Server::sendMetadataChanged(const std::list<v3s16> &meta_updates, float far_d_nodes)
2242 float maxd = far_d_nodes * BS;
2243 NodeMetadataList meta_updates_list(false);
2244 std::vector<session_t> clients = m_clients.getClientIDs();
2248 for (session_t i : clients) {
2249 RemoteClient *client = m_clients.lockedGetClientNoEx(i);
2253 ServerActiveObject *player = m_env->getActiveObject(i);
2254 v3f player_pos = player ? player->getBasePosition() : v3f();
2256 for (const v3s16 &pos : meta_updates) {
2257 NodeMetadata *meta = m_env->getMap().getNodeMetadata(pos);
2262 v3s16 block_pos = getNodeBlockPos(pos);
2263 if (!client->isBlockSent(block_pos) || (player &&
2264 player_pos.getDistanceFrom(intToFloat(pos, BS)) > maxd)) {
2265 client->SetBlockNotSent(block_pos);
2269 // Add the change to send list
2270 meta_updates_list.set(pos, meta);
2272 if (meta_updates_list.size() == 0)
2275 // Send the meta changes
2276 std::ostringstream os(std::ios::binary);
2277 meta_updates_list.serialize(os, client->net_proto_version, false, true);
2278 std::ostringstream oss(std::ios::binary);
2279 compressZlib(os.str(), oss);
2281 NetworkPacket pkt(TOCLIENT_NODEMETA_CHANGED, 0);
2282 pkt.putLongString(oss.str());
2283 m_clients.send(i, 0, &pkt, true);
2285 meta_updates_list.clear();
2291 void Server::SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver,
2292 u16 net_proto_version)
2295 Create a packet with the block in the right format
2298 std::ostringstream os(std::ios_base::binary);
2299 block->serialize(os, ver, false);
2300 block->serializeNetworkSpecific(os);
2301 std::string s = os.str();
2303 NetworkPacket pkt(TOCLIENT_BLOCKDATA, 2 + 2 + 2 + 2 + s.size(), peer_id);
2305 pkt << block->getPos();
2306 pkt.putRawString(s.c_str(), s.size());
2310 void Server::SendBlocks(float dtime)
2312 MutexAutoLock envlock(m_env_mutex);
2313 //TODO check if one big lock could be faster then multiple small ones
2315 std::vector<PrioritySortedBlockTransfer> queue;
2317 u32 total_sending = 0;
2320 ScopeProfiler sp2(g_profiler, "Server::SendBlocks(): Collect list");
2322 std::vector<session_t> clients = m_clients.getClientIDs();
2325 for (const session_t client_id : clients) {
2326 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id, CS_Active);
2331 total_sending += client->getSendingCount();
2332 client->GetNextBlocks(m_env,m_emerge, dtime, queue);
2338 // Lowest priority number comes first.
2339 // Lowest is most important.
2340 std::sort(queue.begin(), queue.end());
2344 // Maximal total count calculation
2345 // The per-client block sends is halved with the maximal online users
2346 u32 max_blocks_to_send = (m_env->getPlayerCount() + g_settings->getU32("max_users")) *
2347 g_settings->getU32("max_simultaneous_block_sends_per_client") / 4 + 1;
2349 ScopeProfiler sp(g_profiler, "Server::SendBlocks(): Send to clients");
2350 Map &map = m_env->getMap();
2352 for (const PrioritySortedBlockTransfer &block_to_send : queue) {
2353 if (total_sending >= max_blocks_to_send)
2356 MapBlock *block = map.getBlockNoCreateNoEx(block_to_send.pos);
2360 RemoteClient *client = m_clients.lockedGetClientNoEx(block_to_send.peer_id,
2365 SendBlockNoLock(block_to_send.peer_id, block, client->serialization_version,
2366 client->net_proto_version);
2368 client->SentBlock(block_to_send.pos);
2374 bool Server::SendBlock(session_t peer_id, const v3s16 &blockpos)
2376 MapBlock *block = m_env->getMap().getBlockNoCreateNoEx(blockpos);
2381 RemoteClient *client = m_clients.lockedGetClientNoEx(peer_id, CS_Active);
2382 if (!client || client->isBlockSent(blockpos)) {
2386 SendBlockNoLock(peer_id, block, client->serialization_version,
2387 client->net_proto_version);
2393 void Server::fillMediaCache()
2395 infostream<<"Server: Calculating media file checksums"<<std::endl;
2397 // Collect all media file paths
2398 std::vector<std::string> paths;
2399 m_modmgr->getModsMediaPaths(paths);
2400 fs::GetRecursiveDirs(paths, m_gamespec.path + DIR_DELIM + "textures");
2401 fs::GetRecursiveDirs(paths, porting::path_user + DIR_DELIM + "textures" + DIR_DELIM + "server");
2403 // Collect media file information from paths into cache
2404 for (const std::string &mediapath : paths) {
2405 std::vector<fs::DirListNode> dirlist = fs::GetDirListing(mediapath);
2406 for (const fs::DirListNode &dln : dirlist) {
2407 if (dln.dir) // Ignode dirs
2409 std::string filename = dln.name;
2410 // If name contains illegal characters, ignore the file
2411 if (!string_allowed(filename, TEXTURENAME_ALLOWED_CHARS)) {
2412 infostream<<"Server: ignoring illegal file name: \""
2413 << filename << "\"" << std::endl;
2416 // If name is not in a supported format, ignore it
2417 const char *supported_ext[] = {
2418 ".png", ".jpg", ".bmp", ".tga",
2419 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
2421 ".x", ".b3d", ".md2", ".obj",
2422 // Custom translation file format
2426 if (removeStringEnd(filename, supported_ext).empty()){
2427 infostream << "Server: ignoring unsupported file extension: \""
2428 << filename << "\"" << std::endl;
2431 // Ok, attempt to load the file and add to cache
2432 std::string filepath;
2433 filepath.append(mediapath).append(DIR_DELIM).append(filename);
2436 std::ifstream fis(filepath.c_str(), std::ios_base::binary);
2438 errorstream << "Server::fillMediaCache(): Could not open \""
2439 << filename << "\" for reading" << std::endl;
2442 std::ostringstream tmp_os(std::ios_base::binary);
2446 fis.read(buf, 1024);
2447 std::streamsize len = fis.gcount();
2448 tmp_os.write(buf, len);
2457 errorstream<<"Server::fillMediaCache(): Failed to read \""
2458 << filename << "\"" << std::endl;
2461 if(tmp_os.str().length() == 0) {
2462 errorstream << "Server::fillMediaCache(): Empty file \""
2463 << filepath << "\"" << std::endl;
2468 sha1.addBytes(tmp_os.str().c_str(), tmp_os.str().length());
2470 unsigned char *digest = sha1.getDigest();
2471 std::string sha1_base64 = base64_encode(digest, 20);
2472 std::string sha1_hex = hex_encode((char*)digest, 20);
2476 m_media[filename] = MediaInfo(filepath, sha1_base64);
2477 verbosestream << "Server: " << sha1_hex << " is " << filename
2483 void Server::sendMediaAnnouncement(session_t peer_id, const std::string &lang_code)
2486 NetworkPacket pkt(TOCLIENT_ANNOUNCE_MEDIA, 0, peer_id);
2489 std::string lang_suffix;
2490 lang_suffix.append(".").append(lang_code).append(".tr");
2491 for (const auto &i : m_media) {
2492 if (str_ends_with(i.first, ".tr") && !str_ends_with(i.first, lang_suffix))
2499 for (const auto &i : m_media) {
2500 if (str_ends_with(i.first, ".tr") && !str_ends_with(i.first, lang_suffix))
2502 pkt << i.first << i.second.sha1_digest;
2505 pkt << g_settings->get("remote_media");
2508 verbosestream << "Server: Announcing files to id(" << peer_id
2509 << "): count=" << media_sent << " size=" << pkt.getSize() << std::endl;
2512 struct SendableMedia
2518 SendableMedia(const std::string &name_="", const std::string &path_="",
2519 const std::string &data_=""):
2526 void Server::sendRequestedMedia(session_t peer_id,
2527 const std::vector<std::string> &tosend)
2529 verbosestream<<"Server::sendRequestedMedia(): "
2530 <<"Sending files to client"<<std::endl;
2534 // Put 5kB in one bunch (this is not accurate)
2535 u32 bytes_per_bunch = 5000;
2537 std::vector< std::vector<SendableMedia> > file_bunches;
2538 file_bunches.emplace_back();
2540 u32 file_size_bunch_total = 0;
2542 for (const std::string &name : tosend) {
2543 if (m_media.find(name) == m_media.end()) {
2544 errorstream<<"Server::sendRequestedMedia(): Client asked for "
2545 <<"unknown file \""<<(name)<<"\""<<std::endl;
2549 //TODO get path + name
2550 std::string tpath = m_media[name].path;
2553 std::ifstream fis(tpath.c_str(), std::ios_base::binary);
2555 errorstream<<"Server::sendRequestedMedia(): Could not open \""
2556 <<tpath<<"\" for reading"<<std::endl;
2559 std::ostringstream tmp_os(std::ios_base::binary);
2563 fis.read(buf, 1024);
2564 std::streamsize len = fis.gcount();
2565 tmp_os.write(buf, len);
2566 file_size_bunch_total += len;
2575 errorstream<<"Server::sendRequestedMedia(): Failed to read \""
2576 <<name<<"\""<<std::endl;
2579 /*infostream<<"Server::sendRequestedMedia(): Loaded \""
2580 <<tname<<"\""<<std::endl;*/
2582 file_bunches[file_bunches.size()-1].emplace_back(name, tpath, tmp_os.str());
2584 // Start next bunch if got enough data
2585 if(file_size_bunch_total >= bytes_per_bunch) {
2586 file_bunches.emplace_back();
2587 file_size_bunch_total = 0;
2592 /* Create and send packets */
2594 u16 num_bunches = file_bunches.size();
2595 for (u16 i = 0; i < num_bunches; i++) {
2598 u16 total number of texture bunches
2599 u16 index of this bunch
2600 u32 number of files in this bunch
2609 NetworkPacket pkt(TOCLIENT_MEDIA, 4 + 0, peer_id);
2610 pkt << num_bunches << i << (u32) file_bunches[i].size();
2612 for (const SendableMedia &j : file_bunches[i]) {
2614 pkt.putLongString(j.data);
2617 verbosestream << "Server::sendRequestedMedia(): bunch "
2618 << i << "/" << num_bunches
2619 << " files=" << file_bunches[i].size()
2620 << " size=" << pkt.getSize() << std::endl;
2625 void Server::sendDetachedInventory(Inventory *inventory, const std::string &name, session_t peer_id)
2627 NetworkPacket pkt(TOCLIENT_DETACHED_INVENTORY, 0, peer_id);
2631 pkt << false; // Remove inventory
2633 pkt << true; // Update inventory
2635 // Serialization & NetworkPacket isn't a love story
2636 std::ostringstream os(std::ios_base::binary);
2637 inventory->serialize(os);
2638 inventory->setModified(false);
2640 const std::string &os_str = os.str();
2641 pkt << static_cast<u16>(os_str.size()); // HACK: to keep compatibility with 5.0.0 clients
2642 pkt.putRawString(os_str);
2645 if (peer_id == PEER_ID_INEXISTENT)
2646 m_clients.sendToAll(&pkt);
2651 void Server::sendDetachedInventories(session_t peer_id, bool incremental)
2653 // Lookup player name, to filter detached inventories just after
2654 std::string peer_name;
2655 if (peer_id != PEER_ID_INEXISTENT) {
2656 peer_name = getClient(peer_id, CS_Created)->getName();
2659 auto send_cb = [this, peer_id](const std::string &name, Inventory *inv) {
2660 sendDetachedInventory(inv, name, peer_id);
2663 m_inventory_mgr->sendDetachedInventories(peer_name, incremental, send_cb);
2670 void Server::DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason)
2672 PlayerSAO *playersao = getPlayerSAO(peer_id);
2675 infostream << "Server::DiePlayer(): Player "
2676 << playersao->getPlayer()->getName()
2677 << " dies" << std::endl;
2679 playersao->setHP(0, reason);
2680 playersao->clearParentAttachment();
2682 // Trigger scripted stuff
2683 m_script->on_dieplayer(playersao, reason);
2685 SendPlayerHP(peer_id);
2686 SendDeathscreen(peer_id, false, v3f(0,0,0));
2689 void Server::RespawnPlayer(session_t peer_id)
2691 PlayerSAO *playersao = getPlayerSAO(peer_id);
2694 infostream << "Server::RespawnPlayer(): Player "
2695 << playersao->getPlayer()->getName()
2696 << " respawns" << std::endl;
2698 playersao->setHP(playersao->accessObjectProperties()->hp_max,
2699 PlayerHPChangeReason(PlayerHPChangeReason::RESPAWN));
2700 playersao->setBreath(playersao->accessObjectProperties()->breath_max);
2702 bool repositioned = m_script->on_respawnplayer(playersao);
2703 if (!repositioned) {
2704 // setPos will send the new position to client
2705 playersao->setPos(findSpawnPos());
2708 SendPlayerHP(peer_id);
2712 void Server::DenySudoAccess(session_t peer_id)
2714 NetworkPacket pkt(TOCLIENT_DENY_SUDO_MODE, 0, peer_id);
2719 void Server::DenyAccessVerCompliant(session_t peer_id, u16 proto_ver, AccessDeniedCode reason,
2720 const std::string &str_reason, bool reconnect)
2722 SendAccessDenied(peer_id, reason, str_reason, reconnect);
2724 m_clients.event(peer_id, CSE_SetDenied);
2725 DisconnectPeer(peer_id);
2729 void Server::DenyAccess(session_t peer_id, AccessDeniedCode reason,
2730 const std::string &custom_reason)
2732 SendAccessDenied(peer_id, reason, custom_reason);
2733 m_clients.event(peer_id, CSE_SetDenied);
2734 DisconnectPeer(peer_id);
2737 // 13/03/15: remove this function when protocol version 25 will become
2738 // the minimum version for MT users, maybe in 1 year
2739 void Server::DenyAccess_Legacy(session_t peer_id, const std::wstring &reason)
2741 SendAccessDenied_Legacy(peer_id, reason);
2742 m_clients.event(peer_id, CSE_SetDenied);
2743 DisconnectPeer(peer_id);
2746 void Server::DisconnectPeer(session_t peer_id)
2748 m_modchannel_mgr->leaveAllChannels(peer_id);
2749 m_con->DisconnectPeer(peer_id);
2752 void Server::acceptAuth(session_t peer_id, bool forSudoMode)
2755 RemoteClient* client = getClient(peer_id, CS_Invalid);
2757 NetworkPacket resp_pkt(TOCLIENT_AUTH_ACCEPT, 1 + 6 + 8 + 4, peer_id);
2759 // Right now, the auth mechs don't change between login and sudo mode.
2760 u32 sudo_auth_mechs = client->allowed_auth_mechs;
2761 client->allowed_sudo_mechs = sudo_auth_mechs;
2763 resp_pkt << v3f(0,0,0) << (u64) m_env->getServerMap().getSeed()
2764 << g_settings->getFloat("dedicated_server_step")
2768 m_clients.event(peer_id, CSE_AuthAccept);
2770 NetworkPacket resp_pkt(TOCLIENT_ACCEPT_SUDO_MODE, 1 + 6 + 8 + 4, peer_id);
2772 // We only support SRP right now
2773 u32 sudo_auth_mechs = AUTH_MECHANISM_FIRST_SRP;
2775 resp_pkt << sudo_auth_mechs;
2777 m_clients.event(peer_id, CSE_SudoSuccess);
2781 void Server::DeleteClient(session_t peer_id, ClientDeletionReason reason)
2783 std::wstring message;
2786 Clear references to playing sounds
2788 for (std::unordered_map<s32, ServerPlayingSound>::iterator
2789 i = m_playing_sounds.begin(); i != m_playing_sounds.end();) {
2790 ServerPlayingSound &psound = i->second;
2791 psound.clients.erase(peer_id);
2792 if (psound.clients.empty())
2793 m_playing_sounds.erase(i++);
2798 // clear formspec info so the next client can't abuse the current state
2799 m_formspec_state_data.erase(peer_id);
2801 RemotePlayer *player = m_env->getPlayer(peer_id);
2803 /* Run scripts and remove from environment */
2805 PlayerSAO *playersao = player->getPlayerSAO();
2808 playersao->clearChildAttachments();
2809 playersao->clearParentAttachment();
2811 // inform connected clients
2812 const std::string &player_name = player->getName();
2813 NetworkPacket notice(TOCLIENT_UPDATE_PLAYER_LIST, 0, PEER_ID_INEXISTENT);
2814 // (u16) 1 + std::string represents a vector serialization representation
2815 notice << (u8) PLAYER_LIST_REMOVE << (u16) 1 << player_name;
2816 m_clients.sendToAll(¬ice);
2818 m_script->on_leaveplayer(playersao, reason == CDR_TIMEOUT);
2820 playersao->disconnected();
2827 if (player && reason != CDR_DENY) {
2828 std::ostringstream os(std::ios_base::binary);
2829 std::vector<session_t> clients = m_clients.getClientIDs();
2831 for (const session_t client_id : clients) {
2833 RemotePlayer *player = m_env->getPlayer(client_id);
2837 // Get name of player
2838 os << player->getName() << " ";
2841 std::string name = player->getName();
2842 actionstream << name << " "
2843 << (reason == CDR_TIMEOUT ? "times out." : "leaves game.")
2844 << " List of players: " << os.str() << std::endl;
2846 m_admin_chat->outgoing_queue.push_back(
2847 new ChatEventNick(CET_NICK_REMOVE, name));
2851 MutexAutoLock env_lock(m_env_mutex);
2852 m_clients.DeleteClient(peer_id);
2856 // Send leave chat message to all remaining clients
2857 if (!message.empty()) {
2858 SendChatMessage(PEER_ID_INEXISTENT,
2859 ChatMessage(CHATMESSAGE_TYPE_ANNOUNCE, message));
2863 void Server::UpdateCrafting(RemotePlayer *player)
2865 InventoryList *clist = player->inventory.getList("craft");
2866 if (!clist || clist->getSize() == 0)
2869 if (!clist->checkModified())
2872 // Get a preview for crafting
2874 InventoryLocation loc;
2875 loc.setPlayer(player->getName());
2876 std::vector<ItemStack> output_replacements;
2877 getCraftingResult(&player->inventory, preview, output_replacements, false, this);
2878 m_env->getScriptIface()->item_CraftPredict(preview, player->getPlayerSAO(),
2881 InventoryList *plist = player->inventory.getList("craftpreview");
2882 if (plist && plist->getSize() >= 1) {
2883 // Put the new preview in
2884 plist->changeItem(0, preview);
2888 void Server::handleChatInterfaceEvent(ChatEvent *evt)
2890 if (evt->type == CET_NICK_ADD) {
2891 // The terminal informed us of its nick choice
2892 m_admin_nick = ((ChatEventNick *)evt)->nick;
2893 if (!m_script->getAuth(m_admin_nick, NULL, NULL)) {
2894 errorstream << "You haven't set up an account." << std::endl
2895 << "Please log in using the client as '"
2896 << m_admin_nick << "' with a secure password." << std::endl
2897 << "Until then, you can't execute admin tasks via the console," << std::endl
2898 << "and everybody can claim the user account instead of you," << std::endl
2899 << "giving them full control over this server." << std::endl;
2902 assert(evt->type == CET_CHAT);
2903 handleAdminChat((ChatEventChat *)evt);
2907 std::wstring Server::handleChat(const std::string &name, const std::wstring &wname,
2908 std::wstring wmessage, bool check_shout_priv, RemotePlayer *player)
2910 // If something goes wrong, this player is to blame
2911 RollbackScopeActor rollback_scope(m_rollback,
2912 std::string("player:") + name);
2914 if (g_settings->getBool("strip_color_codes"))
2915 wmessage = unescape_enriched(wmessage);
2918 switch (player->canSendChatMessage()) {
2919 case RPLAYER_CHATRESULT_FLOODING: {
2920 std::wstringstream ws;
2921 ws << L"You cannot send more messages. You are limited to "
2922 << g_settings->getFloat("chat_message_limit_per_10sec")
2923 << L" messages per 10 seconds.";
2926 case RPLAYER_CHATRESULT_KICK:
2927 DenyAccess_Legacy(player->getPeerId(),
2928 L"You have been kicked due to message flooding.");
2930 case RPLAYER_CHATRESULT_OK:
2933 FATAL_ERROR("Unhandled chat filtering result found.");
2937 if (m_max_chatmessage_length > 0
2938 && wmessage.length() > m_max_chatmessage_length) {
2939 return L"Your message exceed the maximum chat message limit set on the server. "
2940 L"It was refused. Send a shorter message";
2943 auto message = trim(wide_to_utf8(wmessage));
2944 if (message.find_first_of("\n\r") != std::wstring::npos) {
2945 return L"New lines are not permitted in chat messages";
2948 // Run script hook, exit if script ate the chat message
2949 if (m_script->on_chat_message(name, message))
2954 // Whether to send line to the player that sent the message, or to all players
2955 bool broadcast_line = true;
2957 if (check_shout_priv && !checkPriv(name, "shout")) {
2958 line += L"-!- You don't have permission to shout.";
2959 broadcast_line = false;
2962 Workaround for fixing chat on Android. Lua doesn't handle
2963 the Cyrillic alphabet and some characters on older Android devices
2966 line += L"<" + wname + L"> " + wmessage;
2968 line += narrow_to_wide(m_script->formatChatMessage(name,
2969 wide_to_narrow(wmessage)));
2974 Tell calling method to send the message to sender
2976 if (!broadcast_line)
2980 Send the message to others
2982 actionstream << "CHAT: " << wide_to_narrow(unescape_enriched(line)) << std::endl;
2984 std::vector<session_t> clients = m_clients.getClientIDs();
2987 Send the message back to the inital sender
2988 if they are using protocol version >= 29
2991 session_t peer_id_to_avoid_sending =
2992 (player ? player->getPeerId() : PEER_ID_INEXISTENT);
2994 if (player && player->protocol_version >= 29)
2995 peer_id_to_avoid_sending = PEER_ID_INEXISTENT;
2997 for (u16 cid : clients) {
2998 if (cid != peer_id_to_avoid_sending)
2999 SendChatMessage(cid, ChatMessage(line));
3004 void Server::handleAdminChat(const ChatEventChat *evt)
3006 std::string name = evt->nick;
3007 std::wstring wname = utf8_to_wide(name);
3008 std::wstring wmessage = evt->evt_msg;
3010 std::wstring answer = handleChat(name, wname, wmessage);
3012 // If asked to send answer to sender
3013 if (!answer.empty()) {
3014 m_admin_chat->outgoing_queue.push_back(new ChatEventChat("", answer));
3018 RemoteClient *Server::getClient(session_t peer_id, ClientState state_min)
3020 RemoteClient *client = getClientNoEx(peer_id,state_min);
3022 throw ClientNotFoundException("Client not found");
3026 RemoteClient *Server::getClientNoEx(session_t peer_id, ClientState state_min)
3028 return m_clients.getClientNoEx(peer_id, state_min);
3031 std::string Server::getPlayerName(session_t peer_id)
3033 RemotePlayer *player = m_env->getPlayer(peer_id);
3035 return "[id="+itos(peer_id)+"]";
3036 return player->getName();
3039 PlayerSAO *Server::getPlayerSAO(session_t peer_id)
3041 RemotePlayer *player = m_env->getPlayer(peer_id);
3044 return player->getPlayerSAO();
3047 std::wstring Server::getStatusString()
3049 std::wostringstream os(std::ios_base::binary);
3050 os << L"# Server: ";
3052 os << L"version=" << narrow_to_wide(g_version_string);
3054 os << L", uptime=" << m_uptime_counter->get();
3056 os << L", max_lag=" << (m_env ? m_env->getMaxLagEstimate() : 0);
3058 // Information about clients
3060 os << L", clients={";
3062 std::vector<session_t> clients = m_clients.getClientIDs();
3063 for (session_t client_id : clients) {
3064 RemotePlayer *player = m_env->getPlayer(client_id);
3066 // Get name of player
3067 std::wstring name = L"unknown";
3069 name = narrow_to_wide(player->getName());
3071 // Add name to information string
3082 if (m_env && !((ServerMap*)(&m_env->getMap()))->isSavingEnabled())
3083 os << std::endl << L"# Server: " << " WARNING: Map saving is disabled.";
3085 if (!g_settings->get("motd").empty())
3086 os << std::endl << L"# Server: " << narrow_to_wide(g_settings->get("motd"));
3091 std::set<std::string> Server::getPlayerEffectivePrivs(const std::string &name)
3093 std::set<std::string> privs;
3094 m_script->getAuth(name, NULL, &privs);
3098 bool Server::checkPriv(const std::string &name, const std::string &priv)
3100 std::set<std::string> privs = getPlayerEffectivePrivs(name);
3101 return (privs.count(priv) != 0);
3104 void Server::reportPrivsModified(const std::string &name)
3107 std::vector<session_t> clients = m_clients.getClientIDs();
3108 for (const session_t client_id : clients) {
3109 RemotePlayer *player = m_env->getPlayer(client_id);
3110 reportPrivsModified(player->getName());
3113 RemotePlayer *player = m_env->getPlayer(name.c_str());
3116 SendPlayerPrivileges(player->getPeerId());
3117 PlayerSAO *sao = player->getPlayerSAO();
3120 sao->updatePrivileges(
3121 getPlayerEffectivePrivs(name),
3126 void Server::reportInventoryFormspecModified(const std::string &name)
3128 RemotePlayer *player = m_env->getPlayer(name.c_str());
3131 SendPlayerInventoryFormspec(player->getPeerId());
3134 void Server::reportFormspecPrependModified(const std::string &name)
3136 RemotePlayer *player = m_env->getPlayer(name.c_str());
3139 SendPlayerFormspecPrepend(player->getPeerId());
3142 void Server::setIpBanned(const std::string &ip, const std::string &name)
3144 m_banmanager->add(ip, name);
3147 void Server::unsetIpBanned(const std::string &ip_or_name)
3149 m_banmanager->remove(ip_or_name);
3152 std::string Server::getBanDescription(const std::string &ip_or_name)
3154 return m_banmanager->getBanDescription(ip_or_name);
3157 void Server::notifyPlayer(const char *name, const std::wstring &msg)
3159 // m_env will be NULL if the server is initializing
3163 if (m_admin_nick == name && !m_admin_nick.empty()) {
3164 m_admin_chat->outgoing_queue.push_back(new ChatEventChat("", msg));
3167 RemotePlayer *player = m_env->getPlayer(name);
3172 if (player->getPeerId() == PEER_ID_INEXISTENT)
3175 SendChatMessage(player->getPeerId(), ChatMessage(msg));
3178 bool Server::showFormspec(const char *playername, const std::string &formspec,
3179 const std::string &formname)
3181 // m_env will be NULL if the server is initializing
3185 RemotePlayer *player = m_env->getPlayer(playername);
3189 SendShowFormspecMessage(player->getPeerId(), formspec, formname);
3193 u32 Server::hudAdd(RemotePlayer *player, HudElement *form)
3198 u32 id = player->addHud(form);
3200 SendHUDAdd(player->getPeerId(), id, form);
3205 bool Server::hudRemove(RemotePlayer *player, u32 id) {
3209 HudElement* todel = player->removeHud(id);
3216 SendHUDRemove(player->getPeerId(), id);
3220 bool Server::hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *data)
3225 SendHUDChange(player->getPeerId(), id, stat, data);
3229 bool Server::hudSetFlags(RemotePlayer *player, u32 flags, u32 mask)
3234 SendHUDSetFlags(player->getPeerId(), flags, mask);
3235 player->hud_flags &= ~mask;
3236 player->hud_flags |= flags;
3238 PlayerSAO* playersao = player->getPlayerSAO();
3243 m_script->player_event(playersao, "hud_changed");
3247 bool Server::hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount)
3252 if (hotbar_itemcount <= 0 || hotbar_itemcount > HUD_HOTBAR_ITEMCOUNT_MAX)
3255 player->setHotbarItemcount(hotbar_itemcount);
3256 std::ostringstream os(std::ios::binary);
3257 writeS32(os, hotbar_itemcount);
3258 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_ITEMCOUNT, os.str());
3262 void Server::hudSetHotbarImage(RemotePlayer *player, const std::string &name)
3267 player->setHotbarImage(name);
3268 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_IMAGE, name);
3271 void Server::hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name)
3276 player->setHotbarSelectedImage(name);
3277 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_SELECTED_IMAGE, name);
3280 Address Server::getPeerAddress(session_t peer_id)
3282 return m_con->GetPeerAddress(peer_id);
3285 void Server::setLocalPlayerAnimations(RemotePlayer *player,
3286 v2s32 animation_frames[4], f32 frame_speed)
3288 sanity_check(player);
3289 player->setLocalAnimations(animation_frames, frame_speed);
3290 SendLocalPlayerAnimations(player->getPeerId(), animation_frames, frame_speed);
3293 void Server::setPlayerEyeOffset(RemotePlayer *player, const v3f &first, const v3f &third)
3295 sanity_check(player);
3296 player->eye_offset_first = first;
3297 player->eye_offset_third = third;
3298 SendEyeOffset(player->getPeerId(), first, third);
3301 void Server::setSky(RemotePlayer *player, const SkyboxParams ¶ms)
3303 sanity_check(player);
3304 player->setSky(params);
3305 SendSetSky(player->getPeerId(), params);
3308 void Server::setSun(RemotePlayer *player, const SunParams ¶ms)
3310 sanity_check(player);
3311 player->setSun(params);
3312 SendSetSun(player->getPeerId(), params);
3315 void Server::setMoon(RemotePlayer *player, const MoonParams ¶ms)
3317 sanity_check(player);
3318 player->setMoon(params);
3319 SendSetMoon(player->getPeerId(), params);
3322 void Server::setStars(RemotePlayer *player, const StarParams ¶ms)
3324 sanity_check(player);
3325 player->setStars(params);
3326 SendSetStars(player->getPeerId(), params);
3329 void Server::setClouds(RemotePlayer *player, const CloudParams ¶ms)
3331 sanity_check(player);
3332 player->setCloudParams(params);
3333 SendCloudParams(player->getPeerId(), params);
3336 void Server::overrideDayNightRatio(RemotePlayer *player, bool do_override,
3339 sanity_check(player);
3340 player->overrideDayNightRatio(do_override, ratio);
3341 SendOverrideDayNightRatio(player->getPeerId(), do_override, ratio);
3344 void Server::notifyPlayers(const std::wstring &msg)
3346 SendChatMessage(PEER_ID_INEXISTENT, ChatMessage(msg));
3349 void Server::spawnParticle(const std::string &playername,
3350 const ParticleParameters &p)
3352 // m_env will be NULL if the server is initializing
3356 session_t peer_id = PEER_ID_INEXISTENT;
3358 if (!playername.empty()) {
3359 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3362 peer_id = player->getPeerId();
3363 proto_ver = player->protocol_version;
3366 SendSpawnParticle(peer_id, proto_ver, p);
3369 u32 Server::addParticleSpawner(const ParticleSpawnerParameters &p,
3370 ServerActiveObject *attached, const std::string &playername)
3372 // m_env will be NULL if the server is initializing
3376 session_t peer_id = PEER_ID_INEXISTENT;
3378 if (!playername.empty()) {
3379 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3382 peer_id = player->getPeerId();
3383 proto_ver = player->protocol_version;
3386 u16 attached_id = attached ? attached->getId() : 0;
3389 if (attached_id == 0)
3390 id = m_env->addParticleSpawner(p.time);
3392 id = m_env->addParticleSpawner(p.time, attached_id);
3394 SendAddParticleSpawner(peer_id, proto_ver, p, attached_id, id);
3398 void Server::deleteParticleSpawner(const std::string &playername, u32 id)
3400 // m_env will be NULL if the server is initializing
3402 throw ServerError("Can't delete particle spawners during initialisation!");
3404 session_t peer_id = PEER_ID_INEXISTENT;
3405 if (!playername.empty()) {
3406 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3409 peer_id = player->getPeerId();
3412 m_env->deleteParticleSpawner(id);
3413 SendDeleteParticleSpawner(peer_id, id);
3416 // actions: time-reversed list
3417 // Return value: success/failure
3418 bool Server::rollbackRevertActions(const std::list<RollbackAction> &actions,
3419 std::list<std::string> *log)
3421 infostream<<"Server::rollbackRevertActions(len="<<actions.size()<<")"<<std::endl;
3422 ServerMap *map = (ServerMap*)(&m_env->getMap());
3424 // Fail if no actions to handle
3425 if (actions.empty()) {
3427 log->push_back("Nothing to do.");
3434 for (const RollbackAction &action : actions) {
3436 bool success = action.applyRevert(map, m_inventory_mgr.get(), this);
3439 std::ostringstream os;
3440 os<<"Revert of step ("<<num_tried<<") "<<action.toString()<<" failed";
3441 infostream<<"Map::rollbackRevertActions(): "<<os.str()<<std::endl;
3443 log->push_back(os.str());
3445 std::ostringstream os;
3446 os<<"Successfully reverted step ("<<num_tried<<") "<<action.toString();
3447 infostream<<"Map::rollbackRevertActions(): "<<os.str()<<std::endl;
3449 log->push_back(os.str());
3453 infostream<<"Map::rollbackRevertActions(): "<<num_failed<<"/"<<num_tried
3454 <<" failed"<<std::endl;
3456 // Call it done if less than half failed
3457 return num_failed <= num_tried/2;
3460 // IGameDef interface
3462 IItemDefManager *Server::getItemDefManager()
3467 const NodeDefManager *Server::getNodeDefManager()
3472 ICraftDefManager *Server::getCraftDefManager()
3477 u16 Server::allocateUnknownNodeId(const std::string &name)
3479 return m_nodedef->allocateDummy(name);
3482 IWritableItemDefManager *Server::getWritableItemDefManager()
3487 NodeDefManager *Server::getWritableNodeDefManager()
3492 IWritableCraftDefManager *Server::getWritableCraftDefManager()
3497 const std::vector<ModSpec> & Server::getMods() const
3499 return m_modmgr->getMods();
3502 const ModSpec *Server::getModSpec(const std::string &modname) const
3504 return m_modmgr->getModSpec(modname);
3507 void Server::getModNames(std::vector<std::string> &modlist)
3509 m_modmgr->getModNames(modlist);
3512 std::string Server::getBuiltinLuaPath()
3514 return porting::path_share + DIR_DELIM + "builtin";
3517 std::string Server::getModStoragePath() const
3519 return m_path_world + DIR_DELIM + "mod_storage";
3522 v3f Server::findSpawnPos()
3524 ServerMap &map = m_env->getServerMap();
3526 if (g_settings->getV3FNoEx("static_spawnpoint", nodeposf))
3527 return nodeposf * BS;
3529 bool is_good = false;
3530 // Limit spawn range to mapgen edges (determined by 'mapgen_limit')
3531 s32 range_max = map.getMapgenParams()->getSpawnRangeMax();
3533 // Try to find a good place a few times
3534 for (s32 i = 0; i < 4000 && !is_good; i++) {
3535 s32 range = MYMIN(1 + i, range_max);
3536 // We're going to try to throw the player to this position
3537 v2s16 nodepos2d = v2s16(
3538 -range + (myrand() % (range * 2)),
3539 -range + (myrand() % (range * 2)));
3540 // Get spawn level at point
3541 s16 spawn_level = m_emerge->getSpawnLevelAtPoint(nodepos2d);
3542 // Continue if MAX_MAP_GENERATION_LIMIT was returned by the mapgen to
3543 // signify an unsuitable spawn position, or if outside limits.
3544 if (spawn_level >= MAX_MAP_GENERATION_LIMIT ||
3545 spawn_level <= -MAX_MAP_GENERATION_LIMIT)
3548 v3s16 nodepos(nodepos2d.X, spawn_level, nodepos2d.Y);
3549 // Consecutive empty nodes
3552 // Search upwards from 'spawn level' for 2 consecutive empty nodes, to
3553 // avoid obstructions in already-generated mapblocks.
3554 // In ungenerated mapblocks consisting of 'ignore' nodes, there will be
3555 // no obstructions, but mapgen decorations are generated after spawn so
3556 // the player may end up inside one.
3557 for (s32 i = 0; i < 8; i++) {
3558 v3s16 blockpos = getNodeBlockPos(nodepos);
3559 map.emergeBlock(blockpos, true);
3560 content_t c = map.getNode(nodepos).getContent();
3562 // In generated mapblocks allow spawn in all 'airlike' drawtype nodes.
3563 // In ungenerated mapblocks allow spawn in 'ignore' nodes.
3564 if (m_nodedef->get(c).drawtype == NDT_AIRLIKE || c == CONTENT_IGNORE) {
3566 if (air_count >= 2) {
3567 // Spawn in lower empty node
3569 nodeposf = intToFloat(nodepos, BS);
3570 // Don't spawn the player outside map boundaries
3571 if (objectpos_over_limit(nodeposf))
3572 // Exit this loop, positions above are probably over limit
3575 // Good position found, cause an exit from main loop
3589 // No suitable spawn point found, return fallback 0,0,0
3590 return v3f(0.0f, 0.0f, 0.0f);
3593 void Server::requestShutdown(const std::string &msg, bool reconnect, float delay)
3595 if (delay == 0.0f) {
3596 // No delay, shutdown immediately
3597 m_shutdown_state.is_requested = true;
3598 // only print to the infostream, a chat message saying
3599 // "Server Shutting Down" is sent when the server destructs.
3600 infostream << "*** Immediate Server shutdown requested." << std::endl;
3601 } else if (delay < 0.0f && m_shutdown_state.isTimerRunning()) {
3602 // Negative delay, cancel shutdown if requested
3603 m_shutdown_state.reset();
3604 std::wstringstream ws;
3606 ws << L"*** Server shutdown canceled.";
3608 infostream << wide_to_utf8(ws.str()).c_str() << std::endl;
3609 SendChatMessage(PEER_ID_INEXISTENT, ws.str());
3610 // m_shutdown_* are already handled, skip.
3612 } else if (delay > 0.0f) {
3613 // Positive delay, tell the clients when the server will shut down
3614 std::wstringstream ws;
3616 ws << L"*** Server shutting down in "
3617 << duration_to_string(myround(delay)).c_str()
3620 infostream << wide_to_utf8(ws.str()).c_str() << std::endl;
3621 SendChatMessage(PEER_ID_INEXISTENT, ws.str());
3624 m_shutdown_state.trigger(delay, msg, reconnect);
3627 PlayerSAO* Server::emergePlayer(const char *name, session_t peer_id, u16 proto_version)
3630 Try to get an existing player
3632 RemotePlayer *player = m_env->getPlayer(name);
3634 // If player is already connected, cancel
3635 if (player && player->getPeerId() != PEER_ID_INEXISTENT) {
3636 infostream<<"emergePlayer(): Player already connected"<<std::endl;
3641 If player with the wanted peer_id already exists, cancel.
3643 if (m_env->getPlayer(peer_id)) {
3644 infostream<<"emergePlayer(): Player with wrong name but same"
3645 " peer_id already exists"<<std::endl;
3650 player = new RemotePlayer(name, idef());
3653 bool newplayer = false;
3656 PlayerSAO *playersao = m_env->loadPlayer(player, &newplayer, peer_id, isSingleplayer());
3658 // Complete init with server parts
3659 playersao->finalize(player, getPlayerEffectivePrivs(player->getName()));
3660 player->protocol_version = proto_version;
3664 m_script->on_newplayer(playersao);
3670 bool Server::registerModStorage(ModMetadata *storage)
3672 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
3673 errorstream << "Unable to register same mod storage twice. Storage name: "
3674 << storage->getModName() << std::endl;
3678 m_mod_storages[storage->getModName()] = storage;
3682 void Server::unregisterModStorage(const std::string &name)
3684 std::unordered_map<std::string, ModMetadata *>::const_iterator it = m_mod_storages.find(name);
3685 if (it != m_mod_storages.end()) {
3686 // Save unconditionaly on unregistration
3687 it->second->save(getModStoragePath());
3688 m_mod_storages.erase(name);
3692 void dedicated_server_loop(Server &server, bool &kill)
3694 verbosestream<<"dedicated_server_loop()"<<std::endl;
3696 IntervalLimiter m_profiler_interval;
3698 static thread_local const float steplen =
3699 g_settings->getFloat("dedicated_server_step");
3700 static thread_local const float profiler_print_interval =
3701 g_settings->getFloat("profiler_print_interval");
3704 * The dedicated server loop only does time-keeping (in Server::step) and
3705 * provides a way to main.cpp to kill the server externally (bool &kill).
3709 // This is kind of a hack but can be done like this
3710 // because server.step() is very light
3711 sleep_ms((int)(steplen*1000.0));
3712 server.step(steplen);
3714 if (server.isShutdownRequested() || kill)
3720 if (profiler_print_interval != 0) {
3721 if(m_profiler_interval.step(steplen, profiler_print_interval))
3723 infostream<<"Profiler:"<<std::endl;
3724 g_profiler->print(infostream);
3725 g_profiler->clear();
3730 infostream << "Dedicated server quitting" << std::endl;
3732 if (g_settings->getBool("server_announce"))
3733 ServerList::sendAnnounce(ServerList::AA_DELETE,
3734 server.m_bind_addr.getPort());
3743 bool Server::joinModChannel(const std::string &channel)
3745 return m_modchannel_mgr->joinChannel(channel, PEER_ID_SERVER) &&
3746 m_modchannel_mgr->setChannelState(channel, MODCHANNEL_STATE_READ_WRITE);
3749 bool Server::leaveModChannel(const std::string &channel)
3751 return m_modchannel_mgr->leaveChannel(channel, PEER_ID_SERVER);
3754 bool Server::sendModChannelMessage(const std::string &channel, const std::string &message)
3756 if (!m_modchannel_mgr->canWriteOnChannel(channel))
3759 broadcastModChannelMessage(channel, message, PEER_ID_SERVER);
3763 ModChannel* Server::getModChannel(const std::string &channel)
3765 return m_modchannel_mgr->getModChannel(channel);
3768 void Server::broadcastModChannelMessage(const std::string &channel,
3769 const std::string &message, session_t from_peer)
3771 const std::vector<u16> &peers = m_modchannel_mgr->getChannelPeers(channel);
3775 if (message.size() > STRING_MAX_LEN) {
3776 warningstream << "ModChannel message too long, dropping before sending "
3777 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
3778 << channel << ")" << std::endl;
3783 if (from_peer != PEER_ID_SERVER) {
3784 sender = getPlayerName(from_peer);
3787 NetworkPacket resp_pkt(TOCLIENT_MODCHANNEL_MSG,
3788 2 + channel.size() + 2 + sender.size() + 2 + message.size());
3789 resp_pkt << channel << sender << message;
3790 for (session_t peer_id : peers) {
3792 if (peer_id == from_peer)
3795 Send(peer_id, &resp_pkt);
3798 if (from_peer != PEER_ID_SERVER) {
3799 m_script->on_modchannel_message(channel, sender, message);
3803 void Server::loadTranslationLanguage(const std::string &lang_code)
3805 if (g_server_translations->count(lang_code))
3806 return; // Already loaded
3808 std::string suffix = "." + lang_code + ".tr";
3809 for (const auto &i : m_media) {
3810 if (str_ends_with(i.first, suffix)) {
3811 std::ifstream t(i.second.path);
3812 std::string data((std::istreambuf_iterator<char>(t)),
3813 std::istreambuf_iterator<char>());
3815 (*g_server_translations)[lang_code].loadTranslation(data);