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
28 #include "inventorymanager.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;
48 class IWritableNodeDefManager;
49 class IWritableCraftDefManager;
55 class IRollbackManager;
56 struct RollbackAction;
58 class ServerScripting;
59 class ServerEnvironment;
60 struct SimpleSoundSpec;
63 enum ClientDeletionReason {
72 std::string sha1_digest;
74 MediaInfo(const std::string &path_="",
75 const std::string &sha1_digest_=""):
77 sha1_digest(sha1_digest_)
82 struct ServerSoundParams
93 float max_hear_distance = 32 * BS;
96 std::string to_player = "";
98 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
101 struct ServerPlayingSound
103 ServerSoundParams params;
104 SimpleSoundSpec spec;
105 std::unordered_set<u16> clients; // peer ids
108 class Server : public con::PeerHandler, public MapEventReceiver,
109 public InventoryManager, public IGameDef
113 NOTE: Every public method should be thread-safe
117 const std::string &path_world,
118 const SubgameSpec &gamespec,
119 bool simple_singleplayer_mode,
122 ChatInterface *iface = nullptr
125 DISABLE_CLASS_COPY(Server);
127 void start(Address bind_addr);
129 // This is mainly a way to pass the time to the server.
130 // Actual processing is done in an another thread.
131 void step(float dtime);
132 // This is run by ServerThread and does the actual processing
133 void AsyncRunStep(bool initial_step=false);
135 PlayerSAO* StageTwoClientInit(u16 peer_id);
141 void handleCommand(NetworkPacket* pkt);
143 void handleCommand_Null(NetworkPacket* pkt) {};
144 void handleCommand_Deprecated(NetworkPacket* pkt);
145 void handleCommand_Init(NetworkPacket* pkt);
146 void handleCommand_Init2(NetworkPacket* pkt);
147 void handleCommand_RequestMedia(NetworkPacket* pkt);
148 void handleCommand_ClientReady(NetworkPacket* pkt);
149 void handleCommand_GotBlocks(NetworkPacket* pkt);
150 void handleCommand_PlayerPos(NetworkPacket* pkt);
151 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
152 void handleCommand_InventoryAction(NetworkPacket* pkt);
153 void handleCommand_ChatMessage(NetworkPacket* pkt);
154 void handleCommand_Damage(NetworkPacket* pkt);
155 void handleCommand_Password(NetworkPacket* pkt);
156 void handleCommand_PlayerItem(NetworkPacket* pkt);
157 void handleCommand_Respawn(NetworkPacket* pkt);
158 void handleCommand_Interact(NetworkPacket* pkt);
159 void handleCommand_RemovedSounds(NetworkPacket* pkt);
160 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
161 void handleCommand_InventoryFields(NetworkPacket* pkt);
162 void handleCommand_FirstSrp(NetworkPacket* pkt);
163 void handleCommand_SrpBytesA(NetworkPacket* pkt);
164 void handleCommand_SrpBytesM(NetworkPacket* pkt);
166 void ProcessData(NetworkPacket *pkt);
168 void Send(NetworkPacket* pkt);
170 // Helper for handleCommand_PlayerPos and handleCommand_Interact
171 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
174 // Both setter and getter need no envlock,
175 // can be called freely from threads
176 void setTimeOfDay(u32 time);
179 Shall be called with the environment locked.
180 This is accessed by the map, which is inside the environment,
181 so it shouldn't be a problem.
183 void onMapEditEvent(MapEditEvent *event);
186 Shall be called with the environment and the connection locked.
188 Inventory* getInventory(const InventoryLocation &loc);
189 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
191 // Connection must be locked when called
192 std::wstring getStatusString();
193 inline double getUptime() const { return m_uptime.m_value; }
195 // read shutdown state
196 inline bool getShutdownRequested() const { return m_shutdown_requested; }
198 // request server to shutdown
199 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
201 // Returns -1 if failed, sound handle on success
203 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
204 void stopSound(s32 handle);
205 void fadeSound(s32 handle, float step, float gain);
208 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
209 bool checkPriv(const std::string &name, const std::string &priv);
210 void reportPrivsModified(const std::string &name=""); // ""=all
211 void reportInventoryFormspecModified(const std::string &name);
213 void setIpBanned(const std::string &ip, const std::string &name);
214 void unsetIpBanned(const std::string &ip_or_name);
215 std::string getBanDescription(const std::string &ip_or_name);
217 void notifyPlayer(const char *name, const std::wstring &msg);
218 void notifyPlayers(const std::wstring &msg);
219 void spawnParticle(const std::string &playername,
220 v3f pos, v3f velocity, v3f acceleration,
221 float expirationtime, float size,
222 bool collisiondetection, bool collision_removal,
223 bool vertical, const std::string &texture,
224 const struct TileAnimationParams &animation, u8 glow);
226 u32 addParticleSpawner(u16 amount, float spawntime,
227 v3f minpos, v3f maxpos,
228 v3f minvel, v3f maxvel,
229 v3f minacc, v3f maxacc,
230 float minexptime, float maxexptime,
231 float minsize, float maxsize,
232 bool collisiondetection, bool collision_removal,
233 ServerActiveObject *attached,
234 bool vertical, const std::string &texture,
235 const std::string &playername, const struct TileAnimationParams &animation,
238 void deleteParticleSpawner(const std::string &playername, u32 id);
240 // Creates or resets inventory
241 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
243 // Envlock and conlock should be locked when using scriptapi
244 ServerScripting *getScriptIface(){ return m_script; }
246 // actions: time-reversed list
247 // Return value: success/failure
248 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
249 std::list<std::string> *log);
251 // IGameDef interface
253 virtual IItemDefManager* getItemDefManager();
254 virtual INodeDefManager* getNodeDefManager();
255 virtual ICraftDefManager* getCraftDefManager();
256 virtual u16 allocateUnknownNodeId(const std::string &name);
257 virtual MtEventManager* getEventManager();
258 IRollbackManager *getRollbackManager() { return m_rollback; }
259 virtual EmergeManager *getEmergeManager() { return m_emerge; }
261 IWritableItemDefManager* getWritableItemDefManager();
262 IWritableNodeDefManager* getWritableNodeDefManager();
263 IWritableCraftDefManager* getWritableCraftDefManager();
265 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
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 s32 hudGetHotbarItemcount(RemotePlayer *player) const;
289 void hudSetHotbarImage(RemotePlayer *player, std::string name);
290 std::string hudGetHotbarImage(RemotePlayer *player);
291 void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
292 const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const;
294 Address getPeerAddress(u16 peer_id);
296 bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
298 bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
300 bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
301 const std::string &type, const std::vector<std::string> ¶ms,
303 bool setClouds(RemotePlayer *player, float density,
304 const video::SColor &color_bright,
305 const video::SColor &color_ambient,
310 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
312 /* con::PeerHandler implementation. */
313 void peerAdded(con::Peer *peer);
314 void deletingPeer(con::Peer *peer, bool timeout);
316 void DenySudoAccess(u16 peer_id);
317 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
318 const std::string &str_reason = "", bool reconnect = false);
319 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
320 void acceptAuth(u16 peer_id, bool forSudoMode);
321 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
322 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type, float* retval);
323 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
324 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
325 std::string* vers_string);
327 void printToConsoleOnly(const std::string &text);
329 void SendPlayerHPOrDie(PlayerSAO *player);
330 void SendPlayerBreath(PlayerSAO *sao);
331 void SendInventory(PlayerSAO* playerSAO);
332 void SendMovePlayer(u16 peer_id);
334 virtual bool registerModStorage(ModMetadata *storage);
335 virtual void unregisterModStorage(const std::string &name);
340 // Environment mutex (envlock)
341 std::mutex m_env_mutex;
345 friend class EmergeThread;
346 friend class RemoteClient;
348 void SendMovement(u16 peer_id);
349 void SendHP(u16 peer_id, u16 hp);
350 void SendBreath(u16 peer_id, u16 breath);
351 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
352 const std::string &custom_reason, bool reconnect = false);
353 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
354 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
355 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
356 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
358 /* mark blocks not sent for all clients */
359 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
362 void SendChatMessage(u16 peer_id, const ChatMessage &message);
363 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
364 void SendPlayerHP(u16 peer_id);
366 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
367 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
368 void SendPlayerPrivileges(u16 peer_id);
369 void SendPlayerInventoryFormspec(u16 peer_id);
370 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
371 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
372 void SendHUDRemove(u16 peer_id, u32 id);
373 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
374 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
375 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
376 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
377 const std::string &type, const std::vector<std::string> ¶ms,
379 void SendCloudParams(u16 peer_id, float density,
380 const video::SColor &color_bright,
381 const video::SColor &color_ambient,
385 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
388 Send a node removal/addition event to all clients except ignore_id.
389 Additionally, if far_players!=NULL, players further away than
390 far_d_nodes are ignored and their peer_ids are added to far_players
392 // Envlock and conlock should be locked when calling these
393 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
394 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
395 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
396 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
397 bool remove_metadata=true);
398 void setBlockNotSent(v3s16 p);
400 // Environment and Connection must be locked when called
401 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
403 // Sends blocks to clients (locks env and con on its own)
404 void SendBlocks(float dtime);
406 void fillMediaCache();
407 void sendMediaAnnouncement(u16 peer_id, const std::string &lang_code);
408 void sendRequestedMedia(u16 peer_id,
409 const std::vector<std::string> &tosend);
411 void sendDetachedInventory(const std::string &name, u16 peer_id);
412 void sendDetachedInventories(u16 peer_id);
414 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
415 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
416 u16 amount, float spawntime,
417 v3f minpos, v3f maxpos,
418 v3f minvel, v3f maxvel,
419 v3f minacc, v3f maxacc,
420 float minexptime, float maxexptime,
421 float minsize, float maxsize,
422 bool collisiondetection, bool collision_removal,
424 bool vertical, const std::string &texture, u32 id,
425 const struct TileAnimationParams &animation, u8 glow);
427 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
429 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
430 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
431 v3f pos, v3f velocity, v3f acceleration,
432 float expirationtime, float size,
433 bool collisiondetection, bool collision_removal,
434 bool vertical, const std::string &texture,
435 const struct TileAnimationParams &animation, u8 glow);
437 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
438 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
439 void SendCSMFlavourLimits(u16 peer_id);
445 void DiePlayer(u16 peer_id);
446 void RespawnPlayer(u16 peer_id);
447 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
448 void UpdateCrafting(RemotePlayer *player);
450 void handleChatInterfaceEvent(ChatEvent *evt);
452 // This returns the answer to the sender of wmessage, or "" if there is none
453 std::wstring handleChat(const std::string &name, const std::wstring &wname,
454 std::wstring wmessage_input,
455 bool check_shout_priv = false,
456 RemotePlayer *player = NULL);
457 void handleAdminChat(const ChatEventChat *evt);
459 // When called, connection mutex should be locked
460 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
461 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
463 // When called, environment mutex should be locked
464 std::string getPlayerName(u16 peer_id);
465 PlayerSAO* getPlayerSAO(u16 peer_id);
468 Get a player from memory or creates one.
469 If player is already connected, return NULL
470 Does not verify/modify auth info and password.
472 Call with env and con locked.
474 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
476 void handlePeerChanges();
483 std::string m_path_world;
484 // Subgame specification
485 SubgameSpec m_gamespec;
486 // If true, do not allow multiple players and hide some multiplayer
488 bool m_simple_singleplayer_mode;
489 u16 m_max_chatmessage_length;
490 // For "dedicated" server list flag
493 // Thread can set; step() will throw as ServerError
494 MutexedVariable<std::string> m_async_fatal_error;
497 float m_liquid_transform_timer = 0.0f;
498 float m_liquid_transform_every = 1.0f;
499 float m_masterserver_timer = 0.0f;
500 float m_emergethread_trigger_timer = 0.0f;
501 float m_savemap_timer = 0.0f;
502 IntervalLimiter m_map_timer_and_unload_interval;
505 ServerEnvironment *m_env = nullptr;
508 std::shared_ptr<con::Connection> m_con;
511 BanManager *m_banmanager = nullptr;
513 // Rollback manager (behind m_env_mutex)
514 IRollbackManager *m_rollback = nullptr;
515 bool m_enable_rollback_recording = false; // Updated once in a while
518 EmergeManager *m_emerge = nullptr;
521 // Envlock and conlock should be locked when using Lua
522 ServerScripting *m_script = nullptr;
524 // Item definition manager
525 IWritableItemDefManager *m_itemdef;
527 // Node definition manager
528 IWritableNodeDefManager *m_nodedef;
530 // Craft definition manager
531 IWritableCraftDefManager *m_craftdef;
534 EventManager *m_event;
537 std::vector<ModSpec> m_mods;
543 // A buffer for time steps
544 // step() increments and AsyncRunStep() run by m_thread reads it.
545 float m_step_dtime = 0.0f;
546 std::mutex m_step_dtime_mutex;
548 // current server step lag counter
551 // The server mainly operates in this thread
552 ServerThread *m_thread = nullptr;
558 // Timer for sending time of day over network
559 float m_time_of_day_send_timer = 0.0f;
560 // Uptime of server in seconds
561 MutexedVariable<double> m_uptime;
565 ClientInterface m_clients;
569 Queues stuff from peerAdded() and deletingPeer() to
572 std::queue<con::PeerChange> m_peer_change_queue;
578 bool m_shutdown_requested = false;
579 std::string m_shutdown_msg;
580 bool m_shutdown_ask_reconnect = false;
581 float m_shutdown_timer = 0.0f;
583 ChatInterface *m_admin_chat;
584 std::string m_admin_nick;
587 Map edit event queue. Automatically receives all map edits.
588 The constructor of this class registers us to receive them through
591 NOTE: Should these be moved to actually be members of
596 Queue of map edits from the environment for sending to the clients
597 This is behind m_env_mutex
599 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
601 Set to true when the server itself is modifying the map and does
602 all sending of information by itself.
603 This is behind m_env_mutex
605 bool m_ignore_map_edit_events = false;
607 If a non-empty area, map edit events contained within are left
608 unsent. Done at map generation time to speed up editing of the
609 generated area, as it will be sent anyway.
610 This is behind m_env_mutex
612 VoxelArea m_ignore_map_edit_events_area;
614 If set to !=0, the incoming MapEditEvents are modified to have
615 this peed id as the disabled recipient
616 This is behind m_env_mutex
618 u16 m_ignore_map_edit_events_peer_id = 0;
620 // media files known to server
621 std::unordered_map<std::string, MediaInfo> m_media;
626 std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
627 s32 m_next_sound_id = 0;
630 Detached inventories (behind m_env_mutex)
633 std::map<std::string, Inventory*> m_detached_inventories;
634 // value = "" (visible to all players) or player name
635 std::map<std::string, std::string> m_detached_inventories_player;
637 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
638 float m_mod_storage_save_timer = 10.0f;
640 // CSM flavour limits byteflag
641 u64 m_csm_flavour_limits = CSMFlavourLimit::CSM_FL_NONE;
642 u32 m_csm_noderange_limit = 8;
646 Runs a simple dedicated server loop.
648 Shuts down when kill is set to true.
650 void dedicated_server_loop(Server &server, bool &kill);