feat: file-based version/metadata (#168)

* initial support

* finish implementation

Author: ruattd

App/Basics.cs

@@ -2,26 +2,42 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using System.Reflection;
+using System.Text.Json;
 using System.Threading;
 using System.Windows;
 using PCL.Core.Logging;
 using PCL.Core.Utils;
 
 namespace PCL.Core.App;
 
+/// <summary>
+/// 基础工具集。
+/// </summary>
 public static class Basics
 {
     #region 基本信息
 
     /// <summary>
-    /// 当前版本名称。
+    /// 启动器元数据。
     /// </summary>
-    public static string VersionName { get; set; } = "";
+    public static MetadataModel Metadata { get; } = JsonSerializer.Deserialize<MetadataModel>(
+        Assembly.GetEntryAssembly()!.GetManifestResourceStream("PCL.metadata.json")!)!;
 
     /// <summary>
-    /// 当前版本号。
+    /// 版本名称。
     /// </summary>
-    public static int VersionNumber { get; set; } = 0;
+    public static string VersionName => Metadata.Version.BaseName;
+
+    /// <summary>
+    /// 版本内部代号。
+    /// </summary>
+    public static int VersionCode => Metadata.Version.Code;
+
+    /// <summary>
+    /// 版本分支名。
+    /// </summary>
+    public static string VersionBranch => Metadata.Version.BranchName;
 
     #endregion
 
@@ -135,6 +151,8 @@ public static void OpenPath(string path, string? workingDirectory = null)
     }
     #endregion
 
+    #region 应用程序操作
+
     /// <summary>
     /// 获取程序打包资源的输入流。该资源必须声明为 <c>Resource</c> 类型，否则将会报错，<c>Images</c>
     /// 和 <c>Resources</c> 目录已默认声明该类型。
@@ -148,4 +166,6 @@ public static void OpenPath(string path, string? workingDirectory = null)
 
     private const string AssemblyImagePath = "pack://application:,,,/Plain Craft Launcher 2;component/Images/";
     public static string GetAppImagePath(string imageName) => AssemblyImagePath + imageName;
+
+    #endregion
 }

App/Lifecycle.cs

@@ -9,7 +9,6 @@
 using System.Threading.Tasks;
 using System.Windows;
 using PCL.Core.Logging;
-using PCL.Core.Utils.OS;
 
 namespace PCL.Core.App;
 

App/Metadata.cs

@@ -0,0 +1,69 @@
+using System.Text.Json.Serialization;
+using PCL.Core.Utils.OS;
+
+namespace PCL.Core.App;
+
+/// <summary>
+/// 启动器版本信息模型
+/// </summary>
+/// <param name="BaseVersion">基本版本号, 如 <c>2.14.1</c></param>
+/// <param name="Suffix">后缀, 如 <c>beta.1</c></param>
+/// <param name="Code">内部版本代号, 如 <c>712</c></param>
+/// <param name="UpstreamVersion">上游版本, 如 <c>2.12.0</c></param>
+public sealed record LauncherVersionModel(
+    [property: JsonPropertyName("base")] string BaseVersion,
+    [property: JsonPropertyName("suffix")] string Suffix,
+    [property: JsonPropertyName("code")] int Code,
+    [property: JsonPropertyName("upstream")] string UpstreamVersion
+) {
+    private static readonly (string Name, int Code) _CompilationBranchInfo =
+#if DEBUG
+        ("Debug", 100);
+#elif CI
+        ("CI", 50);
+#else
+        ("Publish", 0);
+#endif
+
+    private static readonly string? _SecretCommitInfo = EnvironmentInterop.GetSecret("GITHUB_SHA", false);
+
+    /// <summary>
+    /// 基本版本名, 若 <see cref="Suffix"/> 存在实际值会附加后缀, 否则与 <see cref="BaseVersion"/> 相同
+    /// </summary>
+    public string BaseName { get; } = BaseVersion + (string.IsNullOrWhiteSpace(Suffix) ? "" : "-" + Suffix);
+    
+    /// <summary>
+    /// 发行分支名
+    /// </summary>
+    public string BranchName { get; } = _CompilationBranchInfo.Name;
+    
+    /// <summary>
+    /// 发行分支代号
+    /// </summary>
+    public int BranchCode { get; } = _CompilationBranchInfo.Code;
+    
+    /// <summary>
+    /// 标准版本号
+    /// </summary>
+    public string StandardVersion { get; } = BaseVersion + "." + _CompilationBranchInfo.Code;
+
+    /// <summary>
+    /// 代码提交版本 hash, 若不存在 (非 CI 构建) 则为 <c>native</c>
+    /// </summary>
+    public string Commit { get; } = _SecretCommitInfo ?? "native";
+
+    /// <summary>
+    /// 代码提交版本 hash 的摘要 (取前 7 位), 若不存在 (非 CI 构建) 则为 <c>native</c>
+    /// </summary>
+    public string CommitDigest { get; } = _SecretCommitInfo?[..7] ?? "native";
+}
+
+/// <summary>
+/// 启动器元数据模型
+/// </summary>
+/// <param name="Name">程序名称</param>
+/// <param name="Version">版本信息</param>
+public sealed record MetadataModel(
+    [property: JsonPropertyName("name")] string Name,
+    [property: JsonPropertyName("version")] LauncherVersionModel Version
+);

Net/Http/Client/HttpRequestBuilder.cs

@@ -238,7 +238,7 @@ private void _PrepareRequestParameters()
         if (_addLauncherHeader)
         {
             _request.Headers.TryAddWithoutValidation("User-Agent", $"PCL-Community/PCL2-CE/{Basics.VersionName} (pclc.cc)");
-            _request.Headers.TryAddWithoutValidation("Referer", $"https://{Basics.VersionNumber}.ce.open.pcl2.server/");
+            _request.Headers.TryAddWithoutValidation("Referer", $"https://{Basics.VersionCode}.ce.open.pcl2.server/");
         }
     }