Implement package pinning

.github/actions/spelling/allow.txt

@@ -253,6 +253,7 @@ INVALIDARG
 INVALIDSID
 iomanip
 iostream
+IPinning
 IPortable
 ipmo
 ISAPPROVEDFOROUTPUT

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj

@@ -341,6 +341,7 @@
     <ClCompile Include="Workflows\ImportExportFlow.cpp" />
     <ClCompile Include="Workflows\MsiInstallFlow.cpp" />
     <ClCompile Include="Workflows\MSStoreInstallerHandler.cpp" />
+    <ClCompile Include="Workflows\PinFlow.cpp" />
     <ClCompile Include="Workflows\PortableFlow.cpp" />
     <ClCompile Include="Workflows\PromptFlow.cpp" />
     <ClCompile Include="Workflows\SettingsFlow.cpp" />

src/AppInstallerCLICore/AppInstallerCLICore.vcxproj.filters

@@ -349,8 +349,11 @@
     <ClCompile Include="PortableInstaller.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="Workflows\PinFlow.cpp">
+      <Filter>Workflows</Filter>
+    </ClCompile>
     <ClCompile Include="Commands\PinCommand.cpp">
-      <Filter>Source Files</Filter>
+      <Filter>Commands</Filter>
     </ClCompile>
   </ItemGroup>
   <ItemGroup>

src/AppInstallerCLICore/Commands/PinCommand.cpp

@@ -76,15 +76,26 @@ namespace AppInstaller::CLI
 
     void PinAddCommand::Complete(Execution::Context& context, Args::Type valueType) const
     {
+        context <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed);
+
         switch (valueType)
         {
-        case Args::Type::Query:
-        case Args::Type::Id:
-        case Args::Type::Name:
-        case Args::Type::Moniker:
-        case Args::Type::Source:
+        case Execution::Args::Type::Query:
+            context <<
+                Workflow::RequireCompletionWordNonEmpty <<
+                Workflow::SearchSourceForManyCompletion <<
+                Workflow::CompleteWithMatchedField;
+            break;
+        case Execution::Args::Type::Id:
+        case Execution::Args::Type::Name:
+        case Execution::Args::Type::Moniker:
+        case Execution::Args::Type::Source:
+        case Execution::Args::Type::Tag:
+        case Execution::Args::Type::Command:
             context <<
-                Workflow::CompleteWithSingleSemanticsForValue(valueType);
+                Workflow::CompleteWithSingleSemanticsForValueUsingExistingSource(valueType);
             break;
         }
     }
@@ -105,8 +116,17 @@ namespace AppInstaller::CLI
 
     void PinAddCommand::ExecuteInternal(Execution::Context& context) const
     {
-        // TODO
-        Command::ExecuteInternal(context);
+        context <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed) <<
+            Workflow::SearchSourceForSingle <<
+            Workflow::HandleSearchResultFailures <<
+            Workflow::EnsureOneMatchFromSearchResult(false) <<
+            Workflow::GetInstalledPackageVersion <<
+            Workflow::ReportPackageIdentity <<
+            Workflow::OpenPinningIndex <<
+            Workflow::SearchPin <<
+            Workflow::AddPin;
     }
 
     std::vector<Argument> PinRemoveCommand::GetArguments() const
@@ -137,15 +157,26 @@ namespace AppInstaller::CLI
 
     void PinRemoveCommand::Complete(Execution::Context& context, Args::Type valueType) const
     {
+        context <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed);
+
         switch (valueType)
         {
-        case Args::Type::Query:
-        case Args::Type::Id:
-        case Args::Type::Name:
-        case Args::Type::Moniker:
-        case Args::Type::Source:
+        case Execution::Args::Type::Query:
             context <<
-                Workflow::CompleteWithSingleSemanticsForValue(valueType);
+                Workflow::RequireCompletionWordNonEmpty <<
+                Workflow::SearchSourceForManyCompletion <<
+                Workflow::CompleteWithMatchedField;
+            break;
+        case Execution::Args::Type::Id:
+        case Execution::Args::Type::Name:
+        case Execution::Args::Type::Moniker:
+        case Execution::Args::Type::Source:
+        case Execution::Args::Type::Tag:
+        case Execution::Args::Type::Command:
+            context <<
+                Workflow::CompleteWithSingleSemanticsForValueUsingExistingSource(valueType);
             break;
         }
     }
