PredefinedCulturesOnly=false not respected in new CultureInfo(int)

[OwnageIsMagic]

Description

This creates issue for WinForms
dotnet/winforms#9191 (comment)

see

runtime/src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.cs

Lines 860 to 872 in 182591a

	internal static CultureData GetCultureData(int culture, bool bUseUserOverride)
	{
	CultureData? retVal = null;
	if (culture == CultureInfo.LOCALE_INVARIANT)
	{
	return Invariant;
	}
	if (GlobalizationMode.Invariant)
	{
	// LCID is not supported in the InvariantMode
	throw new CultureNotFoundException(nameof(culture), culture, SR.Argument_CultureNotSupportedInInvariantMode);

and

runtime/src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.cs

Lines 670 to 682 in 182591a

	internal static CultureData? GetCultureData(string? cultureName, bool useUserOverride)
	{
	// First do a shortcut for Invariant
	if (string.IsNullOrEmpty(cultureName))
	{
	return CultureData.Invariant;
	}
	if (GlobalizationMode.PredefinedCulturesOnly)
	{
	if (GlobalizationMode.Invariant || (GlobalizationMode.UseNls ? !NlsIsEnsurePredefinedLocaleName(cultureName): !IcuIsEnsurePredefinedLocaleName(cultureName)))
	return null;
	}

Reproduction Steps

dotnet build /p:InvariantGlobalization=true /p:PredefinedCulturesOnly=false && dotnet run --no-build

_ = new CultureInfo(1100);

Expected behavior

Return Invariant culture.

Actual behavior

Exception.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-globalization
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

This creates issue for WinForms
dotnet/winforms#9191 (comment)

see

runtime/src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.cs

Lines 860 to 872 in 182591a

	internal static CultureData GetCultureData(int culture, bool bUseUserOverride)
	{
	CultureData? retVal = null;
	if (culture == CultureInfo.LOCALE_INVARIANT)
	{
	return Invariant;
	}
	if (GlobalizationMode.Invariant)
	{
	// LCID is not supported in the InvariantMode
	throw new CultureNotFoundException(nameof(culture), culture, SR.Argument_CultureNotSupportedInInvariantMode);

and

runtime/src/libraries/System.Private.CoreLib/src/System/Globalization/CultureData.cs

Lines 670 to 682 in 182591a

	internal static CultureData? GetCultureData(string? cultureName, bool useUserOverride)
	{
	// First do a shortcut for Invariant
	if (string.IsNullOrEmpty(cultureName))
	{
	return CultureData.Invariant;
	}
	if (GlobalizationMode.PredefinedCulturesOnly)
	{
	if (GlobalizationMode.Invariant || (GlobalizationMode.UseNls ? !NlsIsEnsurePredefinedLocaleName(cultureName): !IcuIsEnsurePredefinedLocaleName(cultureName)))
	return null;
	}

Reproduction Steps

dotnet build /p:InvariantGlobalization=true /p:PredefinedCulturesOnly=false && dotnet run --no-build

_ = new CultureInfo(1100);

Expected behavior

return Invariant culture

Actual behavior

exception

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Author:	OwnageIsMagic
Assignees:	-
Labels:	area-System.Globalization, untriaged
Milestone:	-

[tarekgh]

Why would you enable the invariant globalization mode for a WinForm app? I believe this is not the suitable environment for running WinForm apps for several reasons. Additionally, we generally discourage the use of LCID (Locale Identifier) as it is considered obsolete, and we try to avoid investing in outdated technologies. The appropriate course of action in this case is to disable the invariant mode for your WinForm apps.

[ghost]

This issue has been marked needs-author-action and may be missing some important information.

[OwnageIsMagic]

I'm developing tool to convert data from one well defined format to another, and doesn't have any plans on localization. InvariantGlobaliztion helps me to ensure that I don't accidentally depend on current culture of my dev environment and saves me from scanning WinForms and other dependencies repos in case it does somewhere sets CurrentCulture/CurrentUICulture/DefaultThreadCurrentCulture/DefaultThreadCurrentUICulture or any other global property I'm not aware of. (I once had to deal with a library that used some specific culture instead of format string to format dates. And one day came a user with overridden NLS settings ...)

Usage of this constructor is tied to what we get from WM_INPUTLANGCHANGE Win32 message.

Fix is trivial and will bring in consistency between constructor overloads.

  internal static CultureData GetCultureData(int culture, bool bUseUserOverride)
  {
      CultureData? retVal = null;
  
      if (culture == CultureInfo.LOCALE_INVARIANT)
      {
          return Invariant;
      }
 
      if (GlobalizationMode.Invariant)
      {
+         if (!GlobalizationMode.PredefinedCulturesOnly)
+         {
+              return Invariant;
+         }
          // LCID is not supported in the InvariantMode
          throw new CultureNotFoundException(nameof(culture), culture, SR.Argument_CultureNotSupportedInInvariantMode);
      }

[tarekgh]

@OwnageIsMagic thanks for the info. in your tool, who is creating the culture using the LCID? Is it your tool or WinFoms? If it is your tool, then you can just avoid creating the culture in the first place and use Invariant Culture. If it is WinForms, then you have something seriously wrong trying to use WinFomrs and expect it will handle the cultural operation correctly while you are enabling Invariant Globalization mode.

Fix is trivial

This is not the point; the point is we need to refrain users from using LCIDs in general. Helping fixing cases to support LCIDs will make it worse to obsolete such APIs moving forward.

[ghost]

This issue has been marked needs-author-action and may be missing some important information.

[OwnageIsMagic]

@tarekgh the culture is created in WinForms as part of creating EventArgs for handling system broadcast message, it's not used internally, but it's a part of public api.
Issue can be worked around on WinForms side, but exception message links to this property as documented workaround.

the point is

In invariant mode LCID is actually unused and ignored, so I don't think that can be considered as support.

[tarekgh]

@OwnageIsMagic are you interested to submit a PR?