[Linux/MacOS] Split Enviroment Variable and Wrapper Option

electron/__tests__/utils.test.ts

@@ -0,0 +1,27 @@
+import { quoteIfNecessary, removeQuoteIfNecessary } from '../utils'
+
+describe('electron/utils.ts', () => {
+  test('quoteIfNeccessary', () => {
+    const testCases = new Map<string, string>([
+      ['path/without/spaces', 'path/without/spaces'],
+      ['path/with /spaces', '"path/with /spaces"'],
+      ['"path/quoted/without/spaces"', '"path/quoted/without/spaces"'],
+      ['"path/quoted/with /spaces"', '"path/quoted/with /spaces"']
+    ])
+
+    testCases.forEach((expectString, inputString) => {
+      expect(quoteIfNecessary(inputString)).toStrictEqual(expectString)
+    })
+  })
+
+  test('removeQuotesIfNeccessary', () => {
+    const testCases = new Map<string, string>([
+      ['path/without/quotes', 'path/without/quotes'],
+      ['"path/with/quotes"', 'path/with/quotes']
+    ])
+
+    testCases.forEach((expectString, inputString) => {
+      expect(removeQuoteIfNecessary(inputString)).toStrictEqual(expectString)
+    })
+  })
+})

electron/config.ts

@@ -486,7 +486,8 @@ class GlobalConfigV0 extends GlobalConfig {
       maxWorkers: 0,
       minimizeOnLaunch: false,
       nvidiaPrime: false,
-      otherOptions: '',
+      enviromentOptions: [],
+      wrapperOptions: [],
       showUnrealMarket: false,
       showFps: false,
       useGameMode: false,

electron/game_config.ts

@@ -222,7 +222,8 @@ class GameConfigV0 extends GameConfig {
       launcherArgs,
       nvidiaPrime,
       offlineMode,
-      otherOptions,
+      enviromentOptions,
+      wrapperOptions,
       savesPath,
       showFps,
       showMangohud,
@@ -248,7 +249,8 @@ class GameConfigV0 extends GameConfig {
       launcherArgs,
       nvidiaPrime,
       offlineMode,
-      otherOptions,
+      enviromentOptions: enviromentOptions,
+      wrapperOptions,
       savesPath,
       showFps,
       showMangohud,

electron/gog/games.ts

@@ -46,6 +46,7 @@ import {
 import { addShortcuts, removeShortcuts } from '../shortcuts'
 import setup from './setup'
 import { runGogdlCommand } from './library'
+import shlex from 'shlex'
 
 class GOGGame extends Game {
   public appName: string
@@ -319,15 +320,16 @@ class GOGGame extends Game {
           steamRuntime
         )
       }
+
       commandParts = [
         'launch',
         gameInfo.install.install_path,
         ...exeOverrideFlag,
         gameInfo.app_name,
         '--platform',
         `${gameInfo.install.platform}`,
-        launchArguments,
-        gameSettings.launcherArgs
+        ...shlex.split(launchArguments ?? ''),
+        ...shlex.split(gameSettings.launcherArgs ?? '')
       ]
     } else {
       const {
@@ -384,8 +386,8 @@ class GOGGame extends Game {
         ...winePrefixFlag,
         '--os',
         gameInfo.install.platform.toLowerCase(),
-        launchArguments,
-        launcherArgs
+        ...shlex.split(launchArguments ?? ''),
+        ...shlex.split(launcherArgs ?? '')
       ]
     }
 

electron/launcher.ts

@@ -19,7 +19,8 @@ import {
   showErrorBoxModalAuto,
   searchForExecutableOnPath,
   quoteIfNecessary,
-  errorHandler
+  errorHandler,
+  removeQuoteIfNecessary
 } from './utils'
 import {
   logDebug,
@@ -34,15 +35,20 @@ import { DXVK } from './tools'
 import setup from './gog/setup'
 import { GOGGame } from 'gog/games'
 import { LegendaryGame } from 'legendary/games'
-import { CallRunnerOptions, GameInfo, Runner } from './types'
 import {
+  CallRunnerOptions,
+  GameInfo,
+  Runner,
+  EnviromentVariable,
+  WrapperVariable,
   ExecResult,
   GameSettings,
   LaunchPreperationResult,
   RpcClient,
   WineInstallation
 } from './types'
 import { spawn } from 'child_process'
+import shlex from 'shlex'
 
 async function prepareLaunch(
   game: LegendaryGame | GOGGame,
@@ -240,16 +246,10 @@ function setupEnvVars(gameSettings: GameSettings) {
   if (gameSettings.audioFix) {
     ret.PULSE_LATENCY_MSEC = '60'
   }
-  if (gameSettings.otherOptions) {
-    gameSettings.otherOptions
-      .split(' ')
-      .filter((val) => val.indexOf('=') !== -1)
-      .forEach((envKeyAndVar) => {
-        const keyAndValueSplit = envKeyAndVar.split('=')
-        const key = keyAndValueSplit.shift()
-        const value = keyAndValueSplit.join('=')
-        ret[key] = value
-      })
+  if (gameSettings.enviromentOptions) {
+    gameSettings.enviromentOptions.forEach((envEntry: EnviromentVariable) => {
+      ret[envEntry.key] = removeQuoteIfNecessary(envEntry.value)
+    })
   }
 
   // setup LD_PRELOAD if not defined
@@ -305,7 +305,9 @@ function setupWineEnvVars(gameSettings: GameSettings, gameId = '0') {
     ret.PROTON_LOG_DIR = flatPakHome
 
     // Only set WINEDEBUG if PROTON_LOG is set since Proton will also log if just WINEDEBUG is set
-    if (gameSettings.otherOptions.includes('PROTON_LOG=')) {
+    if (
+      gameSettings.enviromentOptions.find((env) => env.key === 'PROTON_LOG')
+    ) {
       // Stop Proton from overriding WINEDEBUG; this prevents logs growing to a few GB for some games
       ret.WINEDEBUG = 'timestamp'
     }
@@ -338,14 +340,11 @@ function setupWrappers(
   steamRuntime: string
 ): Array<string> {
   const wrappers = Array<string>()
-  // Wrappers could be specified in the environment variable section as well
-  if (gameSettings.otherOptions) {
-    gameSettings.otherOptions
-      .split(' ')
-      .filter((val) => val.indexOf('=') === -1)
-      .forEach((val) => {
-        wrappers.push(val)
-      })
+  if (gameSettings.wrapperOptions) {
+    gameSettings.wrapperOptions.forEach((wrapperEntry: WrapperVariable) => {
+      wrappers.push(wrapperEntry.exe)
+      wrappers.push(...shlex.split(wrapperEntry.args ?? ''))
+    })
   }
   if (gameSettings.showMangohud) {
     // Mangohud needs some arguments in addition to the command, so we have to split here

electron/legendary/games.ts

@@ -38,6 +38,7 @@ import { addShortcuts, removeShortcuts } from '../shortcuts'
 import { basename, join } from 'path'
 import { runLegendaryCommand } from './library'
 import { gameInfoStore } from './electronStores'
+import shlex from 'shlex'
 
 class LegendaryGame extends Game {
   public appName: string
@@ -584,6 +585,7 @@ class LegendaryGame extends Game {
           ...commandEnv,
           ...setupEnvVars(gameSettings)
         }
+
         wrappers = setupWrappers(
           gameSettings,
           mangoHudCommand,
@@ -599,8 +601,8 @@ class LegendaryGame extends Game {
         ...languageFlag,
         ...exeOverrideFlag,
         offlineFlag,
-        launchArguments,
-        gameSettings.launcherArgs
+        ...shlex.split(launchArguments ?? ''),
+        ...shlex.split(gameSettings.launcherArgs ?? '')
       ]
     } else {
       // -> We're using Wine/Proton/CX on either Linux or Mac
@@ -622,6 +624,7 @@ class LegendaryGame extends Game {
         ...setupEnvVars(gameSettings),
         ...wineEnvVars
       }
+
       wrappers = setupWrappers(
         gameSettings,
         mangoHudCommand,
@@ -666,8 +669,8 @@ class LegendaryGame extends Game {
         offlineFlag,
         ...wineFlag,
         ...winePrefixFlag,
-        launchArguments,
-        launcherArgs
+        ...shlex.split(launchArguments ?? ''),
+        ...shlex.split(launcherArgs ?? '')
       ]
     }
 

electron/main.ts

@@ -4,7 +4,9 @@ import {
   GamepadInputEventKey,
   GamepadInputEventWheel,
   GamepadInputEventMouse,
-  Runner
+  Runner,
+  AppSettings,
+  GameSettings
 } from './types'
 import * as path from 'path'
 import {
@@ -93,6 +95,7 @@ import { logError, logInfo, LogPrefix, logWarning } from './logger/logger'
 import { gameInfoStore } from './legendary/electronStores'
 import { getFonts } from 'font-list'
 import { verifyWinePrefix } from './launcher'
+import shlex from 'shlex'
 
 const { showMessageBox, showOpenDialog } = dialog
 const isWindows = platform() === 'win32'
@@ -721,11 +724,53 @@ ipcMain.handle('readConfig', async (event, config_class) => {
 })
 
 ipcMain.handle('requestSettings', async (event, appName) => {
+  // To the changes how we handle env and wrappers
+  // otherOptions is deprectaed and needs to be mapped
+  // to new approach.
+  // Can be removed if otherOptions is removed aswell
+  const mapOtherSettings = (config: AppSettings | GameSettings) => {
+    if (config.otherOptions) {
+      if (config.enviromentOptions.length <= 0) {
+        config.otherOptions
+          .split(' ')
+          .filter((val) => val.indexOf('=') !== -1)
+          .forEach((envKeyAndVar) => {
+            const keyAndValueSplit = envKeyAndVar.split('=')
+            const key = keyAndValueSplit.shift()
+            const value = keyAndValueSplit.join('=')
+            config.enviromentOptions.push({ key, value })
+          })
+      }
+
+      if (config.wrapperOptions.length <= 0) {
+        const args = [] as string[]
+        config.otherOptions
+          .split(' ')
+          .filter((val) => val.indexOf('=') === -1)
+          .forEach((val, index) => {
+            if (index === 0) {
+              config.wrapperOptions.push({ exe: val, args: '' })
+            } else {
+              args.push(val)
+            }
+          })
+
+        if (config.wrapperOptions.at(0)) {
+          config.wrapperOptions.at(0).args = shlex.join(args)
+        }
+      }
+
+      delete config.otherOptions
+    }
+    return config
+  }
+
   if (appName === 'default') {
-    return GlobalConfig.get().config
+    return mapOtherSettings(GlobalConfig.get().config)
   }
   // We can't use .config since apparently its not loaded fast enough.
-  return GameConfig.get(appName).getSettings()
+  const config = await GameConfig.get(appName).getSettings()
+  return mapOtherSettings(config)
 })
 
 ipcMain.on('toggleDXVK', (event, [{ winePrefix, winePath }, action]) => {

electron/types.ts

@@ -39,7 +39,9 @@ export interface AppSettings {
   minimizeOnLaunch: boolean
   nvidiaPrime: boolean
   offlineMode: boolean
-  otherOptions: string
+  otherOptions: string //depricated
+  enviromentOptions: EnviromentVariable[]
+  wrapperOptions: WrapperVariable[]
   savesPath: string
   showFps: boolean
   showMangohud: boolean
@@ -145,7 +147,9 @@ export interface GameSettings {
   launcherArgs: string
   nvidiaPrime: boolean
   offlineMode: boolean
-  otherOptions: string
+  otherOptions: string //deprecated
+  enviromentOptions: EnviromentVariable[]
+  wrapperOptions: WrapperVariable[]
   savesPath: string
   showFps: boolean
   showMangohud: boolean
@@ -373,6 +377,16 @@ export interface CallRunnerOptions {
   onOutput?: (output: string, child: ChildProcess) => void
 }
 
+export interface EnviromentVariable {
+  key: string
+  value: string
+}
+
+export interface WrapperVariable {
+  exe: string
+  args: string
+}
+
 export type AntiCheatStatus =
   | 'Planned'
   | 'Denied'

electron/utils.ts

@@ -551,6 +551,10 @@ function quoteIfNecessary(stringToQuote: string) {
   return stringToQuote
 }
 
+function removeQuoteIfNecessary(stringToUnquote: string) {
+  return stringToUnquote.replace(/^"+/, '').replace(/"+$/, '')
+}
+
 function killPattern(pattern: string) {
   logInfo(['Trying to kill', pattern], LogPrefix.Backend)
   let ret
@@ -587,5 +591,6 @@ export {
   getSteamRuntime,
   constructAndUpdateRPC,
   quoteIfNecessary,
+  removeQuoteIfNecessary,
   killPattern
 }

package.json

@@ -159,6 +159,7 @@
     "react-i18next": "^11.16.7",
     "react-router-dom": "^6.3.0",
     "react-scripts": "^5.0.1",
+    "shlex": "^2.1.2",
     "simple-keyboard": "^3.4.24",
     "source-map-support": "^0.5.21",
     "systeminformation": "^5.11.14",