Introduce Command Not Found module (#26319)

* Introduce Command Not Found module * rewrite module to depend on WinGet PowerShell module * address Dongbo's feedback * try and implement settings UI * fix SUI build; try and store PowerShell object * add and use object pool * apply Dongbo's feedback * add warm up; implement IPooledObjectPolicy * Add module interface * WIP trying to import module from settings * Add EnableModule.ps1 * spellcheck * spellcheck again * Installer. Add DisableModule.ps1 * Fix styling * Give the user some output from installing * Prettify the Settings controls * Add button to check PowerShell 7's version * Fix Settings Assets paths * Fix PowerShell 7 output * Make module enable and disable scripts give better information * Fix spellcheck * Fix image files and placeholders * Don't remove CmdNotFound on upgrade and don't fail on uninstall of CmdNotFound * Consistent install module scripts location on debug and installed * installer: Avoid messageboxes and hide powershell on uninstalling CmdNotFound * Fix psd1 file resolution when installed * Fix spellcheck * Add telemetry events * Fix gpo files * If GPO is set, enable/disable module on PT start depending on gpo value * Cleanup module interface * Cleanup settings code * If GPO is set, disable Settings page logic * Adding icons * Update settings UI and strings * Add telemetry for suggestions and feedbacks * Fix sln file * Fix build * minor fixes * Updating icon * Remove global.json * Remove unused PowerShell dependency * Don't use preview version of Automation and fix NOTICE * Fix signing * Fix NOTICE.md * Fix version checking for getfilesiginforedist.dll * Fix spellchecker * Fix README.md * Fix false positives section in expect.txt * Add logs to module interface --------- Co-authored-by: Stefan Markovic <stefan@janeasystems.com> Co-authored-by: Jaime Bernardo <jaime@janeasystems.com> Co-authored-by: Niels Laute <niels.laute@live.nl>
2025-12-15 03:07:56 +01:00 · 2024-01-03 07:43:42 -08:00
parent 3b90f73bd0
commit 46f5316858
65 changed files with 1633 additions and 63 deletions
--- a/installer/PowerToysSetup/CmdNotFound.wxs
+++ b/installer/PowerToysSetup/CmdNotFound.wxs
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi"
+  xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
+
+  <?include $(sys.CURRENTDIR)\Common.wxi?>
+
+  <Fragment>
+    <DirectoryRef Id="INSTALLFOLDER" FileSource="$(var.BinDir)">
+      <!-- !Warning! Make sure to change Component Guid if you update the file list -->
+      <Component Id="Module_CmdNotFound" Win64="yes" Guid="80F648F2-29F6-4685-AED4-04DC1B6EE176">
+        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
+          <RegistryValue Type="string" Name="Module_CmdNotFound" Value="" KeyPath="yes"/>
+        </RegistryKey>
+        <File Source="$(var.BinDir)WinGetCommandNotFound.psd1" />
+        <!-- The dll files will be picked up by BaseApplications generateAllFileComponents.ps1-->
+      </Component>
+    </DirectoryRef>
+
+    <ComponentGroup Id="CmdNotFoundComponentGroup">
+      <ComponentRef Id="Module_CmdNotFound" />
+    </ComponentGroup>
+
+  </Fragment>
+</Wix>
--- a/installer/PowerToysSetup/Common.wxi
+++ b/installer/PowerToysSetup/Common.wxi
@@ -18,6 +18,7 @@
  <?define PastePlainProjectName="PastePlain"?>
  <?define RegistryPreviewProjectName="RegistryPreview"?>
  <?define PeekProjectName="Peek"?>
+  <?define CmdNotFoundProjectName="CmdNotFound"?>
  
  <?define RepoDir="$(var.ProjectDir)..\..\" ?>
  <?if $(var.Platform) = x64?>
--- a/installer/PowerToysSetup/PowerToysInstaller.wixproj
+++ b/installer/PowerToysSetup/PowerToysInstaller.wixproj
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="4.0" DefaultTargets="Build" InitialTargets="EnsureNuGetPackageBuildImports" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project ToolsVersion="4.0" DefaultTargets="Build" InitialTargets="EnsureNuGetPackageBuildImports"
+  xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <Import Project="..\wix.props" Condition="Exists('..\wix.props')" />
  <Import Project="..\..\src\Version.props" />
  <PropertyGroup Condition="'$(Platform)' == 'x64'">
@@ -14,7 +15,7 @@ SET PTRoot=$(SolutionDir)\..
 call "..\..\..\publish.cmd" x64
 )
 call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs"
