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 "util/numeric.h"
33 #include "util/thread.h"
34 #include "environment.h"
35 #include "chat_interface.h"
36 #include "clientiface.h"
37 #include "remoteplayer.h"
38 #include "network/networkpacket.h"
44 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 class IWritableCraftDefManager;
53 class IRollbackManager;
54 struct RollbackAction;
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_Breath(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 // Both setter and getter need no envlock,
201 // can be called freely from threads
202 void setTimeOfDay(u32 time);
205 Shall be called with the environment locked.
206 This is accessed by the map, which is inside the environment,
207 so it shouldn't be a problem.
209 void onMapEditEvent(MapEditEvent *event);
212 Shall be called with the environment and the connection locked.
214 Inventory* getInventory(const InventoryLocation &loc);
215 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
217 // Connection must be locked when called
218 std::wstring getStatusString();
219 inline double getUptime() const { return m_uptime.m_value; }
221 // read shutdown state
222 inline bool getShutdownRequested() const { return m_shutdown_requested; }
224 // request server to shutdown
225 void requestShutdown(const std::string &msg, bool reconnect)
227 m_shutdown_requested = true;
228 m_shutdown_msg = msg;
229 m_shutdown_ask_reconnect = reconnect;
232 // Returns -1 if failed, sound handle on success
234 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
235 void stopSound(s32 handle);
238 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
239 bool checkPriv(const std::string &name, const std::string &priv);
240 void reportPrivsModified(const std::string &name=""); // ""=all
241 void reportInventoryFormspecModified(const std::string &name);
243 void setIpBanned(const std::string &ip, const std::string &name);
244 void unsetIpBanned(const std::string &ip_or_name);
245 std::string getBanDescription(const std::string &ip_or_name);
247 void notifyPlayer(const char *name, const std::wstring &msg);
248 void notifyPlayers(const std::wstring &msg);
249 void spawnParticle(const std::string &playername,
250 v3f pos, v3f velocity, v3f acceleration,
251 float expirationtime, float size,
252 bool collisiondetection, bool collision_removal,
253 bool vertical, const std::string &texture);
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);
266 void deleteParticleSpawner(const std::string &playername, u32 id);
268 // Creates or resets inventory
269 Inventory* createDetachedInventory(const std::string &name);
271 // Envlock and conlock should be locked when using scriptapi
272 GameScripting *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 ITextureSource* getTextureSource();
285 virtual IShaderSource* getShaderSource();
286 virtual u16 allocateUnknownNodeId(const std::string &name);
287 virtual ISoundManager* getSoundManager();
288 virtual MtEventManager* getEventManager();
289 virtual scene::ISceneManager* getSceneManager();
290 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
291 virtual EmergeManager *getEmergeManager() { return m_emerge; }
293 IWritableItemDefManager* getWritableItemDefManager();
294 IWritableNodeDefManager* getWritableNodeDefManager();
295 IWritableCraftDefManager* getWritableCraftDefManager();
297 const ModSpec* getModSpec(const std::string &modname) const;
298 void getModNames(std::vector<std::string> &modlist);
299 std::string getBuiltinLuaPath();
300 inline std::string getWorldPath() const { return m_path_world; }
302 inline bool isSingleplayer()
303 { return m_simple_singleplayer_mode; }
305 inline void setAsyncFatalError(const std::string &error)
306 { m_async_fatal_error.set(error); }
308 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
309 Map & getMap() { return m_env->getMap(); }
310 ServerEnvironment & getEnv() { return *m_env; }
312 u32 hudAdd(RemotePlayer *player, HudElement *element);
313 bool hudRemove(RemotePlayer *player, u32 id);
314 bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
315 bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
316 bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
317 s32 hudGetHotbarItemcount(RemotePlayer *player) const
318 { return player->getHotbarItemcount(); }
319 void hudSetHotbarImage(RemotePlayer *player, std::string name);
320 std::string hudGetHotbarImage(RemotePlayer *player);
321 void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
322 const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
324 return player->getHotbarSelectedImage();
327 inline Address getPeerAddress(u16 peer_id)
328 { return m_con.GetPeerAddress(peer_id); }
330 bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
332 bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
334 bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
335 const std::string &type, const std::vector<std::string> ¶ms);
337 bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
339 /* con::PeerHandler implementation. */
340 void peerAdded(con::Peer *peer);
341 void deletingPeer(con::Peer *peer, bool timeout);
343 void DenySudoAccess(u16 peer_id);
344 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
345 const std::string &str_reason = "", bool reconnect = false);
346 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
347 void acceptAuth(u16 peer_id, bool forSudoMode);
348 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
349 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
350 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
351 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
352 std::string* vers_string);
354 void printToConsoleOnly(const std::string &text);
356 void SendPlayerHPOrDie(PlayerSAO *player);
357 void SendPlayerBreath(u16 peer_id);
358 void SendInventory(PlayerSAO* playerSAO);
359 void SendMovePlayer(u16 peer_id);
364 // Environment mutex (envlock)
369 friend class EmergeThread;
370 friend class RemoteClient;
372 void SendMovement(u16 peer_id);
373 void SendHP(u16 peer_id, u8 hp);
374 void SendBreath(u16 peer_id, u16 breath);
375 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
376 const std::string &custom_reason, bool reconnect = false);
377 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
378 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
379 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
380 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
382 /* mark blocks not sent for all clients */
383 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
386 void SendChatMessage(u16 peer_id, const std::wstring &message);
387 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
388 void SendPlayerHP(u16 peer_id);
390 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
391 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
392 void SendPlayerPrivileges(u16 peer_id);
393 void SendPlayerInventoryFormspec(u16 peer_id);
394 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
395 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
396 void SendHUDRemove(u16 peer_id, u32 id);
397 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
398 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
399 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
400 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
401 const std::string &type, const std::vector<std::string> ¶ms);
402 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
405 Send a node removal/addition event to all clients except ignore_id.
406 Additionally, if far_players!=NULL, players further away than
407 far_d_nodes are ignored and their peer_ids are added to far_players
409 // Envlock and conlock should be locked when calling these
410 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
411 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
412 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
413 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
414 bool remove_metadata=true);
415 void setBlockNotSent(v3s16 p);
417 // Environment and Connection must be locked when called
418 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
420 // Sends blocks to clients (locks env and con on its own)
421 void SendBlocks(float dtime);
423 void fillMediaCache();
424 void sendMediaAnnouncement(u16 peer_id);
425 void sendRequestedMedia(u16 peer_id,
426 const std::vector<std::string> &tosend);
428 void sendDetachedInventory(const std::string &name, u16 peer_id);
429 void sendDetachedInventories(u16 peer_id);
431 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
432 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
433 v3f minpos, v3f maxpos,
434 v3f minvel, v3f maxvel,
435 v3f minacc, v3f maxacc,
436 float minexptime, float maxexptime,
437 float minsize, float maxsize,
438 bool collisiondetection, bool collision_removal,
440 bool vertical, const std::string &texture, u32 id);
442 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
444 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
445 void SendSpawnParticle(u16 peer_id,
446 v3f pos, v3f velocity, v3f acceleration,
447 float expirationtime, float size,
448 bool collisiondetection, bool collision_removal,
449 bool vertical, const std::string &texture);
451 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
452 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
457 void DiePlayer(u16 peer_id);
458 void RespawnPlayer(u16 peer_id);
459 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
460 void UpdateCrafting(RemotePlayer *player);
462 void handleChatInterfaceEvent(ChatEvent *evt);
464 // This returns the answer to the sender of wmessage, or "" if there is none
465 std::wstring handleChat(const std::string &name, const std::wstring &wname,
466 const std::wstring &wmessage,
467 bool check_shout_priv = false,
468 RemotePlayer *player = NULL);
469 void handleAdminChat(const ChatEventChat *evt);
473 // When called, connection mutex should be locked
474 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
475 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
477 // When called, environment mutex should be locked
478 std::string getPlayerName(u16 peer_id);
479 PlayerSAO* getPlayerSAO(u16 peer_id);
482 Get a player from memory or creates one.
483 If player is already connected, return NULL
484 Does not verify/modify auth info and password.
486 Call with env and con locked.
488 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
490 void handlePeerChanges();
497 std::string m_path_world;
498 // Subgame specification
499 SubgameSpec m_gamespec;
500 // If true, do not allow multiple players and hide some multiplayer
502 bool m_simple_singleplayer_mode;
503 u16 m_max_chatmessage_length;
505 // Thread can set; step() will throw as ServerError
506 MutexedVariable<std::string> m_async_fatal_error;
509 float m_liquid_transform_timer;
510 float m_liquid_transform_every;
511 float m_masterserver_timer;
512 float m_emergethread_trigger_timer;
513 float m_savemap_timer;
514 IntervalLimiter m_map_timer_and_unload_interval;
517 ServerEnvironment *m_env;
520 con::Connection m_con;
523 BanManager *m_banmanager;
525 // Rollback manager (behind m_env_mutex)
526 IRollbackManager *m_rollback;
527 bool m_enable_rollback_recording; // Updated once in a while
530 EmergeManager *m_emerge;
533 // Envlock and conlock should be locked when using Lua
534 GameScripting *m_script;
536 // Item definition manager
537 IWritableItemDefManager *m_itemdef;
539 // Node definition manager
540 IWritableNodeDefManager *m_nodedef;
542 // Craft definition manager
543 IWritableCraftDefManager *m_craftdef;
546 EventManager *m_event;
549 std::vector<ModSpec> m_mods;
555 // A buffer for time steps
556 // step() increments and AsyncRunStep() run by m_thread reads it.
558 Mutex m_step_dtime_mutex;
560 // current server step lag counter
563 // The server mainly operates in this thread
564 ServerThread *m_thread;
570 // Timer for sending time of day over network
571 float m_time_of_day_send_timer;
572 // Uptime of server in seconds
573 MutexedVariable<double> m_uptime;
578 ClientInterface m_clients;
582 Queues stuff from peerAdded() and deletingPeer() to
585 std::queue<con::PeerChange> m_peer_change_queue;
591 bool m_shutdown_requested;
592 std::string m_shutdown_msg;
593 bool m_shutdown_ask_reconnect;
595 ChatInterface *m_admin_chat;
596 std::string m_admin_nick;
599 Map edit event queue. Automatically receives all map edits.
600 The constructor of this class registers us to receive them through
603 NOTE: Should these be moved to actually be members of
608 Queue of map edits from the environment for sending to the clients
609 This is behind m_env_mutex
611 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
613 Set to true when the server itself is modifying the map and does
614 all sending of information by itself.
615 This is behind m_env_mutex
617 bool m_ignore_map_edit_events;
619 If a non-empty area, map edit events contained within are left
620 unsent. Done at map generation time to speed up editing of the
621 generated area, as it will be sent anyway.
622 This is behind m_env_mutex
624 VoxelArea m_ignore_map_edit_events_area;
626 If set to !=0, the incoming MapEditEvents are modified to have
627 this peed id as the disabled recipient
628 This is behind m_env_mutex
630 u16 m_ignore_map_edit_events_peer_id;
632 // media files known to server
633 UNORDERED_MAP<std::string, MediaInfo> m_media;
638 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
642 Detached inventories (behind m_env_mutex)
645 std::map<std::string, Inventory*> m_detached_inventories;
647 DISABLE_CLASS_COPY(Server);
651 Runs a simple dedicated server loop.
653 Shuts down when kill is set to true.
655 void dedicated_server_loop(Server &server, bool &kill);