How I will Implement multilingual for fluent validation

this.RuleFor(u => u.Username).NotEmpty().WithMessage("Please enter username");
this.RuleFor(u => u.Password).NotEmpty().WithMessage("Please enter password");

Hi,
I started using your nice library to overcome old resx structures ;). It is a .NET Core WebApplication where the translations should be returned for the current culture of the user. (Done with stringLocalizer.WithCulture(user.Culture)....

But unfortunately I always receive the translation for the default culture (German in my case). If I read your code correctly, WithCulture has no effect and for the initialization of the Localizer the CurrentUICulture is used, which I can't use. So it is currently not possible for me to get things right...

Are there any plans to change the culture behavior (and only fallback to CurrentUICulture if nothing is set)? Even if not, it would be great to add a note to the docs to avoid needless research in future ;)

Thanks!

IViewLocalizer ends up throwing an exception which according to https://docs.microsoft.com/en-us/aspnet/core/blazor/globalization-localization?view=aspnetcore-3.1 is expected:

A limited set of ASP.NET Core's localization scenarios are currently supported:

IStringLocalizer and IStringLocalizer<T> are supported in Blazor apps.
IHtmlLocalizer, IViewLocalizer, and Data Annotations localization are ASP.NET Core MVC scenarios and not supported in Blazor apps. 

The demo app works by replacing IViewLocalizer with IStringLocalizer

How to localize ViewModel DataAnnotations?

Hi,

In the default implementation of IStringLocalizerFactory, they do IStringLocalizer caching (using ConcurentDictornary). According to feedback from the .NET CORE development team, if one decides to implement a custom IStringLocalizerFactory they should implement caching them self.

Implementation should cache localizers to prevent them from being created needlessly.

Unfortunately your test case is small controller so you can't reproduce this issues. In my case, where there is massive use of ISTringLocalizer, it is called many times.

Why was there a need to implement the JsonStringLocalizerFactory? As far as I can tell, you could have solved it all just by using the IStringLocalizer implementation and just keep using the Microsoft default IStringLocalizerFactory (that uses caching)

I will try to make it work without it in my scenario because I currently don't see the benefit of Factory customization. But please let me know if I am missing something...

tnx!
Luka

Be able from Localizer and IHtmlLocalizer to have pluralization.

Example :

Key : User
Values : User | Users

Be able to get User or Users

Isn't the setting IsAbsolutePath redundant? You can always use System.IO.Path.IsPathRooted to tell.

Greate package. I'm trying to use your package in order to localize two Json files in two different paths. I couldn't do this because in the startup.cs the resource path should be fixed.
But this is not the problem, even if i try to put the two json files under the same resource folder what i get in the result is always the content of the two Json resource files.
I thnik that is because the basename is never user when instanciating a JsonStringLocalizer class iin the JsonStringLocalizerFactory. Create method :

  public IStringLocalizer Create(string baseName, string location)
        {
            return (IStringLocalizer)new JsonStringLocalizer(_env, _memCache, _resourcesRelativePath, _localizationOptions);
        }

I guess it should have been something like this :

  public IStringLocalizer Create(string baseName, string location)
        {
            string filePath = _resourcesRelativePath+baseName
            return (IStringLocalizer)new JsonStringLocalizer(_env, _memCache, filePath, _localizationOptions);
        }

Hi!
I have a class library on netstandart 2.1 and add you package last version 3.1.0 but show error:

Error CS1705 Assembly 'Askmethat.Aspnet.JsonLocalizer' with identity 'Askmethat.Aspnet.JsonLocalizer, Version=3.1.0.0, Culture=neutral, PublicKeyToken=null' uses 'System.Runtime, Version=4.2.1.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' which has a higher version than referenced assembly 'System.Runtime' with identity 'System.Runtime, Version=4.1.2.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'_

Last version 3.1.0 does support netstandart 2.1? Where info about this?
Thanks.

Hi,

would it be possible to add an option to the configuration allowing me to set the encoding in which to read the json file?

