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