Add control information to player interacts (#4685)
[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         // Helper for handleCommand_PlayerPos and handleCommand_Interact
201         void process_PlayerPos(RemotePlayer *player, PlayerSAO *playersao,
202                 NetworkPacket *pkt);
203
204         // Both setter and getter need no envlock,
205         // can be called freely from threads
206         void setTimeOfDay(u32 time);
207
208         /*
209                 Shall be called with the environment locked.
210                 This is accessed by the map, which is inside the environment,
211                 so it shouldn't be a problem.
212         */
213         void onMapEditEvent(MapEditEvent *event);
214
215         /*
216                 Shall be called with the environment and the connection locked.
217         */
218         Inventory* getInventory(const InventoryLocation &loc);
219         void setInventoryModified(const InventoryLocation &loc, bool playerSend = true);
220
221         // Connection must be locked when called
222         std::wstring getStatusString();
223         inline double getUptime() const { return m_uptime.m_value; }
224
225         // read shutdown state
226         inline bool getShutdownRequested() const { return m_shutdown_requested; }
227
228         // request server to shutdown
229         void requestShutdown(const std::string &msg, bool reconnect)
230         {
231                 m_shutdown_requested = true;
232                 m_shutdown_msg = msg;
233                 m_shutdown_ask_reconnect = reconnect;
234         }
235
236         // Returns -1 if failed, sound handle on success
237         // Envlock
238         s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
239         void stopSound(s32 handle);
240
241         // Envlock
242         std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
243         bool checkPriv(const std::string &name, const std::string &priv);
244         void reportPrivsModified(const std::string &name=""); // ""=all
245         void reportInventoryFormspecModified(const std::string &name);
246
247         void setIpBanned(const std::string &ip, const std::string &name);
248         void unsetIpBanned(const std::string &ip_or_name);
249         std::string getBanDescription(const std::string &ip_or_name);
250
251         void notifyPlayer(const char *name, const std::wstring &msg);
252         void notifyPlayers(const std::wstring &msg);
253         void spawnParticle(const std::string &playername,
254                 v3f pos, v3f velocity, v3f acceleration,
255                 float expirationtime, float size,
256                 bool collisiondetection, bool collision_removal,
257                 bool vertical, const std::string &texture);
258
259         u32 addParticleSpawner(u16 amount, float spawntime,
260                 v3f minpos, v3f maxpos,
261                 v3f minvel, v3f maxvel,
262                 v3f minacc, v3f maxacc,
263                 float minexptime, float maxexptime,
264                 float minsize, float maxsize,
265                 bool collisiondetection, bool collision_removal,
266                 ServerActiveObject *attached,
267                 bool vertical, const std::string &texture,
268                 const std::string &playername);
269
270         void deleteParticleSpawner(const std::string &playername, u32 id);
271
272         // Creates or resets inventory
273         Inventory* createDetachedInventory(const std::string &name);
274
275         // Envlock and conlock should be locked when using scriptapi
276         GameScripting *getScriptIface(){ return m_script; }
277
278         // actions: time-reversed list
279         // Return value: success/failure
280         bool rollbackRevertActions(const std::list<RollbackAction> &actions,
281                         std::list<std::string> *log);
282
283         // IGameDef interface
284         // Under envlock
285         virtual IItemDefManager* getItemDefManager();
286         virtual INodeDefManager* getNodeDefManager();
287         virtual ICraftDefManager* getCraftDefManager();
288         virtual ITextureSource* getTextureSource();
289         virtual IShaderSource* getShaderSource();
290         virtual u16 allocateUnknownNodeId(const std::string &name);
291         virtual ISoundManager* getSoundManager();
292         virtual MtEventManager* getEventManager();
293         virtual scene::ISceneManager* getSceneManager();
294         virtual IRollbackManager *getRollbackManager() { return m_rollback; }
295         virtual EmergeManager *getEmergeManager() { return m_emerge; }
296
297         IWritableItemDefManager* getWritableItemDefManager();
298         IWritableNodeDefManager* getWritableNodeDefManager();
299         IWritableCraftDefManager* getWritableCraftDefManager();
300
301         const ModSpec* getModSpec(const std::string &modname) const;
302         void getModNames(std::vector<std::string> &modlist);
303         std::string getBuiltinLuaPath();
304         inline std::string getWorldPath() const { return m_path_world; }
305
306         inline bool isSingleplayer()
307                         { return m_simple_singleplayer_mode; }
308
309         inline void setAsyncFatalError(const std::string &error)
310                         { m_async_fatal_error.set(error); }
311
312         bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
313         Map & getMap() { return m_env->getMap(); }
314         ServerEnvironment & getEnv() { return *m_env; }
315
316         u32 hudAdd(RemotePlayer *player, HudElement *element);
317         bool hudRemove(RemotePlayer *player, u32 id);
318         bool hudChange(RemotePlayer *player, u32 id, HudElementStat stat, void *value);
319         bool hudSetFlags(RemotePlayer *player, u32 flags, u32 mask);
320         bool hudSetHotbarItemcount(RemotePlayer *player, s32 hotbar_itemcount);
321         s32 hudGetHotbarItemcount(RemotePlayer *player) const
322                         { return player->getHotbarItemcount(); }
323         void hudSetHotbarImage(RemotePlayer *player, std::string name);
324         std::string hudGetHotbarImage(RemotePlayer *player);
325         void hudSetHotbarSelectedImage(RemotePlayer *player, std::string name);
326         const std::string &hudGetHotbarSelectedImage(RemotePlayer *player) const
327         {
328                 return player->getHotbarSelectedImage();
329         }
330
331         inline Address getPeerAddress(u16 peer_id)
332                         { return m_con.GetPeerAddress(peer_id); }
333
334         bool setLocalPlayerAnimations(RemotePlayer *player, v2s32 animation_frames[4],
335                         f32 frame_speed);
336         bool setPlayerEyeOffset(RemotePlayer *player, v3f first, v3f third);
337
338         bool setSky(RemotePlayer *player, const video::SColor &bgcolor,
339                         const std::string &type, const std::vector<std::string> &params);
340
341         bool overrideDayNightRatio(RemotePlayer *player, bool do_override, float brightness);
342
343         /* con::PeerHandler implementation. */
344         void peerAdded(con::Peer *peer);
345         void deletingPeer(con::Peer *peer, bool timeout);
346
347         void DenySudoAccess(u16 peer_id);
348         void DenyAccessVerCompliant(u16 peer_id, u16 proto_ver, AccessDeniedCode reason,
349                 const std::string &str_reason = "", bool reconnect = false);
350         void DenyAccess(u16 peer_id, AccessDeniedCode reason, const std::string &custom_reason="");
351         void acceptAuth(u16 peer_id, bool forSudoMode);
352         void DenyAccess_Legacy(u16 peer_id, const std::wstring &reason);
353         bool getClientConInfo(u16 peer_id, con::rtt_stat_type type,float* retval);
354         bool getClientInfo(u16 peer_id,ClientState* state, u32* uptime,
355                         u8* ser_vers, u16* prot_vers, u8* major, u8* minor, u8* patch,
356                         std::string* vers_string);
357
358         void printToConsoleOnly(const std::string &text);
359
360         void SendPlayerHPOrDie(PlayerSAO *player);
361         void SendPlayerBreath(u16 peer_id);
362         void SendInventory(PlayerSAO* playerSAO);
363         void SendMovePlayer(u16 peer_id);
364
365         // Bind address
366         Address m_bind_addr;
367
368         // Environment mutex (envlock)
369         Mutex m_env_mutex;
370
371 private:
372
373         friend class EmergeThread;
374         friend class RemoteClient;
375
376         void SendMovement(u16 peer_id);
377         void SendHP(u16 peer_id, u8 hp);
378         void SendBreath(u16 peer_id, u16 breath);
379         void SendAccessDenied(u16 peer_id, AccessDeniedCode reason,
380                 const std::string &custom_reason, bool reconnect = false);
381         void SendAccessDenied_Legacy(u16 peer_id, const std::wstring &reason);
382         void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
383         void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
384         void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
385
386         /* mark blocks not sent for all clients */
387         void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
388
389
390         void SendChatMessage(u16 peer_id, const std::wstring &message);
391         void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
392         void SendPlayerHP(u16 peer_id);
393
394         void SendLocalPlayerAnimations(u16 peer_id, v2s32 animation_frames[4], f32 animation_speed);
395         void SendEyeOffset(u16 peer_id, v3f first, v3f third);
396         void SendPlayerPrivileges(u16 peer_id);
397         void SendPlayerInventoryFormspec(u16 peer_id);
398         void SendShowFormspecMessage(u16 peer_id, const std::string &formspec, const std::string &formname);
399         void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
400         void SendHUDRemove(u16 peer_id, u32 id);
401         void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
402         void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
403         void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
404         void SendSetSky(u16 peer_id, const video::SColor &bgcolor,
405                         const std::string &type, const std::vector<std::string> &params);
406         void SendOverrideDayNightRatio(u16 peer_id, bool do_override, float ratio);
407
408         /*
409                 Send a node removal/addition event to all clients except ignore_id.
410                 Additionally, if far_players!=NULL, players further away than
411                 far_d_nodes are ignored and their peer_ids are added to far_players
412         */
413         // Envlock and conlock should be locked when calling these
414         void sendRemoveNode(v3s16 p, u16 ignore_id=0,
415                         std::vector<u16> *far_players=NULL, float far_d_nodes=100);
416         void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
417                         std::vector<u16> *far_players=NULL, float far_d_nodes=100,
418                         bool remove_metadata=true);
419         void setBlockNotSent(v3s16 p);
420
421         // Environment and Connection must be locked when called
422         void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
423
424         // Sends blocks to clients (locks env and con on its own)
425         void SendBlocks(float dtime);
426
427         void fillMediaCache();
428         void sendMediaAnnouncement(u16 peer_id);
429         void sendRequestedMedia(u16 peer_id,
430                         const std::vector<std::string> &tosend);
431
432         void sendDetachedInventory(const std::string &name, u16 peer_id);
433         void sendDetachedInventories(u16 peer_id);
434
435         // Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
436         void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
437                 v3f minpos, v3f maxpos,
438                 v3f minvel, v3f maxvel,
439                 v3f minacc, v3f maxacc,
440                 float minexptime, float maxexptime,
441                 float minsize, float maxsize,
442                 bool collisiondetection, bool collision_removal,
443                 u16 attached_id,
444                 bool vertical, const std::string &texture, u32 id);
445
446         void SendDeleteParticleSpawner(u16 peer_id, u32 id);
447
448         // Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
449         void SendSpawnParticle(u16 peer_id,
450                 v3f pos, v3f velocity, v3f acceleration,
451                 float expirationtime, float size,
452                 bool collisiondetection, bool collision_removal,
453                 bool vertical, const std::string &texture);
454
455         u32 SendActiveObjectRemoveAdd(u16 peer_id, const std::string &datas);
456         void SendActiveObjectMessages(u16 peer_id, const std::string &datas, bool reliable = true);
457         /*
458                 Something random
459         */
460
461         void DiePlayer(u16 peer_id);
462         void RespawnPlayer(u16 peer_id);
463         void DeleteClient(u16 peer_id, ClientDeletionReason reason);
464         void UpdateCrafting(RemotePlayer *player);
465
466         void handleChatInterfaceEvent(ChatEvent *evt);
467
468         // This returns the answer to the sender of wmessage, or "" if there is none
469         std::wstring handleChat(const std::string &name, const std::wstring &wname,
470                 const std::wstring &wmessage,
471                 bool check_shout_priv = false,
472                 RemotePlayer *player = NULL);
473         void handleAdminChat(const ChatEventChat *evt);
474
475         v3f findSpawnPos();
476
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);
480
481         // When called, environment mutex should be locked
482         std::string getPlayerName(u16 peer_id);
483         PlayerSAO* getPlayerSAO(u16 peer_id);
484
485         /*
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.
489
490                 Call with env and con locked.
491         */
492         PlayerSAO *emergePlayer(const char *name, u16 peer_id, u16 proto_version);
493
494         void handlePeerChanges();
495
496         /*
497                 Variables
498         */
499
500         // World directory
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
505         // functionality
506         bool m_simple_singleplayer_mode;
507         u16 m_max_chatmessage_length;
508
509         // Thread can set; step() will throw as ServerError
510         MutexedVariable<std::string> m_async_fatal_error;
511
512         // Some timers
513         float m_liquid_transform_timer;
514         float m_liquid_transform_every;
515         float m_masterserver_timer;
516         float m_emergethread_trigger_timer;
517         float m_savemap_timer;
518         IntervalLimiter m_map_timer_and_unload_interval;
519
520         // Environment
521         ServerEnvironment *m_env;
522
523         // server connection
524         con::Connection m_con;
525
526         // Ban checking
527         BanManager *m_banmanager;
528
529         // Rollback manager (behind m_env_mutex)
530         IRollbackManager *m_rollback;
531         bool m_enable_rollback_recording; // Updated once in a while
532
533         // Emerge manager
534         EmergeManager *m_emerge;
535
536         // Scripting
537         // Envlock and conlock should be locked when using Lua
538         GameScripting *m_script;
539
540         // Item definition manager
541         IWritableItemDefManager *m_itemdef;
542
543         // Node definition manager
544         IWritableNodeDefManager *m_nodedef;
545
546         // Craft definition manager
547         IWritableCraftDefManager *m_craftdef;
548
549         // Event manager
550         EventManager *m_event;
551
552         // Mods
553         std::vector<ModSpec> m_mods;
554
555         /*
556                 Threads
557         */
558
559         // A buffer for time steps
560         // step() increments and AsyncRunStep() run by m_thread reads it.
561         float m_step_dtime;
562         Mutex m_step_dtime_mutex;
563
564         // current server step lag counter
565         float m_lag;
566
567         // The server mainly operates in this thread
568         ServerThread *m_thread;
569
570         /*
571                 Time related stuff
572         */
573
574         // Timer for sending time of day over network
575         float m_time_of_day_send_timer;
576         // Uptime of server in seconds
577         MutexedVariable<double> m_uptime;
578
579         /*
580          Client interface
581          */
582         ClientInterface m_clients;
583
584         /*
585                 Peer change queue.
586                 Queues stuff from peerAdded() and deletingPeer() to
587                 handlePeerChanges()
588         */
589         std::queue<con::PeerChange> m_peer_change_queue;
590
591         /*
592                 Random stuff
593         */
594
595         bool m_shutdown_requested;
596         std::string m_shutdown_msg;
597         bool m_shutdown_ask_reconnect;
598
599         ChatInterface *m_admin_chat;
600         std::string m_admin_nick;
601
602         /*
603                 Map edit event queue. Automatically receives all map edits.
604                 The constructor of this class registers us to receive them through
605                 onMapEditEvent
606
607                 NOTE: Should these be moved to actually be members of
608                 ServerEnvironment?
609         */
610
611         /*
612                 Queue of map edits from the environment for sending to the clients
613                 This is behind m_env_mutex
614         */
615         std::queue<MapEditEvent*> m_unsent_map_edit_queue;
616         /*
617                 Set to true when the server itself is modifying the map and does
618                 all sending of information by itself.
619                 This is behind m_env_mutex
620         */
621         bool m_ignore_map_edit_events;
622         /*
623                 If a non-empty area, map edit events contained within are left
624                 unsent. Done at map generation time to speed up editing of the
625                 generated area, as it will be sent anyway.
626                 This is behind m_env_mutex
627         */
628         VoxelArea m_ignore_map_edit_events_area;
629         /*
630                 If set to !=0, the incoming MapEditEvents are modified to have
631                 this peed id as the disabled recipient
632                 This is behind m_env_mutex
633         */
634         u16 m_ignore_map_edit_events_peer_id;
635
636         // media files known to server
637         UNORDERED_MAP<std::string, MediaInfo> m_media;
638
639         /*
640                 Sounds
641         */
642         UNORDERED_MAP<s32, ServerPlayingSound> m_playing_sounds;
643         s32 m_next_sound_id;
644
645         /*
646                 Detached inventories (behind m_env_mutex)
647         */
648         // key = name
649         std::map<std::string, Inventory*> m_detached_inventories;
650
651         DISABLE_CLASS_COPY(Server);
652 };
653
654 /*
655         Runs a simple dedicated server loop.
656
657         Shuts down when kill is set to true.
658 */
659 void dedicated_server_loop(Server &server, bool &kill);
660
661 #endif
662