I have noticed that after users change the translation file in notepad, save it without checking the encoding, end up setting it to ANSI or something.
After that, special characters are shown like an � after being localized.

so if you could add a config option allowing me to set the encoding in code, users can't ruin the localizations anymore by not saving in the proper encoding.

Can you please add a version for View localization?

Have a look about performance using benchmarkdotnet comparing to base Asp.net Localizer.

Post result to the Readme file.

If results are bad, try to improve them :)

Hi,

I've been using JsonLocalizer from some time now. For the time being, I had to stick to an older version because I am referencing it from a library that is compiled against nestandard2.0.

I understand that JsonLocalizer is meant to be used in Top Level projects (weapps), however bringing back netstandard as a dependency instead of netcoreapp could be great for cases like mine where the common face lifting is done in libraries instead of every single application.

Thank you in advance.

Is it possible to add different scenarios of how to use this library? for example data annotation, in views and controllers.
Thank you

We still have issues with not getting the correct translation, even when using "WithCulture".

We need to be able to use a localization, not based on geo-position, cookie, browser setting, but based on a predefined setting added(in the database) on the specific page..

we cant get this to work without new page load (change language)

I am trying to make my website bilingual, I set the culture with cookie like this.

           public IActionResult SetCulture(string id = "en")
	{
		var culture = id;
		Response.Cookies.Append(
		   CookieRequestCultureProvider.DefaultCookieName,
		   CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(culture)), 
                                   new CookieOptions { Expires = DateTimeOffset.UtcNow.AddYears(1) }
	   );
		var referer = Request.Headers["Referer"].ToString();
		referer = String.IsNullOrEmpty(referer) ? "/" : referer;
		var address = new Uri(referer);
		var path = address.AbsolutePath;
		return Redirect(path);
	}

but the language does not get changed unless I restart the application;
how can I change the language while the app is running.
Thanks.

Hi,

According to my interpretation of the code, the library would cache only first language that gets requests. Why? Because JsonStringLocalizer constructor only gets called once. I suppose this is because it is registered (see below) as singleton (AddSingleton) instead of Scoped (AddScoped). And if the JsonStringLocalizer constructor is called only once, then its base class constructor gets called only once, and that means that only the first langues gets cached. If the you user in the next request changes its option and chooses a different language, that change would not be reflected in the code.

internal static void AddJsonLocalizationServices(IServiceCollection services) { services.AddMemoryCache(); services.AddSingleton<IStringLocalizerFactory, JsonStringLocalizerFactory>(); services.AddSingleton<IStringLocalizer, JsonStringLocalizer>(); }

Another issue is that you are not storing the cache with the same value as you are reading it:
First is concatenation of key + language, and you are storing it only using key and without language.
I added a fix #43

