3 Copyright (C) 2010-2017 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.
20 #include "serverenvironment.h"
21 #include "content_sao.h"
26 #include "nodemetadata.h"
32 #include "remoteplayer.h"
33 #include "scripting_server.h"
35 #include "util/serialize.h"
36 #include "util/basic_macros.h"
37 #include "util/pointedthing.h"
38 #include "threading/mutex_auto_lock.h"
40 #include "gameparams.h"
41 #include "database/database-dummy.h"
42 #include "database/database-files.h"
43 #include "database/database-sqlite3.h"
45 #include "database/database-postgresql.h"
49 #define LBM_NAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyz0123456789_:"
51 // A number that is much smaller than the timeout for particle spawners should/could ever be
52 #define PARTICLE_SPAWNER_NO_EXPIRY -1024.f
58 ABMWithState::ABMWithState(ActiveBlockModifier *abm_):
61 // Initialize timer to random value to spread processing
62 float itv = abm->getTriggerInterval();
63 itv = MYMAX(0.001, itv); // No less than 1ms
64 int minval = MYMAX(-0.51*itv, -60); // Clamp to
65 int maxval = MYMIN(0.51*itv, 60); // +-60 seconds
66 timer = myrand_range(minval, maxval);
73 void LBMContentMapping::deleteContents()
75 for (auto &it : lbm_list) {
80 void LBMContentMapping::addLBM(LoadingBlockModifierDef *lbm_def, IGameDef *gamedef)
82 // Add the lbm_def to the LBMContentMapping.
83 // Unknown names get added to the global NameIdMapping.
84 const NodeDefManager *nodedef = gamedef->ndef();
86 lbm_list.push_back(lbm_def);
88 for (const std::string &nodeTrigger: lbm_def->trigger_contents) {
89 std::vector<content_t> c_ids;
90 bool found = nodedef->getIds(nodeTrigger, c_ids);
92 content_t c_id = gamedef->allocateUnknownNodeId(nodeTrigger);
93 if (c_id == CONTENT_IGNORE) {
94 // Seems it can't be allocated.
95 warningstream << "Could not internalize node name \"" << nodeTrigger
96 << "\" while loading LBM \"" << lbm_def->name << "\"." << std::endl;
99 c_ids.push_back(c_id);
102 for (content_t c_id : c_ids) {
103 map[c_id].push_back(lbm_def);
108 const std::vector<LoadingBlockModifierDef *> *
109 LBMContentMapping::lookup(content_t c) const
111 lbm_map::const_iterator it = map.find(c);
114 // This first dereferences the iterator, returning
115 // a std::vector<LoadingBlockModifierDef *>
116 // reference, then we convert it to a pointer.
117 return &(it->second);
120 LBMManager::~LBMManager()
122 for (auto &m_lbm_def : m_lbm_defs) {
123 delete m_lbm_def.second;
126 for (auto &it : m_lbm_lookup) {
127 (it.second).deleteContents();
131 void LBMManager::addLBMDef(LoadingBlockModifierDef *lbm_def)
133 // Precondition, in query mode the map isn't used anymore
134 FATAL_ERROR_IF(m_query_mode,
135 "attempted to modify LBMManager in query mode");
137 if (!string_allowed(lbm_def->name, LBM_NAME_ALLOWED_CHARS)) {
138 throw ModError("Error adding LBM \"" + lbm_def->name +
139 "\": Does not follow naming conventions: "
140 "Only characters [a-z0-9_:] are allowed.");
143 m_lbm_defs[lbm_def->name] = lbm_def;
146 void LBMManager::loadIntroductionTimes(const std::string ×,
147 IGameDef *gamedef, u32 now)
152 // Storing it in a map first instead of
153 // handling the stuff directly in the loop
154 // removes all duplicate entries.
155 // TODO make this std::unordered_map
156 std::map<std::string, u32> introduction_times;
159 The introduction times string consists of name~time entries,
160 with each entry terminated by a semicolon. The time is decimal.
165 while ((idx_new = times.find(';', idx)) != std::string::npos) {
166 std::string entry = times.substr(idx, idx_new - idx);
167 std::vector<std::string> components = str_split(entry, '~');
168 if (components.size() != 2)
169 throw SerializationError("Introduction times entry \""
170 + entry + "\" requires exactly one '~'!");
171 const std::string &name = components[0];
172 u32 time = from_string<u32>(components[1]);
173 introduction_times[name] = time;
177 // Put stuff from introduction_times into m_lbm_lookup
178 for (std::map<std::string, u32>::const_iterator it = introduction_times.begin();
179 it != introduction_times.end(); ++it) {
180 const std::string &name = it->first;
181 u32 time = it->second;
183 std::map<std::string, LoadingBlockModifierDef *>::iterator def_it =
184 m_lbm_defs.find(name);
185 if (def_it == m_lbm_defs.end()) {
186 // This seems to be an LBM entry for
187 // an LBM we haven't loaded. Discard it.
190 LoadingBlockModifierDef *lbm_def = def_it->second;
191 if (lbm_def->run_at_every_load) {
192 // This seems to be an LBM entry for
193 // an LBM that runs at every load.
194 // Don't add it just yet.
198 m_lbm_lookup[time].addLBM(lbm_def, gamedef);
200 // Erase the entry so that we know later
201 // what elements didn't get put into m_lbm_lookup
202 m_lbm_defs.erase(name);
205 // Now also add the elements from m_lbm_defs to m_lbm_lookup
206 // that weren't added in the previous step.
207 // They are introduced first time to this world,
208 // or are run at every load (introducement time hardcoded to U32_MAX).
210 LBMContentMapping &lbms_we_introduce_now = m_lbm_lookup[now];
211 LBMContentMapping &lbms_running_always = m_lbm_lookup[U32_MAX];
213 for (auto &m_lbm_def : m_lbm_defs) {
214 if (m_lbm_def.second->run_at_every_load) {
215 lbms_running_always.addLBM(m_lbm_def.second, gamedef);
217 lbms_we_introduce_now.addLBM(m_lbm_def.second, gamedef);
221 // Clear the list, so that we don't delete remaining elements
222 // twice in the destructor
226 std::string LBMManager::createIntroductionTimesString()
228 // Precondition, we must be in query mode
229 FATAL_ERROR_IF(!m_query_mode,
230 "attempted to query on non fully set up LBMManager");
232 std::ostringstream oss;
233 for (const auto &it : m_lbm_lookup) {
235 const std::vector<LoadingBlockModifierDef *> &lbm_list = it.second.lbm_list;
236 for (const auto &lbm_def : lbm_list) {
237 // Don't add if the LBM runs at every load,
238 // then introducement time is hardcoded
239 // and doesn't need to be stored
240 if (lbm_def->run_at_every_load)
242 oss << lbm_def->name << "~" << time << ";";
248 void LBMManager::applyLBMs(ServerEnvironment *env, MapBlock *block, u32 stamp)
250 // Precondition, we need m_lbm_lookup to be initialized
251 FATAL_ERROR_IF(!m_query_mode,
252 "attempted to query on non fully set up LBMManager");
253 v3s16 pos_of_block = block->getPosRelative();
257 lbm_lookup_map::const_iterator it = getLBMsIntroducedAfter(stamp);
258 for (; it != m_lbm_lookup.end(); ++it) {
259 // Cache previous version to speedup lookup which has a very high performance
260 // penalty on each call
261 content_t previous_c{};
262 std::vector<LoadingBlockModifierDef *> *lbm_list = nullptr;
264 for (pos.X = 0; pos.X < MAP_BLOCKSIZE; pos.X++)
265 for (pos.Y = 0; pos.Y < MAP_BLOCKSIZE; pos.Y++)
266 for (pos.Z = 0; pos.Z < MAP_BLOCKSIZE; pos.Z++) {
267 n = block->getNodeNoEx(pos);
270 // If content_t are not matching perform an LBM lookup
271 if (previous_c != c) {
272 lbm_list = (std::vector<LoadingBlockModifierDef *> *)
273 it->second.lookup(c);
279 for (auto lbmdef : *lbm_list) {
280 lbmdef->trigger(env, pos + pos_of_block, n);
290 void fillRadiusBlock(v3s16 p0, s16 r, std::set<v3s16> &list)
293 for(p.X=p0.X-r; p.X<=p0.X+r; p.X++)
294 for(p.Y=p0.Y-r; p.Y<=p0.Y+r; p.Y++)
295 for(p.Z=p0.Z-r; p.Z<=p0.Z+r; p.Z++)
298 if (p.getDistanceFrom(p0) <= r) {
305 void fillViewConeBlock(v3s16 p0,
307 const v3f camera_pos,
308 const v3f camera_dir,
309 const float camera_fov,
310 std::set<v3s16> &list)
313 const s16 r_nodes = r * BS * MAP_BLOCKSIZE;
314 for (p.X = p0.X - r; p.X <= p0.X+r; p.X++)
315 for (p.Y = p0.Y - r; p.Y <= p0.Y+r; p.Y++)
316 for (p.Z = p0.Z - r; p.Z <= p0.Z+r; p.Z++) {
317 if (isBlockInSight(p, camera_pos, camera_dir, camera_fov, r_nodes)) {
323 void ActiveBlockList::update(std::vector<PlayerSAO*> &active_players,
324 s16 active_block_range,
325 s16 active_object_range,
326 std::set<v3s16> &blocks_removed,
327 std::set<v3s16> &blocks_added)
332 std::set<v3s16> newlist = m_forceloaded_list;
333 m_abm_list = m_forceloaded_list;
334 for (const PlayerSAO *playersao : active_players) {
335 v3s16 pos = getNodeBlockPos(floatToInt(playersao->getBasePosition(), BS));
336 fillRadiusBlock(pos, active_block_range, m_abm_list);
337 fillRadiusBlock(pos, active_block_range, newlist);
339 s16 player_ao_range = std::min(active_object_range, playersao->getWantedRange());
340 // only do this if this would add blocks
341 if (player_ao_range > active_block_range) {
342 v3f camera_dir = v3f(0,0,1);
343 camera_dir.rotateYZBy(playersao->getLookPitch());
344 camera_dir.rotateXZBy(playersao->getRotation().Y);
345 fillViewConeBlock(pos,
347 playersao->getEyePosition(),
355 Find out which blocks on the old list are not on the new list
357 // Go through old list
358 for (v3s16 p : m_list) {
359 // If not on new list, it's been removed
360 if (newlist.find(p) == newlist.end())
361 blocks_removed.insert(p);
365 Find out which blocks on the new list are not on the old list
367 // Go through new list
368 for (v3s16 p : newlist) {
369 // If not on old list, it's been added
370 if(m_list.find(p) == m_list.end())
371 blocks_added.insert(p);
378 for (v3s16 p : newlist) {
387 // Random device to seed pseudo random generators.
388 static std::random_device seed;
390 ServerEnvironment::ServerEnvironment(ServerMap *map,
391 ServerScripting *scriptIface, Server *server,
392 const std::string &path_world):
395 m_script(scriptIface),
397 m_path_world(path_world),
400 // Determine which database backend to use
401 std::string conf_path = path_world + DIR_DELIM + "world.mt";
404 std::string player_backend_name = "sqlite3";
405 std::string auth_backend_name = "sqlite3";
407 bool succeeded = conf.readConfigFile(conf_path.c_str());
409 // If we open world.mt read the backend configurations.
411 // Read those values before setting defaults
412 bool player_backend_exists = conf.exists("player_backend");
413 bool auth_backend_exists = conf.exists("auth_backend");
415 // player backend is not set, assume it's legacy file backend.
416 if (!player_backend_exists) {
417 // fall back to files
418 conf.set("player_backend", "files");
419 player_backend_name = "files";
421 if (!conf.updateConfigFile(conf_path.c_str())) {
422 errorstream << "ServerEnvironment::ServerEnvironment(): "
423 << "Failed to update world.mt!" << std::endl;
426 conf.getNoEx("player_backend", player_backend_name);
429 // auth backend is not set, assume it's legacy file backend.
430 if (!auth_backend_exists) {
431 conf.set("auth_backend", "files");
432 auth_backend_name = "files";
434 if (!conf.updateConfigFile(conf_path.c_str())) {
435 errorstream << "ServerEnvironment::ServerEnvironment(): "
436 << "Failed to update world.mt!" << std::endl;
439 conf.getNoEx("auth_backend", auth_backend_name);
443 if (player_backend_name == "files") {
444 warningstream << "/!\\ You are using old player file backend. "
445 << "This backend is deprecated and will be removed in a future release /!\\"
446 << std::endl << "Switching to SQLite3 or PostgreSQL is advised, "
447 << "please read http://wiki.minetest.net/Database_backends." << std::endl;
450 if (auth_backend_name == "files") {
451 warningstream << "/!\\ You are using old auth file backend. "
452 << "This backend is deprecated and will be removed in a future release /!\\"
453 << std::endl << "Switching to SQLite3 is advised, "
454 << "please read http://wiki.minetest.net/Database_backends." << std::endl;
457 m_player_database = openPlayerDatabase(player_backend_name, path_world, conf);
458 m_auth_database = openAuthDatabase(auth_backend_name, path_world, conf);
461 ServerEnvironment::~ServerEnvironment()
463 // Clear active block list.
464 // This makes the next one delete all active objects.
465 m_active_blocks.clear();
467 // Convert all objects to static and delete the active objects
468 deactivateFarObjects(true);
473 // Delete ActiveBlockModifiers
474 for (ABMWithState &m_abm : m_abms) {
478 // Deallocate players
479 for (RemotePlayer *m_player : m_players) {
483 delete m_player_database;
484 delete m_auth_database;
487 Map & ServerEnvironment::getMap()
492 ServerMap & ServerEnvironment::getServerMap()
497 RemotePlayer *ServerEnvironment::getPlayer(const session_t peer_id)
499 for (RemotePlayer *player : m_players) {
500 if (player->getPeerId() == peer_id)
506 RemotePlayer *ServerEnvironment::getPlayer(const char* name)
508 for (RemotePlayer *player : m_players) {
509 if (strcmp(player->getName(), name) == 0)
515 void ServerEnvironment::addPlayer(RemotePlayer *player)
518 Check that peer_ids are unique.
519 Also check that names are unique.
520 Exception: there can be multiple players with peer_id=0
522 // If peer id is non-zero, it has to be unique.
523 if (player->getPeerId() != PEER_ID_INEXISTENT)
524 FATAL_ERROR_IF(getPlayer(player->getPeerId()) != NULL, "Peer id not unique");
525 // Name has to be unique.
526 FATAL_ERROR_IF(getPlayer(player->getName()) != NULL, "Player name not unique");
528 m_players.push_back(player);
531 void ServerEnvironment::removePlayer(RemotePlayer *player)
533 for (std::vector<RemotePlayer *>::iterator it = m_players.begin();
534 it != m_players.end(); ++it) {
535 if ((*it) == player) {
543 bool ServerEnvironment::removePlayerFromDatabase(const std::string &name)
545 return m_player_database->removePlayer(name);
548 bool ServerEnvironment::line_of_sight(v3f pos1, v3f pos2, v3s16 *p)
550 // Iterate trough nodes on the line
551 voxalgo::VoxelLineIterator iterator(pos1 / BS, (pos2 - pos1) / BS);
553 MapNode n = getMap().getNode(iterator.m_current_node_pos);
556 if (n.param0 != CONTENT_AIR) {
558 *p = iterator.m_current_node_pos;
562 } while (iterator.m_current_index <= iterator.m_last_index);
566 void ServerEnvironment::kickAllPlayers(AccessDeniedCode reason,
567 const std::string &str_reason, bool reconnect)
569 for (RemotePlayer *player : m_players) {
570 m_server->DenyAccessVerCompliant(player->getPeerId(),
571 player->protocol_version, reason, str_reason, reconnect);
575 void ServerEnvironment::saveLoadedPlayers(bool force)
577 for (RemotePlayer *player : m_players) {
578 if (force || player->checkModified() || (player->getPlayerSAO() &&
579 player->getPlayerSAO()->getMeta().isModified())) {
581 m_player_database->savePlayer(player);
582 } catch (DatabaseException &e) {
583 errorstream << "Failed to save player " << player->getName() << " exception: "
584 << e.what() << std::endl;
591 void ServerEnvironment::savePlayer(RemotePlayer *player)
594 m_player_database->savePlayer(player);
595 } catch (DatabaseException &e) {
596 errorstream << "Failed to save player " << player->getName() << " exception: "
597 << e.what() << std::endl;
602 PlayerSAO *ServerEnvironment::loadPlayer(RemotePlayer *player, bool *new_player,
603 session_t peer_id, bool is_singleplayer)
605 PlayerSAO *playersao = new PlayerSAO(this, player, peer_id, is_singleplayer);
606 // Create player if it doesn't exist
607 if (!m_player_database->loadPlayer(player, playersao)) {
609 // Set player position
610 infostream << "Server: Finding spawn place for player \""
611 << player->getName() << "\"" << std::endl;
612 playersao->setBasePosition(m_server->findSpawnPos());
614 // Make sure the player is saved
615 player->setModified(true);
617 // If the player exists, ensure that they respawn inside legal bounds
618 // This fixes an assert crash when the player can't be added
619 // to the environment
620 if (objectpos_over_limit(playersao->getBasePosition())) {
621 actionstream << "Respawn position for player \""
622 << player->getName() << "\" outside limits, resetting" << std::endl;
623 playersao->setBasePosition(m_server->findSpawnPos());
627 // Add player to environment
630 /* Clean up old HUD elements from previous sessions */
633 /* Add object to environment */
634 addActiveObject(playersao);
639 void ServerEnvironment::saveMeta()
641 std::string path = m_path_world + DIR_DELIM "env_meta.txt";
643 // Open file and serialize
644 std::ostringstream ss(std::ios_base::binary);
647 args.setU64("game_time", m_game_time);
648 args.setU64("time_of_day", getTimeOfDay());
649 args.setU64("last_clear_objects_time", m_last_clear_objects_time);
650 args.setU64("lbm_introduction_times_version", 1);
651 args.set("lbm_introduction_times",
652 m_lbm_mgr.createIntroductionTimesString());
653 args.setU64("day_count", m_day_count);
657 if(!fs::safeWriteToFile(path, ss.str()))
659 infostream<<"ServerEnvironment::saveMeta(): Failed to write "
661 throw SerializationError("Couldn't save env meta");
665 void ServerEnvironment::loadMeta()
667 // If file doesn't exist, load default environment metadata
668 if (!fs::PathExists(m_path_world + DIR_DELIM "env_meta.txt")) {
669 infostream << "ServerEnvironment: Loading default environment metadata"
675 infostream << "ServerEnvironment: Loading environment metadata" << std::endl;
677 std::string path = m_path_world + DIR_DELIM "env_meta.txt";
679 // Open file and deserialize
680 std::ifstream is(path.c_str(), std::ios_base::binary);
682 infostream << "ServerEnvironment::loadMeta(): Failed to open "
683 << path << std::endl;
684 throw SerializationError("Couldn't load env meta");
689 if (!args.parseConfigLines(is, "EnvArgsEnd")) {
690 throw SerializationError("ServerEnvironment::loadMeta(): "
691 "EnvArgsEnd not found!");
695 m_game_time = args.getU64("game_time");
696 } catch (SettingNotFoundException &e) {
697 // Getting this is crucial, otherwise timestamps are useless
698 throw SerializationError("Couldn't load env meta game_time");
701 setTimeOfDay(args.exists("time_of_day") ?
702 // set day to early morning by default
703 args.getU64("time_of_day") : 5250);
705 m_last_clear_objects_time = args.exists("last_clear_objects_time") ?
706 // If missing, do as if clearObjects was never called
707 args.getU64("last_clear_objects_time") : 0;
709 std::string lbm_introduction_times;
711 u64 ver = args.getU64("lbm_introduction_times_version");
713 lbm_introduction_times = args.get("lbm_introduction_times");
715 infostream << "ServerEnvironment::loadMeta(): Non-supported"
716 << " introduction time version " << ver << std::endl;
718 } catch (SettingNotFoundException &e) {
719 // No problem, this is expected. Just continue with an empty string
721 m_lbm_mgr.loadIntroductionTimes(lbm_introduction_times, m_server, m_game_time);
723 m_day_count = args.exists("day_count") ?
724 args.getU64("day_count") : 0;
728 * called if env_meta.txt doesn't exist (e.g. new world)
730 void ServerEnvironment::loadDefaultMeta()
732 m_lbm_mgr.loadIntroductionTimes("", m_server, m_game_time);
737 ActiveBlockModifier *abm;
739 std::vector<content_t> required_neighbors;
740 bool check_required_neighbors; // false if required_neighbors is known to be empty
746 ServerEnvironment *m_env;
747 std::vector<std::vector<ActiveABM> *> m_aabms;
749 ABMHandler(std::vector<ABMWithState> &abms,
750 float dtime_s, ServerEnvironment *env,
756 const NodeDefManager *ndef = env->getGameDef()->ndef();
757 for (ABMWithState &abmws : abms) {
758 ActiveBlockModifier *abm = abmws.abm;
759 float trigger_interval = abm->getTriggerInterval();
760 if(trigger_interval < 0.001)
761 trigger_interval = 0.001;
762 float actual_interval = dtime_s;
764 abmws.timer += dtime_s;
765 if(abmws.timer < trigger_interval)
767 abmws.timer -= trigger_interval;
768 actual_interval = trigger_interval;
770 float chance = abm->getTriggerChance();
775 if (abm->getSimpleCatchUp()) {
776 float intervals = actual_interval / trigger_interval;
779 aabm.chance = chance / intervals;
783 aabm.chance = chance;
787 const std::vector<std::string> &required_neighbors_s =
788 abm->getRequiredNeighbors();
789 for (const std::string &required_neighbor_s : required_neighbors_s) {
790 ndef->getIds(required_neighbor_s, aabm.required_neighbors);
792 aabm.check_required_neighbors = !required_neighbors_s.empty();
795 const std::vector<std::string> &contents_s = abm->getTriggerContents();
796 for (const std::string &content_s : contents_s) {
797 std::vector<content_t> ids;
798 ndef->getIds(content_s, ids);
799 for (content_t c : ids) {
800 if (c >= m_aabms.size())
801 m_aabms.resize(c + 256, NULL);
803 m_aabms[c] = new std::vector<ActiveABM>;
804 m_aabms[c]->push_back(aabm);
812 for (auto &aabms : m_aabms)
816 // Find out how many objects the given block and its neighbours contain.
817 // Returns the number of objects in the block, and also in 'wider' the
818 // number of objects in the block and all its neighbours. The latter
819 // may an estimate if any neighbours are unloaded.
820 u32 countObjects(MapBlock *block, ServerMap * map, u32 &wider)
823 u32 wider_unknown_count = 0;
824 for(s16 x=-1; x<=1; x++)
825 for(s16 y=-1; y<=1; y++)
826 for(s16 z=-1; z<=1; z++)
828 MapBlock *block2 = map->getBlockNoCreateNoEx(
829 block->getPos() + v3s16(x,y,z));
831 wider_unknown_count++;
834 wider += block2->m_static_objects.m_active.size()
835 + block2->m_static_objects.m_stored.size();
838 u32 active_object_count = block->m_static_objects.m_active.size();
839 u32 wider_known_count = 3*3*3 - wider_unknown_count;
840 wider += wider_unknown_count * wider / wider_known_count;
841 return active_object_count;
844 void apply(MapBlock *block, int &blocks_scanned, int &abms_run, int &blocks_cached)
846 if(m_aabms.empty() || block->isDummy())
849 // Check the content type cache first
850 // to see whether there are any ABMs
851 // to be run at all for this block.
852 if (block->contents_cached) {
854 bool run_abms = false;
855 for (content_t c : block->contents) {
856 if (c < m_aabms.size() && m_aabms[c]) {
865 block->contents.clear();
869 ServerMap *map = &m_env->getServerMap();
871 u32 active_object_count_wider;
872 u32 active_object_count = this->countObjects(block, map, active_object_count_wider);
873 m_env->m_added_objects = 0;
876 for(p0.X=0; p0.X<MAP_BLOCKSIZE; p0.X++)
877 for(p0.Y=0; p0.Y<MAP_BLOCKSIZE; p0.Y++)
878 for(p0.Z=0; p0.Z<MAP_BLOCKSIZE; p0.Z++)
880 const MapNode &n = block->getNodeUnsafe(p0);
881 content_t c = n.getContent();
882 // Cache content types as we go
883 if (!block->contents_cached && !block->do_not_cache_contents) {
884 block->contents.insert(c);
885 if (block->contents.size() > 64) {
886 // Too many different nodes... don't try to cache
887 block->do_not_cache_contents = true;
888 block->contents.clear();
892 if (c >= m_aabms.size() || !m_aabms[c])
895 v3s16 p = p0 + block->getPosRelative();
896 for (ActiveABM &aabm : *m_aabms[c]) {
897 if (myrand() % aabm.chance != 0)
901 if (aabm.check_required_neighbors) {
903 for(p1.X = p0.X-1; p1.X <= p0.X+1; p1.X++)
904 for(p1.Y = p0.Y-1; p1.Y <= p0.Y+1; p1.Y++)
905 for(p1.Z = p0.Z-1; p1.Z <= p0.Z+1; p1.Z++)
910 if (block->isValidPosition(p1)) {
911 // if the neighbor is found on the same map block
912 // get it straight from there
913 const MapNode &n = block->getNodeUnsafe(p1);
916 // otherwise consult the map
917 MapNode n = map->getNode(p1 + block->getPosRelative());
920 if (CONTAINS(aabm.required_neighbors, c))
923 // No required neighbor found
929 // Call all the trigger variations
930 aabm.abm->trigger(m_env, p, n);
931 aabm.abm->trigger(m_env, p, n,
932 active_object_count, active_object_count_wider);
934 // Count surrounding objects again if the abms added any
935 if(m_env->m_added_objects > 0) {
936 active_object_count = countObjects(block, map, active_object_count_wider);
937 m_env->m_added_objects = 0;
941 block->contents_cached = !block->do_not_cache_contents;
945 void ServerEnvironment::activateBlock(MapBlock *block, u32 additional_dtime)
947 // Reset usage timer immediately, otherwise a block that becomes active
948 // again at around the same time as it would normally be unloaded will
949 // get unloaded incorrectly. (I think this still leaves a small possibility
950 // of a race condition between this and server::AsyncRunStep, which only
951 // some kind of synchronisation will fix, but it at least reduces the window
952 // of opportunity for it to break from seconds to nanoseconds)
953 block->resetUsageTimer();
955 // Get time difference
957 u32 stamp = block->getTimestamp();
958 if (m_game_time > stamp && stamp != BLOCK_TIMESTAMP_UNDEFINED)
959 dtime_s = m_game_time - stamp;
960 dtime_s += additional_dtime;
962 /*infostream<<"ServerEnvironment::activateBlock(): block timestamp: "
963 <<stamp<<", game time: "<<m_game_time<<std::endl;*/
965 // Remove stored static objects if clearObjects was called since block's timestamp
966 if (stamp == BLOCK_TIMESTAMP_UNDEFINED || stamp < m_last_clear_objects_time) {
967 block->m_static_objects.m_stored.clear();
968 // do not set changed flag to avoid unnecessary mapblock writes
971 // Set current time as timestamp
972 block->setTimestampNoChangedFlag(m_game_time);
974 /*infostream<<"ServerEnvironment::activateBlock(): block is "
975 <<dtime_s<<" seconds old."<<std::endl;*/
977 // Activate stored objects
978 activateObjects(block, dtime_s);
980 /* Handle LoadingBlockModifiers */
981 m_lbm_mgr.applyLBMs(this, block, stamp);
984 std::vector<NodeTimer> elapsed_timers =
985 block->m_node_timers.step((float)dtime_s);
986 if (!elapsed_timers.empty()) {
988 for (const NodeTimer &elapsed_timer : elapsed_timers) {
989 n = block->getNodeNoEx(elapsed_timer.position);
990 v3s16 p = elapsed_timer.position + block->getPosRelative();
991 if (m_script->node_on_timer(p, n, elapsed_timer.elapsed))
992 block->setNodeTimer(NodeTimer(elapsed_timer.timeout, 0,
993 elapsed_timer.position));
998 void ServerEnvironment::addActiveBlockModifier(ActiveBlockModifier *abm)
1000 m_abms.emplace_back(abm);
1003 void ServerEnvironment::addLoadingBlockModifierDef(LoadingBlockModifierDef *lbm)
1005 m_lbm_mgr.addLBMDef(lbm);
1008 bool ServerEnvironment::setNode(v3s16 p, const MapNode &n)
1010 const NodeDefManager *ndef = m_server->ndef();
1011 MapNode n_old = m_map->getNode(p);
1013 const ContentFeatures &cf_old = ndef->get(n_old);
1016 if (cf_old.has_on_destruct)
1017 m_script->node_on_destruct(p, n_old);
1020 if (!m_map->addNodeWithEvent(p, n))
1023 // Update active VoxelManipulator if a mapgen thread
1024 m_map->updateVManip(p);
1026 // Call post-destructor
1027 if (cf_old.has_after_destruct)
1028 m_script->node_after_destruct(p, n_old);
1030 // Retrieve node content features
1031 // if new node is same as old, reuse old definition to prevent a lookup
1032 const ContentFeatures &cf_new = n_old == n ? cf_old : ndef->get(n);
1035 if (cf_new.has_on_construct)
1036 m_script->node_on_construct(p, n);
1041 bool ServerEnvironment::removeNode(v3s16 p)
1043 const NodeDefManager *ndef = m_server->ndef();
1044 MapNode n_old = m_map->getNode(p);
1047 if (ndef->get(n_old).has_on_destruct)
1048 m_script->node_on_destruct(p, n_old);
1051 // This is slightly optimized compared to addNodeWithEvent(air)
1052 if (!m_map->removeNodeWithEvent(p))
1055 // Update active VoxelManipulator if a mapgen thread
1056 m_map->updateVManip(p);
1058 // Call post-destructor
1059 if (ndef->get(n_old).has_after_destruct)
1060 m_script->node_after_destruct(p, n_old);
1062 // Air doesn't require constructor
1066 bool ServerEnvironment::swapNode(v3s16 p, const MapNode &n)
1068 if (!m_map->addNodeWithEvent(p, n, false))
1071 // Update active VoxelManipulator if a mapgen thread
1072 m_map->updateVManip(p);
1077 void ServerEnvironment::clearObjects(ClearObjectsMode mode)
1079 infostream << "ServerEnvironment::clearObjects(): "
1080 << "Removing all active objects" << std::endl;
1081 auto cb_removal = [this] (ServerActiveObject *obj, u16 id) {
1082 if (obj->getType() == ACTIVEOBJECT_TYPE_PLAYER)
1085 // Delete static object if block is loaded
1086 deleteStaticFromBlock(obj, id, MOD_REASON_CLEAR_ALL_OBJECTS, true);
1088 // If known by some client, don't delete immediately
1089 if (obj->m_known_by_count > 0) {
1090 obj->m_pending_removal = true;
1094 // Tell the object about removal
1095 obj->removingFromEnvironment();
1096 // Deregister in scripting api
1097 m_script->removeObjectReference(obj);
1099 // Delete active object
1100 if (obj->environmentDeletes())
1106 m_ao_manager.clear(cb_removal);
1108 // Get list of loaded blocks
1109 std::vector<v3s16> loaded_blocks;
1110 infostream << "ServerEnvironment::clearObjects(): "
1111 << "Listing all loaded blocks" << std::endl;
1112 m_map->listAllLoadedBlocks(loaded_blocks);
1113 infostream << "ServerEnvironment::clearObjects(): "
1114 << "Done listing all loaded blocks: "
1115 << loaded_blocks.size()<<std::endl;
1117 // Get list of loadable blocks
1118 std::vector<v3s16> loadable_blocks;
1119 if (mode == CLEAR_OBJECTS_MODE_FULL) {
1120 infostream << "ServerEnvironment::clearObjects(): "
1121 << "Listing all loadable blocks" << std::endl;
1122 m_map->listAllLoadableBlocks(loadable_blocks);
1123 infostream << "ServerEnvironment::clearObjects(): "
1124 << "Done listing all loadable blocks: "
1125 << loadable_blocks.size() << std::endl;
1127 loadable_blocks = loaded_blocks;
1130 actionstream << "ServerEnvironment::clearObjects(): "
1131 << "Now clearing objects in " << loadable_blocks.size()
1132 << " blocks" << std::endl;
1134 // Grab a reference on each loaded block to avoid unloading it
1135 for (v3s16 p : loaded_blocks) {
1136 MapBlock *block = m_map->getBlockNoCreateNoEx(p);
1137 assert(block != NULL);
1141 // Remove objects in all loadable blocks
1142 u32 unload_interval = U32_MAX;
1143 if (mode == CLEAR_OBJECTS_MODE_FULL) {
1144 unload_interval = g_settings->getS32("max_clearobjects_extra_loaded_blocks");
1145 unload_interval = MYMAX(unload_interval, 1);
1147 u32 report_interval = loadable_blocks.size() / 10;
1148 u32 num_blocks_checked = 0;
1149 u32 num_blocks_cleared = 0;
1150 u32 num_objs_cleared = 0;
1151 for (auto i = loadable_blocks.begin();
1152 i != loadable_blocks.end(); ++i) {
1154 MapBlock *block = m_map->emergeBlock(p, false);
1156 errorstream << "ServerEnvironment::clearObjects(): "
1157 << "Failed to emerge block " << PP(p) << std::endl;
1160 u32 num_stored = block->m_static_objects.m_stored.size();
1161 u32 num_active = block->m_static_objects.m_active.size();
1162 if (num_stored != 0 || num_active != 0) {
1163 block->m_static_objects.m_stored.clear();
1164 block->m_static_objects.m_active.clear();
1165 block->raiseModified(MOD_STATE_WRITE_NEEDED,
1166 MOD_REASON_CLEAR_ALL_OBJECTS);
1167 num_objs_cleared += num_stored + num_active;
1168 num_blocks_cleared++;
1170 num_blocks_checked++;
1172 if (report_interval != 0 &&
1173 num_blocks_checked % report_interval == 0) {
1174 float percent = 100.0 * (float)num_blocks_checked /
1175 loadable_blocks.size();
1176 actionstream << "ServerEnvironment::clearObjects(): "
1177 << "Cleared " << num_objs_cleared << " objects"
1178 << " in " << num_blocks_cleared << " blocks ("
1179 << percent << "%)" << std::endl;
1181 if (num_blocks_checked % unload_interval == 0) {
1182 m_map->unloadUnreferencedBlocks();
1185 m_map->unloadUnreferencedBlocks();
1187 // Drop references that were added above
1188 for (v3s16 p : loaded_blocks) {
1189 MapBlock *block = m_map->getBlockNoCreateNoEx(p);
1194 m_last_clear_objects_time = m_game_time;
1196 actionstream << "ServerEnvironment::clearObjects(): "
1197 << "Finished: Cleared " << num_objs_cleared << " objects"
1198 << " in " << num_blocks_cleared << " blocks" << std::endl;
1201 void ServerEnvironment::step(float dtime)
1203 /* Step time of day */
1204 stepTimeOfDay(dtime);
1207 // NOTE: This is kind of funny on a singleplayer game, but doesn't
1208 // really matter that much.
1209 static thread_local const float server_step =
1210 g_settings->getFloat("dedicated_server_step");
1211 m_recommended_send_interval = server_step;
1217 m_game_time_fraction_counter += dtime;
1218 u32 inc_i = (u32)m_game_time_fraction_counter;
1219 m_game_time += inc_i;
1220 m_game_time_fraction_counter -= (float)inc_i;
1227 ScopeProfiler sp(g_profiler, "SEnv: handle players avg", SPT_AVG);
1228 for (RemotePlayer *player : m_players) {
1229 // Ignore disconnected players
1230 if (player->getPeerId() == PEER_ID_INEXISTENT)
1234 player->move(dtime, this, 100 * BS);
1239 Manage active block list
1241 if (m_active_blocks_management_interval.step(dtime, m_cache_active_block_mgmt_interval)) {
1242 ScopeProfiler sp(g_profiler, "SEnv: manage act. block list avg per interval", SPT_AVG);
1244 Get player block positions
1246 std::vector<PlayerSAO*> players;
1247 for (RemotePlayer *player: m_players) {
1248 // Ignore disconnected players
1249 if (player->getPeerId() == PEER_ID_INEXISTENT)
1252 PlayerSAO *playersao = player->getPlayerSAO();
1255 players.push_back(playersao);
1259 Update list of active blocks, collecting changes
1261 // use active_object_send_range_blocks since that is max distance
1262 // for active objects sent the client anyway
1263 static thread_local const s16 active_object_range =
1264 g_settings->getS16("active_object_send_range_blocks");
1265 static thread_local const s16 active_block_range =
1266 g_settings->getS16("active_block_range");
1267 std::set<v3s16> blocks_removed;
1268 std::set<v3s16> blocks_added;
1269 m_active_blocks.update(players, active_block_range, active_object_range,
1270 blocks_removed, blocks_added);
1273 Handle removed blocks
1276 // Convert active objects that are no more in active blocks to static
1277 deactivateFarObjects(false);
1279 for (const v3s16 &p: blocks_removed) {
1280 MapBlock *block = m_map->getBlockNoCreateNoEx(p);
1284 // Set current time as timestamp (and let it set ChangedFlag)
1285 block->setTimestamp(m_game_time);
1292 for (const v3s16 &p: blocks_added) {
1293 MapBlock *block = m_map->getBlockOrEmerge(p);
1295 m_active_blocks.m_list.erase(p);
1296 m_active_blocks.m_abm_list.erase(p);
1300 activateBlock(block);
1305 Mess around in active blocks
1307 if (m_active_blocks_nodemetadata_interval.step(dtime, m_cache_nodetimer_interval)) {
1308 ScopeProfiler sp(g_profiler, "SEnv: mess in act. blocks avg per interval", SPT_AVG);
1310 float dtime = m_cache_nodetimer_interval;
1312 for (const v3s16 &p: m_active_blocks.m_list) {
1313 MapBlock *block = m_map->getBlockNoCreateNoEx(p);
1317 // Reset block usage timer
1318 block->resetUsageTimer();
1320 // Set current time as timestamp
1321 block->setTimestampNoChangedFlag(m_game_time);
1322 // If time has changed much from the one on disk,
1323 // set block to be saved when it is unloaded
1324 if(block->getTimestamp() > block->getDiskTimestamp() + 60)
1325 block->raiseModified(MOD_STATE_WRITE_AT_UNLOAD,
1326 MOD_REASON_BLOCK_EXPIRED);
1329 std::vector<NodeTimer> elapsed_timers = block->m_node_timers.step(dtime);
1330 if (!elapsed_timers.empty()) {
1333 for (const NodeTimer &elapsed_timer: elapsed_timers) {
1334 n = block->getNodeNoEx(elapsed_timer.position);
1335 p2 = elapsed_timer.position + block->getPosRelative();
1336 if (m_script->node_on_timer(p2, n, elapsed_timer.elapsed)) {
1337 block->setNodeTimer(NodeTimer(
1338 elapsed_timer.timeout, 0, elapsed_timer.position));
1345 if (m_active_block_modifier_interval.step(dtime, m_cache_abm_interval)) {
1346 ScopeProfiler sp(g_profiler, "SEnv: modify in blocks avg per interval", SPT_AVG);
1347 TimeTaker timer("modify in active blocks per interval");
1349 // Initialize handling of ActiveBlockModifiers
1350 ABMHandler abmhandler(m_abms, m_cache_abm_interval, this, true);
1352 int blocks_scanned = 0;
1354 int blocks_cached = 0;
1356 std::vector<v3s16> output(m_active_blocks.m_abm_list.size());
1358 // Shuffle the active blocks so that each block gets an equal chance
1359 // of having its ABMs run.
1360 std::copy(m_active_blocks.m_abm_list.begin(), m_active_blocks.m_abm_list.end(), output.begin());
1361 std::shuffle(output.begin(), output.end(), m_rgen);
1364 // The time budget for ABMs is 20%.
1365 u32 max_time_ms = m_cache_abm_interval * 1000 / 5;
1366 for (const v3s16 &p : output) {
1367 MapBlock *block = m_map->getBlockNoCreateNoEx(p);
1373 // Set current time as timestamp
1374 block->setTimestampNoChangedFlag(m_game_time);
1376 /* Handle ActiveBlockModifiers */
1377 abmhandler.apply(block, blocks_scanned, abms_run, blocks_cached);
1379 u32 time_ms = timer.getTimerTime();
1381 if (time_ms > max_time_ms) {
1382 warningstream << "active block modifiers took "
1383 << time_ms << "ms (processed " << i << " of "
1384 << output.size() << " active blocks)" << std::endl;
1388 g_profiler->avg("SEnv: active blocks", m_active_blocks.m_abm_list.size());
1389 g_profiler->avg("SEnv: active blocks cached", blocks_cached);
1390 g_profiler->avg("SEnv: active blocks scanned for ABMs", blocks_scanned);
1391 g_profiler->avg("SEnv: ABMs run", abms_run);
1397 Step script environment (run global on_step())
1399 m_script->environment_Step(dtime);
1405 ScopeProfiler sp(g_profiler, "SEnv: step act. objs avg", SPT_AVG);
1407 // This helps the objects to send data at the same time
1408 bool send_recommended = false;
1409 m_send_recommended_timer += dtime;
1410 if (m_send_recommended_timer > getSendRecommendedInterval()) {
1411 m_send_recommended_timer -= getSendRecommendedInterval();
1412 send_recommended = true;
1415 auto cb_state = [this, dtime, send_recommended] (ServerActiveObject *obj) {
1420 obj->step(dtime, send_recommended);
1421 // Read messages from object
1422 while (!obj->m_messages_out.empty()) {
1423 this->m_active_object_messages.push(obj->m_messages_out.front());
1424 obj->m_messages_out.pop();
1427 m_ao_manager.step(dtime, cb_state);
1431 Manage active objects
1433 if (m_object_management_interval.step(dtime, 0.5)) {
1434 ScopeProfiler sp(g_profiler, "SEnv: remove removed objs avg /.5s", SPT_AVG);
1435 removeRemovedObjects();
1439 Manage particle spawner expiration
1441 if (m_particle_management_interval.step(dtime, 1.0)) {
1442 for (std::unordered_map<u32, float>::iterator i = m_particle_spawners.begin();
1443 i != m_particle_spawners.end(); ) {
1444 //non expiring spawners
1445 if (i->second == PARTICLE_SPAWNER_NO_EXPIRY) {
1451 if (i->second <= 0.f)
1452 m_particle_spawners.erase(i++);
1459 u32 ServerEnvironment::addParticleSpawner(float exptime)
1461 // Timers with lifetime 0 do not expire
1462 float time = exptime > 0.f ? exptime : PARTICLE_SPAWNER_NO_EXPIRY;
1465 for (;;) { // look for unused particlespawner id
1467 std::unordered_map<u32, float>::iterator f = m_particle_spawners.find(id);
1468 if (f == m_particle_spawners.end()) {
1469 m_particle_spawners[id] = time;
1476 u32 ServerEnvironment::addParticleSpawner(float exptime, u16 attached_id)
1478 u32 id = addParticleSpawner(exptime);
1479 m_particle_spawner_attachments[id] = attached_id;
1480 if (ServerActiveObject *obj = getActiveObject(attached_id)) {
1481 obj->attachParticleSpawner(id);
1486 void ServerEnvironment::deleteParticleSpawner(u32 id, bool remove_from_object)
1488 m_particle_spawners.erase(id);
1489 const auto &it = m_particle_spawner_attachments.find(id);
1490 if (it != m_particle_spawner_attachments.end()) {
1491 u16 obj_id = it->second;
1492 ServerActiveObject *sao = getActiveObject(obj_id);
1493 if (sao != NULL && remove_from_object) {
1494 sao->detachParticleSpawner(id);
1496 m_particle_spawner_attachments.erase(id);
1500 u16 ServerEnvironment::addActiveObject(ServerActiveObject *object)
1502 assert(object); // Pre-condition
1504 u16 id = addActiveObjectRaw(object, true, 0);
1509 Finds out what new objects have been added to
1510 inside a radius around a position
1512 void ServerEnvironment::getAddedActiveObjects(PlayerSAO *playersao, s16 radius,
1514 std::set<u16> ¤t_objects,
1515 std::queue<u16> &added_objects)
1517 f32 radius_f = radius * BS;
1518 f32 player_radius_f = player_radius * BS;
1520 if (player_radius_f < 0.0f)
1521 player_radius_f = 0.0f;
1523 m_ao_manager.getAddedActiveObjectsAroundPos(playersao->getBasePosition(), radius_f,
1524 player_radius_f, current_objects, added_objects);
1528 Finds out what objects have been removed from
1529 inside a radius around a position
1531 void ServerEnvironment::getRemovedActiveObjects(PlayerSAO *playersao, s16 radius,
1533 std::set<u16> ¤t_objects,
1534 std::queue<u16> &removed_objects)
1536 f32 radius_f = radius * BS;
1537 f32 player_radius_f = player_radius * BS;
1539 if (player_radius_f < 0)
1540 player_radius_f = 0;
1542 Go through current_objects; object is removed if:
1543 - object is not found in m_active_objects (this is actually an
1544 error condition; objects should be removed only after all clients
1545 have been informed about removal), or
1546 - object is to be removed or deactivated, or
1547 - object is too far away
1549 for (u16 id : current_objects) {
1550 ServerActiveObject *object = getActiveObject(id);
1552 if (object == NULL) {
1553 infostream << "ServerEnvironment::getRemovedActiveObjects():"
1554 << " object in current_objects is NULL" << std::endl;
1555 removed_objects.push(id);
1559 if (object->isGone()) {
1560 removed_objects.push(id);
1564 f32 distance_f = object->getBasePosition().getDistanceFrom(playersao->getBasePosition());
1565 if (object->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
1566 if (distance_f <= player_radius_f || player_radius_f == 0)
1568 } else if (distance_f <= radius_f)
1571 // Object is no longer visible
1572 removed_objects.push(id);
1576 void ServerEnvironment::setStaticForActiveObjectsInBlock(
1577 v3s16 blockpos, bool static_exists, v3s16 static_block)
1579 MapBlock *block = m_map->getBlockNoCreateNoEx(blockpos);
1583 for (auto &so_it : block->m_static_objects.m_active) {
1584 // Get the ServerActiveObject counterpart to this StaticObject
1585 ServerActiveObject *sao = m_ao_manager.getActiveObject(so_it.first);
1587 // If this ever happens, there must be some kind of nasty bug.
1588 errorstream << "ServerEnvironment::setStaticForObjectsInBlock(): "
1589 "Object from MapBlock::m_static_objects::m_active not found "
1590 "in m_active_objects";
1594 sao->m_static_exists = static_exists;
1595 sao->m_static_block = static_block;
1599 ActiveObjectMessage ServerEnvironment::getActiveObjectMessage()
1601 if(m_active_object_messages.empty())
1602 return ActiveObjectMessage(0);
1604 ActiveObjectMessage message = m_active_object_messages.front();
1605 m_active_object_messages.pop();
1609 void ServerEnvironment::getSelectedActiveObjects(
1610 const core::line3d<f32> &shootline_on_map,
1611 std::vector<PointedThing> &objects)
1613 std::vector<u16> objectIds;
1614 getObjectsInsideRadius(objectIds, shootline_on_map.start,
1615 shootline_on_map.getLength() + 10.0f);
1616 const v3f line_vector = shootline_on_map.getVector();
1618 for (u16 objectId : objectIds) {
1619 ServerActiveObject* obj = getActiveObject(objectId);
1621 aabb3f selection_box;
1622 if (!obj->getSelectionBox(&selection_box))
1625 v3f pos = obj->getBasePosition();
1627 aabb3f offsetted_box(selection_box.MinEdge + pos,
1628 selection_box.MaxEdge + pos);
1630 v3f current_intersection;
1631 v3s16 current_normal;
1632 if (boxLineCollision(offsetted_box, shootline_on_map.start, line_vector,
1633 ¤t_intersection, ¤t_normal)) {
1634 objects.emplace_back(
1635 (s16) objectId, current_intersection, current_normal,
1636 (current_intersection - shootline_on_map.start).getLengthSQ());
1642 ************ Private methods *************
1645 u16 ServerEnvironment::addActiveObjectRaw(ServerActiveObject *object,
1646 bool set_changed, u32 dtime_s)
1648 if (!m_ao_manager.registerObject(object)) {
1652 // Register reference in scripting api (must be done before post-init)
1653 m_script->addObjectReference(object);
1654 // Post-initialize object
1655 object->addedToEnvironment(dtime_s);
1657 // Add static data to block
1658 if (object->isStaticAllowed()) {
1659 // Add static object to active static list of the block
1660 v3f objectpos = object->getBasePosition();
1661 StaticObject s_obj(object, objectpos);
1662 // Add to the block where the object is located in
1663 v3s16 blockpos = getNodeBlockPos(floatToInt(objectpos, BS));
1664 MapBlock *block = m_map->emergeBlock(blockpos);
1666 block->m_static_objects.m_active[object->getId()] = s_obj;
1667 object->m_static_exists = true;
1668 object->m_static_block = blockpos;
1671 block->raiseModified(MOD_STATE_WRITE_NEEDED,
1672 MOD_REASON_ADD_ACTIVE_OBJECT_RAW);
1674 v3s16 p = floatToInt(objectpos, BS);
1675 errorstream<<"ServerEnvironment::addActiveObjectRaw(): "
1676 <<"could not emerge block for storing id="<<object->getId()
1677 <<" statically (pos="<<PP(p)<<")"<<std::endl;
1681 return object->getId();
1685 Remove objects that satisfy (isGone() && m_known_by_count==0)
1687 void ServerEnvironment::removeRemovedObjects()
1689 auto clear_cb = [this] (ServerActiveObject *obj, u16 id) {
1690 // This shouldn't happen but check it
1692 errorstream << "ServerEnvironment::removeRemovedObjects(): "
1693 << "NULL object found. id=" << id << std::endl;
1698 We will handle objects marked for removal or deactivation
1704 Delete static data from block if removed
1706 if (obj->m_pending_removal)
1707 deleteStaticFromBlock(obj, id, MOD_REASON_REMOVE_OBJECTS_REMOVE, false);
1709 // If still known by clients, don't actually remove. On some future
1710 // invocation this will be 0, which is when removal will continue.
1711 if(obj->m_known_by_count > 0)
1715 Move static data from active to stored if deactivated
1717 if (!obj->m_pending_removal && obj->m_static_exists) {
1718 MapBlock *block = m_map->emergeBlock(obj->m_static_block, false);
1720 const auto i = block->m_static_objects.m_active.find(id);
1721 if (i != block->m_static_objects.m_active.end()) {
1722 block->m_static_objects.m_stored.push_back(i->second);
1723 block->m_static_objects.m_active.erase(id);
1724 block->raiseModified(MOD_STATE_WRITE_NEEDED,
1725 MOD_REASON_REMOVE_OBJECTS_DEACTIVATE);
1727 warningstream << "ServerEnvironment::removeRemovedObjects(): "
1728 << "id=" << id << " m_static_exists=true but "
1729 << "static data doesn't actually exist in "
1730 << PP(obj->m_static_block) << std::endl;
1733 infostream << "Failed to emerge block from which an object to "
1734 << "be deactivated was loaded from. id=" << id << std::endl;
1738 // Tell the object about removal
1739 obj->removingFromEnvironment();
1740 // Deregister in scripting api
1741 m_script->removeObjectReference(obj);
1744 if (obj->environmentDeletes())
1750 m_ao_manager.clear(clear_cb);
1753 static void print_hexdump(std::ostream &o, const std::string &data)
1755 const int linelength = 16;
1756 for(int l=0; ; l++){
1757 int i0 = linelength * l;
1758 bool at_end = false;
1759 int thislinelength = linelength;
1760 if(i0 + thislinelength > (int)data.size()){
1761 thislinelength = data.size() - i0;
1764 for(int di=0; di<linelength; di++){
1767 if(di<thislinelength)
1768 porting::mt_snprintf(buf, sizeof(buf), "%.2x ", data[i]);
1770 porting::mt_snprintf(buf, sizeof(buf), " ");
1774 for(int di=0; di<thislinelength; di++){
1788 Convert stored objects from blocks near the players to active.
1790 void ServerEnvironment::activateObjects(MapBlock *block, u32 dtime_s)
1795 // Ignore if no stored objects (to not set changed flag)
1796 if(block->m_static_objects.m_stored.empty())
1799 verbosestream<<"ServerEnvironment::activateObjects(): "
1800 <<"activating objects of block "<<PP(block->getPos())
1801 <<" ("<<block->m_static_objects.m_stored.size()
1802 <<" objects)"<<std::endl;
1803 bool large_amount = (block->m_static_objects.m_stored.size() > g_settings->getU16("max_objects_per_block"));
1805 errorstream<<"suspiciously large amount of objects detected: "
1806 <<block->m_static_objects.m_stored.size()<<" in "
1807 <<PP(block->getPos())
1808 <<"; removing all of them."<<std::endl;
1809 // Clear stored list
1810 block->m_static_objects.m_stored.clear();
1811 block->raiseModified(MOD_STATE_WRITE_NEEDED,
1812 MOD_REASON_TOO_MANY_OBJECTS);
1816 // Activate stored objects
1817 std::vector<StaticObject> new_stored;
1818 for (const StaticObject &s_obj : block->m_static_objects.m_stored) {
1819 // Create an active object from the data
1820 ServerActiveObject *obj = ServerActiveObject::create
1821 ((ActiveObjectType) s_obj.type, this, 0, s_obj.pos, s_obj.data);
1822 // If couldn't create object, store static data back.
1824 errorstream<<"ServerEnvironment::activateObjects(): "
1825 <<"failed to create active object from static object "
1826 <<"in block "<<PP(s_obj.pos/BS)
1827 <<" type="<<(int)s_obj.type<<" data:"<<std::endl;
1828 print_hexdump(verbosestream, s_obj.data);
1830 new_stored.push_back(s_obj);
1833 verbosestream<<"ServerEnvironment::activateObjects(): "
1834 <<"activated static object pos="<<PP(s_obj.pos/BS)
1835 <<" type="<<(int)s_obj.type<<std::endl;
1836 // This will also add the object to the active static list
1837 addActiveObjectRaw(obj, false, dtime_s);
1840 // Clear stored list
1841 block->m_static_objects.m_stored.clear();
1842 // Add leftover failed stuff to stored list
1843 for (const StaticObject &s_obj : new_stored) {
1844 block->m_static_objects.m_stored.push_back(s_obj);
1848 Note: Block hasn't really been modified here.
1849 The objects have just been activated and moved from the stored
1850 static list to the active static list.
1851 As such, the block is essentially the same.
1852 Thus, do not call block->raiseModified(MOD_STATE_WRITE_NEEDED).
1853 Otherwise there would be a huge amount of unnecessary I/O.
1858 Convert objects that are not standing inside active blocks to static.
1860 If m_known_by_count != 0, active object is not deleted, but static
1861 data is still updated.
1863 If force_delete is set, active object is deleted nevertheless. It
1864 shall only be set so in the destructor of the environment.
1866 If block wasn't generated (not in memory or on disk),
1868 void ServerEnvironment::deactivateFarObjects(bool _force_delete)
1870 auto cb_deactivate = [this, _force_delete] (ServerActiveObject *obj, u16 id) {
1871 // force_delete might be overriden per object
1872 bool force_delete = _force_delete;
1874 // Do not deactivate if static data creation not allowed
1875 if (!force_delete && !obj->isStaticAllowed())
1878 // removeRemovedObjects() is responsible for these
1879 if (!force_delete && obj->isGone())
1882 const v3f &objectpos = obj->getBasePosition();
1884 // The block in which the object resides in
1885 v3s16 blockpos_o = getNodeBlockPos(floatToInt(objectpos, BS));
1887 // If object's static data is stored in a deactivated block and object
1888 // is actually located in an active block, re-save to the block in
1889 // which the object is actually located in.
1890 if (!force_delete && obj->m_static_exists &&
1891 !m_active_blocks.contains(obj->m_static_block) &&
1892 m_active_blocks.contains(blockpos_o)) {
1893 // Delete from block where object was located
1894 deleteStaticFromBlock(obj, id, MOD_REASON_STATIC_DATA_REMOVED, false);
1896 StaticObject s_obj(obj, objectpos);
1897 // Save to block where object is located
1898 saveStaticToBlock(blockpos_o, id, obj, s_obj, MOD_REASON_STATIC_DATA_ADDED);
1903 // If block is still active, don't remove
1904 if (!force_delete && m_active_blocks.contains(blockpos_o))
1907 verbosestream << "ServerEnvironment::deactivateFarObjects(): "
1908 << "deactivating object id=" << id << " on inactive block "
1909 << PP(blockpos_o) << std::endl;
1911 // If known by some client, don't immediately delete.
1912 bool pending_delete = (obj->m_known_by_count > 0 && !force_delete);
1915 Update the static data
1917 if (obj->isStaticAllowed()) {
1918 // Create new static object
1919 StaticObject s_obj(obj, objectpos);
1921 bool stays_in_same_block = false;
1922 bool data_changed = true;
1924 // Check if static data has changed considerably
1925 if (obj->m_static_exists) {
1926 if (obj->m_static_block == blockpos_o)
1927 stays_in_same_block = true;
1929 MapBlock *block = m_map->emergeBlock(obj->m_static_block, false);
1932 const auto n = block->m_static_objects.m_active.find(id);
1933 if (n != block->m_static_objects.m_active.end()) {
1934 StaticObject static_old = n->second;
1936 float save_movem = obj->getMinimumSavedMovement();
1938 if (static_old.data == s_obj.data &&
1939 (static_old.pos - objectpos).getLength() < save_movem)
1940 data_changed = false;
1942 warningstream << "ServerEnvironment::deactivateFarObjects(): "
1943 << "id=" << id << " m_static_exists=true but "
1944 << "static data doesn't actually exist in "
1945 << PP(obj->m_static_block) << std::endl;
1951 While changes are always saved, blocks are only marked as modified
1952 if the object has moved or different staticdata. (see above)
1954 bool shall_be_written = (!stays_in_same_block || data_changed);
1955 u32 reason = shall_be_written ? MOD_REASON_STATIC_DATA_CHANGED : MOD_REASON_UNKNOWN;
1957 // Delete old static object
1958 deleteStaticFromBlock(obj, id, reason, false);
1960 // Add to the block where the object is located in
1961 v3s16 blockpos = getNodeBlockPos(floatToInt(objectpos, BS));
1962 u16 store_id = pending_delete ? id : 0;
1963 if (!saveStaticToBlock(blockpos, store_id, obj, s_obj, reason))
1964 force_delete = true;
1968 If known by some client, set pending deactivation.
1969 Otherwise delete it immediately.
1971 if (pending_delete && !force_delete) {
1972 verbosestream << "ServerEnvironment::deactivateFarObjects(): "
1973 << "object id=" << id << " is known by clients"
1974 << "; not deleting yet" << std::endl;
1976 obj->m_pending_deactivation = true;
1980 verbosestream << "ServerEnvironment::deactivateFarObjects(): "
1981 << "object id=" << id << " is not known by clients"
1982 << "; deleting" << std::endl;
1984 // Tell the object about removal
1985 obj->removingFromEnvironment();
1986 // Deregister in scripting api
1987 m_script->removeObjectReference(obj);
1989 // Delete active object
1990 if (obj->environmentDeletes())
1996 m_ao_manager.clear(cb_deactivate);
1999 void ServerEnvironment::deleteStaticFromBlock(
2000 ServerActiveObject *obj, u16 id, u32 mod_reason, bool no_emerge)
2002 if (!obj->m_static_exists)
2007 block = m_map->getBlockNoCreateNoEx(obj->m_static_block);
2009 block = m_map->emergeBlock(obj->m_static_block, false);
2012 errorstream << "ServerEnv: Failed to emerge block " << PP(obj->m_static_block)
2013 << " when deleting static data of object from it. id=" << id << std::endl;
2017 block->m_static_objects.remove(id);
2018 if (mod_reason != MOD_REASON_UNKNOWN) // Do not mark as modified if requested
2019 block->raiseModified(MOD_STATE_WRITE_NEEDED, mod_reason);
2021 obj->m_static_exists = false;
2024 bool ServerEnvironment::saveStaticToBlock(
2025 v3s16 blockpos, u16 store_id,
2026 ServerActiveObject *obj, const StaticObject &s_obj,
2029 MapBlock *block = nullptr;
2031 block = m_map->emergeBlock(blockpos);
2032 } catch (InvalidPositionException &e) {
2033 // Handled via NULL pointer
2034 // NOTE: emergeBlock's failure is usually determined by it
2035 // actually returning NULL
2039 errorstream << "ServerEnv: Failed to emerge block " << PP(obj->m_static_block)
2040 << " when saving static data of object to it. id=" << store_id << std::endl;
2043 if (block->m_static_objects.m_stored.size() >= g_settings->getU16("max_objects_per_block")) {
2044 warningstream << "ServerEnv: Trying to store id = " << store_id
2045 << " statically but block " << PP(blockpos)
2046 << " already contains "
2047 << block->m_static_objects.m_stored.size()
2048 << " objects." << std::endl;
2052 block->m_static_objects.insert(store_id, s_obj);
2053 if (mod_reason != MOD_REASON_UNKNOWN) // Do not mark as modified if requested
2054 block->raiseModified(MOD_STATE_WRITE_NEEDED, mod_reason);
2056 obj->m_static_exists = true;
2057 obj->m_static_block = blockpos;
2062 PlayerDatabase *ServerEnvironment::openPlayerDatabase(const std::string &name,
2063 const std::string &savedir, const Settings &conf)
2066 if (name == "sqlite3")
2067 return new PlayerDatabaseSQLite3(savedir);
2069 if (name == "dummy")
2070 return new Database_Dummy();
2072 if (name == "postgresql") {
2073 std::string connect_string;
2074 conf.getNoEx("pgsql_player_connection", connect_string);
2075 return new PlayerDatabasePostgreSQL(connect_string);
2078 if (name == "files")
2079 return new PlayerDatabaseFiles(savedir + DIR_DELIM + "players");
2081 throw BaseException(std::string("Database backend ") + name + " not supported.");
2084 bool ServerEnvironment::migratePlayersDatabase(const GameParams &game_params,
2085 const Settings &cmd_args)
2087 std::string migrate_to = cmd_args.get("migrate-players");
2089 std::string world_mt_path = game_params.world_path + DIR_DELIM + "world.mt";
2090 if (!world_mt.readConfigFile(world_mt_path.c_str())) {
2091 errorstream << "Cannot read world.mt!" << std::endl;
2095 if (!world_mt.exists("player_backend")) {
2096 errorstream << "Please specify your current backend in world.mt:"
2098 << " player_backend = {files|sqlite3|postgresql}"
2103 std::string backend = world_mt.get("player_backend");
2104 if (backend == migrate_to) {
2105 errorstream << "Cannot migrate: new backend is same"
2106 << " as the old one" << std::endl;
2110 const std::string players_backup_path = game_params.world_path + DIR_DELIM
2113 if (backend == "files") {
2114 // Create backup directory
2115 fs::CreateDir(players_backup_path);
2119 PlayerDatabase *srcdb = ServerEnvironment::openPlayerDatabase(backend,
2120 game_params.world_path, world_mt);
2121 PlayerDatabase *dstdb = ServerEnvironment::openPlayerDatabase(migrate_to,
2122 game_params.world_path, world_mt);
2124 std::vector<std::string> player_list;
2125 srcdb->listPlayers(player_list);
2126 for (std::vector<std::string>::const_iterator it = player_list.begin();
2127 it != player_list.end(); ++it) {
2128 actionstream << "Migrating player " << it->c_str() << std::endl;
2129 RemotePlayer player(it->c_str(), NULL);
2130 PlayerSAO playerSAO(NULL, &player, 15000, false);
2132 srcdb->loadPlayer(&player, &playerSAO);
2134 playerSAO.finalize(&player, std::set<std::string>());
2135 player.setPlayerSAO(&playerSAO);
2137 dstdb->savePlayer(&player);
2139 // For files source, move player files to backup dir
2140 if (backend == "files") {
2142 game_params.world_path + DIR_DELIM + "players" + DIR_DELIM + (*it),
2143 players_backup_path + DIR_DELIM + (*it));
2147 actionstream << "Successfully migrated " << player_list.size() << " players"
2149 world_mt.set("player_backend", migrate_to);
2150 if (!world_mt.updateConfigFile(world_mt_path.c_str()))
2151 errorstream << "Failed to update world.mt!" << std::endl;
2153 actionstream << "world.mt updated" << std::endl;
2155 // When migration is finished from file backend, remove players directory if empty
2156 if (backend == "files") {
2157 fs::DeleteSingleFileOrEmptyDirectory(game_params.world_path + DIR_DELIM
2164 } catch (BaseException &e) {
2165 errorstream << "An error occurred during migration: " << e.what() << std::endl;
2171 AuthDatabase *ServerEnvironment::openAuthDatabase(
2172 const std::string &name, const std::string &savedir, const Settings &conf)
2174 if (name == "sqlite3")
2175 return new AuthDatabaseSQLite3(savedir);
2177 if (name == "files")
2178 return new AuthDatabaseFiles(savedir);
2180 throw BaseException(std::string("Database backend ") + name + " not supported.");
2183 bool ServerEnvironment::migrateAuthDatabase(
2184 const GameParams &game_params, const Settings &cmd_args)
2186 std::string migrate_to = cmd_args.get("migrate-auth");
2188 std::string world_mt_path = game_params.world_path + DIR_DELIM + "world.mt";
2189 if (!world_mt.readConfigFile(world_mt_path.c_str())) {
2190 errorstream << "Cannot read world.mt!" << std::endl;
2194 std::string backend = "files";
2195 if (world_mt.exists("auth_backend"))
2196 backend = world_mt.get("auth_backend");
2198 warningstream << "No auth_backend found in world.mt, "
2199 "assuming \"files\"." << std::endl;
2201 if (backend == migrate_to) {
2202 errorstream << "Cannot migrate: new backend is same"
2203 << " as the old one" << std::endl;
2208 const std::unique_ptr<AuthDatabase> srcdb(ServerEnvironment::openAuthDatabase(
2209 backend, game_params.world_path, world_mt));
2210 const std::unique_ptr<AuthDatabase> dstdb(ServerEnvironment::openAuthDatabase(
2211 migrate_to, game_params.world_path, world_mt));
2213 std::vector<std::string> names_list;
2214 srcdb->listNames(names_list);
2215 for (const std::string &name : names_list) {
2216 actionstream << "Migrating auth entry for " << name << std::endl;
2218 AuthEntry authEntry;
2219 success = srcdb->getAuth(name, authEntry);
2220 success = success && dstdb->createAuth(authEntry);
2222 errorstream << "Failed to migrate " << name << std::endl;
2225 actionstream << "Successfully migrated " << names_list.size()
2226 << " auth entries" << std::endl;
2227 world_mt.set("auth_backend", migrate_to);
2228 if (!world_mt.updateConfigFile(world_mt_path.c_str()))
2229 errorstream << "Failed to update world.mt!" << std::endl;
2231 actionstream << "world.mt updated" << std::endl;
2233 if (backend == "files") {
2234 // special-case files migration:
2235 // move auth.txt to auth.txt.bak if possible
2236 std::string auth_txt_path =
2237 game_params.world_path + DIR_DELIM + "auth.txt";
2238 std::string auth_bak_path = auth_txt_path + ".bak";
2239 if (!fs::PathExists(auth_bak_path))
2240 if (fs::Rename(auth_txt_path, auth_bak_path))
2241 actionstream << "Renamed auth.txt to auth.txt.bak"
2244 errorstream << "Could not rename auth.txt to "
2245 "auth.txt.bak" << std::endl;
2247 warningstream << "auth.txt.bak already exists, auth.txt "
2248 "not renamed" << std::endl;
2251 } catch (BaseException &e) {
2252 errorstream << "An error occurred during migration: " << e.what()