Font Install, Uninstall, additional Font List (microsoft#5566)

Implements a good chunk of microsoft#166  Key features and changes:

All of the below are experimental behind the fonts experimental feature.
Font install is implemented as a winget-common installer that models
most of the font install behavior of the operating system in its key
components. It deviates from a normal font install in that the install
locations and registry key paths are a little different in order to map
fonts to an identifiable version-specific deterministic location. This
is so we may more easily identify font packages and remove them and
avoid font collisions, torn state, or removing fonts from other
packages.

**Font List update**
- Added new font list "--files" option that lists fonts by installed
files and their known validity state
- Fonts are listed by file where they are located and have an assigned
identifier for later use in removal.
- The Font Status reflects whether the registry matches an actual font
file on disk (fonts without a file are labeled "Corrupt").
- The intent here is to add filters later to get a better idea of what
fonts are on the system, where they came from, and which might need
repair or removal. At present my system had over 300 font files
installed so the list is quite large.

**Font Install**
- Add font support for install. This is the base WinGet install command,
not the 'font' sub-command.
- Requires font experimental feature to be enabled.
- Added the core Font evaluation code to AppInstallerCommonCore so it is
not strictly bound to the CLI.
- The font install scheme puts WinGet installed font packages in sub
folders and subkeys where they can exist side-by-side with other font
packages without worry of file collision and easier high-confidence
removal/upgrade and rollback.
- Registers the font with the current session and notifies other apps of
the new font availability.
- Configures the font to be loaded on subsequent sessions.
- Install works for machine and user fonts.

**Font Uninstall*
- Added font support for uninstall. This is the base WinGet uninstall
command, not the 'font' sub-command.
- Requires font Experimental feature to be enabled.
- Uninstall works for WinGet-installed fonts only at this time.

** Font List*
- Added font package detection to the PredefinedInstalledSource.
- This allows font packages to be detected for uninstall.

**Workflows**
- Support for Font Install and Uninstall

**Tested**
- Added many unit tests which exercise the the Font install, uninstall,
information gathering, listing, for machine and user scopes. All of the
new core code added is exercised in unit tests.
- All scopes for install using unit tests and local web server.
- Install and uninstall with manifest an local server. 
- Install and uninstall and list with package from a private package
source.
- Verified ACLs on the folders match expected permissions for
visibility.
- Verified per-user and per-machine fonts are installed correctly and
show up in Font Settings immediately.

**NOT part of this PR and is likely a future PR**
- Font upgrade (a new version will be installed side-by-side)
- Uninstall of non-packaged fonts. This is in plan, just not in the
scope of this PR.

- [x] I have signed the [Contributor License
Agreement](https://cla.opensource.microsoft.com/microsoft/winget-pkgs).
- [x] I have updated the [Release Notes](../doc/ReleaseNotes.md).
- [x] This pull request is related to an issue.

-----

###### Microsoft Reviewers: [Open in
CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/microsoft/winget-cli/pull/5566)

---------

Co-authored-by: Muhammad Danish <[email protected]>
Co-authored-by: Kaleb Luedtke <[email protected]>

Author: 3 people

.github/actions/spelling/expect.txt

@@ -177,6 +177,8 @@ flargle
 flexera
 FOF
 FOLDERID
+FONTCHANGE
+FONTHASH
 FORPARSING
 foundfr
 fsanitize
@@ -417,12 +419,15 @@ placeholders
 PMS
 positionals
 posix
+postuninstall
 powershellgallery
 pri
 PRIMARYKEY
 processthreads
 productcode
 PRODUCTICON
+propkey
+PROPVARIANT
 proxystub
 pscustomobject
 pseudocode
@@ -437,6 +442,7 @@ pvm
 pwabuilder
 PWAs
 PWSTR
+pwsz
 QUERYENDSESSION
 qword
 RAII
@@ -604,6 +610,7 @@ wincodec
 windir
 windowsdeveloper
 winerror
+wingdi
 wingetconfigroot
 wingetcreate
 wingetdev

doc/ReleaseNotes.md

@@ -20,5 +20,9 @@ The following snippet enables experimental support for fonts via `winget setting
     "fonts": true
   }
 }
-
 ```
+Manifest Schema version updated to 1.12.0 to add support for fonts.
+
+Experimental initial Font Install and Uninstall via manifest for user and machine scopes has been added.
+
+The font 'list' command has been updated with a new '--details' feature for an alternate view of the installed fonts.

doc/windows/package-manager/winget/returnCodes.md

@@ -146,6 +146,13 @@ ms.localizationpriority: medium
 | 0x8A150084 | -1978335100 | APPINSTALLER_CLI_ERROR_SFSCLIENT_PACKAGE_NOT_SUPPORTED | The Microsoft Store package does not support download command. |
 | 0x8A150085 | -1978335099 | APPINSTALLER_CLI_ERROR_LICENSING_API_FAILED_FORBIDDEN | Failed to retrieve Microsoft Store package license. The Microsoft Entra Id account does not have required privilege. |
 | 0x8A150086 | -1978335098 | APPINSTALLER_CLI_ERROR_INSTALLER_ZERO_BYTE_FILE | Downloaded zero byte installer; ensure that your network connection is working properly. |
+| 0x8A150087 | -1979335097 | APPINSTALLER_CLI_ERROR_FONT_INSTALL_FAILED | Failed installing one or more fonts. |
+| 0x8A150088 | -1979335096 | APPINSTALLER_CLI_ERROR_FONT_FILE_NOT_SUPPORTED | Font file is not supported and cannot be installed. |
+| 0x8A150089 | -1979335095 | APPINSTALLER_CLI_ERROR_FONT_ALREADY_INSTALLED | Font package is already installed. |
+| 0x8A15008A | -1979335094 | APPINSTALLER_CLI_ERROR_FONT_FILE_NOT_FOUND | Font file not found. |
+| 0x8A15008B | -1979335093 | APPINSTALLER_CLI_ERROR_FONT_UNINSTALL_FAILED | Font uninstall failed. The font may not be in a good state. Try uninstalling after a restart. |
+| 0x8A15008C | -1979335092 | APPINSTALLER_CLI_ERROR_FONT_VALIDATION_FAILED | Font validation failed. |
+| 0x8A15008D | -1979335091 | APPINSTALLER_CLI_ERROR_FONT_ROLLBACK_FAILED | Font rollback failed. The font may not be in a good state. Try uninstalling after a restart. |
 
 ## Install errors.
 
@@ -170,7 +177,7 @@ ms.localizationpriority: medium
 | 0x8A150111 | -1978334959 | APPINSTALLER_CLI_ERROR_INSTALL_PACKAGE_IN_USE_BY_APPLICATION | Application is currently in use by another application. |
 | 0x8A150112 | -1978334958 | APPINSTALLER_CLI_ERROR_INSTALL_INVALID_PARAMETER | Invalid parameter. |
 | 0x8A150113 | -1978334957 | APPINSTALLER_CLI_ERROR_INSTALL_SYSTEM_NOT_SUPPORTED | Package not supported by the system. |
-| 0x8A150114 | -1978334956 | APPINSTALLER_CLI_ERROR_INSTALL_UPGRADE_NOT_SUPPORTED | The installer does not support upgrading an existing package. |
+| 0x8A150114 | -1978334956 | APPINSTALLER_CLI_ERROR_INSTALL_UPGRADE_NOT_SUPPORTED | The installer does not support upgrading an existing package. |
 | 0x8A150115 | -1978334955 | APPINSTALLER_CLI_ERROR_INSTALL_CUSTOM_ERROR | Installation failed with installer custom error. |
 
 ## Check for package installed status

src/AppInstallerCLICore/Argument.cpp

@@ -203,6 +203,8 @@ namespace AppInstaller::CLI
         // Font command
         case Execution::Args::Type::Family:
             return { type, "family"_liv, ArgTypeCategory::None };
+        case Execution::Args::Type::Details:
+            return { type, "details"_liv, ArgTypeCategory::None };
 
         // Configuration commands
         case Execution::Args::Type::ConfigurationFile:
@@ -472,6 +474,8 @@ namespace AppInstaller::CLI
             return Argument{ type, Resource::String::NoProxyArgumentDescription, ArgumentType::Flag, TogglePolicy::Policy::ProxyCommandLineOptions, BoolAdminSetting::ProxyCommandLineOptions };
         case Args::Type::Family:
             return Argument{ type, Resource::String::FontFamilyNameArgumentDescription, ArgumentType::Positional, false };
+        case Args::Type::Details:
+            return Argument{ type, Resource::String::FontDetailsArgumentDescription, ArgumentType::Flag, false };
         case Args::Type::Correlation:
             return Argument{ type, Resource::String::CorrelationArgumentDescription, ArgumentType::Standard, Argument::Visibility::Hidden };
         default:

src/AppInstallerCLICore/Commands/FontCommand.cpp

@@ -3,8 +3,8 @@
 #include "pch.h"
 #include "FontCommand.h"
 #include "Workflows/CompletionFlow.h"
-#include "Workflows/WorkflowBase.h"
 #include "Workflows/FontFlow.h"
+#include "Workflows/WorkflowBase.h"
 #include "Resources.h"
 
 namespace AppInstaller::CLI
@@ -16,6 +16,8 @@ namespace AppInstaller::CLI
 
     Utility::LocIndView s_FontCommand_HelpLink = "https://aka.ms/winget-command-font"_liv;
 
+    // Base Font Command
+
     std::vector<std::unique_ptr<Command>> FontCommand::GetCommands() const
     {
         return InitializeFromMoveOnly<std::vector<std::unique_ptr<Command>>>({
@@ -43,17 +45,13 @@ namespace AppInstaller::CLI
         OutputHelp(context.Reporter);
     }
 
+    // FontListCommand
+
     std::vector<Argument> FontListCommand::GetArguments() const
     {
         return {
             Argument::ForType(Args::Type::Family),
-            Argument::ForType(Args::Type::Moniker),
-            Argument::ForType(Args::Type::Source),
-            Argument::ForType(Args::Type::Tag),
-            Argument::ForType(Args::Type::Exact),
-            Argument::ForType(Args::Type::AuthenticationMode),
-            Argument::ForType(Args::Type::AuthenticationAccount),
-            Argument::ForType(Args::Type::AcceptSourceAgreements),
+            Argument::ForType(Args::Type::Details),
         };
     }
 

src/AppInstallerCLICore/ExecutionArgs.h

@@ -125,6 +125,7 @@ namespace AppInstaller::CLI::Execution
 
             // Font Command
             Family,
+            Details,
 
             // Stub package (extended features)
             ExtendedFeaturesEnable,

src/AppInstallerCLICore/Resources.h

@@ -303,16 +303,30 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(FileNotFound);
         WINGET_DEFINE_RESOURCE_STRINGID(FilesRemainInInstallDirectory);
         WINGET_DEFINE_RESOURCE_STRINGID(FlagContainAdjoinedError);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontAlreadyInstalled);
         WINGET_DEFINE_RESOURCE_STRINGID(FontCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(FontCommandShortDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(FontFace);
         WINGET_DEFINE_RESOURCE_STRINGID(FontFaces);
         WINGET_DEFINE_RESOURCE_STRINGID(FontFamily);
         WINGET_DEFINE_RESOURCE_STRINGID(FontFamilyNameArgumentDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontFileNotSupported);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontDetailsArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(FontFilePaths);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontInstallFailed);
         WINGET_DEFINE_RESOURCE_STRINGID(FontListCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(FontListCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontPackage);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontRollbackFailed);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontStatus);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontStatusCorrupt);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontStatusOK);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontStatusUnknown);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontTitle);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontUninstallFailed);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontValidationFailed);
         WINGET_DEFINE_RESOURCE_STRINGID(FontVersion);
