Files
SPT-Server-Build/Libraries/SPTarkov.Server.Core/Services/LocaleService.cs
T
Archangel 3419368f53 Add Transformer to Lazyload, get rid of event
This will break mods and their examples!

In addition:
- Removes being able to add custom locales, modders should do .AddTransformer on the LazyLoaded value in the database!
- Fixes up PostDBLoad methods trying to use .Value which won't work as this data will be unloaded after 30 seconds
- Move all other SPT code to use .AddTransformer
2025-06-15 19:08:38 +02:00

213 lines
7.0 KiB
C#

using System.Globalization;
using SPTarkov.DI.Annotations;
using SPTarkov.Server.Core.Models.Spt.Config;
using SPTarkov.Server.Core.Models.Utils;
using SPTarkov.Server.Core.Servers;
namespace SPTarkov.Server.Core.Services;
[Injectable(InjectionType.Singleton)]
public class LocaleService(
ISptLogger<LocaleService> _logger,
DatabaseServer _databaseServer,
ConfigServer _configServer
)
{
protected readonly LocaleConfig _localeConfig = _configServer.GetConfig<LocaleConfig>();
/// <summary>
/// Get the eft globals db file based on the configured locale in config/locale.json, if not found, fall back to 'en'
/// </summary>
/// <returns> Dictionary of locales for desired language - en/fr/cn </returns>
public Dictionary<string, string> GetLocaleDb(string? language = null)
{
var languageToUse = string.IsNullOrEmpty(language)
? GetDesiredGameLocale()
: language;
// if it can't get locales for language provided, default to en
if (TryGetLocaleDb(languageToUse, out var localeToReturn) || TryGetLocaleDb("en", out localeToReturn))
{
return localeToReturn;
}
throw new Exception($"unable to get locales from either {languageToUse} or en");
}
/// <summary>
/// Attempts to retrieve the locale database for the specified language key
/// </summary>
/// <param name="languageKey">The language key for which the locale database should be retrieved.</param>
/// <param name="localeToReturn">The resulting locale database as a dictionary, or null if the operation fails.</param>
/// <returns>True if the locale database was successfully retrieved, otherwise false.</returns>
protected bool TryGetLocaleDb(string languageKey, out Dictionary<string, string>? localeToReturn)
{
localeToReturn = null;
if (!_databaseServer.GetTables().Locales.Global.TryGetValue(languageKey, out var keyedLocales))
{
return false;
}
localeToReturn = keyedLocales.Value;
return true;
}
/// <summary>
/// Gets the game locale key from the locale.json file,
/// if value is 'system' get system-configured locale
/// </summary>
/// <returns> Locale e.g en/ge/cz/cn </returns>
public string GetDesiredGameLocale()
{
return string.Equals(_localeConfig.GameLocale, "system", StringComparison.OrdinalIgnoreCase)
? GetPlatformForClientLocale()
: _localeConfig.GameLocale.ToLower(); // Use custom locale value
}
/// <summary>
/// Gets the game locale key from the locale.json file,
/// if value is 'system' get system locale
/// </summary>
/// <returns> Locale e.g en/ge/cz/cn </returns>
public string GetDesiredServerLocale()
{
return string.Equals(_localeConfig.ServerLocale, "system", StringComparison.OrdinalIgnoreCase)
? GetPlatformForServerLocale()
: _localeConfig.ServerLocale.ToLower(); // Use custom locale value
}
/// <summary>
/// Get array of languages supported for localisation
/// </summary>
/// <returns> List of locales e.g. en/fr/cn </returns>
public List<string> GetServerSupportedLocales()
{
return _localeConfig.ServerSupportedLocales;
}
/// <summary>
/// Get array of languages supported for localisation
/// </summary>
/// <returns> Dictionary of locales e.g. en/fr/cn </returns>
public Dictionary<string, string> GetLocaleFallbacks()
{
return _localeConfig.Fallbacks;
}
/// <summary>
/// Get the full locale of the computer running the server lowercased e.g. en-gb / pt-pt
/// </summary>
/// <returns> System locale as String </returns>
public string GetPlatformForServerLocale()
{
var platformLocale = GetPlatformLocale();
if (platformLocale == null)
{
_logger.Warning("System language not found, falling back to english");
return "en";
}
var baseNameCode = platformLocale.TwoLetterISOLanguageName.ToLower();
if (_localeConfig.ServerSupportedLocales.Contains(baseNameCode))
{
// Found a matching locale
return baseNameCode;
}
// Check if base language (e.g. CN / EN / DE) exists
var languageCode = platformLocale.Name.ToLower();
if (_localeConfig.ServerSupportedLocales.Contains(languageCode))
{
if (baseNameCode == "zh")
// Handle edge case of zh
{
return "zh-cn";
}
return languageCode;
}
if (baseNameCode == "pt")
// Handle edge case of pt
{
return "pt-pt";
}
_logger.Warning($"Unsupported system language found: {baseNameCode}, langCode: {languageCode} falling back to english for server locale");
return "en";
}
/// <summary>
/// Get the locale of the computer running the server
/// </summary>
/// <returns> Language part of locale e.g. 'en' part of 'en-US' </returns>
protected string GetPlatformForClientLocale()
{
var platformLocale = GetPlatformLocale();
if (platformLocale == null)
{
_logger.Warning("System language not found, falling back to english");
return "en";
}
var locales = _databaseServer.GetTables().Locales;
var baseNameCode = platformLocale.TwoLetterISOLanguageName.ToLower();
if (locales.Global.ContainsKey(baseNameCode))
{
return baseNameCode;
}
var languageCode = platformLocale.Name.ToLower();
if (locales.Global.ContainsKey(languageCode))
{
return languageCode;
}
//
// const regionCode = platformLocale.region?.toLocaleLowerCase();
// if (regionCode && locales.global[regionCode]) {
// return regionCode;
// }
// BSG map DE to GE some reason
if (baseNameCode == "de")
{
return "ge";
}
if (baseNameCode == "zh")
// Handle edge case of zh
{
return "cn";
}
_logger.Warning($"Unsupported system language found: {languageCode} baseLocale: {baseNameCode}, falling back to english for client locale");
return "en";
}
/// <summary>
/// Get the current machines locale data
/// </summary>
/// <returns> The current platform locale </returns>
protected static CultureInfo GetPlatformLocale()
{
return CultureInfo.InstalledUICulture;
}
public List<string> GetLocaleKeysThatStartsWithValue(string partialKey)
{
return GetLocaleDb().Keys.Where(x => x.StartsWith(partialKey)).ToList();
}
/// <summary>
/// Blank out the "test" mail message from prapor
/// </summary>
protected Dictionary<string, string> RemovePraporTestMessage(Dictionary<string, string> dbLocales)
{
dbLocales["61687e2c3e526901fa76baf9"] = "";
return dbLocales;
}
}