src/server.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 #ifndef SERVER_HEADER
  21 #define SERVER_HEADER
  22
  23 #include "connection.h"
  24 #include "irr_v3d.h"
  25 #include "map.h"
  26 #include "hud.h"
  27 #include "gamedef.h"
  28 #include "serialization.h" // For SER_FMT_VER_INVALID
  29 #include "mods.h"
  30 #include "inventorymanager.h"
  31 #include "subgame.h"
  32 #include "rollback_interface.h" // Needed for rollbackRevertActions()
  33 #include "util/numeric.h"
  34 #include "util/thread.h"
  35 #include "environment.h"
  36 #include "clientiface.h"
  37 #include <string>
  38 #include <list>
  39 #include <map>
  40 #include <vector>
  41
  42 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
  43
  44 class IWritableItemDefManager;
  45 class IWritableNodeDefManager;
  46 class IWritableCraftDefManager;
  47 class BanManager;
  48 class EventManager;
  49 class Inventory;
  50 class Player;
  51 class PlayerSAO;
  52 class IRollbackManager;
  53 class EmergeManager;
  54 class GameScripting;
  55 class ServerEnvironment;
  56 struct SimpleSoundSpec;
  57 class ServerThread;
  58
  59 enum ClientDeletionReason {
  60         CDR_LEAVE,
  61         CDR_TIMEOUT,
  62         CDR_DENY
  63 };
  64
  65 /*
  66         Some random functions
  67 */
  68 v3f findSpawnPos(ServerMap &map);
  69
  70 class MapEditEventIgnorer
  71 {
  72 public:
  73         MapEditEventIgnorer(bool *flag):
  74                 m_flag(flag)
  75         {
  76                 if(*m_flag == false)
  77                         *m_flag = true;
  78                 else
  79                         m_flag = NULL;
  80         }
  81
  82         ~MapEditEventIgnorer()
  83         {
  84                 if(m_flag)
  85                 {
  86                         assert(*m_flag);
  87                         *m_flag = false;
  88                 }
  89         }
  90
  91 private:
  92         bool *m_flag;
  93 };
  94
  95 class MapEditEventAreaIgnorer
  96 {
  97 public:
  98         MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
  99                 m_ignorevariable(ignorevariable)
 100         {
 101                 if(m_ignorevariable->getVolume() == 0)
 102                         *m_ignorevariable = a;
 103                 else
 104                         m_ignorevariable = NULL;
 105         }
 106
 107         ~MapEditEventAreaIgnorer()
 108         {
 109                 if(m_ignorevariable)
 110                 {
 111                         assert(m_ignorevariable->getVolume() != 0);
 112                         *m_ignorevariable = VoxelArea();
 113                 }
 114         }
 115
 116 private:
 117         VoxelArea *m_ignorevariable;
 118 };
 119
 120 struct MediaInfo
 121 {
 122         std::string path;
 123         std::string sha1_digest;
 124
 125         MediaInfo(const std::string &path_="",
 126                   const std::string &sha1_digest_=""):
 127                 path(path_),
 128                 sha1_digest(sha1_digest_)
 129         {
 130         }
 131 };
 132
 133 struct ServerSoundParams
 134 {
 135         float gain;
 136         std::string to_player;
 137         enum Type{
 138                 SSP_LOCAL=0,
 139                 SSP_POSITIONAL=1,
 140                 SSP_OBJECT=2
 141         } type;
 142         v3f pos;
 143         u16 object;
 144         float max_hear_distance;
 145         bool loop;
 146
 147         ServerSoundParams():
 148                 gain(1.0),
 149                 to_player(""),
 150                 type(SSP_LOCAL),
 151                 pos(0,0,0),
 152                 object(0),
 153                 max_hear_distance(32*BS),
 154                 loop(false)
 155         {}
 156
 157         v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
 158 };
 159
 160 struct ServerPlayingSound
 161 {
 162         ServerSoundParams params;
 163         std::set<u16> clients; // peer ids
 164 };
 165
 166 class Server : public con::PeerHandler, public MapEventReceiver,
 167                 public InventoryManager, public IGameDef
 168 {
 169 public:
 170         /*
 171                 NOTE: Every public method should be thread-safe
 172         */
 173
 174         Server(
 175                 const std::string &path_world,
 176                 const SubgameSpec &gamespec,
 177                 bool simple_singleplayer_mode,
 178                 bool ipv6
 179         );
 180         ~Server();
 181         void start(Address bind_addr);
 182         void stop();
 183         // This is mainly a way to pass the time to the server.
 184         // Actual processing is done in an another thread.
 185         void step(float dtime);
 186         // This is run by ServerThread and does the actual processing
 187         void AsyncRunStep(bool initial_step=false);
 188         void Receive();
 189         PlayerSAO* StageTwoClientInit(u16 peer_id);
 190         void ProcessData(u8 *data, u32 datasize, u16 peer_id);
 191
 192         // Environment must be locked when called
 193         void setTimeOfDay(u32 time);
 194
 195         /*
 196                 Shall be called with the environment locked.
 197                 This is accessed by the map, which is inside the environment,
 198                 so it shouldn't be a problem.
 199         */
 200         void onMapEditEvent(MapEditEvent *event);
 201
 202         /*
 203                 Shall be called with the environment and the connection locked.
 204         */
 205         Inventory* getInventory(const InventoryLocation &loc);
 206         void setInventoryModified(const InventoryLocation &loc);
 207
 208         // Connection must be locked when called
 209         std::wstring getStatusString();
 210
 211         // read shutdown state
 212         inline bool getShutdownRequested()
 213                         { return m_shutdown_requested; }
 214
 215         // request server to shutdown
 216         inline void requestShutdown(void)
 217                         { m_shutdown_requested = true; }
 218
 219         // Returns -1 if failed, sound handle on success
 220         // Envlock
 221         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
 222         void stopSound(s32 handle);
 223
 224         // Envlock
 225         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
 226         bool checkPriv(const std::string &name, const std::string &priv);
 227         void reportPrivsModified(const std::string &name=""); // ""=all
 228         void reportInventoryFormspecModified(const std::string &name);
 229
 230         void setIpBanned(const std::string &ip, const std::string &name);
 231         void unsetIpBanned(const std::string &ip_or_name);
 232         std::string getBanDescription(const std::string &ip_or_name);
 233
 234         void notifyPlayer(const char *name, const std::wstring &msg);
 235         void notifyPlayers(const std::wstring &msg);
 236         void spawnParticle(const char *playername,
 237                 v3f pos, v3f velocity, v3f acceleration,
 238                 float expirationtime, float size,
 239                 bool collisiondetection, bool vertical, std::string texture);
 240
 241         void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
 242                 float expirationtime, float size,
 243                 bool collisiondetection, bool vertical, std::string texture);
 244
 245         u32 addParticleSpawner(const char *playername,
 246                 u16 amount, float spawntime,
 247                 v3f minpos, v3f maxpos,
 248                 v3f minvel, v3f maxvel,
 249                 v3f minacc, v3f maxacc,
 250                 float minexptime, float maxexptime,
 251                 float minsize, float maxsize,
 252                 bool collisiondetection, bool vertical, std::string texture);
 253
 254         u32 addParticleSpawnerAll(u16 amount, float spawntime,
 255                 v3f minpos, v3f maxpos,
 256                 v3f minvel, v3f maxvel,
 257                 v3f minacc, v3f maxacc,
 258                 float minexptime, float maxexptime,
 259                 float minsize, float maxsize,
 260                 bool collisiondetection, bool vertical, std::string texture);
 261
 262         void deleteParticleSpawner(const char *playername, u32 id);
 263         void deleteParticleSpawnerAll(u32 id);
 264
 265         // Creates or resets inventory
 266         Inventory* createDetachedInventory(const std::string &name);
 267
 268         // Envlock and conlock should be locked when using scriptapi
 269         GameScripting *getScriptIface(){ return m_script; }
 270
 271         // Envlock should be locked when using the rollback manager
 272         IRollbackManager *getRollbackManager(){ return m_rollback; }
 273
 274         //TODO: determine what (if anything) should be locked to access EmergeManager
 275         EmergeManager *getEmergeManager(){ return m_emerge; }
 276
 277         // actions: time-reversed list
 278         // Return value: success/failure
 279         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
 280                         std::list<std::string> *log);
 281
 282         // IGameDef interface
 283         // Under envlock
 284         virtual IItemDefManager* getItemDefManager();
 285         virtual INodeDefManager* getNodeDefManager();
 286         virtual ICraftDefManager* getCraftDefManager();
 287         virtual ITextureSource* getTextureSource();
 288         virtual IShaderSource* getShaderSource();
 289         virtual u16 allocateUnknownNodeId(const std::string &name);
 290         virtual ISoundManager* getSoundManager();
 291         virtual MtEventManager* getEventManager();
 292         virtual IRollbackReportSink* getRollbackReportSink();
 293
 294         IWritableItemDefManager* getWritableItemDefManager();
 295         IWritableNodeDefManager* getWritableNodeDefManager();
 296         IWritableCraftDefManager* getWritableCraftDefManager();
 297
 298         const ModSpec* getModSpec(const std::string &modname);
 299         void getModNames(std::list<std::string> &modlist);
 300         std::string getBuiltinLuaPath();
 301         inline std::string getWorldPath()
 302                         { return m_path_world; }
 303
 304         inline bool isSingleplayer()
 305                         { return m_simple_singleplayer_mode; }
 306
 307         inline void setAsyncFatalError(const std::string &error)
 308                         { m_async_fatal_error.set(error); }
 309
 310         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
 311         Map & getMap() { return m_env->getMap(); }
 312         ServerEnvironment & getEnv() { return *m_env; }
 313
 314         u32 hudAdd(Player *player, HudElement *element);
 315         bool hudRemove(Player *player, u32 id);
 316         bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
 317         bool hudSetFlags(Player *player, u32 flags, u32 mask);
 318         bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
 319         void hudSetHotbarImage(Player *player, std::string name);
 320         void hudSetHotbarSelectedImage(Player *player, std::string name);
 321
 322         inline Address getPeerAddress(u16 peer_id)
 323                         { return m_con.GetPeerAddress(peer_id); }
 324
 325         bool setSky(Player *player, const video::SColor &bgcolor,
 326                         const std::string &type, const std::vector<std::string> &params);
 327
 328         bool overrideDayNightRatio(Player *player, bool do_override,
 329                         float brightness);
 330
 331         /* con::PeerHandler implementation. */
 332         void peerAdded(con::Peer *peer);
 333         void deletingPeer(con::Peer *peer, bool timeout);
 334
 335         void DenyAccess(u16 peer_id, const std::wstring &reason);
 336         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
 337         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
 338                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
 339                         std::string* vers_string);
 340
 341 private:
 342
 343         friend class EmergeThread;
 344         friend class RemoteClient;
 345
 346         void SendMovement(u16 peer_id);
 347         void SendHP(u16 peer_id, u8 hp);
 348         void SendBreath(u16 peer_id, u16 breath);
 349         void SendAccessDenied(u16 peer_id,const std::wstring &reason);
 350         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
 351         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
 352         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
 353
 354         /* mark blocks not sent for all clients */
 355         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
 356
 357         // Envlock and conlock should be locked when calling these
 358         void SendInventory(u16 peer_id);
 359         void SendChatMessage(u16 peer_id, const std::wstring &message);
 360         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
 361         void SendPlayerHP(u16 peer_id);
 362         void SendPlayerBreath(u16 peer_id);
 363         void SendMovePlayer(u16 peer_id);
 364         void SendPlayerPrivileges(u16 peer_id);
 365         void SendPlayerInventoryFormspec(u16 peer_id);
 366         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
 367         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
 368         void SendHUDRemove(u16 peer_id, u32 id);
 369         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
 370         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
 371         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
 372         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
 373                         const std::string &type, const std::vector<std::string> &params);
 374         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
 375
 376         /*
 377                 Send a node removal/addition event to all clients except ignore_id.
 378                 Additionally, if far_players!=NULL, players further away than
 379                 far_d_nodes are ignored and their peer_ids are added to far_players
 380         */
 381         // Envlock and conlock should be locked when calling these
 382         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
 383                         std::list<u16> *far_players=NULL, float far_d_nodes=100);
 384         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
 385                         std::list<u16> *far_players=NULL, float far_d_nodes=100,
 386                         bool remove_metadata=true);
 387         void setBlockNotSent(v3s16 p);
 388
 389         // Environment and Connection must be locked when called
 390         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
 391
 392         // Sends blocks to clients (locks env and con on its own)
 393         void SendBlocks(float dtime);
 394
 395         void fillMediaCache();
 396         void sendMediaAnnouncement(u16 peer_id);
 397         void sendRequestedMedia(u16 peer_id,
 398                         const std::list<std::string> &tosend);
 399
 400         void sendDetachedInventory(const std::string &name, u16 peer_id);
 401         void sendDetachedInventories(u16 peer_id);
 402
 403         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
 404         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
 405                 v3f minpos, v3f maxpos,
 406                 v3f minvel, v3f maxvel,
 407                 v3f minacc, v3f maxacc,
 408                 float minexptime, float maxexptime,
 409                 float minsize, float maxsize,
 410                 bool collisiondetection, bool vertical, std::string texture, u32 id);
 411
 412         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
 413
 414         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
 415         void SendSpawnParticle(u16 peer_id,
 416                 v3f pos, v3f velocity, v3f acceleration,
 417                 float expirationtime, float size,
 418                 bool collisiondetection, bool vertical, std::string texture);
 419
 420         /*
 421                 Something random
 422         */
 423
 424         void DiePlayer(u16 peer_id);
 425         void RespawnPlayer(u16 peer_id);
 426         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
 427         void UpdateCrafting(u16 peer_id);
 428
 429         // When called, connection mutex should be locked
 430         RemoteClient* getClient(u16 peer_id,ClientState state_min=Active);
 431         RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=Active);
 432
 433         // When called, environment mutex should be locked
 434         std::string getPlayerName(u16 peer_id);
 435         PlayerSAO* getPlayerSAO(u16 peer_id);
 436
 437         /*
 438                 Get a player from memory or creates one.
 439                 If player is already connected, return NULL
 440                 Does not verify/modify auth info and password.
 441
 442                 Call with env and con locked.
 443         */
 444         PlayerSAO *emergePlayer(const char *name, u16 peer_id);
 445
 446         void handlePeerChanges();
 447
 448         /*
 449                 Variables
 450         */
 451
 452         // World directory
 453         std::string m_path_world;
 454         // Subgame specification
 455         SubgameSpec m_gamespec;
 456         // If true, do not allow multiple players and hide some multiplayer
 457         // functionality
 458         bool m_simple_singleplayer_mode;
 459
 460         // Thread can set; step() will throw as ServerError
 461         MutexedVariable<std::string> m_async_fatal_error;
 462
 463         // Some timers
 464         float m_liquid_transform_timer;
 465         float m_liquid_transform_every;
 466         float m_print_info_timer;
 467         float m_masterserver_timer;
 468         float m_objectdata_timer;
 469         float m_emergethread_trigger_timer;
 470         float m_savemap_timer;
 471         IntervalLimiter m_map_timer_and_unload_interval;
 472
 473         // Environment
 474         ServerEnvironment *m_env;
 475         JMutex m_env_mutex;
 476
 477         // server connection
 478         con::Connection m_con;
 479
 480         // Ban checking
 481         BanManager *m_banmanager;
 482
 483         // Rollback manager (behind m_env_mutex)
 484         IRollbackManager *m_rollback;
 485         bool m_rollback_sink_enabled;
 486         bool m_enable_rollback_recording; // Updated once in a while
 487
 488         // Emerge manager
 489         EmergeManager *m_emerge;
 490
 491         // Scripting
 492         // Envlock and conlock should be locked when using Lua
 493         GameScripting *m_script;
 494
 495         // Item definition manager
 496         IWritableItemDefManager *m_itemdef;
 497
 498         // Node definition manager
 499         IWritableNodeDefManager *m_nodedef;
 500
 501         // Craft definition manager
 502         IWritableCraftDefManager *m_craftdef;
 503
 504         // Event manager
 505         EventManager *m_event;
 506
 507         // Mods
 508         std::vector<ModSpec> m_mods;
 509
 510         /*
 511                 Threads
 512         */
 513
 514         // A buffer for time steps
 515         // step() increments and AsyncRunStep() run by m_thread reads it.
 516         float m_step_dtime;
 517         JMutex m_step_dtime_mutex;
 518
 519         // current server step lag counter
 520         float m_lag;
 521
 522         // The server mainly operates in this thread
 523         ServerThread *m_thread;
 524
 525         /*
 526                 Time related stuff
 527         */
 528
 529         // Timer for sending time of day over network
 530         float m_time_of_day_send_timer;
 531         // Uptime of server in seconds
 532         MutexedVariable<double> m_uptime;
 533
 534         /*
 535          Client interface
 536          */
 537         ClientInterface m_clients;
 538
 539         /*
 540                 Peer change queue.
 541                 Queues stuff from peerAdded() and deletingPeer() to
 542                 handlePeerChanges()
 543         */
 544         Queue<con::PeerChange> m_peer_change_queue;
 545
 546         /*
 547                 Random stuff
 548         */
 549
 550         // Mod parent directory paths
 551         std::list<std::string> m_modspaths;
 552
 553         bool m_shutdown_requested;
 554
 555         /*
 556                 Map edit event queue. Automatically receives all map edits.
 557                 The constructor of this class registers us to receive them through
 558                 onMapEditEvent
 559
 560                 NOTE: Should these be moved to actually be members of
 561                 ServerEnvironment?
 562         */
 563
 564         /*
 565                 Queue of map edits from the environment for sending to the clients
 566                 This is behind m_env_mutex
 567         */
 568         Queue<MapEditEvent*> m_unsent_map_edit_queue;
 569         /*
 570                 Set to true when the server itself is modifying the map and does
 571                 all sending of information by itself.
 572                 This is behind m_env_mutex
 573         */
 574         bool m_ignore_map_edit_events;
 575         /*
 576                 If a non-empty area, map edit events contained within are left
 577                 unsent. Done at map generation time to speed up editing of the
 578                 generated area, as it will be sent anyway.
 579                 This is behind m_env_mutex
 580         */
 581         VoxelArea m_ignore_map_edit_events_area;
 582         /*
 583                 If set to !=0, the incoming MapEditEvents are modified to have
 584                 this peed id as the disabled recipient
 585                 This is behind m_env_mutex
 586         */
 587         u16 m_ignore_map_edit_events_peer_id;
 588
 589         // media files known to server
 590         std::map<std::string,MediaInfo> m_media;
 591
 592         /*
 593                 Sounds
 594         */
 595         std::map<s32, ServerPlayingSound> m_playing_sounds;
 596         s32 m_next_sound_id;
 597
 598         /*
 599                 Detached inventories (behind m_env_mutex)
 600         */
 601         // key = name
 602         std::map<std::string, Inventory*> m_detached_inventories;
 603
 604         /*
 605                 Particles
 606         */
 607         std::vector<u32> m_particlespawner_ids;
 608 };
 609
 610 /*
 611         Runs a simple dedicated server loop.
 612
 613         Shuts down when run is set to false.
 614 */
 615 void dedicated_server_loop(Server &server, bool &run);
 616
 617 #endif
 618