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 {
69 v3f findSpawnPos(ServerMap &map);
71 class MapEditEventIgnorer
74 MapEditEventIgnorer(bool *flag):
83 ~MapEditEventIgnorer()
96 class MapEditEventAreaIgnorer
99 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
100 m_ignorevariable(ignorevariable)
102 if(m_ignorevariable->getVolume() == 0)
103 *m_ignorevariable = a;
105 m_ignorevariable = NULL;
108 ~MapEditEventAreaIgnorer()
112 assert(m_ignorevariable->getVolume() != 0);
113 *m_ignorevariable = VoxelArea();
118 VoxelArea *m_ignorevariable;
124 std::string sha1_digest;
126 MediaInfo(const std::string &path_="",
127 const std::string &sha1_digest_=""):
129 sha1_digest(sha1_digest_)
134 struct ServerSoundParams
137 std::string to_player;
145 float max_hear_distance;
154 max_hear_distance(32*BS),
158 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
161 struct ServerPlayingSound
163 ServerSoundParams params;
164 std::set<u16> clients; // peer ids
167 class Server : public con::PeerHandler, public MapEventReceiver,
168 public InventoryManager, public IGameDef
172 NOTE: Every public method should be thread-safe
176 const std::string &path_world,
177 const SubgameSpec &gamespec,
178 bool simple_singleplayer_mode,
182 void start(Address bind_addr);
184 // This is mainly a way to pass the time to the server.
185 // Actual processing is done in an another thread.
186 void step(float dtime);
187 // This is run by ServerThread and does the actual processing
188 void AsyncRunStep(bool initial_step=false);
190 PlayerSAO* StageTwoClientInit(u16 peer_id);
196 void handleCommand(NetworkPacket* pkt);
198 void handleCommand_Null(NetworkPacket* pkt) {};
199 void handleCommand_Deprecated(NetworkPacket* pkt);
200 void handleCommand_Init(NetworkPacket* pkt);
201 void handleCommand_Auth(NetworkPacket* pkt);
202 void handleCommand_Init_Legacy(NetworkPacket* pkt);
203 void handleCommand_Init2(NetworkPacket* pkt);
204 void handleCommand_RequestMedia(NetworkPacket* pkt);
205 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
206 void handleCommand_ClientReady(NetworkPacket* pkt);
207 void handleCommand_GotBlocks(NetworkPacket* pkt);
208 void handleCommand_PlayerPos(NetworkPacket* pkt);
209 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
210 void handleCommand_InventoryAction(NetworkPacket* pkt);
211 void handleCommand_ChatMessage(NetworkPacket* pkt);
212 void handleCommand_Damage(NetworkPacket* pkt);
213 void handleCommand_Breath(NetworkPacket* pkt);
214 void handleCommand_Password(NetworkPacket* pkt);
215 void handleCommand_PlayerItem(NetworkPacket* pkt);
216 void handleCommand_Respawn(NetworkPacket* pkt);
217 void handleCommand_Interact(NetworkPacket* pkt);
218 void handleCommand_RemovedSounds(NetworkPacket* pkt);
219 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
220 void handleCommand_InventoryFields(NetworkPacket* pkt);
222 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
224 void Send(NetworkPacket* pkt);
226 // Environment must be locked when called
227 void setTimeOfDay(u32 time);
230 Shall be called with the environment locked.
231 This is accessed by the map, which is inside the environment,
232 so it shouldn't be a problem.
234 void onMapEditEvent(MapEditEvent *event);
237 Shall be called with the environment and the connection locked.
239 Inventory* getInventory(const InventoryLocation &loc);
240 void setInventoryModified(const InventoryLocation &loc);
242 // Connection must be locked when called
243 std::wstring getStatusString();
245 // read shutdown state
246 inline bool getShutdownRequested()
247 { return m_shutdown_requested; }
249 // request server to shutdown
250 inline void requestShutdown(void)
251 { m_shutdown_requested = true; }
253 // Returns -1 if failed, sound handle on success
255 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
256 void stopSound(s32 handle);
259 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
260 bool checkPriv(const std::string &name, const std::string &priv);
261 void reportPrivsModified(const std::string &name=""); // ""=all
262 void reportInventoryFormspecModified(const std::string &name);
264 void setIpBanned(const std::string &ip, const std::string &name);
265 void unsetIpBanned(const std::string &ip_or_name);
266 std::string getBanDescription(const std::string &ip_or_name);
268 void notifyPlayer(const char *name, const std::wstring &msg);
269 void notifyPlayers(const std::wstring &msg);
270 void spawnParticle(const char *playername,
271 v3f pos, v3f velocity, v3f acceleration,
272 float expirationtime, float size,
273 bool collisiondetection, bool vertical, std::string texture);
275 void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
276 float expirationtime, float size,
277 bool collisiondetection, bool vertical, std::string texture);
279 u32 addParticleSpawner(const char *playername,
280 u16 amount, float spawntime,
281 v3f minpos, v3f maxpos,
282 v3f minvel, v3f maxvel,
283 v3f minacc, v3f maxacc,
284 float minexptime, float maxexptime,
285 float minsize, float maxsize,
286 bool collisiondetection, bool vertical, std::string texture);
288 u32 addParticleSpawnerAll(u16 amount, float spawntime,
289 v3f minpos, v3f maxpos,
290 v3f minvel, v3f maxvel,
291 v3f minacc, v3f maxacc,
292 float minexptime, float maxexptime,
293 float minsize, float maxsize,
294 bool collisiondetection, bool vertical, std::string texture);
296 void deleteParticleSpawner(const char *playername, u32 id);
297 void deleteParticleSpawnerAll(u32 id);
299 // Creates or resets inventory
300 Inventory* createDetachedInventory(const std::string &name);
302 // Envlock and conlock should be locked when using scriptapi
303 GameScripting *getScriptIface(){ return m_script; }
305 //TODO: determine what (if anything) should be locked to access EmergeManager
306 EmergeManager *getEmergeManager(){ return m_emerge; }
308 // actions: time-reversed list
309 // Return value: success/failure
310 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
311 std::list<std::string> *log);
313 // IGameDef interface
315 virtual IItemDefManager* getItemDefManager();
316 virtual INodeDefManager* getNodeDefManager();
317 virtual ICraftDefManager* getCraftDefManager();
318 virtual ITextureSource* getTextureSource();
319 virtual IShaderSource* getShaderSource();
320 virtual u16 allocateUnknownNodeId(const std::string &name);
321 virtual ISoundManager* getSoundManager();
322 virtual MtEventManager* getEventManager();
323 virtual scene::ISceneManager* getSceneManager();
324 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
327 IWritableItemDefManager* getWritableItemDefManager();
328 IWritableNodeDefManager* getWritableNodeDefManager();
329 IWritableCraftDefManager* getWritableCraftDefManager();
331 const ModSpec* getModSpec(const std::string &modname);
332 void getModNames(std::vector<std::string> &modlist);
333 std::string getBuiltinLuaPath();
334 inline std::string getWorldPath()
335 { return m_path_world; }
337 inline bool isSingleplayer()
338 { return m_simple_singleplayer_mode; }
340 inline void setAsyncFatalError(const std::string &error)
341 { m_async_fatal_error.set(error); }
343 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
344 Map & getMap() { return m_env->getMap(); }
345 ServerEnvironment & getEnv() { return *m_env; }
347 u32 hudAdd(Player *player, HudElement *element);
348 bool hudRemove(Player *player, u32 id);
349 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
350 bool hudSetFlags(Player *player, u32 flags, u32 mask);
351 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
352 void hudSetHotbarImage(Player *player, std::string name);
353 void hudSetHotbarSelectedImage(Player *player, std::string name);
355 inline Address getPeerAddress(u16 peer_id)
356 { return m_con.GetPeerAddress(peer_id); }
358 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
359 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
361 bool setSky(Player *player, const video::SColor &bgcolor,
362 const std::string &type, const std::vector<std::string> ¶ms);
364 bool overrideDayNightRatio(Player *player, bool do_override,
367 /* con::PeerHandler implementation. */
368 void peerAdded(con::Peer *peer);
369 void deletingPeer(con::Peer *peer, bool timeout);
371 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason=NULL);
372 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
373 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
374 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
375 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
376 std::string* vers_string);
378 void SendPlayerHPOrDie(u16 peer_id, bool die) { die ? DiePlayer(peer_id) : SendPlayerHP(peer_id); }
379 void SendPlayerBreath(u16 peer_id);
380 void SendInventory(PlayerSAO* playerSAO);
381 void SendMovePlayer(u16 peer_id);
388 friend class EmergeThread;
389 friend class RemoteClient;
391 void SendMovement(u16 peer_id);
392 void SendHP(u16 peer_id, u8 hp);
393 void SendBreath(u16 peer_id, u16 breath);
394 void SendAccessDenied(u16 peer_id, AccessDeniedCode reason, const std::wstring &custom_reason);
395 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
396 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
397 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
398 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
400 /* mark blocks not sent for all clients */
401 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
404 void SendChatMessage(u16 peer_id, const std::wstring &message);
405 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
406 void SendPlayerHP(u16 peer_id);
408 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
409 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
410 void SendPlayerPrivileges(u16 peer_id);
411 void SendPlayerInventoryFormspec(u16 peer_id);
412 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
413 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
414 void SendHUDRemove(u16 peer_id, u32 id);
415 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
416 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
417 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
418 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
419 const std::string &type, const std::vector<std::string> ¶ms);
420 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
423 Send a node removal/addition event to all clients except ignore_id.
424 Additionally, if far_players!=NULL, players further away than
425 far_d_nodes are ignored and their peer_ids are added to far_players
427 // Envlock and conlock should be locked when calling these
428 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
429 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
430 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
431 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
432 bool remove_metadata=true);
433 void setBlockNotSent(v3s16 p);
435 // Environment and Connection must be locked when called
436 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
438 // Sends blocks to clients (locks env and con on its own)
439 void SendBlocks(float dtime);
441 void fillMediaCache();
442 void sendMediaAnnouncement(u16 peer_id);
443 void sendRequestedMedia(u16 peer_id,
444 const std::vector<std::string> &tosend);
446 void sendDetachedInventory(const std::string &name, u16 peer_id);
447 void sendDetachedInventories(u16 peer_id);
449 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
450 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
451 v3f minpos, v3f maxpos,
452 v3f minvel, v3f maxvel,
453 v3f minacc, v3f maxacc,
454 float minexptime, float maxexptime,
455 float minsize, float maxsize,
456 bool collisiondetection, bool vertical, std::string texture, u32 id);
458 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
460 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
461 void SendSpawnParticle(u16 peer_id,
462 v3f pos, v3f velocity, v3f acceleration,
463 float expirationtime, float size,
464 bool collisiondetection, bool vertical, std::string texture);
466 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
467 void SendActiveObjectMessages(u16 peer_id, const std::string &datas);
472 void DiePlayer(u16 peer_id);
473 void RespawnPlayer(u16 peer_id);
474 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
475 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);
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;
526 con::Connection m_con;
529 BanManager *m_banmanager;
531 // Rollback manager (behind m_env_mutex)
532 IRollbackManager *m_rollback;
533 bool m_enable_rollback_recording; // Updated once in a while
536 EmergeManager *m_emerge;
539 // Envlock and conlock should be locked when using Lua
540 GameScripting *m_script;
542 // Item definition manager
543 IWritableItemDefManager *m_itemdef;
545 // Node definition manager
546 IWritableNodeDefManager *m_nodedef;
548 // Craft definition manager
549 IWritableCraftDefManager *m_craftdef;
552 EventManager *m_event;
555 std::vector<ModSpec> m_mods;
561 // A buffer for time steps
562 // step() increments and AsyncRunStep() run by m_thread reads it.
564 JMutex m_step_dtime_mutex;
566 // current server step lag counter
569 // The server mainly operates in this thread
570 ServerThread *m_thread;
576 // Timer for sending time of day over network
577 float m_time_of_day_send_timer;
578 // Uptime of server in seconds
579 MutexedVariable<double> m_uptime;
584 ClientInterface m_clients;
588 Queues stuff from peerAdded() and deletingPeer() to
591 std::queue<con::PeerChange> m_peer_change_queue;
597 bool m_shutdown_requested;
600 Map edit event queue. Automatically receives all map edits.
601 The constructor of this class registers us to receive them through
604 NOTE: Should these be moved to actually be members of
609 Queue of map edits from the environment for sending to the clients
610 This is behind m_env_mutex
612 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
614 Set to true when the server itself is modifying the map and does
615 all sending of information by itself.
616 This is behind m_env_mutex
618 bool m_ignore_map_edit_events;
620 If a non-empty area, map edit events contained within are left
621 unsent. Done at map generation time to speed up editing of the
622 generated area, as it will be sent anyway.
623 This is behind m_env_mutex
625 VoxelArea m_ignore_map_edit_events_area;
627 If set to !=0, the incoming MapEditEvents are modified to have
628 this peed id as the disabled recipient
629 This is behind m_env_mutex
631 u16 m_ignore_map_edit_events_peer_id;
633 // media files known to server
634 std::map<std::string,MediaInfo> m_media;
639 std::map<s32, ServerPlayingSound> m_playing_sounds;
643 Detached inventories (behind m_env_mutex)
646 std::map<std::string, Inventory*> m_detached_inventories;
651 std::vector<u32> m_particlespawner_ids;
655 Runs a simple dedicated server loop.
657 Shuts down when run is set to false.
659 void dedicated_server_loop(Server &server, bool &run);