-</PreBuildEvent>
+    </PreBuildEvent>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Platform)' != 'x64'">
@@ -25,7 +26,7 @@ SET PTRoot=$(SolutionDir)\..
 call "..\..\..\publish.cmd" arm64
 )
 call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuildThisFileDirectory)\generateMonacoWxs.ps1 -monacoWxsFile "$(MSBuildThisFileDirectory)\MonacoSRC.wxs"
-</PreBuildEvent>
+    </PreBuildEvent>
  </PropertyGroup>
  <PropertyGroup>
    <RunPostBuildEvent>Always</RunPostBuildEvent>
@@ -67,7 +68,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil

  <PropertyGroup>
    <!-- We do not support debug installer builds -->
-    <Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration> 
+    <Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
    <Platform>$(Platform)</Platform>
    <ProductVersion>3.10</ProductVersion>
    <ProjectGuid>022a9d30-7c4f-416d-a9df-5ff2661cc0ad</ProjectGuid>
@@ -103,6 +104,7 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil

    <Compile Include="Awake.wxs" />
    <Compile Include="BaseApplications.wxs" />
+    <Compile Include="CmdNotFound.wxs" />
    <Compile Include="ColorPicker.wxs" />
    <Compile Include="EnvironmentVariables.wxs" />
    <Compile Include="FileExplorerPreview.wxs" />
