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,
152 ChatInterface *iface = NULL
155 void start(Address bind_addr);
157 // This is mainly a way to pass the time to the server.
158 // Actual processing is done in an another thread.
159 void step(float dtime);
160 // This is run by ServerThread and does the actual processing
161 void AsyncRunStep(bool initial_step=false);
163 PlayerSAO* StageTwoClientInit(u16 peer_id);
169 void handleCommand(NetworkPacket* pkt);
171 void handleCommand_Null(NetworkPacket* pkt) {};
172 void handleCommand_Deprecated(NetworkPacket* pkt);
173 void handleCommand_Init(NetworkPacket* pkt);
174 void handleCommand_Init_Legacy(NetworkPacket* pkt);
175 void handleCommand_Init2(NetworkPacket* pkt);
176 void handleCommand_RequestMedia(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, float delay = 0.0f);
230 // Returns -1 if failed, sound handle on success
232 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
233 void stopSound(s32 handle);
236 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
237 bool checkPriv(const std::string &name, const std::string &priv);
238 void reportPrivsModified(const std::string &name=""); // ""=all
239 void reportInventoryFormspecModified(const std::string &name);
241 void setIpBanned(const std::string &ip, const std::string &name);
242 void unsetIpBanned(const std::string &ip_or_name);
243 std::string getBanDescription(const std::string &ip_or_name);
245 void notifyPlayer(const char *name, const std::wstring &msg);
246 void notifyPlayers(const std::wstring &msg);
247 void spawnParticle(const std::string &playername,
248 v3f pos, v3f velocity, v3f acceleration,
249 float expirationtime, float size,
250 bool collisiondetection, bool collision_removal,
251 bool vertical, const std::string &texture,
252 const struct TileAnimationParams &animation, u8 glow);
254 u32 addParticleSpawner(u16 amount, float spawntime,
255 v3f minpos, v3f maxpos,
256 v3f minvel, v3f maxvel,
257 v3f minacc, v3f maxacc,
258 float minexptime, float maxexptime,
259 float minsize, float maxsize,
260 bool collisiondetection, bool collision_removal,
261 ServerActiveObject *attached,
262 bool vertical, const std::string &texture,
263 const std::string &playername, const struct TileAnimationParams &animation,
266 void deleteParticleSpawner(const std::string &playername, u32 id);
268 // Creates or resets inventory
269 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
271 // Envlock and conlock should be locked when using scriptapi
272 ServerScripting *getScriptIface(){ return m_script; }
274 // actions: time-reversed list
275 // Return value: success/failure
276 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
277 std::list<std::string> *log);
279 // IGameDef interface
281 virtual IItemDefManager* getItemDefManager();
282 virtual INodeDefManager* getNodeDefManager();
283 virtual ICraftDefManager* getCraftDefManager();
284 virtual u16 allocateUnknownNodeId(const std::string &name);
285 virtual MtEventManager* getEventManager();
286 IRollbackManager *getRollbackManager() { return m_rollback; }
287 virtual EmergeManager *getEmergeManager() { return m_emerge; }
289 IWritableItemDefManager* getWritableItemDefManager();
290 IWritableNodeDefManager* getWritableNodeDefManager();
291 IWritableCraftDefManager* getWritableCraftDefManager();
293 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
294 virtual const ModSpec* getModSpec(const std::string &modname) const;
295 void getModNames(std::vector<std::string> &modlist);
296 std::string getBuiltinLuaPath();
297 virtual std::string getWorldPath() const { return m_path_world; }
298 virtual std::string getModStoragePath() const;
300 inline bool isSingleplayer()
301 { return m_simple_singleplayer_mode; }
303 inline void setAsyncFatalError(const std::string &error)
304 { m_async_fatal_error.set(error); }
306 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
307 Map & getMap() { return m_env->getMap(); }
308 ServerEnvironment & getEnv() { return *m_env; }
311 u32 hudAdd(RemotePlayer *player, HudElement *element);
312 bool hudRemove(RemotePlayer *player, u32 id);
313 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
314 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
315 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
316 s32 hudGetHotbarItemcount(RemotePlayer *player) const
317 { return player->getHotbarItemcount(); }
318 void hudSetHotbarImage(RemotePlayer *player, std::string name);
319 std::string hudGetHotbarImage(RemotePlayer *player);
320 void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
321 const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
323 return player->getHotbarSelectedImage();
326 inline Address getPeerAddress(u16 peer_id)
327 { return m_con.GetPeerAddress(peer_id); }
329 bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
331 bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
333 bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
334 const std::string &type, const std::vector<std::string> ¶ms);
335 bool setClouds(RemotePlayer *player, float density,
336 const video::SColor &color_bright,
337 const video::SColor &color_ambient,
342 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
344 /* con::PeerHandler implementation. */
345 void peerAdded(con::Peer *peer);
346 void deletingPeer(con::Peer *peer, bool timeout);
348 void DenySudoAccess(u16 peer_id);
349 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
350 const std::string &str_reason = "", bool reconnect = false);
351 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
352 void acceptAuth(u16 peer_id, bool forSudoMode);
353 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
354 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
355 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
356 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
357 std::string* vers_string);
359 void printToConsoleOnly(const std::string &text);
361 void SendPlayerHPOrDie(PlayerSAO *player);
362 void SendPlayerBreath(PlayerSAO *sao);
363 void SendInventory(PlayerSAO* playerSAO);
364 void SendMovePlayer(u16 peer_id);
366 virtual bool registerModStorage(ModMetadata *storage);
367 virtual void unregisterModStorage(const std::string &name);
372 // Environment mutex (envlock)
377 friend class EmergeThread;
378 friend class RemoteClient;
380 void SendMovement(u16 peer_id);
381 void SendHP(u16 peer_id, u8 hp);
382 void SendBreath(u16 peer_id, u16 breath);
383 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
384 const std::string &custom_reason, bool reconnect = false);
385 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
386 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
387 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
388 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
390 /* mark blocks not sent for all clients */
391 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
394 void SendChatMessage(u16 peer_id, const std::wstring &message);
395 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
396 void SendPlayerHP(u16 peer_id);
398 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
399 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
400 void SendPlayerPrivileges(u16 peer_id);
401 void SendPlayerInventoryFormspec(u16 peer_id);
402 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
403 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
404 void SendHUDRemove(u16 peer_id, u32 id);
405 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
406 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
407 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
408 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
409 const std::string &type, const std::vector<std::string> ¶ms);
410 void SendCloudParams(u16 peer_id, float density,
411 const video::SColor &color_bright,
412 const video::SColor &color_ambient,
416 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
419 Send a node removal/addition event to all clients except ignore_id.
420 Additionally, if far_players!=NULL, players further away than
421 far_d_nodes are ignored and their peer_ids are added to far_players
423 // Envlock and conlock should be locked when calling these
424 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
425 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
426 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
427 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
428 bool remove_metadata=true);
429 void setBlockNotSent(v3s16 p);
431 // Environment and Connection must be locked when called
432 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
434 // Sends blocks to clients (locks env and con on its own)
435 void SendBlocks(float dtime);
437 void fillMediaCache();
438 void sendMediaAnnouncement(u16 peer_id);
439 void sendRequestedMedia(u16 peer_id,
440 const std::vector<std::string> &tosend);
442 void sendDetachedInventory(const std::string &name, u16 peer_id);
443 void sendDetachedInventories(u16 peer_id);
445 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
446 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
447 u16 amount, float spawntime,
448 v3f minpos, v3f maxpos,
449 v3f minvel, v3f maxvel,
450 v3f minacc, v3f maxacc,
451 float minexptime, float maxexptime,
452 float minsize, float maxsize,
453 bool collisiondetection, bool collision_removal,
455 bool vertical, const std::string &texture, u32 id,
456 const struct TileAnimationParams &animation, u8 glow);
458 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
460 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
461 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
462 v3f pos, v3f velocity, v3f acceleration,
463 float expirationtime, float size,
464 bool collisiondetection, bool collision_removal,
465 bool vertical, const std::string &texture,
466 const struct TileAnimationParams &animation, u8 glow);
468 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
469 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
474 void DiePlayer(u16 peer_id);
475 void RespawnPlayer(u16 peer_id);
476 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
477 void UpdateCrafting(RemotePlayer *player);
479 void handleChatInterfaceEvent(ChatEvent *evt);
481 // This returns the answer to the sender of wmessage, or "" if there is none
482 std::wstring handleChat(const std::string &name, const std::wstring &wname,
483 const std::wstring &wmessage,
484 bool check_shout_priv = false,
485 RemotePlayer *player = NULL);
486 void handleAdminChat(const ChatEventChat *evt);
488 // When called, connection mutex should be locked
489 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
490 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
492 // When called, environment mutex should be locked
493 std::string getPlayerName(u16 peer_id);
494 PlayerSAO* getPlayerSAO(u16 peer_id);
497 Get a player from memory or creates one.
498 If player is already connected, return NULL
499 Does not verify/modify auth info and password.
501 Call with env and con locked.
503 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
505 void handlePeerChanges();
512 std::string m_path_world;
513 // Subgame specification
514 SubgameSpec m_gamespec;
515 // If true, do not allow multiple players and hide some multiplayer
517 bool m_simple_singleplayer_mode;
518 u16 m_max_chatmessage_length;
519 // For "dedicated" server list flag
522 // Thread can set; step() will throw as ServerError
523 MutexedVariable<std::string> m_async_fatal_error;
526 float m_liquid_transform_timer;
527 float m_liquid_transform_every;
528 float m_masterserver_timer;
529 float m_emergethread_trigger_timer;
530 float m_savemap_timer;
531 IntervalLimiter m_map_timer_and_unload_interval;
534 ServerEnvironment *m_env;
537 con::Connection m_con;
540 BanManager *m_banmanager;
542 // Rollback manager (behind m_env_mutex)
543 IRollbackManager *m_rollback;
544 bool m_enable_rollback_recording; // Updated once in a while
547 EmergeManager *m_emerge;
550 // Envlock and conlock should be locked when using Lua
551 ServerScripting *m_script;
553 // Item definition manager
554 IWritableItemDefManager *m_itemdef;
556 // Node definition manager
557 IWritableNodeDefManager *m_nodedef;
559 // Craft definition manager
560 IWritableCraftDefManager *m_craftdef;
563 EventManager *m_event;
566 std::vector<ModSpec> m_mods;
572 // A buffer for time steps
573 // step() increments and AsyncRunStep() run by m_thread reads it.
575 Mutex m_step_dtime_mutex;
577 // current server step lag counter
580 // The server mainly operates in this thread
581 ServerThread *m_thread;
587 // Timer for sending time of day over network
588 float m_time_of_day_send_timer;
589 // Uptime of server in seconds
590 MutexedVariable<double> m_uptime;
594 ClientInterface m_clients;
598 Queues stuff from peerAdded() and deletingPeer() to
601 std::queue<con::PeerChange> m_peer_change_queue;
607 bool m_shutdown_requested;
608 std::string m_shutdown_msg;
609 bool m_shutdown_ask_reconnect;
610 float m_shutdown_timer;
612 ChatInterface *m_admin_chat;
613 std::string m_admin_nick;
616 Map edit event queue. Automatically receives all map edits.
617 The constructor of this class registers us to receive them through
620 NOTE: Should these be moved to actually be members of
625 Queue of map edits from the environment for sending to the clients
626 This is behind m_env_mutex
628 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
630 Set to true when the server itself is modifying the map and does
631 all sending of information by itself.
632 This is behind m_env_mutex
634 bool m_ignore_map_edit_events;
636 If a non-empty area, map edit events contained within are left
637 unsent. Done at map generation time to speed up editing of the
638 generated area, as it will be sent anyway.
639 This is behind m_env_mutex
641 VoxelArea m_ignore_map_edit_events_area;
643 If set to !=0, the incoming MapEditEvents are modified to have
644 this peed id as the disabled recipient
645 This is behind m_env_mutex
647 u16 m_ignore_map_edit_events_peer_id;
649 // media files known to server
650 UNORDERED_MAP<std::string, MediaInfo> m_media;
655 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
659 Detached inventories (behind m_env_mutex)
662 std::map<std::string, Inventory*> m_detached_inventories;
663 // value = "" (visible to all players) or player name
664 std::map<std::string, std::string> m_detached_inventories_player;
666 UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
667 float m_mod_storage_save_timer;
669 DISABLE_CLASS_COPY(Server);
673 Runs a simple dedicated server loop.
675 Shuts down when kill is set to true.
677 void dedicated_server_loop(Server &server, bool &kill);