mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Fix: [Script] Detect circular references in ScriptText

pull/10533/head
glx22 2023-03-05 17:00:57 +01:00 committed by Loïc Guilloux
parent 9a957f1d4b
commit ce8cde3b8d
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/script/api/script_text.cpp
View File

@ -159,19 +159,25 @@ SQInteger ScriptText::_set(HSQUIRRELVM vm)
const std::string ScriptText::GetEncodedText() const std::string ScriptText::GetEncodedText()
{ {
static char buf[1024]; static char buf[1024];
static StringIDList seen_ids;
int param_count = 0; int param_count = 0;
this->_GetEncodedText(buf, lastof(buf), param_count); seen_ids.clear();
this->_GetEncodedText(buf, lastof(buf), param_count, seen_ids);
if (param_count > SCRIPT_TEXT_MAX_PARAMETERS) throw Script_FatalError(fmt::format("{}: Too many parameters", GetGameStringName(this->string))); if (param_count > SCRIPT_TEXT_MAX_PARAMETERS) throw Script_FatalError(fmt::format("{}: Too many parameters", GetGameStringName(this->string)));
return buf; return buf;
} }
char *ScriptText::_GetEncodedText(char *p, char *lastofp, int &param_count) char *ScriptText::_GetEncodedText(char *p, char *lastofp, int &param_count, StringIDList &seen_ids)
{ {
const std::string &name = GetGameStringName(this->string);
if (std::find(seen_ids.begin(), seen_ids.end(), this->string) != seen_ids.end()) throw Script_FatalError(fmt::format("{}: Circular reference detected", name));
seen_ids.push_back(this->string);
p += Utf8Encode(p, SCC_ENCODED); p += Utf8Encode(p, SCC_ENCODED);
p += seprintf(p, lastofp, "%X", this->string); p += seprintf(p, lastofp, "%X", this->string);
const StringParams &params = GetGameStringParams(this->string); const StringParams &params = GetGameStringParams(this->string);
const std::string &name = GetGameStringName(this->string);
int cur_idx = 0; int cur_idx = 0;
for (const StringParam &cur_param : params) { for (const StringParam &cur_param : params) {
@ -187,7 +193,7 @@ char *ScriptText::_GetEncodedText(char *p, char *lastofp, int &param_count)
if (!std::holds_alternative<ScriptTextRef>(this->param[cur_idx])) throw Script_FatalError(fmt::format("{}: Parameter {} expects a substring", name, cur_idx)); if (!std::holds_alternative<ScriptTextRef>(this->param[cur_idx])) throw Script_FatalError(fmt::format("{}: Parameter {} expects a substring", name, cur_idx));
int count = 1; // 1 because the string id is included in consumed parameters int count = 1; // 1 because the string id is included in consumed parameters
p += seprintf(p, lastofp, ":"); p += seprintf(p, lastofp, ":");
p = std::get<ScriptTextRef>(this->param[cur_idx++])->_GetEncodedText(p, lastofp, count); p = std::get<ScriptTextRef>(this->param[cur_idx++])->_GetEncodedText(p, lastofp, count, seen_ids);
if (count != cur_param.consumes) throw Script_FatalError(fmt::format("{}: Parameter {} substring consumes {}, but expected {} to be consumed", name, cur_idx, count - 1, cur_param.consumes - 1)); if (count != cur_param.consumes) throw Script_FatalError(fmt::format("{}: Parameter {} substring consumes {}, but expected {} to be consumed", name, cur_idx, count - 1, cur_param.consumes - 1));
break; break;
} }
@ -203,6 +209,8 @@ char *ScriptText::_GetEncodedText(char *p, char *lastofp, int &param_count)
param_count += cur_param.consumes; param_count += cur_param.consumes;
} }
seen_ids.pop_back();
return p; return p;
} }

4
src/script/api/script_text.hpp
View File

@ -129,6 +129,7 @@ public:
private: private:
using ScriptTextRef = ScriptObjectRef<ScriptText>; using ScriptTextRef = ScriptObjectRef<ScriptText>;
using StringIDList = std::vector<StringID>;
StringID string; StringID string;
std::variant<SQInteger, std::string, ScriptTextRef> param[SCRIPT_TEXT_MAX_PARAMETERS]; std::variant<SQInteger, std::string, ScriptTextRef> param[SCRIPT_TEXT_MAX_PARAMETERS];
@ -140,9 +141,10 @@ private:
* @param p The current position in the buffer. * @param p The current position in the buffer.
* @param lastofp The last position valid in the buffer. * @param lastofp The last position valid in the buffer.
* @param param_count The number of parameters that are in the string. * @param param_count The number of parameters that are in the string.
* @param seen_ids The list of seen StringID.
* @return The new current position in the buffer. * @return The new current position in the buffer.
*/ */
char *_GetEncodedText(char *p, char *lastofp, int &param_count); char *_GetEncodedText(char *p, char *lastofp, int &param_count, StringIDList &seen_ids);
/** /**
* Set a parameter, where the value is the first item on the stack. * Set a parameter, where the value is the first item on the stack.