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_ReceivedMedia(NetworkPacket* pkt);
178 void handleCommand_ClientReady(NetworkPacket* pkt);
179 void handleCommand_GotBlocks(NetworkPacket* pkt);
180 void handleCommand_PlayerPos(NetworkPacket* pkt);
181 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
182 void handleCommand_InventoryAction(NetworkPacket* pkt);
183 void handleCommand_ChatMessage(NetworkPacket* pkt);
184 void handleCommand_Damage(NetworkPacket* pkt);
185 void handleCommand_Password(NetworkPacket* pkt);
186 void handleCommand_PlayerItem(NetworkPacket* pkt);
187 void handleCommand_Respawn(NetworkPacket* pkt);
188 void handleCommand_Interact(NetworkPacket* pkt);
189 void handleCommand_RemovedSounds(NetworkPacket* pkt);
190 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
191 void handleCommand_InventoryFields(NetworkPacket* pkt);
192 void handleCommand_FirstSrp(NetworkPacket* pkt);
193 void handleCommand_SrpBytesA(NetworkPacket* pkt);
194 void handleCommand_SrpBytesM(NetworkPacket* pkt);
196 void ProcessData(NetworkPacket *pkt);
198 void Send(NetworkPacket* pkt);
200 // Helper for handleCommand_PlayerPos and handleCommand_Interact
201 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
204 // Both setter and getter need no envlock,
205 // can be called freely from threads
206 void setTimeOfDay(u32 time);
209 Shall be called with the environment locked.
210 This is accessed by the map, which is inside the environment,
211 so it shouldn't be a problem.
213 void onMapEditEvent(MapEditEvent *event);
216 Shall be called with the environment and the connection locked.
218 Inventory* getInventory(const InventoryLocation &loc);
219 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
221 // Connection must be locked when called
222 std::wstring getStatusString();
223 inline double getUptime() const { return m_uptime.m_value; }
225 // read shutdown state
226 inline bool getShutdownRequested() const { return m_shutdown_requested; }
228 // request server to shutdown
229 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
231 // Returns -1 if failed, sound handle on success
233 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
234 void stopSound(s32 handle);
237 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
238 bool checkPriv(const std::string &name, const std::string &priv);
239 void reportPrivsModified(const std::string &name=""); // ""=all
240 void reportInventoryFormspecModified(const std::string &name);
242 void setIpBanned(const std::string &ip, const std::string &name);
243 void unsetIpBanned(const std::string &ip_or_name);
244 std::string getBanDescription(const std::string &ip_or_name);
246 void notifyPlayer(const char *name, const std::wstring &msg);
247 void notifyPlayers(const std::wstring &msg);
248 void spawnParticle(const std::string &playername,
249 v3f pos, v3f velocity, v3f acceleration,
250 float expirationtime, float size,
251 bool collisiondetection, bool collision_removal,
252 bool vertical, const std::string &texture,
253 const struct TileAnimationParams &animation, u8 glow);
255 u32 addParticleSpawner(u16 amount, float spawntime,
256 v3f minpos, v3f maxpos,
257 v3f minvel, v3f maxvel,
258 v3f minacc, v3f maxacc,
259 float minexptime, float maxexptime,
260 float minsize, float maxsize,
261 bool collisiondetection, bool collision_removal,
262 ServerActiveObject *attached,
263 bool vertical, const std::string &texture,
264 const std::string &playername, const struct TileAnimationParams &animation,
267 void deleteParticleSpawner(const std::string &playername, u32 id);
269 // Creates or resets inventory
270 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
272 // Envlock and conlock should be locked when using scriptapi
273 ServerScripting *getScriptIface(){ return m_script; }
275 // actions: time-reversed list
276 // Return value: success/failure
277 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
278 std::list<std::string> *log);
280 // IGameDef interface
282 virtual IItemDefManager* getItemDefManager();
283 virtual INodeDefManager* getNodeDefManager();
284 virtual ICraftDefManager* getCraftDefManager();
285 virtual u16 allocateUnknownNodeId(const std::string &name);
286 virtual MtEventManager* getEventManager();
287 IRollbackManager *getRollbackManager() { return m_rollback; }
288 virtual EmergeManager *getEmergeManager() { return m_emerge; }
290 IWritableItemDefManager* getWritableItemDefManager();
291 IWritableNodeDefManager* getWritableNodeDefManager();
292 IWritableCraftDefManager* getWritableCraftDefManager();
294 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
295 virtual const ModSpec* getModSpec(const std::string &modname) const;
296 void getModNames(std::vector<std::string> &modlist);
297 std::string getBuiltinLuaPath();
298 virtual std::string getWorldPath() const { return m_path_world; }
299 virtual std::string getModStoragePath() const;
301 inline bool isSingleplayer()
302 { return m_simple_singleplayer_mode; }
304 inline void setAsyncFatalError(const std::string &error)
305 { m_async_fatal_error.set(error); }
307 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
308 Map & getMap() { return m_env->getMap(); }
309 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);
336 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
338 /* con::PeerHandler implementation. */
339 void peerAdded(con::Peer *peer);
340 void deletingPeer(con::Peer *peer, bool timeout);
342 void DenySudoAccess(u16 peer_id);
343 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
344 const std::string &str_reason = "", bool reconnect = false);
345 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
346 void acceptAuth(u16 peer_id, bool forSudoMode);
347 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
348 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
349 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
350 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
351 std::string* vers_string);
353 void printToConsoleOnly(const std::string &text);
355 void SendPlayerHPOrDie(PlayerSAO *player);
356 void SendPlayerBreath(PlayerSAO *sao);
357 void SendInventory(PlayerSAO* playerSAO);
358 void SendMovePlayer(u16 peer_id);
360 virtual bool registerModStorage(ModMetadata *storage);
361 virtual void unregisterModStorage(const std::string &name);
366 // Environment mutex (envlock)
371 friend class EmergeThread;
372 friend class RemoteClient;
374 void SendMovement(u16 peer_id);
375 void SendHP(u16 peer_id, u8 hp);
376 void SendBreath(u16 peer_id, u16 breath);
377 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
378 const std::string &custom_reason, bool reconnect = false);
379 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
380 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
381 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
382 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
384 /* mark blocks not sent for all clients */
385 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
388 void SendChatMessage(u16 peer_id, const std::wstring &message);
389 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
390 void SendPlayerHP(u16 peer_id);
392 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
393 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
394 void SendPlayerPrivileges(u16 peer_id);
395 void SendPlayerInventoryFormspec(u16 peer_id);
396 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
397 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
398 void SendHUDRemove(u16 peer_id, u32 id);
399 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
400 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
401 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
402 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
403 const std::string &type, const std::vector<std::string> ¶ms);
404 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
407 Send a node removal/addition event to all clients except ignore_id.
408 Additionally, if far_players!=NULL, players further away than
409 far_d_nodes are ignored and their peer_ids are added to far_players
411 // Envlock and conlock should be locked when calling these
412 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
413 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
414 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
415 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
416 bool remove_metadata=true);
417 void setBlockNotSent(v3s16 p);
419 // Environment and Connection must be locked when called
420 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
422 // Sends blocks to clients (locks env and con on its own)
423 void SendBlocks(float dtime);
425 void fillMediaCache();
426 void sendMediaAnnouncement(u16 peer_id);
427 void sendRequestedMedia(u16 peer_id,
428 const std::vector<std::string> &tosend);
430 void sendDetachedInventory(const std::string &name, u16 peer_id);
431 void sendDetachedInventories(u16 peer_id);
433 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
434 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
435 u16 amount, float spawntime,
436 v3f minpos, v3f maxpos,
437 v3f minvel, v3f maxvel,
438 v3f minacc, v3f maxacc,
439 float minexptime, float maxexptime,
440 float minsize, float maxsize,
441 bool collisiondetection, bool collision_removal,
443 bool vertical, const std::string &texture, u32 id,
444 const struct TileAnimationParams &animation, u8 glow);
446 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
448 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
449 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
450 v3f pos, v3f velocity, v3f acceleration,
451 float expirationtime, float size,
452 bool collisiondetection, bool collision_removal,
453 bool vertical, const std::string &texture,
454 const struct TileAnimationParams &animation, u8 glow);
456 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
457 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
462 void DiePlayer(u16 peer_id);
463 void RespawnPlayer(u16 peer_id);
464 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
465 void UpdateCrafting(RemotePlayer *player);
467 void handleChatInterfaceEvent(ChatEvent *evt);
469 // This returns the answer to the sender of wmessage, or "" if there is none
470 std::wstring handleChat(const std::string &name, const std::wstring &wname,
471 const std::wstring &wmessage,
472 bool check_shout_priv = false,
473 RemotePlayer *player = NULL);
474 void handleAdminChat(const ChatEventChat *evt);
478 // When called, connection mutex should be locked
479 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
480 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
482 // When called, environment mutex should be locked
483 std::string getPlayerName(u16 peer_id);
484 PlayerSAO* getPlayerSAO(u16 peer_id);
487 Get a player from memory or creates one.
488 If player is already connected, return NULL
489 Does not verify/modify auth info and password.
491 Call with env and con locked.
493 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
495 void handlePeerChanges();
502 std::string m_path_world;
503 // Subgame specification
504 SubgameSpec m_gamespec;
505 // If true, do not allow multiple players and hide some multiplayer
507 bool m_simple_singleplayer_mode;
508 u16 m_max_chatmessage_length;
509 // For "dedicated" server list flag
512 // Thread can set; step() will throw as ServerError
513 MutexedVariable<std::string> m_async_fatal_error;
516 float m_liquid_transform_timer;
517 float m_liquid_transform_every;
518 float m_masterserver_timer;
519 float m_emergethread_trigger_timer;
520 float m_savemap_timer;
521 IntervalLimiter m_map_timer_and_unload_interval;
524 ServerEnvironment *m_env;
527 con::Connection m_con;
530 BanManager *m_banmanager;
532 // Rollback manager (behind m_env_mutex)
533 IRollbackManager *m_rollback;
534 bool m_enable_rollback_recording; // Updated once in a while
537 EmergeManager *m_emerge;
540 // Envlock and conlock should be locked when using Lua
541 ServerScripting *m_script;
543 // Item definition manager
544 IWritableItemDefManager *m_itemdef;
546 // Node definition manager
547 IWritableNodeDefManager *m_nodedef;
549 // Craft definition manager
550 IWritableCraftDefManager *m_craftdef;
553 EventManager *m_event;
556 std::vector<ModSpec> m_mods;
562 // A buffer for time steps
563 // step() increments and AsyncRunStep() run by m_thread reads it.
565 Mutex m_step_dtime_mutex;
567 // current server step lag counter
570 // The server mainly operates in this thread
571 ServerThread *m_thread;
577 // Timer for sending time of day over network
578 float m_time_of_day_send_timer;
579 // Uptime of server in seconds
580 MutexedVariable<double> m_uptime;
584 ClientInterface m_clients;
588 Queues stuff from peerAdded() and deletingPeer() to
591 std::queue<con::PeerChange> m_peer_change_queue;
597 bool m_shutdown_requested;
598 std::string m_shutdown_msg;
599 bool m_shutdown_ask_reconnect;
600 float m_shutdown_timer;
602 ChatInterface *m_admin_chat;
603 std::string m_admin_nick;
606 Map edit event queue. Automatically receives all map edits.
607 The constructor of this class registers us to receive them through
610 NOTE: Should these be moved to actually be members of
615 Queue of map edits from the environment for sending to the clients
616 This is behind m_env_mutex
618 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
620 Set to true when the server itself is modifying the map and does
621 all sending of information by itself.
622 This is behind m_env_mutex
624 bool m_ignore_map_edit_events;
626 If a non-empty area, map edit events contained within are left
627 unsent. Done at map generation time to speed up editing of the
628 generated area, as it will be sent anyway.
629 This is behind m_env_mutex
631 VoxelArea m_ignore_map_edit_events_area;
633 If set to !=0, the incoming MapEditEvents are modified to have
634 this peed id as the disabled recipient
635 This is behind m_env_mutex
637 u16 m_ignore_map_edit_events_peer_id;
639 // media files known to server
640 UNORDERED_MAP<std::string, MediaInfo> m_media;
645 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
649 Detached inventories (behind m_env_mutex)
652 std::map<std::string, Inventory*> m_detached_inventories;
653 // value = "" (visible to all players) or player name
654 std::map<std::string, std::string> m_detached_inventories_player;
656 UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
657 float m_mod_storage_save_timer;
659 DISABLE_CLASS_COPY(Server);
663 Runs a simple dedicated server loop.
665 Shuts down when kill is set to true.
667 void dedicated_server_loop(Server &server, bool &kill);