Localization - First Pass (#2174)
* Started designing the backend localization service * Worked in Transloco for initial PoC * Worked in Transloco for initial PoC * Translated the login screen * translated dashboard screen * Started work on the backend * Fixed a logic bug * translated edit-user screen * Hooked up the backend for having a locale property. * Hooked up the ability to view the available locales and switch to them. * Made the localization service languages be derived from what's in langs/ directory. * Fixed up localization switching * Switched when we check for a license on UI bootstrap * Tweaked some code * Fixed the bug where dashboard wasn't loading and made it so language switching is working. * Fixed a bug on dashboard with languagePath * Converted user-scrobble-history.component.html * Converted spoiler.component.html * Converted review-series-modal.component.html * Converted review-card-modal.component.html * Updated the readme * Translated using Weblate (English) Currently translated at 100.0% (54 of 54 strings) Translation: Kavita/ui Translate-URL: https://hosted.weblate.org/projects/kavita/ui/en/ * Converted review-card.component.html * Deleted dead component * Converted want-to-read.component.html * Added translation using Weblate (Korean) * Translated using Weblate (Spanish) Currently translated at 40.7% (22 of 54 strings) Translation: Kavita/ui Translate-URL: https://hosted.weblate.org/projects/kavita/ui/es/ * Translated using Weblate (Korean) Currently translated at 62.9% (34 of 54 strings) Translation: Kavita/ui Translate-URL: https://hosted.weblate.org/projects/kavita/ui/ko/ * Converted user-preferences.component.html * Translated using Weblate (Korean) Currently translated at 92.5% (50 of 54 strings) Translation: Kavita/ui Translate-URL: https://hosted.weblate.org/projects/kavita/ui/ko/ * Converted user-holds.component.html * Converted theme-manager.component.html * Converted restriction-selector.component.html * Converted manage-devices.component.html * Converted edit-device.component.html * Converted change-password.component.html * Converted change-email.component.html * Converted change-age-restriction.component.html * Converted api-key.component.html * Converted anilist-key.component.html * Converted typeahead.component.html * Converted user-stats-info-cards.component.html * Converted user-stats.component.html * Converted top-readers.component.html * Converted some pipes and ensure translation is loaded before the app. * Finished all but one pipe for localization * Converted directory-picker.component.html * Converted library-access-modal.component.html * Converted a few components * Converted a few components * Converted a few components * Converted a few components * Converted a few components * Merged weblate in * ... -> … update * Updated the readme * Updateded all fonts to be woff2 * Cleaned up some strings to increase re-use * Removed an old flow (that doesn't exist in backend any longer) from when we introduced emails on Kavita. * Converted Series detail * Lots more converted * Lots more converted & hooked up the ability to flatten during prod build the language files. * Lots more converted * Lots more converted & fixed a bunch of broken pipes due to inject() * Lots more converted * Lots more converted * Lots more converted & fixed some bad keys * Lots more converted * Fixed some bugs with admin dasbhoard nested tabs not rendering on first load due to not using onpush change detection * Fixed up some localization errors and fixed forgot password error when the user doesn't have change password permission * Fixed a stupid build issue again * Started adding errors for interceptor and backend. * Finished off manga-reader * More translations * Few fixes * Fixed a bug where character tag badges weren't showing the name on chapter info * All components are translated * All toasts are translated * All confirm/alerts are translated * Trying something new for the backend * Migrated the localization strings for the backend into a new file. * Updated the localization service to be able to do backend localization with fallback to english. * Cleaned up some external reviews code to reduce looping * Localized AccountController.cs * 60% done with controllers * All controllers are done * All KavitaExceptions are covered * Some shakeout fixes * Prep for initial merge * Everything is done except options and basic shakeout proves response times are good. Unit tests are broken. * Fixed up the unit tests * All unit tests are now working * Removed some quantifier * I'm not sure I can support localization for some Volume/Chapter/Book strings within the codebase. --------- Co-authored-by: Robbie Davis <robbie@therobbiedavis.com> Co-authored-by: majora2007 <kavitareader@gmail.com> Co-authored-by: expertjun <jtrobin@naver.com> Co-authored-by: ThePromidius <thepromidiusyt@gmail.com>
This commit is contained in:
Joe Milazzo
GitHub
parent
670bf82c38
commit
3b23d63234
389 changed files with 13652 additions and 7925 deletions
146
API/Services/LocalizationService.cs
Normal file
146
API/Services/LocalizationService.cs
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Text.Json;
|
||||
using System.Threading.Tasks;
|
||||
using API.Data;
|
||||
using Microsoft.Extensions.Caching.Memory;
|
||||
using Microsoft.Extensions.Hosting;
|
||||
|
||||
namespace API.Services;
|
||||
#nullable enable
|
||||
|
||||
|
||||
public interface ILocalizationService
|
||||
{
|
||||
Task<string> Get(string locale, string key, params object[] args);
|
||||
Task<string> Translate(int userId, string key, params object[] args);
|
||||
IEnumerable<string> GetLocales();
|
||||
}
|
||||
|
||||
public class LocalizationService : ILocalizationService
|
||||
{
|
||||
private readonly IDirectoryService _directoryService;
|
||||
private readonly IMemoryCache _cache;
|
||||
private readonly IUnitOfWork _unitOfWork;
|
||||
|
||||
/// <summary>
|
||||
/// The locales for the UI
|
||||
/// </summary>
|
||||
private readonly string _localizationDirectoryUi;
|
||||
|
||||
private readonly MemoryCacheEntryOptions _cacheOptions;
|
||||
|
||||
|
||||
public LocalizationService(IDirectoryService directoryService,
|
||||
IHostEnvironment environment, IMemoryCache cache, IUnitOfWork unitOfWork)
|
||||
{
|
||||
_directoryService = directoryService;
|
||||
_cache = cache;
|
||||
_unitOfWork = unitOfWork;
|
||||
if (environment.IsDevelopment())
|
||||
{
|
||||
_localizationDirectoryUi = directoryService.FileSystem.Path.Join(
|
||||
directoryService.FileSystem.Directory.GetCurrentDirectory(),
|
||||
"UI/Web/src/assets/langs");
|
||||
} else if (environment.EnvironmentName.Equals("Testing", StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
_localizationDirectoryUi = directoryService.FileSystem.Path.Join(
|
||||
directoryService.FileSystem.Directory.GetCurrentDirectory(),
|
||||
"/../../../../../UI/Web/src/assets/langs");
|
||||
}
|
||||
else
|
||||
{
|
||||
_localizationDirectoryUi = directoryService.FileSystem.Path.Join(
|
||||
directoryService.FileSystem.Directory.GetCurrentDirectory(),
|
||||
"wwwroot", "assets/langs");
|
||||
}
|
||||
|
||||
_cacheOptions = new MemoryCacheEntryOptions()
|
||||
.SetSize(1)
|
||||
.SetAbsoluteExpiration(TimeSpan.FromMinutes(15));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Loads a language, if language is blank, falls back to english
|
||||
/// </summary>
|
||||
/// <param name="languageCode"></param>
|
||||
/// <returns></returns>
|
||||
public async Task<Dictionary<string, string>?> LoadLanguage(string languageCode)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(languageCode)) languageCode = "en";
|
||||
var languageFile = _directoryService.FileSystem.Path.Join(_directoryService.LocalizationDirectory, languageCode + ".json");
|
||||
if (!_directoryService.FileSystem.FileInfo.New(languageFile).Exists)
|
||||
throw new ArgumentException($"Language {languageCode} does not exist");
|
||||
|
||||
var json = await _directoryService.FileSystem.File.ReadAllTextAsync(languageFile);
|
||||
return JsonSerializer.Deserialize<Dictionary<string, string>>(json);
|
||||
}
|
||||
|
||||
public async Task<string> Get(string locale, string key, params object[] args)
|
||||
{
|
||||
|
||||
// Check if the translation for the given locale is cached
|
||||
var cacheKey = $"{locale}_{key}";
|
||||
if (!_cache.TryGetValue(cacheKey, out string? translatedString))
|
||||
{
|
||||
// Load the locale JSON file
|
||||
var translationData = await LoadLanguage(locale);
|
||||
|
||||
// Find the translation for the given key
|
||||
if (translationData != null && translationData.TryGetValue(key, out var value))
|
||||
{
|
||||
translatedString = value;
|
||||
|
||||
// Cache the translation for subsequent requests
|
||||
_cache.Set(cacheKey, translatedString, _cacheOptions);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (string.IsNullOrEmpty(translatedString))
|
||||
{
|
||||
if (!locale.Equals("en"))
|
||||
{
|
||||
return await Get("en", key, args);
|
||||
}
|
||||
return key;
|
||||
}
|
||||
|
||||
// Format the translated string with arguments
|
||||
if (args.Length > 0)
|
||||
{
|
||||
translatedString = string.Format(translatedString, args);
|
||||
}
|
||||
|
||||
return translatedString;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Returns a translated string for a given user's locale, falling back to english or the key if missing
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="key"></param>
|
||||
/// <param name="args"></param>
|
||||
/// <returns></returns>
|
||||
public async Task<string> Translate(int userId, string key, params object[] args)
|
||||
{
|
||||
var userLocale = await _unitOfWork.UserRepository.GetLocale(userId);
|
||||
return await Get(userLocale, key, args);
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Returns all available locales that exist on both the Frontend and the Backend
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public IEnumerable<string> GetLocales()
|
||||
{
|
||||
return
|
||||
_directoryService.GetFilesWithExtension(_directoryService.FileSystem.Path.GetFullPath(_localizationDirectoryUi), @"\.json")
|
||||
.Select(f => _directoryService.FileSystem.Path.GetFileName(f).Replace(".json", string.Empty))
|
||||
.Union(_directoryService.GetFilesWithExtension(_directoryService.LocalizationDirectory, @"\.json")
|
||||
.Select(f => _directoryService.FileSystem.Path.GetFileName(f).Replace(".json", string.Empty)))
|
||||
.Distinct();
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue