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 "chat_interface.h"
36 #include "clientiface.h"
37 #include "network/networkpacket.h"
43 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
45 class IWritableItemDefManager;
46 class IWritableNodeDefManager;
47 class IWritableCraftDefManager;
53 class IRollbackManager;
54 struct RollbackAction;
57 class ServerEnvironment;
58 struct SimpleSoundSpec;
61 enum ClientDeletionReason {
67 class MapEditEventIgnorer
70 MapEditEventIgnorer(bool *flag):
79 ~MapEditEventIgnorer()
92 class MapEditEventAreaIgnorer
95 MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
96 m_ignorevariable(ignorevariable)
98 if(m_ignorevariable->getVolume() == 0)
99 *m_ignorevariable = a;
101 m_ignorevariable = NULL;
104 ~MapEditEventAreaIgnorer()
108 assert(m_ignorevariable->getVolume() != 0);
109 *m_ignorevariable = VoxelArea();
114 VoxelArea *m_ignorevariable;
120 std::string sha1_digest;
122 MediaInfo(const std::string &path_="",
123 const std::string &sha1_digest_=""):
125 sha1_digest(sha1_digest_)
130 struct ServerSoundParams
133 std::string to_player;
141 float max_hear_distance;
150 max_hear_distance(32*BS),
154 v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
157 struct ServerPlayingSound
159 ServerSoundParams params;
160 UNORDERED_SET<u16> clients; // peer ids
163 class Server : public con::PeerHandler, public MapEventReceiver,
164 public InventoryManager, public IGameDef
168 NOTE: Every public method should be thread-safe
172 const std::string &path_world,
173 const SubgameSpec &gamespec,
174 bool simple_singleplayer_mode,
176 ChatInterface *iface = NULL
179 void start(Address bind_addr);
181 // This is mainly a way to pass the time to the server.
182 // Actual processing is done in an another thread.
183 void step(float dtime);
184 // This is run by ServerThread and does the actual processing
185 void AsyncRunStep(bool initial_step=false);
187 PlayerSAO* StageTwoClientInit(u16 peer_id);
193 void handleCommand(NetworkPacket* pkt);
195 void handleCommand_Null(NetworkPacket* pkt) {};
196 void handleCommand_Deprecated(NetworkPacket* pkt);
197 void handleCommand_Init(NetworkPacket* pkt);
198 void handleCommand_Init_Legacy(NetworkPacket* pkt);
199 void handleCommand_Init2(NetworkPacket* pkt);
200 void handleCommand_RequestMedia(NetworkPacket* pkt);
201 void handleCommand_ReceivedMedia(NetworkPacket* pkt);
202 void handleCommand_ClientReady(NetworkPacket* pkt);
203 void handleCommand_GotBlocks(NetworkPacket* pkt);
204 void handleCommand_PlayerPos(NetworkPacket* pkt);
205 void handleCommand_DeletedBlocks(NetworkPacket* pkt);
206 void handleCommand_InventoryAction(NetworkPacket* pkt);
207 void handleCommand_ChatMessage(NetworkPacket* pkt);
208 void handleCommand_Damage(NetworkPacket* pkt);
209 void handleCommand_Breath(NetworkPacket* pkt);
210 void handleCommand_Password(NetworkPacket* pkt);
211 void handleCommand_PlayerItem(NetworkPacket* pkt);
212 void handleCommand_Respawn(NetworkPacket* pkt);
213 void handleCommand_Interact(NetworkPacket* pkt);
214 void handleCommand_RemovedSounds(NetworkPacket* pkt);
215 void handleCommand_NodeMetaFields(NetworkPacket* pkt);
216 void handleCommand_InventoryFields(NetworkPacket* pkt);
217 void handleCommand_FirstSrp(NetworkPacket* pkt);
218 void handleCommand_SrpBytesA(NetworkPacket* pkt);
219 void handleCommand_SrpBytesM(NetworkPacket* pkt);
221 void ProcessData(NetworkPacket *pkt);
223 void Send(NetworkPacket* pkt);
225 // Both setter and getter need no envlock,
226 // can be called freely from threads
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, bool playerSend = true);
242 // Connection must be locked when called
243 std::wstring getStatusString();
245 // read shutdown state
246 inline bool getShutdownRequested() const { return m_shutdown_requested; }
248 // request server to shutdown
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 collision_removal,
277 bool vertical, const std::string &texture);
279 u32 addParticleSpawner(u16 amount, float spawntime,
280 v3f minpos, v3f maxpos,
281 v3f minvel, v3f maxvel,
282 v3f minacc, v3f maxacc,
283 float minexptime, float maxexptime,
284 float minsize, float maxsize,
285 bool collisiondetection, bool collision_removal,
286 bool vertical, const std::string &texture,
287 const std::string &playername);
289 void deleteParticleSpawner(const std::string &playername, u32 id);
290 void deleteParticleSpawnerAll(u32 id);
292 // Creates or resets inventory
293 Inventory* createDetachedInventory(const std::string &name);
295 // Envlock and conlock should be locked when using scriptapi
296 GameScripting *getScriptIface(){ return m_script; }
298 // actions: time-reversed list
299 // Return value: success/failure
300 bool rollbackRevertActions(const std::list<RollbackAction> &actions,
301 std::list<std::string> *log);
303 // IGameDef interface
305 virtual IItemDefManager* getItemDefManager();
306 virtual INodeDefManager* getNodeDefManager();
307 virtual ICraftDefManager* getCraftDefManager();
308 virtual ITextureSource* getTextureSource();
309 virtual IShaderSource* getShaderSource();
310 virtual u16 allocateUnknownNodeId(const std::string &name);
311 virtual ISoundManager* getSoundManager();
312 virtual MtEventManager* getEventManager();
313 virtual scene::ISceneManager* getSceneManager();
314 virtual IRollbackManager *getRollbackManager() { return m_rollback; }
315 virtual EmergeManager *getEmergeManager() { return m_emerge; }
317 IWritableItemDefManager* getWritableItemDefManager();
318 IWritableNodeDefManager* getWritableNodeDefManager();
319 IWritableCraftDefManager* getWritableCraftDefManager();
321 const ModSpec* getModSpec(const std::string &modname) const;
322 void getModNames(std::vector<std::string> &modlist);
323 std::string getBuiltinLuaPath();
324 inline std::string getWorldPath() const { return m_path_world; }
326 inline bool isSingleplayer()
327 { return m_simple_singleplayer_mode; }
329 inline void setAsyncFatalError(const std::string &error)
330 { m_async_fatal_error.set(error); }
332 bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
333 Map & getMap() { return m_env->getMap(); }
334 ServerEnvironment & getEnv() { return *m_env; }
336 u32 hudAdd(Player *player, HudElement *element);
337 bool hudRemove(Player *player, u32 id);
338 bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
339 bool hudSetFlags(Player *player, u32 flags, u32 mask);
340 bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
341 s32 hudGetHotbarItemcount(Player *player);
342 void hudSetHotbarImage(Player *player, std::string name);
343 std::string hudGetHotbarImage(Player *player);
344 void hudSetHotbarSelectedImage(Player *player, std::string name);
345 std::string hudGetHotbarSelectedImage(Player *player);
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, float brightness);
358 /* con::PeerHandler implementation. */
359 void peerAdded(con::Peer *peer);
360 void deletingPeer(con::Peer *peer, bool timeout);
362 void DenySudoAccess(u16 peer_id);
363 void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
364 const std::string &str_reason = "", bool reconnect = false);
365 void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
366 void acceptAuth(u16 peer_id, bool forSudoMode);
367 void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
368 bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
369 bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
370 u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
371 std::string* vers_string);
373 void printToConsoleOnly(const std::string &text);
375 void SendPlayerHPOrDie(PlayerSAO *player);
376 void SendPlayerBreath(u16 peer_id);
377 void SendInventory(PlayerSAO* playerSAO);
378 void SendMovePlayer(u16 peer_id);
383 // Environment mutex (envlock)
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,
395 const std::string &custom_reason, bool reconnect = false);
396 void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
397 void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
398 void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
399 void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
401 /* mark blocks not sent for all clients */
402 void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
405 void SendChatMessage(u16 peer_id, const std::wstring &message);
406 void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
407 void SendPlayerHP(u16 peer_id);
409 void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
410 void SendEyeOffset(u16 peer_id, v3f first, v3f third);
411 void SendPlayerPrivileges(u16 peer_id);
412 void SendPlayerInventoryFormspec(u16 peer_id);
413 void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
414 void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
415 void SendHUDRemove(u16 peer_id, u32 id);
416 void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
417 void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
418 void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
419 void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
420 const std::string &type, const std::vector<std::string> ¶ms);
421 void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
424 Send a node removal/addition event to all clients except ignore_id.
425 Additionally, if far_players!=NULL, players further away than
426 far_d_nodes are ignored and their peer_ids are added to far_players
428 // Envlock and conlock should be locked when calling these
429 void sendRemoveNode(v3s16 p, u16 ignore_id=0,
430 std::vector<u16> *far_players=NULL, float far_d_nodes=100);
431 void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
432 std::vector<u16> *far_players=NULL, float far_d_nodes=100,
433 bool remove_metadata=true);
434 void setBlockNotSent(v3s16 p);
436 // Environment and Connection must be locked when called
437 void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
439 // Sends blocks to clients (locks env and con on its own)
440 void SendBlocks(float dtime);
442 void fillMediaCache();
443 void sendMediaAnnouncement(u16 peer_id);
444 void sendRequestedMedia(u16 peer_id,
445 const std::vector<std::string> &tosend);
447 void sendDetachedInventory(const std::string &name, u16 peer_id);
448 void sendDetachedInventories(u16 peer_id);
450 // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
451 void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
452 v3f minpos, v3f maxpos,
453 v3f minvel, v3f maxvel,
454 v3f minacc, v3f maxacc,
455 float minexptime, float maxexptime,
456 float minsize, float maxsize,
457 bool collisiondetection, bool collision_removal,
458 bool vertical, const std::string &texture, u32 id);
460 void SendDeleteParticleSpawner(u16 peer_id, u32 id);
462 // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
463 void SendSpawnParticle(u16 peer_id,
464 v3f pos, v3f velocity, v3f acceleration,
465 float expirationtime, float size,
466 bool collisiondetection, bool collision_removal,
467 bool vertical, const std::string &texture);
469 u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
470 void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
475 void DiePlayer(u16 peer_id);
476 void RespawnPlayer(u16 peer_id);
477 void DeleteClient(u16 peer_id, ClientDeletionReason reason);
478 void UpdateCrafting(Player *player);
480 void handleChatInterfaceEvent(ChatEvent *evt);
482 // This returns the answer to the sender of wmessage, or "" if there is none
483 std::wstring handleChat(const std::string &name, const std::wstring &wname,
484 const std::wstring &wmessage,
485 bool check_shout_priv = false,
486 RemotePlayer *player = NULL);
487 void handleAdminChat(const ChatEventChat *evt);
491 // When called, connection mutex should be locked
492 RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
493 RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
495 // When called, environment mutex should be locked
496 std::string getPlayerName(u16 peer_id);
497 PlayerSAO* getPlayerSAO(u16 peer_id);
500 Get a player from memory or creates one.
501 If player is already connected, return NULL
502 Does not verify/modify auth info and password.
504 Call with env and con locked.
506 PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
508 void handlePeerChanges();
515 std::string m_path_world;
516 // Subgame specification
517 SubgameSpec m_gamespec;
518 // If true, do not allow multiple players and hide some multiplayer
520 bool m_simple_singleplayer_mode;
521 u16 m_max_chatmessage_length;
523 // Thread can set; step() will throw as ServerError
524 MutexedVariable<std::string> m_async_fatal_error;
527 float m_liquid_transform_timer;
528 float m_liquid_transform_every;
529 float m_print_info_timer;
530 float m_masterserver_timer;
531 float m_objectdata_timer;
532 float m_emergethread_trigger_timer;
533 float m_savemap_timer;
534 IntervalLimiter m_map_timer_and_unload_interval;
537 ServerEnvironment *m_env;
540 con::Connection m_con;
543 BanManager *m_banmanager;
545 // Rollback manager (behind m_env_mutex)
546 IRollbackManager *m_rollback;
547 bool m_enable_rollback_recording; // Updated once in a while
550 EmergeManager *m_emerge;
553 // Envlock and conlock should be locked when using Lua
554 GameScripting *m_script;
556 // Item definition manager
557 IWritableItemDefManager *m_itemdef;
559 // Node definition manager
560 IWritableNodeDefManager *m_nodedef;
562 // Craft definition manager
563 IWritableCraftDefManager *m_craftdef;
566 EventManager *m_event;
569 std::vector<ModSpec> m_mods;
575 // A buffer for time steps
576 // step() increments and AsyncRunStep() run by m_thread reads it.
578 Mutex m_step_dtime_mutex;
580 // current server step lag counter
583 // The server mainly operates in this thread
584 ServerThread *m_thread;
590 // Timer for sending time of day over network
591 float m_time_of_day_send_timer;
592 // Uptime of server in seconds
593 MutexedVariable<double> m_uptime;
598 ClientInterface m_clients;
602 Queues stuff from peerAdded() and deletingPeer() to
605 std::queue<con::PeerChange> m_peer_change_queue;
611 bool m_shutdown_requested;
612 std::string m_shutdown_msg;
613 bool m_shutdown_ask_reconnect;
615 ChatInterface *m_admin_chat;
616 std::string m_admin_nick;
619 Map edit event queue. Automatically receives all map edits.
620 The constructor of this class registers us to receive them through
623 NOTE: Should these be moved to actually be members of
628 Queue of map edits from the environment for sending to the clients
629 This is behind m_env_mutex
631 std::queue<MapEditEvent*> m_unsent_map_edit_queue;
633 Set to true when the server itself is modifying the map and does
634 all sending of information by itself.
635 This is behind m_env_mutex
637 bool m_ignore_map_edit_events;
639 If a non-empty area, map edit events contained within are left
640 unsent. Done at map generation time to speed up editing of the
641 generated area, as it will be sent anyway.
642 This is behind m_env_mutex
644 VoxelArea m_ignore_map_edit_events_area;
646 If set to !=0, the incoming MapEditEvents are modified to have
647 this peed id as the disabled recipient
648 This is behind m_env_mutex
650 u16 m_ignore_map_edit_events_peer_id;
652 // media files known to server
653 UNORDERED_MAP<std::string, MediaInfo> m_media;
658 UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
662 Detached inventories (behind m_env_mutex)
665 std::map<std::string, Inventory*> m_detached_inventories;
667 DISABLE_CLASS_COPY(Server);
671 Runs a simple dedicated server loop.
673 Shuts down when kill is set to true.
675 void dedicated_server_loop(Server &server, bool &kill);