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 "util/metricsbackend.h"
37 #include "serverenvironment.h"
38 #include "clientiface.h"
39 #include "chatmessage.h"
48 class IWritableItemDefManager;
50 class IWritableCraftDefManager;
57 struct PlayerHPChangeReason;
58 class IRollbackManager;
59 struct RollbackAction;
61 class ServerScripting;
62 class ServerEnvironment;
63 struct SimpleSoundSpec;
70 class ServerModManager;
72 enum ClientDeletionReason {
81 std::string sha1_digest;
83 MediaInfo(const std::string &path_="",
84 const std::string &sha1_digest_=""):
86 sha1_digest(sha1_digest_)
91 struct ServerSoundParams
102 float max_hear_distance = 32 * BS;
105 std::string to_player = "";
106 std::string exclude_player = "";
108 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
111 struct ServerPlayingSound
113 ServerSoundParams params;
114 SimpleSoundSpec spec;
115 std::unordered_set<session_t> clients; // peer ids
118 class Server : public con::PeerHandler, public MapEventReceiver,
119 public InventoryManager, public IGameDef
123 NOTE: Every public method should be thread-safe
127 const std::string &path_world,
128 const SubgameSpec &gamespec,
129 bool simple_singleplayer_mode,
132 ChatInterface *iface = nullptr
135 DISABLE_CLASS_COPY(Server);
140 // This is mainly a way to pass the time to the server.
141 // Actual processing is done in an another thread.
142 void step(float dtime);
143 // This is run by ServerThread and does the actual processing
144 void AsyncRunStep(bool initial_step=false);
146 PlayerSAO* StageTwoClientInit(session_t peer_id);
152 void handleCommand(NetworkPacket* pkt);
154 void handleCommand_Null(NetworkPacket* pkt) {};
155 void handleCommand_Deprecated(NetworkPacket* pkt);
156 void handleCommand_Init(NetworkPacket* pkt);
157 void handleCommand_Init2(NetworkPacket* pkt);
158 void handleCommand_ModChannelJoin(NetworkPacket *pkt);
159 void handleCommand_ModChannelLeave(NetworkPacket *pkt);
160 void handleCommand_ModChannelMsg(NetworkPacket *pkt);
161 void handleCommand_RequestMedia(NetworkPacket* pkt);
162 void handleCommand_ClientReady(NetworkPacket* pkt);
163 void handleCommand_GotBlocks(NetworkPacket* pkt);
164 void handleCommand_PlayerPos(NetworkPacket* pkt);
165 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
166 void handleCommand_InventoryAction(NetworkPacket* pkt);
167 void handleCommand_ChatMessage(NetworkPacket* pkt);
168 void handleCommand_Damage(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_counter->get(); }
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, std::string* lang_code);
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);
362 // Load translations for a language
363 void loadTranslationLanguage(const std::string &lang_code);
368 // Environment mutex (envlock)
369 std::mutex m_env_mutex;
372 friend class EmergeThread;
373 friend class RemoteClient;
374 friend class TestServerShutdownState;
376 struct ShutdownState {
377 friend class TestServerShutdownState;
379 bool is_requested = false;
380 bool should_reconnect = false;
384 void trigger(float delay, const std::string &msg, bool reconnect);
385 void tick(float dtime, Server *server);
386 std::wstring getShutdownTimerMessage() const;
387 bool isTimerRunning() const { return m_timer > 0.0f; }
389 float m_timer = 0.0f;
392 void SendMovement(session_t peer_id);
393 void SendHP(session_t peer_id, u16 hp);
394 void SendBreath(session_t peer_id, u16 breath);
395 void SendAccessDenied(session_t peer_id, AccessDeniedCode reason,
396 const std::string &custom_reason, bool reconnect = false);
397 void SendAccessDenied_Legacy(session_t peer_id, const std::wstring &reason);
398 void SendDeathscreen(session_t peer_id, bool set_camera_point_target,
399 v3f camera_point_target);
400 void SendItemDef(session_t peer_id, IItemDefManager *itemdef, u16 protocol_version);
401 void SendNodeDef(session_t peer_id, const NodeDefManager *nodedef,
402 u16 protocol_version);
404 /* mark blocks not sent for all clients */
405 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
408 virtual void SendChatMessage(session_t peer_id, const ChatMessage &message);
409 void SendTimeOfDay(session_t peer_id, u16 time, f32 time_speed);
410 void SendPlayerHP(session_t peer_id);
412 void SendLocalPlayerAnimations(session_t peer_id, v2s32 animation_frames[4],
413 f32 animation_speed);
414 void SendEyeOffset(session_t peer_id, v3f first, v3f third);
415 void SendPlayerPrivileges(session_t peer_id);
416 void SendPlayerInventoryFormspec(session_t peer_id);
417 void SendPlayerFormspecPrepend(session_t peer_id);
418 void SendShowFormspecMessage(session_t peer_id, const std::string &formspec,
419 const std::string &formname);
420 void SendHUDAdd(session_t peer_id, u32 id, HudElement *form);
421 void SendHUDRemove(session_t peer_id, u32 id);
422 void SendHUDChange(session_t peer_id, u32 id, HudElementStat stat, void *value);
423 void SendHUDSetFlags(session_t peer_id, u32 flags, u32 mask);
424 void SendHUDSetParam(session_t peer_id, u16 param, const std::string &value);
425 void SendSetSky(session_t peer_id, const SkyboxParams ¶ms);
426 void SendSetSun(session_t peer_id, const SunParams ¶ms);
427 void SendSetMoon(session_t peer_id, const MoonParams ¶ms);
428 void SendSetStars(session_t peer_id, const StarParams ¶ms);
429 void SendCloudParams(session_t peer_id, const CloudParams ¶ms);
430 void SendOverrideDayNightRatio(session_t peer_id, bool do_override, float ratio);
431 void broadcastModChannelMessage(const std::string &channel,
432 const std::string &message, session_t from_peer);
435 Send a node removal/addition event to all clients except ignore_id.
436 Additionally, if far_players!=NULL, players further away than
437 far_d_nodes are ignored and their peer_ids are added to far_players
439 // Envlock and conlock should be locked when calling these
440 void sendRemoveNode(v3s16 p, std::unordered_set<u16> *far_players = nullptr,
441 float far_d_nodes = 100);
442 void sendAddNode(v3s16 p, MapNode n,
443 std::unordered_set<u16> *far_players = nullptr,
444 float far_d_nodes = 100, bool remove_metadata = true);
446 void sendMetadataChanged(const std::list<v3s16> &meta_updates,
447 float far_d_nodes = 100);
449 // Environment and Connection must be locked when called
450 void SendBlockNoLock(session_t peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
452 // Sends blocks to clients (locks env and con on its own)
453 void SendBlocks(float dtime);
455 void fillMediaCache();
456 void sendMediaAnnouncement(session_t peer_id, const std::string &lang_code);
457 void sendRequestedMedia(session_t peer_id,
458 const std::vector<std::string> &tosend);
460 void sendDetachedInventory(const std::string &name, session_t peer_id);
462 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
463 void SendAddParticleSpawner(session_t peer_id, u16 protocol_version,
464 u16 amount, float spawntime,
465 v3f minpos, v3f maxpos,
466 v3f minvel, v3f maxvel,
467 v3f minacc, v3f maxacc,
468 float minexptime, float maxexptime,
469 float minsize, float maxsize,
470 bool collisiondetection, bool collision_removal, bool object_collision,
472 bool vertical, const std::string &texture, u32 id,
473 const struct TileAnimationParams &animation, u8 glow);
475 void SendDeleteParticleSpawner(session_t peer_id, u32 id);
477 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
478 void SendSpawnParticle(session_t peer_id, u16 protocol_version,
479 v3f pos, v3f velocity, v3f acceleration,
480 float expirationtime, float size,
481 bool collisiondetection, bool collision_removal, bool object_collision,
482 bool vertical, const std::string &texture,
483 const struct TileAnimationParams &animation, u8 glow);
485 void SendActiveObjectRemoveAdd(RemoteClient *client, PlayerSAO *playersao);
486 void SendActiveObjectMessages(session_t peer_id, const std::string &datas,
487 bool reliable = true);
488 void SendCSMRestrictionFlags(session_t peer_id);
494 void DiePlayer(session_t peer_id, const PlayerHPChangeReason &reason);
495 void RespawnPlayer(session_t peer_id);
496 void DeleteClient(session_t peer_id, ClientDeletionReason reason);
497 void UpdateCrafting(RemotePlayer *player);
498 bool checkInteractDistance(RemotePlayer *player, const f32 d, const std::string &what);
500 void handleChatInterfaceEvent(ChatEvent *evt);
502 // This returns the answer to the sender of wmessage, or "" if there is none
503 std::wstring handleChat(const std::string &name, const std::wstring &wname,
504 std::wstring wmessage_input,
505 bool check_shout_priv = false,
506 RemotePlayer *player = NULL);
507 void handleAdminChat(const ChatEventChat *evt);
509 // When called, connection mutex should be locked
510 RemoteClient* getClient(session_t peer_id, ClientState state_min = CS_Active);
511 RemoteClient* getClientNoEx(session_t peer_id, ClientState state_min = CS_Active);
513 // When called, environment mutex should be locked
514 std::string getPlayerName(session_t peer_id);
515 PlayerSAO *getPlayerSAO(session_t peer_id);
518 Get a player from memory or creates one.
519 If player is already connected, return NULL
520 Does not verify/modify auth info and password.
522 Call with env and con locked.
524 PlayerSAO *emergePlayer(const char *name, session_t peer_id, u16 proto_version);
526 void handlePeerChanges();
532 std::string m_path_world;
533 // Subgame specification
534 SubgameSpec m_gamespec;
535 // If true, do not allow multiple players and hide some multiplayer
537 bool m_simple_singleplayer_mode;
538 u16 m_max_chatmessage_length;
539 // For "dedicated" server list flag
542 // Thread can set; step() will throw as ServerError
543 MutexedVariable<std::string> m_async_fatal_error;
546 float m_liquid_transform_timer = 0.0f;
547 float m_liquid_transform_every = 1.0f;
548 float m_masterserver_timer = 0.0f;
549 float m_emergethread_trigger_timer = 0.0f;
550 float m_savemap_timer = 0.0f;
551 IntervalLimiter m_map_timer_and_unload_interval;
554 ServerEnvironment *m_env = nullptr;
557 std::shared_ptr<con::Connection> m_con;
560 BanManager *m_banmanager = nullptr;
562 // Rollback manager (behind m_env_mutex)
563 IRollbackManager *m_rollback = nullptr;
566 EmergeManager *m_emerge = nullptr;
569 // Envlock and conlock should be locked when using Lua
570 ServerScripting *m_script = nullptr;
572 // Item definition manager
573 IWritableItemDefManager *m_itemdef;
575 // Node definition manager
576 NodeDefManager *m_nodedef;
578 // Craft definition manager
579 IWritableCraftDefManager *m_craftdef;
582 EventManager *m_event;
585 std::unique_ptr<ServerModManager> m_modmgr;
590 // A buffer for time steps
591 // step() increments and AsyncRunStep() run by m_thread reads it.
592 float m_step_dtime = 0.0f;
593 std::mutex m_step_dtime_mutex;
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;
607 ClientInterface m_clients;
611 Queues stuff from peerAdded() and deletingPeer() to
614 std::queue<con::PeerChange> m_peer_change_queue;
616 std::unordered_map<session_t, std::string> m_formspec_state_data;
622 ShutdownState m_shutdown_state;
624 ChatInterface *m_admin_chat;
625 std::string m_admin_nick;
628 Map edit event queue. Automatically receives all map edits.
629 The constructor of this class registers us to receive them through
632 NOTE: Should these be moved to actually be members of
637 Queue of map edits from the environment for sending to the clients
638 This is behind m_env_mutex
640 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
642 If a non-empty area, map edit events contained within are left
643 unsent. Done at map generation time to speed up editing of the
644 generated area, as it will be sent anyway.
645 This is behind m_env_mutex
647 VoxelArea m_ignore_map_edit_events_area;
649 // media files known to server
650 std::unordered_map<std::string, MediaInfo> m_media;
655 std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
656 s32 m_next_sound_id = 0; // positive values only
660 Detached inventories (behind m_env_mutex)
663 std::map<std::string, Inventory*> m_detached_inventories;
664 // value = "" (visible to all players) or player name
665 std::map<std::string, std::string> m_detached_inventories_player;
667 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
668 float m_mod_storage_save_timer = 10.0f;
670 // CSM restrictions byteflag
671 u64 m_csm_restriction_flags = CSMRestrictionFlags::CSM_RF_NONE;
672 u32 m_csm_restriction_noderange = 8;
674 // ModChannel manager
675 std::unique_ptr<ModChannelMgr> m_modchannel_mgr;
677 // Global server metrics backend
678 std::unique_ptr<MetricsBackend> m_metrics_backend;
681 MetricCounterPtr m_uptime_counter;
682 MetricGaugePtr m_player_gauge;
683 MetricGaugePtr m_timeofday_gauge;
684 // current server step lag
685 MetricGaugePtr m_lag_gauge;
686 MetricCounterPtr m_aom_buffer_counter;
687 MetricCounterPtr m_packet_recv_counter;
688 MetricCounterPtr m_packet_recv_processed_counter;
692 Runs a simple dedicated server loop.
694 Shuts down when kill is set to true.
696 void dedicated_server_loop(Server &server, bool &kill);