Archives/OpenTTD-patches
2
0
Fork 0
mirror of https://github.com/JGRennison/OpenTTD-patches.git synced 2024-10-31 15:20:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix bf4b6696: [Script] Broken ScriptText circular reference detection (#12187)

Browse Source
This commit is contained in:
Loïc Guilloux 2024-02-27 18:16:21 +01:00 committed by GitHub
parent 2fb1593550
commit f612bc6ee2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -160,25 +160,30 @@ SQInteger ScriptText::_set(HSQUIRRELVM vm)
std::string ScriptText::GetEncodedText() std::string ScriptText::GetEncodedText()
{ {
StringIDList seen_ids; ScriptTextList seen_texts;
ParamList params; ParamList params;
int param_count = 0; int param_count = 0;
std::string result; std::string result;
auto output = std::back_inserter(result); auto output = std::back_inserter(result);
this->_FillParamList(params); this->_FillParamList(params, seen_texts);
this->_GetEncodedText(output, param_count, seen_ids, params); this->_GetEncodedText(output, param_count, params);
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 result; return result;
} }
void ScriptText::_FillParamList(ParamList &params) void ScriptText::_FillParamList(ParamList &params, ScriptTextList &seen_texts)
{ {
if (std::find(seen_texts.begin(), seen_texts.end(), this) != seen_texts.end()) throw Script_FatalError(fmt::format("{}: Circular reference detected", GetGameStringName(this->string)));
seen_texts.push_back(this);
for (int i = 0; i < this->paramc; i++) { for (int i = 0; i < this->paramc; i++) {
Param *p = &this->param[i]; Param *p = &this->param[i];
params.emplace_back(this->string, i, p); params.emplace_back(this->string, i, p);
if (!std::holds_alternative<ScriptTextRef>(*p)) continue; if (!std::holds_alternative<ScriptTextRef>(*p)) continue;
std::get<ScriptTextRef>(*p)->_FillParamList(params); std::get<ScriptTextRef>(*p)->_FillParamList(params, seen_texts);
} }
seen_texts.pop_back();
} }
void ScriptText::ParamCheck::Encode(std::back_insert_iterator<std::string> &output) void ScriptText::ParamCheck::Encode(std::back_insert_iterator<std::string> &output)
@ -190,13 +195,10 @@ void ScriptText::ParamCheck::Encode(std::back_insert_iterator<std::string> &outp
this->used = true; this->used = true;
} }
void ScriptText::_GetEncodedText(std::back_insert_iterator<std::string> &output, int &param_count, StringIDList &seen_ids, ParamSpan args) void ScriptText::_GetEncodedText(std::back_insert_iterator<std::string> &output, int &param_count, ParamSpan args)
{ {
const std::string &name = GetGameStringName(this->string); 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);
Utf8Encode(output, SCC_ENCODED); Utf8Encode(output, SCC_ENCODED);
fmt::format_to(output, "{:X}", this->string); fmt::format_to(output, "{:X}", this->string);
@ -234,7 +236,7 @@ void ScriptText::_GetEncodedText(std::back_insert_iterator<std::string> &output,
int count = 0; int count = 0;
fmt::format_to(output, ":"); fmt::format_to(output, ":");
ScriptTextRef &ref = std::get<ScriptTextRef>(*p.param); ScriptTextRef &ref = std::get<ScriptTextRef>(*p.param);
ref->_GetEncodedText(output, count, seen_ids, args.subspan(idx)); ref->_GetEncodedText(output, count, args.subspan(idx));
p.used = true; p.used = true;
if (++count != cur_param.consumes) { if (++count != cur_param.consumes) {
ScriptLog::Error(fmt::format("{}({}): {{{}}} expects {} to be consumed, but {} consumes {}", name, param_count + 1, cur_param.cmd, cur_param.consumes - 1, GetGameStringName(ref->string), count - 1)); ScriptLog::Error(fmt::format("{}({}): {{{}}} expects {} to be consumed, but {} consumes {}", name, param_count + 1, cur_param.cmd, cur_param.consumes - 1, GetGameStringName(ref->string), count - 1));
@ -255,8 +257,6 @@ void ScriptText::_GetEncodedText(std::back_insert_iterator<std::string> &output,
param_count += cur_param.consumes; param_count += cur_param.consumes;
} }
seen_ids.pop_back();
} }
const std::string Text::GetDecodedText() const std::string Text::GetDecodedText()

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

@ -129,7 +129,7 @@ public:
private: private:
using ScriptTextRef = ScriptObjectRef<ScriptText>; using ScriptTextRef = ScriptObjectRef<ScriptText>;
using StringIDList = std::vector<StringID>; using ScriptTextList = std::vector<ScriptText *>;
using Param = std::variant<SQInteger, std::string, ScriptTextRef>; using Param = std::variant<SQInteger, std::string, ScriptTextRef>;
struct ParamCheck { struct ParamCheck {
@ -155,17 +155,18 @@ private:
* The parameters are added as _GetEncodedText used to encode them * The parameters are added as _GetEncodedText used to encode them
* before the addition of parameter validation. * before the addition of parameter validation.
* @param params The list of parameters to fill. * @param params The list of parameters to fill.
* @param seen_texts The list of seen ScriptText.
*/ */
void _FillParamList(ParamList &params); void _FillParamList(ParamList &params, ScriptTextList &seen_texts);
/** /**
* Internal function for recursive calling this function over multiple * Internal function for recursive calling this function over multiple
* instances, while writing in the same buffer. * instances, while writing in the same buffer.
* @param output The output to write the encoded text to. * @param output The output to write the encoded text to.
* @param param_count The number of parameters that are in the string. * @param param_count The number of parameters that are consumed by the string.
* @param seen_ids The list of seen StringID. * @param args The parameters to be consumed.
*/ */
void _GetEncodedText(std::back_insert_iterator<std::string> &output, int &param_count, StringIDList &seen_ids, ParamSpan args); void _GetEncodedText(std::back_insert_iterator<std::string> &output, int &param_count, ParamSpan args);
/** /**
* 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.