summaryrefslogtreecommitdiff
path: root/src/script/lua_api/l_mainmenu.h
blob: 781185425196b7f9931f0c4d3f46a10d2de739e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
Minetest
Copyright (C) 2013 sapier

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.
*/

#pragma once

#include "lua_api/l_base.h"

class AsyncEngine;

/** Implementation of lua api support for mainmenu */
class ModApiMainMenu: public ModApiBase
{

private:
	/**
	 * read a text variable from gamedata table within lua stack
	 * @param L stack to read variable from
	 * @param name name of variable to read
	 * @return string value of requested variable
	 */
	static std::string getTextData(lua_State *L, std::string name);

	/**
	 * read a integer variable from gamedata table within lua stack
	 * @param L stack to read variable from
	 * @param name name of variable to read
	 * @return integer value of requested variable
	 */
	static int getIntegerData(lua_State *L, std::string name,bool& valid);

	/**
	 * read a bool variable from gamedata table within lua stack
	 * @param L stack to read variable from
	 * @param name name of variable to read
	 * @return bool value of requested variable
	 */
	static int getBoolData(lua_State *L, std::string name,bool& valid);

	/**
	 * Checks if a path may be modified. Paths in the temp directory or the user
	 * games, mods, textures, or worlds directories may be modified.
	 * @param path path to check
	 * @return true if the path may be modified
	 */
	static bool mayModifyPath(std::string path);

	//api calls

	static int l_start(lua_State *L);

	static int l_close(lua_State *L);

	static int l_create_world(lua_State *L);

	static int l_delete_world(lua_State *L);

	static int l_get_worlds(lua_State *L);

	static int l_get_mapgen_names(lua_State *L);

	static int l_gettext(lua_State *L);

	//packages

	static int l_get_games(lua_State *L);

	static int l_get_content_info(lua_State *L);

	//gui

	static int l_show_keys_menu(lua_State *L);

	static int l_show_path_select_dialog(lua_State *L);

	static int l_set_topleft_text(lua_State *L);

	static int l_set_clouds(lua_State *L);

	static int l_get_textlist_index(lua_State *L);

	static int l_get_table_index(lua_State *L);

	static int l_set_background(lua_State *L);

	static int l_update_formspec(lua_State *L);

	static int l_set_formspec_prepend(lua_State *L);

	static int l_get_screen_info(lua_State *L);

	//filesystem

	static int l_get_mainmenu_path(lua_State *L);

	static int l_get_user_path(lua_State *L);

	static int l_get_modpath(lua_State *L);

	static int l_get_modpaths(lua_State *L);

	static int l_get_clientmodpath(lua_State *L);

	static int l_get_gamepath(lua_State *L);

	static int l_get_texturepath(lua_State *L);

	static int l_get_texturepath_share(lua_State *L);

	static int l_get_cache_path(lua_State *L);

	static int l_get_temp_path(lua_State *L);

	static int l_create_dir(lua_State *L);

	static int l_delete_dir(lua_State *L);

	static int l_copy_dir(lua_State *L);

	static int l_is_dir(lua_State *L);

	static int l_extract_zip(lua_State *L);

	static int l_may_modify_path(lua_State *L);

	static int l_download_file(lua_State *L);

	static int l_get_video_drivers(lua_State *L);

	//version compatibility
	static int l_get_min_supp_proto(lua_State *L);

	static int l_get_max_supp_proto(lua_State *L);

	// other
	static int l_open_url(lua_State *L);

	static int l_open_dir(lua_State *L);


	// async
	static int l_do_async_callback(lua_State *L);

public:

	/**
	 * initialize this API module
	 * @param L lua stack to initialize
	 * @param top index (in lua stack) of global API table
	 */
	static void Initialize(lua_State *L, int top);

