src/serverenvironment.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2017 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include "activeobject.h"
  23 #include "environment.h"
  24 #include "mapnode.h"
  25 #include "settings.h"
  26 #include "server/activeobjectmgr.h"
  27 #include "util/numeric.h"
  28 #include "util/metricsbackend.h"
  29 #include <set>
  30 #include <random>
  31
  32 class IGameDef;
  33 class ServerMap;
  34 struct GameParams;
  35 class MapBlock;
  36 class RemotePlayer;
  37 class PlayerDatabase;
  38 class AuthDatabase;
  39 class PlayerSAO;
  40 class ServerEnvironment;
  41 class ActiveBlockModifier;
  42 struct StaticObject;
  43 class ServerActiveObject;
  44 class Server;
  45 class ServerScripting;
  46
  47 /*
  48         {Active, Loading} block modifier interface.
  49
  50         These are fed into ServerEnvironment at initialization time;
  51         ServerEnvironment handles deleting them.
  52 */
  53
  54 class ActiveBlockModifier
  55 {
  56 public:
  57         ActiveBlockModifier() = default;
  58         virtual ~ActiveBlockModifier() = default;
  59
  60         // Set of contents to trigger on
  61         virtual const std::vector<std::string> &getTriggerContents() const = 0;
  62         // Set of required neighbors (trigger doesn't happen if none are found)
  63         // Empty = do not check neighbors
  64         virtual const std::vector<std::string> &getRequiredNeighbors() const = 0;
  65         // Trigger interval in seconds
  66         virtual float getTriggerInterval() = 0;
  67         // Random chance of (1 / return value), 0 is disallowed
  68         virtual u32 getTriggerChance() = 0;
  69         // Whether to modify chance to simulate time lost by an unnattended block
  70         virtual bool getSimpleCatchUp() = 0;
  71         // get min Y for apply abm
  72         virtual s16 getMinY() = 0;
  73         // get max Y for apply abm
  74         virtual s16 getMaxY() = 0;
  75         // This is called usually at interval for 1/chance of the nodes
  76         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
  77         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
  78                 u32 active_object_count, u32 active_object_count_wider){};
  79 };
  80
  81 struct ABMWithState
  82 {
  83         ActiveBlockModifier *abm;
  84         float timer = 0.0f;
  85
  86         ABMWithState(ActiveBlockModifier *abm_);
  87 };
  88
  89 struct LoadingBlockModifierDef
  90 {
  91         // Set of contents to trigger on
  92         std::set<std::string> trigger_contents;
  93         std::string name;
  94         bool run_at_every_load = false;
  95
  96         virtual ~LoadingBlockModifierDef() = default;
  97
  98         virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n){};
  99 };
 100
 101 struct LBMContentMapping
 102 {
 103         typedef std::unordered_map<content_t, std::vector<LoadingBlockModifierDef *>> lbm_map;
 104         lbm_map map;
 105
 106         std::vector<LoadingBlockModifierDef *> lbm_list;
 107
 108         // Needs to be separate method (not inside destructor),
 109         // because the LBMContentMapping may be copied and destructed
 110         // many times during operation in the lbm_lookup_map.
 111         void deleteContents();
 112         void addLBM(LoadingBlockModifierDef *lbm_def, IGameDef *gamedef);
 113         const std::vector<LoadingBlockModifierDef *> *lookup(content_t c) const;
 114 };
 115
 116 class LBMManager
 117 {
 118 public:
 119         LBMManager() = default;
 120         ~LBMManager();
 121
 122         // Don't call this after loadIntroductionTimes() ran.
 123         void addLBMDef(LoadingBlockModifierDef *lbm_def);
 124
 125         void loadIntroductionTimes(const std::string &times,
 126                 IGameDef *gamedef, u32 now);
 127
 128         // Don't call this before loadIntroductionTimes() ran.
 129         std::string createIntroductionTimesString();
 130
 131         // Don't call this before loadIntroductionTimes() ran.
 132         void applyLBMs(ServerEnvironment *env, MapBlock *block, u32 stamp);
 133
 134         // Warning: do not make this std::unordered_map, order is relevant here
 135         typedef std::map<u32, LBMContentMapping> lbm_lookup_map;
 136
 137 private:
 138         // Once we set this to true, we can only query,
 139         // not modify
 140         bool m_query_mode = false;
 141
 142         // For m_query_mode == false:
 143         // The key of the map is the LBM def's name.
 144         // TODO make this std::unordered_map
 145         std::map<std::string, LoadingBlockModifierDef *> m_lbm_defs;
 146
 147         // For m_query_mode == true:
 148         // The key of the map is the LBM def's first introduction time.
 149         lbm_lookup_map m_lbm_lookup;
 150
 151         // Returns an iterator to the LBMs that were introduced
 152         // after the given time. This is guaranteed to return
 153         // valid values for everything
 154         lbm_lookup_map::const_iterator getLBMsIntroducedAfter(u32 time)
 155         { return m_lbm_lookup.lower_bound(time); }
 156 };
 157
 158 /*
 159         List of active blocks, used by ServerEnvironment
 160 */
 161
 162 class ActiveBlockList
 163 {
 164 public:
 165         void update(std::vector<PlayerSAO*> &active_players,
 166                 s16 active_block_range,
 167                 s16 active_object_range,
 168                 std::set<v3s16> &blocks_removed,
 169                 std::set<v3s16> &blocks_added);
 170
 171         bool contains(v3s16 p) const {
 172                 return (m_list.find(p) != m_list.end());
 173         }
 174
 175         auto size() const {
 176                 return m_list.size();
 177         }
 178
 179         void clear() {
 180                 m_list.clear();
 181         }
 182
 183         std::set<v3s16> m_list;
 184         std::set<v3s16> m_abm_list;
 185         std::set<v3s16> m_forceloaded_list;
 186 };
 187
 188 /*
 189         Operation mode for ServerEnvironment::clearObjects()
 190 */
 191 enum ClearObjectsMode {
 192         // Load and go through every mapblock, clearing objects
 193                 CLEAR_OBJECTS_MODE_FULL,
 194
 195         // Clear objects immediately in loaded mapblocks;
 196         // clear objects in unloaded mapblocks only when the mapblocks are next activated.
 197                 CLEAR_OBJECTS_MODE_QUICK,
 198 };
 199
 200 class ServerEnvironment : public Environment
 201 {
 202 public:
 203         ServerEnvironment(ServerMap *map, ServerScripting *scriptIface,
 204                 Server *server, const std::string &path_world, MetricsBackend *mb);
 205         ~ServerEnvironment();
 206
 207         Map & getMap();
 208
 209         ServerMap & getServerMap();
 210
 211         //TODO find way to remove this fct!
 212         ServerScripting* getScriptIface()
 213         { return m_script; }
 214
 215         Server *getGameDef()
 216         { return m_server; }
 217
 218         float getSendRecommendedInterval()
 219         { return m_recommended_send_interval; }
 220
 221         void kickAllPlayers(AccessDeniedCode reason,
 222                 const std::string &str_reason, bool reconnect);
 223         // Save players
 224         void saveLoadedPlayers(bool force = false);
 225         void savePlayer(RemotePlayer *player);
 226         PlayerSAO *loadPlayer(RemotePlayer *player, bool *new_player, session_t peer_id,
 227                 bool is_singleplayer);
 228         void addPlayer(RemotePlayer *player);
 229         void removePlayer(RemotePlayer *player);
 230         bool removePlayerFromDatabase(const std::string &name);
 231
 232         /*
 233                 Save and load time of day and game timer
 234         */
 235         void saveMeta();
 236         void loadMeta();
 237
 238         u32 addParticleSpawner(float exptime);
 239         u32 addParticleSpawner(float exptime, u16 attached_id);
 240         void deleteParticleSpawner(u32 id, bool remove_from_object = true);
 241
 242         /*
 243                 External ActiveObject interface
 244                 -------------------------------------------
 245         */
 246
 247         ServerActiveObject* getActiveObject(u16 id)
 248         {
 249                 return m_ao_manager.getActiveObject(id);
 250         }
 251
 252         /*
 253                 Add an active object to the environment.
 254                 Environment handles deletion of object.
 255                 Object may be deleted by environment immediately.
 256                 If id of object is 0, assigns a free id to it.
 257                 Returns the id of the object.
 258                 Returns 0 if not added and thus deleted.
 259         */
 260         u16 addActiveObject(ServerActiveObject *object);
 261
 262         /*
 263                 Add an active object as a static object to the corresponding
 264                 MapBlock.
 265                 Caller allocates memory, ServerEnvironment frees memory.
 266                 Return value: true if succeeded, false if failed.
 267                 (note:  not used, pending removal from engine)
 268         */
 269         //bool addActiveObjectAsStatic(ServerActiveObject *object);
 270
 271         /*
 272                 Find out what new objects have been added to
 273                 inside a radius around a position
 274         */
 275         void getAddedActiveObjects(PlayerSAO *playersao, s16 radius,
 276                 s16 player_radius,
 277                 std::set<u16> &current_objects,
 278                 std::queue<u16> &added_objects);
 279
 280         /*
 281                 Find out what new objects have been removed from
 282                 inside a radius around a position
 283         */
 284         void getRemovedActiveObjects(PlayerSAO *playersao, s16 radius,
 285                 s16 player_radius,
 286                 std::set<u16> &current_objects,
 287                 std::queue<u16> &removed_objects);
 288
 289         /*
 290                 Get the next message emitted by some active object.
 291                 Returns false if no messages are available, true otherwise.
 292         */
 293         bool getActiveObjectMessage(ActiveObjectMessage *dest);
 294
 295         virtual void getSelectedActiveObjects(
 296                 const core::line3d<f32> &shootline_on_map,
 297                 std::vector<PointedThing> &objects
 298         );
 299
 300         /*
 301                 Activate objects and dynamically modify for the dtime determined
 302                 from timestamp and additional_dtime
 303         */
 304         void activateBlock(MapBlock *block, u32 additional_dtime=0);
 305
 306         /*
 307                 {Active,Loading}BlockModifiers
 308                 -------------------------------------------
 309         */
 310
 311         void addActiveBlockModifier(ActiveBlockModifier *abm);
 312         void addLoadingBlockModifierDef(LoadingBlockModifierDef *lbm);
 313
 314         /*
 315                 Other stuff
 316                 -------------------------------------------
 317         */
 318
 319         // Script-aware node setters
 320         bool setNode(v3s16 p, const MapNode &n);
 321         bool removeNode(v3s16 p);
 322         bool swapNode(v3s16 p, const MapNode &n);
 323
 324         // Find the daylight value at pos with a Depth First Search
 325         u8 findSunlight(v3s16 pos) const;
 326
 327         // Find all active objects inside a radius around a point
 328         void getObjectsInsideRadius(std::vector<ServerActiveObject *> &objects, const v3f &pos, float radius,
 329                         std::function<bool(ServerActiveObject *obj)> include_obj_cb)
 330         {
 331                 return m_ao_manager.getObjectsInsideRadius(pos, radius, objects, include_obj_cb);
 332         }
 333
 334         // Find all active objects inside a box
 335         void getObjectsInArea(std::vector<ServerActiveObject *> &objects, const aabb3f &box,
 336                         std::function<bool(ServerActiveObject *obj)> include_obj_cb)
 337         {
 338                 return m_ao_manager.getObjectsInArea(box, objects, include_obj_cb);
 339         }
 340
 341         // Clear objects, loading and going through every MapBlock
 342         void clearObjects(ClearObjectsMode mode);
 343
 344         // This makes stuff happen
 345         void step(f32 dtime);
 346
 347         u32 getGameTime() const { return m_game_time; }
 348
 349         void reportMaxLagEstimate(float f) { m_max_lag_estimate = f; }
 350         float getMaxLagEstimate() { return m_max_lag_estimate; }
 351
 352         std::set<v3s16>* getForceloadedBlocks() { return &m_active_blocks.m_forceloaded_list; }
 353
 354         // Sorted by how ready a mapblock is
 355         enum BlockStatus {
 356                 BS_UNKNOWN,
 357                 BS_EMERGING,
 358                 BS_LOADED,
 359                 BS_ACTIVE // always highest value
 360         };
 361         BlockStatus getBlockStatus(v3s16 blockpos);
 362
 363         // Sets the static object status all the active objects in the specified block
 364         // This is only really needed for deleting blocks from the map
 365         void setStaticForActiveObjectsInBlock(v3s16 blockpos,
 366                 bool static_exists, v3s16 static_block=v3s16(0,0,0));
 367
 368         RemotePlayer *getPlayer(const session_t peer_id);
 369         RemotePlayer *getPlayer(const char* name);
 370         const std::vector<RemotePlayer *> getPlayers() const { return m_players; }
 371         u32 getPlayerCount() const { return m_players.size(); }
 372
 373         static bool migratePlayersDatabase(const GameParams &game_params,
 374                         const Settings &cmd_args);
 375
 376         AuthDatabase *getAuthDatabase() { return m_auth_database; }
 377         static bool migrateAuthDatabase(const GameParams &game_params,
 378                         const Settings &cmd_args);
 379 private:
 380
 381         /**
 382          * called if env_meta.txt doesn't exist (e.g. new world)
 383          */
 384         void loadDefaultMeta();
 385
 386         static PlayerDatabase *openPlayerDatabase(const std::string &name,
 387                         const std::string &savedir, const Settings &conf);
 388         static AuthDatabase *openAuthDatabase(const std::string &name,
 389                         const std::string &savedir, const Settings &conf);
 390         /*
 391                 Internal ActiveObject interface
 392                 -------------------------------------------
 393         */
 394
 395         /*
 396                 Add an active object to the environment.
 397
 398                 Called by addActiveObject.
 399
 400                 Object may be deleted by environment immediately.
 401                 If id of object is 0, assigns a free id to it.
 402                 Returns the id of the object.
 403                 Returns 0 if not added and thus deleted.
 404         */
 405         u16 addActiveObjectRaw(ServerActiveObject *object, bool set_changed, u32 dtime_s);
 406
 407         /*
 408                 Remove all objects that satisfy (isGone() && m_known_by_count==0)
 409         */
 410         void removeRemovedObjects();
 411
 412         /*
 413                 Convert stored objects from block to active
 414         */
 415         void activateObjects(MapBlock *block, u32 dtime_s);
 416
 417         /*
 418                 Convert objects that are not in active blocks to static.
 419
 420                 If m_known_by_count != 0, active object is not deleted, but static
 421                 data is still updated.
 422
 423                 If force_delete is set, active object is deleted nevertheless. It
 424                 shall only be set so in the destructor of the environment.
 425         */
 426         void deactivateFarObjects(bool force_delete);
 427
 428         /*
 429                 A few helpers used by the three above methods
 430         */
 431         void deleteStaticFromBlock(
 432                         ServerActiveObject *obj, u16 id, u32 mod_reason, bool no_emerge);
 433         bool saveStaticToBlock(v3s16 blockpos, u16 store_id,
 434                         ServerActiveObject *obj, const StaticObject &s_obj, u32 mod_reason);
 435
 436         /*
 437                 Member variables
 438         */
 439
 440         // The map
 441         ServerMap *m_map;
 442         // Lua state
 443         ServerScripting* m_script;
 444         // Server definition
 445         Server *m_server;
 446         // Active Object Manager
 447         server::ActiveObjectMgr m_ao_manager;
 448         // World path
 449         const std::string m_path_world;
 450         // Outgoing network message buffer for active objects
 451         std::queue<ActiveObjectMessage> m_active_object_messages;
 452         // Some timers
 453         float m_send_recommended_timer = 0.0f;
 454         IntervalLimiter m_object_management_interval;
 455         // List of active blocks
 456         ActiveBlockList m_active_blocks;
 457         bool m_force_update_active_blocks = false;
 458         IntervalLimiter m_active_blocks_mgmt_interval;
 459         IntervalLimiter m_active_block_modifier_interval;
 460         IntervalLimiter m_active_blocks_nodemetadata_interval;
 461         // Whether the variables below have been read from file yet
 462         bool m_meta_loaded = false;
 463         // Time from the beginning of the game in seconds.
 464         // Incremented in step().
 465         u32 m_game_time = 0;
 466         // A helper variable for incrementing the latter
 467         float m_game_time_fraction_counter = 0.0f;
 468         // Time of last clearObjects call (game time).
 469         // When a mapblock older than this is loaded, its objects are cleared.
 470         u32 m_last_clear_objects_time = 0;
 471         // Active block modifiers
 472         std::vector<ABMWithState> m_abms;
 473         LBMManager m_lbm_mgr;
 474         // An interval for generally sending object positions and stuff
 475         float m_recommended_send_interval = 0.1f;
 476         // Estimate for general maximum lag as determined by server.
 477         // Can raise to high values like 15s with eg. map generation mods.
 478         float m_max_lag_estimate = 0.1f;
 479
 480         // peer_ids in here should be unique, except that there may be many 0s
 481         std::vector<RemotePlayer*> m_players;
 482
 483         PlayerDatabase *m_player_database = nullptr;
 484         AuthDatabase *m_auth_database = nullptr;
 485
 486         // Pseudo random generator for shuffling, etc.
 487         std::mt19937 m_rgen;
 488
 489         // Particles
 490         IntervalLimiter m_particle_management_interval;
 491         std::unordered_map<u32, float> m_particle_spawners;
 492         std::unordered_map<u32, u16> m_particle_spawner_attachments;
 493
 494         // Environment metrics
 495         MetricCounterPtr m_step_time_counter;
 496         MetricGaugePtr m_active_block_gauge;
 497         MetricGaugePtr m_active_object_gauge;
 498
 499         ServerActiveObject* createSAO(ActiveObjectType type, v3f pos, const std::string &data);
 500 };