File size: 6,383 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
using System.Management.Automation.Internal;
using System.Text;
namespace System.Management.Automation.Help
{
/// <summary>
/// Represents each supported culture.
/// </summary>
internal class CultureSpecificUpdatableHelp
{
/// <summary>
/// Class constructor.
/// </summary>
/// <param name="culture">Culture info.</param>
/// <param name="version">Version info.</param>
internal CultureSpecificUpdatableHelp(CultureInfo culture, Version version)
{
Debug.Assert(version != null);
Debug.Assert(culture != null);
Culture = culture;
Version = version;
}
/// <summary>
/// Culture version.
/// </summary>
internal Version Version { get; set; }
/// <summary>
/// Supported culture.
/// </summary>
internal CultureInfo Culture { get; set; }
/// <summary>
/// Enumerates fallback chain (parents) of the culture, including itself.
/// </summary>
/// <param name="culture">Culture to enumerate</param>
/// <example>
/// Examples:
/// en-GB => { en-GB, en }
/// zh-Hans-CN => { zh-Hans-CN, zh-Hans, zh }.
/// </example>
/// <returns>An enumerable list of culture names.</returns>
internal static IEnumerable<string> GetCultureFallbackChain(CultureInfo culture)
{
// We use just names instead because comparing two CultureInfo objects
// can fail if they are created using different means
while (culture != null)
{
if (string.IsNullOrEmpty(culture.Name))
{
yield break;
}
yield return culture.Name;
culture = culture.Parent;
}
}
/// <summary>
/// Checks if a culture is supported.
/// </summary>
/// <param name="cultureName">Name of the culture to check.</param>
/// <returns>True if supported, false if not.</returns>
internal bool IsCultureSupported(string cultureName)
{
Debug.Assert(cultureName != null, $"{nameof(cultureName)} may not be null");
return GetCultureFallbackChain(Culture).Any(fallback => fallback == cultureName);
}
}
/// <summary>
/// This class represents the HelpInfo metadata XML.
/// </summary>
internal class UpdatableHelpInfo
{
/// <summary>
/// Class constructor.
/// </summary>
/// <param name="unresolvedUri">Unresolved help content URI.</param>
/// <param name="cultures">Supported UI cultures.</param>
internal UpdatableHelpInfo(string unresolvedUri, CultureSpecificUpdatableHelp[] cultures)
{
Debug.Assert(cultures != null);
UnresolvedUri = unresolvedUri;
HelpContentUriCollection = new Collection<UpdatableHelpUri>();
UpdatableHelpItems = cultures;
}
/// <summary>
/// Unresolved URI.
/// </summary>
internal string UnresolvedUri { get; }
/// <summary>
/// Link to the actual help content.
/// </summary>
internal Collection<UpdatableHelpUri> HelpContentUriCollection { get; }
/// <summary>
/// Supported UI cultures.
/// </summary>
internal CultureSpecificUpdatableHelp[] UpdatableHelpItems { get; }
/// <summary>
/// Checks if the other HelpInfo has a newer version.
/// </summary>
/// <param name="helpInfo">HelpInfo object to check.</param>
/// <param name="culture">Culture to check.</param>
/// <returns>True if the other HelpInfo is newer, false if not.</returns>
internal bool IsNewerVersion(UpdatableHelpInfo helpInfo, CultureInfo culture)
{
Debug.Assert(helpInfo != null);
Version v1 = helpInfo.GetCultureVersion(culture);
Version v2 = GetCultureVersion(culture);
Debug.Assert(v1 != null);
if (v2 == null)
{
return true;
}
return v1 > v2;
}
/// <summary>
/// Checks if a culture is supported.
/// </summary>
/// <param name="cultureName">Name of the culture to check.</param>
/// <returns>True if supported, false if not.</returns>
internal bool IsCultureSupported(string cultureName)
{
Debug.Assert(cultureName != null, $"{nameof(cultureName)} may not be null");
return UpdatableHelpItems.Any(item => item.IsCultureSupported(cultureName));
}
/// <summary>
/// Gets a string representation of the supported cultures.
/// </summary>
/// <returns>Supported cultures in string.</returns>
internal string GetSupportedCultures()
{
if (UpdatableHelpItems.Length == 0)
{
return StringUtil.Format(HelpDisplayStrings.None);
}
StringBuilder sb = new StringBuilder();
for (int i = 0; i < UpdatableHelpItems.Length; i++)
{
sb.Append(UpdatableHelpItems[i].Culture.Name);
if (i != (UpdatableHelpItems.Length - 1))
{
sb.Append(" | ");
}
}
return sb.ToString();
}
/// <summary>
/// Gets the culture version.
/// </summary>
/// <param name="culture">Culture info.</param>
/// <returns>Culture version.</returns>
internal Version GetCultureVersion(CultureInfo culture)
{
foreach (CultureSpecificUpdatableHelp updatableHelpItem in UpdatableHelpItems)
{
if (string.Equals(updatableHelpItem.Culture.Name, culture.Name,
StringComparison.OrdinalIgnoreCase))
{
return updatableHelpItem.Version;
}
}
return null;
}
}
}
|