	static void InitializeAsync(lua_State *L, int top);

};
n> 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. */ #include "lua_api/l_server.h" #include "lua_api/l_internal.h" #include "common/c_converter.h" #include "common/c_content.h" #include "cpp_api/s_base.h" #include "cpp_api/s_security.h" #include "scripting_server.h" #include "server.h" #include "environment.h" #include "remoteplayer.h" #include "log.h" #include <algorithm> // request_shutdown() int ModApiServer::l_request_shutdown(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char *msg = lua_tolstring(L, 1, NULL); bool reconnect = readParam<bool>(L, 2); float seconds_before_shutdown = lua_tonumber(L, 3); getServer(L)->requestShutdown(msg ? msg : "", reconnect, seconds_before_shutdown); return 0; } // get_server_status() int ModApiServer::l_get_server_status(lua_State *L) { NO_MAP_LOCK_REQUIRED; lua_pushstring(L, getServer(L)->getStatusString().c_str()); return 1; } // get_server_uptime() int ModApiServer::l_get_server_uptime(lua_State *L) { NO_MAP_LOCK_REQUIRED; lua_pushnumber(L, getServer(L)->getUptime()); return 1; } // get_server_max_lag() int ModApiServer::l_get_server_max_lag(lua_State *L) { NO_MAP_LOCK_REQUIRED; ServerEnvironment *s_env = dynamic_cast<ServerEnvironment *>(getEnv(L)); if (!s_env) lua_pushnil(L); else lua_pushnumber(L, s_env->getMaxLagEstimate()); return 1; } // print(text) int ModApiServer::l_print(lua_State *L) { NO_MAP_LOCK_REQUIRED; std::string text; text = luaL_checkstring(L, 1); getServer(L)->printToConsoleOnly(text); return 0; } // chat_send_all(text) int ModApiServer::l_chat_send_all(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char *text = luaL_checkstring(L, 1); // Get server from registry Server *server = getServer(L); // Send server->notifyPlayers(utf8_to_wide(text)); return 0; } // chat_send_player(name, text) int ModApiServer::l_chat_send_player(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char *name = luaL_checkstring(L, 1); const char *text = luaL_checkstring(L, 2); // Get server from registry Server *server = getServer(L); // Send server->notifyPlayer(name, utf8_to_wide(text)); return 0; } // get_player_privs(name, text) int ModApiServer::l_get_player_privs(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char *name = luaL_checkstring(L, 1); // Get server from registry Server *server = getServer(L); // Do it lua_newtable(L); int table = lua_gettop(L); std::set<std::string> privs_s = server->getPlayerEffectivePrivs(name); for (const std::string &privs_ : privs_s) { lua_pushboolean(L, true); lua_setfield(L, table, privs_.c_str()); } lua_pushvalue(L, table); return 1; } // get_player_ip() int ModApiServer::l_get_player_ip(lua_State *L) { NO_MAP_LOCK_REQUIRED; Server *server = getServer(L); const char *name = luaL_checkstring(L, 1); RemotePlayer *player = server->getEnv().getPlayer(name); if (!player) { lua_pushnil(L); // no such player return 1; } lua_pushstring(L, server->getPeerAddress(player->getPeerId()).serializeString().c_str()); return 1; } // get_player_information(name) int ModApiServer::l_get_player_information(lua_State *L) { NO_MAP_LOCK_REQUIRED; Server *server = getServer(L); const char *name = luaL_checkstring(L, 1); RemotePlayer *player = server->getEnv().getPlayer(name); if (!player) { lua_pushnil(L); // no such player return 1; } /* Be careful not to introduce a depdendency on the connection to the peer here. This function is >>REQUIRED<< to still be able to return values even when the peer unexpectedly disappears. Hence all the ConInfo values here are optional. */ auto getConInfo = [&] (con::rtt_stat_type type, float *value) -> bool { return server->getClientConInfo(player->getPeerId(), type, value); }; float min_rtt, max_rtt, avg_rtt, min_jitter, max_jitter, avg_jitter; bool have_con_info = getConInfo(con::MIN_RTT, &min_rtt) && getConInfo(con::MAX_RTT, &max_rtt) && getConInfo(con::AVG_RTT, &avg_rtt) && getConInfo(con::MIN_JITTER, &min_jitter) && getConInfo(con::MAX_JITTER, &max_jitter) && getConInfo(con::AVG_JITTER, &avg_jitter); ClientInfo info; if (!server->getClientInfo(player->getPeerId(), info)) { warningstream << FUNCTION_NAME << ": no client info?!" << std::endl; lua_pushnil(L); // error return 1; } lua_newtable(L); int table = lua_gettop(L); lua_pushstring(L,"address"); lua_pushstring(L, info.addr.serializeString().c_str()); lua_settable(L, table); lua_pushstring(L,"ip_version"); if (info.addr.getFamily() == AF_INET) { lua_pushnumber(L, 4); } else if (info.addr.getFamily() == AF_INET6) { lua_pushnumber(L, 6); } else { lua_pushnumber(L, 0); } lua_settable(L, table); if (have_con_info) { // may be missing lua_pushstring(L, "min_rtt"); lua_pushnumber(L, min_rtt); lua_settable(L, table); lua_pushstring(L, "max_rtt"); lua_pushnumber(L, max_rtt); lua_settable(L, table); lua_pushstring(L, "avg_rtt"); lua_pushnumber(L, avg_rtt); lua_settable(L, table); lua_pushstring(L, "min_jitter"); lua_pushnumber(L, min_jitter); lua_settable(L, table); lua_pushstring(L, "max_jitter"); lua_pushnumber(L, max_jitter); lua_settable(L, table); lua_pushstring(L, "avg_jitter"); lua_pushnumber(L, avg_jitter); lua_settable(L, table); } lua_pushstring(L,"connection_uptime"); lua_pushnumber(L, info.uptime); lua_settable(L, table); lua_pushstring(L,"protocol_version"); lua_pushnumber(L, info.prot_vers); lua_settable(L, table); lua_pushstring(L, "formspec_version"); lua_pushnumber(L, player->formspec_version); lua_settable(L, table); lua_pushstring(L, "lang_code"); lua_pushstring(L, info.lang_code.c_str()); lua_settable(L, table); #ifndef NDEBUG lua_pushstring(L,"serialization_version"); lua_pushnumber(L, info.ser_vers); lua_settable(L, table); lua_pushstring(L,"major"); lua_pushnumber(L, info.major); lua_settable(L, table); lua_pushstring(L,"minor"); lua_pushnumber(L, info.minor); lua_settable(L, table); lua_pushstring(L,"patch"); lua_pushnumber(L, info.patch); lua_settable(L, table); lua_pushstring(L,"version_string"); lua_pushstring(L, info.vers_string.c_str()); lua_settable(L, table); lua_pushstring(L,"state"); lua_pushstring(L, ClientInterface::state2Name(info.state).c_str()); lua_settable(L, table); #endif return 1; } // get_ban_list() int ModApiServer::l_get_ban_list(lua_State *L) { NO_MAP_LOCK_REQUIRED; lua_pushstring(L, getServer(L)->getBanDescription("").c_str()); return 1; } // get_ban_description() int ModApiServer::l_get_ban_description(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char * ip_or_name = luaL_checkstring(L, 1); lua_pushstring(L, getServer(L)->getBanDescription(std::string(ip_or_name)).c_str()); return 1; } // ban_player() int ModApiServer::l_ban_player(lua_State *L) { NO_MAP_LOCK_REQUIRED; if (!getEnv(L)) throw LuaError("Can't ban player before server has started up"); Server *server = getServer(L); const char *name = luaL_checkstring(L, 1); RemotePlayer *player = server->getEnv().getPlayer(name); if (!player) { lua_pushboolean(L, false); // no such player return 1; } std::string ip_str = server->getPeerAddress(player->getPeerId()).serializeString(); server->setIpBanned(ip_str, name); lua_pushboolean(L, true); return 1; } // disconnect_player(name, [reason]) -> success int ModApiServer::l_disconnect_player(lua_State *L) { NO_MAP_LOCK_REQUIRED; if (!getEnv(L)) throw LuaError("Can't kick player before server has started up"); const char *name = luaL_checkstring(L, 1); std::string message; if (lua_isstring(L, 2)) message.append(readParam<std::string>(L, 2)); else message.append("Disconnected."); RemotePlayer *player = dynamic_cast<ServerEnvironment *>(getEnv(L))->getPlayer(name); if (player == NULL) { lua_pushboolean(L, false); // No such player return 1; } getServer(L)->DenyAccess_Legacy(player->getPeerId(), utf8_to_wide(message)); lua_pushboolean(L, true); return 1; } int ModApiServer::l_remove_player(lua_State *L) { NO_MAP_LOCK_REQUIRED; std::string name = luaL_checkstring(L, 1); ServerEnvironment *s_env = dynamic_cast<ServerEnvironment *>(getEnv(L)); if (!s_env) throw LuaError("Can't remove player before server has started up"); RemotePlayer *player = s_env->getPlayer(name.c_str()); if (!player) lua_pushinteger(L, s_env->removePlayerFromDatabase(name) ? 0 : 1); else lua_pushinteger(L, 2); return 1; } // unban_player_or_ip() int ModApiServer::l_unban_player_or_ip(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char * ip_or_name = luaL_checkstring(L, 1); getServer(L)->unsetIpBanned(ip_or_name); lua_pushboolean(L, true); return 1; } // show_formspec(playername,formname,formspec) int ModApiServer::l_show_formspec(lua_State *L) { NO_MAP_LOCK_REQUIRED; const char *playername = luaL_checkstring(L, 1); const char *formname = luaL_checkstring(L, 2); const char *formspec = luaL_checkstring(L, 3); if(getServer(L)->showFormspec(playername,formspec,formname)) { lua_pushboolean(L, true); }else{ lua_pushboolean(L, false); } return 1; } // get_current_modname() int ModApiServer::l_get_current_modname(lua_State *L) { NO_MAP_LOCK_REQUIRED; lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME); return 1; } // get_modpath(modname) int ModApiServer::l_get_modpath(lua_State *L) { NO_MAP_LOCK_REQUIRED; std::string modname = luaL_checkstring(L, 1); const ModSpec *mod = getServer(L)->getModSpec(modname); if (!mod) { lua_pushnil(L); return 1; } lua_pushstring(L, mod->path.c_str()); return 1; } // get_modnames() // the returned list is sorted alphabetically for you int ModApiServer::l_get_modnames(lua_State *L) { NO_MAP_LOCK_REQUIRED; // Get a list of mods std::vector<std::string> modlist; getServer(L)->getModNames(modlist); std::sort(modlist.begin(), modlist.end()); // Package them up for Lua lua_createtable(L, modlist.size(), 0); std::vector<std::string>::iterator iter = modlist.begin(); for (u16 i = 0; iter != modlist.end(); ++iter) { lua_pushstring(L, iter->c_str()); lua_rawseti(L, -2, ++i); } return 1; } // get_worldpath() int ModApiServer::l_get_worldpath(lua_State *L) { NO_MAP_LOCK_REQUIRED; std::string worldpath = getServer(L)->getWorldPath(); lua_pushstring(L, worldpath.c_str()); return 1; } // sound_play(spec, parameters, [ephemeral]) int ModApiServer::l_sound_play(lua_State *L) { NO_MAP_LOCK_REQUIRED; SimpleSoundSpec spec; read_soundspec(L, 1, spec); ServerSoundParams params; read_server_sound_params(L, 2, params); bool ephemeral = lua_gettop(L) > 2 && readParam<bool>(L, 3); if (ephemeral) { getServer(L)->playSound(spec, params, true); lua_pushnil(L); } else { s32 handle = getServer(L)->playSound(spec, params); lua_pushinteger(L, handle); } return 1; } // sound_stop(handle) int ModApiServer::l_sound_stop(lua_State *L) { NO_MAP_LOCK_REQUIRED; s32 handle = luaL_checkinteger(L, 1); getServer(L)->stopSound(handle); return 0; } int ModApiServer::l_sound_fade(lua_State *L) { NO_MAP_LOCK_REQUIRED; s32 handle = luaL_checkinteger(L, 1); float step = readParam<float>(L, 2); float gain = readParam<float>(L, 3); getServer(L)->fadeSound(handle, step, gain); return 0; } // dynamic_add_media(filepath) int ModApiServer::l_dynamic_add_media(lua_State *L) { NO_MAP_LOCK_REQUIRED; if (!getEnv(L)) throw LuaError("Dynamic media cannot be added before server has started up"); Server *server = getServer(L); std::string filepath; std::string to_player; bool ephemeral = false; if (lua_istable(L, 1)) { getstringfield(L, 1, "filepath", filepath); getstringfield(L, 1, "to_player", to_player); getboolfield(L, 1, "ephemeral", ephemeral); } else { filepath = readParam<std::string>(L, 1); } if (filepath.empty()) luaL_typerror(L, 1, "non-empty string"); luaL_checktype(L, 2, LUA_TFUNCTION); CHECK_SECURE_PATH(L, filepath.c_str(), false); u32 token = server->getScriptIface()->allocateDynamicMediaCallback(L, 2); bool ok = server->dynamicAddMedia(filepath, token, to_player, ephemeral); if (!ok) server->getScriptIface()->freeDynamicMediaCallback(token); lua_pushboolean(L, ok); return 1; } // is_singleplayer() int ModApiServer::l_is_singleplayer(lua_State *L) { NO_MAP_LOCK_REQUIRED; lua_pushboolean(L, getServer(L)->isSingleplayer()); return 1; } // notify_authentication_modified(name) int ModApiServer::l_notify_authentication_modified(lua_State *L) { NO_MAP_LOCK_REQUIRED; std::string name; if(lua_isstring(L, 1)) name = readParam<std::string>(L, 1); getServer(L)->reportPrivsModified(name); return 0; } void ModApiServer::Initialize(lua_State *L, int top) { API_FCT(request_shutdown); API_FCT(get_server_status); API_FCT(get_server_uptime); API_FCT(get_server_max_lag); API_FCT(get_worldpath); API_FCT(is_singleplayer); API_FCT(get_current_modname); API_FCT(get_modpath); API_FCT(get_modnames); API_FCT(print); API_FCT(chat_send_all); API_FCT(chat_send_player); API_FCT(show_formspec); API_FCT(sound_play); API_FCT(sound_stop); API_FCT(sound_fade); API_FCT(dynamic_add_media); API_FCT(get_player_information); API_FCT(get_player_privs); API_FCT(get_player_ip); API_FCT(get_ban_list); API_FCT(get_ban_description); API_FCT(ban_player); API_FCT(disconnect_player); API_FCT(remove_player); API_FCT(unban_player_or_ip); API_FCT(notify_authentication_modified); }