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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
|
/**********************************************************************
Freeciv - Copyright (C) 2005 - The Freeciv Project
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, 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 General Public License for more details.
***********************************************************************/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdarg.h>
#include <stdlib.h>
#include <time.h>
#include "lua.h"
#include "lualib.h"
#include "tolua.h"
#include "astring.h"
#include "log.h"
#include "registry.h"
#include "api_gen.h"
#include "api_types.h"
#include "api_specenum.h"
#include "script_signal.h"
#include "script.h"
/**************************************************************************
Configuration for script execution time limits. Checkinterval is the
number of executed lua instructions between checking. Disabled if 0.
**************************************************************************/
#define SCRIPT_MAX_EXECUTION_TIME_SEC 5.0
#define SCRIPT_CHECKINTERVAL 10000
/**************************************************************************
Lua virtual machine state.
**************************************************************************/
static lua_State *state;
/**************************************************************************
Optional game script code (useful for scenarios).
**************************************************************************/
static char *script_code;
/**************************************************************************
Unsafe Lua builtin symbols that we to remove access to.
If Freeciv's Lua version changes, you have to check how the set of
unsafe functions and modules changes in the new version. Update the list of
loaded libraries in script_lualibs, then update the unsafe symbols blacklist
in script_unsafe_symbols.
Once the variables are updated for the new version, update the value of
SCRIPT_SECURE_LUA_VERSION
In general, unsafe is all functionality that gives access to:
* Reading files and running processes
* Loading lua files or libraries
**************************************************************************/
#define SCRIPT_SECURE_LUA_VERSION 501
static const char *script_unsafe_symbols[] = {
"debug",
"dofile",
"loadfile",
NULL
};
#if LUA_VERSION_NUM != SCRIPT_SECURE_LUA_VERSION
#warning "The script runtime's unsafe symbols information is not up to date."
#warning "This can be a big security hole!"
#endif
/**************************************************************************
Lua libraries to load (all default libraries, excluding operating system
and library loading modules). See linit.c in Lua 5.1 for the default list.
**************************************************************************/
static luaL_Reg script_lualibs[] = {
/* Using default libraries excluding: package, io and os */
{"", luaopen_base},
{LUA_TABLIBNAME, luaopen_table},
{LUA_STRLIBNAME, luaopen_string},
{LUA_MATHLIBNAME, luaopen_math},
{LUA_DBLIBNAME, luaopen_debug},
{NULL, NULL}
};
/**************************************************************************
Report a lua error.
**************************************************************************/
static int script_report(lua_State *L, int status, const char *code)
{
if (status) {
struct astring str = ASTRING_INIT;
const char *msg;
int lineno;
if (!(msg = lua_tostring(L, -1))) {
msg = "(error with no message)";
}
/* Add error message. */
astr_add_line(&str, "lua error:");
astr_add_line(&str, "\t%s", msg);
if (code) {
/* Add lines around the place the parse error is. */
if (sscanf(msg, "%*[^:]:%d:", &lineno) == 1) {
const char *begin, *end;
int i;
astr_add(&str, "\n");
i = 1;
for (begin = code; *begin != '\0';) {
int len;
end = strchr(begin, '\n');
if (end) {
len = end - begin;
} else {
len = strlen(begin);
}
if (abs(lineno - i) <= 3) {
const char *indicator;
indicator = (lineno == i) ? "-->" : " ";
astr_add_line(&str, "\t%s%3d:\t%*.*s",
indicator, i, len, len, begin);
}
i++;
if (end) {
begin = end + 1;
} else {
break;
}
}
astr_add(&str, "\n");
}
}
log_error("%s", astr_str(&str));
astr_free(&str);
lua_pop(L, 1);
}
return status;
}
/**************************************************************************
Find the debug.traceback function and store in the registry
**************************************************************************/
static void script_traceback_func_save(lua_State *L)
{
/* Find the debug.traceback function, if available */
lua_getglobal(L, "debug");
if (lua_istable(L, -1)) {
lua_getfield(L, -1, "traceback");
lua_setfield(L, LUA_REGISTRYINDEX, "freeciv_traceback");
}
lua_pop(L, 1); /* pop debug */
}
/**************************************************************************
Push the traceback function to the stack
**************************************************************************/
static void script_traceback_func_push(lua_State *L)
{
lua_getfield(L, LUA_REGISTRYINDEX, "freeciv_traceback");
}
/**************************************************************************
Check currently excecuting lua function for execution time limit
**************************************************************************/
static void script_exec_check(lua_State *L, lua_Debug *ar)
{
lua_Number exec_clock;
lua_getfield(L, LUA_REGISTRYINDEX, "freeciv_exec_clock");
exec_clock = lua_tonumber(L, -1);
lua_pop(L, 1);
if ((float)(clock() - exec_clock)/CLOCKS_PER_SEC
> SCRIPT_MAX_EXECUTION_TIME_SEC) {
luaL_error(L, "Execution time limit exceeded in script");
}
}
/**************************************************************************
Setup function execution guard
**************************************************************************/
static void script_hook_start(lua_State *L)
{
#if SCRIPT_CHECKINTERVAL
/* Store clock timestamp in the registry */
lua_pushnumber(L, clock());
lua_setfield(L, LUA_REGISTRYINDEX, "freeciv_exec_clock");
lua_sethook(L, script_exec_check, LUA_MASKCOUNT, SCRIPT_CHECKINTERVAL);
#endif
}
/**************************************************************************
Clear function execution guard
**************************************************************************/
static void script_hook_end(lua_State *L)
{
#if SCRIPT_CHECKINTERVAL
lua_sethook(L, script_exec_check, 0, 0);
#endif
}
/**************************************************************************
Evaluate a Lua function call or loaded script on the stack.
Return nonzero if an error occured.
If available pass the source code string as code, else NULL.
Will pop function and arguments (1 + narg values) from the stack.
Will push nret return values to the stack.
On error, print an error message with traceback. Nothing is pushed to
the stack.
**************************************************************************/
static int script_call(lua_State *L, int narg, int nret, const char *code)
{
int status;
int base = lua_gettop(L) - narg; /* Index of function to call */
int traceback = 0; /* Index of traceback function */
/* Find the traceback function, if available */
script_traceback_func_push(L);
if (lua_isfunction(L, -1)) {
lua_insert(L, base); /* insert traceback before function */
traceback = base;
} else {
lua_pop(L, 1); /* pop non-function traceback */
}
script_hook_start(L);
status = lua_pcall(L, narg, nret, traceback);
script_hook_end(L);
if (status) {
script_report(L, status, code);
}
if (traceback) {
lua_remove(L, traceback);
}
return status;
}
/**************************************************************************
lua_dostring replacement with error message showing on errors.
**************************************************************************/
static int script_dostring(lua_State *L, const char *str, const char *name)
{
int status;
status = luaL_loadbuffer(L, str, strlen(str), name);
if (status) {
script_report(L, status, str);
} else {
status = script_call(L, 0, 0, str);
}
return status;
}
/**************************************************************************
Parse and execute the script in str
**************************************************************************/
bool script_do_string(const char *str)
{
int status = script_dostring(state, str, "cmd");
return (status == 0);
}
/**************************************************************************
Parse and execute the script at filename.
**************************************************************************/
bool script_do_file(const char *filename)
{
int status;
status = luaL_loadfile(state, filename);
if (status) {
script_report(state, status, NULL);
} else {
status = script_call(state, 0, 0, NULL);
}
return (status == 0);
}
/**************************************************************************
Internal api error function.
Invoking this will cause Lua to stop executing the current context and
throw an exception, so to speak.
**************************************************************************/
int script_error(const char *fmt, ...)
{
va_list argp;
va_start(argp, fmt);
luaL_where(state, 1);
lua_pushvfstring(state, fmt, argp);
va_end(argp);
lua_concat(state, 2);
return lua_error(state);
}
/**************************************************************************
Like script_error, but using a prefix identifying the called lua function:
bad argument #narg to '<func>': msg
**************************************************************************/
int script_arg_error(int narg, const char *msg)
{
return luaL_argerror(state, narg, msg);
}
/**************************************************************************
Push callback arguments into the Lua stack.
**************************************************************************/
static void script_callback_push_args(int nargs, va_list args)
{
int i;
for (i = 0; i < nargs; i++) {
int type;
type = va_arg(args, int);
switch (type) {
case API_TYPE_INT:
{
int arg;
arg = va_arg(args, int);
tolua_pushnumber(state, (lua_Number)arg);
}
break;
case API_TYPE_BOOL:
{
int arg;
arg = va_arg(args, int);
tolua_pushboolean(state, (bool)arg);
}
break;
case API_TYPE_STRING:
{
const char *arg;
arg = va_arg(args, const char*);
tolua_pushstring(state, arg);
}
break;
default:
{
const char *name;
void *arg;
name = get_api_type_name(type);
fc_assert_ret(NULL != name);
arg = va_arg(args, void*);
tolua_pushusertype(state, arg, name);
}
break;
}
}
}
/**************************************************************************
Invoke the 'callback_name' Lua function.
**************************************************************************/
bool script_callback_invoke(const char *callback_name,
int nargs, va_list args)
{
bool stop_emission = FALSE;
/* The function name */
lua_getglobal(state, callback_name);
if (!lua_isfunction(state, -1)) {
log_error("lua error: Unknown callback '%s'", callback_name);
lua_pop(state, 1);
return FALSE;
}
script_callback_push_args(nargs, args);
/* Call the function with nargs arguments, return 1 results */
if (script_call(state, nargs, 1, NULL)) {
return FALSE;
}
/* Shall we stop the emission of this signal? */
if (lua_isboolean(state, -1)) {
stop_emission = lua_toboolean(state, -1);
}
lua_pop(state, 1); /* pop return value */
return stop_emission;
}
/**************************************************************************
Mark any, if exported, full userdata representing 'object' in
the current script state as 'Nonexistent'.
This changes the type of the lua variable.
**************************************************************************/
void script_remove_exported_object(void *object)
{
if (state) {
lua_State *L = state;
fc_assert_ret(object != NULL);
/* The following is similar to
* tolua_release(..) in src/lib/tolua_map.c
*/
/* Find the userdata representing 'object' */
lua_pushstring(L,"tolua_ubox");
lua_rawget(L, LUA_REGISTRYINDEX); /* stack: ubox */
lua_pushlightuserdata(L, object); /* stack: ubox u */
lua_rawget(L, -2); /* stack: ubox ubox[u] */
if (!lua_isnil(L, -1)) {
fc_assert(object == tolua_tousertype(L, -1, NULL));
/* Change API type to 'Nonexistent' */
tolua_getmetatable(L, "Nonexistent"); /* stack: ubox ubox[u] mt */
lua_setmetatable(L, -2);
/* Set the userdata payload to NULL */
*((void **)lua_touserdata(L, -1)) = NULL;
/* Remove from ubox */
lua_pushlightuserdata(L, object); /* stack: ubox ubox[u] u */
lua_pushnil(L); /* stack: ubox ubox[u] u nil */
lua_rawset(L, -4);
}
lua_pop(L, 2);
}
}
/**************************************************************************
Initialize the game script variables.
**************************************************************************/
static void script_vars_init(void)
{
/* nothing */
}
/**************************************************************************
Free the game script variables.
**************************************************************************/
static void script_vars_free(void)
{
/* nothing */
}
/**************************************************************************
Load the game script variables in file.
**************************************************************************/
static void script_vars_load(struct section_file *file)
{
if (state) {
const char *vars;
const char *section = "script.vars";
vars = secfile_lookup_str_default(file, "", "%s", section);
script_dostring(state, vars, section);
}
}
/**************************************************************************
Save the game script variables to file.
**************************************************************************/
static void script_vars_save(struct section_file *file)
{
if (state) {
lua_getglobal(state, "_freeciv_state_dump");
if (script_call(state, 0, 1, NULL) == 0) {
const char *vars;
vars = lua_tostring(state, -1);
lua_pop(state, 1);
if (vars) {
secfile_insert_str_noescape(file, vars, "script.vars");
}
} else {
/* _freeciv_state_dump in api.pkg is busted */
log_error("lua error: Failed to dump variables");
}
}
}
/**************************************************************************
Initialize the optional game script code (useful for scenarios).
**************************************************************************/
static void script_code_init(void)
{
script_code = NULL;
}
/**************************************************************************
Free the optional game script code (useful for scenarios).
**************************************************************************/
static void script_code_free(void)
{
if (script_code) {
free(script_code);
script_code = NULL;
}
}
/**************************************************************************
Load the optional game script code from file (useful for scenarios).
**************************************************************************/
static void script_code_load(struct section_file *file)
{
if (!script_code) {
const char *code;
const char *section = "script.code";
code = secfile_lookup_str_default(file, "", "%s", section);
script_code = fc_strdup(code);
script_dostring(state, script_code, section);
}
}
/**************************************************************************
Save the optional game script code to file (useful for scenarios).
**************************************************************************/
static void script_code_save(struct section_file *file)
{
if (script_code) {
secfile_insert_str_noescape(file, script_code, "script.code");
}
}
/**************************************************************************
Open lua libraries in the array of library definitions in llib.
**************************************************************************/
static void script_openlibs(lua_State *L, const luaL_Reg *llib)
{
for (; llib->func; llib++) {
lua_pushcfunction(L, llib->func);
lua_pushstring(L, llib->name);
lua_call(L, 1, 0);
}
}
/**************************************************************************
Remove global symbols from lua state L
**************************************************************************/
static void script_blacklist(lua_State *L, const char *lsymbols[])
{
int i;
for (i = 0; lsymbols[i] != NULL; i++) {
lua_pushnil(L);
lua_setglobal(L, lsymbols[i]);
}
}
/**************************************************************************
Initialize the scripting state.
**************************************************************************/
bool script_init(void)
{
if (!state) {
state = lua_open();
if (!state) {
return FALSE;
}
script_openlibs(state, script_lualibs);
script_traceback_func_save(state);
script_blacklist(state, script_unsafe_symbols);
tolua_api_open(state);
api_specenum_open(state);
script_code_init();
script_vars_init();
script_signals_init();
return TRUE;
} else {
return FALSE;
}
}
/**************************************************************************
Free the scripting data.
**************************************************************************/
void script_free(void)
{
if (state) {
script_code_free();
script_vars_free();
script_signals_free();
lua_gc(state, LUA_GCCOLLECT, 0); /* Collected garbage */
lua_close(state);
state = NULL;
}
}
/**************************************************************************
Load the scripting state from file.
**************************************************************************/
void script_state_load(struct section_file *file)
{
script_code_load(file);
/* Variables must be loaded after code is loaded and executed,
* so we restore their saved state properly */
script_vars_load(file);
}
/**************************************************************************
Save the scripting state to file.
**************************************************************************/
void script_state_save(struct section_file *file)
{
script_code_save(file);
script_vars_save(file);
}
|