@@ -157,8 +188,17 @@ namespace AppInstaller::CLI
 
     void PinRemoveCommand::ExecuteInternal(Execution::Context& context) const
     {
-        // TODO
-        Command::ExecuteInternal(context);
+        context <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed) <<
+            Workflow::SearchSourceForSingle <<
+            Workflow::HandleSearchResultFailures <<
+            Workflow::EnsureOneMatchFromSearchResult(false) <<
+            Workflow::GetInstalledPackageVersion <<
+            Workflow::ReportPackageIdentity <<
+            Workflow::OpenPinningIndex <<
+            Workflow::SearchPin <<
+            Workflow::RemovePin;
     }
 
     std::vector<Argument> PinListCommand::GetArguments() const
@@ -189,15 +229,26 @@ namespace AppInstaller::CLI
 
     void PinListCommand::Complete(Execution::Context& context, Args::Type valueType) const
     {
+        context <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed);
+
         switch (valueType)
         {
-        case Args::Type::Query:
-        case Args::Type::Id:
-        case Args::Type::Name:
-        case Args::Type::Moniker:
-        case Args::Type::Source:
+        case Execution::Args::Type::Query:
+            context <<
+                Workflow::RequireCompletionWordNonEmpty <<
+                Workflow::SearchSourceForManyCompletion <<
+                Workflow::CompleteWithMatchedField;
+            break;
+        case Execution::Args::Type::Id:
+        case Execution::Args::Type::Name:
+        case Execution::Args::Type::Moniker:
+        case Execution::Args::Type::Source:
+        case Execution::Args::Type::Tag:
+        case Execution::Args::Type::Command:
             context <<
-                Workflow::CompleteWithSingleSemanticsForValue(valueType);
+                Workflow::CompleteWithSingleSemanticsForValueUsingExistingSource(valueType);
             break;
         }
     }
@@ -209,8 +260,13 @@ namespace AppInstaller::CLI
 
     void PinListCommand::ExecuteInternal(Execution::Context& context) const
     {
-        // TODO
-        Command::ExecuteInternal(context);
+        context <<
+            Workflow::OpenPinningIndex <<
+            Workflow::GetAllPins <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed) <<
+            Workflow::CrossReferencePinsWithSource <<
+            Workflow::ReportPins;
     }
 
     std::vector<Argument> PinResetCommand::GetArguments() const
@@ -237,7 +293,12 @@ namespace AppInstaller::CLI
 
     void PinResetCommand::ExecuteInternal(Execution::Context& context) const
     {
-        // TODO
-        Command::ExecuteInternal(context);
+        context <<
+            Workflow::OpenPinningIndex <<
+            Workflow::GetAllPins <<
+            Workflow::OpenSource() <<
+            Workflow::OpenCompositeSource(Repository::PredefinedSource::Installed) <<
+            Workflow::CrossReferencePinsWithSource <<
+            Workflow::ResetAllPins;
     }
 }

src/AppInstallerCLICore/ExecutionArgs.h

@@ -84,6 +84,7 @@ namespace AppInstaller::CLI::Execution
             // Upgrade command
             All, // Used in Update command to update all installed packages to latest
             IncludeUnknown, // Used in Upgrade command to allow upgrades of packages with unknown versions
+            IncludePinned, // Used in Upgrade command to allow upgrades to pinned packages (only for pinning type of pins)
 
             // Show command
             ListVersions, // Used in Show command to list all available versions of an app

src/AppInstallerCLICore/ExecutionContextData.h

@@ -4,6 +4,7 @@
 #include <winget/RepositorySource.h>
 #include <winget/Manifest.h>
 #include <winget/ARPCorrelation.h>
+#include <winget/Pin.h>
 #include "CompletionData.h"
 #include "PackageCollection.h"
 #include "PortableInstaller.h"
@@ -16,6 +17,10 @@
 #include <variant>
 #include <vector>
 
+namespace AppInstaller::Repository::Microsoft
+{
+    struct PinningIndex;
+}
 
 namespace AppInstaller::CLI::Execution
 {
@@ -55,6 +60,8 @@ namespace AppInstaller::CLI::Execution
         AllowedArchitectures,
         AllowUnknownScope,
         PortableInstaller,
+        PinningIndex,
+        Pins,
         Max
     };
 
