From dab7930aead58f15d479c5c735739d45994fede3 Mon Sep 17 00:00:00 2001
From: Matthew John Cheetham <mjcheetham@outlook.com>
Date: Tue, 21 Jun 2022 13:14:36 +0100
Subject: [PATCH] windows: generate app manifests for all exe projects

Automatically generate the correct application manifest for Windows
executable projects that we produce. The manifests are required on
Windows systems newer than Windows 8 to correctly access versioning
APIs that will otherwise always report "Windows 8", even on later
versions.

The manifest we generate states we are compatible with all versions of
Windows from 7 to 11 (inclusive).
---
 Directory.Build.props               |  6 ++++
 Directory.Build.targets             | 27 +++++++++++++++
 build/GCM.MSBuild.csproj            | 13 ++++++++
 build/GCM.tasks                     | 16 +++++++++
 build/GenerateWindowsAppManifest.cs | 51 +++++++++++++++++++++++++++++
 5 files changed, 113 insertions(+)
 create mode 100644 Directory.Build.targets
 create mode 100644 build/GCM.MSBuild.csproj
 create mode 100644 build/GCM.tasks
 create mode 100644 build/GenerateWindowsAppManifest.cs

diff --git a/Directory.Build.props b/Directory.Build.props
index 7f78555c7..3abe378a3 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -18,6 +18,12 @@
     <RepoSrcPath>$(RepoPath)src\</RepoSrcPath>
     <RepoOutPath>$(RepoPath)out\</RepoOutPath>
     <RepoAssetsPath>$(RepoPath)assets\</RepoAssetsPath>
+
+    <!-- Identify projects that output an executable binary (not libraries) -->
+    <_IsExeProject Condition="'$(OutputType)' == 'Exe' OR '$(OutputType)' == 'WinExe'">true</_IsExeProject>
+
+    <!-- Automatically generate a Windows app manifest on Windows for exe projects -->
+    <GenerateWindowsAppManifest Condition="'$(GenerateWindowsAppManifest)' == '' AND '$(OSPlatform)' == 'windows' AND '$(_IsExeProject)' == 'true'">true</GenerateWindowsAppManifest>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Directory.Build.targets b/Directory.Build.targets
new file mode 100644
index 000000000..3c84f230d
--- /dev/null
+++ b/Directory.Build.targets
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!-- This is the root Directory.Build.targets file -->
+
+  <!-- Load custom build tasks -->
+  <Import Project="$(RepoPath)build\GCM.tasks" />
+
+  <!-- Windows application manifest generation -->
+  <PropertyGroup Condition="'$(GenerateWindowsAppManifest)' != 'false'">
+    <ApplicationManifest>$(IntermediateOutputPath)app.manifest</ApplicationManifest>
+  </PropertyGroup>
+
+  <!-- Generate the manifest file before we set the win32 manifest properties -->
+  <Target Name="GenerateWindowsAppManifest"
+          BeforeTargets="SetWin32ManifestProperties"
+          Condition="'$(GenerateWindowsAppManifest)' != 'false'"
+          Inputs="$(FileVersion);$(AssemblyName)"
+          Outputs="$(IntermediateOutputPath)app.manifest">
+    <GenerateWindowsAppManifest Version="$(FileVersion)"
+                                ApplicationName="$(AssemblyName)"
+                                OutputFile="$(IntermediateOutputPath)app.manifest"/>
+    <ItemGroup>
+      <FileWrites Include="$(IntermediateOutputPath)app.manifest" />
+    </ItemGroup>
+  </Target>
+
+</Project>
diff --git a/build/GCM.MSBuild.csproj b/build/GCM.MSBuild.csproj
new file mode 100644
index 000000000..7dbe90afe
--- /dev/null
+++ b/build/GCM.MSBuild.csproj
@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Build.Framework" Version="16.0.461" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.0.461" PrivateAssets="all" />
+  </ItemGroup>
+
+</Project>
diff --git a/build/GCM.tasks b/build/GCM.tasks
new file mode 100644
index 000000000..fe7031f34
--- /dev/null
+++ b/build/GCM.tasks
@@ -0,0 +1,16 @@
+<Project>
+    <PropertyGroup Condition="'$(MSBuildRuntimeType)' == 'Mono'">
+        <_TaskAssembly>$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll</_TaskAssembly>
+        <_TaskFactory>CodeTaskFactory</_TaskFactory>
+    </PropertyGroup>
+    <PropertyGroup Condition="'$(MSBuildRuntimeType)' != 'Mono'">
+        <_TaskAssembly>$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll</_TaskAssembly>
+        <_TaskFactory>RoslynCodeTaskFactory</_TaskFactory>
+    </PropertyGroup>
+
+    <UsingTask TaskName="GenerateWindowsAppManifest" TaskFactory="$(_TaskFactory)" AssemblyFile="$(_TaskAssembly)">
+        <Task>
+            <Code Type="Class" Source="$(MSBuildThisFileDirectory)GenerateWindowsAppManifest.cs" />
+        </Task>
+    </UsingTask>
+</Project>
diff --git a/build/GenerateWindowsAppManifest.cs b/build/GenerateWindowsAppManifest.cs
new file mode 100644
index 000000000..58a94c5a1
--- /dev/null
+++ b/build/GenerateWindowsAppManifest.cs
@@ -0,0 +1,51 @@
+using Microsoft.Build.Framework;
+using Microsoft.Build.Utilities;
+using System.IO;
+
+namespace GitCredentialManager.MSBuild
+{
+    public class GenerateWindowsAppManifest : Task
+    {
+        [Required]
+        public string Version { get; set; }
+
+        [Required]
+        public string ApplicationName { get; set; }
+
+        [Required]
+        public string OutputFile { get; set; }
+
+        public override bool Execute()
+        {
+            Log.LogMessage(MessageImportance.Normal, "Creating application manifest file for '{0}'...", ApplicationName);
+
+            string manifestDirectory = Path.GetDirectoryName(OutputFile);
+            if (!Directory.Exists(manifestDirectory))
+            {
+                Directory.CreateDirectory(manifestDirectory);
+            }
+
+            File.WriteAllText(
+                OutputFile,
+                $@"<?xml version=""1.0"" encoding=""utf-8""?>
+<assembly manifestVersion=""1.0"" xmlns=""urn:schemas-microsoft-com:asm.v1"">
+  <assemblyIdentity version=""{Version}"" name=""{ApplicationName}""/>
+  <compatibility xmlns=""urn:schemas-microsoft-com:compatibility.v1"">
+    <application>
+      <!-- Windows 10 and Windows 11 -->
+      <supportedOS Id=""{{8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a}}""/>
+      <!-- Windows 8.1 -->
+      <supportedOS Id=""{{1f676c76-80e1-4239-95bb-83d0f6d0da78}}""/>
+      <!-- Windows 8 -->
+      <supportedOS Id=""{{4a2f28e3-53b9-4441-ba9c-d69d4a4a6e38}}""/>
+      <!-- Windows 7 -->
+      <supportedOS Id=""{{35138b9a-5d96-4fbd-8e2d-a2440225f93a}}""/>
+    </application>
+  </compatibility>
+</assembly>
+");
+
+            return true;
+        }
+    }
+}