Add core.strip_escapes() (#16485)

builtin/common/misc_helpers.lua

@@ -658,7 +658,7 @@ function core.colorize(color, message)
 		lines[i] = color_code .. line
 	end
 
-	return table.concat(lines, "\n") .. core.get_color_escape_sequence("#ffffff")
+	return table.concat(lines, "\n") .. core.get_color_escape_sequence("#fff")
 end
 
 
@@ -674,6 +674,7 @@ function core.strip_colors(str)
 	return (str:gsub(ESCAPE_CHAR .. "%([bc]@[^)]+%)", ""))
 end
 
+
 local function translate(textdomain, str, num, ...)
 	local start_seq
 	if textdomain == "" and num == "" then

builtin/profiler/reporter.lua

@@ -182,7 +182,7 @@ local function format_statistics(profile, format, filter, enable_translation)
 	formatter:format(filter)
 	local out = formatter:flush()
 	if not enable_translation then
-		out = core.get_translated_string("en", out)
+		out = core.strip_escapes(out)
 	end
 	return out
 end

doc/lua_api.md

@@ -3920,10 +3920,8 @@ The following functions provide escape sequences:
     * `color` is a ColorString
     * The escape sequence sets the text color to `color`
 * `core.colorize(color, message)`:
-    * Equivalent to:
-      `core.get_color_escape_sequence(color) ..
-      message ..
-      core.get_color_escape_sequence("#ffffff")`
+    * Equivalent to including the right color escape sequence in the front,
+      and resetting to `#fff` after the text (plus newline handling).
 * `core.get_background_escape_sequence(color)`
     * `color` is a ColorString
     * The escape sequence sets the background of the whole text element to
@@ -3934,6 +3932,10 @@ The following functions provide escape sequences:
     * Removes background colors added by `get_background_escape_sequence`.
 * `core.strip_colors(str)`
     * Removes all color escape sequences.
+* `core.strip_escapes(str)`
+    * Removes all escape sequences, including client-side translations and
+      any unknown or future escape sequences that Luanti might define.
+    * You can use this to clean text before logging or handing to an external system.
 
 
 Coordinate System

src/script/lua_api/l_util.cpp

@@ -695,6 +695,17 @@ int ModApiUtil::l_is_valid_player_name(lua_State *L)
 	return 1;
 }
 
+// strip_escapes(str)
+int ModApiUtil::l_strip_escapes(lua_State *L)
+{
+	NO_MAP_LOCK_REQUIRED;
+
+	auto s = readParam<std::string_view>(L, 1);
+	auto r = unescape_enriched(s);
+	lua_pushlstring(L, r.c_str(), r.size());
+	return 1;
+}
+
 void ModApiUtil::Initialize(lua_State *L, int top)
 {
 	API_FCT(log);
@@ -746,6 +757,7 @@ void ModApiUtil::Initialize(lua_State *L, int top)
 
 	API_FCT(urlencode);
 	API_FCT(is_valid_player_name);
+	API_FCT(strip_escapes);
 
 	LuaSettings::create(L, g_settings, g_settings_path);
 	lua_setfield(L, top, "settings");
@@ -780,6 +792,7 @@ void ModApiUtil::InitializeClient(lua_State *L, int top)
 	API_FCT(set_last_run_mod);
 
 	API_FCT(urlencode);
+	API_FCT(strip_escapes);
 
 	LuaSettings::create(L, g_settings, g_settings_path);
 	lua_setfield(L, top, "settings");
@@ -828,6 +841,7 @@ void ModApiUtil::InitializeAsync(lua_State *L, int top)
 	API_FCT(set_last_run_mod);
 
 	API_FCT(urlencode);
+	API_FCT(strip_escapes);
 
 	LuaSettings::create(L, g_settings, g_settings_path);
 	lua_setfield(L, top, "settings");

src/script/lua_api/l_util.h

@@ -127,6 +127,9 @@ private:
 	// is_valid_player_name(name)
 	static int l_is_valid_player_name(lua_State *L);
 
+	// strip_escapes(str)
+	static int l_strip_escapes(lua_State *L);
+
 public:
 	static void Initialize(lua_State *L, int top);
 	static void InitializeAsync(lua_State *L, int top);

src/unittest/test_scriptapi.cpp

@@ -17,7 +17,7 @@ namespace {
 	public:
 		MyScriptApi() : ScriptApiBase(ScriptingType::Async) {};
 		void init();
-		using ScriptApiBase::getStack;
+		using ScriptApiBase::getStack; // make public
 	};
 }
 

src/unittest/test_utilities.cpp

@@ -335,6 +335,8 @@ void TestUtilities::testRemoveEscapes()
 		L"abc\x1b(escaped)def") == L"abcdef");
 	UASSERT(unescape_enriched<wchar_t>(
 		L"abc\x1b((escaped with parenthesis\\))def") == L"abcdef");
+	UASSERTEQ(auto, unescape_enriched("abc\x1b(not this\\\\)def"),
+		"abcdef");
 	UASSERT(unescape_enriched<wchar_t>(
 		L"abc\x1b(incomplete") == L"abc");
 	UASSERT(unescape_enriched<wchar_t>(
@@ -342,6 +344,9 @@ void TestUtilities::testRemoveEscapes()
 	// Nested escapes not supported
 	UASSERT(unescape_enriched<wchar_t>(
 		L"abc\x1b(outer \x1b(inner escape)escape)def") == L"abcescape)def");
+	// Multiple
+	UASSERTEQ(auto, unescape_enriched("one\x1bX two \x1b(four)three"),
+		"one two three");
 }
 
 void TestUtilities::testWrapRows()

src/util/string.h

@@ -592,27 +592,25 @@ inline std::basic_string<T> unescape_string(const std::basic_string<T> &s)
  */
 template <typename T>
 [[nodiscard]]
-std::basic_string<T> unescape_enriched(const std::basic_string<T> &s)
+std::basic_string<T> unescape_enriched(std::basic_string_view<T> s)
 {
 	std::basic_string<T> output;
 	output.reserve(s.size());
 	size_t i = 0;
 	while (i < s.length()) {
-		if (s[i] == '\x1b') {
+		if (s[i] == static_cast<T>('\x1b')) {
 			++i;
-			if (i == s.length()) continue;
-			if (s[i] == '(') {
+			if (i == s.length())
+				continue;
+			if (s[i] == static_cast<T>('(')) {
 				++i;
-				while (i < s.length() && s[i] != ')') {
-					if (s[i] == '\\') {
+				while (i < s.length() && s[i] != static_cast<T>(')')) {
+					if (s[i] == static_cast<T>('\\'))
 						++i;
-					}
 					++i;
 				}
-				++i;
-			} else {
-				++i;
 			}
+			++i;
 			continue;
 		}
 		output += s[i];
@@ -621,6 +619,18 @@ std::basic_string<T> unescape_enriched(const std::basic_string<T> &s)
 	return output;
 }
 
+// (same templating issue here)
+[[nodiscard]]
+inline std::string unescape_enriched(std::string_view s)
+{
+	return unescape_enriched<char>(s);
+}
+[[nodiscard]]
+inline std::wstring unescape_enriched(std::wstring_view s)
+{
+	return unescape_enriched<wchar_t>(s);
+}
+
 template <typename T>
 [[nodiscard]]
 std::vector<std::basic_string<T> > split(const std::basic_string<T> &s, T delim)