3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include "serialization.h" // For SER_FMT_VER_INVALID
27 #include "content/mods.h"
28 #include "inventorymanager.h"
29 #include "content/subgames.h"
30 #include "tileanimation.h" // struct TileAnimationParams
31 #include "network/peerhandler.h"
32 #include "network/address.h"
33 #include "util/numeric.h"
34 #include "util/thread.h"
35 #include "util/basic_macros.h"
36 #include "serverenvironment.h"
37 #include "clientiface.h"
38 #include "chatmessage.h"
47 class IWritableItemDefManager;
49 class IWritableCraftDefManager;
56 struct PlayerHPChangeReason;
57 class IRollbackManager;
58 struct RollbackAction;
60 class ServerScripting;
61 class ServerEnvironment;
62 struct SimpleSoundSpec;
69 class ServerModManager;
71 enum ClientDeletionReason {
80 std::string sha1_digest;
82 MediaInfo(const std::string &path_="",
83 const std::string &sha1_digest_=""):
85 sha1_digest(sha1_digest_)
90 struct ServerSoundParams
101 float max_hear_distance = 32 * BS;
104 std::string to_player = "";
105 std::string exclude_player = "";
107 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
110 struct ServerPlayingSound
112 ServerSoundParams params;
113 SimpleSoundSpec spec;
114 std::unordered_set<session_t> clients; // peer ids
117 class Server : public con::PeerHandler, public MapEventReceiver,
118 public InventoryManager, public IGameDef
122 NOTE: Every public method should be thread-safe
126 const std::string &path_world,
127 const SubgameSpec &gamespec,
128 bool simple_singleplayer_mode,
131 ChatInterface *iface = nullptr
134 DISABLE_CLASS_COPY(Server);
139 // This is mainly a way to pass the time to the server.
140 // Actual processing is done in an another thread.
141 void step(float dtime);
142 // This is run by ServerThread and does the actual processing
143 void AsyncRunStep(bool initial_step=false);
145 PlayerSAO* StageTwoClientInit(session_t peer_id);
151 void handleCommand(NetworkPacket* pkt);
153 void handleCommand_Null(NetworkPacket* pkt) {};
154 void handleCommand_Deprecated(NetworkPacket* pkt);
155 void handleCommand_Init(NetworkPacket* pkt);
156 void handleCommand_Init2(NetworkPacket* pkt);
157 void handleCommand_ModChannelJoin(NetworkPacket *pkt);
158 void handleCommand_ModChannelLeave(NetworkPacket *pkt);
159 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
160 void handleCommand_RequestMedia(NetworkPacket* pkt);
161 void handleCommand_ClientReady(NetworkPacket* pkt);
162 void handleCommand_GotBlocks(NetworkPacket* pkt);
163 void handleCommand_PlayerPos(NetworkPacket* pkt);
164 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
165 void handleCommand_InventoryAction(NetworkPacket* pkt);
166 void handleCommand_ChatMessage(NetworkPacket* pkt);
167 void handleCommand_Damage(NetworkPacket* pkt);
168 void handleCommand_Password(NetworkPacket* pkt);
169 void handleCommand_PlayerItem(NetworkPacket* pkt);
170 void handleCommand_Respawn(NetworkPacket* pkt);
171 void handleCommand_Interact(NetworkPacket* pkt);
172 void handleCommand_RemovedSounds(NetworkPacket* pkt);
173 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
174 void handleCommand_InventoryFields(NetworkPacket* pkt);
175 void handleCommand_FirstSrp(NetworkPacket* pkt);
176 void handleCommand_SrpBytesA(NetworkPacket* pkt);
177 void handleCommand_SrpBytesM(NetworkPacket* pkt);
179 void ProcessData(NetworkPacket *pkt);
181 void Send(NetworkPacket *pkt);
182 void Send(session_t peer_id, NetworkPacket *pkt);
184 // Helper for handleCommand_PlayerPos and handleCommand_Interact
185 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
188 // Both setter and getter need no envlock,
189 // can be called freely from threads
190 void setTimeOfDay(u32 time);
193 Shall be called with the environment locked.
194 This is accessed by the map, which is inside the environment,
195 so it shouldn't be a problem.
197 void onMapEditEvent(const MapEditEvent &event);
200 Shall be called with the environment and the connection locked.
202 Inventory* getInventory(const InventoryLocation &loc);
203 void setInventoryModified(const InventoryLocation &loc);
205 // Connection must be locked when called
206 std::wstring getStatusString();
207 inline double getUptime() const { return m_uptime.m_value; }
209 // read shutdown state
210 inline bool isShutdownRequested() const { return m_shutdown_state.is_requested; }
212 // request server to shutdown
213 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
215 // Returns -1 if failed, sound handle on success
217 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms,
218 bool ephemeral=false);
219 void stopSound(s32 handle);
220 void fadeSound(s32 handle, float step, float gain);
223 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
224 bool checkPriv(const std::string &name, const std::string &priv);
225 void reportPrivsModified(const std::string &name=""); // ""=all
226 void reportInventoryFormspecModified(const std::string &name);
227 void reportFormspecPrependModified(const std::string &name);
229 void setIpBanned(const std::string &ip, const std::string &name);
230 void unsetIpBanned(const std::string &ip_or_name);
231 std::string getBanDescription(const std::string &ip_or_name);
233 void notifyPlayer(const char *name, const std::wstring &msg);
234 void notifyPlayers(const std::wstring &msg);
235 void spawnParticle(const std::string &playername,
236 v3f pos, v3f velocity, v3f acceleration,
237 float expirationtime, float size,
238 bool collisiondetection, bool collision_removal, bool object_collision,
239 bool vertical, const std::string &texture,
240 const struct TileAnimationParams &animation, u8 glow);
242 u32 addParticleSpawner(u16 amount, float spawntime,
243 v3f minpos, v3f maxpos,
244 v3f minvel, v3f maxvel,
245 v3f minacc, v3f maxacc,
246 float minexptime, float maxexptime,
247 float minsize, float maxsize,
248 bool collisiondetection, bool collision_removal, bool object_collision,
249 ServerActiveObject *attached,
250 bool vertical, const std::string &texture,
251 const std::string &playername, const struct TileAnimationParams &animation,
254 void deleteParticleSpawner(const std::string &playername, u32 id);
256 // Creates or resets inventory
257 Inventory *createDetachedInventory(const std::string &name,
258 const std::string &player = "");
259 bool removeDetachedInventory(const std::string &name);
261 // Envlock and conlock should be locked when using scriptapi
262 ServerScripting *getScriptIface(){ return m_script; }
264 // actions: time-reversed list
265 // Return value: success/failure
266 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
267 std::list<std::string> *log);
269 // IGameDef interface
271 virtual IItemDefManager* getItemDefManager();
272 virtual const NodeDefManager* getNodeDefManager();
273 virtual ICraftDefManager* getCraftDefManager();
274 virtual u16 allocateUnknownNodeId(const std::string &name);
275 IRollbackManager *getRollbackManager() { return m_rollback; }
276 virtual EmergeManager *getEmergeManager() { return m_emerge; }
278 IWritableItemDefManager* getWritableItemDefManager();
279 NodeDefManager* getWritableNodeDefManager();
280 IWritableCraftDefManager* getWritableCraftDefManager();
282 virtual const std::vector<ModSpec> &getMods() const;
283 virtual const ModSpec* getModSpec(const std::string &modname) const;
284 void getModNames(std::vector<std::string> &modlist);
285 std::string getBuiltinLuaPath();
286 virtual std::string getWorldPath() const { return m_path_world; }
287 virtual std::string getModStoragePath() const;
289 inline bool isSingleplayer()
290 { return m_simple_singleplayer_mode; }
292 inline void setAsyncFatalError(const std::string &error)
293 { m_async_fatal_error.set(error); }
295 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
296 Map & getMap() { return m_env->getMap(); }
297 ServerEnvironment & getEnv() { return *m_env; }
300 u32 hudAdd(RemotePlayer *player, HudElement *element);
301 bool hudRemove(RemotePlayer *player, u32 id);
302 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
303 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
304 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
305 void hudSetHotbarImage(RemotePlayer *player, const std::string &name);
306 void hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name);
308 Address getPeerAddress(session_t peer_id);
310 void setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
312 void setPlayerEyeOffset(RemotePlayer *player, const v3f &first, const v3f &third);
314 void setSky(RemotePlayer *player, const SkyboxParams ¶ms);
315 void setSun(RemotePlayer *player, const SunParams ¶ms);
316 void setMoon(RemotePlayer *player, const MoonParams ¶ms);
317 void setStars(RemotePlayer *player, const StarParams ¶ms);
319 void setClouds(RemotePlayer *player, const CloudParams ¶ms);
321 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
323 /* con::PeerHandler implementation. */
324 void peerAdded(con::Peer *peer);
325 void deletingPeer(con::Peer *peer, bool timeout);
327 void DenySudoAccess(session_t peer_id);
328 void DenyAccessVerCompliant(session_t peer_id, u16 proto_ver, AccessDeniedCode reason,
329 const std::string &str_reason = "", bool reconnect = false);
330 void DenyAccess(session_t peer_id, AccessDeniedCode reason,
331 const std::string &custom_reason = "");
332 void acceptAuth(session_t peer_id, bool forSudoMode);
333 void DenyAccess_Legacy(session_t peer_id, const std::wstring &reason);
334 void DisconnectPeer(session_t peer_id);
335 bool getClientConInfo(session_t peer_id, con::rtt_stat_type type, float *retval);
336 bool getClientInfo(session_t peer_id, ClientState *state, u32 *uptime,
337 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
338 std::string* vers_string);
340 void printToConsoleOnly(const std::string &text);
342 void SendPlayerHPOrDie(PlayerSAO *player, const PlayerHPChangeReason &reason);
343 void SendPlayerBreath(PlayerSAO *sao);
344 void SendInventory(PlayerSAO *playerSAO, bool incremental);
345 void SendMovePlayer(session_t peer_id);
346 void SendPlayerSpeed(session_t peer_id, const v3f &added_vel);
347 void SendPlayerFov(session_t peer_id);
349 void sendDetachedInventories(session_t peer_id, bool incremental);
351 virtual bool registerModStorage(ModMetadata *storage);
352 virtual void unregisterModStorage(const std::string &name);
354 bool joinModChannel(const std::string &channel);
355 bool leaveModChannel(const std::string &channel);
356 bool sendModChannelMessage(const std::string &channel, const std::string &message);
357 ModChannel *getModChannel(const std::string &channel);
359 // Send block to specific player only
360 bool SendBlock(session_t peer_id, const v3s16 &blockpos);
365 // Environment mutex (envlock)
366 std::mutex m_env_mutex;
369 friend class EmergeThread;
370 friend class RemoteClient;
371 friend class TestServerShutdownState;
373 struct ShutdownState {
374 friend class TestServerShutdownState;
376 bool is_requested = false;
377 bool should_reconnect = false;
381 void trigger(float delay, const std::string &msg, bool reconnect);
382 void tick(float dtime, Server *server);
383 std::wstring getShutdownTimerMessage() const;
384 bool isTimerRunning() const { return m_timer > 0.0f; }
386 float m_timer = 0.0f;
389 void SendMovement(session_t peer_id);
390 void SendHP(session_t peer_id, u16 hp);
391 void SendBreath(session_t peer_id, u16 breath);
392 void SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
393 const std::string &custom_reason, bool reconnect = false);
394 void SendAccessDenied_Legacy(session_t peer_id, const std::wstring &reason);
395 void SendDeathscreen(session_t peer_id, bool set_camera_point_target,
396 v3f camera_point_target);
397 void SendItemDef(session_t peer_id, IItemDefManager *itemdef, u16 protocol_version);
398 void SendNodeDef(session_t peer_id, const NodeDefManager *nodedef,
399 u16 protocol_version);
401 /* mark blocks not sent for all clients */
402 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
405 virtual void SendChatMessage(session_t peer_id, const ChatMessage &message);
406 void SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed);
407 void SendPlayerHP(session_t peer_id);
409 void SendLocalPlayerAnimations(session_t peer_id, v2s32 animation_frames[4],
410 f32 animation_speed);
411 void SendEyeOffset(session_t peer_id, v3f first, v3f third);
412 void SendPlayerPrivileges(session_t peer_id);
413 void SendPlayerInventoryFormspec(session_t peer_id);
414 void SendPlayerFormspecPrepend(session_t peer_id);
415 void SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
416 const std::string &formname);
417 void SendHUDAdd(session_t peer_id, u32 id, HudElement *form);
418 void SendHUDRemove(session_t peer_id, u32 id);
419 void SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value);
420 void SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask);
421 void SendHUDSetParam(session_t peer_id, u16 param, const std::string &value);
422 void SendSetSky(session_t peer_id, const SkyboxParams ¶ms);
423 void SendSetSun(session_t peer_id, const SunParams ¶ms);
424 void SendSetMoon(session_t peer_id, const MoonParams ¶ms);
425 void SendSetStars(session_t peer_id, const StarParams ¶ms);
426 void SendCloudParams(session_t peer_id, const CloudParams ¶ms);
427 void SendOverrideDayNightRatio(session_t peer_id, bool do_override, float ratio);
428 void broadcastModChannelMessage(const std::string &channel,
429 const std::string &message, session_t from_peer);
432 Send a node removal/addition event to all clients except ignore_id.
433 Additionally, if far_players!=NULL, players further away than
434 far_d_nodes are ignored and their peer_ids are added to far_players
436 // Envlock and conlock should be locked when calling these
437 void sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players = nullptr,
438 float far_d_nodes = 100);
439 void sendAddNode(v3s16 p, MapNode n,
440 std::unordered_set<u16> *far_players = nullptr,
441 float far_d_nodes = 100, bool remove_metadata = true);
443 void sendMetadataChanged(const std::list<v3s16> &meta_updates,
444 float far_d_nodes = 100);
446 // Environment and Connection must be locked when called
447 void SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
449 // Sends blocks to clients (locks env and con on its own)
450 void SendBlocks(float dtime);
452 void fillMediaCache();
453 void sendMediaAnnouncement(session_t peer_id, const std::string &lang_code);
454 void sendRequestedMedia(session_t peer_id,
455 const std::vector<std::string> &tosend);
457 void sendDetachedInventory(const std::string &name, session_t peer_id);
459 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
460 void SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
461 u16 amount, float spawntime,
462 v3f minpos, v3f maxpos,
463 v3f minvel, v3f maxvel,
464 v3f minacc, v3f maxacc,
465 float minexptime, float maxexptime,
466 float minsize, float maxsize,
467 bool collisiondetection, bool collision_removal, bool object_collision,
469 bool vertical, const std::string &texture, u32 id,
470 const struct TileAnimationParams &animation, u8 glow);
472 void SendDeleteParticleSpawner(session_t peer_id, u32 id);
474 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
475 void SendSpawnParticle(session_t peer_id, u16 protocol_version,
476 v3f pos, v3f velocity, v3f acceleration,
477 float expirationtime, float size,
478 bool collisiondetection, bool collision_removal, bool object_collision,
479 bool vertical, const std::string &texture,
480 const struct TileAnimationParams &animation, u8 glow);
482 void SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao);
483 void SendActiveObjectMessages(session_t peer_id, const std::string &datas,
484 bool reliable = true);
485 void SendCSMRestrictionFlags(session_t peer_id);
491 void DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason);
492 void RespawnPlayer(session_t peer_id);
493 void DeleteClient(session_t peer_id, ClientDeletionReason reason);
494 void UpdateCrafting(RemotePlayer *player);
495 bool checkInteractDistance(RemotePlayer *player, const f32 d, const std::string &what);
497 void handleChatInterfaceEvent(ChatEvent *evt);
499 // This returns the answer to the sender of wmessage, or "" if there is none
500 std::wstring handleChat(const std::string &name, const std::wstring &wname,
501 std::wstring wmessage_input,
502 bool check_shout_priv = false,
503 RemotePlayer *player = NULL);
504 void handleAdminChat(const ChatEventChat *evt);
506 // When called, connection mutex should be locked
507 RemoteClient* getClient(session_t peer_id, ClientState state_min = CS_Active);
508 RemoteClient* getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
510 // When called, environment mutex should be locked
511 std::string getPlayerName(session_t peer_id);
512 PlayerSAO *getPlayerSAO(session_t peer_id);
515 Get a player from memory or creates one.
516 If player is already connected, return NULL
517 Does not verify/modify auth info and password.
519 Call with env and con locked.
521 PlayerSAO *emergePlayer(const char *name, session_t peer_id, u16 proto_version);
523 void handlePeerChanges();
529 std::string m_path_world;
530 // Subgame specification
531 SubgameSpec m_gamespec;
532 // If true, do not allow multiple players and hide some multiplayer
534 bool m_simple_singleplayer_mode;
535 u16 m_max_chatmessage_length;
536 // For "dedicated" server list flag
539 // Thread can set; step() will throw as ServerError
540 MutexedVariable<std::string> m_async_fatal_error;
543 float m_liquid_transform_timer = 0.0f;
544 float m_liquid_transform_every = 1.0f;
545 float m_masterserver_timer = 0.0f;
546 float m_emergethread_trigger_timer = 0.0f;
547 float m_savemap_timer = 0.0f;
548 IntervalLimiter m_map_timer_and_unload_interval;
551 ServerEnvironment *m_env = nullptr;
554 std::shared_ptr<con::Connection> m_con;
557 BanManager *m_banmanager = nullptr;
559 // Rollback manager (behind m_env_mutex)
560 IRollbackManager *m_rollback = nullptr;
563 EmergeManager *m_emerge = nullptr;
566 // Envlock and conlock should be locked when using Lua
567 ServerScripting *m_script = nullptr;
569 // Item definition manager
570 IWritableItemDefManager *m_itemdef;
572 // Node definition manager
573 NodeDefManager *m_nodedef;
575 // Craft definition manager
576 IWritableCraftDefManager *m_craftdef;
579 EventManager *m_event;
582 std::unique_ptr<ServerModManager> m_modmgr;
587 // A buffer for time steps
588 // step() increments and AsyncRunStep() run by m_thread reads it.
589 float m_step_dtime = 0.0f;
590 std::mutex m_step_dtime_mutex;
592 // current server step lag counter
595 // The server mainly operates in this thread
596 ServerThread *m_thread = nullptr;
601 // Timer for sending time of day over network
602 float m_time_of_day_send_timer = 0.0f;
603 // Uptime of server in seconds
604 MutexedVariable<double> m_uptime;
609 ClientInterface m_clients;
613 Queues stuff from peerAdded() and deletingPeer() to
616 std::queue<con::PeerChange> m_peer_change_queue;
618 std::unordered_map<session_t, std::string> m_formspec_state_data;
624 ShutdownState m_shutdown_state;
626 ChatInterface *m_admin_chat;
627 std::string m_admin_nick;
630 Map edit event queue. Automatically receives all map edits.
631 The constructor of this class registers us to receive them through
634 NOTE: Should these be moved to actually be members of
639 Queue of map edits from the environment for sending to the clients
640 This is behind m_env_mutex
642 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
644 If a non-empty area, map edit events contained within are left
645 unsent. Done at map generation time to speed up editing of the
646 generated area, as it will be sent anyway.
647 This is behind m_env_mutex
649 VoxelArea m_ignore_map_edit_events_area;
651 // media files known to server
652 std::unordered_map<std::string, MediaInfo> m_media;
657 std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
658 s32 m_next_sound_id = 0; // positive values only
662 Detached inventories (behind m_env_mutex)
665 std::map<std::string, Inventory*> m_detached_inventories;
666 // value = "" (visible to all players) or player name
667 std::map<std::string, std::string> m_detached_inventories_player;
669 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
670 float m_mod_storage_save_timer = 10.0f;
672 // CSM restrictions byteflag
673 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
674 u32 m_csm_restriction_noderange = 8;
676 // ModChannel manager
677 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
681 Runs a simple dedicated server loop.
683 Shuts down when kill is set to true.
685 void dedicated_server_loop(Server &server, bool &kill);