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;
126 max_hear_distance(32*BS),
131 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
134 struct ServerPlayingSound
136 ServerSoundParams params;
137 SimpleSoundSpec spec;
138 UNORDERED_SET<u16> clients; // peer ids
141 class Server : public con::PeerHandler, public MapEventReceiver,
142 public InventoryManager, public IGameDef
146 NOTE: Every public method should be thread-safe
150 const std::string &path_world,
151 const SubgameSpec &gamespec,
152 bool simple_singleplayer_mode,
155 ChatInterface *iface = NULL
158 void start(Address bind_addr);
160 // This is mainly a way to pass the time to the server.
161 // Actual processing is done in an another thread.
162 void step(float dtime);
163 // This is run by ServerThread and does the actual processing
164 void AsyncRunStep(bool initial_step=false);
166 PlayerSAO* StageTwoClientInit(u16 peer_id);
172 void handleCommand(NetworkPacket* pkt);
174 void handleCommand_Null(NetworkPacket* pkt) {};
175 void handleCommand_Deprecated(NetworkPacket* pkt);
176 void handleCommand_Init(NetworkPacket* pkt);
177 void handleCommand_Init_Legacy(NetworkPacket* pkt);
178 void handleCommand_Init2(NetworkPacket* pkt);
179 void handleCommand_RequestMedia(NetworkPacket* pkt);
180 void handleCommand_ClientReady(NetworkPacket* pkt);
181 void handleCommand_GotBlocks(NetworkPacket* pkt);
182 void handleCommand_PlayerPos(NetworkPacket* pkt);
183 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
184 void handleCommand_InventoryAction(NetworkPacket* pkt);
185 void handleCommand_ChatMessage(NetworkPacket* pkt);
186 void handleCommand_Damage(NetworkPacket* pkt);
187 void handleCommand_Password(NetworkPacket* pkt);
188 void handleCommand_PlayerItem(NetworkPacket* pkt);
189 void handleCommand_Respawn(NetworkPacket* pkt);
190 void handleCommand_Interact(NetworkPacket* pkt);
191 void handleCommand_RemovedSounds(NetworkPacket* pkt);
192 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
193 void handleCommand_InventoryFields(NetworkPacket* pkt);
194 void handleCommand_FirstSrp(NetworkPacket* pkt);
195 void handleCommand_SrpBytesA(NetworkPacket* pkt);
196 void handleCommand_SrpBytesM(NetworkPacket* pkt);
198 void ProcessData(NetworkPacket *pkt);
200 void Send(NetworkPacket* pkt);
202 // Helper for handleCommand_PlayerPos and handleCommand_Interact
203 void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
206 // Both setter and getter need no envlock,
207 // can be called freely from threads
208 void setTimeOfDay(u32 time);
211 Shall be called with the environment locked.
212 This is accessed by the map, which is inside the environment,
213 so it shouldn't be a problem.
215 void onMapEditEvent(MapEditEvent *event);
218 Shall be called with the environment and the connection locked.
220 Inventory* getInventory(const InventoryLocation &loc);
221 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
223 // Connection must be locked when called
224 std::wstring getStatusString();
225 inline double getUptime() const { return m_uptime.m_value; }
227 // read shutdown state
228 inline bool getShutdownRequested() const { return m_shutdown_requested; }
230 // request server to shutdown
231 void requestShutdown(const std::string &msg, bool reconnect, float delay = 0.0f);
233 // Returns -1 if failed, sound handle on success
235 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
236 void stopSound(s32 handle);
237 void fadeSound(s32 handle, float step, float gain);
240 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
241 bool checkPriv(const std::string &name, const std::string &priv);
242 void reportPrivsModified(const std::string &name=""); // ""=all
243 void reportInventoryFormspecModified(const std::string &name);
245 void setIpBanned(const std::string &ip, const std::string &name);
246 void unsetIpBanned(const std::string &ip_or_name);
247 std::string getBanDescription(const std::string &ip_or_name);
249 void notifyPlayer(const char *name, const std::wstring &msg);
250 void notifyPlayers(const std::wstring &msg);
251 void spawnParticle(const std::string &playername,
252 v3f pos, v3f velocity, v3f acceleration,
253 float expirationtime, float size,
254 bool collisiondetection, bool collision_removal,
255 bool vertical, const std::string &texture,
256 const struct TileAnimationParams &animation, u8 glow);
258 u32 addParticleSpawner(u16 amount, float spawntime,
259 v3f minpos, v3f maxpos,
260 v3f minvel, v3f maxvel,
261 v3f minacc, v3f maxacc,
262 float minexptime, float maxexptime,
263 float minsize, float maxsize,
264 bool collisiondetection, bool collision_removal,
265 ServerActiveObject *attached,
266 bool vertical, const std::string &texture,
267 const std::string &playername, const struct TileAnimationParams &animation,
270 void deleteParticleSpawner(const std::string &playername, u32 id);
272 // Creates or resets inventory
273 Inventory* createDetachedInventory(const std::string &name, const std::string &player="");
275 // Envlock and conlock should be locked when using scriptapi
276 ServerScripting *getScriptIface(){ return m_script; }
278 // actions: time-reversed list
279 // Return value: success/failure
280 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
281 std::list<std::string> *log);
283 // IGameDef interface
285 virtual IItemDefManager* getItemDefManager();
286 virtual INodeDefManager* getNodeDefManager();
287 virtual ICraftDefManager* getCraftDefManager();
288 virtual u16 allocateUnknownNodeId(const std::string &name);
289 virtual MtEventManager* getEventManager();
290 IRollbackManager *getRollbackManager() { return m_rollback; }
291 virtual EmergeManager *getEmergeManager() { return m_emerge; }
293 IWritableItemDefManager* getWritableItemDefManager();
294 IWritableNodeDefManager* getWritableNodeDefManager();
295 IWritableCraftDefManager* getWritableCraftDefManager();
297 virtual const std::vector<ModSpec> &getMods() const { return m_mods; }
298 virtual const ModSpec* getModSpec(const std::string &modname) const;
299 void getModNames(std::vector<std::string> &modlist);
300 std::string getBuiltinLuaPath();
301 virtual std::string getWorldPath() const { return m_path_world; }
302 virtual std::string getModStoragePath() const;
304 inline bool isSingleplayer()
305 { return m_simple_singleplayer_mode; }
307 inline void setAsyncFatalError(const std::string &error)
308 { m_async_fatal_error.set(error); }
310 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
311 Map & getMap() { return m_env->getMap(); }
312 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 setClouds(RemotePlayer *player, float density,
341 const video::SColor &color_bright,
342 const video::SColor &color_ambient,
347 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
349 /* con::PeerHandler implementation. */
350 void peerAdded(con::Peer *peer);
351 void deletingPeer(con::Peer *peer, bool timeout);
353 void DenySudoAccess(u16 peer_id);
354 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
355 const std::string &str_reason = "", bool reconnect = false);
356 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
357 void acceptAuth(u16 peer_id, bool forSudoMode);
358 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
359 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
360 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
361 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
362 std::string* vers_string);
364 void printToConsoleOnly(const std::string &text);
366 void SendPlayerHPOrDie(PlayerSAO *player);
367 void SendPlayerBreath(PlayerSAO *sao);
368 void SendInventory(PlayerSAO* playerSAO);
369 void SendMovePlayer(u16 peer_id);
371 virtual bool registerModStorage(ModMetadata *storage);
372 virtual void unregisterModStorage(const std::string &name);
377 // Environment mutex (envlock)
382 friend class EmergeThread;
383 friend class RemoteClient;
385 void SendMovement(u16 peer_id);
386 void SendHP(u16 peer_id, u8 hp);
387 void SendBreath(u16 peer_id, u16 breath);
388 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
389 const std::string &custom_reason, bool reconnect = false);
390 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
391 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
392 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
393 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
395 /* mark blocks not sent for all clients */
396 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
399 void SendChatMessage(u16 peer_id, const std::wstring &message);
400 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
401 void SendPlayerHP(u16 peer_id);
403 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
404 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
405 void SendPlayerPrivileges(u16 peer_id);
406 void SendPlayerInventoryFormspec(u16 peer_id);
407 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
408 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
409 void SendHUDRemove(u16 peer_id, u32 id);
410 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
411 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
412 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
413 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
414 const std::string &type, const std::vector<std::string> ¶ms,
416 void SendCloudParams(u16 peer_id, float density,
417 const video::SColor &color_bright,
418 const video::SColor &color_ambient,
422 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
425 Send a node removal/addition event to all clients except ignore_id.
426 Additionally, if far_players!=NULL, players further away than
427 far_d_nodes are ignored and their peer_ids are added to far_players
429 // Envlock and conlock should be locked when calling these
430 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
431 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
432 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
433 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
434 bool remove_metadata=true);
435 void setBlockNotSent(v3s16 p);
437 // Environment and Connection must be locked when called
438 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
440 // Sends blocks to clients (locks env and con on its own)
441 void SendBlocks(float dtime);
443 void fillMediaCache();
444 void sendMediaAnnouncement(u16 peer_id);
445 void sendRequestedMedia(u16 peer_id,
446 const std::vector<std::string> &tosend);
448 void sendDetachedInventory(const std::string &name, u16 peer_id);
449 void sendDetachedInventories(u16 peer_id);
451 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
452 void SendAddParticleSpawner(u16 peer_id, u16 protocol_version,
453 u16 amount, float spawntime,
454 v3f minpos, v3f maxpos,
455 v3f minvel, v3f maxvel,
456 v3f minacc, v3f maxacc,
457 float minexptime, float maxexptime,
458 float minsize, float maxsize,
459 bool collisiondetection, bool collision_removal,
461 bool vertical, const std::string &texture, u32 id,
462 const struct TileAnimationParams &animation, u8 glow);
464 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
466 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
467 void SendSpawnParticle(u16 peer_id, u16 protocol_version,
468 v3f pos, v3f velocity, v3f acceleration,
469 float expirationtime, float size,
470 bool collisiondetection, bool collision_removal,
471 bool vertical, const std::string &texture,
472 const struct TileAnimationParams &animation, u8 glow);
474 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
475 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
480 void DiePlayer(u16 peer_id);
481 void RespawnPlayer(u16 peer_id);
482 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
483 void UpdateCrafting(RemotePlayer *player);
485 void handleChatInterfaceEvent(ChatEvent *evt);
487 // This returns the answer to the sender of wmessage, or "" if there is none
488 std::wstring handleChat(const std::string &name, const std::wstring &wname,
489 const std::wstring &wmessage,
490 bool check_shout_priv = false,
491 RemotePlayer *player = NULL);
492 void handleAdminChat(const ChatEventChat *evt);
494 // When called, connection mutex should be locked
495 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
496 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
498 // When called, environment mutex should be locked
499 std::string getPlayerName(u16 peer_id);
500 PlayerSAO* getPlayerSAO(u16 peer_id);
503 Get a player from memory or creates one.
504 If player is already connected, return NULL
505 Does not verify/modify auth info and password.
507 Call with env and con locked.
509 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
511 void handlePeerChanges();
518 std::string m_path_world;
519 // Subgame specification
520 SubgameSpec m_gamespec;
521 // If true, do not allow multiple players and hide some multiplayer
523 bool m_simple_singleplayer_mode;
524 u16 m_max_chatmessage_length;
525 // For "dedicated" server list flag
528 // Thread can set; step() will throw as ServerError
529 MutexedVariable<std::string> m_async_fatal_error;
532 float m_liquid_transform_timer;
533 float m_liquid_transform_every;
534 float m_masterserver_timer;
535 float m_emergethread_trigger_timer;
536 float m_savemap_timer;
537 IntervalLimiter m_map_timer_and_unload_interval;
540 ServerEnvironment *m_env;
543 con::Connection m_con;
546 BanManager *m_banmanager;
548 // Rollback manager (behind m_env_mutex)
549 IRollbackManager *m_rollback;
550 bool m_enable_rollback_recording; // Updated once in a while
553 EmergeManager *m_emerge;
556 // Envlock and conlock should be locked when using Lua
557 ServerScripting *m_script;
559 // Item definition manager
560 IWritableItemDefManager *m_itemdef;
562 // Node definition manager
563 IWritableNodeDefManager *m_nodedef;
565 // Craft definition manager
566 IWritableCraftDefManager *m_craftdef;
569 EventManager *m_event;
572 std::vector<ModSpec> m_mods;
578 // A buffer for time steps
579 // step() increments and AsyncRunStep() run by m_thread reads it.
581 Mutex m_step_dtime_mutex;
583 // current server step lag counter
586 // The server mainly operates in this thread
587 ServerThread *m_thread;
593 // Timer for sending time of day over network
594 float m_time_of_day_send_timer;
595 // Uptime of server in seconds
596 MutexedVariable<double> m_uptime;
600 ClientInterface m_clients;
604 Queues stuff from peerAdded() and deletingPeer() to
607 std::queue<con::PeerChange> m_peer_change_queue;
613 bool m_shutdown_requested;
614 std::string m_shutdown_msg;
615 bool m_shutdown_ask_reconnect;
616 float m_shutdown_timer;
618 ChatInterface *m_admin_chat;
619 std::string m_admin_nick;
622 Map edit event queue. Automatically receives all map edits.
623 The constructor of this class registers us to receive them through
626 NOTE: Should these be moved to actually be members of
631 Queue of map edits from the environment for sending to the clients
632 This is behind m_env_mutex
634 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
636 Set to true when the server itself is modifying the map and does
637 all sending of information by itself.
638 This is behind m_env_mutex
640 bool m_ignore_map_edit_events;
642 If a non-empty area, map edit events contained within are left
643 unsent. Done at map generation time to speed up editing of the
644 generated area, as it will be sent anyway.
645 This is behind m_env_mutex
647 VoxelArea m_ignore_map_edit_events_area;
649 If set to !=0, the incoming MapEditEvents are modified to have
650 this peed id as the disabled recipient
651 This is behind m_env_mutex
653 u16 m_ignore_map_edit_events_peer_id;
655 // media files known to server
656 UNORDERED_MAP<std::string, MediaInfo> m_media;
661 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
665 Detached inventories (behind m_env_mutex)
668 std::map<std::string, Inventory*> m_detached_inventories;
669 // value = "" (visible to all players) or player name
670 std::map<std::string, std::string> m_detached_inventories_player;
672 UNORDERED_MAP<std::string, ModMetadata *> m_mod_storages;
673 float m_mod_storage_save_timer;
675 DISABLE_CLASS_COPY(Server);
679 Runs a simple dedicated server loop.
681 Shuts down when kill is set to true.
683 void dedicated_server_loop(Server &server, bool &kill);