@@ -229,5 +236,17 @@ namespace AppInstaller::CLI::Execution
         {
             using value_t = CLI::Portable::PortableInstaller;
         };
+
+        template <>
+        struct DataMapping<Data::PinningIndex>
+        {
+            using value_t = std::shared_ptr<Repository::Microsoft::PinningIndex>;
+        };
+
+        template <>
+        struct DataMapping<Data::Pins>
+        {
+            using value_t = std::vector<Pinning::Pin>;
+        };
     }
 }

src/AppInstallerCLICore/Resources.h

@@ -244,14 +244,23 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(PinAddBlockingArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinAddCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinAddCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinAdded);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinAlreadyExists);
         WINGET_DEFINE_RESOURCE_STRINGID(PinCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinDoesNotExist);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinExistsOverwriting);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinExistsUseForceArg);
         WINGET_DEFINE_RESOURCE_STRINGID(PinListCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinListCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinNoPinsExist);
         WINGET_DEFINE_RESOURCE_STRINGID(PinRemoveCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinRemoveCommandShortDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinResetCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinResetCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinResettingAll);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinResetUseForceArg);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinType);
         WINGET_DEFINE_RESOURCE_STRINGID(PoliciesDisabled);
         WINGET_DEFINE_RESOURCE_STRINGID(PoliciesEnabled);
         WINGET_DEFINE_RESOURCE_STRINGID(PoliciesPolicy);
@@ -417,6 +426,7 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(UpdateAllArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpdateNotApplicable);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeAvailableForPinned);
+        WINGET_DEFINE_RESOURCE_STRINGID(UpgradeBlockingPinCount);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeCommandShortDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeDifferentInstallTechnology);

src/AppInstallerCLICore/Workflows/CompletionFlow.cpp

@@ -70,7 +70,7 @@ namespace AppInstaller::CLI::Workflow
         const std::string& word = context.Get<Data::CompletionData>().Word();
         auto stream = context.Reporter.Completion();
 
-        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys())
+        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys(Repository::PinBehavior::IgnorePins))
         {
             if (word.empty() || Utility::ICUCaseInsensitiveStartsWith(vc.Version, word))
             {
@@ -86,7 +86,7 @@ namespace AppInstaller::CLI::Workflow
 
         std::vector<std::string> channels;
 
-        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys())
+        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys(Repository::PinBehavior::IgnorePins))
         {
             if ((word.empty() || Utility::ICUCaseInsensitiveStartsWith(vc.Channel, word)) &&
                 std::find(channels.begin(), channels.end(), vc.Channel) == channels.end())

src/AppInstallerCLICore/Workflows/DependencyNodeProcessor.cpp

@@ -41,7 +41,7 @@ namespace AppInstaller::CLI::Workflow
         const auto& package = match.Package;
         auto packageId = package->GetProperty(PackageProperty::Id);
         m_nodePackageInstalledVersion = package->GetInstalledVersion();
-        m_nodePackageLatestVersion = package->GetLatestAvailableVersion();
+        m_nodePackageLatestVersion = package->GetLatestAvailableVersion(PinBehavior::ConsiderPins);
 
         if (m_nodePackageInstalledVersion && dependencyNode.IsVersionOk(Utility::Version(m_nodePackageInstalledVersion->GetProperty(PackageVersionProperty::Version))))
         {

src/AppInstallerCLICore/Workflows/ImportExportFlow.cpp

@@ -65,13 +65,13 @@ namespace AppInstaller::CLI::Workflow
         {
             if (!checkVersion)
             {
-                return package->GetLatestAvailableVersion();
+                return package->GetLatestAvailableVersion(PinBehavior::IgnorePins);
             }
 
-            auto availablePackageVersion = package->GetAvailableVersion({ "", version, channel });
+            auto availablePackageVersion = package->GetAvailableVersion({ "", version, channel }, PinBehavior::IgnorePins);
             if (!availablePackageVersion)
             {
-                availablePackageVersion = package->GetLatestAvailableVersion();
+                availablePackageVersion = package->GetLatestAvailableVersion(PinBehavior::IgnorePins);
                 if (availablePackageVersion)
                 {
                     // Warn installed version is not available.