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 "clientiface.h"
36 #include "network/networkpacket.h"
42 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
44 class IWritableItemDefManager;
45 class IWritableNodeDefManager;
46 class IWritableCraftDefManager;
52 class IRollbackManager;
53 struct RollbackAction;
56 class ServerEnvironment;
57 struct SimpleSoundSpec;
60 enum ClientDeletionReason {
66 class MapEditEventIgnorer
69 MapEditEventIgnorer(bool *flag):
78 ~MapEditEventIgnorer()
91 class MapEditEventAreaIgnorer
94 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
95 m_ignorevariable(ignorevariable)
97 if(m_ignorevariable->getVolume() == 0)
98 *m_ignorevariable = a;
100 m_ignorevariable = NULL;
103 ~MapEditEventAreaIgnorer()
107 assert(m_ignorevariable->getVolume() != 0);
108 *m_ignorevariable = VoxelArea();
113 VoxelArea *m_ignorevariable;
119 std::string sha1_digest;
121 MediaInfo(const std::string &path_="",
122 const std::string &sha1_digest_=""):
124 sha1_digest(sha1_digest_)
129 struct ServerSoundParams
132 std::string to_player;
140 float max_hear_distance;
149 max_hear_distance(32*BS),
153 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
156 struct ServerPlayingSound
158 ServerSoundParams params;
159 std::set<u16> clients; // peer ids
162 class Server : public con::PeerHandler, public MapEventReceiver,
163 public InventoryManager, public IGameDef
167 NOTE: Every public method should be thread-safe
171 const std::string &path_world,
172 const SubgameSpec &gamespec,
173 bool simple_singleplayer_mode,
177 void start(Address bind_addr);
179 // This is mainly a way to pass the time to the server.
180 // Actual processing is done in an another thread.
181 void step(float dtime);
182 // This is run by ServerThread and does the actual processing
183 void AsyncRunStep(bool initial_step=false);
185 PlayerSAO* StageTwoClientInit(u16 peer_id);
191 void handleCommand(NetworkPacket* pkt);
193 void handleCommand_Null(NetworkPacket* pkt) {};
194 void handleCommand_Deprecated(NetworkPacket* pkt);
195 void handleCommand_Init(NetworkPacket* pkt);
196 void handleCommand_Init_Legacy(NetworkPacket* pkt);
197 void handleCommand_Init2(NetworkPacket* pkt);
198 void handleCommand_RequestMedia(NetworkPacket* pkt);
199 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
200 void handleCommand_ClientReady(NetworkPacket* pkt);
201 void handleCommand_GotBlocks(NetworkPacket* pkt);
202 void handleCommand_PlayerPos(NetworkPacket* pkt);
203 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
204 void handleCommand_InventoryAction(NetworkPacket* pkt);
205 void handleCommand_ChatMessage(NetworkPacket* pkt);
206 void handleCommand_Damage(NetworkPacket* pkt);
207 void handleCommand_Breath(NetworkPacket* pkt);
208 void handleCommand_Password(NetworkPacket* pkt);
209 void handleCommand_PlayerItem(NetworkPacket* pkt);
210 void handleCommand_Respawn(NetworkPacket* pkt);
211 void handleCommand_Interact(NetworkPacket* pkt);
212 void handleCommand_RemovedSounds(NetworkPacket* pkt);
213 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
214 void handleCommand_InventoryFields(NetworkPacket* pkt);
215 void handleCommand_FirstSrp(NetworkPacket* pkt);
216 void handleCommand_SrpBytesA(NetworkPacket* pkt);
217 void handleCommand_SrpBytesM(NetworkPacket* pkt);
219 void ProcessData(NetworkPacket *pkt);
221 void Send(NetworkPacket* pkt);
223 // Environment must be locked when called
224 void setTimeOfDay(u32 time);
227 Shall be called with the environment locked.
228 This is accessed by the map, which is inside the environment,
229 so it shouldn't be a problem.
231 void onMapEditEvent(MapEditEvent *event);
234 Shall be called with the environment and the connection locked.
236 Inventory* getInventory(const InventoryLocation &loc);
237 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
239 // Connection must be locked when called
240 std::wstring getStatusString();
242 // read shutdown state
243 inline bool getShutdownRequested()
244 { return m_shutdown_requested; }
246 // request server to shutdown
247 inline void requestShutdown() { m_shutdown_requested = true; }
248 void requestShutdown(const std::string &msg, bool reconnect)
250 m_shutdown_requested = true;
251 m_shutdown_msg = msg;
252 m_shutdown_ask_reconnect = reconnect;
255 // Returns -1 if failed, sound handle on success
257 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
258 void stopSound(s32 handle);
261 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
262 bool checkPriv(const std::string &name, const std::string &priv);
263 void reportPrivsModified(const std::string &name=""); // ""=all
264 void reportInventoryFormspecModified(const std::string &name);
266 void setIpBanned(const std::string &ip, const std::string &name);
267 void unsetIpBanned(const std::string &ip_or_name);
268 std::string getBanDescription(const std::string &ip_or_name);
270 void notifyPlayer(const char *name, const std::wstring &msg);
271 void notifyPlayers(const std::wstring &msg);
272 void spawnParticle(const char *playername,
273 v3f pos, v3f velocity, v3f acceleration,
274 float expirationtime, float size,
275 bool collisiondetection, bool vertical, const std::string &texture);
277 void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
278 float expirationtime, float size,
279 bool collisiondetection, bool vertical, const std::string &texture);
281 u32 addParticleSpawner(const char *playername,
282 u16 amount, float spawntime,
283 v3f minpos, v3f maxpos,
284 v3f minvel, v3f maxvel,
285 v3f minacc, v3f maxacc,
286 float minexptime, float maxexptime,
287 float minsize, float maxsize,
288 bool collisiondetection, bool vertical, const std::string &texture);
290 u32 addParticleSpawnerAll(u16 amount, float spawntime,
291 v3f minpos, v3f maxpos,
292 v3f minvel, v3f maxvel,
293 v3f minacc, v3f maxacc,
294 float minexptime, float maxexptime,
295 float minsize, float maxsize,
296 bool collisiondetection, bool vertical, const std::string &texture);
298 void deleteParticleSpawner(const char *playername, u32 id);
299 void deleteParticleSpawnerAll(u32 id);
301 // Creates or resets inventory
302 Inventory* createDetachedInventory(const std::string &name);
304 // Envlock and conlock should be locked when using scriptapi
305 GameScripting *getScriptIface(){ return m_script; }
307 // actions: time-reversed list
308 // Return value: success/failure
309 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
310 std::list<std::string> *log);
312 // IGameDef interface
314 virtual IItemDefManager* getItemDefManager();
315 virtual INodeDefManager* getNodeDefManager();
316 virtual ICraftDefManager* getCraftDefManager();
317 virtual ITextureSource* getTextureSource();
318 virtual IShaderSource* getShaderSource();
319 virtual u16 allocateUnknownNodeId(const std::string &name);
320 virtual ISoundManager* getSoundManager();
321 virtual MtEventManager* getEventManager();
322 virtual scene::ISceneManager* getSceneManager();
323 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
324 virtual EmergeManager *getEmergeManager() { return m_emerge; }
326 IWritableItemDefManager* getWritableItemDefManager();
327 IWritableNodeDefManager* getWritableNodeDefManager();
328 IWritableCraftDefManager* getWritableCraftDefManager();
330 const ModSpec* getModSpec(const std::string &modname) const;
331 void getModNames(std::vector<std::string> &modlist);
332 std::string getBuiltinLuaPath();
333 inline std::string getWorldPath() const
334 { return m_path_world; }
336 inline bool isSingleplayer()
337 { return m_simple_singleplayer_mode; }
339 inline void setAsyncFatalError(const std::string &error)
340 { m_async_fatal_error.set(error); }
342 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
343 Map & getMap() { return m_env->getMap(); }
344 ServerEnvironment & getEnv() { return *m_env; }
346 u32 hudAdd(Player *player, HudElement *element);
347 bool hudRemove(Player *player, u32 id);
348 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
349 bool hudSetFlags(Player *player, u32 flags, u32 mask);
350 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
351 s32 hudGetHotbarItemcount(Player *player);
352 void hudSetHotbarImage(Player *player, std::string name);
353 std::string hudGetHotbarImage(Player *player);
354 void hudSetHotbarSelectedImage(Player *player, std::string name);
355 std::string hudGetHotbarSelectedImage(Player *player);
357 inline Address getPeerAddress(u16 peer_id)
358 { return m_con.GetPeerAddress(peer_id); }
360 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
361 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
363 bool setSky(Player *player, const video::SColor &bgcolor,
364 const std::string &type, const std::vector<std::string> ¶ms);
366 bool overrideDayNightRatio(Player *player, bool do_override,
369 /* con::PeerHandler implementation. */
370 void peerAdded(con::Peer *peer);
371 void deletingPeer(con::Peer *peer, bool timeout);
373 void DenySudoAccess(u16 peer_id);
374 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
375 const std::string &str_reason = "", bool reconnect = false);
376 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
377 void acceptAuth(u16 peer_id, bool forSudoMode);
378 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
379 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
380 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
381 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
382 std::string* vers_string);
384 void SendPlayerHPOrDie(PlayerSAO *player);
385 void SendPlayerBreath(u16 peer_id);
386 void SendInventory(PlayerSAO* playerSAO);
387 void SendMovePlayer(u16 peer_id);
394 friend class EmergeThread;
395 friend class RemoteClient;
397 void SendMovement(u16 peer_id);
398 void SendHP(u16 peer_id, u8 hp);
399 void SendBreath(u16 peer_id, u16 breath);
400 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
401 const std::string &custom_reason, bool reconnect = false);
402 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
403 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
404 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
405 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
407 /* mark blocks not sent for all clients */
408 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
411 void SendChatMessage(u16 peer_id, const std::wstring &message);
412 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
413 void SendPlayerHP(u16 peer_id);
415 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
416 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
417 void SendPlayerPrivileges(u16 peer_id);
418 void SendPlayerInventoryFormspec(u16 peer_id);
419 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
420 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
421 void SendHUDRemove(u16 peer_id, u32 id);
422 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
423 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
424 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
425 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
426 const std::string &type, const std::vector<std::string> ¶ms);
427 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
430 Send a node removal/addition event to all clients except ignore_id.
431 Additionally, if far_players!=NULL, players further away than
432 far_d_nodes are ignored and their peer_ids are added to far_players
434 // Envlock and conlock should be locked when calling these
435 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
436 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
437 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
438 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
439 bool remove_metadata=true);
440 void setBlockNotSent(v3s16 p);
442 // Environment and Connection must be locked when called
443 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
445 // Sends blocks to clients (locks env and con on its own)
446 void SendBlocks(float dtime);
448 void fillMediaCache();
449 void sendMediaAnnouncement(u16 peer_id);
450 void sendRequestedMedia(u16 peer_id,
451 const std::vector<std::string> &tosend);
453 void sendDetachedInventory(const std::string &name, u16 peer_id);
454 void sendDetachedInventories(u16 peer_id);
456 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
457 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
458 v3f minpos, v3f maxpos,
459 v3f minvel, v3f maxvel,
460 v3f minacc, v3f maxacc,
461 float minexptime, float maxexptime,
462 float minsize, float maxsize,
463 bool collisiondetection, bool vertical, std::string texture, u32 id);
465 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
467 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
468 void SendSpawnParticle(u16 peer_id,
469 v3f pos, v3f velocity, v3f acceleration,
470 float expirationtime, float size,
471 bool collisiondetection, bool vertical, std::string texture);
473 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
474 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
479 void DiePlayer(u16 peer_id);
480 void RespawnPlayer(u16 peer_id);
481 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
482 void UpdateCrafting(Player *player);
486 // When called, connection mutex should be locked
487 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
488 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
490 // When called, environment mutex should be locked
491 std::string getPlayerName(u16 peer_id);
492 PlayerSAO* getPlayerSAO(u16 peer_id);
495 Get a player from memory or creates one.
496 If player is already connected, return NULL
497 Does not verify/modify auth info and password.
499 Call with env and con locked.
501 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
503 void handlePeerChanges();
510 std::string m_path_world;
511 // Subgame specification
512 SubgameSpec m_gamespec;
513 // If true, do not allow multiple players and hide some multiplayer
515 bool m_simple_singleplayer_mode;
517 // Thread can set; step() will throw as ServerError
518 MutexedVariable<std::string> m_async_fatal_error;
521 float m_liquid_transform_timer;
522 float m_liquid_transform_every;
523 float m_print_info_timer;
524 float m_masterserver_timer;
525 float m_objectdata_timer;
526 float m_emergethread_trigger_timer;
527 float m_savemap_timer;
528 IntervalLimiter m_map_timer_and_unload_interval;
531 ServerEnvironment *m_env;
535 con::Connection m_con;
538 BanManager *m_banmanager;
540 // Rollback manager (behind m_env_mutex)
541 IRollbackManager *m_rollback;
542 bool m_enable_rollback_recording; // Updated once in a while
545 EmergeManager *m_emerge;
548 // Envlock and conlock should be locked when using Lua
549 GameScripting *m_script;
551 // Item definition manager
552 IWritableItemDefManager *m_itemdef;
554 // Node definition manager
555 IWritableNodeDefManager *m_nodedef;
557 // Craft definition manager
558 IWritableCraftDefManager *m_craftdef;
561 EventManager *m_event;
564 std::vector<ModSpec> m_mods;
570 // A buffer for time steps
571 // step() increments and AsyncRunStep() run by m_thread reads it.
573 JMutex m_step_dtime_mutex;
575 // current server step lag counter
578 // The server mainly operates in this thread
579 ServerThread *m_thread;
585 // Timer for sending time of day over network
586 float m_time_of_day_send_timer;
587 // Uptime of server in seconds
588 MutexedVariable<double> m_uptime;
593 ClientInterface m_clients;
597 Queues stuff from peerAdded() and deletingPeer() to
600 std::queue<con::PeerChange> m_peer_change_queue;
606 bool m_shutdown_requested;
607 std::string m_shutdown_msg;
608 bool m_shutdown_ask_reconnect;
611 Map edit event queue. Automatically receives all map edits.
612 The constructor of this class registers us to receive them through
615 NOTE: Should these be moved to actually be members of
620 Queue of map edits from the environment for sending to the clients
621 This is behind m_env_mutex
623 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
625 Set to true when the server itself is modifying the map and does
626 all sending of information by itself.
627 This is behind m_env_mutex
629 bool m_ignore_map_edit_events;
631 If a non-empty area, map edit events contained within are left
632 unsent. Done at map generation time to speed up editing of the
633 generated area, as it will be sent anyway.
634 This is behind m_env_mutex
636 VoxelArea m_ignore_map_edit_events_area;
638 If set to !=0, the incoming MapEditEvents are modified to have
639 this peed id as the disabled recipient
640 This is behind m_env_mutex
642 u16 m_ignore_map_edit_events_peer_id;
644 // media files known to server
645 std::map<std::string,MediaInfo> m_media;
650 std::map<s32, ServerPlayingSound> m_playing_sounds;
654 Detached inventories (behind m_env_mutex)
657 std::map<std::string, Inventory*> m_detached_inventories;
662 std::vector<u32> m_particlespawner_ids;
666 Runs a simple dedicated server loop.
668 Shuts down when kill is set to true.
670 void dedicated_server_loop(Server &server, bool &kill);