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.
23 #include "network/connection.h"
28 #include "serialization.h" // For SER_FMT_VER_INVALID
30 #include "inventorymanager.h"
32 #include "tileanimation.h" // struct TileAnimationParams
33 #include "util/numeric.h"
34 #include "util/thread.h"
35 #include "util/basic_macros.h"
36 #include "serverenvironment.h"
37 #include "chat_interface.h"
38 #include "clientiface.h"
39 #include "remoteplayer.h"
40 #include "network/networkpacket.h"
41 #include "chatmessage.h"
47 class IWritableItemDefManager;
48 class IWritableNodeDefManager;
49 class IWritableCraftDefManager;
54 class IRollbackManager;
55 struct RollbackAction;
57 class ServerScripting;
58 class ServerEnvironment;
59 struct SimpleSoundSpec;
62 enum ClientDeletionReason {
68 class MapEditEventAreaIgnorer
71 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
72 m_ignorevariable(ignorevariable)
74 if(m_ignorevariable->getVolume() == 0)
75 *m_ignorevariable = a;
77 m_ignorevariable = NULL;
80 ~MapEditEventAreaIgnorer()
84 assert(m_ignorevariable->getVolume() != 0);
85 *m_ignorevariable = VoxelArea();
90 VoxelArea *m_ignorevariable;
96 std::string sha1_digest;
98 MediaInfo(const std::string &path_="",
99 const std::string &sha1_digest_=""):
101 sha1_digest(sha1_digest_)
106 struct ServerSoundParams
117 float max_hear_distance = 32 * BS;
120 std::string to_player = "";
122 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
125 struct ServerPlayingSound
127 ServerSoundParams params;
128 SimpleSoundSpec spec;
129 std::unordered_set<u16> clients; // peer ids
132 class Server : public con::PeerHandler, public MapEventReceiver,
133 public InventoryManager, public IGameDef
137 NOTE: Every public method should be thread-safe
141 const std::string &path_world,
142 const SubgameSpec &gamespec,
143 bool simple_singleplayer_mode,
146 ChatInterface *iface = nullptr
149 DISABLE_CLASS_COPY(Server);
151 void start(Address bind_addr);
153 // This is mainly a way to pass the time to the server.
154 // Actual processing is done in an another thread.
155 void step(float dtime);
156 // This is run by ServerThread and does the actual processing
157 void AsyncRunStep(bool initial_step=false);
159 PlayerSAO* StageTwoClientInit(u16 peer_id);
165 void handleCommand(NetworkPacket* pkt);
167 void handleCommand_Null(NetworkPacket* pkt) {};
168 void handleCommand_Deprecated(NetworkPacket* pkt);
169 void handleCommand_Init(NetworkPacket* pkt);
170 void handleCommand_Init_Legacy(NetworkPacket* pkt);
171 void handleCommand_Init2(NetworkPacket* pkt);
172 void handleCommand_RequestMedia(NetworkPacket* pkt);
173 void handleCommand_ClientReady(NetworkPacket* pkt);
174 void handleCommand_GotBlocks(NetworkPacket* pkt);
175 void handleCommand_PlayerPos(NetworkPacket* pkt);
176 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
177 void handleCommand_InventoryAction(NetworkPacket* pkt);
178 void handleCommand_ChatMessage(NetworkPacket* pkt);
179 void handleCommand_Damage(NetworkPacket* pkt);
180 void handleCommand_Password(NetworkPacket* pkt);
181 void handleCommand_PlayerItem(NetworkPacket* pkt);
182 void handleCommand_Respawn(NetworkPacket* pkt);
183 void handleCommand_Interact(NetworkPacket* pkt);
184 void handleCommand_RemovedSounds(NetworkPacket* pkt);
185 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
186 void handleCommand_InventoryFields(NetworkPacket* pkt);
187 void handleCommand_FirstSrp(NetworkPacket* pkt);
188 void handleCommand_SrpBytesA(NetworkPacket* pkt);
189 void handleCommand_SrpBytesM(NetworkPacket* pkt);
191 void ProcessData(NetworkPacket *pkt);
193 void Send(NetworkPacket* pkt);
195 // Helper for handleCommand_PlayerPos and handleCommand_Interact
196 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
199 // Both setter and getter need no envlock,
200 // can be called freely from threads
201 void setTimeOfDay(u32 time);
204 Shall be called with the environment locked.
205 This is accessed by the map, which is inside the environment,
206 so it shouldn't be a problem.
208 void onMapEditEvent(MapEditEvent *event);
211 Shall be called with the environment and the connection locked.
213 Inventory* getInventory(const InventoryLocation &loc);
214 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
216 // Connection must be locked when called
217 std::wstring getStatusString();
218 inline double getUptime() const { return m_uptime.m_value; }
220 // read shutdown state
221 inline bool getShutdownRequested() const { return m_shutdown_requested; }
223 // request server to shutdown
224 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
226 // Returns -1 if failed, sound handle on success
228 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
229 void stopSound(s32 handle);
230 void fadeSound(s32 handle, float step, float gain);
233 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
234 bool checkPriv(const std::string &name, const std::string &priv);
235 void reportPrivsModified(const std::string &name=""); // ""=all
236 void reportInventoryFormspecModified(const std::string &name);
238 void setIpBanned(const std::string &ip, const std::string &name);
239 void unsetIpBanned(const std::string &ip_or_name);
240 std::string getBanDescription(const std::string &ip_or_name);
242 void notifyPlayer(const char *name, const std::wstring &msg);
243 void notifyPlayers(const std::wstring &msg);
244 void spawnParticle(const std::string &playername,
245 v3f pos, v3f velocity, v3f acceleration,
246 float expirationtime, float size,
247 bool collisiondetection, bool collision_removal,
248 bool vertical, const std::string &texture,
249 const struct TileAnimationParams &animation, u8 glow);
251 u32 addParticleSpawner(u16 amount, float spawntime,
252 v3f minpos, v3f maxpos,
253 v3f minvel, v3f maxvel,
254 v3f minacc, v3f maxacc,
255 float minexptime, float maxexptime,
256 float minsize, float maxsize,
257 bool collisiondetection, bool collision_removal,
258 ServerActiveObject *attached,
259 bool vertical, const std::string &texture,
260 const std::string &playername, const struct TileAnimationParams &animation,
263 void deleteParticleSpawner(const std::string &playername, u32 id);
265 // Creates or resets inventory
266 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
268 // Envlock and conlock should be locked when using scriptapi
269 ServerScripting *getScriptIface(){ return m_script; }
271 // actions: time-reversed list
272 // Return value: success/failure
273 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
274 std::list<std::string> *log);
276 // IGameDef interface
278 virtual IItemDefManager* getItemDefManager();
279 virtual INodeDefManager* getNodeDefManager();
280 virtual ICraftDefManager* getCraftDefManager();
281 virtual u16 allocateUnknownNodeId(const std::string &name);
282 virtual MtEventManager* getEventManager();
283 IRollbackManager *getRollbackManager() { return m_rollback; }
284 virtual EmergeManager *getEmergeManager() { return m_emerge; }
286 IWritableItemDefManager* getWritableItemDefManager();
287 IWritableNodeDefManager* getWritableNodeDefManager();
288 IWritableCraftDefManager* getWritableCraftDefManager();
290 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
291 virtual const ModSpec* getModSpec(const std::string &modname) const;
292 void getModNames(std::vector<std::string> &modlist);
293 std::string getBuiltinLuaPath();
294 virtual std::string getWorldPath() const { return m_path_world; }
295 virtual std::string getModStoragePath() const;
297 inline bool isSingleplayer()
298 { return m_simple_singleplayer_mode; }
300 inline void setAsyncFatalError(const std::string &error)
301 { m_async_fatal_error.set(error); }
303 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
304 Map & getMap() { return m_env->getMap(); }
305 ServerEnvironment & getEnv() { return *m_env; }
308 u32 hudAdd(RemotePlayer *player, HudElement *element);
309 bool hudRemove(RemotePlayer *player, u32 id);
310 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
311 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
312 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
313 s32 hudGetHotbarItemcount(RemotePlayer *player) const
314 { return player->getHotbarItemcount(); }
315 void hudSetHotbarImage(RemotePlayer *player, std::string name);
316 std::string hudGetHotbarImage(RemotePlayer *player);
317 void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
318 const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
320 return player->getHotbarSelectedImage();
323 inline Address getPeerAddress(u16 peer_id)
324 { return m_con.GetPeerAddress(peer_id); }
326 bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
328 bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
330 bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
331 const std::string &type, const std::vector<std::string> ¶ms,
333 bool setClouds(RemotePlayer *player, float density,
334 const video::SColor &color_bright,
335 const video::SColor &color_ambient,
340 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
342 /* con::PeerHandler implementation. */
343 void peerAdded(con::Peer *peer);
344 void deletingPeer(con::Peer *peer, bool timeout);
346 void DenySudoAccess(u16 peer_id);
347 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
348 const std::string &str_reason = "", bool reconnect = false);
349 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
350 void acceptAuth(u16 peer_id, bool forSudoMode);
351 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
352 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
353 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
354 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
355 std::string* vers_string);
357 void printToConsoleOnly(const std::string &text);
359 void SendPlayerHPOrDie(PlayerSAO *player);
360 void SendPlayerBreath(PlayerSAO *sao);
361 void SendInventory(PlayerSAO* playerSAO);
362 void SendMovePlayer(u16 peer_id);
364 virtual bool registerModStorage(ModMetadata *storage);
365 virtual void unregisterModStorage(const std::string &name);
370 // Environment mutex (envlock)
371 std::mutex m_env_mutex;
375 friend class EmergeThread;
376 friend class RemoteClient;
378 void SendMovement(u16 peer_id);
379 void SendHP(u16 peer_id, u8 hp);
380 void SendBreath(u16 peer_id, u16 breath);
381 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
382 const std::string &custom_reason, bool reconnect = false);
383 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
384 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
385 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
386 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
388 /* mark blocks not sent for all clients */
389 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
392 void SendChatMessage(u16 peer_id, const ChatMessage &message);
393 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
394 void SendPlayerHP(u16 peer_id);
396 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
397 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
398 void SendPlayerPrivileges(u16 peer_id);
399 void SendPlayerInventoryFormspec(u16 peer_id);
400 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
401 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
402 void SendHUDRemove(u16 peer_id, u32 id);
403 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
404 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
405 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
406 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
407 const std::string &type, const std::vector<std::string> ¶ms,
409 void SendCloudParams(u16 peer_id, float density,
410 const video::SColor &color_bright,
411 const video::SColor &color_ambient,
415 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
418 Send a node removal/addition event to all clients except ignore_id.
419 Additionally, if far_players!=NULL, players further away than
420 far_d_nodes are ignored and their peer_ids are added to far_players
422 // Envlock and conlock should be locked when calling these
423 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
424 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
425 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
426 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
427 bool remove_metadata=true);
428 void setBlockNotSent(v3s16 p);
430 // Environment and Connection must be locked when called
431 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
433 // Sends blocks to clients (locks env and con on its own)
434 void SendBlocks(float dtime);
436 void fillMediaCache();
437 void sendMediaAnnouncement(u16 peer_id);
438 void sendRequestedMedia(u16 peer_id,
439 const std::vector<std::string> &tosend);
441 void sendDetachedInventory(const std::string &name, u16 peer_id);
442 void sendDetachedInventories(u16 peer_id);
444 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
445 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
446 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 collision_removal,
454 bool vertical, const std::string &texture, u32 id,
455 const struct TileAnimationParams &animation, u8 glow);
457 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
459 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
460 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
461 v3f pos, v3f velocity, v3f acceleration,
462 float expirationtime, float size,
463 bool collisiondetection, bool collision_removal,
464 bool vertical, const std::string &texture,
465 const struct TileAnimationParams &animation, u8 glow);
467 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
468 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
473 void DiePlayer(u16 peer_id);
474 void RespawnPlayer(u16 peer_id);
475 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
476 void UpdateCrafting(RemotePlayer *player);
478 void handleChatInterfaceEvent(ChatEvent *evt);
480 // This returns the answer to the sender of wmessage, or "" if there is none
481 std::wstring handleChat(const std::string &name, const std::wstring &wname,
482 std::wstring wmessage_input,
483 bool check_shout_priv = false,
484 RemotePlayer *player = NULL);
485 void handleAdminChat(const ChatEventChat *evt);
487 // When called, connection mutex should be locked
488 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
489 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
491 // When called, environment mutex should be locked
492 std::string getPlayerName(u16 peer_id);
493 PlayerSAO* getPlayerSAO(u16 peer_id);
496 Get a player from memory or creates one.
497 If player is already connected, return NULL
498 Does not verify/modify auth info and password.
500 Call with env and con locked.
502 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
504 void handlePeerChanges();
511 std::string m_path_world;
512 // Subgame specification
513 SubgameSpec m_gamespec;
514 // If true, do not allow multiple players and hide some multiplayer
516 bool m_simple_singleplayer_mode;
517 u16 m_max_chatmessage_length;
518 // For "dedicated" server list flag
521 // Thread can set; step() will throw as ServerError
522 MutexedVariable<std::string> m_async_fatal_error;
525 float m_liquid_transform_timer = 0.0f;
526 float m_liquid_transform_every = 1.0f;
527 float m_masterserver_timer = 0.0f;
528 float m_emergethread_trigger_timer = 0.0f;
529 float m_savemap_timer = 0.0f;
530 IntervalLimiter m_map_timer_and_unload_interval;
533 ServerEnvironment *m_env = nullptr;
536 con::Connection m_con;
539 BanManager *m_banmanager = nullptr;
541 // Rollback manager (behind m_env_mutex)
542 IRollbackManager *m_rollback = nullptr;
543 bool m_enable_rollback_recording = false; // Updated once in a while
546 EmergeManager *m_emerge = nullptr;
549 // Envlock and conlock should be locked when using Lua
550 ServerScripting *m_script = nullptr;
552 // Item definition manager
553 IWritableItemDefManager *m_itemdef;
555 // Node definition manager
556 IWritableNodeDefManager *m_nodedef;
558 // Craft definition manager
559 IWritableCraftDefManager *m_craftdef;
562 EventManager *m_event;
565 std::vector<ModSpec> m_mods;
571 // A buffer for time steps
572 // step() increments and AsyncRunStep() run by m_thread reads it.
573 float m_step_dtime = 0.0f;
574 std::mutex m_step_dtime_mutex;
576 // current server step lag counter
579 // The server mainly operates in this thread
580 ServerThread *m_thread = nullptr;
586 // Timer for sending time of day over network
587 float m_time_of_day_send_timer = 0.0f;
588 // Uptime of server in seconds
589 MutexedVariable<double> m_uptime;
593 ClientInterface m_clients;
597 Queues stuff from peerAdded() and deletingPeer() to
600 std::queue<con::PeerChange> m_peer_change_queue;
606 bool m_shutdown_requested = false;
607 std::string m_shutdown_msg;
608 bool m_shutdown_ask_reconnect = false;
609 float m_shutdown_timer = 0.0f;
611 ChatInterface *m_admin_chat;
612 std::string m_admin_nick;
615 Map edit event queue. Automatically receives all map edits.
616 The constructor of this class registers us to receive them through
619 NOTE: Should these be moved to actually be members of
624 Queue of map edits from the environment for sending to the clients
625 This is behind m_env_mutex
627 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
629 Set to true when the server itself is modifying the map and does
630 all sending of information by itself.
631 This is behind m_env_mutex
633 bool m_ignore_map_edit_events = false;
635 If a non-empty area, map edit events contained within are left
636 unsent. Done at map generation time to speed up editing of the
637 generated area, as it will be sent anyway.
638 This is behind m_env_mutex
640 VoxelArea m_ignore_map_edit_events_area;
642 If set to !=0, the incoming MapEditEvents are modified to have
643 this peed id as the disabled recipient
644 This is behind m_env_mutex
646 u16 m_ignore_map_edit_events_peer_id = 0;
648 // media files known to server
649 std::unordered_map<std::string, MediaInfo> m_media;
654 std::unordered_map<s32, ServerPlayingSound> m_playing_sounds;
655 s32 m_next_sound_id = 0;
658 Detached inventories (behind m_env_mutex)
661 std::map<std::string, Inventory*> m_detached_inventories;
662 // value = "" (visible to all players) or player name
663 std::map<std::string, std::string> m_detached_inventories_player;
665 std::unordered_map<std::string, ModMetadata *> m_mod_storages;
666 float m_mod_storage_save_timer = 10.0f;
670 Runs a simple dedicated server loop.
672 Shuts down when kill is set to true.
674 void dedicated_server_loop(Server &server, bool &kill);