if (!_memCache.TryGetValue($"{CACHE_KEY}_{currentCulture.ThreeLetterISOLanguageName}", out localization)) { ConstructLocalizationObject(_resourcesRelativePath, currentCulture); // Set cache options. var cacheEntryOptions = new MemoryCacheEntryOptions() // Keep in cache for this time, reset time if accessed. .SetSlidingExpiration(_memCacheDuration); // Save data in cache. _memCache.Set(CACHE_KEY, localization, cacheEntryOptions); }

#44

Hi,

I have HomeController which inherits BaseController

Constructor of HomeController:

 public HomeController(IConfiguration configuration,
            **IJsonStringLocalizer<HomeController> localizer**) :
        base(configuration, localizer){
}

Class BaseController:

private readonly IConfiguration _configuration;
 protected  IJsonStringLocalizer<BaseController> _localizer;

       public BaseController(IConfiguration configuration,
           **IJsonStringLocalizer<BaseController> localizer**)
       {
           this.apiHandler = apiHandler;
           this._configuration = configuration;
           this._localizer = localizer;
       }

If we want to use it this way, we would actually need (I assume):

public interface IJsonStringLocalizer<out T> : IJsonStringLocalizer
instead of

public interface IJsonStringLocalizer<T> : IJsonStringLocalizer

<T> -> <out T>

I got download nuget package and as in example, When I was coding service extensions, I got these errors,

If i use

@{
var desiredLanguageLocalizer = Localizer.WithCulture(new CultureInfo("da"));
}
<p>@desiredLanguageLocalizer['myKey']</p>

It does not seem to use the culture i selected from above, but the "default one"..

I need to be able to use a predefined language set in a db, and pretty much have to ignore what the user have it the users accept-language/cookie.. But it seems i cant do anything to make it work, without a pageload or redirect which seems silly?

The above should be the normal way to force the localizer to use a predetermined language, but it seems to ignore it.

(the above is tried directly in the view, but is ignored. I have not tried directly from the controller, but i guess its the same)

Great repo!

Does it also support Blazor WebAssembly?

Repro Step :

• Create a pluralized string
• Try to use another languages with query string
• Crash

Hi,

Getting exception while retrieving a localized string using GetString method of IStringLocalizer class. Below is the exception:
Culture is not supported. (Parameter 'name')\r\n <FolderPartName" is an invalid culture identifier.

Root Cause:
This exception occurs when a I18N JSON resource files with format like "localization.en-US.json" is in a folder path which has atleast one folder in the heirarchy with a dot (".") in its name.
This is because filename splitter is assuming that only filenames will have dot in the absolute path. which may not be the case.

Fix:
Fix is to use Path.GetFileName to first get filename from the absolute folder path and then try to retrieve the file culture details from last but one index of filename split array.

Hi Alex, I'd like to push a change to make JsonLocalizer support One|Other|Zero|Two|Few|Many types of pluralization and not just plural/singular.

Hi. I get this error after using this package with asp.net core 2.2
DirectoryNotFoundException: Could not find a part of the path '\bin\Debug\netcoreapp2.2\json'.
but after I copy manually JSON file to \bin\Debug\netcoreapp2.2\json the error gets fixed.

How about replacing Newtonsoft.Json with System.Text.JSON, any thoughts?

Should the localizer be using CurrentUICulture instead of CurrentCulture by default?

From documentation I've read, it sounds like CurrentUICulture is meant to be used for resource-strings, and CurrentCulture is intended for formatting (numbers, dates, currency, etc.). Microsoft's own implementations of resource-string managers and StringLocalizers also rely on just CurrentUICulture.

However, I've also come across a couple comments that Windows can misrepresent a person's chosen culture with CurrentUICulture (back in 2012 with en-GB at least): see the Question Comments here https://stackoverflow.com/questions/329033/what-is-the-difference-between-currentculture-and-currentuiculture-properties-of#comment-11872860. I'd think that might only be a concern with desktop applications though. Web-apps shouldn't be affected as there'd typically be a culture-provider selecting the relevant culture to use from a request/cookie etc.

Is it possible to set the Resource path as an absolute address instead of one relative to the project folder?

Can I use this library with Data Annotations?

As mention in this article :

https://dotnettips.wordpress.com/2019/11/25/properly-comparing-strings-with-globalization-and-performance-in-net/

Using InvariantCultureIgnoreCase in string equals for dictionary key matching is slow.
Using OrdinalIgnoreCase will improve the whole application performance.

I think to completely support BaseName matching in JsonStringLocalizerFactory the Create-Method with a Type as input parameter should be changed to use the type:

public IStringLocalizer Create(Type resourceSource)
        {
            return this.Create(resourceSource.FullName, string.Empty);
        }

I also tried to get the matching more closely to what is mentioned in the MSDN regarding DataAnnotations localization:

Using the option ResourcesPath = "Resources", the error messages in RegisterViewModel can be stored in either of the following paths:
Resources/ViewModels.Account.RegisterViewModel.fr.resx
Resources/ViewModels/Account/RegisterViewModel.fr.resx

As I need this for my lingualization design but did not want to break the existing functionality, I tried to implement a priorized search for localization files working as you implemented it before when there is a matching folder found. This is the logic:

Search patterns when UseBaseName = true

If UseBaseName is set to true, it will be searched for lingualization files by the following order - skipping the options below if any option before matches.

• If you use a non-typed IStringLocalizer all files in the Resources-directory, including all subdirectories, will be used to find a localization. This can cause unpredictable behavior if the same key is used in multiple files.

• If you use a typed localizer, the following applies - Namespace is the "short namespace" without the root namespace:

  • If there is a folder named "Your/Namespace/And/Classname", all contents of this folder will be used.
  • If there is a folder named "Your/Namespace" the folder will be searched for all json-files beginning with your classname.
  • Otherwise there will be searched for a json-file starting with "Your.Namespace.And.Classname" in your Resources-folder.

You can see how I implemented it in my latest commit. I also extended the TestSample-Project to reflect the different ways of adding translation files.

The more strict matching from the beginning of this post might be considered as breaking change.

With last netcore version, some unit test not working in CI...

Trying to move to Azure Devops to avoid this.

Reproduce Step

JSON

{
"Users":{
"Values":{
"en-US": "Users"
}
}
}

C#

Localizer.GetString("Users", true) or Localizer.GetString("Users", false) will throw exception.

This could be avoided by catching or checking if separator exist.
If translation was not implemented with separator, return value.

Improve the default behavor of IStringLocalizer for translation not found

Cases of Translation not found

1. The key was not found in localized files
2. Current language key was not found for looking translation

Proposition

• For the case 1 : Throw a exception. The key should exist if user try to use it
• For the case 2 : Throw a warning to advert user that current language does not exist for current and get default language key

The typed localizer is not working properly - JsonStringLocalizerOfT receives a nullable baseName parameter.

Proposed fix for JsonStringLocalizerOfT:

namespace Askmethat.Aspnet.JsonLocalizer.Localizer
{
    //resource not use, only here to match microsoft interfaces
    internal class JsonStringLocalizerOfT<T> : JsonStringLocalizer, IJsonStringLocalizer<T>, IStringLocalizer<T>
    {
#if NETCORE
         public JsonStringLocalizerOfT(IOptions<JsonLocalizationOptions> localizationOptions, IWebHostEnvironment env, string baseName
 = null) : base(localizationOptions, env, ModifyBaseName())
        {
        }
#else
        public JsonStringLocalizerOfT(IOptions<JsonLocalizationOptions> localizationOptions, IHostingEnvironment env,
            string baseName = null) : base(localizationOptions, env, ModifyBaseName())
        {
        }
#endif

        static string ModifyBaseName()
        {
            return typeof(T).ToString();
        }

    }
}

I am changing my json file at run time. Then I execute the ClearMemCache method and refresh the view containing the keys. Should the view display the new key values?

Hi,

if you have your json files stored in an Assembly which (Copy files to Output Directory = true) is used by your maybe Blazor app, you have to set "AbsolutPath=False".
But in the .net core web app the filepath then will be like this:

...bin\\Debug\\netcoreapp3.1\Locales\\localisation.de-DE.json

Then you will get an error "Culture is not supported" because he has found o localization Name like '1\Locales…."

I have view your source Code and there is a Problem in your i18 Class:

`
if (files.Any() && !isInvariantCulture)

        {

            foreach (var file in files)

            {

                var splittedFiles = file.Split(Path.AltDirectorySeparatorChar);

                var stringCulture = splittedFiles.Last().Split('.')[1];
                var fileCulture = new CultureInfo(stringCulture);



                var isParent =

                    fileCulture.Name.Equals(currentCulture.Parent.Name, StringComparison.OrdinalIgnoreCase);



                if (fileCulture.Name.Equals(currentCulture.Name, StringComparison.OrdinalIgnoreCase) ||

                    isParent && fileCulture.Name != "json")

                {

                    AddValueToLocalization(options, file, isParent);

                }

            }

        }`

Shared files are used to avoid duplicating key/values in JSON Files.

Files are working correctly for .shared.files under a base path but not for the one in base path.

Can someone help me with setting up the Default Culture and Default UI Culture?

I did try setting the following options at the Startup. cs:

       services.AddJsonLocalization(options =>
       {

           options.SupportedCultureInfos = new HashSet<CultureInfo>()
                   {
                         new CultureInfo("np"),
                         new CultureInfo("en-US")
                   };
           options.DefaultCulture = new CultureInfo("np");
           options.DefaultUICulture = new CultureInfo("np");
           options.CacheDuration = TimeSpan.FromMinutes(15);
           options.ResourcesPath = "Resources";
           options.LocalizationMode = LocalizationMode.I18n;
       });

However, it is always taking the "en-Us" as the default culture resource. Here is the snapshot of the file located on the project:

Any help would be much more appreciable.

Thanks

i have installed the plugin in my project but i can't refrernce
using Askmethat.Aspnet.JsonLocalizer.JsonOptions;

Please note that i downloaded the repo and i can see the refrence for this working.

Currently, same keys in multiple files are not properly managed.
You can have multple times the same key, with the same translation with any merge or control.

Improvement proposition

• Merge same keys comming from multiple JSON files
• Throw an exception if identical key have the same language translation ( Two translation for en-US )

I am currently trying to understand the "GetCultureToUse"-method. I understand that it gets the localization from the MemCache which seems to be fine - what I don't understand are the calls to "SetCurrentCultureToCache" - they don't seem to have any effect as at the end of the method SetCurrentCultureToCache(cultureToUse); overrides the other 2 calls. Am I right to assume that only the last call is relevant and the other 2 can be removed? I also think the elsepart can be removed as it was done at the beginning.

        protected void GetCultureToUse(CultureInfo cultureToUse)
        {
            if (!_memCache.TryGetValue(GetCacheKey(cultureToUse), out localization))
            {
                if (_memCache.TryGetValue(GetCacheKey(cultureToUse.Parent), out localization))
                {
                    SetCurrentCultureToCache(cultureToUse.Parent);
                }
                else
                {
                    _memCache.TryGetValue(GetCacheKey(cultureToUse), out localization);
                    SetCurrentCultureToCache(_localizationOptions.Value.DefaultCulture);
                }
            }
            SetCurrentCultureToCache(cultureToUse);
        }

I think this method should do the same:

protected void GetCultureToUse(CultureInfo cultureToUse)
        {
            if (!_memCache.TryGetValue(GetCacheKey(cultureToUse), out localization))
            {
                _memCache.TryGetValue(GetCacheKey(cultureToUse.Parent), out localization));
            }
            SetCurrentCultureToCache(cultureToUse);
        }

