fix(core): fix custom locale.json broken by the sandboxed ScRT

Author: tabarra

.gitignore

@@ -11,6 +11,7 @@ monitor-*.zip
 bundle_size_report.html
 .github/.cienv
 scripts/**/*.local.*
+.runtime/
 
 # IDE Specific
 .idea

core/modules/FxRunner/index.ts

@@ -8,7 +8,7 @@ import { resolveCFGFilePath, validateFixServerConfig } from '@lib/fxserver/fxsCo
 import { msToShortishDuration } from '@lib/misc';
 import { SYM_SYSTEM_AUTHOR } from '@lib/symbols';
 import { UpdateConfigKeySet } from '@modules/ConfigStore/utils';
-import { childProcessEventBlackHole, getFxSpawnVariables, getMutableConvars, isValidChildProcess, mutableConvarConfigDependencies, stringifyConsoleArgs } from './utils';
+import { childProcessEventBlackHole, getFxSpawnVariables, getMutableConvars, isValidChildProcess, mutableConvarConfigDependencies, setupCustomLocaleFile, stringifyConsoleArgs } from './utils';
 import ProcessManager, { ChildProcessStateInfo } from './ProcessManager';
 import handleFd3Messages from './handleFd3Messages';
 import ConsoleLineEnum from '@modules/Logger/FXServerLogger/ConsoleLineEnum';
@@ -41,7 +41,7 @@ export default class FxRunner {
      * Triggers a convar update
      */
     public handleConfigUpdate(updatedConfigs: UpdateConfigKeySet) {
-        this.updateMutableConvars();
+        this.updateMutableConvars().catch(() => { });
     }
 
 
@@ -116,7 +116,7 @@ export default class FxRunner {
             return msg;
         }
 
-        //Setup spawn variables
+        //Setup spawn variables & locale file
         let fxSpawnVars;
         const newServerMutex = genMutex();
         try {
@@ -128,6 +128,13 @@ export default class FxRunner {
             console.error(errMsg);
             return errMsg;
         }
+        try {
+            await setupCustomLocaleFile();
+        } catch (error) {
+            const errMsg = `Error copying custom locale: ${(error as any).message}`;
+            console.error(errMsg);
+            return errMsg;
+        }
 
         //If there is any FXServer configuration missing
         if (!this.isConfigured) {
@@ -355,9 +362,10 @@ export default class FxRunner {
      * Useful for when we change txAdmin settings and want it to reflect on the server.
      * This will also fire the `txAdmin:event:configChanged`
      */
-    private updateMutableConvars() {
+    private async updateMutableConvars() {
         console.log('Updating FXServer ConVars.');
         try {
+            await setupCustomLocaleFile();
             const convarList = getMutableConvars(false);
             for (const [set, convar, value] of convarList) {
                 this.sendCommand(set, [convar, value], SYM_SYSTEM_AUTHOR);

core/modules/FxRunner/utils.ts

@@ -1,3 +1,4 @@
+import fsp from 'node:fs/promises';
 import type { ChildProcessWithoutNullStreams } from "node:child_process";
 import { Readable, Writable } from "node:stream";
 import { txEnv, txHostConfig } from "@core/globalData";
@@ -28,7 +29,6 @@ export const getMutableConvars = (isCmdLine = false) => {
     const checkPlayerJoin = txConfig.banlist.enabled || txConfig.whitelist.mode !== 'disabled';
     const convars: RawConvarSetTuple[] = [
         ['setr', 'locale', txConfig.general.language ?? 'en'],
-        ['set', 'localeFile', txCore.translator.customLocalePath],
         ['set', 'serverName', txConfig.general.serverName ?? 'txAdmin'],
         ['set', 'checkPlayerJoin', checkPlayerJoin],
         ['set', 'menuAlignRight', txConfig.gameFeatures.menuAlignRight],
@@ -220,3 +220,28 @@ export const stringifyConsoleArgs = (args: (string | number | object)[]) => {
 
     return cleanArgs.join(' ');
 }
+
+
+/**
+ * Copies the custom locale file from txData to the 'monitor' path, due to sandboxing.
+ */
+export const setupCustomLocaleFile = async () => {
+    const srcPath = txCore.translator.customLocalePath;
+    const destRuntimePath = path.resolve(txEnv.txaPath, '.runtime');
+    const destFilePath = path.resolve(destRuntimePath, 'locale.json');
+    const isCustomLocale = txConfig.general.language === 'custom';
+    const action = isCustomLocale ? 'copy' : 'remove';
+    try {
+        if (txConfig.general.language === 'custom') {
+            await fsp.mkdir(destRuntimePath, { recursive: true });
+            await fsp.copyFile(srcPath, destFilePath);
+        } else {
+            await fsp.unlink(destFilePath);
+        }
+    } catch (error) {
+        const logger = isCustomLocale
+            ? console.tag('FXRunner').error
+            : console.tag('FXRunner').verbose.warn;
+        logger(`Failed to ${action} custom locale file: ${(error as any).message}`);
+    }
+}

docs/dev-notes.md

@@ -109,13 +109,10 @@ Legend:
 ## Other stuff
 - [x] new env vars
 - [x] remove dynamicAds from the modules
+- [x] fix custom locale
 - [!] add stats tracking for the framework team (ask them, idk)
 - [!] package updates - test radix stuff
 - [!] commit stashed stuff
-- [!] fix custom locale
-    - see if it's viable to use `fsp.link()` or `fsp.symlink()`
-    - https://nodejs.org/docs/latest-v16.x/api/fs.html#fspromiseslinkexistingpath-newpath
-    - https://nodejs.org/docs/latest-v16.x/api/fs.html#fspromisessymlinktarget-path-type
 - [!] check txAdmin-private
 - [ ] implement `cleanFullPath.ts` in settings save ui & api for comparison consistency
     - [ ] add it to `setup/save.js -> handleValidateLocalDataFolder()` as well

resource/sv_ctx.lua

@@ -19,21 +19,24 @@ local ServerCtxObj = {
   announceNotiPos = '', -- top-center, top-right, top-left, bottom-center, bottom-right, bottom-left
 }
 
-local function getCustomLocaleData()
-  --Get convar
-  local filePath = GetConvar('txAdmin-localeFile', 'false')
-  if filePath == 'false' then
-    return false
-  end
+-- local function getRawCustomLocaleData()
+--   LoadResourceFile('monitor', '.runtime/locale.json', function(fileData)
+--     if not fileData then
+--       txPrint('^2Loaded custom locale file.')
+--     else
+--       txPrint('^1WARNING: failed to load custom locale from path: '..filePath)
+--     end
+--   end)
+
+--   return fileData
+-- end
 
-  -- Get file data
-  local fileHandle = io.open(filePath, "rb")
-  if not fileHandle then
-    txPrint('^1WARNING: failed to load custom locale from path: '..filePath)
+local function getCustomLocaleData()
+  local fileData = LoadResourceFile('monitor', '.runtime/locale.json')
+  if type(fileData) ~="string" then
+    txPrint('^1WARNING: failed to load custom \'locale.json\' file.')
     return false
   end
-  local fileData = fileHandle:read "*a"
-  fileHandle:close()
 
   -- Parse and validate data
   local locale = json.decode(fileData)
@@ -43,7 +46,7 @@ local function getCustomLocaleData()
     or type(locale['nui_warning']) ~= "table"
     or type(locale['nui_menu']) ~= "table"
   then
-    txPrint('^1WARNING: load or validate custom locale JSON data from path: '..filePath)
+    txPrint('^1WARNING: failed to validate custom locale JSON.')
     return false
   end