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 "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"
41 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
43 class IWritableItemDefManager;
44 class IWritableNodeDefManager;
45 class IWritableCraftDefManager;
51 class IRollbackManager;
52 struct RollbackAction;
55 class ServerEnvironment;
56 struct SimpleSoundSpec;
59 enum ClientDeletionReason {
68 v3f findSpawnPos(ServerMap &map);
70 class MapEditEventIgnorer
73 MapEditEventIgnorer(bool *flag):
82 ~MapEditEventIgnorer()
95 class MapEditEventAreaIgnorer
98 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
99 m_ignorevariable(ignorevariable)
101 if(m_ignorevariable->getVolume() == 0)
102 *m_ignorevariable = a;
104 m_ignorevariable = NULL;
107 ~MapEditEventAreaIgnorer()
111 assert(m_ignorevariable->getVolume() != 0);
112 *m_ignorevariable = VoxelArea();
117 VoxelArea *m_ignorevariable;
123 std::string sha1_digest;
125 MediaInfo(const std::string &path_="",
126 const std::string &sha1_digest_=""):
128 sha1_digest(sha1_digest_)
133 struct ServerSoundParams
136 std::string to_player;
144 float max_hear_distance;
153 max_hear_distance(32*BS),
157 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
160 struct ServerPlayingSound
162 ServerSoundParams params;
163 std::set<u16> clients; // peer ids
166 class Server : public con::PeerHandler, public MapEventReceiver,
167 public InventoryManager, public IGameDef
171 NOTE: Every public method should be thread-safe
175 const std::string &path_world,
176 const SubgameSpec &gamespec,
177 bool simple_singleplayer_mode,
181 void start(Address bind_addr);
183 // This is mainly a way to pass the time to the server.
184 // Actual processing is done in an another thread.
185 void step(float dtime);
186 // This is run by ServerThread and does the actual processing
187 void AsyncRunStep(bool initial_step=false);
189 PlayerSAO* StageTwoClientInit(u16 peer_id);
190 void ProcessData(u8 *data, u32 datasize, u16 peer_id);
192 // Environment must be locked when called
193 void setTimeOfDay(u32 time);
196 Shall be called with the environment locked.
197 This is accessed by the map, which is inside the environment,
198 so it shouldn't be a problem.
200 void onMapEditEvent(MapEditEvent *event);
203 Shall be called with the environment and the connection locked.
205 Inventory* getInventory(const InventoryLocation &loc);
206 void setInventoryModified(const InventoryLocation &loc);
208 // Connection must be locked when called
209 std::wstring getStatusString();
211 // read shutdown state
212 inline bool getShutdownRequested()
213 { return m_shutdown_requested; }
215 // request server to shutdown
216 inline void requestShutdown(void)
217 { m_shutdown_requested = true; }
219 // Returns -1 if failed, sound handle on success
221 s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams ¶ms);
222 void stopSound(s32 handle);
225 std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
226 bool checkPriv(const std::string &name, const std::string &priv);
227 void reportPrivsModified(const std::string &name=""); // ""=all
228 void reportInventoryFormspecModified(const std::string &name);
230 void setIpBanned(const std::string &ip, const std::string &name);
231 void unsetIpBanned(const std::string &ip_or_name);
232 std::string getBanDescription(const std::string &ip_or_name);
234 void notifyPlayer(const char *name, const std::wstring &msg);
235 void notifyPlayers(const std::wstring &msg);
236 void spawnParticle(const char *playername,
237 v3f pos, v3f velocity, v3f acceleration,
238 float expirationtime, float size,
239 bool collisiondetection, bool vertical, std::string texture);
241 void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
242 float expirationtime, float size,
243 bool collisiondetection, bool vertical, std::string texture);
245 u32 addParticleSpawner(const char *playername,
246 u16 amount, float spawntime,
247 v3f minpos, v3f maxpos,
248 v3f minvel, v3f maxvel,
249 v3f minacc, v3f maxacc,
250 float minexptime, float maxexptime,
251 float minsize, float maxsize,
252 bool collisiondetection, bool vertical, std::string texture);
254 u32 addParticleSpawnerAll(u16 amount, float spawntime,
255 v3f minpos, v3f maxpos,
256 v3f minvel, v3f maxvel,
257 v3f minacc, v3f maxacc,
258 float minexptime, float maxexptime,
259 float minsize, float maxsize,
260 bool collisiondetection, bool vertical, std::string texture);
262 void deleteParticleSpawner(const char *playername, u32 id);
263 void deleteParticleSpawnerAll(u32 id);
265 // Creates or resets inventory
266 Inventory* createDetachedInventory(const std::string &name);
268 // Envlock and conlock should be locked when using scriptapi
269 GameScripting *getScriptIface(){ return m_script; }
271 //TODO: determine what (if anything) should be locked to access EmergeManager
272 EmergeManager *getEmergeManager(){ return m_emerge; }
274 // actions: time-reversed list
275 // Return value: success/failure
276 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
277 std::list<std::string> *log);
279 // IGameDef interface
281 virtual IItemDefManager* getItemDefManager();
282 virtual INodeDefManager* getNodeDefManager();
283 virtual ICraftDefManager* getCraftDefManager();
284 virtual ITextureSource* getTextureSource();
285 virtual IShaderSource* getShaderSource();
286 virtual u16 allocateUnknownNodeId(const std::string &name);
287 virtual ISoundManager* getSoundManager();
288 virtual MtEventManager* getEventManager();
289 virtual scene::ISceneManager* getSceneManager();
290 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
293 IWritableItemDefManager* getWritableItemDefManager();
294 IWritableNodeDefManager* getWritableNodeDefManager();
295 IWritableCraftDefManager* getWritableCraftDefManager();
297 const ModSpec* getModSpec(const std::string &modname);
298 void getModNames(std::list<std::string> &modlist);
299 std::string getBuiltinLuaPath();
300 inline std::string getWorldPath()
301 { return m_path_world; }
303 inline bool isSingleplayer()
304 { return m_simple_singleplayer_mode; }
306 inline void setAsyncFatalError(const std::string &error)
307 { m_async_fatal_error.set(error); }
309 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
310 Map & getMap() { return m_env->getMap(); }
311 ServerEnvironment & getEnv() { return *m_env; }
313 u32 hudAdd(Player *player, HudElement *element);
314 bool hudRemove(Player *player, u32 id);
315 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
316 bool hudSetFlags(Player *player, u32 flags, u32 mask);
317 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
318 void hudSetHotbarImage(Player *player, std::string name);
319 void hudSetHotbarSelectedImage(Player *player, std::string name);
321 inline Address getPeerAddress(u16 peer_id)
322 { return m_con.GetPeerAddress(peer_id); }
324 bool setLocalPlayerAnimations(Player *player, v2s32 animation_frames[4], f32 frame_speed);
325 bool setPlayerEyeOffset(Player *player, v3f first, v3f third);
327 bool setSky(Player *player, const video::SColor &bgcolor,
328 const std::string &type, const std::vector<std::string> ¶ms);
330 bool overrideDayNightRatio(Player *player, bool do_override,
333 /* con::PeerHandler implementation. */
334 void peerAdded(con::Peer *peer);
335 void deletingPeer(con::Peer *peer, bool timeout);
337 void DenyAccess(u16 peer_id, const std::wstring &reason);
338 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
339 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
340 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
341 std::string* vers_string);
345 friend class EmergeThread;
346 friend class RemoteClient;
348 void SendMovement(u16 peer_id);
349 void SendHP(u16 peer_id, u8 hp);
350 void SendBreath(u16 peer_id, u16 breath);
351 void SendAccessDenied(u16 peer_id,const std::wstring &reason);
352 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
353 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
354 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
356 /* mark blocks not sent for all clients */
357 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
359 // Envlock and conlock should be locked when calling these
360 void SendInventory(u16 peer_id);
361 void SendChatMessage(u16 peer_id, const std::wstring &message);
362 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
363 void SendPlayerHP(u16 peer_id);
364 void SendPlayerBreath(u16 peer_id);
365 void SendMovePlayer(u16 peer_id);
366 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
367 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
368 void SendPlayerPrivileges(u16 peer_id);
369 void SendPlayerInventoryFormspec(u16 peer_id);
370 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
371 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
372 void SendHUDRemove(u16 peer_id, u32 id);
373 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
374 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
375 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
376 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
377 const std::string &type, const std::vector<std::string> ¶ms);
378 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
381 Send a node removal/addition event to all clients except ignore_id.
382 Additionally, if far_players!=NULL, players further away than
383 far_d_nodes are ignored and their peer_ids are added to far_players
385 // Envlock and conlock should be locked when calling these
386 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
387 std::list<u16> *far_players=NULL, float far_d_nodes=100);
388 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
389 std::list<u16> *far_players=NULL, float far_d_nodes=100,
390 bool remove_metadata=true);
391 void setBlockNotSent(v3s16 p);
393 // Environment and Connection must be locked when called
394 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
396 // Sends blocks to clients (locks env and con on its own)
397 void SendBlocks(float dtime);
399 void fillMediaCache();
400 void sendMediaAnnouncement(u16 peer_id);
401 void sendRequestedMedia(u16 peer_id,
402 const std::list<std::string> &tosend);
404 void sendDetachedInventory(const std::string &name, u16 peer_id);
405 void sendDetachedInventories(u16 peer_id);
407 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
408 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
409 v3f minpos, v3f maxpos,
410 v3f minvel, v3f maxvel,
411 v3f minacc, v3f maxacc,
412 float minexptime, float maxexptime,
413 float minsize, float maxsize,
414 bool collisiondetection, bool vertical, std::string texture, u32 id);
416 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
418 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
419 void SendSpawnParticle(u16 peer_id,
420 v3f pos, v3f velocity, v3f acceleration,
421 float expirationtime, float size,
422 bool collisiondetection, bool vertical, std::string texture);
428 void DiePlayer(u16 peer_id);
429 void RespawnPlayer(u16 peer_id);
430 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
431 void UpdateCrafting(u16 peer_id);
433 // When called, connection mutex should be locked
434 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
435 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
437 // When called, environment mutex should be locked
438 std::string getPlayerName(u16 peer_id);
439 PlayerSAO* getPlayerSAO(u16 peer_id);
442 Get a player from memory or creates one.
443 If player is already connected, return NULL
444 Does not verify/modify auth info and password.
446 Call with env and con locked.
448 PlayerSAO *emergePlayer(const char *name, u16 peer_id);
450 void handlePeerChanges();
457 std::string m_path_world;
458 // Subgame specification
459 SubgameSpec m_gamespec;
460 // If true, do not allow multiple players and hide some multiplayer
462 bool m_simple_singleplayer_mode;
464 // Thread can set; step() will throw as ServerError
465 MutexedVariable<std::string> m_async_fatal_error;
468 float m_liquid_transform_timer;
469 float m_liquid_transform_every;
470 float m_print_info_timer;
471 float m_masterserver_timer;
472 float m_objectdata_timer;
473 float m_emergethread_trigger_timer;
474 float m_savemap_timer;
475 IntervalLimiter m_map_timer_and_unload_interval;
478 ServerEnvironment *m_env;
482 con::Connection m_con;
485 BanManager *m_banmanager;
487 // Rollback manager (behind m_env_mutex)
488 IRollbackManager *m_rollback;
489 bool m_enable_rollback_recording; // Updated once in a while
492 EmergeManager *m_emerge;
495 // Envlock and conlock should be locked when using Lua
496 GameScripting *m_script;
498 // Item definition manager
499 IWritableItemDefManager *m_itemdef;
501 // Node definition manager
502 IWritableNodeDefManager *m_nodedef;
504 // Craft definition manager
505 IWritableCraftDefManager *m_craftdef;
508 EventManager *m_event;
511 std::vector<ModSpec> m_mods;
517 // A buffer for time steps
518 // step() increments and AsyncRunStep() run by m_thread reads it.
520 JMutex m_step_dtime_mutex;
522 // current server step lag counter
525 // The server mainly operates in this thread
526 ServerThread *m_thread;
532 // Timer for sending time of day over network
533 float m_time_of_day_send_timer;
534 // Uptime of server in seconds
535 MutexedVariable<double> m_uptime;
540 ClientInterface m_clients;
544 Queues stuff from peerAdded() and deletingPeer() to
547 Queue<con::PeerChange> m_peer_change_queue;
553 // Mod parent directory paths
554 std::list<std::string> m_modspaths;
556 bool m_shutdown_requested;
559 Map edit event queue. Automatically receives all map edits.
560 The constructor of this class registers us to receive them through
563 NOTE: Should these be moved to actually be members of
568 Queue of map edits from the environment for sending to the clients
569 This is behind m_env_mutex
571 Queue<MapEditEvent*> m_unsent_map_edit_queue;
573 Set to true when the server itself is modifying the map and does
574 all sending of information by itself.
575 This is behind m_env_mutex
577 bool m_ignore_map_edit_events;
579 If a non-empty area, map edit events contained within are left
580 unsent. Done at map generation time to speed up editing of the
581 generated area, as it will be sent anyway.
582 This is behind m_env_mutex
584 VoxelArea m_ignore_map_edit_events_area;
586 If set to !=0, the incoming MapEditEvents are modified to have
587 this peed id as the disabled recipient
588 This is behind m_env_mutex
590 u16 m_ignore_map_edit_events_peer_id;
592 // media files known to server
593 std::map<std::string,MediaInfo> m_media;
598 std::map<s32, ServerPlayingSound> m_playing_sounds;
602 Detached inventories (behind m_env_mutex)
605 std::map<std::string, Inventory*> m_detached_inventories;
610 std::vector<u32> m_particlespawner_ids;
614 Runs a simple dedicated server loop.
616 Shuts down when run is set to false.
618 void dedicated_server_loop(Server &server, bool &run);