Move RemotePlayer code to its own cpp/header
[oweals/minetest.git] / src / server.h
1 /*
2 Minetest
3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
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.
9
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.
14
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.
18 */
19
20 #ifndef SERVER_HEADER
21 #define SERVER_HEADER
22
23 #include "network/connection.h"
24 #include "irr_v3d.h"
25 #include "map.h"
26 #include "hud.h"
27 #include "gamedef.h"
28 #include "serialization.h" // For SER_FMT_VER_INVALID
29 #include "mods.h"
30 #include "inventorymanager.h"
31 #include "subgame.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 "remoteplayer.h"
38 #include "network/networkpacket.h"
39 #include <string>
40 #include <list>
41 #include <map>
42 #include <vector>
43
44 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
45
46 class IWritableItemDefManager;
47 class IWritableNodeDefManager;
48 class IWritableCraftDefManager;
49 class BanManager;
50 class EventManager;
51 class Inventory;
52 class PlayerSAO;
53 class IRollbackManager;
54 struct RollbackAction;
55 class EmergeManager;
56 class GameScripting;
57 class ServerEnvironment;
58 struct SimpleSoundSpec;
59 class ServerThread;
60
61 enum ClientDeletionReason {
62         CDR_LEAVE,
63         CDR_TIMEOUT,
64         CDR_DENY
65 };
66
67 class MapEditEventAreaIgnorer
68 {
69 public:
70         MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
71                 m_ignorevariable(ignorevariable)
72         {
73                 if(m_ignorevariable->getVolume() == 0)
74                         *m_ignorevariable = a;
75                 else
76                         m_ignorevariable = NULL;
77         }
78
79         ~MapEditEventAreaIgnorer()
80         {
81                 if(m_ignorevariable)
82                 {
83                         assert(m_ignorevariable->getVolume() != 0);
84                         *m_ignorevariable = VoxelArea();
85                 }
86         }
87
88 private:
89         VoxelArea *m_ignorevariable;
90 };
91
92 struct MediaInfo
93 {
94         std::string path;
95         std::string sha1_digest;
96
97         MediaInfo(const std::string &path_="",
98                   const std::string &sha1_digest_=""):
99                 path(path_),
100                 sha1_digest(sha1_digest_)
101         {
102         }
103 };
104
105 struct ServerSoundParams
106 {
107         float gain;
108         std::string to_player;
109         enum Type{
110                 SSP_LOCAL=0,
111                 SSP_POSITIONAL=1,
112                 SSP_OBJECT=2
113         } type;
114         v3f pos;
115         u16 object;
116         float max_hear_distance;
117         bool loop;
118
119         ServerSoundParams():
120                 gain(1.0),
121                 to_player(""),
122                 type(SSP_LOCAL),
123                 pos(0,0,0),
124                 object(0),
125                 max_hear_distance(32*BS),
126                 loop(false)
127         {}
128
129         v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
130 };
131
132 struct ServerPlayingSound
133 {
134         ServerSoundParams params;
135         UNORDERED_SET<u16> clients; // peer ids
136 };
137
138 class Server : public con::PeerHandler, public MapEventReceiver,
139                 public InventoryManager, public IGameDef
140 {
141 public:
142         /*
143                 NOTE: Every public method should be thread-safe
144         */
145
146         Server(
147                 const std::string &path_world,
148                 const SubgameSpec &gamespec,
149                 bool simple_singleplayer_mode,
150                 bool ipv6,
151                 ChatInterface *iface = NULL
152         );
153         ~Server();
154         void start(Address bind_addr);
155         void stop();
156         // This is mainly a way to pass the time to the server.
157         // Actual processing is done in an another thread.
158         void step(float dtime);
159         // This is run by ServerThread and does the actual processing
160         void AsyncRunStep(bool initial_step=false);
161         void Receive();
162         PlayerSAO* StageTwoClientInit(u16 peer_id);
163
164         /*
165          * Command Handlers
166          */
167
168         void handleCommand(NetworkPacket* pkt);
169
170         void handleCommand_Null(NetworkPacket* pkt) {};
171         void handleCommand_Deprecated(NetworkPacket* pkt);
172         void handleCommand_Init(NetworkPacket* pkt);
173         void handleCommand_Init_Legacy(NetworkPacket* pkt);
174         void handleCommand_Init2(NetworkPacket* pkt);
175         void handleCommand_RequestMedia(NetworkPacket* pkt);
176         void handleCommand_ReceivedMedia(NetworkPacket* pkt);
177         void handleCommand_ClientReady(NetworkPacket* pkt);
178         void handleCommand_GotBlocks(NetworkPacket* pkt);
179         void handleCommand_PlayerPos(NetworkPacket* pkt);
180         void handleCommand_DeletedBlocks(NetworkPacket* pkt);
181         void handleCommand_InventoryAction(NetworkPacket* pkt);
182         void handleCommand_ChatMessage(NetworkPacket* pkt);
183         void handleCommand_Damage(NetworkPacket* pkt);
184         void handleCommand_Breath(NetworkPacket* pkt);
185         void handleCommand_Password(NetworkPacket* pkt);
186         void handleCommand_PlayerItem(NetworkPacket* pkt);
187         void handleCommand_Respawn(NetworkPacket* pkt);
188         void handleCommand_Interact(NetworkPacket* pkt);
189         void handleCommand_RemovedSounds(NetworkPacket* pkt);
190         void handleCommand_NodeMetaFields(NetworkPacket* pkt);
191         void handleCommand_InventoryFields(NetworkPacket* pkt);
192         void handleCommand_FirstSrp(NetworkPacket* pkt);
193         void handleCommand_SrpBytesA(NetworkPacket* pkt);
194         void handleCommand_SrpBytesM(NetworkPacket* pkt);
195
196         void ProcessData(NetworkPacket *pkt);
197
198         void Send(NetworkPacket* pkt);
199
200         // Both setter and getter need no envlock,
201         // can be called freely from threads
202         void setTimeOfDay(u32 time);
203
204         /*
205                 Shall be called with the environment locked.
206                 This is accessed by the map, which is inside the environment,
207                 so it shouldn't be a problem.
208         */
209         void onMapEditEvent(MapEditEvent *event);
210
211         /*
212                 Shall be called with the environment and the connection locked.
213         */
214         Inventory* getInventory(const InventoryLocation &loc);
215         void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
216
217         // Connection must be locked when called
218         std::wstring getStatusString();
219
220         // read shutdown state
221         inline bool getShutdownRequested() const { return m_shutdown_requested; }
222
223         // request server to shutdown
224         void requestShutdown(const std::string &msg, bool reconnect)
225         {
226                 m_shutdown_requested = true;
227                 m_shutdown_msg = msg;
228                 m_shutdown_ask_reconnect = reconnect;
229         }
230
231         // Returns -1 if failed, sound handle on success
232         // Envlock
233         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
234         void stopSound(s32 handle);
235
236         // Envlock
237         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
238         bool checkPriv(const std::string &name, const std::string &priv);
239         void reportPrivsModified(const std::string &name=""); // ""=all
240         void reportInventoryFormspecModified(const std::string &name);
241
242         void setIpBanned(const std::string &ip, const std::string &name);
243         void unsetIpBanned(const std::string &ip_or_name);
244         std::string getBanDescription(const std::string &ip_or_name);
245
246         void notifyPlayer(const char *name, const std::wstring &msg);
247         void notifyPlayers(const std::wstring &msg);
248         void spawnParticle(const std::string &playername,
249                 v3f pos, v3f velocity, v3f acceleration,
250                 float expirationtime, float size,
251                 bool collisiondetection, bool collision_removal,
252                 bool vertical, const std::string &texture);
253
254         u32 addParticleSpawner(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 collision_removal,
261                 bool vertical, const std::string &texture,
262                 const std::string &playername);
263
264         void deleteParticleSpawner(const std::string &playername, u32 id);
265
266         // Creates or resets inventory
267         Inventory* createDetachedInventory(const std::string &name);
268
269         // Envlock and conlock should be locked when using scriptapi
270         GameScripting *getScriptIface(){ return m_script; }
271
272         // actions: time-reversed list
273         // Return value: success/failure
274         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
275                         std::list<std::string> *log);
276
277         // IGameDef interface
278         // Under envlock
279         virtual IItemDefManager* getItemDefManager();
280         virtual INodeDefManager* getNodeDefManager();
281         virtual ICraftDefManager* getCraftDefManager();
282         virtual ITextureSource* getTextureSource();
283         virtual IShaderSource* getShaderSource();
284         virtual u16 allocateUnknownNodeId(const std::string &name);
285         virtual ISoundManager* getSoundManager();
286         virtual MtEventManager* getEventManager();
287         virtual scene::ISceneManager* getSceneManager();
288         virtual IRollbackManager *getRollbackManager() { return m_rollback; }
289         virtual EmergeManager *getEmergeManager() { return m_emerge; }
290
291         IWritableItemDefManager* getWritableItemDefManager();
292         IWritableNodeDefManager* getWritableNodeDefManager();
293         IWritableCraftDefManager* getWritableCraftDefManager();
294
295         const ModSpec* getModSpec(const std::string &modname) const;
296         void getModNames(std::vector<std::string> &modlist);
297         std::string getBuiltinLuaPath();
298         inline std::string getWorldPath() const { return m_path_world; }
299
300         inline bool isSingleplayer()
301                         { return m_simple_singleplayer_mode; }
302
303         inline void setAsyncFatalError(const std::string &error)
304                         { m_async_fatal_error.set(error); }
305
306         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
307         Map & getMap() { return m_env->getMap(); }
308         ServerEnvironment & getEnv() { return *m_env; }
309
310         u32 hudAdd(RemotePlayer *player, HudElement *element);
311         bool hudRemove(RemotePlayer *player, u32 id);
312         bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
313         bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
314         bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
315         s32 hudGetHotbarItemcount(RemotePlayer *player) const
316                         { return player->getHotbarItemcount(); }
317         void hudSetHotbarImage(RemotePlayer *player, std::string name);
318         std::string hudGetHotbarImage(RemotePlayer *player);
319         void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
320         const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
321         {
322                 return player->getHotbarSelectedImage();
323         }
324
325         inline Address getPeerAddress(u16 peer_id)
326                         { return m_con.GetPeerAddress(peer_id); }
327
328         bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
329                         f32 frame_speed);
330         bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
331
332         bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
333                         const std::string &type, const std::vector<std::string> &params);
334
335         bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
336
337         /* con::PeerHandler implementation. */
338         void peerAdded(con::Peer *peer);
339         void deletingPeer(con::Peer *peer, bool timeout);
340
341         void DenySudoAccess(u16 peer_id);
342         void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
343                 const std::string &str_reason = "", bool reconnect = false);
344         void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
345         void acceptAuth(u16 peer_id, bool forSudoMode);
346         void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
347         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
348         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
349                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
350                         std::string* vers_string);
351
352         void printToConsoleOnly(const std::string &text);
353
354         void SendPlayerHPOrDie(PlayerSAO *player);
355         void SendPlayerBreath(u16 peer_id);
356         void SendInventory(PlayerSAO* playerSAO);
357         void SendMovePlayer(u16 peer_id);
358
359         // Bind address
360         Address m_bind_addr;
361
362         // Environment mutex (envlock)
363         Mutex m_env_mutex;
364
365 private:
366
367         friend class EmergeThread;
368         friend class RemoteClient;
369
370         void SendMovement(u16 peer_id);
371         void SendHP(u16 peer_id, u8 hp);
372         void SendBreath(u16 peer_id, u16 breath);
373         void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
374                 const std::string &custom_reason, bool reconnect = false);
375         void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
376         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
377         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
378         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
379
380         /* mark blocks not sent for all clients */
381         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
382
383
384         void SendChatMessage(u16 peer_id, const std::wstring &message);
385         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
386         void SendPlayerHP(u16 peer_id);
387
388         void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
389         void SendEyeOffset(u16 peer_id, v3f first, v3f third);
390         void SendPlayerPrivileges(u16 peer_id);
391         void SendPlayerInventoryFormspec(u16 peer_id);
392         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
393         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
394         void SendHUDRemove(u16 peer_id, u32 id);
395         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
396         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
397         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
398         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
399                         const std::string &type, const std::vector<std::string> &params);
400         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
401
402         /*
403                 Send a node removal/addition event to all clients except ignore_id.
404                 Additionally, if far_players!=NULL, players further away than
405                 far_d_nodes are ignored and their peer_ids are added to far_players
406         */
407         // Envlock and conlock should be locked when calling these
408         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
409                         std::vector<u16> *far_players=NULL, float far_d_nodes=100);
410         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
411                         std::vector<u16> *far_players=NULL, float far_d_nodes=100,
412                         bool remove_metadata=true);
413         void setBlockNotSent(v3s16 p);
414
415         // Environment and Connection must be locked when called
416         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
417
418         // Sends blocks to clients (locks env and con on its own)
419         void SendBlocks(float dtime);
420
421         void fillMediaCache();
422         void sendMediaAnnouncement(u16 peer_id);
423         void sendRequestedMedia(u16 peer_id,
424                         const std::vector<std::string> &tosend);
425
426         void sendDetachedInventory(const std::string &name, u16 peer_id);
427         void sendDetachedInventories(u16 peer_id);
428
429         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
430         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
431                 v3f minpos, v3f maxpos,
432                 v3f minvel, v3f maxvel,
433                 v3f minacc, v3f maxacc,
434                 float minexptime, float maxexptime,
435                 float minsize, float maxsize,
436                 bool collisiondetection, bool collision_removal,
437                 bool vertical, const std::string &texture, u32 id);
438
439         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
440
441         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
442         void SendSpawnParticle(u16 peer_id,
443                 v3f pos, v3f velocity, v3f acceleration,
444                 float expirationtime, float size,
445                 bool collisiondetection, bool collision_removal,
446                 bool vertical, const std::string &texture);
447
448         u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
449         void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
450         /*
451                 Something random
452         */
453
454         void DiePlayer(u16 peer_id);
455         void RespawnPlayer(u16 peer_id);
456         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
457         void UpdateCrafting(RemotePlayer *player);
458
459         void handleChatInterfaceEvent(ChatEvent *evt);
460
461         // This returns the answer to the sender of wmessage, or "" if there is none
462         std::wstring handleChat(const std::string &name, const std::wstring &wname,
463                 const std::wstring &wmessage,
464                 bool check_shout_priv = false,
465                 RemotePlayer *player = NULL);
466         void handleAdminChat(const ChatEventChat *evt);
467
468         v3f findSpawnPos();
469
470         // When called, connection mutex should be locked
471         RemoteClient* getClient(u16 peer_id,ClientState state_min=CS_Active);
472         RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=CS_Active);
473
474         // When called, environment mutex should be locked
475         std::string getPlayerName(u16 peer_id);
476         PlayerSAO* getPlayerSAO(u16 peer_id);
477
478         /*
479                 Get a player from memory or creates one.
480                 If player is already connected, return NULL
481                 Does not verify/modify auth info and password.
482
483                 Call with env and con locked.
484         */
485         PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
486
487         void handlePeerChanges();
488
489         /*
490                 Variables
491         */
492
493         // World directory
494         std::string m_path_world;
495         // Subgame specification
496         SubgameSpec m_gamespec;
497         // If true, do not allow multiple players and hide some multiplayer
498         // functionality
499         bool m_simple_singleplayer_mode;
500         u16 m_max_chatmessage_length;
501
502         // Thread can set; step() will throw as ServerError
503         MutexedVariable<std::string> m_async_fatal_error;
504
505         // Some timers
506         float m_liquid_transform_timer;
507         float m_liquid_transform_every;
508         float m_masterserver_timer;
509         float m_emergethread_trigger_timer;
510         float m_savemap_timer;
511         IntervalLimiter m_map_timer_and_unload_interval;
512
513         // Environment
514         ServerEnvironment *m_env;
515
516         // server connection
517         con::Connection m_con;
518
519         // Ban checking
520         BanManager *m_banmanager;
521
522         // Rollback manager (behind m_env_mutex)
523         IRollbackManager *m_rollback;
524         bool m_enable_rollback_recording; // Updated once in a while
525
526         // Emerge manager
527         EmergeManager *m_emerge;
528
529         // Scripting
530         // Envlock and conlock should be locked when using Lua
531         GameScripting *m_script;
532
533         // Item definition manager
534         IWritableItemDefManager *m_itemdef;
535
536         // Node definition manager
537         IWritableNodeDefManager *m_nodedef;
538
539         // Craft definition manager
540         IWritableCraftDefManager *m_craftdef;
541
542         // Event manager
543         EventManager *m_event;
544
545         // Mods
546         std::vector<ModSpec> m_mods;
547
548         /*
549                 Threads
550         */
551
552         // A buffer for time steps
553         // step() increments and AsyncRunStep() run by m_thread reads it.
554         float m_step_dtime;
555         Mutex m_step_dtime_mutex;
556
557         // current server step lag counter
558         float m_lag;
559
560         // The server mainly operates in this thread
561         ServerThread *m_thread;
562
563         /*
564                 Time related stuff
565         */
566
567         // Timer for sending time of day over network
568         float m_time_of_day_send_timer;
569         // Uptime of server in seconds
570         MutexedVariable<double> m_uptime;
571
572         /*
573          Client interface
574          */
575         ClientInterface m_clients;
576
577         /*
578                 Peer change queue.
579                 Queues stuff from peerAdded() and deletingPeer() to
580                 handlePeerChanges()
581         */
582         std::queue<con::PeerChange> m_peer_change_queue;
583
584         /*
585                 Random stuff
586         */
587
588         bool m_shutdown_requested;
589         std::string m_shutdown_msg;
590         bool m_shutdown_ask_reconnect;
591
592         ChatInterface *m_admin_chat;
593         std::string m_admin_nick;
594
595         /*
596                 Map edit event queue. Automatically receives all map edits.
597                 The constructor of this class registers us to receive them through
598                 onMapEditEvent
599
600                 NOTE: Should these be moved to actually be members of
601                 ServerEnvironment?
602         */
603
604         /*
605                 Queue of map edits from the environment for sending to the clients
606                 This is behind m_env_mutex
607         */
608         std::queue<MapEditEvent*> m_unsent_map_edit_queue;
609         /*
610                 Set to true when the server itself is modifying the map and does
611                 all sending of information by itself.
612                 This is behind m_env_mutex
613         */
614         bool m_ignore_map_edit_events;
615         /*
616                 If a non-empty area, map edit events contained within are left
617                 unsent. Done at map generation time to speed up editing of the
618                 generated area, as it will be sent anyway.
619                 This is behind m_env_mutex
620         */
621         VoxelArea m_ignore_map_edit_events_area;
622         /*
623                 If set to !=0, the incoming MapEditEvents are modified to have
624                 this peed id as the disabled recipient
625                 This is behind m_env_mutex
626         */
627         u16 m_ignore_map_edit_events_peer_id;
628
629         // media files known to server
630         UNORDERED_MAP<std::string, MediaInfo> m_media;
631
632         /*
633                 Sounds
634         */
635         UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
636         s32 m_next_sound_id;
637
638         /*
639                 Detached inventories (behind m_env_mutex)
640         */
641         // key = name
642         std::map<std::string, Inventory*> m_detached_inventories;
643
644         DISABLE_CLASS_COPY(Server);
645 };
646
647 /*
648         Runs a simple dedicated server loop.
649
650         Shuts down when kill is set to true.
651 */
652 void dedicated_server_loop(Server &server, bool &kill);
653
654 #endif
655