would you add support for an alternate file layout configuration?

example 1
Resources/localization.en-US.json
Resources/localization.fr-FR.json

example 2
Resources/en-US/localization.json
Resources/fr-FR/localization.json

Does the I18N model support hierarchical relationships?
If it is not supported, Put all keys in the same file?

eg：
localization.en-US.json
{
"Page":{
"Title": "title for page"
}
}

localization.zh-CN.json
{
"Page":{
"Title": "标题"
}
}

Today, all the key values are cached without taking care of the current culture provided (By browser or something else).

The blob key should be enhanced to take the current culture or parent culture.

This should :

• Improve performance
• Reduce memory consumption
• Improve compliance with the Microsoft localizer

Regarding to the MSDN not found keys should return the key and not throw an exception:

If the localized value of "About Title" isn't found, then the indexer key is returned, that is, the string "About Title".

Localizations consisting of an empty string should be treated as valid. Some languages might have prefixes/suffixes that others dont, for example.

I would love to see a way to invalidation/refresh the memory cache.

I'm allowing my users to update the localization.json file from an admin screen, and I need the changes to take effect immediately, not at the end of the expiration period.

I believe the correct value for LocalizedString.ResourceNotFound should be false (when retrieved via JsonStringLocalizer.GetAllStrings(includeParentCultures:false)) and you probably set it to true there because Microsoft's documentation for that property in versions prior to .NET Standard 2.0 was wrong.