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_Auth(NetworkPacket* pkt);
197 void handleCommand_Init_Legacy(NetworkPacket* pkt);
198 void handleCommand_Init2(NetworkPacket* pkt);
199 void handleCommand_RequestMedia(NetworkPacket* pkt);
200 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
201 void handleCommand_ClientReady(NetworkPacket* pkt);
202 void handleCommand_GotBlocks(NetworkPacket* pkt);
203 void handleCommand_PlayerPos(NetworkPacket* pkt);
204 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
205 void handleCommand_InventoryAction(NetworkPacket* pkt);
206 void handleCommand_ChatMessage(NetworkPacket* pkt);
207 void handleCommand_Damage(NetworkPacket* pkt);
208 void handleCommand_Breath(NetworkPacket* pkt);
209 void handleCommand_Password(NetworkPacket* pkt);
210 void handleCommand_PlayerItem(NetworkPacket* pkt);
211 void handleCommand_Respawn(NetworkPacket* pkt);
212 void handleCommand_Interact(NetworkPacket* pkt);
213 void handleCommand_RemovedSounds(NetworkPacket* pkt);
214 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
215 void handleCommand_InventoryFields(NetworkPacket* pkt);
217 void ProcessData(NetworkPacket *pkt);
219 void Send(NetworkPacket* pkt);
221 // Environment must be locked when called
222 void setTimeOfDay(u32 time);
225 Shall be called with the environment locked.
226 This is accessed by the map, which is inside the environment,
227 so it shouldn't be a problem.
229 void onMapEditEvent(MapEditEvent *event);
232 Shall be called with the environment and the connection locked.
234 Inventory* getInventory(const InventoryLocation &loc);
235 void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
237 // Connection must be locked when called
238 std::wstring getStatusString();
240 // read shutdown state
241 inline bool getShutdownRequested()
242 { return m_shutdown_requested; }
244 // request server to shutdown
245 inline void requestShutdown(void)
246 { m_shutdown_requested = true; }
248 // Returns -1 if failed, sound handle on success
250 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
251 void stopSound(s32 handle);
254 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
255 bool checkPriv(const std::string &name, const std::string &priv);
256 void reportPrivsModified(const std::string &name=""); // ""=all
257 void reportInventoryFormspecModified(const std::string &name);
259 void setIpBanned(const std::string &ip, const std::string &name);
260 void unsetIpBanned(const std::string &ip_or_name);
261 std::string getBanDescription(const std::string &ip_or_name);
263 void notifyPlayer(const char *name, const std::wstring &msg);
264 void notifyPlayers(const std::wstring &msg);
265 void spawnParticle(const char *playername,
266 v3f pos, v3f velocity, v3f acceleration,
267 float expirationtime, float size,
268 bool collisiondetection, bool vertical, std::string texture);
270 void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
271 float expirationtime, float size,
272 bool collisiondetection, bool vertical, std::string texture);
274 u32 addParticleSpawner(const char *playername,
275 u16 amount, float spawntime,
276 v3f minpos, v3f maxpos,
277 v3f minvel, v3f maxvel,
278 v3f minacc, v3f maxacc,
279 float minexptime, float maxexptime,
280 float minsize, float maxsize,
281 bool collisiondetection, bool vertical, std::string texture);
283 u32 addParticleSpawnerAll(u16 amount, float spawntime,
284 v3f minpos, v3f maxpos,
285 v3f minvel, v3f maxvel,
286 v3f minacc, v3f maxacc,
287 float minexptime, float maxexptime,
288 float minsize, float maxsize,
289 bool collisiondetection, bool vertical, std::string texture);
291 void deleteParticleSpawner(const char *playername, u32 id);
292 void deleteParticleSpawnerAll(u32 id);
294 // Creates or resets inventory
295 Inventory* createDetachedInventory(const std::string &name);
297 // Envlock and conlock should be locked when using scriptapi
298 GameScripting *getScriptIface(){ return m_script; }
300 // actions: time-reversed list
301 // Return value: success/failure
302 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
303 std::list<std::string> *log);
305 // IGameDef interface
307 virtual IItemDefManager* getItemDefManager();
308 virtual INodeDefManager* getNodeDefManager();
309 virtual ICraftDefManager* getCraftDefManager();
310 virtual ITextureSource* getTextureSource();
311 virtual IShaderSource* getShaderSource();
312 virtual u16 allocateUnknownNodeId(const std::string &name);
313 virtual ISoundManager* getSoundManager();
314 virtual MtEventManager* getEventManager();
315 virtual scene::ISceneManager* getSceneManager();
316 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
317 virtual EmergeManager *getEmergeManager() { return m_emerge; }
319 IWritableItemDefManager* getWritableItemDefManager();
320 IWritableNodeDefManager* getWritableNodeDefManager();
321 IWritableCraftDefManager* getWritableCraftDefManager();
323 const ModSpec* getModSpec(const std::string &modname);
324 void getModNames(std::vector<std::string> &modlist);
325 std::string getBuiltinLuaPath();
326 inline std::string getWorldPath()
327 { return m_path_world; }
329 inline bool isSingleplayer()
330 { return m_simple_singleplayer_mode; }
332 inline void setAsyncFatalError(const std::string &error)
333 { m_async_fatal_error.set(error); }
335 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
336 Map & getMap() { return m_env->getMap(); }
337 ServerEnvironment & getEnv() { return *m_env; }
339 u32 hudAdd(Player *player, HudElement *element);
340 bool hudRemove(Player *player, u32 id);
341 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
342 bool hudSetFlags(Player *player, u32 flags, u32 mask);
343 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
344 void hudSetHotbarImage(Player *player, std::string name);
345 void hudSetHotbarSelectedImage(Player *player, std::string name);
347 inline Address getPeerAddress(u16 peer_id)
348 { return m_con.GetPeerAddress(peer_id); }
350 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
351 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
353 bool setSky(Player *player, const video::SColor &bgcolor,
354 const std::string &type, const std::vector<std::string> ¶ms);
356 bool overrideDayNightRatio(Player *player, bool do_override,
359 /* con::PeerHandler implementation. */
360 void peerAdded(con::Peer *peer);
361 void deletingPeer(con::Peer *peer, bool timeout);
363 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason=NULL);
364 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
365 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
366 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
367 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
368 std::string* vers_string);
370 void SendPlayerHPOrDie(u16 peer_id, bool die) { die ? DiePlayer(peer_id) : SendPlayerHP(peer_id); }
371 void SendPlayerBreath(u16 peer_id);
372 void SendInventory(PlayerSAO* playerSAO);
373 void SendMovePlayer(u16 peer_id);
380 friend class EmergeThread;
381 friend class RemoteClient;
383 void SendMovement(u16 peer_id);
384 void SendHP(u16 peer_id, u8 hp);
385 void SendBreath(u16 peer_id, u16 breath);
386 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason);
387 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
388 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
389 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
390 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
392 /* mark blocks not sent for all clients */
393 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
396 void SendChatMessage(u16 peer_id, const std::wstring &message);
397 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
398 void SendPlayerHP(u16 peer_id);
400 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
401 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
402 void SendPlayerPrivileges(u16 peer_id);
403 void SendPlayerInventoryFormspec(u16 peer_id);
404 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
405 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
406 void SendHUDRemove(u16 peer_id, u32 id);
407 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
408 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
409 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
410 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
411 const std::string &type, const std::vector<std::string> ¶ms);
412 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
415 Send a node removal/addition event to all clients except ignore_id.
416 Additionally, if far_players!=NULL, players further away than
417 far_d_nodes are ignored and their peer_ids are added to far_players
419 // Envlock and conlock should be locked when calling these
420 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
421 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
422 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
423 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
424 bool remove_metadata=true);
425 void setBlockNotSent(v3s16 p);
427 // Environment and Connection must be locked when called
428 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
430 // Sends blocks to clients (locks env and con on its own)
431 void SendBlocks(float dtime);
433 void fillMediaCache();
434 void sendMediaAnnouncement(u16 peer_id);
435 void sendRequestedMedia(u16 peer_id,
436 const std::vector<std::string> &tosend);
438 void sendDetachedInventory(const std::string &name, u16 peer_id);
439 void sendDetachedInventories(u16 peer_id);
441 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
442 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
443 v3f minpos, v3f maxpos,
444 v3f minvel, v3f maxvel,
445 v3f minacc, v3f maxacc,
446 float minexptime, float maxexptime,
447 float minsize, float maxsize,
448 bool collisiondetection, bool vertical, std::string texture, u32 id);
450 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
452 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
453 void SendSpawnParticle(u16 peer_id,
454 v3f pos, v3f velocity, v3f acceleration,
455 float expirationtime, float size,
456 bool collisiondetection, bool vertical, std::string texture);
458 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
459 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
464 void DiePlayer(u16 peer_id);
465 void RespawnPlayer(u16 peer_id);
466 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
467 void UpdateCrafting(Player *player);
471 // When called, connection mutex should be locked
472 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
473 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
475 // When called, environment mutex should be locked
476 std::string getPlayerName(u16 peer_id);
477 PlayerSAO* getPlayerSAO(u16 peer_id);
480 Get a player from memory or creates one.
481 If player is already connected, return NULL
482 Does not verify/modify auth info and password.
484 Call with env and con locked.
486 PlayerSAO *emergePlayer(const char *name, u16 peer_id);
488 void handlePeerChanges();
495 std::string m_path_world;
496 // Subgame specification
497 SubgameSpec m_gamespec;
498 // If true, do not allow multiple players and hide some multiplayer
500 bool m_simple_singleplayer_mode;
502 // Thread can set; step() will throw as ServerError
503 MutexedVariable<std::string> m_async_fatal_error;
506 float m_liquid_transform_timer;
507 float m_liquid_transform_every;
508 float m_print_info_timer;
509 float m_masterserver_timer;
510 float m_objectdata_timer;
511 float m_emergethread_trigger_timer;
512 float m_savemap_timer;
513 IntervalLimiter m_map_timer_and_unload_interval;
516 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 JMutex 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;
594 Map edit event queue. Automatically receives all map edits.
595 The constructor of this class registers us to receive them through
598 NOTE: Should these be moved to actually be members of
603 Queue of map edits from the environment for sending to the clients
604 This is behind m_env_mutex
606 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
608 Set to true when the server itself is modifying the map and does
609 all sending of information by itself.
610 This is behind m_env_mutex
612 bool m_ignore_map_edit_events;
614 If a non-empty area, map edit events contained within are left
615 unsent. Done at map generation time to speed up editing of the
616 generated area, as it will be sent anyway.
617 This is behind m_env_mutex
619 VoxelArea m_ignore_map_edit_events_area;
621 If set to !=0, the incoming MapEditEvents are modified to have
622 this peed id as the disabled recipient
623 This is behind m_env_mutex
625 u16 m_ignore_map_edit_events_peer_id;
627 // media files known to server
628 std::map<std::string,MediaInfo> m_media;
633 std::map<s32, ServerPlayingSound> m_playing_sounds;
637 Detached inventories (behind m_env_mutex)
640 std::map<std::string, Inventory*> m_detached_inventories;
645 std::vector<u32> m_particlespawner_ids;
649 Runs a simple dedicated server loop.
651 Shuts down when run is set to false.
653 void dedicated_server_loop(Server &server, bool &run);