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" // TileAnimationParams
31 #include "particles.h" // ParticleParams
32 #include "network/peerhandler.h"
33 #include "network/address.h"
34 #include "util/numeric.h"
35 #include "util/thread.h"
36 #include "util/basic_macros.h"
37 #include "util/metricsbackend.h"
38 #include "serverenvironment.h"
39 #include "clientiface.h"
40 #include "chatmessage.h"
49 class IWritableItemDefManager;
51 class IWritableCraftDefManager;
58 struct PlayerHPChangeReason;
59 class IRollbackManager;
60 struct RollbackAction;
62 class ServerScripting;
63 class ServerEnvironment;
64 struct SimpleSoundSpec;
71 class ServerModManager;
72 class ServerInventoryManager;
74 enum ClientDeletionReason {
83 std::string sha1_digest;
85 MediaInfo(const std::string &path_="",
86 const std::string &sha1_digest_=""):
88 sha1_digest(sha1_digest_)
93 struct ServerSoundParams
104 float max_hear_distance = 32 * BS;
107 std::string to_player = "";
108 std::string exclude_player = "";
110 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
113 struct ServerPlayingSound
115 ServerSoundParams params;
116 SimpleSoundSpec spec;
117 std::unordered_set<session_t> clients; // peer ids
120 class Server : public con::PeerHandler, public MapEventReceiver,
125 NOTE: Every public method should be thread-safe
129 const std::string &path_world,
130 const SubgameSpec &gamespec,
131 bool simple_singleplayer_mode,
134 ChatInterface *iface = nullptr
137 DISABLE_CLASS_COPY(Server);
141 // This is mainly a way to pass the time to the server.
142 // Actual processing is done in an another thread.
143 void step(float dtime);
144 // This is run by ServerThread and does the actual processing
145 void AsyncRunStep(bool initial_step=false);
147 PlayerSAO* StageTwoClientInit(session_t peer_id);
153 void handleCommand(NetworkPacket* pkt);
155 void handleCommand_Null(NetworkPacket* pkt) {};
156 void handleCommand_Deprecated(NetworkPacket* pkt);
157 void handleCommand_Init(NetworkPacket* pkt);
158 void handleCommand_Init2(NetworkPacket* pkt);
159 void handleCommand_ModChannelJoin(NetworkPacket *pkt);
160 void handleCommand_ModChannelLeave(NetworkPacket *pkt);
161 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
162 void handleCommand_RequestMedia(NetworkPacket* pkt);
163 void handleCommand_ClientReady(NetworkPacket* pkt);
164 void handleCommand_GotBlocks(NetworkPacket* pkt);
165 void handleCommand_PlayerPos(NetworkPacket* pkt);
166 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
167 void handleCommand_InventoryAction(NetworkPacket* pkt);
168 void handleCommand_ChatMessage(NetworkPacket* pkt);
169 void handleCommand_Damage(NetworkPacket* pkt);
170 void handleCommand_PlayerItem(NetworkPacket* pkt);
171 void handleCommand_Respawn(NetworkPacket* pkt);
172 void handleCommand_Interact(NetworkPacket* pkt);
173 void handleCommand_RemovedSounds(NetworkPacket* pkt);
174 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
175 void handleCommand_InventoryFields(NetworkPacket* pkt);
176 void handleCommand_FirstSrp(NetworkPacket* pkt);
177 void handleCommand_SrpBytesA(NetworkPacket* pkt);
178 void handleCommand_SrpBytesM(NetworkPacket* pkt);
180 void ProcessData(NetworkPacket *pkt);
182 void Send(NetworkPacket *pkt);
183 void Send(session_t peer_id, NetworkPacket *pkt);
185 // Helper for handleCommand_PlayerPos and handleCommand_Interact
186 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
189 // Both setter and getter need no envlock,
190 // can be called freely from threads
191 void setTimeOfDay(u32 time);
194 Shall be called with the environment locked.
195 This is accessed by the map, which is inside the environment,
196 so it shouldn't be a problem.
198 void onMapEditEvent(const MapEditEvent &event);
200 // Connection must be locked when called
201 std::wstring getStatusString();
202 inline double getUptime() const { return m_uptime_counter->get(); }
204 // read shutdown state
205 inline bool isShutdownRequested() const { return m_shutdown_state.is_requested; }
207 // request server to shutdown
208 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
210 // Returns -1 if failed, sound handle on success
212 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms,
213 bool ephemeral=false);
214 void stopSound(s32 handle);
215 void fadeSound(s32 handle, float step, float gain);
218 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
219 bool checkPriv(const std::string &name, const std::string &priv);
220 void reportPrivsModified(const std::string &name=""); // ""=all
221 void reportInventoryFormspecModified(const std::string &name);
222 void reportFormspecPrependModified(const std::string &name);
224 void setIpBanned(const std::string &ip, const std::string &name);
225 void unsetIpBanned(const std::string &ip_or_name);
226 std::string getBanDescription(const std::string &ip_or_name);
228 void notifyPlayer(const char *name, const std::wstring &msg);
229 void notifyPlayers(const std::wstring &msg);
231 void spawnParticle(const std::string &playername,
232 const ParticleParameters &p);
234 u32 addParticleSpawner(const ParticleSpawnerParameters &p,
235 ServerActiveObject *attached, const std::string &playername);
237 void deleteParticleSpawner(const std::string &playername, u32 id);
239 bool dynamicAddMedia(const std::string &filepath);
241 ServerInventoryManager *getInventoryMgr() const { return m_inventory_mgr.get(); }
242 void sendDetachedInventory(Inventory *inventory, const std::string &name, session_t peer_id);
244 // Envlock and conlock should be locked when using scriptapi
245 ServerScripting *getScriptIface(){ return m_script; }
247 // actions: time-reversed list
248 // Return value: success/failure
249 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
250 std::list<std::string> *log);
252 // IGameDef interface
254 virtual IItemDefManager* getItemDefManager();
255 virtual const NodeDefManager* getNodeDefManager();
256 virtual ICraftDefManager* getCraftDefManager();
257 virtual u16 allocateUnknownNodeId(const std::string &name);
258 IRollbackManager *getRollbackManager() { return m_rollback; }
259 virtual EmergeManager *getEmergeManager() { return m_emerge; }
261 IWritableItemDefManager* getWritableItemDefManager();
262 NodeDefManager* getWritableNodeDefManager();
263 IWritableCraftDefManager* getWritableCraftDefManager();
265 virtual const std::vector<ModSpec> &getMods() const;
266 virtual const ModSpec* getModSpec(const std::string &modname) const;
267 void getModNames(std::vector<std::string> &modlist);
268 std::string getBuiltinLuaPath();
269 virtual std::string getWorldPath() const { return m_path_world; }
270 virtual std::string getModStoragePath() const;
272 inline bool isSingleplayer()
273 { return m_simple_singleplayer_mode; }
275 inline void setAsyncFatalError(const std::string &error)
276 { m_async_fatal_error.set(error); }
278 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
279 Map & getMap() { return m_env->getMap(); }
280 ServerEnvironment & getEnv() { return *m_env; }
283 u32 hudAdd(RemotePlayer *player, HudElement *element);
284 bool hudRemove(RemotePlayer *player, u32 id);
285 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
286 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
287 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
288 void hudSetHotbarImage(RemotePlayer *player, const std::string &name);
289 void hudSetHotbarSelectedImage(RemotePlayer *player, const std::string &name);
291 Address getPeerAddress(session_t peer_id);
293 void setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
295 void setPlayerEyeOffset(RemotePlayer *player, const v3f &first, const v3f &third);
297 void setSky(RemotePlayer *player, const SkyboxParams ¶ms);
298 void setSun(RemotePlayer *player, const SunParams ¶ms);
299 void setMoon(RemotePlayer *player, const MoonParams ¶ms);
300 void setStars(RemotePlayer *player, const StarParams ¶ms);
302 void setClouds(RemotePlayer *player, const CloudParams ¶ms);
304 void overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
306 /* con::PeerHandler implementation. */
307 void peerAdded(con::Peer *peer);
308 void deletingPeer(con::Peer *peer, bool timeout);
310 void DenySudoAccess(session_t peer_id);
311 void DenyAccessVerCompliant(session_t peer_id, u16 proto_ver, AccessDeniedCode reason,
312 const std::string &str_reason = "", bool reconnect = false);
313 void DenyAccess(session_t peer_id, AccessDeniedCode reason,
314 const std::string &custom_reason = "");
315 void acceptAuth(session_t peer_id, bool forSudoMode);
316 void DenyAccess_Legacy(session_t peer_id, const std::wstring &reason);
317 void DisconnectPeer(session_t peer_id);
318 bool getClientConInfo(session_t peer_id, con::rtt_stat_type type, float *retval);
319 bool getClientInfo(session_t peer_id, ClientState *state, u32 *uptime,
320 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
321 std::string* vers_string, std::string* lang_code);
323 void printToConsoleOnly(const std::string &text);
325 void SendPlayerHPOrDie(PlayerSAO *player, const PlayerHPChangeReason &reason);
326 void SendPlayerBreath(PlayerSAO *sao);
327 void SendInventory(PlayerSAO *playerSAO, bool incremental);
328 void SendMovePlayer(session_t peer_id);
329 void SendPlayerSpeed(session_t peer_id, const v3f &added_vel);
330 void SendPlayerFov(session_t peer_id);
332 void sendDetachedInventories(session_t peer_id, bool incremental);
334 virtual bool registerModStorage(ModMetadata *storage);
335 virtual void unregisterModStorage(const std::string &name);
337 bool joinModChannel(const std::string &channel);
338 bool leaveModChannel(const std::string &channel);
339 bool sendModChannelMessage(const std::string &channel, const std::string &message);
340 ModChannel *getModChannel(const std::string &channel);
342 // Send block to specific player only
343 bool SendBlock(session_t peer_id, const v3s16 &blockpos);
345 // Load translations for a language
346 void loadTranslationLanguage(const std::string &lang_code);
351 // Environment mutex (envlock)
352 std::mutex m_env_mutex;
355 friend class EmergeThread;
356 friend class RemoteClient;
357 friend class TestServerShutdownState;
359 struct ShutdownState {
360 friend class TestServerShutdownState;
362 bool is_requested = false;
363 bool should_reconnect = false;
367 void trigger(float delay, const std::string &msg, bool reconnect);
368 void tick(float dtime, Server *server);
369 std::wstring getShutdownTimerMessage() const;
370 bool isTimerRunning() const { return m_timer > 0.0f; }
372 float m_timer = 0.0f;
377 void SendMovement(session_t peer_id);
378 void SendHP(session_t peer_id, u16 hp);
379 void SendBreath(session_t peer_id, u16 breath);
380 void SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
381 const std::string &custom_reason, bool reconnect = false);
382 void SendAccessDenied_Legacy(session_t peer_id, const std::wstring &reason);
383 void SendDeathscreen(session_t peer_id, bool set_camera_point_target,
384 v3f camera_point_target);
385 void SendItemDef(session_t peer_id, IItemDefManager *itemdef, u16 protocol_version);
386 void SendNodeDef(session_t peer_id, const NodeDefManager *nodedef,
387 u16 protocol_version);
389 /* mark blocks not sent for all clients */
390 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
393 virtual void SendChatMessage(session_t peer_id, const ChatMessage &message);
394 void SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed);
395 void SendPlayerHP(session_t peer_id);
397 void SendLocalPlayerAnimations(session_t peer_id, v2s32 animation_frames[4],
398 f32 animation_speed);
399 void SendEyeOffset(session_t peer_id, v3f first, v3f third);
400 void SendPlayerPrivileges(session_t peer_id);
401 void SendPlayerInventoryFormspec(session_t peer_id);
402 void SendPlayerFormspecPrepend(session_t peer_id);
403 void SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
404 const std::string &formname);
405 void SendHUDAdd(session_t peer_id, u32 id, HudElement *form);
406 void SendHUDRemove(session_t peer_id, u32 id);
407 void SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value);
408 void SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask);
409 void SendHUDSetParam(session_t peer_id, u16 param, const std::string &value);
410 void SendSetSky(session_t peer_id, const SkyboxParams ¶ms);
411 void SendSetSun(session_t peer_id, const SunParams ¶ms);
412 void SendSetMoon(session_t peer_id, const MoonParams ¶ms);
413 void SendSetStars(session_t peer_id, const StarParams ¶ms);
414 void SendCloudParams(session_t peer_id, const CloudParams ¶ms);
415 void SendOverrideDayNightRatio(session_t peer_id, bool do_override, float ratio);
416 void broadcastModChannelMessage(const std::string &channel,
417 const std::string &message, session_t from_peer);
420 Send a node removal/addition event to all clients except ignore_id.
421 Additionally, if far_players!=NULL, players further away than
422 far_d_nodes are ignored and their peer_ids are added to far_players
424 // Envlock and conlock should be locked when calling these
425 void sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players = nullptr,
426 float far_d_nodes = 100);
427 void sendAddNode(v3s16 p, MapNode n,
428 std::unordered_set<u16> *far_players = nullptr,
429 float far_d_nodes = 100, bool remove_metadata = true);
431 void sendMetadataChanged(const std::list<v3s16> &meta_updates,
432 float far_d_nodes = 100);
434 // Environment and Connection must be locked when called
435 void SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
437 // Sends blocks to clients (locks env and con on its own)
438 void SendBlocks(float dtime);
440 bool addMediaFile(const std::string &filename, const std::string &filepath,
441 std::string *filedata = nullptr, std::string *digest = nullptr);
442 void fillMediaCache();
443 void sendMediaAnnouncement(session_t peer_id, const std::string &lang_code);
444 void sendRequestedMedia(session_t peer_id,
445 const std::vector<std::string> &tosend);
447 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
448 void SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
449 const ParticleSpawnerParameters &p, u16 attached_id, u32 id);
451 void SendDeleteParticleSpawner(session_t peer_id, u32 id);
453 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
454 void SendSpawnParticle(session_t peer_id, u16 protocol_version,
455 const ParticleParameters &p);
457 void SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao);
458 void SendActiveObjectMessages(session_t peer_id, const std::string &datas,
459 bool reliable = true);
460 void SendCSMRestrictionFlags(session_t peer_id);
466 void DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason);
467 void RespawnPlayer(session_t peer_id);
468 void DeleteClient(session_t peer_id, ClientDeletionReason reason);
469 void UpdateCrafting(RemotePlayer *player);
470 bool checkInteractDistance(RemotePlayer *player, const f32 d, const std::string &what);
472 void handleChatInterfaceEvent(ChatEvent *evt);
474 // This returns the answer to the sender of wmessage, or "" if there is none
475 std::wstring handleChat(const std::string &name, const std::wstring &wname,
476 std::wstring wmessage_input,
477 bool check_shout_priv = false,
478 RemotePlayer *player = NULL);
479 void handleAdminChat(const ChatEventChat *evt);
481 // When called, connection mutex should be locked
482 RemoteClient* getClient(session_t peer_id, ClientState state_min = CS_Active);
483 RemoteClient* getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
485 // When called, environment mutex should be locked
486 std::string getPlayerName(session_t peer_id);
487 PlayerSAO *getPlayerSAO(session_t peer_id);
490 Get a player from memory or creates one.
491 If player is already connected, return NULL
492 Does not verify/modify auth info and password.
494 Call with env and con locked.
496 PlayerSAO *emergePlayer(const char *name, session_t peer_id, u16 proto_version);
498 void handlePeerChanges();
504 std::string m_path_world;
505 // Subgame specification
506 SubgameSpec m_gamespec;
507 // If true, do not allow multiple players and hide some multiplayer
509 bool m_simple_singleplayer_mode;
510 u16 m_max_chatmessage_length;
511 // For "dedicated" server list flag
514 // Thread can set; step() will throw as ServerError
515 MutexedVariable<std::string> m_async_fatal_error;
518 float m_liquid_transform_timer = 0.0f;
519 float m_liquid_transform_every = 1.0f;
520 float m_masterserver_timer = 0.0f;
521 float m_emergethread_trigger_timer = 0.0f;
522 float m_savemap_timer = 0.0f;
523 IntervalLimiter m_map_timer_and_unload_interval;
526 ServerEnvironment *m_env = nullptr;
529 std::shared_ptr<con::Connection> m_con;
532 BanManager *m_banmanager = nullptr;
534 // Rollback manager (behind m_env_mutex)
535 IRollbackManager *m_rollback = nullptr;
538 EmergeManager *m_emerge = nullptr;
541 // Envlock and conlock should be locked when using Lua
542 ServerScripting *m_script = nullptr;
544 // Item definition manager
545 IWritableItemDefManager *m_itemdef;
547 // Node definition manager
548 NodeDefManager *m_nodedef;
550 // Craft definition manager
551 IWritableCraftDefManager *m_craftdef;
554 EventManager *m_event;
557 std::unique_ptr<ServerModManager> m_modmgr;
562 // A buffer for time steps
563 // step() increments and AsyncRunStep() run by m_thread reads it.
564 float m_step_dtime = 0.0f;
565 std::mutex m_step_dtime_mutex;
567 // The server mainly operates in this thread
568 ServerThread *m_thread = nullptr;
573 // Timer for sending time of day over network
574 float m_time_of_day_send_timer = 0.0f;
579 ClientInterface m_clients;
583 Queues stuff from peerAdded() and deletingPeer() to
586 std::queue<con::PeerChange> m_peer_change_queue;
588 std::unordered_map<session_t, std::string> m_formspec_state_data;
594 ShutdownState m_shutdown_state;
596 ChatInterface *m_admin_chat;
597 std::string m_admin_nick;
600 Map edit event queue. Automatically receives all map edits.
601 The constructor of this class registers us to receive them through
604 NOTE: Should these be moved to actually be members of
609 Queue of map edits from the environment for sending to the clients
610 This is behind m_env_mutex
612 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
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
619 VoxelArea m_ignore_map_edit_events_area;
621 // media files known to server
622 std::unordered_map<std::string, MediaInfo> m_media;
627 std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
628 s32 m_next_sound_id = 0; // positive values only
631 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
632 float m_mod_storage_save_timer = 10.0f;
634 // CSM restrictions byteflag
635 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
636 u32 m_csm_restriction_noderange = 8;
638 // ModChannel manager
639 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
642 std::unique_ptr<ServerInventoryManager> m_inventory_mgr;
644 // Global server metrics backend
645 std::unique_ptr<MetricsBackend> m_metrics_backend;
648 MetricCounterPtr m_uptime_counter;
649 MetricGaugePtr m_player_gauge;
650 MetricGaugePtr m_timeofday_gauge;
651 // current server step lag
652 MetricGaugePtr m_lag_gauge;
653 MetricCounterPtr m_aom_buffer_counter;
654 MetricCounterPtr m_packet_recv_counter;
655 MetricCounterPtr m_packet_recv_processed_counter;
659 Runs a simple dedicated server loop.
661 Shuts down when kill is set to true.
663 void dedicated_server_loop(Server &server, bool &kill);