minetest/src/server.h

603 lines
16 KiB
C
Raw Normal View History

/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
2010-11-27 00:02:21 +01:00
#ifndef SERVER_HEADER
#define SERVER_HEADER
#include "connection.h"
#include "irr_v3d.h"
2011-02-23 01:49:57 +01:00
#include "map.h"
#include "hud.h"
#include "gamedef.h"
#include "serialization.h" // For SER_FMT_VER_INVALID
2011-12-11 15:49:40 +01:00
#include "mods.h"
#include "inventorymanager.h"
2012-03-11 13:54:23 +01:00
#include "subgame.h"
#include "rollback_interface.h" // Needed for rollbackRevertActions()
#include "util/numeric.h"
#include "util/thread.h"
2013-09-06 18:22:12 +02:00
#include "environment.h"
#include "clientiface.h"
#include <string>
#include <list>
#include <map>
#include <vector>
#define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
class IWritableItemDefManager;
2011-11-14 20:41:30 +01:00
class IWritableNodeDefManager;
2011-11-17 01:28:46 +01:00
class IWritableCraftDefManager;
class BanManager;
class EventManager;
class Inventory;
class Player;
class PlayerSAO;
class IRollbackManager;
class EmergeManager;
class GameScripting;
class ServerEnvironment;
struct SimpleSoundSpec;
class ServerThread;
enum ClientDeletionReason {
CDR_LEAVE,
CDR_TIMEOUT,
CDR_DENY
};
2010-11-27 00:02:21 +01:00
/*
Some random functions
*/
v3f findSpawnPos(ServerMap &map);
2013-02-24 04:45:12 +01:00
class MapEditEventIgnorer
2010-11-27 00:02:21 +01:00
{
public:
2013-02-24 04:45:12 +01:00
MapEditEventIgnorer(bool *flag):
m_flag(flag)
2010-11-27 00:02:21 +01:00
{
2013-02-24 04:45:12 +01:00
if(*m_flag == false)
*m_flag = true;
else
m_flag = NULL;
2010-11-27 00:02:21 +01:00
}
2013-02-24 04:45:12 +01:00
~MapEditEventIgnorer()
2010-11-27 00:02:21 +01:00
{
2013-02-24 04:45:12 +01:00
if(m_flag)
2010-11-27 00:02:21 +01:00
{
2013-02-24 04:45:12 +01:00
assert(*m_flag);
*m_flag = false;
2010-11-27 00:02:21 +01:00
}
}
2013-02-24 04:45:12 +01:00
private:
bool *m_flag;
};
2010-11-27 00:02:21 +01:00
2013-02-24 04:45:12 +01:00
class MapEditEventAreaIgnorer
{
public:
MapEditEventAreaIgnorer(VoxelArea *ignorevariable, const VoxelArea &a):
m_ignorevariable(ignorevariable)
2010-11-27 00:02:21 +01:00
{
2013-02-24 04:45:12 +01:00
if(m_ignorevariable->getVolume() == 0)
*m_ignorevariable = a;
else
m_ignorevariable = NULL;
2010-11-27 00:02:21 +01:00
}
2013-02-24 04:45:12 +01:00
~MapEditEventAreaIgnorer()
{
2013-02-24 04:45:12 +01:00
if(m_ignorevariable)
{
2013-02-24 04:45:12 +01:00
assert(m_ignorevariable->getVolume() != 0);
*m_ignorevariable = VoxelArea();
}
}
2010-11-27 00:02:21 +01:00
private:
2013-02-24 04:45:12 +01:00
VoxelArea *m_ignorevariable;
2010-11-27 00:02:21 +01:00
};
2012-03-25 10:50:29 +02:00
struct MediaInfo
{
std::string path;
std::string sha1_digest;
2012-03-25 10:50:29 +02:00
MediaInfo(const std::string path_="",
const std::string sha1_digest_=""):
path(path_),
sha1_digest(sha1_digest_)
{
}
};
2012-03-24 18:01:26 +01:00
struct ServerSoundParams
{
float gain;
std::string to_player;
enum Type{
SSP_LOCAL=0,
SSP_POSITIONAL=1,
SSP_OBJECT=2
} type;
v3f pos;
u16 object;
float max_hear_distance;
bool loop;
ServerSoundParams():
gain(1.0),
to_player(""),
type(SSP_LOCAL),
pos(0,0,0),
object(0),
max_hear_distance(32*BS),
loop(false)
{}
v3f getPos(ServerEnvironment *env, bool *pos_exists) const;
2012-03-24 18:01:26 +01:00
};
struct ServerPlayingSound
{
ServerSoundParams params;
std::set<u16> clients; // peer ids
};
2011-04-04 14:13:19 +02:00
class Server : public con::PeerHandler, public MapEventReceiver,
public InventoryManager, public IGameDef
2010-11-27 00:02:21 +01:00
{
public:
/*
NOTE: Every public method should be thread-safe
*/
2010-11-27 00:02:21 +01:00
Server(
2012-03-11 13:54:23 +01:00
const std::string &path_world,
const SubgameSpec &gamespec,
bool simple_singleplayer_mode
);
2010-11-27 00:02:21 +01:00
~Server();
void start(unsigned short port);
void stop();
// This is mainly a way to pass the time to the server.
// Actual processing is done in an another thread.
2010-11-27 00:02:21 +01:00
void step(float dtime);
// This is run by ServerThread and does the actual processing
void AsyncRunStep(bool initial_step=false);
2010-11-27 00:02:21 +01:00
void Receive();
void ProcessData(u8 *data, u32 datasize, u16 peer_id);
// Environment must be locked when called
void setTimeOfDay(u32 time);
2011-02-23 01:49:57 +01:00
/*
Shall be called with the environment locked.
This is accessed by the map, which is inside the environment,
so it shouldn't be a problem.
*/
void onMapEditEvent(MapEditEvent *event);
2011-04-04 14:13:19 +02:00
/*
Shall be called with the environment and the connection locked.
*/
Inventory* getInventory(const InventoryLocation &loc);
void setInventoryModified(const InventoryLocation &loc);
2011-04-04 14:13:19 +02:00
// Connection must be locked when called
std::wstring getStatusString();
// read shutdown state
inline bool getShutdownRequested()
{ return m_shutdown_requested; }
// request server to shutdown
inline void requestShutdown(void)
{ m_shutdown_requested = true; }
2012-03-24 18:01:26 +01:00
// Returns -1 if failed, sound handle on success
// Envlock
2012-03-24 18:01:26 +01:00
s32 playSound(const SimpleSoundSpec &spec, const ServerSoundParams &params);
void stopSound(s32 handle);
// Envlock
std::set<std::string> getPlayerEffectivePrivs(const std::string &name);
bool checkPriv(const std::string &name, const std::string &priv);
void reportPrivsModified(const std::string &name=""); // ""=all
void reportInventoryFormspecModified(const std::string &name);
void setIpBanned(const std::string &ip, const std::string &name);
void unsetIpBanned(const std::string &ip_or_name);
std::string getBanDescription(const std::string &ip_or_name);
void notifyPlayer(const char *name, const std::wstring msg, const bool prepend);
2011-10-17 23:01:50 +02:00
void notifyPlayers(const std::wstring msg);
void spawnParticle(const char *playername,
v3f pos, v3f velocity, v3f acceleration,
float expirationtime, float size,
bool collisiondetection, bool vertical, std::string texture);
void spawnParticleAll(v3f pos, v3f velocity, v3f acceleration,
float expirationtime, float size,
bool collisiondetection, bool vertical, std::string texture);
u32 addParticleSpawner(const char *playername,
u16 amount, float spawntime,
v3f minpos, v3f maxpos,
v3f minvel, v3f maxvel,
v3f minacc, v3f maxacc,
float minexptime, float maxexptime,
float minsize, float maxsize,
bool collisiondetection, bool vertical, std::string texture);
u32 addParticleSpawnerAll(u16 amount, float spawntime,
v3f minpos, v3f maxpos,
v3f minvel, v3f maxvel,
v3f minacc, v3f maxacc,
float minexptime, float maxexptime,
float minsize, float maxsize,
bool collisiondetection, bool vertical, std::string texture);
void deleteParticleSpawner(const char *playername, u32 id);
void deleteParticleSpawnerAll(u32 id);
2012-07-24 19:57:17 +02:00
// Creates or resets inventory
Inventory* createDetachedInventory(const std::string &name);
// Envlock and conlock should be locked when using scriptapi
GameScripting *getScriptIface(){ return m_script; }
// Envlock should be locked when using the rollback manager
IRollbackManager *getRollbackManager(){ return m_rollback; }
2013-04-06 17:19:59 +02:00
//TODO: determine what (if anything) should be locked to access EmergeManager
EmergeManager *getEmergeManager(){ return m_emerge; }
// actions: time-reversed list
// Return value: success/failure
bool rollbackRevertActions(const std::list<RollbackAction> &actions,
std::list<std::string> *log);
// IGameDef interface
// Under envlock
virtual IItemDefManager* getItemDefManager();
2011-11-14 20:41:30 +01:00
virtual INodeDefManager* getNodeDefManager();
2011-11-17 01:28:46 +01:00
virtual ICraftDefManager* getCraftDefManager();
2011-11-14 20:41:30 +01:00
virtual ITextureSource* getTextureSource();
2012-03-19 02:59:12 +01:00
virtual IShaderSource* getShaderSource();
2011-11-16 12:03:28 +01:00
virtual u16 allocateUnknownNodeId(const std::string &name);
virtual ISoundManager* getSoundManager();
virtual MtEventManager* getEventManager();
virtual IRollbackReportSink* getRollbackReportSink();
IWritableItemDefManager* getWritableItemDefManager();
2011-11-15 01:03:28 +01:00
IWritableNodeDefManager* getWritableNodeDefManager();
2011-11-17 01:28:46 +01:00
IWritableCraftDefManager* getWritableCraftDefManager();
2011-12-11 15:49:40 +01:00
const ModSpec* getModSpec(const std::string &modname);
2012-12-20 18:19:49 +01:00
void getModNames(std::list<std::string> &modlist);
std::string getBuiltinLuaPath();
inline std::string getWorldPath()
{ return m_path_world; }
inline bool isSingleplayer()
{ return m_simple_singleplayer_mode; }
2012-03-28 12:22:48 +02:00
inline void setAsyncFatalError(const std::string &error)
{ m_async_fatal_error.set(error); }
bool showFormspec(const char *name, const std::string &formspec, const std::string &formname);
Map & getMap() { return m_env->getMap(); }
ServerEnvironment & getEnv() { return *m_env; }
u32 hudAdd(Player *player, HudElement *element);
bool hudRemove(Player *player, u32 id);
bool hudChange(Player *player, u32 id, HudElementStat stat, void *value);
bool hudSetFlags(Player *player, u32 flags, u32 mask);
bool hudSetHotbarItemcount(Player *player, s32 hotbar_itemcount);
void hudSetHotbarImage(Player *player, std::string name);
void hudSetHotbarSelectedImage(Player *player, std::string name);
inline Address getPeerAddress(u16 peer_id)
{ return m_con.GetPeerAddress(peer_id); }
2010-11-27 00:02:21 +01:00
/* con::PeerHandler implementation. */
2010-11-27 00:02:21 +01:00
void peerAdded(con::Peer *peer);
void deletingPeer(con::Peer *peer, bool timeout);
private:
friend class EmergeThread;
friend class RemoteClient;
void SendMovement(u16 peer_id);
void SendHP(u16 peer_id, u8 hp);
void SendBreath(u16 peer_id, u16 breath);
void SendAccessDenied(u16 peer_id,const std::wstring &reason);
void SendDeathscreen(u16 peer_id,bool set_camera_point_target, v3f camera_point_target);
void SendItemDef(u16 peer_id,IItemDefManager *itemdef, u16 protocol_version);
void SendNodeDef(u16 peer_id,INodeDefManager *nodedef, u16 protocol_version);
/* mark blocks not sent for all clients */
void SetBlocksNotSent(std::map<v3s16, MapBlock *>& block);
2010-11-27 00:02:21 +01:00
// Envlock and conlock should be locked when calling these
void SendInventory(u16 peer_id);
void SendChatMessage(u16 peer_id, const std::wstring &message);
void SendTimeOfDay(u16 peer_id, u16 time, f32 time_speed);
void SendPlayerHP(u16 peer_id);
void SendPlayerBreath(u16 peer_id);
void SendMovePlayer(u16 peer_id);
void SendPlayerPrivileges(u16 peer_id);
void SendPlayerInventoryFormspec(u16 peer_id);
void SendShowFormspecMessage(u16 peer_id, const std::string formspec, const std::string formname);
void SendHUDAdd(u16 peer_id, u32 id, HudElement *form);
void SendHUDRemove(u16 peer_id, u32 id);
void SendHUDChange(u16 peer_id, u32 id, HudElementStat stat, void *value);
void SendHUDSetFlags(u16 peer_id, u32 flags, u32 mask);
void SendHUDSetParam(u16 peer_id, u16 param, const std::string &value);
/*
Send a node removal/addition event to all clients except ignore_id.
Additionally, if far_players!=NULL, players further away than
far_d_nodes are ignored and their peer_ids are added to far_players
*/
// Envlock and conlock should be locked when calling these
void sendRemoveNode(v3s16 p, u16 ignore_id=0,
2012-12-20 18:19:49 +01:00
std::list<u16> *far_players=NULL, float far_d_nodes=100);
void sendAddNode(v3s16 p, MapNode n, u16 ignore_id=0,
2013-11-23 15:35:49 +01:00
std::list<u16> *far_players=NULL, float far_d_nodes=100,
bool remove_metadata=true);
void setBlockNotSent(v3s16 p);
// Environment and Connection must be locked when called
2013-08-01 22:51:36 +02:00
void SendBlockNoLock(u16 peer_id, MapBlock *block, u8 ver, u16 net_proto_version);
// Sends blocks to clients (locks env and con on its own)
2010-11-27 00:02:21 +01:00
void SendBlocks(float dtime);
2012-03-25 10:50:29 +02:00
void fillMediaCache();
void sendMediaAnnouncement(u16 peer_id);
void sendRequestedMedia(u16 peer_id,
Rewrite client media download and support hash-based remote download Move most of the media-related code in client.cpp into a new class ClientMediaDownloader (clientmedia.cpp, clientmedia.h). Among other things, this class does the following things: - Download [remote_server][sha1] instead of [remote_server][name]. This is to support servers that provide the same file name with different contents. - Initially fetch [remote_server]index.mth. This file should follow the Minetest Hashset format (currently version 1) and contain a list of SHA1 hashes that exist on the server. - The list of needed SHA1s is uploaded (via HTTP POST) when index.mth is requested, so servers can optionally narrow down the list to the needs of the client. - If index.mth is missing (HTTP response code 404), we enter compat mode, fetching [remote_server][name] as before this commit. - remote_server can now contain multiple servers, separated by commas. The downloader code attempts to split requests between the different servers, as permitted by each server's index.mth. If one server claims to have a file but actually doesn't (or something fails), we ask a different server that also claims to have it. - As before, when none of the remote servers provide a particular file, we download it via the conventional method, i.e. using the minetest protocol: TOSERVER_REQUEST_MEDIA / TOCLIENT_MEDIA. - Bugfix: Every downloaded file's SHA1 is now verified against the SHA1 announced by the minetest server (before loading it and inserting it into the file cache). - Bugfix: Only send TOSERVER_RECEIVED_MEDIA when we actually have all media. This should fix #863.
2013-08-29 05:22:18 +02:00
const std::list<std::string> &tosend);
2012-07-24 19:57:17 +02:00
void sendDetachedInventory(const std::string &name, u16 peer_id);
void sendDetachedInventories(u16 peer_id);
// Adds a ParticleSpawner on peer with peer_id (PEER_ID_INEXISTENT == all)
void SendAddParticleSpawner(u16 peer_id, u16 amount, float spawntime,
v3f minpos, v3f maxpos,
v3f minvel, v3f maxvel,
v3f minacc, v3f maxacc,
float minexptime, float maxexptime,
float minsize, float maxsize,
bool collisiondetection, bool vertical, std::string texture, u32 id);
void SendDeleteParticleSpawner(u16 peer_id, u32 id);
// Spawns particle on peer with peer_id (PEER_ID_INEXISTENT == all)
void SendSpawnParticle(u16 peer_id,
v3f pos, v3f velocity, v3f acceleration,
float expirationtime, float size,
bool collisiondetection, bool vertical, std::string texture);
/*
Something random
*/
void DiePlayer(u16 peer_id);
void RespawnPlayer(u16 peer_id);
void DenyAccess(u16 peer_id, const std::wstring &reason);
void DeleteClient(u16 peer_id, ClientDeletionReason reason);
void UpdateCrafting(u16 peer_id);
2010-11-27 00:02:21 +01:00
// When called, connection mutex should be locked
RemoteClient* getClient(u16 peer_id,ClientState state_min=Active);
RemoteClient* getClientNoEx(u16 peer_id,ClientState state_min=Active);
// When called, environment mutex should be locked
std::string getPlayerName(u16 peer_id);
PlayerSAO* getPlayerSAO(u16 peer_id);
/*
Get a player from memory or creates one.
If player is already connected, return NULL
Does not verify/modify auth info and password.
Call with env and con locked.
*/
PlayerSAO *emergePlayer(const char *name, u16 peer_id);
void handlePeerChanges();
/*
Variables
*/
2012-03-10 14:56:24 +01:00
// World directory
std::string m_path_world;
2012-03-11 13:54:23 +01:00
// Subgame specification
SubgameSpec m_gamespec;
// If true, do not allow multiple players and hide some multiplayer
// functionality
bool m_simple_singleplayer_mode;
2012-03-10 14:56:24 +01:00
// Thread can set; step() will throw as ServerError
MutexedVariable<std::string> m_async_fatal_error;
// Some timers
float m_liquid_transform_timer;
2013-02-24 15:39:07 +01:00
float m_liquid_transform_every;
2010-12-19 15:51:45 +01:00
float m_print_info_timer;
2013-02-21 23:00:44 +01:00
float m_masterserver_timer;
2010-12-19 15:51:45 +01:00
float m_objectdata_timer;
float m_emergethread_trigger_timer;
float m_savemap_timer;
IntervalLimiter m_map_timer_and_unload_interval;
// Environment
2011-11-11 18:33:17 +01:00
ServerEnvironment *m_env;
JMutex m_env_mutex;
// server connection
2010-11-27 00:02:21 +01:00
con::Connection m_con;
// Ban checking
BanManager *m_banmanager;
2011-11-11 18:33:17 +01:00
// Rollback manager (behind m_env_mutex)
IRollbackManager *m_rollback;
bool m_rollback_sink_enabled;
bool m_enable_rollback_recording; // Updated once in a while
// Emerge manager
EmergeManager *m_emerge;
2011-11-11 18:33:17 +01:00
// Scripting
// Envlock and conlock should be locked when using Lua
GameScripting *m_script;
// Item definition manager
IWritableItemDefManager *m_itemdef;
2011-11-14 20:41:30 +01:00
// Node definition manager
IWritableNodeDefManager *m_nodedef;
2011-11-17 01:28:46 +01:00
// Craft definition manager
IWritableCraftDefManager *m_craftdef;
// Event manager
EventManager *m_event;
2011-12-11 15:49:40 +01:00
// Mods
Basic support for configuring which mods to load for each world settings.h: added function to return all keys used in settings, and a function to remove a setting mods.{h,cpp}: added class ModConfiguration that represents a subset of the installed mods. server.{h,cpp}: server does not load add-on mods that are disabled in the world.mt file. mods are disabled by a setting of the form "load_mod_<modname> = false". if no load_mod_<modname> = ... setting is found, the mod is loaded anyways for backwards compatibilty. server also complains to errorstream about mods with unstatisfied dependencies and about mods that are not installed. guiConfigureWorld.{h,cpp}: shows a treeview of installed add-on mods and modpacks with little icons in front of their name indicating their status: a checkmark for enabled mods, a cross for disabled mods, a question mark for "new" mods Mods can be enabled/disabled by a checkbox. Mods also show a list of dependencies and reverse dependencies. double-click on a mod in dependency or reverse dependency listbox selects the corresponding mod. Enabling a mod also enables all its dependencies. Disabling a mod also disables all its reverse dependencies. For modpacks, show buttons to enable/disable all mods (recursively, including their dependencies) in it. Button "Save" saves the current settings to the world.mt file and returns to the main menu. Button "Cancel" returns to main menu without saving. basic keyboard controls (if the proper widget has keyboard focus): up/down: scroll through tree of mods left/right: collaps/expand a modpack space: enable/disable the selected mod
2012-12-08 18:10:54 +01:00
std::vector<ModSpec> m_mods;
/*
Threads
*/
// A buffer for time steps
// step() increments and AsyncRunStep() run by m_thread reads it.
2010-11-27 00:02:21 +01:00
float m_step_dtime;
JMutex m_step_dtime_mutex;
// current server step lag counter
float m_lag;
// The server mainly operates in this thread
ServerThread *m_thread;
/*
Time related stuff
*/
// Timer for sending time of day over network
float m_time_of_day_send_timer;
// Uptime of server in seconds
MutexedVariable<double> m_uptime;
/*
Client interface
*/
ClientInterface m_clients;
/*
Peer change queue.
Queues stuff from peerAdded() and deletingPeer() to
handlePeerChanges()
*/
Queue<con::PeerChange> m_peer_change_queue;
/*
Random stuff
*/
2011-11-15 10:02:47 +01:00
// Mod parent directory paths
2012-12-20 18:19:49 +01:00
std::list<std::string> m_modspaths;
bool m_shutdown_requested;
/*
Map edit event queue. Automatically receives all map edits.
The constructor of this class registers us to receive them through
onMapEditEvent
NOTE: Should these be moved to actually be members of
ServerEnvironment?
*/
2011-02-23 01:49:57 +01:00
/*
Queue of map edits from the environment for sending to the clients
This is behind m_env_mutex
*/
Queue<MapEditEvent*> m_unsent_map_edit_queue;
/*
Set to true when the server itself is modifying the map and does
all sending of information by itself.
This is behind m_env_mutex
*/
bool m_ignore_map_edit_events;
/*
If a non-empty area, map edit events contained within are left
unsent. Done at map generation time to speed up editing of the
generated area, as it will be sent anyway.
This is behind m_env_mutex
*/
VoxelArea m_ignore_map_edit_events_area;
2011-02-23 01:49:57 +01:00
/*
If set to !=0, the incoming MapEditEvents are modified to have
this peed id as the disabled recipient
This is behind m_env_mutex
*/
u16 m_ignore_map_edit_events_peer_id;
// media files known to server
2012-03-25 10:50:29 +02:00
std::map<std::string,MediaInfo> m_media;
2012-03-24 18:01:26 +01:00
/*
Sounds
*/
std::map<s32, ServerPlayingSound> m_playing_sounds;
s32 m_next_sound_id;
2012-07-24 19:57:17 +02:00
/*
Detached inventories (behind m_env_mutex)
*/
// key = name
std::map<std::string, Inventory*> m_detached_inventories;
/*
Particles
*/
std::vector<u32> m_particlespawner_ids;
2010-11-27 00:02:21 +01:00
};
2011-01-23 16:29:15 +01:00
/*
Runs a simple dedicated server loop.
Shuts down when run is set to false.
2011-01-23 16:29:15 +01:00
*/
void dedicated_server_loop(Server &server, bool &run);
2011-01-23 16:29:15 +01:00
2010-11-27 00:02:21 +01:00
#endif