Skip to content

Commit

Permalink
Revert "Allow TimeZoneInfo display names to use any of the installed …
Browse files Browse the repository at this point in the history 
…Windows languages" (#53112)

This reverts commit b54dbaf.
  • Loading branch information
@mattjohnsonpint
mattjohnsonpint authored May 21, 2021
1 parent b54dbaf commit 35a0c5b
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 203 deletions.
5 changes: 2 additions & 3 deletions src/libraries/Common/src/Interop/Windows/Kernel32/Interop.MUI.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ internal static partial class Interop
{
internal static partial class Kernel32
{
internal const uint MUI_USER_PREFERRED_UI_LANGUAGES = 0x10;
internal const uint MUI_USE_INSTALLED_LANGUAGES = 0x20;
internal const uint MUI_PREFERRED_UI_LANGUAGES = 0x10;

[DllImport(Libraries.Kernel32, CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
internal static extern unsafe bool GetFileMUIPath(uint dwFlags, string pcwszFilePath, char* pwszLanguage, ref uint pcchLanguage, char* pwszFileMUIPath, ref uint pcchFileMUIPath, ref ulong pululEnumerator);
internal static extern unsafe bool GetFileMUIPath(uint dwFlags, string pcwszFilePath, char* pwszLanguage, ref int pcchLanguage, char* pwszFileMUIPath, ref int pcchFileMUIPath, ref long pululEnumerator);
}
}
2 changes: 0 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/TimeZoneInfo.Unix.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ public sealed partial class TimeZoneInfo
"Zulu"
};

private static readonly TimeZoneInfo s_utcTimeZone = CreateUtcTimeZone();

private TimeZoneInfo(byte[] data, string id, bool dstDisabled)
{
_id = id;
Expand Down
149 changes: 27 additions & 122 deletions src/libraries/System.Private.CoreLib/src/System/TimeZoneInfo.Win32.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ public sealed partial class TimeZoneInfo
private const int MaxKeyLength = 255;
private const string InvariantUtcStandardDisplayName = "Coordinated Universal Time";

private static readonly Dictionary<string, string> s_FileMuiPathCache = new();
private static readonly TimeZoneInfo s_utcTimeZone = CreateUtcTimeZone();

private sealed partial class CachedData
{
private static TimeZoneInfo GetCurrentOneYearLocal()
Expand Down Expand Up @@ -739,106 +736,6 @@ private static bool TryCompareTimeZoneInformationToRegistry(in TIME_ZONE_INFORMA
}
}

/// <summary>
/// Helper function for getting the MUI path for a given resource and culture, using a cache to prevent duplicating work.
/// Searches the installed OS languages for either an exact matching culture, or one that has the same parent.
/// If not found, uses the preferred default OS UI language, to align with prior behavior.
/// </summary>
private static string GetCachedFileMuiPath(string filePath, CultureInfo cultureInfo)
{
string? result;
string cacheKey = $"{cultureInfo.Name};{filePath}";

lock (s_FileMuiPathCache)
{
if (s_FileMuiPathCache.TryGetValue(cacheKey, out result))
{
return result;
}
}

result = GetFileMuiPath(filePath, cultureInfo);

lock (s_FileMuiPathCache)
{
s_FileMuiPathCache.TryAdd(cacheKey, result);
}

return result;
}

/// <summary>
/// Helper function for getting the MUI path for a given resource and culture.
/// Searches the installed OS languages for either an exact matching culture, or one that has the same parent.
/// If not found, uses the preferred default OS UI language, to align with prior behavior.
/// </summary>
private static unsafe string GetFileMuiPath(string filePath, CultureInfo cultureInfo)
{
char* fileMuiPath = stackalloc char[Interop.Kernel32.MAX_PATH + 1];
char* language = stackalloc char[Interop.Kernel32.LOCALE_NAME_MAX_LENGTH + 1];
uint fileMuiPathLength = Interop.Kernel32.MAX_PATH;
uint languageLength = Interop.Kernel32.LOCALE_NAME_MAX_LENGTH;
ulong enumerator = 0;

while (true)
{
// Search all installed languages. The enumerator is re-used between loop iterations.
bool succeeded = Interop.Kernel32.GetFileMUIPath(
Interop.Kernel32.MUI_USE_INSTALLED_LANGUAGES,
filePath, language, ref languageLength,
fileMuiPath, ref fileMuiPathLength, ref enumerator);

if (!succeeded)
{
// Recurse to search using the parent of the desired culture.
if (cultureInfo.Parent.Name != string.Empty)
{
return GetFileMuiPath(filePath, cultureInfo.Parent);
}

// Final fallback, using the preferred installed UI language.
enumerator = 0;
succeeded = Interop.Kernel32.GetFileMUIPath(
Interop.Kernel32.MUI_USER_PREFERRED_UI_LANGUAGES,
filePath, language, ref languageLength,
fileMuiPath, ref fileMuiPathLength, ref enumerator);

if (succeeded)
{
fileMuiPath[Interop.Kernel32.MAX_PATH] = '\0';
return new string(fileMuiPath);
}

// Shouldn't get here, as there's always at least one language installed.
return string.Empty;
}

// Lookup succeeded. Check for exact match to the desired culture.
language[Interop.Kernel32.LOCALE_NAME_MAX_LENGTH] = '\0';
var lang = new string(language);
if (string.Equals(lang, cultureInfo.Name, StringComparison.OrdinalIgnoreCase))
{
fileMuiPath[Interop.Kernel32.MAX_PATH] = '\0';
return new string(fileMuiPath);
}

// Check for match of any parent of the language returned to the desired culture.
var ci = CultureInfo.GetCultureInfo(lang);
while (ci.Parent.Name != string.Empty)
{
if (ci.Parent.Name.Equals(cultureInfo.Name, StringComparison.OrdinalIgnoreCase))
{
fileMuiPath[Interop.Kernel32.MAX_PATH] = '\0';
return new string(fileMuiPath);
}

ci = ci.Parent;
}

// Not found yet. Continue with next iteration.
}
}

/// <summary>
/// Helper function for retrieving a localized string resource via MUI.
/// The function expects a string in the form: "@resource.dll, -123"
Expand All @@ -849,16 +746,13 @@ private static unsafe string GetFileMuiPath(string filePath, CultureInfo culture
/// If a localized resource file exists, we LoadString resource ID "123" and
/// return it to our caller.
/// </summary>
private static string GetLocalizedNameByMuiNativeResource(string resource, CultureInfo? cultureInfo = null)
private static string TryGetLocalizedNameByMuiNativeResource(string resource)
{
if (string.IsNullOrEmpty(resource))
{
return string.Empty;
}

// Use the current UI culture when culture not specified
cultureInfo ??= CultureInfo.CurrentUICulture;

// parse "@tzres.dll, -100"
//
// filePath = "C:\Windows\System32\tzres.dll"
Expand Down Expand Up @@ -888,23 +782,34 @@ private static string GetLocalizedNameByMuiNativeResource(string resource, Cultu
return string.Empty;
}

// Get the MUI File Path
string fileMuiPath = GetCachedFileMuiPath(filePath, cultureInfo);
if (fileMuiPath == string.Empty)
if (!int.TryParse(resources[1], NumberStyles.Integer, CultureInfo.InvariantCulture, out int resourceId))
{
// not likely, but we could not resolve a MUI path
return string.Empty;
}
resourceId = -resourceId;

// Get the resource ID
if (!int.TryParse(resources[1], NumberStyles.Integer, CultureInfo.InvariantCulture, out int resourceId))
try
{
unsafe
{
char* fileMuiPath = stackalloc char[Interop.Kernel32.MAX_PATH];
int fileMuiPathLength = Interop.Kernel32.MAX_PATH;
int languageLength = 0;
long enumerator = 0;

bool succeeded = Interop.Kernel32.GetFileMUIPath(
Interop.Kernel32.MUI_PREFERRED_UI_LANGUAGES,
filePath, null /* language */, ref languageLength,
fileMuiPath, ref fileMuiPathLength, ref enumerator);
return succeeded ?
TryGetLocalizedNameByNativeResource(new string(fileMuiPath, 0, fileMuiPathLength), resourceId) :
string.Empty;
}
}
catch (EntryPointNotFoundException)
{
return string.Empty;
}
resourceId = -resourceId;

// Finally, get the resource from the resource path
return GetLocalizedNameByNativeResource(fileMuiPath, resourceId);
}

/// <summary>
Expand All @@ -914,7 +819,7 @@ private static string GetLocalizedNameByMuiNativeResource(string resource, Cultu
/// "resource.dll" is a language-specific resource DLL.
/// If the localized resource DLL exists, LoadString(resource) is returned.
/// </summary>
private static unsafe string GetLocalizedNameByNativeResource(string filePath, int resource)
private static unsafe string TryGetLocalizedNameByNativeResource(string filePath, int resource)
{
IntPtr handle = IntPtr.Zero;
try
Expand Down Expand Up @@ -964,17 +869,17 @@ private static void GetLocalizedNamesByRegistryKey(RegistryKey key, out string?
// try to load the strings from the native resource DLL(s)
if (!string.IsNullOrEmpty(displayNameMuiResource))
{
displayName = GetLocalizedNameByMuiNativeResource(displayNameMuiResource);
displayName = TryGetLocalizedNameByMuiNativeResource(displayNameMuiResource);
}

if (!string.IsNullOrEmpty(standardNameMuiResource))
{
standardName = GetLocalizedNameByMuiNativeResource(standardNameMuiResource);
standardName = TryGetLocalizedNameByMuiNativeResource(standardNameMuiResource);
}

if (!string.IsNullOrEmpty(daylightNameMuiResource))
{
daylightName = GetLocalizedNameByMuiNativeResource(daylightNameMuiResource);
daylightName = TryGetLocalizedNameByMuiNativeResource(daylightNameMuiResource);
}

// fallback to using the standard registry keys
Expand Down Expand Up @@ -1098,7 +1003,7 @@ private static string GetUtcStandardDisplayName()
// try to load the string from the native resource DLL(s)
if (!string.IsNullOrEmpty(standardNameMuiResource))
{
standardDisplayName = GetLocalizedNameByMuiNativeResource(standardNameMuiResource);
standardDisplayName = TryGetLocalizedNameByMuiNativeResource(standardNameMuiResource);
}

// fallback to using the standard registry key
Expand Down
2 changes: 2 additions & 0 deletions src/libraries/System.Private.CoreLib/src/System/TimeZoneInfo.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ private enum TimeZoneInfoResult
private const string UtcId = "UTC";
private const string LocalId = "Local";

private static readonly TimeZoneInfo s_utcTimeZone = CreateUtcTimeZone();

private static CachedData s_cachedData = new CachedData();

//
Expand Down
76 changes: 0 additions & 76 deletions src/libraries/System.Runtime/tests/System/TimeZoneInfoTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices;
using System.Runtime.Serialization.Formatters.Binary;
using System.Text.RegularExpressions;
using Microsoft.DotNet.RemoteExecutor;
Expand Down Expand Up @@ -2721,31 +2720,7 @@ public static void TestNameWithInvariantCulture()
Assert.True(pacific.DisplayName.IndexOf("Pacific", StringComparison.OrdinalIgnoreCase) >= 0, $"'{pacific.DisplayName}' is not the expected display name for Pacific time zone");
}).Dispose();
}

private static readonly CultureInfo[] s_CulturesForWindowsNlsDisplayNamesTest = WindowsUILanguageHelper.GetInstalledWin32CulturesWithUniqueLanguages();
private static bool CanTestWindowsNlsDisplayNames => RemoteExecutor.IsSupported && s_CulturesForWindowsNlsDisplayNamesTest.Length > 1;

[PlatformSpecific(TestPlatforms.Windows)]
[ConditionalFact(nameof(CanTestWindowsNlsDisplayNames))]
public static void TestWindowsNlsDisplayNames()
{
RemoteExecutor.Invoke(() =>
{
CultureInfo[] cultures = s_CulturesForWindowsNlsDisplayNamesTest;
CultureInfo.CurrentUICulture = cultures[0];
TimeZoneInfo.ClearCachedData();
TimeZoneInfo tz1 = TimeZoneInfo.FindSystemTimeZoneById(s_strPacific);

CultureInfo.CurrentUICulture = cultures[1];
TimeZoneInfo.ClearCachedData();
TimeZoneInfo tz2 = TimeZoneInfo.FindSystemTimeZoneById(s_strPacific);
Assert.True(tz1.DisplayName != tz2.DisplayName, $"The display name '{tz1.DisplayName}' should be different between {cultures[0].Name} and {cultures[1].Name}.");
Assert.True(tz1.StandardName != tz2.StandardName, $"The standard name '{tz1.StandardName}' should be different between {cultures[0].Name} and {cultures[1].Name}.");
Assert.True(tz1.DaylightName != tz2.DaylightName, $"The daylight name '{tz1.DaylightName}' should be different between {cultures[0].Name} and {cultures[1].Name}.");
}).Dispose();
}

[Theory]
Expand Down Expand Up @@ -3008,56 +2983,5 @@ private static void VerifyCustomTimeZoneException<TException>(string id, TimeSpa
}
});
}