@@ -180,17 +182,6 @@ call powershell.exe -NonInteractive -executionpolicy Unrestricted -File $(MSBuil
 	<Target Name="AfterBuild">
 	</Target> -->
  <Target Name="BeforeBuild">
-    <HeatDirectory Directory="..\..\src\common\FilePreviewCommon\Assets\Monaco\monacoSRC"
-      PreprocessorVariable="var.MonacoSRCHarvestPath"
-      OutputFile="MonacoSRC.wxs"
-      ComponentGroupName="MonacoSRCHeatGenerated"
-      DirectoryRefId="MonacoPreviewHandlerMonacoSRCFolder"
-      AutogenerateGuids="false"
-      GenerateGuidsNow="true" 
-      ToolPath="$(WixToolPath)"
-      RunAsSeparateProcess="true"
-      SuppressFragments="false"
-      SuppressRegistry="false"
-      SuppressRootDirectory="true"/>
+    <HeatDirectory Directory="..\..\src\common\FilePreviewCommon\Assets\Monaco\monacoSRC" PreprocessorVariable="var.MonacoSRCHarvestPath" OutputFile="MonacoSRC.wxs" ComponentGroupName="MonacoSRCHeatGenerated" DirectoryRefId="MonacoPreviewHandlerMonacoSRCFolder" AutogenerateGuids="false" GenerateGuidsNow="true" ToolPath="$(WixToolPath)" RunAsSeparateProcess="true" SuppressFragments="false" SuppressRegistry="false" SuppressRootDirectory="true"/>
  </Target>
 </Project>
--- a/installer/PowerToysSetup/Product.wxs
+++ b/installer/PowerToysSetup/Product.wxs
@@ -72,6 +72,7 @@
      <ComponentGroupRef Id="VideoConferenceComponentGroup" />
      <ComponentGroupRef Id="MouseWithoutBordersComponentGroup" />
      <ComponentGroupRef Id="EnvironmentVariablesComponentGroup" />
+      <ComponentGroupRef Id="CmdNotFoundComponentGroup" />
        
      <ComponentGroupRef Id="ResourcesComponentGroup" />
      <ComponentGroupRef Id="WindowsAppSDKComponentGroup" />
@@ -133,6 +134,7 @@
    <InstallExecuteSequence>
      <Custom Action="DetectPrevInstallPath" After="AppSearch" />
      <Custom Action="SetLaunchPowerToysParam" Before="LaunchPowerToys" />
+      <Custom Action="SetUninstallCommandNotFoundParam" Before="UninstallCommandNotFound" />
      <Custom Action="SetApplyModulesRegistryChangeSetsParam" Before="ApplyModulesRegistryChangeSets" />
      <Custom Action="SetUnApplyModulesRegistryChangeSetsParam" Before="UnApplyModulesRegistryChangeSets" />
      <Custom Action="CheckGPO" After="InstallInitialize">
@@ -159,6 +161,9 @@
      <Custom Action="UnRegisterContextMenuPackages" Before="RemoveFiles">
        Installed AND (REMOVE="ALL")
      </Custom>
+      <Custom Action="UninstallCommandNotFound" Before="RemoveFiles">
+        Installed AND (NOT UPGRADINGPRODUCTCODE) AND (REMOVE="ALL")
+      </Custom>
      <Custom Action="UninstallServicesTask" After="InstallFinalize">
          Installed AND (NOT UPGRADINGPRODUCTCODE) AND (REMOVE="ALL")
      </Custom>
@@ -200,6 +205,10 @@
                    Property="UnApplyModulesRegistryChangeSets"
                    Value="[INSTALLFOLDER]" />

+    <CustomAction Id="SetUninstallCommandNotFoundParam"
+                    Property="UninstallCommandNotFound"
+                    Value="[INSTALLFOLDER]" />
+
    <CustomAction Id="SetCreateWinAppSDKHardlinksParam"
                    Property="CreateWinAppSDKHardlinks"
                    Value="[INSTALLFOLDER]" />
@@ -252,7 +261,15 @@
                    BinaryKey="PTCustomActions"
                    DllEntry="UninstallServicesCA"
                   />
-      
+
+      <CustomAction Id="UninstallCommandNotFound"
+                    Return="ignore"
+                    Impersonate="yes"
+                    Execute="deferred"
+                    BinaryKey="PTCustomActions"
+                    DllEntry="UninstallCommandNotFoundModuleCA"
+                   />
+
      <CustomAction Id="TelemetryLogInstallSuccess"
              Return="ignore"
              Impersonate="yes"
--- a/installer/PowerToysSetup/Settings.wxs
+++ b/installer/PowerToysSetup/Settings.wxs
@@ -19,12 +19,14 @@
  <Fragment>
    <DirectoryRef Id="WinUI3AppsAssetsFolder">
      <Directory Id="SettingsV2AssetsInstallFolder" Name="Settings">
+        <Directory Id="SettingsAppAssetsScriptsFolder" Name="Scripts"/>
        <Directory Id="SettingsV2OOBEAssetsFluentIconsInstallFolder" Name="FluentIcons" />
        <Directory Id="SettingsV2AssetsModulesInstallFolder" Name="Modules" >
          <Directory Id="SettingsV2OOBEAssetsModulesInstallFolder" Name="OOBE" />
        </Directory>
      </Directory>
    </DirectoryRef>
+
    <DirectoryRef Id="SettingsV2AssetsInstallFolder" FileSource="$(var.SettingsV2AssetsFilesPath)">
    <!-- Generated by generateFileComponents.ps1 -->
    <!--SettingsV2AssetsFiles_Component_Def-->
@@ -45,6 +47,16 @@
    <!--SettingsV2OOBEAssetsFluentIconsFiles_Component_Def-->
    </DirectoryRef>

+    <DirectoryRef Id="SettingsAppAssetsScriptsFolder" FileSource="$(var.SettingsV2AssetsFilesPath)\Scripts\">
+      <Component Id="CommandNotFound_Scripts" Win64="yes" Guid="898EFA1E-EDD3-4F4B-8C7F-4A14B0D05B02">
+        <RegistryKey Root="$(var.RegistryScope)" Key="Software\Classes\powertoys\components">
+          <RegistryValue Type="string" Name="CommandNotFound_Scripts" Value="" KeyPath="yes"/>
+        </RegistryKey>
+        <File Id="CommandNotFound_Scripts_EnableModule.ps1" Source="$(var.SettingsV2AssetsFilesPath)\Scripts\EnableModule.ps1" />
+        <File Id="CommandNotFound_Scripts_DisableModule.ps1" Source="$(var.SettingsV2AssetsFilesPath)\Scripts\DisableModule.ps1" />
+      </Component>
+    </DirectoryRef>
+
    <ComponentGroup Id="SettingsComponentGroup">

      <Component Id="RemoveSettingsFolder" Guid="2D3AEF68-4E5A-4FF9-A5C0-9E53391AC754" Directory="SettingsV2AssetsInstallFolder" >
@@ -55,7 +67,9 @@
        <RemoveFolder Id="RemoveFolderSettingsV2OOBEAssetsFluentIconsInstallFolder" Directory="SettingsV2OOBEAssetsFluentIconsInstallFolder" On="uninstall"/>
        <RemoveFolder Id="RemoveFolderSettingsV2AssetsModulesInstallFolder" Directory="SettingsV2AssetsModulesInstallFolder" On="uninstall"/>
        <RemoveFolder Id="RemoveFolderSettingsV2OOBEAssetsModulesInstallFolder" Directory="SettingsV2OOBEAssetsModulesInstallFolder" On="uninstall"/>
+        <RemoveFolder Id="RemoveFolderSettingsAppAssetsScriptsFolder" Directory="SettingsAppAssetsScriptsFolder" On="uninstall"/>
      </Component>
+      <ComponentRef Id="CommandNotFound_Scripts"/>
    </ComponentGroup>

  </Fragment>
--- a/installer/PowerToysSetupCustomActions/CustomAction.cpp
+++ b/installer/PowerToysSetupCustomActions/CustomAction.cpp
@@ -433,7 +433,29 @@ UINT __stdcall RemoveWindowsServiceByName(std::wstring serviceName)
    return ERROR_SUCCESS;
 }

