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 "serverobject.h"
38 #include "genericobject.h"
42 #include "scripting_server.h"
47 #include "mapgen/mapgen.h"
48 #include "mapgen/mg_biome.h"
49 #include "content_mapnode.h"
50 #include "content_nodemeta.h"
51 #include "content_sao.h"
52 #include "content/mods.h"
53 #include "modchannels.h"
54 #include "serverlist.h"
55 #include "util/string.h"
57 #include "util/serialize.h"
58 #include "util/thread.h"
59 #include "defaultsettings.h"
60 #include "server/mods.h"
61 #include "util/base64.h"
62 #include "util/sha1.h"
64 #include "database/database.h"
65 #include "chatmessage.h"
66 #include "chat_interface.h"
67 #include "remoteplayer.h"
69 class ClientNotFoundException : public BaseException
72 ClientNotFoundException(const char *s):
77 class ServerThread : public Thread
81 ServerThread(Server *server):
92 void *ServerThread::run()
94 BEGIN_DEBUG_EXCEPTION_HANDLER
97 * The real business of the server happens on the ServerThread.
99 * AsyncRunStep() runs an actual server step as soon as enough time has
100 * passed (dedicated_server_loop keeps track of that).
101 * Receive() blocks at least(!) 30ms waiting for a packet (so this loop
102 * doesn't busy wait) and will process any remaining packets.
105 m_server->AsyncRunStep(true);
107 while (!stopRequested()) {
109 m_server->AsyncRunStep();
113 } catch (con::PeerNotFoundException &e) {
114 infostream<<"Server: PeerNotFoundException"<<std::endl;
115 } catch (ClientNotFoundException &e) {
116 } catch (con::ConnectionBindFailed &e) {
117 m_server->setAsyncFatalError(e.what());
118 } catch (LuaError &e) {
119 m_server->setAsyncFatalError(
120 "ServerThread::run Lua: " + std::string(e.what()));
124 END_DEBUG_EXCEPTION_HANDLER
129 v3f ServerSoundParams::getPos(ServerEnvironment *env, bool *pos_exists) const
131 if(pos_exists) *pos_exists = false;
136 if(pos_exists) *pos_exists = true;
141 ServerActiveObject *sao = env->getActiveObject(object);
144 if(pos_exists) *pos_exists = true;
145 return sao->getBasePosition(); }
150 void Server::ShutdownState::reset()
154 should_reconnect = false;
155 is_requested = false;
158 void Server::ShutdownState::trigger(float delay, const std::string &msg, bool reconnect)
162 should_reconnect = reconnect;
165 void Server::ShutdownState::tick(float dtime, Server *server)
171 static const float shutdown_msg_times[] =
173 1, 2, 3, 4, 5, 10, 20, 40, 60, 120, 180, 300, 600, 1200, 1800, 3600
176 // Automated messages
177 if (m_timer < shutdown_msg_times[ARRLEN(shutdown_msg_times) - 1]) {
178 for (float t : shutdown_msg_times) {
179 // If shutdown timer matches an automessage, shot it
180 if (m_timer > t && m_timer - dtime < t) {
181 std::wstring periodicMsg = getShutdownTimerMessage();
183 infostream << wide_to_utf8(periodicMsg).c_str() << std::endl;
184 server->SendChatMessage(PEER_ID_INEXISTENT, periodicMsg);
191 if (m_timer < 0.0f) {
197 std::wstring Server::ShutdownState::getShutdownTimerMessage() const
199 std::wstringstream ws;
200 ws << L"*** Server shutting down in "
201 << duration_to_string(myround(m_timer)).c_str() << ".";
210 const std::string &path_world,
211 const SubgameSpec &gamespec,
212 bool simple_singleplayer_mode,
217 m_bind_addr(bind_addr),
218 m_path_world(path_world),
219 m_gamespec(gamespec),
220 m_simple_singleplayer_mode(simple_singleplayer_mode),
221 m_dedicated(dedicated),
222 m_async_fatal_error(""),
223 m_con(std::make_shared<con::Connection>(PROTOCOL_ID,
226 m_bind_addr.isIPv6(),
228 m_itemdef(createItemDefManager()),
229 m_nodedef(createNodeDefManager()),
230 m_craftdef(createCraftDefManager()),
231 m_thread(new ServerThread(this)),
235 m_modchannel_mgr(new ModChannelMgr())
237 m_lag = g_settings->getFloat("dedicated_server_step");
239 if (m_path_world.empty())
240 throw ServerError("Supplied empty world path");
242 if (!gamespec.isValid())
243 throw ServerError("Supplied invalid gamespec");
249 // Send shutdown message
250 SendChatMessage(PEER_ID_INEXISTENT, ChatMessage(CHATMESSAGE_TYPE_ANNOUNCE,
251 L"*** Server shutting down"));
254 MutexAutoLock envlock(m_env_mutex);
256 infostream << "Server: Saving players" << std::endl;
257 m_env->saveLoadedPlayers();
259 infostream << "Server: Kicking players" << std::endl;
260 std::string kick_msg;
261 bool reconnect = false;
262 if (isShutdownRequested()) {
263 reconnect = m_shutdown_state.should_reconnect;
264 kick_msg = m_shutdown_state.message;
266 if (kick_msg.empty()) {
267 kick_msg = g_settings->get("kick_msg_shutdown");
269 m_env->saveLoadedPlayers(true);
270 m_env->kickAllPlayers(SERVER_ACCESSDENIED_SHUTDOWN,
271 kick_msg, reconnect);
274 actionstream << "Server: Shutting down" << std::endl;
276 // Do this before stopping the server in case mapgen callbacks need to access
277 // server-controlled resources (like ModStorages). Also do them before
278 // shutdown callbacks since they may modify state that is finalized in a
281 m_emerge->stopThreads();
284 MutexAutoLock envlock(m_env_mutex);
286 // Execute script shutdown hooks
287 infostream << "Executing shutdown hooks" << std::endl;
288 m_script->on_shutdown();
290 infostream << "Server: Saving environment metadata" << std::endl;
300 // Delete things in the reverse order of creation
309 // Deinitialize scripting
310 infostream << "Server: Deinitializing scripting" << std::endl;
313 // Delete detached inventories
314 for (auto &detached_inventory : m_detached_inventories) {
315 delete detached_inventory.second;
318 while (!m_unsent_map_edit_queue.empty()) {
319 delete m_unsent_map_edit_queue.front();
320 m_unsent_map_edit_queue.pop();
326 infostream << "Server created for gameid \"" << m_gamespec.id << "\"";
327 if (m_simple_singleplayer_mode)
328 infostream << " in simple singleplayer mode" << std::endl;
330 infostream << std::endl;
331 infostream << "- world: " << m_path_world << std::endl;
332 infostream << "- game: " << m_gamespec.path << std::endl;
334 // Create world if it doesn't exist
335 if (!loadGameConfAndInitWorld(m_path_world, m_gamespec))
336 throw ServerError("Failed to initialize world");
338 // Create emerge manager
339 m_emerge = new EmergeManager(this);
341 // Create ban manager
342 std::string ban_path = m_path_world + DIR_DELIM "ipban.txt";
343 m_banmanager = new BanManager(ban_path);
345 m_modmgr = std::unique_ptr<ServerModManager>(new ServerModManager(m_path_world));
346 std::vector<ModSpec> unsatisfied_mods = m_modmgr->getUnsatisfiedMods();
347 // complain about mods with unsatisfied dependencies
348 if (!m_modmgr->isConsistent()) {
349 m_modmgr->printUnsatisfiedModsError();
353 MutexAutoLock envlock(m_env_mutex);
355 // Create the Map (loads map_meta.txt, overriding configured mapgen params)
356 ServerMap *servermap = new ServerMap(m_path_world, this, m_emerge);
358 // Initialize scripting
359 infostream << "Server: Initializing Lua" << std::endl;
361 m_script = new ServerScripting(this);
363 m_script->loadMod(getBuiltinLuaPath() + DIR_DELIM "init.lua", BUILTIN_MOD_NAME);
365 m_modmgr->loadMods(m_script);
367 // Read Textures and calculate sha1 sums
370 // Apply item aliases in the node definition manager
371 m_nodedef->updateAliases(m_itemdef);
373 // Apply texture overrides from texturepack/override.txt
374 std::vector<std::string> paths;
375 fs::GetRecursiveDirs(paths, g_settings->get("texture_path"));
376 fs::GetRecursiveDirs(paths, m_gamespec.path + DIR_DELIM + "textures");
377 for (const std::string &path : paths)
378 m_nodedef->applyTextureOverrides(path + DIR_DELIM + "override.txt");
380 m_nodedef->setNodeRegistrationStatus(true);
382 // Perform pending node name resolutions
383 m_nodedef->runNodeResolveCallbacks();
385 // unmap node names for connected nodeboxes
386 m_nodedef->mapNodeboxConnections();
388 // init the recipe hashes to speed up crafting
389 m_craftdef->initHashes(this);
391 // Initialize Environment
392 m_env = new ServerEnvironment(servermap, m_script, this, m_path_world);
394 m_clients.setEnv(m_env);
396 if (!servermap->settings_mgr.makeMapgenParams())
397 FATAL_ERROR("Couldn't create any mapgen type");
399 // Initialize mapgens
400 m_emerge->initMapgens(servermap->getMapgenParams());
402 if (g_settings->getBool("enable_rollback_recording")) {
403 // Create rollback manager
404 m_rollback = new RollbackManager(m_path_world, this);
407 // Give environment reference to scripting api
408 m_script->initializeEnvironment(m_env);
410 // Register us to receive map edit events
411 servermap->addEventReceiver(this);
415 m_liquid_transform_every = g_settings->getFloat("liquid_update");
416 m_max_chatmessage_length = g_settings->getU16("chat_message_max_size");
417 m_csm_restriction_flags = g_settings->getU64("csm_restriction_flags");
418 m_csm_restriction_noderange = g_settings->getU32("csm_restriction_noderange");
423 infostream << "Starting server on " << m_bind_addr.serializeString()
424 << "..." << std::endl;
426 // Stop thread if already running
429 // Initialize connection
430 m_con->SetTimeoutMs(30);
431 m_con->Serve(m_bind_addr);
436 // ASCII art for the win!
438 << " .__ __ __ " << std::endl
439 << " _____ |__| ____ _____/ |_ ____ _______/ |_ " << std::endl
440 << " / \\| |/ \\_/ __ \\ __\\/ __ \\ / ___/\\ __\\" << std::endl
441 << "| Y Y \\ | | \\ ___/| | \\ ___/ \\___ \\ | | " << std::endl
442 << "|__|_| /__|___| /\\___ >__| \\___ >____ > |__| " << std::endl
443 << " \\/ \\/ \\/ \\/ \\/ " << std::endl;
444 actionstream << "World at [" << m_path_world << "]" << std::endl;
445 actionstream << "Server for gameid=\"" << m_gamespec.id
446 << "\" listening on " << m_bind_addr.serializeString() << ":"
447 << m_bind_addr.getPort() << "." << std::endl;
452 infostream<<"Server: Stopping and waiting threads"<<std::endl;
454 // Stop threads (set run=false first so both start stopping)
456 //m_emergethread.setRun(false);
458 //m_emergethread.stop();
460 infostream<<"Server: Threads stopped"<<std::endl;
463 void Server::step(float dtime)
469 MutexAutoLock lock(m_step_dtime_mutex);
470 m_step_dtime += dtime;
472 // Throw if fatal error occurred in thread
473 std::string async_err = m_async_fatal_error.get();
474 if (!async_err.empty()) {
475 if (!m_simple_singleplayer_mode) {
476 m_env->kickAllPlayers(SERVER_ACCESSDENIED_CRASH,
477 g_settings->get("kick_msg_crash"),
478 g_settings->getBool("ask_reconnect_on_crash"));
480 throw ServerError("AsyncErr: " + async_err);
484 void Server::AsyncRunStep(bool initial_step)
489 MutexAutoLock lock1(m_step_dtime_mutex);
490 dtime = m_step_dtime;
494 // Send blocks to clients
498 if((dtime < 0.001) && !initial_step)
501 ScopeProfiler sp(g_profiler, "Server::AsyncRunStep()", SPT_AVG);
504 MutexAutoLock lock1(m_step_dtime_mutex);
505 m_step_dtime -= dtime;
512 m_uptime.set(m_uptime.get() + dtime);
518 Update time of day and overall game time
520 m_env->setTimeOfDaySpeed(g_settings->getFloat("time_speed"));
523 Send to clients at constant intervals
526 m_time_of_day_send_timer -= dtime;
527 if(m_time_of_day_send_timer < 0.0) {
528 m_time_of_day_send_timer = g_settings->getFloat("time_send_interval");
529 u16 time = m_env->getTimeOfDay();
530 float time_speed = g_settings->getFloat("time_speed");
531 SendTimeOfDay(PEER_ID_INEXISTENT, time, time_speed);
535 MutexAutoLock lock(m_env_mutex);
536 // Figure out and report maximum lag to environment
537 float max_lag = m_env->getMaxLagEstimate();
538 max_lag *= 0.9998; // Decrease slowly (about half per 5 minutes)
540 if(dtime > 0.1 && dtime > max_lag * 2.0)
541 infostream<<"Server: Maximum lag peaked to "<<dtime
545 m_env->reportMaxLagEstimate(max_lag);
550 static const float map_timer_and_unload_dtime = 2.92;
551 if(m_map_timer_and_unload_interval.step(dtime, map_timer_and_unload_dtime))
553 MutexAutoLock lock(m_env_mutex);
554 // Run Map's timers and unload unused data
555 ScopeProfiler sp(g_profiler, "Server: map timer and unload");
556 m_env->getMap().timerUpdate(map_timer_and_unload_dtime,
557 g_settings->getFloat("server_unload_unused_data_timeout"),
562 Listen to the admin chat, if available
565 if (!m_admin_chat->command_queue.empty()) {
566 MutexAutoLock lock(m_env_mutex);
567 while (!m_admin_chat->command_queue.empty()) {
568 ChatEvent *evt = m_admin_chat->command_queue.pop_frontNoEx();
569 handleChatInterfaceEvent(evt);
573 m_admin_chat->outgoing_queue.push_back(
574 new ChatEventTimeInfo(m_env->getGameTime(), m_env->getTimeOfDay()));
581 /* Transform liquids */
582 m_liquid_transform_timer += dtime;
583 if(m_liquid_transform_timer >= m_liquid_transform_every)
585 m_liquid_transform_timer -= m_liquid_transform_every;
587 MutexAutoLock lock(m_env_mutex);
589 ScopeProfiler sp(g_profiler, "Server: liquid transform");
591 std::map<v3s16, MapBlock*> modified_blocks;
592 m_env->getMap().transformLiquids(modified_blocks, m_env);
595 Set the modified blocks unsent for all the clients
597 if (!modified_blocks.empty()) {
598 SetBlocksNotSent(modified_blocks);
601 m_clients.step(dtime);
603 m_lag += (m_lag > dtime ? -1 : 1) * dtime/100;
605 // send masterserver announce
607 float &counter = m_masterserver_timer;
608 if (!isSingleplayer() && (!counter || counter >= 300.0) &&
609 g_settings->getBool("server_announce")) {
610 ServerList::sendAnnounce(counter ? ServerList::AA_UPDATE :
611 ServerList::AA_START,
612 m_bind_addr.getPort(),
613 m_clients.getPlayerNames(),
615 m_env->getGameTime(),
618 Mapgen::getMapgenName(m_emerge->mgparams->mgtype),
628 Check added and deleted active objects
631 //infostream<<"Server: Checking added and deleted active objects"<<std::endl;
632 MutexAutoLock envlock(m_env_mutex);
635 const RemoteClientMap &clients = m_clients.getClientList();
636 ScopeProfiler sp(g_profiler, "Server: update objects within range");
638 for (const auto &client_it : clients) {
639 RemoteClient *client = client_it.second;
641 if (client->getState() < CS_DefinitionsSent)
644 // This can happen if the client times out somehow
645 if (!m_env->getPlayer(client->peer_id))
648 PlayerSAO *playersao = getPlayerSAO(client->peer_id);
652 SendActiveObjectRemoveAdd(client, playersao);
656 // Save mod storages if modified
657 m_mod_storage_save_timer -= dtime;
658 if (m_mod_storage_save_timer <= 0.0f) {
659 infostream << "Saving registered mod storages." << std::endl;
660 m_mod_storage_save_timer = g_settings->getFloat("server_map_save_interval");
661 for (std::unordered_map<std::string, ModMetadata *>::const_iterator
662 it = m_mod_storages.begin(); it != m_mod_storages.end(); ++it) {
663 if (it->second->isModified()) {
664 it->second->save(getModStoragePath());
674 MutexAutoLock envlock(m_env_mutex);
675 ScopeProfiler sp(g_profiler, "Server: send SAO messages");
678 // Value = data sent by object
679 std::unordered_map<u16, std::vector<ActiveObjectMessage>*> buffered_messages;
681 // Get active object messages from environment
683 ActiveObjectMessage aom = m_env->getActiveObjectMessage();
687 std::vector<ActiveObjectMessage>* message_list = nullptr;
688 std::unordered_map<u16, std::vector<ActiveObjectMessage>* >::iterator n;
689 n = buffered_messages.find(aom.id);
690 if (n == buffered_messages.end()) {
691 message_list = new std::vector<ActiveObjectMessage>;
692 buffered_messages[aom.id] = message_list;
695 message_list = n->second;
697 message_list->push_back(aom);
701 const RemoteClientMap &clients = m_clients.getClientList();
702 // Route data to every client
703 for (const auto &client_it : clients) {
704 RemoteClient *client = client_it.second;
705 PlayerSAO *player = getPlayerSAO(client->peer_id);
706 std::string reliable_data;
707 std::string unreliable_data;
708 // Go through all objects in message buffer
709 for (const auto &buffered_message : buffered_messages) {
710 // If object does not exist or is not known by client, skip it
711 u16 id = buffered_message.first;
712 ServerActiveObject *sao = m_env->getActiveObject(id);
713 if (!sao || client->m_known_objects.find(id) == client->m_known_objects.end())
716 // Get message list of object
717 std::vector<ActiveObjectMessage>* list = buffered_message.second;
718 // Go through every message
719 for (const ActiveObjectMessage &aom : *list) {
720 // Send position updates to players who do not see the attachment
721 if (aom.datastring[0] == GENERIC_CMD_UPDATE_POSITION) {
722 if (sao->getId() == player->getId())
725 // Do not send position updates for attached players
726 // as long the parent is known to the client
727 ServerActiveObject *parent = sao->getParent();
728 if (parent && client->m_known_objects.find(parent->getId()) !=
729 client->m_known_objects.end())
732 // Compose the full new data with header
733 std::string new_data;
736 writeU16((u8*)&buf[0], aom.id);
737 new_data.append(buf, 2);
739 new_data += serializeString(aom.datastring);
740 // Add data to buffer
742 reliable_data += new_data;
744 unreliable_data += new_data;
748 reliable_data and unreliable_data are now ready.
751 if (!reliable_data.empty()) {
752 SendActiveObjectMessages(client->peer_id, reliable_data);
755 if (!unreliable_data.empty()) {
756 SendActiveObjectMessages(client->peer_id, unreliable_data, false);
761 // Clear buffered_messages
762 for (auto &buffered_message : buffered_messages) {
763 delete buffered_message.second;
768 Send queued-for-sending map edit events.
771 // We will be accessing the environment
772 MutexAutoLock lock(m_env_mutex);
774 // Don't send too many at a time
777 // Single change sending is disabled if queue size is not small
778 bool disable_single_change_sending = false;
779 if(m_unsent_map_edit_queue.size() >= 4)
780 disable_single_change_sending = true;
782 int event_count = m_unsent_map_edit_queue.size();
784 // We'll log the amount of each
787 std::list<v3s16> node_meta_updates;
789 while (!m_unsent_map_edit_queue.empty()) {
790 MapEditEvent* event = m_unsent_map_edit_queue.front();
791 m_unsent_map_edit_queue.pop();
793 // Players far away from the change are stored here.
794 // Instead of sending the changes, MapBlocks are set not sent
796 std::unordered_set<u16> far_players;
798 switch (event->type) {
801 prof.add("MEET_ADDNODE", 1);
802 sendAddNode(event->p, event->n, &far_players,
803 disable_single_change_sending ? 5 : 30,
804 event->type == MEET_ADDNODE);
806 case MEET_REMOVENODE:
807 prof.add("MEET_REMOVENODE", 1);
808 sendRemoveNode(event->p, &far_players,
809 disable_single_change_sending ? 5 : 30);
811 case MEET_BLOCK_NODE_METADATA_CHANGED: {
812 verbosestream << "Server: MEET_BLOCK_NODE_METADATA_CHANGED" << std::endl;
813 prof.add("MEET_BLOCK_NODE_METADATA_CHANGED", 1);
814 if (!event->is_private_change) {
815 // Don't send the change yet. Collect them to eliminate dupes.
816 node_meta_updates.remove(event->p);
817 node_meta_updates.push_back(event->p);
820 if (MapBlock *block = m_env->getMap().getBlockNoCreateNoEx(
821 getNodeBlockPos(event->p))) {
822 block->raiseModified(MOD_STATE_WRITE_NEEDED,
823 MOD_REASON_REPORT_META_CHANGE);
828 infostream << "Server: MEET_OTHER" << std::endl;
829 prof.add("MEET_OTHER", 1);
830 for (const v3s16 &modified_block : event->modified_blocks) {
831 m_clients.markBlockposAsNotSent(modified_block);
835 prof.add("unknown", 1);
836 warningstream << "Server: Unknown MapEditEvent "
837 << ((u32)event->type) << std::endl;
842 Set blocks not sent to far players
844 if (!far_players.empty()) {
845 // Convert list format to that wanted by SetBlocksNotSent
846 std::map<v3s16, MapBlock*> modified_blocks2;
847 for (const v3s16 &modified_block : event->modified_blocks) {
848 modified_blocks2[modified_block] =
849 m_env->getMap().getBlockNoCreateNoEx(modified_block);
852 // Set blocks not sent
853 for (const u16 far_player : far_players) {
854 if (RemoteClient *client = getClient(far_player))
855 client->SetBlocksNotSent(modified_blocks2);
862 if (event_count >= 5) {
863 infostream << "Server: MapEditEvents:" << std::endl;
864 prof.print(infostream);
865 } else if (event_count != 0) {
866 verbosestream << "Server: MapEditEvents:" << std::endl;
867 prof.print(verbosestream);
870 // Send all metadata updates
871 if (node_meta_updates.size())
872 sendMetadataChanged(node_meta_updates);
876 Trigger emergethread (it somehow gets to a non-triggered but
877 bysy state sometimes)
880 float &counter = m_emergethread_trigger_timer;
882 if (counter >= 2.0) {
885 m_emerge->startThreads();
889 // Save map, players and auth stuff
891 float &counter = m_savemap_timer;
893 static thread_local const float save_interval =
894 g_settings->getFloat("server_map_save_interval");
895 if (counter >= save_interval) {
897 MutexAutoLock lock(m_env_mutex);
899 ScopeProfiler sp(g_profiler, "Server: map saving (sum)");
902 if (m_banmanager->isModified()) {
903 m_banmanager->save();
906 // Save changed parts of map
907 m_env->getMap().save(MOD_STATE_WRITE_NEEDED);
910 m_env->saveLoadedPlayers();
912 // Save environment metadata
917 m_shutdown_state.tick(dtime, this);
920 void Server::Receive()
930 In the first iteration *wait* for a packet, afterwards process
931 all packets that are immediately available (no waiting).
934 m_con->Receive(&pkt);
937 if (!m_con->TryReceive(&pkt))
941 peer_id = pkt.getPeerId();
943 } catch (const con::InvalidIncomingDataException &e) {
944 infostream << "Server::Receive(): InvalidIncomingDataException: what()="
945 << e.what() << std::endl;
946 } catch (const SerializationError &e) {
947 infostream << "Server::Receive(): SerializationError: what()="
948 << e.what() << std::endl;
949 } catch (const ClientStateError &e) {
950 errorstream << "ProcessData: peer=" << peer_id << " what()="
951 << e.what() << std::endl;
952 DenyAccess_Legacy(peer_id, L"Your client sent something server didn't expect."
953 L"Try reconnecting or updating your client");
954 } catch (const con::PeerNotFoundException &e) {
956 } catch (const con::NoIncomingDataException &e) {
962 PlayerSAO* Server::StageTwoClientInit(session_t peer_id)
964 std::string playername;
965 PlayerSAO *playersao = NULL;
968 RemoteClient* client = m_clients.lockedGetClientNoEx(peer_id, CS_InitDone);
970 playername = client->getName();
971 playersao = emergePlayer(playername.c_str(), peer_id, client->net_proto_version);
973 } catch (std::exception &e) {
979 RemotePlayer *player = m_env->getPlayer(playername.c_str());
982 if (!playersao || !player) {
983 if (player && player->getPeerId() != PEER_ID_INEXISTENT) {
984 actionstream << "Server: Failed to emerge player \"" << playername
985 << "\" (player allocated to an another client)" << std::endl;
986 DenyAccess_Legacy(peer_id, L"Another client is connected with this "
987 L"name. If your client closed unexpectedly, try again in "
990 errorstream << "Server: " << playername << ": Failed to emerge player"
992 DenyAccess_Legacy(peer_id, L"Could not allocate player.");
998 Send complete position information
1000 SendMovePlayer(peer_id);
1003 SendPlayerPrivileges(peer_id);
1005 // Send inventory formspec
1006 SendPlayerInventoryFormspec(peer_id);
1009 SendInventory(playersao, false);
1011 // Send HP or death screen
1012 if (playersao->isDead())
1013 SendDeathscreen(peer_id, false, v3f(0,0,0));
1015 SendPlayerHPOrDie(playersao,
1016 PlayerHPChangeReason(PlayerHPChangeReason::SET_HP));
1019 SendPlayerBreath(playersao);
1021 Address addr = getPeerAddress(player->getPeerId());
1022 std::string ip_str = addr.serializeString();
1023 actionstream<<player->getName() <<" [" << ip_str << "] joins game. " << std::endl;
1028 const std::vector<std::string> &names = m_clients.getPlayerNames();
1030 actionstream << player->getName() << " joins game. List of players: ";
1032 for (const std::string &name : names) {
1033 actionstream << name << " ";
1036 actionstream << player->getName() <<std::endl;
1041 inline void Server::handleCommand(NetworkPacket *pkt)
1043 const ToServerCommandHandler &opHandle = toServerCommandTable[pkt->getCommand()];
1044 (this->*opHandle.handler)(pkt);
1047 void Server::ProcessData(NetworkPacket *pkt)
1049 // Environment is locked first.
1050 MutexAutoLock envlock(m_env_mutex);
1052 ScopeProfiler sp(g_profiler, "Server: Process network packet (sum)");
1053 u32 peer_id = pkt->getPeerId();
1056 Address address = getPeerAddress(peer_id);
1057 std::string addr_s = address.serializeString();
1059 if(m_banmanager->isIpBanned(addr_s)) {
1060 std::string ban_name = m_banmanager->getBanName(addr_s);
1061 infostream << "Server: A banned client tried to connect from "
1062 << addr_s << "; banned name was "
1063 << ban_name << std::endl;
1064 // This actually doesn't seem to transfer to the client
1065 DenyAccess_Legacy(peer_id, L"Your ip is banned. Banned name was "
1066 + utf8_to_wide(ban_name));
1070 catch(con::PeerNotFoundException &e) {
1072 * no peer for this packet found
1073 * most common reason is peer timeout, e.g. peer didn't
1074 * respond for some time, your server was overloaded or
1077 infostream << "Server::ProcessData(): Canceling: peer "
1078 << peer_id << " not found" << std::endl;
1083 ToServerCommand command = (ToServerCommand) pkt->getCommand();
1085 // Command must be handled into ToServerCommandHandler
1086 if (command >= TOSERVER_NUM_MSG_TYPES) {
1087 infostream << "Server: Ignoring unknown command "
1088 << command << std::endl;
1092 if (toServerCommandTable[command].state == TOSERVER_STATE_NOT_CONNECTED) {
1097 u8 peer_ser_ver = getClient(peer_id, CS_InitDone)->serialization_version;
1099 if(peer_ser_ver == SER_FMT_VER_INVALID) {
1100 errorstream << "Server::ProcessData(): Cancelling: Peer"
1101 " serialization format invalid or not initialized."
1102 " Skipping incoming command=" << command << std::endl;
1106 /* Handle commands related to client startup */
1107 if (toServerCommandTable[command].state == TOSERVER_STATE_STARTUP) {
1112 if (m_clients.getClientState(peer_id) < CS_Active) {
1113 if (command == TOSERVER_PLAYERPOS) return;
1115 errorstream << "Got packet command: " << command << " for peer id "
1116 << peer_id << " but client isn't active yet. Dropping packet "
1122 } catch (SendFailedException &e) {
1123 errorstream << "Server::ProcessData(): SendFailedException: "
1124 << "what=" << e.what()
1126 } catch (PacketError &e) {
1127 actionstream << "Server::ProcessData(): PacketError: "
1128 << "what=" << e.what()
1133 void Server::setTimeOfDay(u32 time)
1135 m_env->setTimeOfDay(time);
1136 m_time_of_day_send_timer = 0;
1139 void Server::onMapEditEvent(const MapEditEvent &event)
1141 if (m_ignore_map_edit_events_area.contains(event.getArea()))
1144 m_unsent_map_edit_queue.push(new MapEditEvent(event));
1147 Inventory* Server::getInventory(const InventoryLocation &loc)
1150 case InventoryLocation::UNDEFINED:
1151 case InventoryLocation::CURRENT_PLAYER:
1153 case InventoryLocation::PLAYER:
1155 RemotePlayer *player = m_env->getPlayer(loc.name.c_str());
1158 PlayerSAO *playersao = player->getPlayerSAO();
1161 return playersao->getInventory();
1164 case InventoryLocation::NODEMETA:
1166 NodeMetadata *meta = m_env->getMap().getNodeMetadata(loc.p);
1169 return meta->getInventory();
1172 case InventoryLocation::DETACHED:
1174 if(m_detached_inventories.count(loc.name) == 0)
1176 return m_detached_inventories[loc.name];
1180 sanity_check(false); // abort
1186 void Server::setInventoryModified(const InventoryLocation &loc)
1189 case InventoryLocation::UNDEFINED:
1191 case InventoryLocation::PLAYER:
1194 RemotePlayer *player = m_env->getPlayer(loc.name.c_str());
1199 player->setModified(true);
1200 player->inventory.setModified(true);
1201 // Updates are sent in ServerEnvironment::step()
1204 case InventoryLocation::NODEMETA:
1207 event.type = MEET_BLOCK_NODE_METADATA_CHANGED;
1209 m_env->getMap().dispatchEvent(event);
1212 case InventoryLocation::DETACHED:
1214 // Updates are sent in ServerEnvironment::step()
1218 sanity_check(false); // abort
1223 void Server::SetBlocksNotSent(std::map<v3s16, MapBlock *>& block)
1225 std::vector<session_t> clients = m_clients.getClientIDs();
1227 // Set the modified blocks unsent for all the clients
1228 for (const session_t client_id : clients) {
1229 if (RemoteClient *client = m_clients.lockedGetClientNoEx(client_id))
1230 client->SetBlocksNotSent(block);
1235 void Server::peerAdded(con::Peer *peer)
1237 verbosestream<<"Server::peerAdded(): peer->id="
1238 <<peer->id<<std::endl;
1240 m_peer_change_queue.push(con::PeerChange(con::PEER_ADDED, peer->id, false));
1243 void Server::deletingPeer(con::Peer *peer, bool timeout)
1245 verbosestream<<"Server::deletingPeer(): peer->id="
1246 <<peer->id<<", timeout="<<timeout<<std::endl;
1248 m_clients.event(peer->id, CSE_Disconnect);
1249 m_peer_change_queue.push(con::PeerChange(con::PEER_REMOVED, peer->id, timeout));
1252 bool Server::getClientConInfo(session_t peer_id, con::rtt_stat_type type, float* retval)
1254 *retval = m_con->getPeerStat(peer_id,type);
1255 return *retval != -1;
1258 bool Server::getClientInfo(
1267 std::string* vers_string
1270 *state = m_clients.getClientState(peer_id);
1272 RemoteClient* client = m_clients.lockedGetClientNoEx(peer_id, CS_Invalid);
1279 *uptime = client->uptime();
1280 *ser_vers = client->serialization_version;
1281 *prot_vers = client->net_proto_version;
1283 *major = client->getMajor();
1284 *minor = client->getMinor();
1285 *patch = client->getPatch();
1286 *vers_string = client->getFull();
1293 void Server::handlePeerChanges()
1295 while(!m_peer_change_queue.empty())
1297 con::PeerChange c = m_peer_change_queue.front();
1298 m_peer_change_queue.pop();
1300 verbosestream<<"Server: Handling peer change: "
1301 <<"id="<<c.peer_id<<", timeout="<<c.timeout
1306 case con::PEER_ADDED:
1307 m_clients.CreateClient(c.peer_id);
1310 case con::PEER_REMOVED:
1311 DeleteClient(c.peer_id, c.timeout?CDR_TIMEOUT:CDR_LEAVE);
1315 FATAL_ERROR("Invalid peer change event received!");
1321 void Server::printToConsoleOnly(const std::string &text)
1324 m_admin_chat->outgoing_queue.push_back(
1325 new ChatEventChat("", utf8_to_wide(text)));
1327 std::cout << text << std::endl;
1331 void Server::Send(NetworkPacket *pkt)
1333 Send(pkt->getPeerId(), pkt);
1336 void Server::Send(session_t peer_id, NetworkPacket *pkt)
1338 m_clients.send(peer_id,
1339 clientCommandFactoryTable[pkt->getCommand()].channel,
1341 clientCommandFactoryTable[pkt->getCommand()].reliable);
1344 void Server::SendMovement(session_t peer_id)
1346 std::ostringstream os(std::ios_base::binary);
1348 NetworkPacket pkt(TOCLIENT_MOVEMENT, 12 * sizeof(float), peer_id);
1350 pkt << g_settings->getFloat("movement_acceleration_default");
1351 pkt << g_settings->getFloat("movement_acceleration_air");
1352 pkt << g_settings->getFloat("movement_acceleration_fast");
1353 pkt << g_settings->getFloat("movement_speed_walk");
1354 pkt << g_settings->getFloat("movement_speed_crouch");
1355 pkt << g_settings->getFloat("movement_speed_fast");
1356 pkt << g_settings->getFloat("movement_speed_climb");
1357 pkt << g_settings->getFloat("movement_speed_jump");
1358 pkt << g_settings->getFloat("movement_liquid_fluidity");
1359 pkt << g_settings->getFloat("movement_liquid_fluidity_smooth");
1360 pkt << g_settings->getFloat("movement_liquid_sink");
1361 pkt << g_settings->getFloat("movement_gravity");
1366 void Server::SendPlayerHPOrDie(PlayerSAO *playersao, const PlayerHPChangeReason &reason)
1368 if (playersao->isImmortal())
1371 session_t peer_id = playersao->getPeerID();
1372 bool is_alive = playersao->getHP() > 0;
1375 SendPlayerHP(peer_id);
1377 DiePlayer(peer_id, reason);
1380 void Server::SendHP(session_t peer_id, u16 hp)
1382 NetworkPacket pkt(TOCLIENT_HP, 1, peer_id);
1387 void Server::SendBreath(session_t peer_id, u16 breath)
1389 NetworkPacket pkt(TOCLIENT_BREATH, 2, peer_id);
1390 pkt << (u16) breath;
1394 void Server::SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
1395 const std::string &custom_reason, bool reconnect)
1397 assert(reason < SERVER_ACCESSDENIED_MAX);
1399 NetworkPacket pkt(TOCLIENT_ACCESS_DENIED, 1, peer_id);
1401 if (reason == SERVER_ACCESSDENIED_CUSTOM_STRING)
1402 pkt << custom_reason;
1403 else if (reason == SERVER_ACCESSDENIED_SHUTDOWN ||
1404 reason == SERVER_ACCESSDENIED_CRASH)
1405 pkt << custom_reason << (u8)reconnect;
1409 void Server::SendAccessDenied_Legacy(session_t peer_id,const std::wstring &reason)
1411 NetworkPacket pkt(TOCLIENT_ACCESS_DENIED_LEGACY, 0, peer_id);
1416 void Server::SendDeathscreen(session_t peer_id, bool set_camera_point_target,
1417 v3f camera_point_target)
1419 NetworkPacket pkt(TOCLIENT_DEATHSCREEN, 1 + sizeof(v3f), peer_id);
1420 pkt << set_camera_point_target << camera_point_target;
1424 void Server::SendItemDef(session_t peer_id,
1425 IItemDefManager *itemdef, u16 protocol_version)
1427 NetworkPacket pkt(TOCLIENT_ITEMDEF, 0, peer_id);
1431 u32 length of the next item
1432 zlib-compressed serialized ItemDefManager
1434 std::ostringstream tmp_os(std::ios::binary);
1435 itemdef->serialize(tmp_os, protocol_version);
1436 std::ostringstream tmp_os2(std::ios::binary);
1437 compressZlib(tmp_os.str(), tmp_os2);
1438 pkt.putLongString(tmp_os2.str());
1441 verbosestream << "Server: Sending item definitions to id(" << peer_id
1442 << "): size=" << pkt.getSize() << std::endl;
1447 void Server::SendNodeDef(session_t peer_id,
1448 const NodeDefManager *nodedef, u16 protocol_version)
1450 NetworkPacket pkt(TOCLIENT_NODEDEF, 0, peer_id);
1454 u32 length of the next item
1455 zlib-compressed serialized NodeDefManager
1457 std::ostringstream tmp_os(std::ios::binary);
1458 nodedef->serialize(tmp_os, protocol_version);
1459 std::ostringstream tmp_os2(std::ios::binary);
1460 compressZlib(tmp_os.str(), tmp_os2);
1462 pkt.putLongString(tmp_os2.str());
1465 verbosestream << "Server: Sending node definitions to id(" << peer_id
1466 << "): size=" << pkt.getSize() << std::endl;
1472 Non-static send methods
1475 void Server::SendInventory(PlayerSAO *sao, bool incremental)
1477 RemotePlayer *player = sao->getPlayer();
1479 // Do not send new format to old clients
1480 incremental &= player->protocol_version >= 38;
1482 UpdateCrafting(player);
1488 NetworkPacket pkt(TOCLIENT_INVENTORY, 0, sao->getPeerID());
1490 std::ostringstream os(std::ios::binary);
1491 sao->getInventory()->serialize(os, incremental);
1492 sao->getInventory()->setModified(false);
1493 player->setModified(true);
1495 const std::string &s = os.str();
1496 pkt.putRawString(s.c_str(), s.size());
1500 void Server::SendChatMessage(session_t peer_id, const ChatMessage &message)
1502 NetworkPacket pkt(TOCLIENT_CHAT_MESSAGE, 0, peer_id);
1504 u8 type = message.type;
1505 pkt << version << type << std::wstring(L"") << message.message << (u64)message.timestamp;
1507 if (peer_id != PEER_ID_INEXISTENT) {
1508 RemotePlayer *player = m_env->getPlayer(peer_id);
1514 m_clients.sendToAll(&pkt);
1518 void Server::SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
1519 const std::string &formname)
1521 NetworkPacket pkt(TOCLIENT_SHOW_FORMSPEC, 0, peer_id);
1522 if (formspec.empty()){
1523 //the client should close the formspec
1524 //but make sure there wasn't another one open in meantime
1525 const auto it = m_formspec_state_data.find(peer_id);
1526 if (it != m_formspec_state_data.end() && it->second == formname) {
1527 m_formspec_state_data.erase(peer_id);
1529 pkt.putLongString("");
1531 m_formspec_state_data[peer_id] = formname;
1532 pkt.putLongString(formspec);
1539 // Spawns a particle on peer with peer_id
1540 void Server::SendSpawnParticle(session_t peer_id, u16 protocol_version,
1541 v3f pos, v3f velocity, v3f acceleration,
1542 float expirationtime, float size, bool collisiondetection,
1543 bool collision_removal, bool object_collision,
1544 bool vertical, const std::string &texture,
1545 const struct TileAnimationParams &animation, u8 glow)
1547 static thread_local const float radius =
1548 g_settings->getS16("max_block_send_distance") * MAP_BLOCKSIZE * BS;
1550 if (peer_id == PEER_ID_INEXISTENT) {
1551 std::vector<session_t> clients = m_clients.getClientIDs();
1553 for (const session_t client_id : clients) {
1554 RemotePlayer *player = m_env->getPlayer(client_id);
1558 PlayerSAO *sao = player->getPlayerSAO();
1562 // Do not send to distant clients
1563 if (sao->getBasePosition().getDistanceFrom(pos * BS) > radius)
1566 SendSpawnParticle(client_id, player->protocol_version,
1567 pos, velocity, acceleration,
1568 expirationtime, size, collisiondetection, collision_removal,
1569 object_collision, vertical, texture, animation, glow);
1574 NetworkPacket pkt(TOCLIENT_SPAWN_PARTICLE, 0, peer_id);
1576 pkt << pos << velocity << acceleration << expirationtime
1577 << size << collisiondetection;
1578 pkt.putLongString(texture);
1580 pkt << collision_removal;
1581 // This is horrible but required (why are there two ways to serialize pkts?)
1582 std::ostringstream os(std::ios_base::binary);
1583 animation.serialize(os, protocol_version);
1584 pkt.putRawString(os.str());
1586 pkt << object_collision;
1591 // Adds a ParticleSpawner on peer with peer_id
1592 void Server::SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
1593 u16 amount, float spawntime, v3f minpos, v3f maxpos,
1594 v3f minvel, v3f maxvel, v3f minacc, v3f maxacc, float minexptime, float maxexptime,
1595 float minsize, float maxsize, bool collisiondetection, bool collision_removal,
1596 bool object_collision, u16 attached_id, bool vertical, const std::string &texture, u32 id,
1597 const struct TileAnimationParams &animation, u8 glow)
1599 if (peer_id == PEER_ID_INEXISTENT) {
1600 // This sucks and should be replaced:
1601 std::vector<session_t> clients = m_clients.getClientIDs();
1602 for (const session_t client_id : clients) {
1603 RemotePlayer *player = m_env->getPlayer(client_id);
1606 SendAddParticleSpawner(client_id, player->protocol_version,
1607 amount, spawntime, minpos, maxpos,
1608 minvel, maxvel, minacc, maxacc, minexptime, maxexptime,
1609 minsize, maxsize, collisiondetection, collision_removal,
1610 object_collision, attached_id, vertical, texture, id,
1616 NetworkPacket pkt(TOCLIENT_ADD_PARTICLESPAWNER, 0, peer_id);
1618 pkt << amount << spawntime << minpos << maxpos << minvel << maxvel
1619 << minacc << maxacc << minexptime << maxexptime << minsize
1620 << maxsize << collisiondetection;
1622 pkt.putLongString(texture);
1624 pkt << id << vertical;
1625 pkt << collision_removal;
1627 // This is horrible but required
1628 std::ostringstream os(std::ios_base::binary);
1629 animation.serialize(os, protocol_version);
1630 pkt.putRawString(os.str());
1632 pkt << object_collision;
1637 void Server::SendDeleteParticleSpawner(session_t peer_id, u32 id)
1639 NetworkPacket pkt(TOCLIENT_DELETE_PARTICLESPAWNER, 4, peer_id);
1641 // Ugly error in this packet
1644 if (peer_id != PEER_ID_INEXISTENT)
1647 m_clients.sendToAll(&pkt);
1651 void Server::SendHUDAdd(session_t peer_id, u32 id, HudElement *form)
1653 NetworkPacket pkt(TOCLIENT_HUDADD, 0 , peer_id);
1655 pkt << id << (u8) form->type << form->pos << form->name << form->scale
1656 << form->text << form->number << form->item << form->dir
1657 << form->align << form->offset << form->world_pos << form->size
1663 void Server::SendHUDRemove(session_t peer_id, u32 id)
1665 NetworkPacket pkt(TOCLIENT_HUDRM, 4, peer_id);
1670 void Server::SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value)
1672 NetworkPacket pkt(TOCLIENT_HUDCHANGE, 0, peer_id);
1673 pkt << id << (u8) stat;
1677 case HUD_STAT_SCALE:
1678 case HUD_STAT_ALIGN:
1679 case HUD_STAT_OFFSET:
1680 pkt << *(v2f *) value;
1684 pkt << *(std::string *) value;
1686 case HUD_STAT_WORLD_POS:
1687 pkt << *(v3f *) value;
1690 pkt << *(v2s32 *) value;
1692 case HUD_STAT_NUMBER:
1696 pkt << *(u32 *) value;
1703 void Server::SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask)
1705 NetworkPacket pkt(TOCLIENT_HUD_SET_FLAGS, 4 + 4, peer_id);
1707 flags &= ~(HUD_FLAG_HEALTHBAR_VISIBLE | HUD_FLAG_BREATHBAR_VISIBLE);
1709 pkt << flags << mask;
1714 void Server::SendHUDSetParam(session_t peer_id, u16 param, const std::string &value)
1716 NetworkPacket pkt(TOCLIENT_HUD_SET_PARAM, 0, peer_id);
1717 pkt << param << value;
1721 void Server::SendSetSky(session_t peer_id, const video::SColor &bgcolor,
1722 const std::string &type, const std::vector<std::string> ¶ms,
1725 NetworkPacket pkt(TOCLIENT_SET_SKY, 0, peer_id);
1726 pkt << bgcolor << type << (u16) params.size();
1728 for (const std::string ¶m : params)
1736 void Server::SendCloudParams(session_t peer_id, const CloudParams ¶ms)
1738 NetworkPacket pkt(TOCLIENT_CLOUD_PARAMS, 0, peer_id);
1739 pkt << params.density << params.color_bright << params.color_ambient
1740 << params.height << params.thickness << params.speed;
1744 void Server::SendOverrideDayNightRatio(session_t peer_id, bool do_override,
1747 NetworkPacket pkt(TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO,
1750 pkt << do_override << (u16) (ratio * 65535);
1755 void Server::SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed)
1757 NetworkPacket pkt(TOCLIENT_TIME_OF_DAY, 0, peer_id);
1758 pkt << time << time_speed;
1760 if (peer_id == PEER_ID_INEXISTENT) {
1761 m_clients.sendToAll(&pkt);
1768 void Server::SendPlayerHP(session_t peer_id)
1770 PlayerSAO *playersao = getPlayerSAO(peer_id);
1771 // In some rare case if the player is disconnected
1772 // while Lua call l_punch, for example, this can be NULL
1776 SendHP(peer_id, playersao->getHP());
1777 m_script->player_event(playersao,"health_changed");
1779 // Send to other clients
1780 std::string str = gob_cmd_punched(playersao->getHP());
1781 ActiveObjectMessage aom(playersao->getId(), true, str);
1782 playersao->m_messages_out.push(aom);
1785 void Server::SendPlayerBreath(PlayerSAO *sao)
1789 m_script->player_event(sao, "breath_changed");
1790 SendBreath(sao->getPeerID(), sao->getBreath());
1793 void Server::SendMovePlayer(session_t peer_id)
1795 RemotePlayer *player = m_env->getPlayer(peer_id);
1797 PlayerSAO *sao = player->getPlayerSAO();
1800 NetworkPacket pkt(TOCLIENT_MOVE_PLAYER, sizeof(v3f) + sizeof(f32) * 2, peer_id);
1801 pkt << sao->getBasePosition() << sao->getLookPitch() << sao->getRotation().Y;
1804 v3f pos = sao->getBasePosition();
1805 verbosestream << "Server: Sending TOCLIENT_MOVE_PLAYER"
1806 << " pos=(" << pos.X << "," << pos.Y << "," << pos.Z << ")"
1807 << " pitch=" << sao->getLookPitch()
1808 << " yaw=" << sao->getRotation().Y
1815 void Server::SendPlayerFov(session_t peer_id)
1817 NetworkPacket pkt(TOCLIENT_FOV, 4 + 1, peer_id);
1819 PlayerFovSpec fov_spec = m_env->getPlayer(peer_id)->getFov();
1820 pkt << fov_spec.fov << fov_spec.is_multiplier;
1825 void Server::SendLocalPlayerAnimations(session_t peer_id, v2s32 animation_frames[4],
1826 f32 animation_speed)
1828 NetworkPacket pkt(TOCLIENT_LOCAL_PLAYER_ANIMATIONS, 0,
1831 pkt << animation_frames[0] << animation_frames[1] << animation_frames[2]
1832 << animation_frames[3] << animation_speed;
1837 void Server::SendEyeOffset(session_t peer_id, v3f first, v3f third)
1839 NetworkPacket pkt(TOCLIENT_EYE_OFFSET, 0, peer_id);
1840 pkt << first << third;
1844 void Server::SendPlayerPrivileges(session_t peer_id)
1846 RemotePlayer *player = m_env->getPlayer(peer_id);
1848 if(player->getPeerId() == PEER_ID_INEXISTENT)
1851 std::set<std::string> privs;
1852 m_script->getAuth(player->getName(), NULL, &privs);
1854 NetworkPacket pkt(TOCLIENT_PRIVILEGES, 0, peer_id);
1855 pkt << (u16) privs.size();
1857 for (const std::string &priv : privs) {
1864 void Server::SendPlayerInventoryFormspec(session_t peer_id)
1866 RemotePlayer *player = m_env->getPlayer(peer_id);
1868 if (player->getPeerId() == PEER_ID_INEXISTENT)
1871 NetworkPacket pkt(TOCLIENT_INVENTORY_FORMSPEC, 0, peer_id);
1872 pkt.putLongString(player->inventory_formspec);
1877 void Server::SendPlayerFormspecPrepend(session_t peer_id)
1879 RemotePlayer *player = m_env->getPlayer(peer_id);
1881 if (player->getPeerId() == PEER_ID_INEXISTENT)
1884 NetworkPacket pkt(TOCLIENT_FORMSPEC_PREPEND, 0, peer_id);
1885 pkt << player->formspec_prepend;
1889 void Server::SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao)
1891 // Radius inside which objects are active
1892 static thread_local const s16 radius =
1893 g_settings->getS16("active_object_send_range_blocks") * MAP_BLOCKSIZE;
1895 // Radius inside which players are active
1896 static thread_local const bool is_transfer_limited =
1897 g_settings->exists("unlimited_player_transfer_distance") &&
1898 !g_settings->getBool("unlimited_player_transfer_distance");
1900 static thread_local const s16 player_transfer_dist =
1901 g_settings->getS16("player_transfer_distance") * MAP_BLOCKSIZE;
1903 s16 player_radius = player_transfer_dist == 0 && is_transfer_limited ?
1904 radius : player_transfer_dist;
1906 s16 my_radius = MYMIN(radius, playersao->getWantedRange() * MAP_BLOCKSIZE);
1910 std::queue<u16> removed_objects, added_objects;
1911 m_env->getRemovedActiveObjects(playersao, my_radius, player_radius,
1912 client->m_known_objects, removed_objects);
1913 m_env->getAddedActiveObjects(playersao, my_radius, player_radius,
1914 client->m_known_objects, added_objects);
1916 int removed_count = removed_objects.size();
1917 int added_count = added_objects.size();
1919 if (removed_objects.empty() && added_objects.empty())
1925 // Handle removed objects
1926 writeU16((u8*)buf, removed_objects.size());
1927 data.append(buf, 2);
1928 while (!removed_objects.empty()) {
1930 u16 id = removed_objects.front();
1931 ServerActiveObject* obj = m_env->getActiveObject(id);
1933 // Add to data buffer for sending
1934 writeU16((u8*)buf, id);
1935 data.append(buf, 2);
1937 // Remove from known objects
1938 client->m_known_objects.erase(id);
1940 if (obj && obj->m_known_by_count > 0)
1941 obj->m_known_by_count--;
1943 removed_objects.pop();
1946 // Handle added objects
1947 writeU16((u8*)buf, added_objects.size());
1948 data.append(buf, 2);
1949 while (!added_objects.empty()) {
1951 u16 id = added_objects.front();
1952 ServerActiveObject *obj = m_env->getActiveObject(id);
1953 added_objects.pop();
1956 warningstream << FUNCTION_NAME << ": NULL object id="
1957 << (int)id << std::endl;
1962 u8 type = obj->getSendType();
1964 // Add to data buffer for sending
1965 writeU16((u8*)buf, id);
1966 data.append(buf, 2);
1967 writeU8((u8*)buf, type);
1968 data.append(buf, 1);
1970 data.append(serializeLongString(
1971 obj->getClientInitializationData(client->net_proto_version)));
1973 // Add to known objects
1974 client->m_known_objects.insert(id);
1976 obj->m_known_by_count++;
1979 NetworkPacket pkt(TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD, data.size(), client->peer_id);
1980 pkt.putRawString(data.c_str(), data.size());
1983 verbosestream << "Server::SendActiveObjectRemoveAdd: "
1984 << removed_count << " removed, " << added_count << " added, "
1985 << "packet size is " << pkt.getSize() << std::endl;
1988 void Server::SendActiveObjectMessages(session_t peer_id, const std::string &datas,
1991 NetworkPacket pkt(TOCLIENT_ACTIVE_OBJECT_MESSAGES,
1992 datas.size(), peer_id);
1994 pkt.putRawString(datas.c_str(), datas.size());
1996 m_clients.send(pkt.getPeerId(),
1997 reliable ? clientCommandFactoryTable[pkt.getCommand()].channel : 1,
2001 void Server::SendCSMRestrictionFlags(session_t peer_id)
2003 NetworkPacket pkt(TOCLIENT_CSM_RESTRICTION_FLAGS,
2004 sizeof(m_csm_restriction_flags) + sizeof(m_csm_restriction_noderange), peer_id);
2005 pkt << m_csm_restriction_flags << m_csm_restriction_noderange;
2009 void Server::SendPlayerSpeed(session_t peer_id, const v3f &added_vel)
2011 NetworkPacket pkt(TOCLIENT_PLAYER_SPEED, 0, peer_id);
2016 s32 Server::playSound(const SimpleSoundSpec &spec,
2017 const ServerSoundParams ¶ms)
2019 // Find out initial position of sound
2020 bool pos_exists = false;
2021 v3f pos = params.getPos(m_env, &pos_exists);
2022 // If position is not found while it should be, cancel sound
2023 if(pos_exists != (params.type != ServerSoundParams::SSP_LOCAL))
2026 // Filter destination clients
2027 std::vector<session_t> dst_clients;
2028 if(!params.to_player.empty()) {
2029 RemotePlayer *player = m_env->getPlayer(params.to_player.c_str());
2031 infostream<<"Server::playSound: Player \""<<params.to_player
2032 <<"\" not found"<<std::endl;
2035 if (player->getPeerId() == PEER_ID_INEXISTENT) {
2036 infostream<<"Server::playSound: Player \""<<params.to_player
2037 <<"\" not connected"<<std::endl;
2040 dst_clients.push_back(player->getPeerId());
2042 std::vector<session_t> clients = m_clients.getClientIDs();
2044 for (const session_t client_id : clients) {
2045 RemotePlayer *player = m_env->getPlayer(client_id);
2049 PlayerSAO *sao = player->getPlayerSAO();
2054 if(sao->getBasePosition().getDistanceFrom(pos) >
2055 params.max_hear_distance)
2058 dst_clients.push_back(client_id);
2062 if(dst_clients.empty())
2066 s32 id = m_next_sound_id++;
2067 // The sound will exist as a reference in m_playing_sounds
2068 m_playing_sounds[id] = ServerPlayingSound();
2069 ServerPlayingSound &psound = m_playing_sounds[id];
2070 psound.params = params;
2073 float gain = params.gain * spec.gain;
2074 NetworkPacket pkt(TOCLIENT_PLAY_SOUND, 0);
2075 pkt << id << spec.name << gain
2076 << (u8) params.type << pos << params.object
2077 << params.loop << params.fade << params.pitch;
2079 // Backwards compability
2080 bool play_sound = gain > 0;
2082 for (const u16 dst_client : dst_clients) {
2083 if (play_sound || m_clients.getProtocolVersion(dst_client) >= 32) {
2084 psound.clients.insert(dst_client);
2085 m_clients.send(dst_client, 0, &pkt, true);
2090 void Server::stopSound(s32 handle)
2092 // Get sound reference
2093 std::unordered_map<s32, ServerPlayingSound>::iterator i =
2094 m_playing_sounds.find(handle);
2095 if (i == m_playing_sounds.end())
2097 ServerPlayingSound &psound = i->second;
2099 NetworkPacket pkt(TOCLIENT_STOP_SOUND, 4);
2102 for (std::unordered_set<session_t>::const_iterator si = psound.clients.begin();
2103 si != psound.clients.end(); ++si) {
2105 m_clients.send(*si, 0, &pkt, true);
2107 // Remove sound reference
2108 m_playing_sounds.erase(i);
2111 void Server::fadeSound(s32 handle, float step, float gain)
2113 // Get sound reference
2114 std::unordered_map<s32, ServerPlayingSound>::iterator i =
2115 m_playing_sounds.find(handle);
2116 if (i == m_playing_sounds.end())
2119 ServerPlayingSound &psound = i->second;
2120 psound.params.gain = gain;
2122 NetworkPacket pkt(TOCLIENT_FADE_SOUND, 4);
2123 pkt << handle << step << gain;
2125 // Backwards compability
2126 bool play_sound = gain > 0;
2127 ServerPlayingSound compat_psound = psound;
2128 compat_psound.clients.clear();
2130 NetworkPacket compat_pkt(TOCLIENT_STOP_SOUND, 4);
2131 compat_pkt << handle;
2133 for (std::unordered_set<u16>::iterator it = psound.clients.begin();
2134 it != psound.clients.end();) {
2135 if (m_clients.getProtocolVersion(*it) >= 32) {
2137 m_clients.send(*it, 0, &pkt, true);
2140 compat_psound.clients.insert(*it);
2142 m_clients.send(*it, 0, &compat_pkt, true);
2143 psound.clients.erase(it++);
2147 // Remove sound reference
2148 if (!play_sound || psound.clients.empty())
2149 m_playing_sounds.erase(i);
2151 if (play_sound && !compat_psound.clients.empty()) {
2152 // Play new sound volume on older clients
2153 playSound(compat_psound.spec, compat_psound.params);
2157 void Server::sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players,
2160 float maxd = far_d_nodes * BS;
2161 v3f p_f = intToFloat(p, BS);
2162 v3s16 block_pos = getNodeBlockPos(p);
2164 NetworkPacket pkt(TOCLIENT_REMOVENODE, 6);
2167 std::vector<session_t> clients = m_clients.getClientIDs();
2170 for (session_t client_id : clients) {
2171 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id);
2175 RemotePlayer *player = m_env->getPlayer(client_id);
2176 PlayerSAO *sao = player ? player->getPlayerSAO() : nullptr;
2178 // If player is far away, only set modified blocks not sent
2179 if (!client->isBlockSent(block_pos) || (sao &&
2180 sao->getBasePosition().getDistanceFrom(p_f) > maxd)) {
2182 far_players->emplace(client_id);
2184 client->SetBlockNotSent(block_pos);
2189 m_clients.send(client_id, 0, &pkt, true);
2195 void Server::sendAddNode(v3s16 p, MapNode n, std::unordered_set<u16> *far_players,
2196 float far_d_nodes, bool remove_metadata)
2198 float maxd = far_d_nodes * BS;
2199 v3f p_f = intToFloat(p, BS);
2200 v3s16 block_pos = getNodeBlockPos(p);
2202 NetworkPacket pkt(TOCLIENT_ADDNODE, 6 + 2 + 1 + 1 + 1);
2203 pkt << p << n.param0 << n.param1 << n.param2
2204 << (u8) (remove_metadata ? 0 : 1);
2206 std::vector<session_t> clients = m_clients.getClientIDs();
2209 for (session_t client_id : clients) {
2210 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id);
2214 RemotePlayer *player = m_env->getPlayer(client_id);
2215 PlayerSAO *sao = player ? player->getPlayerSAO() : nullptr;
2217 // If player is far away, only set modified blocks not sent
2218 if (!client->isBlockSent(block_pos) || (sao &&
2219 sao->getBasePosition().getDistanceFrom(p_f) > maxd)) {
2221 far_players->emplace(client_id);
2223 client->SetBlockNotSent(block_pos);
2228 m_clients.send(client_id, 0, &pkt, true);
2234 void Server::sendMetadataChanged(const std::list<v3s16> &meta_updates, float far_d_nodes)
2236 float maxd = far_d_nodes * BS;
2237 NodeMetadataList meta_updates_list(false);
2238 std::vector<session_t> clients = m_clients.getClientIDs();
2242 for (session_t i : clients) {
2243 RemoteClient *client = m_clients.lockedGetClientNoEx(i);
2247 ServerActiveObject *player = m_env->getActiveObject(i);
2248 v3f player_pos = player ? player->getBasePosition() : v3f();
2250 for (const v3s16 &pos : meta_updates) {
2251 NodeMetadata *meta = m_env->getMap().getNodeMetadata(pos);
2256 v3s16 block_pos = getNodeBlockPos(pos);
2257 if (!client->isBlockSent(block_pos) || (player &&
2258 player_pos.getDistanceFrom(intToFloat(pos, BS)) > maxd)) {
2259 client->SetBlockNotSent(block_pos);
2263 // Add the change to send list
2264 meta_updates_list.set(pos, meta);
2266 if (meta_updates_list.size() == 0)
2269 // Send the meta changes
2270 std::ostringstream os(std::ios::binary);
2271 meta_updates_list.serialize(os, client->net_proto_version, false, true);
2272 std::ostringstream oss(std::ios::binary);
2273 compressZlib(os.str(), oss);
2275 NetworkPacket pkt(TOCLIENT_NODEMETA_CHANGED, 0);
2276 pkt.putLongString(oss.str());
2277 m_clients.send(i, 0, &pkt, true);
2279 meta_updates_list.clear();
2285 void Server::SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver,
2286 u16 net_proto_version)
2289 Create a packet with the block in the right format
2292 std::ostringstream os(std::ios_base::binary);
2293 block->serialize(os, ver, false);
2294 block->serializeNetworkSpecific(os);
2295 std::string s = os.str();
2297 NetworkPacket pkt(TOCLIENT_BLOCKDATA, 2 + 2 + 2 + 2 + s.size(), peer_id);
2299 pkt << block->getPos();
2300 pkt.putRawString(s.c_str(), s.size());
2304 void Server::SendBlocks(float dtime)
2306 MutexAutoLock envlock(m_env_mutex);
2307 //TODO check if one big lock could be faster then multiple small ones
2309 std::vector<PrioritySortedBlockTransfer> queue;
2311 u32 total_sending = 0;
2314 ScopeProfiler sp2(g_profiler, "Server::SendBlocks(): Collect list");
2316 std::vector<session_t> clients = m_clients.getClientIDs();
2319 for (const session_t client_id : clients) {
2320 RemoteClient *client = m_clients.lockedGetClientNoEx(client_id, CS_Active);
2325 total_sending += client->getSendingCount();
2326 client->GetNextBlocks(m_env,m_emerge, dtime, queue);
2332 // Lowest priority number comes first.
2333 // Lowest is most important.
2334 std::sort(queue.begin(), queue.end());
2338 // Maximal total count calculation
2339 // The per-client block sends is halved with the maximal online users
2340 u32 max_blocks_to_send = (m_env->getPlayerCount() + g_settings->getU32("max_users")) *
2341 g_settings->getU32("max_simultaneous_block_sends_per_client") / 4 + 1;
2343 ScopeProfiler sp(g_profiler, "Server::SendBlocks(): Send to clients");
2344 Map &map = m_env->getMap();
2346 for (const PrioritySortedBlockTransfer &block_to_send : queue) {
2347 if (total_sending >= max_blocks_to_send)
2350 MapBlock *block = map.getBlockNoCreateNoEx(block_to_send.pos);
2354 RemoteClient *client = m_clients.lockedGetClientNoEx(block_to_send.peer_id,
2359 SendBlockNoLock(block_to_send.peer_id, block, client->serialization_version,
2360 client->net_proto_version);
2362 client->SentBlock(block_to_send.pos);
2368 bool Server::SendBlock(session_t peer_id, const v3s16 &blockpos)
2370 MapBlock *block = m_env->getMap().getBlockNoCreateNoEx(blockpos);
2375 RemoteClient *client = m_clients.lockedGetClientNoEx(peer_id, CS_Active);
2376 if (!client || client->isBlockSent(blockpos)) {
2380 SendBlockNoLock(peer_id, block, client->serialization_version,
2381 client->net_proto_version);
2387 void Server::fillMediaCache()
2389 infostream<<"Server: Calculating media file checksums"<<std::endl;
2391 // Collect all media file paths
2392 std::vector<std::string> paths;
2393 m_modmgr->getModsMediaPaths(paths);
2394 fs::GetRecursiveDirs(paths, m_gamespec.path + DIR_DELIM + "textures");
2395 fs::GetRecursiveDirs(paths, porting::path_user + DIR_DELIM + "textures" + DIR_DELIM + "server");
2397 // Collect media file information from paths into cache
2398 for (const std::string &mediapath : paths) {
2399 std::vector<fs::DirListNode> dirlist = fs::GetDirListing(mediapath);
2400 for (const fs::DirListNode &dln : dirlist) {
2401 if (dln.dir) // Ignode dirs
2403 std::string filename = dln.name;
2404 // If name contains illegal characters, ignore the file
2405 if (!string_allowed(filename, TEXTURENAME_ALLOWED_CHARS)) {
2406 infostream<<"Server: ignoring illegal file name: \""
2407 << filename << "\"" << std::endl;
2410 // If name is not in a supported format, ignore it
2411 const char *supported_ext[] = {
2412 ".png", ".jpg", ".bmp", ".tga",
2413 ".pcx", ".ppm", ".psd", ".wal", ".rgb",
2415 ".x", ".b3d", ".md2", ".obj",
2416 // Custom translation file format
2420 if (removeStringEnd(filename, supported_ext).empty()){
2421 infostream << "Server: ignoring unsupported file extension: \""
2422 << filename << "\"" << std::endl;
2425 // Ok, attempt to load the file and add to cache
2426 std::string filepath;
2427 filepath.append(mediapath).append(DIR_DELIM).append(filename);
2430 std::ifstream fis(filepath.c_str(), std::ios_base::binary);
2432 errorstream << "Server::fillMediaCache(): Could not open \""
2433 << filename << "\" for reading" << std::endl;
2436 std::ostringstream tmp_os(std::ios_base::binary);
2440 fis.read(buf, 1024);
2441 std::streamsize len = fis.gcount();
2442 tmp_os.write(buf, len);
2451 errorstream<<"Server::fillMediaCache(): Failed to read \""
2452 << filename << "\"" << std::endl;
2455 if(tmp_os.str().length() == 0) {
2456 errorstream << "Server::fillMediaCache(): Empty file \""
2457 << filepath << "\"" << std::endl;
2462 sha1.addBytes(tmp_os.str().c_str(), tmp_os.str().length());
2464 unsigned char *digest = sha1.getDigest();
2465 std::string sha1_base64 = base64_encode(digest, 20);
2466 std::string sha1_hex = hex_encode((char*)digest, 20);
2470 m_media[filename] = MediaInfo(filepath, sha1_base64);
2471 verbosestream << "Server: " << sha1_hex << " is " << filename
2477 void Server::sendMediaAnnouncement(session_t peer_id, const std::string &lang_code)
2479 verbosestream << "Server: Announcing files to id(" << peer_id << ")"
2483 NetworkPacket pkt(TOCLIENT_ANNOUNCE_MEDIA, 0, peer_id);
2486 std::string lang_suffix;
2487 lang_suffix.append(".").append(lang_code).append(".tr");
2488 for (const auto &i : m_media) {
2489 if (str_ends_with(i.first, ".tr") && !str_ends_with(i.first, lang_suffix))
2496 for (const auto &i : m_media) {
2497 if (str_ends_with(i.first, ".tr") && !str_ends_with(i.first, lang_suffix))
2499 pkt << i.first << i.second.sha1_digest;
2502 pkt << g_settings->get("remote_media");
2506 struct SendableMedia
2512 SendableMedia(const std::string &name_="", const std::string &path_="",
2513 const std::string &data_=""):
2520 void Server::sendRequestedMedia(session_t peer_id,
2521 const std::vector<std::string> &tosend)
2523 verbosestream<<"Server::sendRequestedMedia(): "
2524 <<"Sending files to client"<<std::endl;
2528 // Put 5kB in one bunch (this is not accurate)
2529 u32 bytes_per_bunch = 5000;
2531 std::vector< std::vector<SendableMedia> > file_bunches;
2532 file_bunches.emplace_back();
2534 u32 file_size_bunch_total = 0;
2536 for (const std::string &name : tosend) {
2537 if (m_media.find(name) == m_media.end()) {
2538 errorstream<<"Server::sendRequestedMedia(): Client asked for "
2539 <<"unknown file \""<<(name)<<"\""<<std::endl;
2543 //TODO get path + name
2544 std::string tpath = m_media[name].path;
2547 std::ifstream fis(tpath.c_str(), std::ios_base::binary);
2549 errorstream<<"Server::sendRequestedMedia(): Could not open \""
2550 <<tpath<<"\" for reading"<<std::endl;
2553 std::ostringstream tmp_os(std::ios_base::binary);
2557 fis.read(buf, 1024);
2558 std::streamsize len = fis.gcount();
2559 tmp_os.write(buf, len);
2560 file_size_bunch_total += len;
2569 errorstream<<"Server::sendRequestedMedia(): Failed to read \""
2570 <<name<<"\""<<std::endl;
2573 /*infostream<<"Server::sendRequestedMedia(): Loaded \""
2574 <<tname<<"\""<<std::endl;*/
2576 file_bunches[file_bunches.size()-1].emplace_back(name, tpath, tmp_os.str());
2578 // Start next bunch if got enough data
2579 if(file_size_bunch_total >= bytes_per_bunch) {
2580 file_bunches.emplace_back();
2581 file_size_bunch_total = 0;
2586 /* Create and send packets */
2588 u16 num_bunches = file_bunches.size();
2589 for (u16 i = 0; i < num_bunches; i++) {
2592 u16 total number of texture bunches
2593 u16 index of this bunch
2594 u32 number of files in this bunch
2603 NetworkPacket pkt(TOCLIENT_MEDIA, 4 + 0, peer_id);
2604 pkt << num_bunches << i << (u32) file_bunches[i].size();
2606 for (const SendableMedia &j : file_bunches[i]) {
2608 pkt.putLongString(j.data);
2611 verbosestream << "Server::sendRequestedMedia(): bunch "
2612 << i << "/" << num_bunches
2613 << " files=" << file_bunches[i].size()
2614 << " size=" << pkt.getSize() << std::endl;
2619 void Server::sendDetachedInventory(const std::string &name, session_t peer_id)
2621 const auto &inv_it = m_detached_inventories.find(name);
2622 const auto &player_it = m_detached_inventories_player.find(name);
2624 if (player_it == m_detached_inventories_player.end() ||
2625 player_it->second.empty()) {
2626 // OK. Send to everyone
2629 return; // Mods are not done loading
2631 RemotePlayer *p = m_env->getPlayer(player_it->second.c_str());
2633 return; // Player is offline
2635 if (peer_id != PEER_ID_INEXISTENT && peer_id != p->getPeerId())
2636 return; // Caller requested send to a different player, so don't send.
2638 peer_id = p->getPeerId();
2641 NetworkPacket pkt(TOCLIENT_DETACHED_INVENTORY, 0, peer_id);
2644 if (inv_it == m_detached_inventories.end()) {
2645 pkt << false; // Remove inventory
2647 pkt << true; // Update inventory
2649 // Serialization & NetworkPacket isn't a love story
2650 std::ostringstream os(std::ios_base::binary);
2651 inv_it->second->serialize(os);
2652 inv_it->second->setModified(false);
2654 const std::string &os_str = os.str();
2655 pkt << static_cast<u16>(os_str.size()); // HACK: to keep compatibility with 5.0.0 clients
2656 pkt.putRawString(os_str);
2659 if (peer_id == PEER_ID_INEXISTENT)
2660 m_clients.sendToAll(&pkt);
2665 void Server::sendDetachedInventories(session_t peer_id, bool incremental)
2667 for (const auto &detached_inventory : m_detached_inventories) {
2668 const std::string &name = detached_inventory.first;
2670 Inventory *inv = detached_inventory.second;
2671 if (!inv || !inv->checkModified())
2675 sendDetachedInventory(name, peer_id);
2683 void Server::DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason)
2685 PlayerSAO *playersao = getPlayerSAO(peer_id);
2686 // In some rare cases this can be NULL -- if the player is disconnected
2687 // when a Lua function modifies l_punch, for example
2691 infostream << "Server::DiePlayer(): Player "
2692 << playersao->getPlayer()->getName()
2693 << " dies" << std::endl;
2695 playersao->setHP(0, reason);
2696 playersao->clearParentAttachment();
2698 // Trigger scripted stuff
2699 m_script->on_dieplayer(playersao, reason);
2701 SendPlayerHP(peer_id);
2702 SendDeathscreen(peer_id, false, v3f(0,0,0));
2705 void Server::RespawnPlayer(session_t peer_id)
2707 PlayerSAO *playersao = getPlayerSAO(peer_id);
2710 infostream << "Server::RespawnPlayer(): Player "
2711 << playersao->getPlayer()->getName()
2712 << " respawns" << std::endl;
2714 playersao->setHP(playersao->accessObjectProperties()->hp_max,
2715 PlayerHPChangeReason(PlayerHPChangeReason::RESPAWN));
2716 playersao->setBreath(playersao->accessObjectProperties()->breath_max);
2718 bool repositioned = m_script->on_respawnplayer(playersao);
2719 if (!repositioned) {
2720 // setPos will send the new position to client
2721 playersao->setPos(findSpawnPos());
2724 SendPlayerHP(peer_id);
2728 void Server::DenySudoAccess(session_t peer_id)
2730 NetworkPacket pkt(TOCLIENT_DENY_SUDO_MODE, 0, peer_id);
2735 void Server::DenyAccessVerCompliant(session_t peer_id, u16 proto_ver, AccessDeniedCode reason,
2736 const std::string &str_reason, bool reconnect)
2738 SendAccessDenied(peer_id, reason, str_reason, reconnect);
2740 m_clients.event(peer_id, CSE_SetDenied);
2741 DisconnectPeer(peer_id);
2745 void Server::DenyAccess(session_t peer_id, AccessDeniedCode reason,
2746 const std::string &custom_reason)
2748 SendAccessDenied(peer_id, reason, custom_reason);
2749 m_clients.event(peer_id, CSE_SetDenied);
2750 DisconnectPeer(peer_id);
2753 // 13/03/15: remove this function when protocol version 25 will become
2754 // the minimum version for MT users, maybe in 1 year
2755 void Server::DenyAccess_Legacy(session_t peer_id, const std::wstring &reason)
2757 SendAccessDenied_Legacy(peer_id, reason);
2758 m_clients.event(peer_id, CSE_SetDenied);
2759 DisconnectPeer(peer_id);
2762 void Server::DisconnectPeer(session_t peer_id)
2764 m_modchannel_mgr->leaveAllChannels(peer_id);
2765 m_con->DisconnectPeer(peer_id);
2768 void Server::acceptAuth(session_t peer_id, bool forSudoMode)
2771 RemoteClient* client = getClient(peer_id, CS_Invalid);
2773 NetworkPacket resp_pkt(TOCLIENT_AUTH_ACCEPT, 1 + 6 + 8 + 4, peer_id);
2775 // Right now, the auth mechs don't change between login and sudo mode.
2776 u32 sudo_auth_mechs = client->allowed_auth_mechs;
2777 client->allowed_sudo_mechs = sudo_auth_mechs;
2779 resp_pkt << v3f(0,0,0) << (u64) m_env->getServerMap().getSeed()
2780 << g_settings->getFloat("dedicated_server_step")
2784 m_clients.event(peer_id, CSE_AuthAccept);
2786 NetworkPacket resp_pkt(TOCLIENT_ACCEPT_SUDO_MODE, 1 + 6 + 8 + 4, peer_id);
2788 // We only support SRP right now
2789 u32 sudo_auth_mechs = AUTH_MECHANISM_FIRST_SRP;
2791 resp_pkt << sudo_auth_mechs;
2793 m_clients.event(peer_id, CSE_SudoSuccess);
2797 void Server::DeleteClient(session_t peer_id, ClientDeletionReason reason)
2799 std::wstring message;
2802 Clear references to playing sounds
2804 for (std::unordered_map<s32, ServerPlayingSound>::iterator
2805 i = m_playing_sounds.begin(); i != m_playing_sounds.end();) {
2806 ServerPlayingSound &psound = i->second;
2807 psound.clients.erase(peer_id);
2808 if (psound.clients.empty())
2809 m_playing_sounds.erase(i++);
2814 // clear formspec info so the next client can't abuse the current state
2815 m_formspec_state_data.erase(peer_id);
2817 RemotePlayer *player = m_env->getPlayer(peer_id);
2819 /* Run scripts and remove from environment */
2821 PlayerSAO *playersao = player->getPlayerSAO();
2824 playersao->clearChildAttachments();
2825 playersao->clearParentAttachment();
2827 // inform connected clients
2828 const std::string &player_name = player->getName();
2829 NetworkPacket notice(TOCLIENT_UPDATE_PLAYER_LIST, 0, PEER_ID_INEXISTENT);
2830 // (u16) 1 + std::string represents a vector serialization representation
2831 notice << (u8) PLAYER_LIST_REMOVE << (u16) 1 << player_name;
2832 m_clients.sendToAll(¬ice);
2834 m_script->on_leaveplayer(playersao, reason == CDR_TIMEOUT);
2836 playersao->disconnected();
2843 if (player && reason != CDR_DENY) {
2844 std::ostringstream os(std::ios_base::binary);
2845 std::vector<session_t> clients = m_clients.getClientIDs();
2847 for (const session_t client_id : clients) {
2849 RemotePlayer *player = m_env->getPlayer(client_id);
2853 // Get name of player
2854 os << player->getName() << " ";
2857 std::string name = player->getName();
2858 actionstream << name << " "
2859 << (reason == CDR_TIMEOUT ? "times out." : "leaves game.")
2860 << " List of players: " << os.str() << std::endl;
2862 m_admin_chat->outgoing_queue.push_back(
2863 new ChatEventNick(CET_NICK_REMOVE, name));
2867 MutexAutoLock env_lock(m_env_mutex);
2868 m_clients.DeleteClient(peer_id);
2872 // Send leave chat message to all remaining clients
2873 if (!message.empty()) {
2874 SendChatMessage(PEER_ID_INEXISTENT,
2875 ChatMessage(CHATMESSAGE_TYPE_ANNOUNCE, message));
2879 void Server::UpdateCrafting(RemotePlayer *player)
2881 InventoryList *clist = player->inventory.getList("craft");
2882 if (!clist || clist->getSize() == 0)
2885 if (!clist->checkModified()) {
2886 verbosestream << "Skip Server::UpdateCrafting(): list unmodified" << std::endl;
2890 // Get a preview for crafting
2892 InventoryLocation loc;
2893 loc.setPlayer(player->getName());
2894 std::vector<ItemStack> output_replacements;
2895 getCraftingResult(&player->inventory, preview, output_replacements, false, this);
2896 m_env->getScriptIface()->item_CraftPredict(preview, player->getPlayerSAO(),
2899 InventoryList *plist = player->inventory.getList("craftpreview");
2900 if (plist && plist->getSize() >= 1) {
2901 // Put the new preview in
2902 plist->changeItem(0, preview);
2906 void Server::handleChatInterfaceEvent(ChatEvent *evt)
2908 if (evt->type == CET_NICK_ADD) {
2909 // The terminal informed us of its nick choice
2910 m_admin_nick = ((ChatEventNick *)evt)->nick;
2911 if (!m_script->getAuth(m_admin_nick, NULL, NULL)) {
2912 errorstream << "You haven't set up an account." << std::endl
2913 << "Please log in using the client as '"
2914 << m_admin_nick << "' with a secure password." << std::endl
2915 << "Until then, you can't execute admin tasks via the console," << std::endl
2916 << "and everybody can claim the user account instead of you," << std::endl
2917 << "giving them full control over this server." << std::endl;
2920 assert(evt->type == CET_CHAT);
2921 handleAdminChat((ChatEventChat *)evt);
2925 std::wstring Server::handleChat(const std::string &name, const std::wstring &wname,
2926 std::wstring wmessage, bool check_shout_priv, RemotePlayer *player)
2928 // If something goes wrong, this player is to blame
2929 RollbackScopeActor rollback_scope(m_rollback,
2930 std::string("player:") + name);
2932 if (g_settings->getBool("strip_color_codes"))
2933 wmessage = unescape_enriched(wmessage);
2936 switch (player->canSendChatMessage()) {
2937 case RPLAYER_CHATRESULT_FLOODING: {
2938 std::wstringstream ws;
2939 ws << L"You cannot send more messages. You are limited to "
2940 << g_settings->getFloat("chat_message_limit_per_10sec")
2941 << L" messages per 10 seconds.";
2944 case RPLAYER_CHATRESULT_KICK:
2945 DenyAccess_Legacy(player->getPeerId(),
2946 L"You have been kicked due to message flooding.");
2948 case RPLAYER_CHATRESULT_OK:
2951 FATAL_ERROR("Unhandled chat filtering result found.");
2955 if (m_max_chatmessage_length > 0
2956 && wmessage.length() > m_max_chatmessage_length) {
2957 return L"Your message exceed the maximum chat message limit set on the server. "
2958 L"It was refused. Send a shorter message";
2961 auto message = trim(wide_to_utf8(wmessage));
2962 if (message.find_first_of("\n\r") != std::wstring::npos) {
2963 return L"New lines are not permitted in chat messages";
2966 // Run script hook, exit if script ate the chat message
2967 if (m_script->on_chat_message(name, message))
2972 // Whether to send line to the player that sent the message, or to all players
2973 bool broadcast_line = true;
2975 if (check_shout_priv && !checkPriv(name, "shout")) {
2976 line += L"-!- You don't have permission to shout.";
2977 broadcast_line = false;
2979 line += narrow_to_wide(m_script->formatChatMessage(name,
2980 wide_to_narrow(wmessage)));
2984 Tell calling method to send the message to sender
2986 if (!broadcast_line)
2990 Send the message to others
2992 actionstream << "CHAT: " << wide_to_narrow(unescape_enriched(line)) << std::endl;
2994 std::vector<session_t> clients = m_clients.getClientIDs();
2997 Send the message back to the inital sender
2998 if they are using protocol version >= 29
3001 session_t peer_id_to_avoid_sending =
3002 (player ? player->getPeerId() : PEER_ID_INEXISTENT);
3004 if (player && player->protocol_version >= 29)
3005 peer_id_to_avoid_sending = PEER_ID_INEXISTENT;
3007 for (u16 cid : clients) {
3008 if (cid != peer_id_to_avoid_sending)
3009 SendChatMessage(cid, ChatMessage(line));
3014 void Server::handleAdminChat(const ChatEventChat *evt)
3016 std::string name = evt->nick;
3017 std::wstring wname = utf8_to_wide(name);
3018 std::wstring wmessage = evt->evt_msg;
3020 std::wstring answer = handleChat(name, wname, wmessage);
3022 // If asked to send answer to sender
3023 if (!answer.empty()) {
3024 m_admin_chat->outgoing_queue.push_back(new ChatEventChat("", answer));
3028 RemoteClient *Server::getClient(session_t peer_id, ClientState state_min)
3030 RemoteClient *client = getClientNoEx(peer_id,state_min);
3032 throw ClientNotFoundException("Client not found");
3036 RemoteClient *Server::getClientNoEx(session_t peer_id, ClientState state_min)
3038 return m_clients.getClientNoEx(peer_id, state_min);
3041 std::string Server::getPlayerName(session_t peer_id)
3043 RemotePlayer *player = m_env->getPlayer(peer_id);
3045 return "[id="+itos(peer_id)+"]";
3046 return player->getName();
3049 PlayerSAO *Server::getPlayerSAO(session_t peer_id)
3051 RemotePlayer *player = m_env->getPlayer(peer_id);
3054 return player->getPlayerSAO();
3057 std::wstring Server::getStatusString()
3059 std::wostringstream os(std::ios_base::binary);
3060 os << L"# Server: ";
3062 os << L"version=" << narrow_to_wide(g_version_string);
3064 os << L", uptime=" << m_uptime.get();
3066 os << L", max_lag=" << (m_env ? m_env->getMaxLagEstimate() : 0);
3068 // Information about clients
3070 os << L", clients={";
3072 std::vector<session_t> clients = m_clients.getClientIDs();
3073 for (session_t client_id : clients) {
3074 RemotePlayer *player = m_env->getPlayer(client_id);
3076 // Get name of player
3077 std::wstring name = L"unknown";
3079 name = narrow_to_wide(player->getName());
3081 // Add name to information string
3092 if (m_env && !((ServerMap*)(&m_env->getMap()))->isSavingEnabled())
3093 os << std::endl << L"# Server: " << " WARNING: Map saving is disabled.";
3095 if (!g_settings->get("motd").empty())
3096 os << std::endl << L"# Server: " << narrow_to_wide(g_settings->get("motd"));
3101 std::set<std::string> Server::getPlayerEffectivePrivs(const std::string &name)
3103 std::set<std::string> privs;
3104 m_script->getAuth(name, NULL, &privs);
3108 bool Server::checkPriv(const std::string &name, const std::string &priv)
3110 std::set<std::string> privs = getPlayerEffectivePrivs(name);
3111 return (privs.count(priv) != 0);
3114 void Server::reportPrivsModified(const std::string &name)
3117 std::vector<session_t> clients = m_clients.getClientIDs();
3118 for (const session_t client_id : clients) {
3119 RemotePlayer *player = m_env->getPlayer(client_id);
3120 reportPrivsModified(player->getName());
3123 RemotePlayer *player = m_env->getPlayer(name.c_str());
3126 SendPlayerPrivileges(player->getPeerId());
3127 PlayerSAO *sao = player->getPlayerSAO();
3130 sao->updatePrivileges(
3131 getPlayerEffectivePrivs(name),
3136 void Server::reportInventoryFormspecModified(const std::string &name)
3138 RemotePlayer *player = m_env->getPlayer(name.c_str());
3141 SendPlayerInventoryFormspec(player->getPeerId());
3144 void Server::reportFormspecPrependModified(const std::string &name)
3146 RemotePlayer *player = m_env->getPlayer(name.c_str());
3149 SendPlayerFormspecPrepend(player->getPeerId());
3152 void Server::setIpBanned(const std::string &ip, const std::string &name)
3154 m_banmanager->add(ip, name);
3157 void Server::unsetIpBanned(const std::string &ip_or_name)
3159 m_banmanager->remove(ip_or_name);
3162 std::string Server::getBanDescription(const std::string &ip_or_name)
3164 return m_banmanager->getBanDescription(ip_or_name);
3167 void Server::notifyPlayer(const char *name, const std::wstring &msg)
3169 // m_env will be NULL if the server is initializing
3173 if (m_admin_nick == name && !m_admin_nick.empty()) {
3174 m_admin_chat->outgoing_queue.push_back(new ChatEventChat("", msg));
3177 RemotePlayer *player = m_env->getPlayer(name);
3182 if (player->getPeerId() == PEER_ID_INEXISTENT)
3185 SendChatMessage(player->getPeerId(), ChatMessage(msg));
3188 bool Server::showFormspec(const char *playername, const std::string &formspec,
3189 const std::string &formname)
3191 // m_env will be NULL if the server is initializing
3195 RemotePlayer *player = m_env->getPlayer(playername);
3199 SendShowFormspecMessage(player->getPeerId(), formspec, formname);
3203 u32 Server::hudAdd(RemotePlayer *player, HudElement *form)
3208 u32 id = player->addHud(form);
3210 SendHUDAdd(player->getPeerId(), id, form);
3215 bool Server::hudRemove(RemotePlayer *player, u32 id) {
3219 HudElement* todel = player->removeHud(id);
3226 SendHUDRemove(player->getPeerId(), id);
3230 bool Server::hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *data)
3235 SendHUDChange(player->getPeerId(), id, stat, data);
3239 bool Server::hudSetFlags(RemotePlayer *player, u32 flags, u32 mask)
3244 SendHUDSetFlags(player->getPeerId(), flags, mask);
3245 player->hud_flags &= ~mask;
3246 player->hud_flags |= flags;
3248 PlayerSAO* playersao = player->getPlayerSAO();
3253 m_script->player_event(playersao, "hud_changed");
3257 bool Server::hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount)
3262 if (hotbar_itemcount <= 0 || hotbar_itemcount > HUD_HOTBAR_ITEMCOUNT_MAX)
3265 player->setHotbarItemcount(hotbar_itemcount);
3266 std::ostringstream os(std::ios::binary);
3267 writeS32(os, hotbar_itemcount);
3268 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_ITEMCOUNT, os.str());
3272 void Server::hudSetHotbarImage(RemotePlayer *player, const std::string &name)
3277 player->setHotbarImage(name);
3278 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_IMAGE, name);
3281 void Server::hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name)
3286 player->setHotbarSelectedImage(name);
3287 SendHUDSetParam(player->getPeerId(), HUD_PARAM_HOTBAR_SELECTED_IMAGE, name);
3290 Address Server::getPeerAddress(session_t peer_id)
3292 return m_con->GetPeerAddress(peer_id);
3295 void Server::setLocalPlayerAnimations(RemotePlayer *player,
3296 v2s32 animation_frames[4], f32 frame_speed)
3298 sanity_check(player);
3299 player->setLocalAnimations(animation_frames, frame_speed);
3300 SendLocalPlayerAnimations(player->getPeerId(), animation_frames, frame_speed);
3303 void Server::setPlayerEyeOffset(RemotePlayer *player, const v3f &first, const v3f &third)
3305 sanity_check(player);
3306 player->eye_offset_first = first;
3307 player->eye_offset_third = third;
3308 SendEyeOffset(player->getPeerId(), first, third);
3311 void Server::setSky(RemotePlayer *player, const video::SColor &bgcolor,
3312 const std::string &type, const std::vector<std::string> ¶ms,
3315 sanity_check(player);
3316 player->setSky(bgcolor, type, params, clouds);
3317 SendSetSky(player->getPeerId(), bgcolor, type, params, clouds);
3320 void Server::setClouds(RemotePlayer *player, const CloudParams ¶ms)
3322 sanity_check(player);
3323 player->setCloudParams(params);
3324 SendCloudParams(player->getPeerId(), params);
3327 bool Server::overrideDayNightRatio(RemotePlayer *player, bool do_override,
3333 player->overrideDayNightRatio(do_override, ratio);
3334 SendOverrideDayNightRatio(player->getPeerId(), do_override, ratio);
3338 void Server::notifyPlayers(const std::wstring &msg)
3340 SendChatMessage(PEER_ID_INEXISTENT, ChatMessage(msg));
3343 void Server::spawnParticle(const std::string &playername, v3f pos,
3344 v3f velocity, v3f acceleration,
3345 float expirationtime, float size, bool
3346 collisiondetection, bool collision_removal, bool object_collision,
3347 bool vertical, const std::string &texture,
3348 const struct TileAnimationParams &animation, u8 glow)
3350 // m_env will be NULL if the server is initializing
3354 session_t peer_id = PEER_ID_INEXISTENT;
3356 if (!playername.empty()) {
3357 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3360 peer_id = player->getPeerId();
3361 proto_ver = player->protocol_version;
3364 SendSpawnParticle(peer_id, proto_ver, pos, velocity, acceleration,
3365 expirationtime, size, collisiondetection, collision_removal,
3366 object_collision, vertical, texture, animation, glow);
3369 u32 Server::addParticleSpawner(u16 amount, float spawntime,
3370 v3f minpos, v3f maxpos, v3f minvel, v3f maxvel, v3f minacc, v3f maxacc,
3371 float minexptime, float maxexptime, float minsize, float maxsize,
3372 bool collisiondetection, bool collision_removal, bool object_collision,
3373 ServerActiveObject *attached, bool vertical, const std::string &texture,
3374 const std::string &playername, const struct TileAnimationParams &animation,
3377 // m_env will be NULL if the server is initializing
3381 session_t peer_id = PEER_ID_INEXISTENT;
3383 if (!playername.empty()) {
3384 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3387 peer_id = player->getPeerId();
3388 proto_ver = player->protocol_version;
3391 u16 attached_id = attached ? attached->getId() : 0;
3394 if (attached_id == 0)
3395 id = m_env->addParticleSpawner(spawntime);
3397 id = m_env->addParticleSpawner(spawntime, attached_id);
3399 SendAddParticleSpawner(peer_id, proto_ver, amount, spawntime,
3400 minpos, maxpos, minvel, maxvel, minacc, maxacc,
3401 minexptime, maxexptime, minsize, maxsize, collisiondetection,
3402 collision_removal, object_collision, attached_id, vertical,
3403 texture, id, animation, glow);
3408 void Server::deleteParticleSpawner(const std::string &playername, u32 id)
3410 // m_env will be NULL if the server is initializing
3412 throw ServerError("Can't delete particle spawners during initialisation!");
3414 session_t peer_id = PEER_ID_INEXISTENT;
3415 if (!playername.empty()) {
3416 RemotePlayer *player = m_env->getPlayer(playername.c_str());
3419 peer_id = player->getPeerId();
3422 m_env->deleteParticleSpawner(id);
3423 SendDeleteParticleSpawner(peer_id, id);
3426 Inventory* Server::createDetachedInventory(const std::string &name, const std::string &player)
3428 if(m_detached_inventories.count(name) > 0){
3429 infostream<<"Server clearing detached inventory \""<<name<<"\""<<std::endl;
3430 delete m_detached_inventories[name];
3432 infostream<<"Server creating detached inventory \""<<name<<"\""<<std::endl;
3434 Inventory *inv = new Inventory(m_itemdef);
3436 m_detached_inventories[name] = inv;
3437 if (!player.empty())
3438 m_detached_inventories_player[name] = player;
3440 //TODO find a better way to do this
3441 sendDetachedInventory(name,PEER_ID_INEXISTENT);
3445 bool Server::removeDetachedInventory(const std::string &name)
3447 const auto &inv_it = m_detached_inventories.find(name);
3448 if (inv_it == m_detached_inventories.end())
3451 delete inv_it->second;
3452 m_detached_inventories.erase(inv_it);
3454 if (!m_env) // Mods are not done loading
3457 const auto &player_it = m_detached_inventories_player.find(name);
3458 if (player_it != m_detached_inventories_player.end()) {
3459 RemotePlayer *player = m_env->getPlayer(player_it->second.c_str());
3461 if (player && player->getPeerId() != PEER_ID_INEXISTENT)
3462 sendDetachedInventory(name, player->getPeerId());
3464 m_detached_inventories_player.erase(player_it);
3466 // Notify all players about the change
3467 sendDetachedInventory(name, PEER_ID_INEXISTENT);
3472 // actions: time-reversed list
3473 // Return value: success/failure
3474 bool Server::rollbackRevertActions(const std::list<RollbackAction> &actions,
3475 std::list<std::string> *log)
3477 infostream<<"Server::rollbackRevertActions(len="<<actions.size()<<")"<<std::endl;
3478 ServerMap *map = (ServerMap*)(&m_env->getMap());
3480 // Fail if no actions to handle
3481 if (actions.empty()) {
3483 log->push_back("Nothing to do.");
3490 for (const RollbackAction &action : actions) {
3492 bool success = action.applyRevert(map, this, this);
3495 std::ostringstream os;
3496 os<<"Revert of step ("<<num_tried<<") "<<action.toString()<<" failed";
3497 infostream<<"Map::rollbackRevertActions(): "<<os.str()<<std::endl;
3499 log->push_back(os.str());
3501 std::ostringstream os;
3502 os<<"Successfully reverted step ("<<num_tried<<") "<<action.toString();
3503 infostream<<"Map::rollbackRevertActions(): "<<os.str()<<std::endl;
3505 log->push_back(os.str());
3509 infostream<<"Map::rollbackRevertActions(): "<<num_failed<<"/"<<num_tried
3510 <<" failed"<<std::endl;
3512 // Call it done if less than half failed
3513 return num_failed <= num_tried/2;
3516 // IGameDef interface
3518 IItemDefManager *Server::getItemDefManager()
3523 const NodeDefManager *Server::getNodeDefManager()
3528 ICraftDefManager *Server::getCraftDefManager()
3533 u16 Server::allocateUnknownNodeId(const std::string &name)
3535 return m_nodedef->allocateDummy(name);
3538 IWritableItemDefManager *Server::getWritableItemDefManager()
3543 NodeDefManager *Server::getWritableNodeDefManager()
3548 IWritableCraftDefManager *Server::getWritableCraftDefManager()
3553 const std::vector<ModSpec> & Server::getMods() const
3555 return m_modmgr->getMods();
3558 const ModSpec *Server::getModSpec(const std::string &modname) const
3560 return m_modmgr->getModSpec(modname);
3563 void Server::getModNames(std::vector<std::string> &modlist)
3565 m_modmgr->getModNames(modlist);
3568 std::string Server::getBuiltinLuaPath()
3570 return porting::path_share + DIR_DELIM + "builtin";
3573 std::string Server::getModStoragePath() const
3575 return m_path_world + DIR_DELIM + "mod_storage";
3578 v3f Server::findSpawnPos()
3580 ServerMap &map = m_env->getServerMap();
3582 if (g_settings->getV3FNoEx("static_spawnpoint", nodeposf))
3583 return nodeposf * BS;
3585 bool is_good = false;
3586 // Limit spawn range to mapgen edges (determined by 'mapgen_limit')
3587 s32 range_max = map.getMapgenParams()->getSpawnRangeMax();
3589 // Try to find a good place a few times
3590 for (s32 i = 0; i < 4000 && !is_good; i++) {
3591 s32 range = MYMIN(1 + i, range_max);
3592 // We're going to try to throw the player to this position
3593 v2s16 nodepos2d = v2s16(
3594 -range + (myrand() % (range * 2)),
3595 -range + (myrand() % (range * 2)));
3596 // Get spawn level at point
3597 s16 spawn_level = m_emerge->getSpawnLevelAtPoint(nodepos2d);
3598 // Continue if MAX_MAP_GENERATION_LIMIT was returned by the mapgen to
3599 // signify an unsuitable spawn position, or if outside limits.
3600 if (spawn_level >= MAX_MAP_GENERATION_LIMIT ||
3601 spawn_level <= -MAX_MAP_GENERATION_LIMIT)
3604 v3s16 nodepos(nodepos2d.X, spawn_level, nodepos2d.Y);
3605 // Consecutive empty nodes
3608 // Search upwards from 'spawn level' for 2 consecutive empty nodes, to
3609 // avoid obstructions in already-generated mapblocks.
3610 // In ungenerated mapblocks consisting of 'ignore' nodes, there will be
3611 // no obstructions, but mapgen decorations are generated after spawn so
3612 // the player may end up inside one.
3613 for (s32 i = 0; i < 8; i++) {
3614 v3s16 blockpos = getNodeBlockPos(nodepos);
3615 map.emergeBlock(blockpos, true);
3616 content_t c = map.getNode(nodepos).getContent();
3618 // In generated mapblocks allow spawn in all 'airlike' drawtype nodes.
3619 // In ungenerated mapblocks allow spawn in 'ignore' nodes.
3620 if (m_nodedef->get(c).drawtype == NDT_AIRLIKE || c == CONTENT_IGNORE) {
3622 if (air_count >= 2) {
3623 // Spawn in lower empty node
3625 nodeposf = intToFloat(nodepos, BS);
3626 // Don't spawn the player outside map boundaries
3627 if (objectpos_over_limit(nodeposf))
3628 // Exit this loop, positions above are probably over limit
3631 // Good position found, cause an exit from main loop
3645 // No suitable spawn point found, return fallback 0,0,0
3646 return v3f(0.0f, 0.0f, 0.0f);
3649 void Server::requestShutdown(const std::string &msg, bool reconnect, float delay)
3651 if (delay == 0.0f) {
3652 // No delay, shutdown immediately
3653 m_shutdown_state.is_requested = true;
3654 // only print to the infostream, a chat message saying
3655 // "Server Shutting Down" is sent when the server destructs.
3656 infostream << "*** Immediate Server shutdown requested." << std::endl;
3657 } else if (delay < 0.0f && m_shutdown_state.isTimerRunning()) {
3658 // Negative delay, cancel shutdown if requested
3659 m_shutdown_state.reset();
3660 std::wstringstream ws;
3662 ws << L"*** Server shutdown canceled.";
3664 infostream << wide_to_utf8(ws.str()).c_str() << std::endl;
3665 SendChatMessage(PEER_ID_INEXISTENT, ws.str());
3666 // m_shutdown_* are already handled, skip.
3668 } else if (delay > 0.0f) {
3669 // Positive delay, tell the clients when the server will shut down
3670 std::wstringstream ws;
3672 ws << L"*** Server shutting down in "
3673 << duration_to_string(myround(delay)).c_str()
3676 infostream << wide_to_utf8(ws.str()).c_str() << std::endl;
3677 SendChatMessage(PEER_ID_INEXISTENT, ws.str());
3680 m_shutdown_state.trigger(delay, msg, reconnect);
3683 PlayerSAO* Server::emergePlayer(const char *name, session_t peer_id, u16 proto_version)
3686 Try to get an existing player
3688 RemotePlayer *player = m_env->getPlayer(name);
3690 // If player is already connected, cancel
3691 if (player && player->getPeerId() != PEER_ID_INEXISTENT) {
3692 infostream<<"emergePlayer(): Player already connected"<<std::endl;
3697 If player with the wanted peer_id already exists, cancel.
3699 if (m_env->getPlayer(peer_id)) {
3700 infostream<<"emergePlayer(): Player with wrong name but same"
3701 " peer_id already exists"<<std::endl;
3706 player = new RemotePlayer(name, idef());
3709 bool newplayer = false;
3712 PlayerSAO *playersao = m_env->loadPlayer(player, &newplayer, peer_id, isSingleplayer());
3714 // Complete init with server parts
3715 playersao->finalize(player, getPlayerEffectivePrivs(player->getName()));
3716 player->protocol_version = proto_version;
3720 m_script->on_newplayer(playersao);
3726 bool Server::registerModStorage(ModMetadata *storage)
3728 if (m_mod_storages.find(storage->getModName()) != m_mod_storages.end()) {
3729 errorstream << "Unable to register same mod storage twice. Storage name: "
3730 << storage->getModName() << std::endl;
3734 m_mod_storages[storage->getModName()] = storage;
3738 void Server::unregisterModStorage(const std::string &name)
3740 std::unordered_map<std::string, ModMetadata *>::const_iterator it = m_mod_storages.find(name);
3741 if (it != m_mod_storages.end()) {
3742 // Save unconditionaly on unregistration
3743 it->second->save(getModStoragePath());
3744 m_mod_storages.erase(name);
3748 void dedicated_server_loop(Server &server, bool &kill)
3750 verbosestream<<"dedicated_server_loop()"<<std::endl;
3752 IntervalLimiter m_profiler_interval;
3754 static thread_local const float steplen =
3755 g_settings->getFloat("dedicated_server_step");
3756 static thread_local const float profiler_print_interval =
3757 g_settings->getFloat("profiler_print_interval");
3760 * The dedicated server loop only does time-keeping (in Server::step) and
3761 * provides a way to main.cpp to kill the server externally (bool &kill).
3765 // This is kind of a hack but can be done like this
3766 // because server.step() is very light
3767 sleep_ms((int)(steplen*1000.0));
3768 server.step(steplen);
3770 if (server.isShutdownRequested() || kill)
3776 if (profiler_print_interval != 0) {
3777 if(m_profiler_interval.step(steplen, profiler_print_interval))
3779 infostream<<"Profiler:"<<std::endl;
3780 g_profiler->print(infostream);
3781 g_profiler->clear();
3786 infostream << "Dedicated server quitting" << std::endl;
3788 if (g_settings->getBool("server_announce"))
3789 ServerList::sendAnnounce(ServerList::AA_DELETE,
3790 server.m_bind_addr.getPort());
3799 bool Server::joinModChannel(const std::string &channel)
3801 return m_modchannel_mgr->joinChannel(channel, PEER_ID_SERVER) &&
3802 m_modchannel_mgr->setChannelState(channel, MODCHANNEL_STATE_READ_WRITE);
3805 bool Server::leaveModChannel(const std::string &channel)
3807 return m_modchannel_mgr->leaveChannel(channel, PEER_ID_SERVER);
3810 bool Server::sendModChannelMessage(const std::string &channel, const std::string &message)
3812 if (!m_modchannel_mgr->canWriteOnChannel(channel))
3815 broadcastModChannelMessage(channel, message, PEER_ID_SERVER);
3819 ModChannel* Server::getModChannel(const std::string &channel)
3821 return m_modchannel_mgr->getModChannel(channel);
3824 void Server::broadcastModChannelMessage(const std::string &channel,
3825 const std::string &message, session_t from_peer)
3827 const std::vector<u16> &peers = m_modchannel_mgr->getChannelPeers(channel);
3831 if (message.size() > STRING_MAX_LEN) {
3832 warningstream << "ModChannel message too long, dropping before sending "
3833 << " (" << message.size() << " > " << STRING_MAX_LEN << ", channel: "
3834 << channel << ")" << std::endl;
3839 if (from_peer != PEER_ID_SERVER) {
3840 sender = getPlayerName(from_peer);
3843 NetworkPacket resp_pkt(TOCLIENT_MODCHANNEL_MSG,
3844 2 + channel.size() + 2 + sender.size() + 2 + message.size());
3845 resp_pkt << channel << sender << message;
3846 for (session_t peer_id : peers) {
3848 if (peer_id == from_peer)
3851 Send(peer_id, &resp_pkt);
3854 if (from_peer != PEER_ID_SERVER) {
3855 m_script->on_modchannel_message(channel, sender, message);