cpp/openttd-patchpack/source Changeset - r28821:565dadbd1dcb

Changeset - r28821:565dadbd1dcb

Parent rev.

Child rev.

[Not reviewed]

master

0 2 0

Loïc Guilloux - 9 months ago 2024-02-27 17:16:21
glx22@users.noreply.github.com

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

2 files changed with 18 insertions and 17 deletions:

src/script/api/script_text.cpp

src/script/api/script_text.hpp

0 comments (0 inline, 0 general)

src/script/api/script_text.cpp

➞

Show inline comments

@@ @@ -151,61 +151,63 @@ SQInteger ScriptText::_set(HSQUIRRELVM v @@
 		return SQ_ERROR;
+	}
 	if (k > SCRIPT_TEXT_MAX_PARAMETERS) return SQ_ERROR;
 	if (k < 1) return SQ_ERROR;
 	k--;
 	return this->_SetParam(k, vm);
+}
 std::string ScriptText::GetEncodedText()
+{
-	StringIDList seen_ids;
+	ScriptTextList seen_texts;
 	ParamList params;
 	int param_count = 0;
 	std::string result;
 	auto output = std::back_inserter(result);
 	this->_FillParamList(params);
 	this->_GetEncodedText(output, param_count, seen_ids, params);
 	this->_FillParamList(params, seen_texts);
 	this->_GetEncodedText(output, param_count, params);
 	if (param_count > SCRIPT_TEXT_MAX_PARAMETERS) throw Script_FatalError(fmt::format("{}: Too many parameters", GetGameStringName(this->string)));
 	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++) {
 		Param *p = &this->param[i];
 		params.emplace_back(this->string, i, p);
 		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)
+{
 	if (this->used) return;
 	if (std::holds_alternative<std::string>(*this->param)) fmt::format_to(output, ":\"{}\"", std::get<std::string>(*this->param));
 	if (std::holds_alternative<SQInteger>(*this->param)) fmt::format_to(output, ":{:X}", std::get<SQInteger>(*this->param));
 	if (std::holds_alternative<ScriptTextRef>(*this->param)) fmt::format_to(output, ":{:X}", this->owner);
 	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);
 	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);
 	fmt::format_to(output, "{:X}", this->string);
 	const StringParams &params = GetGameStringParams(this->string);
 	size_t idx = 0;
 	auto get_next_arg = [&]() {
 		if (idx >= args.size()) throw Script_FatalError(fmt::format("{}({}): Not enough parameters", name, param_count + 1));
 		ParamCheck &pc = args[idx++];
 		if (pc.owner != this->string) ScriptLog::Warning(fmt::format("{}({}): Consumes {}({})", name, param_count + 1, GetGameStringName(pc.owner), pc.idx + 1));
 		return &pc;
 	};
@@ @@ -225,42 +227,40 @@ void ScriptText::_GetEncodedText(std::ba @@
+			}
 			case StringParam::STRING: {
 				ParamCheck &p = *get_next_arg();
 				if (!std::holds_alternative<ScriptTextRef>(*p.param)){
 					ScriptLog::Error(fmt::format("{}({}): {{{}}} expects a GSText", name, param_count + 1, cur_param.cmd));
 					p.Encode(output);
 					break;
+				}
 				int count = 0;
 				fmt::format_to(output, ":");
 				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;
 				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));
 					/* Fill missing params if needed. */
 					for (int i = count; i < cur_param.consumes; i++) fmt::format_to(output, ":0");
+				}
 				skip_args(cur_param.consumes - 1);
 				break;
+			}
 			default:
 				for (int i = 0; i < cur_param.consumes; i++) {
 					ParamCheck &p = *get_next_arg();
 					if (!std::holds_alternative<SQInteger>(*p.param)) ScriptLog::Error(fmt::format("{}({}): {{{}}} expects an integer", name, param_count + i + 1, cur_param.cmd));
 					p.Encode(output);
+				}
+		}
 		param_count += cur_param.consumes;
+	}
 	seen_ids.pop_back();
+}
 const std::string Text::GetDecodedText()
+{
 	::SetDParamStr(0, this->GetEncodedText());
 	return ::GetString(STR_JUST_RAW_STRING);
+}

src/script/api/script_text.hpp

➞

Show inline comments

@@ @@ -120,25 +120,25 @@ public: @@
 	 * @return The same object as on which this is called, so you can chain.
 	 */
 	ScriptText *AddParam(Object value);
 #endif /* DOXYGEN_API */
 	/**
 	 * @api -all
 	 */
 	std::string GetEncodedText() override;
 private:
 	using ScriptTextRef = ScriptObjectRef<ScriptText>;
-	using StringIDList = std::vector<StringID>;
+	using ScriptTextList = std::vector<ScriptText *>;
 	using Param = std::variant<SQInteger, std::string, ScriptTextRef>;
 	struct ParamCheck {
 		StringID owner;
 		int idx;
 		Param *param;
 		bool used;
 		ParamCheck(StringID owner, int idx, Param *param) : owner(owner), idx(idx), param(param), used(false) {}
 		void Encode(std::back_insert_iterator<std::string> &output);
 	};
@@ @@ -146,31 +146,32 @@ private: @@
 	using ParamList = std::vector<ParamCheck>;
 	using ParamSpan = std::span<ParamCheck>;
 	StringID string;
 	Param param[SCRIPT_TEXT_MAX_PARAMETERS];
 	int paramc;
 	/**
 	 * Internal function to recursively fill a list of parameters.
 	 * The parameters are added as _GetEncodedText used to encode them
 	 *  before the addition of parameter validation.
 	 * @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
 	 *  instances, while writing in the same buffer.
 	 * @param output The output to write the encoded text to.
 	 * @param param_count The number of parameters that are in the string.
 	 * @param seen_ids The list of seen StringID.
 	 * @param param_count The number of parameters that are consumed by the string.
 	 * @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.
 	 */
 	SQInteger _SetParam(int k, HSQUIRRELVM vm);
 };
 #endif /* SCRIPT_TEXT_HPP */

0 comments (0 inline, 0 general)