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_Init2(NetworkPacket* pkt);
202 void handleCommand_RequestMedia(NetworkPacket* pkt);
203 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
204 void handleCommand_ClientReady(NetworkPacket* pkt);
205 void handleCommand_GotBlocks(NetworkPacket* pkt);
206 void handleCommand_PlayerPos(NetworkPacket* pkt);
207 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
208 void handleCommand_InventoryAction(NetworkPacket* pkt);
209 void handleCommand_ChatMessage(NetworkPacket* pkt);
210 void handleCommand_Damage(NetworkPacket* pkt);
211 void handleCommand_Breath(NetworkPacket* pkt);
212 void handleCommand_Password(NetworkPacket* pkt);
213 void handleCommand_PlayerItem(NetworkPacket* pkt);
214 void handleCommand_Respawn(NetworkPacket* pkt);
215 void handleCommand_Interact(NetworkPacket* pkt);
216 void handleCommand_RemovedSounds(NetworkPacket* pkt);
217 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
218 void handleCommand_InventoryFields(NetworkPacket* pkt);
220 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
222 void Send(NetworkPacket* pkt);
224 // Environment must be locked when called
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);
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(void)
249 { m_shutdown_requested = true; }
251 // Returns -1 if failed, sound handle on success
253 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
254 void stopSound(s32 handle);
257 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
258 bool checkPriv(const std::string &name, const std::string &priv);
259 void reportPrivsModified(const std::string &name=""); // ""=all
260 void reportInventoryFormspecModified(const std::string &name);
262 void setIpBanned(const std::string &ip, const std::string &name);
263 void unsetIpBanned(const std::string &ip_or_name);
264 std::string getBanDescription(const std::string &ip_or_name);
266 void notifyPlayer(const char *name, const std::wstring &msg);
267 void notifyPlayers(const std::wstring &msg);
268 void spawnParticle(const char *playername,
269 v3f pos, v3f velocity, v3f acceleration,
270 float expirationtime, float size,
271 bool collisiondetection, bool vertical, std::string texture);
273 void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
274 float expirationtime, float size,
275 bool collisiondetection, bool vertical, std::string texture);
277 u32 addParticleSpawner(const char *playername,
278 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, std::string texture);
286 u32 addParticleSpawnerAll(u16 amount, float spawntime,
287 v3f minpos, v3f maxpos,
288 v3f minvel, v3f maxvel,
289 v3f minacc, v3f maxacc,
290 float minexptime, float maxexptime,
291 float minsize, float maxsize,
292 bool collisiondetection, bool vertical, std::string texture);
294 void deleteParticleSpawner(const char *playername, u32 id);
295 void deleteParticleSpawnerAll(u32 id);
297 // Creates or resets inventory
298 Inventory* createDetachedInventory(const std::string &name);
300 // Envlock and conlock should be locked when using scriptapi
301 GameScripting *getScriptIface(){ return m_script; }
303 //TODO: determine what (if anything) should be locked to access EmergeManager
304 EmergeManager *getEmergeManager(){ return m_emerge; }
306 // actions: time-reversed list
307 // Return value: success/failure
308 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
309 std::list<std::string> *log);
311 // IGameDef interface
313 virtual IItemDefManager* getItemDefManager();
314 virtual INodeDefManager* getNodeDefManager();
315 virtual ICraftDefManager* getCraftDefManager();
316 virtual ITextureSource* getTextureSource();
317 virtual IShaderSource* getShaderSource();
318 virtual u16 allocateUnknownNodeId(const std::string &name);
319 virtual ISoundManager* getSoundManager();
320 virtual MtEventManager* getEventManager();
321 virtual scene::ISceneManager* getSceneManager();
322 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
325 IWritableItemDefManager* getWritableItemDefManager();
326 IWritableNodeDefManager* getWritableNodeDefManager();
327 IWritableCraftDefManager* getWritableCraftDefManager();
329 const ModSpec* getModSpec(const std::string &modname);
330 void getModNames(std::list<std::string> &modlist);
331 std::string getBuiltinLuaPath();
332 inline std::string getWorldPath()
333 { return m_path_world; }
335 inline bool isSingleplayer()
336 { return m_simple_singleplayer_mode; }
338 inline void setAsyncFatalError(const std::string &error)
339 { m_async_fatal_error.set(error); }
341 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
342 Map & getMap() { return m_env->getMap(); }
343 ServerEnvironment & getEnv() { return *m_env; }
345 u32 hudAdd(Player *player, HudElement *element);
346 bool hudRemove(Player *player, u32 id);
347 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
348 bool hudSetFlags(Player *player, u32 flags, u32 mask);
349 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
350 void hudSetHotbarImage(Player *player, std::string name);
351 void hudSetHotbarSelectedImage(Player *player, std::string name);
353 inline Address getPeerAddress(u16 peer_id)
354 { return m_con.GetPeerAddress(peer_id); }
356 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
357 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
359 bool setSky(Player *player, const video::SColor &bgcolor,
360 const std::string &type, const std::vector<std::string> ¶ms);
362 bool overrideDayNightRatio(Player *player, bool do_override,
365 /* con::PeerHandler implementation. */
366 void peerAdded(con::Peer *peer);
367 void deletingPeer(con::Peer *peer, bool timeout);
369 void DenyAccess(u16 peer_id, const std::wstring &reason);
370 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
371 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
372 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
373 std::string* vers_string);
375 void SendPlayerHPOrDie(u16 peer_id, bool die) { die ? DiePlayer(peer_id) : SendPlayerHP(peer_id); }
376 void SendPlayerBreath(u16 peer_id);
378 // Envlock and conlock should be locked when calling these
379 void SendInventory(u16 peer_id);
386 friend class EmergeThread;
387 friend class RemoteClient;
389 void SendMovement(u16 peer_id);
390 void SendHP(u16 peer_id, u8 hp);
391 void SendBreath(u16 peer_id, u16 breath);
392 void SendAccessDenied(u16 peer_id,const std::wstring &reason);
393 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
394 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
395 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
397 /* mark blocks not sent for all clients */
398 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
401 void SendChatMessage(u16 peer_id, const std::wstring &message);
402 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
403 void SendPlayerHP(u16 peer_id);
405 void SendMovePlayer(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::list<u16> *far_players=NULL, float far_d_nodes=100);
428 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
429 std::list<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::list<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);
468 void DiePlayer(u16 peer_id);
469 void RespawnPlayer(u16 peer_id);
470 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
471 void UpdateCrafting(Player *player);
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);
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;
504 // Thread can set; step() will throw as ServerError
505 MutexedVariable<std::string> m_async_fatal_error;
508 float m_liquid_transform_timer;
509 float m_liquid_transform_every;
510 float m_print_info_timer;
511 float m_masterserver_timer;
512 float m_objectdata_timer;
513 float m_emergethread_trigger_timer;
514 float m_savemap_timer;
515 IntervalLimiter m_map_timer_and_unload_interval;
518 ServerEnvironment *m_env;
522 con::Connection m_con;
525 BanManager *m_banmanager;
527 // Rollback manager (behind m_env_mutex)
528 IRollbackManager *m_rollback;
529 bool m_enable_rollback_recording; // Updated once in a while
532 EmergeManager *m_emerge;
535 // Envlock and conlock should be locked when using Lua
536 GameScripting *m_script;
538 // Item definition manager
539 IWritableItemDefManager *m_itemdef;
541 // Node definition manager
542 IWritableNodeDefManager *m_nodedef;
544 // Craft definition manager
545 IWritableCraftDefManager *m_craftdef;
548 EventManager *m_event;
551 std::vector<ModSpec> m_mods;
557 // A buffer for time steps
558 // step() increments and AsyncRunStep() run by m_thread reads it.
560 JMutex m_step_dtime_mutex;
562 // current server step lag counter
565 // The server mainly operates in this thread
566 ServerThread *m_thread;
572 // Timer for sending time of day over network
573 float m_time_of_day_send_timer;
574 // Uptime of server in seconds
575 MutexedVariable<double> m_uptime;
580 ClientInterface m_clients;
584 Queues stuff from peerAdded() and deletingPeer() to
587 Queue<con::PeerChange> m_peer_change_queue;
593 // Mod parent directory paths
594 std::list<std::string> m_modspaths;
596 bool m_shutdown_requested;
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 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 std::map<std::string,MediaInfo> m_media;
638 std::map<s32, ServerPlayingSound> m_playing_sounds;
642 Detached inventories (behind m_env_mutex)
645 std::map<std::string, Inventory*> m_detached_inventories;
650 std::vector<u32> m_particlespawner_ids;
654 Runs a simple dedicated server loop.
656 Shuts down when run is set to false.
658 void dedicated_server_loop(Server &server, bool &run);