3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
20 #include "cpp_api/s_base.h"
21 #include "cpp_api/s_internal.h"
22 #include "cpp_api/s_security.h"
23 #include "lua_api/l_object.h"
24 #include "common/c_converter.h"
25 #include "serverobject.h"
29 #include "util/string.h"
45 #include "script/common/c_content.h"
54 ModNameStorer(lua_State *L_, const std::string &mod_name):
57 // Store current mod name in registry
58 lua_pushstring(L, mod_name.c_str());
59 lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
63 // Clear current mod name from registry
65 lua_rawseti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
74 ScriptApiBase::ScriptApiBase() :
78 #ifdef SCRIPTAPI_LOCK_DEBUG
79 m_lock_recursion_count = 0;
82 m_luastack = luaL_newstate();
83 FATAL_ERROR_IF(!m_luastack, "luaL_newstate() failed");
85 lua_atpanic(m_luastack, &luaPanic);
87 luaL_openlibs(m_luastack);
89 // Make the ScriptApiBase* accessible to ModApiBase
90 lua_pushlightuserdata(m_luastack, this);
91 lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_SCRIPTAPI);
93 // Add and save an error handler
94 lua_pushcfunction(m_luastack, script_error_handler);
95 lua_rawseti(m_luastack, LUA_REGISTRYINDEX, CUSTOM_RIDX_ERROR_HANDLER);
97 // If we are using LuaJIT add a C++ wrapper function to catch
98 // exceptions thrown in Lua -> C++ calls
100 lua_pushlightuserdata(m_luastack, (void*) script_exception_wrapper);
101 luaJIT_setmode(m_luastack, -1, LUAJIT_MODE_WRAPCFUNC | LUAJIT_MODE_ON);
102 lua_pop(m_luastack, 1);
106 lua_newtable(m_luastack);
107 lua_setglobal(m_luastack, "core");
109 lua_pushstring(m_luastack, DIR_DELIM);
110 lua_setglobal(m_luastack, "DIR_DELIM");
112 lua_pushstring(m_luastack, porting::getPlatformName());
113 lua_setglobal(m_luastack, "PLATFORM");
115 // m_secure gets set to true inside
116 // ScriptApiSecurity::initializeSecurity(), if neccessary.
117 // Default to false otherwise
120 m_environment = NULL;
124 ScriptApiBase::~ScriptApiBase()
126 lua_close(m_luastack);
129 int ScriptApiBase::luaPanic(lua_State *L)
131 std::ostringstream oss;
132 oss << "LUA PANIC: unprotected error in call to Lua API ("
133 << lua_tostring(L, -1) << ")";
134 FATAL_ERROR(oss.str().c_str());
139 void ScriptApiBase::loadMod(const std::string &script_path,
140 const std::string &mod_name)
142 ModNameStorer mod_name_storer(getStack(), mod_name);
144 loadScript(script_path);
147 void ScriptApiBase::loadScript(const std::string &script_path)
149 verbosestream << "Loading and running script from " << script_path << std::endl;
151 lua_State *L = getStack();
153 int error_handler = PUSH_ERROR_HANDLER(L);
157 ok = ScriptApiSecurity::safeLoadFile(L, script_path.c_str());
159 ok = !luaL_loadfile(L, script_path.c_str());
161 ok = ok && !lua_pcall(L, 0, 0, error_handler);
163 std::string error_msg = lua_tostring(L, -1);
164 lua_pop(L, 2); // Pop error message and error handler
165 throw ModError("Failed to load and run script from " +
166 script_path + ":\n" + error_msg);
168 lua_pop(L, 1); // Pop error handler
171 // Push the list of callbacks (a lua table).
172 // Then push nargs arguments.
173 // Then call this function, which
174 // - runs the callbacks
175 // - replaces the table and arguments with the return value,
176 // computed depending on mode
177 // This function must only be called with scriptlock held (i.e. inside of a
178 // code block with SCRIPTAPI_PRECHECKHEADER declared)
179 void ScriptApiBase::runCallbacksRaw(int nargs,
180 RunCallbacksMode mode, const char *fxn)
182 #ifdef SCRIPTAPI_LOCK_DEBUG
183 assert(m_lock_recursion_count > 0);
185 lua_State *L = getStack();
186 FATAL_ERROR_IF(lua_gettop(L) < nargs + 1, "Not enough arguments");
188 // Insert error handler
189 PUSH_ERROR_HANDLER(L);
190 int error_handler = lua_gettop(L) - nargs - 1;
191 lua_insert(L, error_handler);
193 // Insert run_callbacks between error handler and table
194 lua_getglobal(L, "core");
195 lua_getfield(L, -1, "run_callbacks");
197 lua_insert(L, error_handler + 1);
199 // Insert mode after table
200 lua_pushnumber(L, (int)mode);
201 lua_insert(L, error_handler + 3);
203 // Stack now looks like this:
204 // ... <error handler> <run_callbacks> <table> <mode> <arg#1> <arg#2> ... <arg#n>
206 int result = lua_pcall(L, nargs + 2, 1, error_handler);
208 scriptError(result, fxn);
210 lua_remove(L, error_handler);
213 void ScriptApiBase::realityCheck()
215 int top = lua_gettop(m_luastack);
217 dstream << "Stack is over 30:" << std::endl;
219 std::string traceback = script_get_backtrace(m_luastack);
220 throw LuaError("Stack is over 30 (reality check)\n" + traceback);
224 void ScriptApiBase::scriptError(int result, const char *fxn)
226 script_error(getStack(), result, m_last_run_mod.c_str(), fxn);
229 void ScriptApiBase::stackDump(std::ostream &o)
231 int top = lua_gettop(m_luastack);
232 for (int i = 1; i <= top; i++) { /* repeat for each level */
233 int t = lua_type(m_luastack, i);
235 case LUA_TSTRING: /* strings */
236 o << "\"" << lua_tostring(m_luastack, i) << "\"";
238 case LUA_TBOOLEAN: /* booleans */
239 o << (lua_toboolean(m_luastack, i) ? "true" : "false");
241 case LUA_TNUMBER: /* numbers */ {
243 snprintf(buf, 10, "%g", lua_tonumber(m_luastack, i));
247 default: /* other values */
248 o << lua_typename(m_luastack, t);
256 void ScriptApiBase::setOriginDirect(const char *origin)
258 m_last_run_mod = origin ? origin : "??";
261 void ScriptApiBase::setOriginFromTableRaw(int index, const char *fxn)
263 #ifdef SCRIPTAPI_DEBUG
264 lua_State *L = getStack();
266 m_last_run_mod = lua_istable(L, index) ?
267 getstringfield_default(L, index, "mod_origin", "") : "";
268 //printf(">>>> running %s for mod: %s\n", fxn, m_last_run_mod.c_str());
272 void ScriptApiBase::addObjectReference(ServerActiveObject *cobj)
274 SCRIPTAPI_PRECHECKHEADER
275 //infostream<<"scriptapi_add_object_reference: id="<<cobj->getId()<<std::endl;
277 // Create object on stack
278 ObjectRef::create(L, cobj); // Puts ObjectRef (as userdata) on stack
279 int object = lua_gettop(L);
281 // Get core.object_refs table
282 lua_getglobal(L, "core");
283 lua_getfield(L, -1, "object_refs");
284 luaL_checktype(L, -1, LUA_TTABLE);
285 int objectstable = lua_gettop(L);
287 // object_refs[id] = object
288 lua_pushnumber(L, cobj->getId()); // Push id
289 lua_pushvalue(L, object); // Copy object to top of stack
290 lua_settable(L, objectstable);
293 void ScriptApiBase::removeObjectReference(ServerActiveObject *cobj)
295 SCRIPTAPI_PRECHECKHEADER
296 //infostream<<"scriptapi_rm_object_reference: id="<<cobj->getId()<<std::endl;
298 // Get core.object_refs table
299 lua_getglobal(L, "core");
300 lua_getfield(L, -1, "object_refs");
301 luaL_checktype(L, -1, LUA_TTABLE);
302 int objectstable = lua_gettop(L);
304 // Get object_refs[id]
305 lua_pushnumber(L, cobj->getId()); // Push id
306 lua_gettable(L, objectstable);
307 // Set object reference to NULL
308 ObjectRef::set_null(L);
309 lua_pop(L, 1); // pop object
311 // Set object_refs[id] = nil
312 lua_pushnumber(L, cobj->getId()); // Push id
314 lua_settable(L, objectstable);
317 // Creates a new anonymous reference if cobj=NULL or id=0
318 void ScriptApiBase::objectrefGetOrCreate(lua_State *L,
319 ServerActiveObject *cobj)
321 if (cobj == NULL || cobj->getId() == 0) {
322 ObjectRef::create(L, cobj);
324 push_objectRef(L, cobj->getId());
328 Server* ScriptApiBase::getServer()
330 return dynamic_cast<Server *>(m_gamedef);
333 Client* ScriptApiBase::getClient()
335 return dynamic_cast<Client *>(m_gamedef);