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"
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 class IWritableCraftDefManager;
53 class IRollbackManager;
54 struct RollbackAction;
56 class ServerScripting;
57 class ServerEnvironment;
58 struct SimpleSoundSpec;
61 enum ClientDeletionReason {
67 class MapEditEventAreaIgnorer
70 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
71 m_ignorevariable(ignorevariable)
73 if(m_ignorevariable->getVolume() == 0)
74 *m_ignorevariable = a;
76 m_ignorevariable = NULL;
79 ~MapEditEventAreaIgnorer()
83 assert(m_ignorevariable->getVolume() != 0);
84 *m_ignorevariable = VoxelArea();
89 VoxelArea *m_ignorevariable;
95 std::string sha1_digest;
97 MediaInfo(const std::string &path_="",
98 const std::string &sha1_digest_=""):
100 sha1_digest(sha1_digest_)
105 struct ServerSoundParams
108 std::string to_player;
116 float max_hear_distance;
125 max_hear_distance(32*BS),
129 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
132 struct ServerPlayingSound
134 ServerSoundParams params;
135 UNORDERED_SET<u16> clients; // peer ids
138 class Server : public con::PeerHandler, public MapEventReceiver,
139 public InventoryManager, public IGameDef
143 NOTE: Every public method should be thread-safe
147 const std::string &path_world,
148 const SubgameSpec &gamespec,
149 bool simple_singleplayer_mode,
151 ChatInterface *iface = NULL
154 void start(Address bind_addr);
156 // This is mainly a way to pass the time to the server.
157 // Actual processing is done in an another thread.
158 void step(float dtime);
159 // This is run by ServerThread and does the actual processing
160 void AsyncRunStep(bool initial_step=false);
162 PlayerSAO* StageTwoClientInit(u16 peer_id);
168 void handleCommand(NetworkPacket* pkt);
170 void handleCommand_Null(NetworkPacket* pkt) {};
171 void handleCommand_Deprecated(NetworkPacket* pkt);
172 void handleCommand_Init(NetworkPacket* pkt);
173 void handleCommand_Init_Legacy(NetworkPacket* pkt);
174 void handleCommand_Init2(NetworkPacket* pkt);
175 void handleCommand_RequestMedia(NetworkPacket* pkt);
176 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
177 void handleCommand_ClientReady(NetworkPacket* pkt);
178 void handleCommand_GotBlocks(NetworkPacket* pkt);
179 void handleCommand_PlayerPos(NetworkPacket* pkt);
180 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
181 void handleCommand_InventoryAction(NetworkPacket* pkt);
182 void handleCommand_ChatMessage(NetworkPacket* pkt);
183 void handleCommand_Damage(NetworkPacket* pkt);
184 void handleCommand_Password(NetworkPacket* pkt);
185 void handleCommand_PlayerItem(NetworkPacket* pkt);
186 void handleCommand_Respawn(NetworkPacket* pkt);
187 void handleCommand_Interact(NetworkPacket* pkt);
188 void handleCommand_RemovedSounds(NetworkPacket* pkt);
189 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
190 void handleCommand_InventoryFields(NetworkPacket* pkt);
191 void handleCommand_FirstSrp(NetworkPacket* pkt);
192 void handleCommand_SrpBytesA(NetworkPacket* pkt);
193 void handleCommand_SrpBytesM(NetworkPacket* pkt);
195 void ProcessData(NetworkPacket *pkt);
197 void Send(NetworkPacket* pkt);
199 // Helper for handleCommand_PlayerPos and handleCommand_Interact
200 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
203 // Both setter and getter need no envlock,
204 // can be called freely from threads
205 void setTimeOfDay(u32 time);
208 Shall be called with the environment locked.
209 This is accessed by the map, which is inside the environment,
210 so it shouldn't be a problem.
212 void onMapEditEvent(MapEditEvent *event);
215 Shall be called with the environment and the connection locked.
217 Inventory* getInventory(const InventoryLocation &loc);
218 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
220 // Connection must be locked when called
221 std::wstring getStatusString();
222 inline double getUptime() const { return m_uptime.m_value; }
224 // read shutdown state
225 inline bool getShutdownRequested() const { return m_shutdown_requested; }
227 // request server to shutdown
228 void requestShutdown(const std::string &msg, bool reconnect)
230 m_shutdown_requested = true;
231 m_shutdown_msg = msg;
232 m_shutdown_ask_reconnect = reconnect;
235 // Returns -1 if failed, sound handle on success
237 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
238 void stopSound(s32 handle);
241 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
242 bool checkPriv(const std::string &name, const std::string &priv);
243 void reportPrivsModified(const std::string &name=""); // ""=all
244 void reportInventoryFormspecModified(const std::string &name);
246 void setIpBanned(const std::string &ip, const std::string &name);
247 void unsetIpBanned(const std::string &ip_or_name);
248 std::string getBanDescription(const std::string &ip_or_name);
250 void notifyPlayer(const char *name, const std::wstring &msg);
251 void notifyPlayers(const std::wstring &msg);
252 void spawnParticle(const std::string &playername,
253 v3f pos, v3f velocity, v3f acceleration,
254 float expirationtime, float size,
255 bool collisiondetection, bool collision_removal,
256 bool vertical, const std::string &texture,
257 const struct TileAnimationParams &animation, u8 glow);
259 u32 addParticleSpawner(u16 amount, float spawntime,
260 v3f minpos, v3f maxpos,
261 v3f minvel, v3f maxvel,
262 v3f minacc, v3f maxacc,
263 float minexptime, float maxexptime,
264 float minsize, float maxsize,
265 bool collisiondetection, bool collision_removal,
266 ServerActiveObject *attached,
267 bool vertical, const std::string &texture,
268 const std::string &playername, const struct TileAnimationParams &animation,
271 void deleteParticleSpawner(const std::string &playername, u32 id);
273 // Creates or resets inventory
274 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
276 // Envlock and conlock should be locked when using scriptapi
277 ServerScripting *getScriptIface(){ return m_script; }
279 // actions: time-reversed list
280 // Return value: success/failure
281 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
282 std::list<std::string> *log);
284 // IGameDef interface
286 virtual IItemDefManager* getItemDefManager();
287 virtual INodeDefManager* getNodeDefManager();
288 virtual ICraftDefManager* getCraftDefManager();
289 virtual u16 allocateUnknownNodeId(const std::string &name);
290 virtual MtEventManager* getEventManager();
291 IRollbackManager *getRollbackManager() { return m_rollback; }
292 virtual EmergeManager *getEmergeManager() { return m_emerge; }
294 IWritableItemDefManager* getWritableItemDefManager();
295 IWritableNodeDefManager* getWritableNodeDefManager();
296 IWritableCraftDefManager* getWritableCraftDefManager();
298 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
299 virtual const ModSpec* getModSpec(const std::string &modname) const;
300 void getModNames(std::vector<std::string> &modlist);
301 std::string getBuiltinLuaPath();
302 std::string getWorldPath() const { return m_path_world; }
303 std::string getModStoragePath() const;
305 inline bool isSingleplayer()
306 { return m_simple_singleplayer_mode; }
308 inline void setAsyncFatalError(const std::string &error)
309 { m_async_fatal_error.set(error); }
311 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
312 Map & getMap() { return m_env->getMap(); }
313 ServerEnvironment & getEnv() { return *m_env; }
315 u32 hudAdd(RemotePlayer *player, HudElement *element);
316 bool hudRemove(RemotePlayer *player, u32 id);
317 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
318 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
319 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
320 s32 hudGetHotbarItemcount(RemotePlayer *player) const
321 { return player->getHotbarItemcount(); }
322 void hudSetHotbarImage(RemotePlayer *player, std::string name);
323 std::string hudGetHotbarImage(RemotePlayer *player);
324 void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
325 const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
327 return player->getHotbarSelectedImage();
330 inline Address getPeerAddress(u16 peer_id)
331 { return m_con.GetPeerAddress(peer_id); }
333 bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
335 bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
337 bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
338 const std::string &type, const std::vector<std::string> ¶ms);
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 bool registerModStorage(ModMetadata *storage);
365 void unregisterModStorage(const std::string &name);
370 // Environment mutex (envlock)
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 std::wstring &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);
408 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
411 Send a node removal/addition event to all clients except ignore_id.
412 Additionally, if far_players!=NULL, players further away than
413 far_d_nodes are ignored and their peer_ids are added to far_players
415 // Envlock and conlock should be locked when calling these
416 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
417 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
418 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
419 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
420 bool remove_metadata=true);
421 void setBlockNotSent(v3s16 p);
423 // Environment and Connection must be locked when called
424 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
426 // Sends blocks to clients (locks env and con on its own)
427 void SendBlocks(float dtime);
429 void fillMediaCache();
430 void sendMediaAnnouncement(u16 peer_id);
431 void sendRequestedMedia(u16 peer_id,
432 const std::vector<std::string> &tosend);
434 void sendDetachedInventory(const std::string &name, u16 peer_id);
435 void sendDetachedInventories(u16 peer_id);
437 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
438 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
439 u16 amount, float spawntime,
440 v3f minpos, v3f maxpos,
441 v3f minvel, v3f maxvel,
442 v3f minacc, v3f maxacc,
443 float minexptime, float maxexptime,
444 float minsize, float maxsize,
445 bool collisiondetection, bool collision_removal,
447 bool vertical, const std::string &texture, u32 id,
448 const struct TileAnimationParams &animation, u8 glow);
450 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
452 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
453 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
454 v3f pos, v3f velocity, v3f acceleration,
455 float expirationtime, float size,
456 bool collisiondetection, bool collision_removal,
457 bool vertical, const std::string &texture,
458 const struct TileAnimationParams &animation, u8 glow);
460 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
461 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
466 void DiePlayer(u16 peer_id);
467 void RespawnPlayer(u16 peer_id);
468 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
469 void UpdateCrafting(RemotePlayer *player);
471 void handleChatInterfaceEvent(ChatEvent *evt);
473 // This returns the answer to the sender of wmessage, or "" if there is none
474 std::wstring handleChat(const std::string &name, const std::wstring &wname,
475 const std::wstring &wmessage,
476 bool check_shout_priv = false,
477 RemotePlayer *player = NULL);
478 void handleAdminChat(const ChatEventChat *evt);
482 // When called, connection mutex should be locked
483 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
484 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
486 // When called, environment mutex should be locked
487 std::string getPlayerName(u16 peer_id);
488 PlayerSAO* getPlayerSAO(u16 peer_id);
491 Get a player from memory or creates one.
492 If player is already connected, return NULL
493 Does not verify/modify auth info and password.
495 Call with env and con locked.
497 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
499 void handlePeerChanges();
506 std::string m_path_world;
507 // Subgame specification
508 SubgameSpec m_gamespec;
509 // If true, do not allow multiple players and hide some multiplayer
511 bool m_simple_singleplayer_mode;
512 u16 m_max_chatmessage_length;
514 // Thread can set; step() will throw as ServerError
515 MutexedVariable<std::string> m_async_fatal_error;
518 float m_liquid_transform_timer;
519 float m_liquid_transform_every;
520 float m_masterserver_timer;
521 float m_emergethread_trigger_timer;
522 float m_savemap_timer;
523 IntervalLimiter m_map_timer_and_unload_interval;
526 ServerEnvironment *m_env;
529 con::Connection m_con;
532 BanManager *m_banmanager;
534 // Rollback manager (behind m_env_mutex)
535 IRollbackManager *m_rollback;
536 bool m_enable_rollback_recording; // Updated once in a while
539 EmergeManager *m_emerge;
542 // Envlock and conlock should be locked when using Lua
543 ServerScripting *m_script;
545 // Item definition manager
546 IWritableItemDefManager *m_itemdef;
548 // Node definition manager
549 IWritableNodeDefManager *m_nodedef;
551 // Craft definition manager
552 IWritableCraftDefManager *m_craftdef;
555 EventManager *m_event;
558 std::vector<ModSpec> m_mods;
564 // A buffer for time steps
565 // step() increments and AsyncRunStep() run by m_thread reads it.
567 Mutex m_step_dtime_mutex;
569 // current server step lag counter
572 // The server mainly operates in this thread
573 ServerThread *m_thread;
579 // Timer for sending time of day over network
580 float m_time_of_day_send_timer;
581 // Uptime of server in seconds
582 MutexedVariable<double> m_uptime;
586 ClientInterface m_clients;
590 Queues stuff from peerAdded() and deletingPeer() to
593 std::queue<con::PeerChange> m_peer_change_queue;
599 bool m_shutdown_requested;
600 std::string m_shutdown_msg;
601 bool m_shutdown_ask_reconnect;
603 ChatInterface *m_admin_chat;
604 std::string m_admin_nick;
607 Map edit event queue. Automatically receives all map edits.
608 The constructor of this class registers us to receive them through
611 NOTE: Should these be moved to actually be members of
616 Queue of map edits from the environment for sending to the clients
617 This is behind m_env_mutex
619 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
621 Set to true when the server itself is modifying the map and does
622 all sending of information by itself.
623 This is behind m_env_mutex
625 bool m_ignore_map_edit_events;
627 If a non-empty area, map edit events contained within are left
628 unsent. Done at map generation time to speed up editing of the
629 generated area, as it will be sent anyway.
630 This is behind m_env_mutex
632 VoxelArea m_ignore_map_edit_events_area;
634 If set to !=0, the incoming MapEditEvents are modified to have
635 this peed id as the disabled recipient
636 This is behind m_env_mutex
638 u16 m_ignore_map_edit_events_peer_id;
640 // media files known to server
641 UNORDERED_MAP<std::string, MediaInfo> m_media;
646 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
650 Detached inventories (behind m_env_mutex)
653 std::map<std::string, Inventory*> m_detached_inventories;
654 // value = "" (visible to all players) or player name
655 std::map<std::string, std::string> m_detached_inventories_player;
657 UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
658 float m_mod_storage_save_timer;
660 DISABLE_CLASS_COPY(Server);
664 Runs a simple dedicated server loop.
666 Shuts down when kill is set to true.
668 void dedicated_server_loop(Server &server, bool &kill);