// This helper class is used to retrieve information about installed OS languages from Windows.
// Its methods returns empty when run on non-Windows platforms.
private static class WindowsUILanguageHelper
{
public static CultureInfo[] GetInstalledWin32CulturesWithUniqueLanguages() =>
GetInstalledWin32Cultures()
.GroupBy(c => c.TwoLetterISOLanguageName)
.Select(g => g.First())
.ToArray();

public static CultureInfo[] GetInstalledWin32Cultures()
{
if (!OperatingSystem.IsWindows())
{
return new CultureInfo[0];
}

var context = new EnumContext();
EnumUILanguagesProc proc = EnumUiLanguagesCallback;

EnumUILanguages(proc, MUI_ALL_INSTALLED_LANGUAGES | MUI_LANGUAGE_NAME, context);
GC.KeepAlive(proc);
return context.InstalledCultures.ToArray();
}

private static bool EnumUiLanguagesCallback(IntPtr lpUiLanguageString, EnumContext lParam)
{
var cultureName = Marshal.PtrToStringUni(lpUiLanguageString);
if (cultureName != null)
{
lParam.InstalledCultures.Add(CultureInfo.GetCultureInfo(cultureName));
return true;
}

return false;
}

private const uint MUI_LANGUAGE_NAME = 0x8;
private const uint MUI_ALL_INSTALLED_LANGUAGES = 0x20;

[DllImport("Kernel32.dll", CharSet = CharSet.Auto)]
private static extern bool EnumUILanguages(EnumUILanguagesProc lpUILanguageEnumProc, uint dwFlags, EnumContext lParam);

private delegate bool EnumUILanguagesProc(IntPtr lpUILanguageString, EnumContext lParam);

private class EnumContext
{
public readonly List<CultureInfo> InstalledCultures = new();
}
}
}
}

0 comments on commit 35a0c5b

Please sign in to comment.