+        WINGET_DEFINE_RESOURCE_STRINGID(FontWinGetSupported);
         WINGET_DEFINE_RESOURCE_STRINGID(ForceArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(GatedVersionArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(GetManifestResultVersionNotFound);
@@ -461,8 +475,8 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(MSStoreStoreClientBlocked);
         WINGET_DEFINE_RESOURCE_STRINGID(MultipleExclusiveArgumentsProvided);
         WINGET_DEFINE_RESOURCE_STRINGID(MultipleInstalledPackagesFound);
-        WINGET_DEFINE_RESOURCE_STRINGID(MultipleNonPortableNestedInstallersSpecified);
         WINGET_DEFINE_RESOURCE_STRINGID(MultiplePackagesFound);
+        WINGET_DEFINE_RESOURCE_STRINGID(MultipleUnsupportedNestedInstallersSpecified);
         WINGET_DEFINE_RESOURCE_STRINGID(MultiQueryArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(MultiQueryPackageAlreadyInstalled);
         WINGET_DEFINE_RESOURCE_STRINGID(MultiQueryPackageNotFound);

src/AppInstallerCLICore/Workflows/ArchiveFlow.cpp

@@ -106,7 +106,7 @@ namespace AppInstaller::CLI::Workflow
                     << std::endl;
                 AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_NESTEDINSTALLER_NOT_FOUND);
             }
-            else if (!IsPortableType(installer.NestedInstallerType))
+            else if (!DoesInstallerTypeSupportMultipleNestedInstallers(installer.NestedInstallerType))
             {
                 // Update the installerPath to the extracted non-portable installer. 
                 AICLI_LOG(CLI, Info, << "Setting installerPath to: " << nestedInstallerPath);
@@ -138,10 +138,10 @@ namespace AppInstaller::CLI::Workflow
                 AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_INVALID_MANIFEST);
             }
 