+UINT __stdcall UninstallCommandNotFoundModuleCA(MSIHANDLE hInstall)
+{
+    HRESULT hr = S_OK;
+    UINT er = ERROR_SUCCESS;
+    std::wstring installationFolder;
+    std::string command;

+    hr = WcaInitialize(hInstall, "UninstallCommandNotFoundModule");
+    ExitOnFailure(hr, "Failed to initialize");
+
+    hr = getInstallFolder(hInstall, installationFolder);
+    ExitOnFailure(hr, "Failed to get installFolder.");
+
+    command = "pwsh.exe";
+    command += " ";
+    command += "-NoProfile -NonInteractive -NoLogo -WindowStyle Hidden -ExecutionPolicy Unrestricted -File \"" + winrt::to_string(installationFolder) + "\\WinUI3Apps\\Assets\\Settings\\Scripts\\DisableModule.ps1" + "\"";
+
+    system(command.c_str());
+
+LExit:
+    er = SUCCEEDED(hr) ? ERROR_SUCCESS : ERROR_INSTALL_FAILURE;
+    return WcaFinalize(er);
+}

 UINT __stdcall UninstallServicesCA(MSIHANDLE hInstall)
 {
--- a/installer/PowerToysSetupCustomActions/CustomAction.def
+++ b/installer/PowerToysSetupCustomActions/CustomAction.def
@@ -22,4 +22,5 @@ EXPORTS
 	UninstallVirtualCameraDriverCA
 	UnRegisterContextMenuPackagesCA
 	UninstallEmbeddedMSIXCA
-	UninstallServicesCA
+	UninstallServicesCA
+	UninstallCommandNotFoundModuleCA