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 // Both setter and getter need no envlock,
224 // can be called freely from threads
225 void setTimeOfDay(u32 time);
228 Shall be called with the environment locked.
229 This is accessed by the map, which is inside the environment,
230 so it shouldn't be a problem.
232 void onMapEditEvent(MapEditEvent *event);
235 Shall be called with the environment and the connection locked.
237 Inventory* getInventory(const InventoryLocation &loc);
238 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
240 // Connection must be locked when called
241 std::wstring getStatusString();
243 // read shutdown state
244 inline bool getShutdownRequested()
245 { return m_shutdown_requested; }
247 // request server to shutdown
248 inline void requestShutdown() { m_shutdown_requested = true; }
249 void requestShutdown(const std::string &msg, bool reconnect)
251 m_shutdown_requested = true;
252 m_shutdown_msg = msg;
253 m_shutdown_ask_reconnect = reconnect;
256 // Returns -1 if failed, sound handle on success
258 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
259 void stopSound(s32 handle);
262 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
263 bool checkPriv(const std::string &name, const std::string &priv);
264 void reportPrivsModified(const std::string &name=""); // ""=all
265 void reportInventoryFormspecModified(const std::string &name);
267 void setIpBanned(const std::string &ip, const std::string &name);
268 void unsetIpBanned(const std::string &ip_or_name);
269 std::string getBanDescription(const std::string &ip_or_name);
271 void notifyPlayer(const char *name, const std::wstring &msg);
272 void notifyPlayers(const std::wstring &msg);
273 void spawnParticle(const std::string &playername,
274 v3f pos, v3f velocity, v3f acceleration,
275 float expirationtime, float size,
276 bool collisiondetection, bool vertical, const std::string &texture);
278 u32 addParticleSpawner(u16 amount, float spawntime,
279 v3f minpos, v3f maxpos,
280 v3f minvel, v3f maxvel,
281 v3f minacc, v3f maxacc,
282 float minexptime, float maxexptime,
283 float minsize, float maxsize,
284 bool collisiondetection, bool vertical, const std::string &texture,
285 const std::string &playername);
287 void deleteParticleSpawner(const std::string &playername, u32 id);
289 // Creates or resets inventory
290 Inventory* createDetachedInventory(const std::string &name);
292 // Envlock and conlock should be locked when using scriptapi
293 GameScripting *getScriptIface(){ return m_script; }
295 // actions: time-reversed list
296 // Return value: success/failure
297 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
298 std::list<std::string> *log);
300 // IGameDef interface
302 virtual IItemDefManager* getItemDefManager();
303 virtual INodeDefManager* getNodeDefManager();
304 virtual ICraftDefManager* getCraftDefManager();
305 virtual ITextureSource* getTextureSource();
306 virtual IShaderSource* getShaderSource();
307 virtual u16 allocateUnknownNodeId(const std::string &name);
308 virtual ISoundManager* getSoundManager();
309 virtual MtEventManager* getEventManager();
310 virtual scene::ISceneManager* getSceneManager();
311 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
312 virtual EmergeManager *getEmergeManager() { return m_emerge; }
314 IWritableItemDefManager* getWritableItemDefManager();
315 IWritableNodeDefManager* getWritableNodeDefManager();
316 IWritableCraftDefManager* getWritableCraftDefManager();
318 const ModSpec* getModSpec(const std::string &modname) const;
319 void getModNames(std::vector<std::string> &modlist);
320 std::string getBuiltinLuaPath();
321 inline std::string getWorldPath() const
322 { return m_path_world; }
324 inline bool isSingleplayer()
325 { return m_simple_singleplayer_mode; }
327 inline void setAsyncFatalError(const std::string &error)
328 { m_async_fatal_error.set(error); }
330 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
331 Map & getMap() { return m_env->getMap(); }
332 ServerEnvironment & getEnv() { return *m_env; }
334 u32 hudAdd(Player *player, HudElement *element);
335 bool hudRemove(Player *player, u32 id);
336 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
337 bool hudSetFlags(Player *player, u32 flags, u32 mask);
338 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
339 s32 hudGetHotbarItemcount(Player *player);
340 void hudSetHotbarImage(Player *player, std::string name);
341 std::string hudGetHotbarImage(Player *player);
342 void hudSetHotbarSelectedImage(Player *player, std::string name);
343 std::string hudGetHotbarSelectedImage(Player *player);
345 inline Address getPeerAddress(u16 peer_id)
346 { return m_con.GetPeerAddress(peer_id); }
348 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
349 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
351 bool setSky(Player *player, const video::SColor &bgcolor,
352 const std::string &type, const std::vector<std::string> ¶ms);
354 bool overrideDayNightRatio(Player *player, bool do_override,
357 /* con::PeerHandler implementation. */
358 void peerAdded(con::Peer *peer);
359 void deletingPeer(con::Peer *peer, bool timeout);
361 void DenySudoAccess(u16 peer_id);
362 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
363 const std::string &str_reason = "", bool reconnect = false);
364 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
365 void acceptAuth(u16 peer_id, bool forSudoMode);
366 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
367 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
368 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
369 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
370 std::string* vers_string);
372 void SendPlayerHPOrDie(PlayerSAO *player);
373 void SendPlayerBreath(u16 peer_id);
374 void SendInventory(PlayerSAO* playerSAO);
375 void SendMovePlayer(u16 peer_id);
380 // Environment mutex (envlock)
385 friend class EmergeThread;
386 friend class RemoteClient;
388 void SendMovement(u16 peer_id);
389 void SendHP(u16 peer_id, u8 hp);
390 void SendBreath(u16 peer_id, u16 breath);
391 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
392 const std::string &custom_reason, bool reconnect = false);
393 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
394 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
395 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
396 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
398 /* mark blocks not sent for all clients */
399 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
402 void SendChatMessage(u16 peer_id, const std::wstring &message);
403 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
404 void SendPlayerHP(u16 peer_id);
406 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
407 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
408 void SendPlayerPrivileges(u16 peer_id);
409 void SendPlayerInventoryFormspec(u16 peer_id);
410 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
411 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
412 void SendHUDRemove(u16 peer_id, u32 id);
413 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
414 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
415 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
416 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
417 const std::string &type, const std::vector<std::string> ¶ms);
418 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
421 Send a node removal/addition event to all clients except ignore_id.
422 Additionally, if far_players!=NULL, players further away than
423 far_d_nodes are ignored and their peer_ids are added to far_players
425 // Envlock and conlock should be locked when calling these
426 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
427 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
428 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
429 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
430 bool remove_metadata=true);
431 void setBlockNotSent(v3s16 p);
433 // Environment and Connection must be locked when called
434 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
436 // Sends blocks to clients (locks env and con on its own)
437 void SendBlocks(float dtime);
439 void fillMediaCache();
440 void sendMediaAnnouncement(u16 peer_id);
441 void sendRequestedMedia(u16 peer_id,
442 const std::vector<std::string> &tosend);
444 void sendDetachedInventory(const std::string &name, u16 peer_id);
445 void sendDetachedInventories(u16 peer_id);
447 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
448 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
449 v3f minpos, v3f maxpos,
450 v3f minvel, v3f maxvel,
451 v3f minacc, v3f maxacc,
452 float minexptime, float maxexptime,
453 float minsize, float maxsize,
454 bool collisiondetection, bool vertical, std::string texture, u32 id);
456 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
458 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
459 void SendSpawnParticle(u16 peer_id,
460 v3f pos, v3f velocity, v3f acceleration,
461 float expirationtime, float size,
462 bool collisiondetection, bool vertical, std::string texture);
464 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
465 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
470 void DiePlayer(u16 peer_id);
471 void RespawnPlayer(u16 peer_id);
472 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
473 void UpdateCrafting(Player *player);
477 // When called, connection mutex should be locked
478 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
479 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
481 // When called, environment mutex should be locked
482 std::string getPlayerName(u16 peer_id);
483 PlayerSAO* getPlayerSAO(u16 peer_id);
486 Get a player from memory or creates one.
487 If player is already connected, return NULL
488 Does not verify/modify auth info and password.
490 Call with env and con locked.
492 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
494 void handlePeerChanges();
501 std::string m_path_world;
502 // Subgame specification
503 SubgameSpec m_gamespec;
504 // If true, do not allow multiple players and hide some multiplayer
506 bool m_simple_singleplayer_mode;
508 // Thread can set; step() will throw as ServerError
509 MutexedVariable<std::string> m_async_fatal_error;
512 float m_liquid_transform_timer;
513 float m_liquid_transform_every;
514 float m_print_info_timer;
515 float m_masterserver_timer;
516 float m_objectdata_timer;
517 float m_emergethread_trigger_timer;
518 float m_savemap_timer;
519 IntervalLimiter m_map_timer_and_unload_interval;
522 ServerEnvironment *m_env;
525 con::Connection m_con;
528 BanManager *m_banmanager;
530 // Rollback manager (behind m_env_mutex)
531 IRollbackManager *m_rollback;
532 bool m_enable_rollback_recording; // Updated once in a while
535 EmergeManager *m_emerge;
538 // Envlock and conlock should be locked when using Lua
539 GameScripting *m_script;
541 // Item definition manager
542 IWritableItemDefManager *m_itemdef;
544 // Node definition manager
545 IWritableNodeDefManager *m_nodedef;
547 // Craft definition manager
548 IWritableCraftDefManager *m_craftdef;
551 EventManager *m_event;
554 std::vector<ModSpec> m_mods;
560 // A buffer for time steps
561 // step() increments and AsyncRunStep() run by m_thread reads it.
563 Mutex m_step_dtime_mutex;
565 // current server step lag counter
568 // The server mainly operates in this thread
569 ServerThread *m_thread;
575 // Timer for sending time of day over network
576 float m_time_of_day_send_timer;
577 // Uptime of server in seconds
578 MutexedVariable<double> m_uptime;
583 ClientInterface m_clients;
587 Queues stuff from peerAdded() and deletingPeer() to
590 std::queue<con::PeerChange> m_peer_change_queue;
596 bool m_shutdown_requested;
597 std::string m_shutdown_msg;
598 bool m_shutdown_ask_reconnect;
601 Map edit event queue. Automatically receives all map edits.
602 The constructor of this class registers us to receive them through
605 NOTE: Should these be moved to actually be members of
610 Queue of map edits from the environment for sending to the clients
611 This is behind m_env_mutex
613 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
615 Set to true when the server itself is modifying the map and does
616 all sending of information by itself.
617 This is behind m_env_mutex
619 bool m_ignore_map_edit_events;
621 If a non-empty area, map edit events contained within are left
622 unsent. Done at map generation time to speed up editing of the
623 generated area, as it will be sent anyway.
624 This is behind m_env_mutex
626 VoxelArea m_ignore_map_edit_events_area;
628 If set to !=0, the incoming MapEditEvents are modified to have
629 this peed id as the disabled recipient
630 This is behind m_env_mutex
632 u16 m_ignore_map_edit_events_peer_id;
634 // media files known to server
635 std::map<std::string,MediaInfo> m_media;
640 std::map<s32, ServerPlayingSound> m_playing_sounds;
644 Detached inventories (behind m_env_mutex)
647 std::map<std::string, Inventory*> m_detached_inventories;
652 std::vector<u32> m_particlespawner_ids;
654 DISABLE_CLASS_COPY(Server);
658 Runs a simple dedicated server loop.
660 Shuts down when kill is set to true.
662 void dedicated_server_loop(Server &server, bool &kill);