aboutsummaryrefslogtreecommitdiff
Commit message (Expand)AuthorAge
...
* Add Note regarding pcnaming and interlocking signalsorwell962018-11-20
* Remove superfluous "tarvelocity" assignmentsorwell962018-11-20
* Make "Line" property accessible from OBC and gettable via LATC, change subway...orwell962018-11-20
* Remove debug printorwell962018-11-20
* Permit basic signal aspect settingorwell962018-11-19
* Fix protection regarding tracks (track_builder and railway_operator) and docu...orwell962018-11-12
* Increase savefile version to 2orwell962018-11-10
* Remove "couple locks" and apply protection to the actual coupling process, an...orwell962018-11-10
* Ks signals emit some lightorwell962018-11-05
* Allow pcnaming for any signalsorwell962018-11-05
* Replace "Allow accelereting train towards signal"orwell962018-10-30
* No static_save for discouple entitiesorwell962018-10-30
* Make fillout_aspect also fill "info" fieldorwell962018-10-30
* Do not allow static signals for routesettingorwell962018-10-30
* Fix Ks signals not setting aspect (missing set_aspect function)orwell962018-10-30
* Document fix 0a982b6356b2f4b6a28e74f9f90c4f584169a96dorwell962018-10-29
* Actually set last_connid to 1, to prevent warningorwell962018-10-29
* Do not print "couldn't determine section" warning when all traverser ends wer...orwell962018-10-29
* Handle the case that a train is not initialized (train_ensure_init returns ni...orwell962018-10-29
* Allow to accelerate trains slowly towards red signals from stand.orwell962018-10-29
* Fix typo in signal assignment, causing crashorwell962018-10-29
* Miscellaneous routesetting fixesorwell962018-10-29
* atdump() to treat certain values specialorwell962018-10-29
* Fix signal_get_aspect()orwell962018-10-29
* Small fixes which do not have any effectorwell962018-10-29
* Add Interlocking Tool to inspect route locksorwell962018-10-26
* Add "Reset track section" functionorwell962018-10-26
* Complete Ks Main signalsorwell962018-10-26
* Fix demo signalsorwell962018-10-25
* Add doc for supported_aspects, improve other doc and aspect autofillorwell962018-10-25
* Display route_rsn when denying routesetting by subroute locked.orwell962018-10-25
* Fix node database ATC rail bugorwell962018-10-17
* Prevent any user control except "Brake" when an ATC override is presentorwell962018-10-17
* Improve ATC-LZB-User control interaction, smoothen LZB control operationsorwell962018-10-17
* Address H#60, H#17, M#18 and M#7orwell962018-10-17
* Fix H#69orwell962018-10-17
* Fix H#66 (Hemiptera 66) crash on missing double_conn matchorwell962018-10-17
* Actually allow what manual promises (setting IP on non-assigned signals)orwell962018-10-17
* Update manual againorwell962018-10-15
* Properly handle speed restrictionsorwell962018-10-10
* Remote Routesetting from Onboard Computerorwell962018-10-10
* Properly implement invalidate_all_paths, recheck lzb on aspect changeorwell962018-10-10
* Add signal safety control override, restructure control systemorwell962018-10-10
* Make signal influence point (~halt point) specifiableorwell962018-10-09
* Improve route programming:orwell962018-10-07
* Fix route programming lock-placementorwell962018-09-28
* lower steel returnThomas Rudin2018-09-28
* Add interlocking guide/manual, silence debug outputsorwell962018-09-14
* Add LuaAutomation interface functions for interlocking routesetting and aspec...orwell962018-08-24
* (Note added, merge in next commit)orwell962018-08-24
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 "cpp_api/s_base.h" #include "cpp_api/s_internal.h" #include "cpp_api/s_security.h" #include "lua_api/l_object.h" #include "common/c_converter.h" #include "serverobject.h" #include "filesys.h" #include "content/mods.h" #include "porting.h" #include "util/string.h" #include "server.h" #ifndef SERVER #include "client.h" #endif extern "C" { #include "lualib.h" #if USE_LUAJIT #include "luajit.h" #endif } #include <cstdio> #include <cstdarg> #include "script/common/c_content.h" #include "content_sao.h" #include <sstream> class ModNameStorer { private: lua_State *L; public: ModNameStorer(lua_State *L_, const std::string &mod_name): L(L_) { // Store current mod name in registry lua_pushstring(L, mod_name.c_str()); lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME); } ~ModNameStorer() { // Clear current mod name from registry lua_pushnil(L); lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME); } }; /* ScriptApiBase */ ScriptApiBase::ScriptApiBase(ScriptingType type): m_type(type) { #ifdef SCRIPTAPI_LOCK_DEBUG m_lock_recursion_count = 0; #endif m_luastack = luaL_newstate(); FATAL_ERROR_IF(!m_luastack, "luaL_newstate() failed"); lua_atpanic(m_luastack, &luaPanic); if (m_type == ScriptingType::Client) clientOpenLibs(m_luastack); else luaL_openlibs(m_luastack); // Make the ScriptApiBase* accessible to ModApiBase lua_pushlightuserdata(m_luastack, this); lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI); // Add and save an error handler lua_getglobal(m_luastack, "debug"); lua_getfield(m_luastack, -1, "traceback"); lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_BACKTRACE); lua_pop(m_luastack, 1); // pop debug // If we are using LuaJIT add a C++ wrapper function to catch // exceptions thrown in Lua -> C++ calls #if USE_LUAJIT lua_pushlightuserdata(m_luastack, (void*) script_exception_wrapper); luaJIT_setmode(m_luastack, -1, LUAJIT_MODE_WRAPCFUNC | LUAJIT_MODE_ON); lua_pop(m_luastack, 1); #endif // Add basic globals lua_newtable(m_luastack); lua_setglobal(m_luastack, "core"); if (m_type == ScriptingType::Client) lua_pushstring(m_luastack, "/"); else lua_pushstring(m_luastack, DIR_DELIM); lua_setglobal(m_luastack, "DIR_DELIM"); lua_pushstring(m_luastack, porting::getPlatformName()); lua_setglobal(m_luastack, "PLATFORM"); // Make sure Lua uses the right locale setlocale(LC_NUMERIC, "C"); } ScriptApiBase::~ScriptApiBase() { lua_close(m_luastack); } int ScriptApiBase::luaPanic(lua_State *L) { std::ostringstream oss; oss << "LUA PANIC: unprotected error in call to Lua API (" << readParam<std::string>(L, -1) << ")"; FATAL_ERROR(oss.str().c_str()); // NOTREACHED return 0; } void ScriptApiBase::clientOpenLibs(lua_State *L) { static const std::vector<std::pair<std::string, lua_CFunction>> m_libs = { { "", luaopen_base }, { LUA_TABLIBNAME, luaopen_table }, { LUA_OSLIBNAME, luaopen_os }, { LUA_STRLIBNAME, luaopen_string }, { LUA_MATHLIBNAME, luaopen_math }, { LUA_DBLIBNAME, luaopen_debug }, #if USE_LUAJIT { LUA_JITLIBNAME, luaopen_jit }, #endif }; for (const std::pair<std::string, lua_CFunction> &lib : m_libs) { lua_pushcfunction(L, lib.second); lua_pushstring(L, lib.first.c_str()); lua_call(L, 1, 0); } } void ScriptApiBase::loadMod(const std::string &script_path, const std::string &mod_name) { ModNameStorer mod_name_storer(getStack(), mod_name); loadScript(script_path); } void ScriptApiBase::loadScript(const std::string &script_path) { verbosestream << "Loading and running script from " << script_path << std::endl; lua_State *L = getStack(); int error_handler = PUSH_ERROR_HANDLER(L); bool ok; if (m_secure) { ok = ScriptApiSecurity::safeLoadFile(L, script_path.c_str()); } else { ok = !luaL_loadfile(L, script_path.c_str()); } ok = ok && !lua_pcall(L, 0, 0, error_handler); if (!ok) { std::string error_msg = readParam<std::string>(L, -1); lua_pop(L, 2); // Pop error message and error handler throw ModError("Failed to load and run script from " + script_path + ":\n" + error_msg); } lua_pop(L, 1); // Pop error handler } #ifndef SERVER void ScriptApiBase::loadModFromMemory(const std::string &mod_name) { ModNameStorer mod_name_storer(getStack(), mod_name); const std::string *init_filename = getClient()->getModFile(mod_name + ":init.lua"); const std::string display_filename = mod_name + ":init.lua"; if(init_filename == NULL) throw ModError("Mod:\"" + mod_name + "\" lacks init.lua"); verbosestream << "Loading and running script " << display_filename << std::endl; lua_State *L = getStack(); int error_handler = PUSH_ERROR_HANDLER(L); bool ok = ScriptApiSecurity::safeLoadFile(L, init_filename->c_str(), display_filename.c_str()); if (ok) ok = !lua_pcall(L, 0, 0, error_handler); if (!ok) { std::string error_msg = luaL_checkstring(L, -1); lua_pop(L, 2); // Pop error message and error handler throw ModError("Failed to load and run mod \"" + mod_name + "\":\n" + error_msg); } lua_pop(L, 1); // Pop error handler } #endif // Push the list of callbacks (a lua table). // Then push nargs arguments. // Then call this function, which // - runs the callbacks // - replaces the table and arguments with the return value, // computed depending on mode // This function must only be called with scriptlock held (i.e. inside of a // code block with SCRIPTAPI_PRECHECKHEADER declared) void ScriptApiBase::runCallbacksRaw(int nargs, RunCallbacksMode mode, const char *fxn) { #ifdef SCRIPTAPI_LOCK_DEBUG assert(m_lock_recursion_count > 0); #endif lua_State *L = getStack(); FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments"); // Insert error handler PUSH_ERROR_HANDLER(L); int error_handler = lua_gettop(L) - nargs - 1; lua_insert(L, error_handler); // Insert run_callbacks between error handler and table lua_getglobal(L, "core"); lua_getfield(L, -1, "run_callbacks"); lua_remove(L, -2); lua_insert(L, error_handler + 1); // Insert mode after table lua_pushnumber(L, (int)mode); lua_insert(L, error_handler + 3); // Stack now looks like this: // ... <error handler> <run_callbacks> <table> <mode> <arg#1> <arg#2> ... <arg#n> int result = lua_pcall(L, nargs + 2, 1, error_handler); if (result != 0) scriptError(result, fxn); lua_remove(L, error_handler); } void ScriptApiBase::realityCheck() { int top = lua_gettop(m_luastack); if (top >= 30) { dstream << "Stack is over 30:" << std::endl; stackDump(dstream); std::string traceback = script_get_backtrace(m_luastack); throw LuaError("Stack is over 30 (reality check)\n" + traceback); } } void ScriptApiBase::scriptError(int result, const char *fxn) { script_error(getStack(), result, m_last_run_mod.c_str(), fxn); } void ScriptApiBase::stackDump(std::ostream &o) { int top = lua_gettop(m_luastack); for (int i = 1; i <= top; i++) { /* repeat for each level */ int t = lua_type(m_luastack, i); switch (t) { case LUA_TSTRING: /* strings */ o << "\"" << readParam<std::string>(m_luastack, i) << "\""; break; case LUA_TBOOLEAN: /* booleans */ o << (readParam<bool>(m_luastack, i) ? "true" : "false"); break; case LUA_TNUMBER: /* numbers */ { char buf[10]; porting::mt_snprintf(buf, sizeof(buf), "%lf", lua_tonumber(m_luastack, i)); o << buf; break; } default: /* other values */ o << lua_typename(m_luastack, t); break; } o << " "; } o << std::endl; } void ScriptApiBase::setOriginDirect(const char *origin) { m_last_run_mod = origin ? origin : "??"; } void ScriptApiBase::setOriginFromTableRaw(int index, const char *fxn) { #ifdef SCRIPTAPI_DEBUG lua_State *L = getStack(); m_last_run_mod = lua_istable(L, index) ? getstringfield_default(L, index, "mod_origin", "") : ""; //printf(">>>> running %s for mod: %s\n", fxn, m_last_run_mod.c_str()); #endif } void ScriptApiBase::addObjectReference(ServerActiveObject *cobj) { SCRIPTAPI_PRECHECKHEADER //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl; // Create object on stack ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack int object = lua_gettop(L); // Get core.object_refs table lua_getglobal(L, "core"); lua_getfield(L, -1, "object_refs"); luaL_checktype(L, -1, LUA_TTABLE); int objectstable = lua_gettop(L); // object_refs[id] = object lua_pushnumber(L, cobj->getId()); // Push id lua_pushvalue(L, object); // Copy object to top of stack lua_settable(L, objectstable); } void ScriptApiBase::removeObjectReference(ServerActiveObject *cobj) { SCRIPTAPI_PRECHECKHEADER //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl; // Get core.object_refs table lua_getglobal(L, "core"); lua_getfield(L, -1, "object_refs"); luaL_checktype(L, -1, LUA_TTABLE); int objectstable = lua_gettop(L); // Get object_refs[id] lua_pushnumber(L, cobj->getId()); // Push id lua_gettable(L, objectstable); // Set object reference to NULL ObjectRef::set_null(L); lua_pop(L, 1); // pop object // Set object_refs[id] = nil lua_pushnumber(L, cobj->getId()); // Push id lua_pushnil(L); lua_settable(L, objectstable); } // Creates a new anonymous reference if cobj=NULL or id=0 void ScriptApiBase::objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj) { if (cobj == NULL || cobj->getId() == 0) { ObjectRef::create(L, cobj); } else { push_objectRef(L, cobj->getId()); if (cobj->isGone()) warningstream << "ScriptApiBase::objectrefGetOrCreate(): " << "Pushing ObjectRef to removed/deactivated object" << ", this is probably a bug." << std::endl; } } void ScriptApiBase::pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason &reason) { if (reason.lua_reference >= 0) { lua_rawgeti(L, LUA_REGISTRYINDEX, reason.lua_reference); luaL_unref(L, LUA_REGISTRYINDEX, reason.lua_reference); } else lua_newtable(L); lua_pushstring(L, reason.getTypeAsString().c_str()); lua_setfield(L, -2, "type"); lua_pushstring(L, reason.from_mod ? "mod" : "engine"); lua_setfield(L, -2, "from"); if (reason.object) { objectrefGetOrCreate(L, reason.object); lua_setfield(L, -2, "object"); } } Server* ScriptApiBase::getServer() { return dynamic_cast<Server *>(m_gamedef); } #ifndef SERVER Client* ScriptApiBase::getClient() { return dynamic_cast<Client *>(m_gamedef); } #endif