-            if (installer.NestedInstallerType != InstallerTypeEnum::Portable && nestedInstallerFiles.size() != 1)
+            if (!DoesInstallerTypeSupportMultipleNestedInstallers(installer.NestedInstallerType) && (nestedInstallerFiles.size() != 1))
             {
-                AICLI_LOG(CLI, Error, << "Multiple nested installers specified for non-portable nested installerType");
-                context.Reporter.Error() << Resource::String::MultipleNonPortableNestedInstallersSpecified << std::endl;
+                AICLI_LOG(CLI, Error, << "Multiple nested installers specified for unsupported nested installerType");
+                context.Reporter.Error() << Resource::String::MultipleUnsupportedNestedInstallersSpecified << std::endl;
                 AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_INVALID_MANIFEST);
             }
         }

src/AppInstallerCLICore/Workflows/DownloadFlow.cpp

@@ -63,6 +63,18 @@ namespace AppInstaller::CLI::Workflow
                 return L".msix"sv;
             case InstallerTypeEnum::Zip:
                 return L".zip"sv;
+            case InstallerTypeEnum::Font:
+                {
+                    const auto& fileName = GetFileNameFromURI(installer->Url);
+                    if (fileName.has_extension())
+                    {
+                        return fileName.extension().c_str();
+                    }
+                    else
+                    {
+                        THROW_HR(HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED));
+                    }
+                }
             default:
                 THROW_HR(HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED));
             }
@@ -288,6 +300,7 @@ namespace AppInstaller::CLI::Workflow
             case InstallerTypeEnum::Nullsoft:
             case InstallerTypeEnum::Portable: 
             case InstallerTypeEnum::Wix:
+            case InstallerTypeEnum::Font:
             case InstallerTypeEnum::Zip:
                 context << DownloadInstallerFile;
                 break;