Enable Explicit toggling for sources (i.e. Enable/Disable) (microsoft#5904)

<!-- To check a checkbox place an "x" between the brackets. e.g: [x] -->

- [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.

-----
Closes microsoft#5797
This issue was related to enabling/disabling a source without removing
it. Functionally in WinGet this is already captured with the "Explicit"
property, where a source is not included unless it is explicitly
referenced. This is effectively equivalent to a "disabled" source. In
examining this problem we determined the best way to resolve this is to
allow editing of a source's properties, specifically the "Explicit"
property, without having to remove and re-add a source, which is
problematic with default sources. This PR implements that solution to
allow editing of a Source's properties, starting with the Explicit
property. This works on User defined sources and Default sources. In
terms of policy, Edit follows Remove; if you can remove a source you can
edit that source. If you cannot remove the source, then you cannot edit
the source either.

This PR Introduces a new experimental feature, "**sourceEdit**" which
has this new editing behavior. The user experience is not final so we
are keeping it behind sourceEdit for now for testing and refinement.

**New functionality: source edit subcommand**
This allows a source to be edited without removing/readding. This
currently only supports the "Explicit" property of a source, and
includes User sources and Default sources (such as the winget-font
source).

Aliases for this command: `set` and `config`

Example1:  `winget source edit -n winget --explicit true` 
This will make the winget source explicit.

Example2:  `winget source edit -n winget-font -e false`
This will make the winget-font source no longer explicit.

This interface is probably going to change later, which is one of the
reasons why we are using the experimental feature.

Key implementation detail is the addition of an "IsOverride" property to
the SourceDetailsInternal which functions similar to IsTombstone, only
instead of deleting the source it overrides some of the source's
properties, currently the "Explicit" property. This is needed for the
Default sources. For user sources the update is straightforward.

<img width="504" height="110" alt="image"
src="https://github.com/user-attachments/assets/d4d16dd2-61d7-460b-ba3e-310fbdb499e9"
/>

**Tested**
* Added CLI tests for the default source override validation
* Added E2E tests for the command validation
* Manual verification of the command functionality.


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

Author: dkbennett

doc/ReleaseNotes.md

@@ -1,5 +1,16 @@
 ## New in v1.28
 
+# Experimental Feature: 'sourceEdit'
+New feature that adds an 'edit' subcommand to the 'source' command. This can be used to set an explicit source to be implicit and vice-versa. For example, with this feature you can make the 'winget-font' source an implicit source instead of explicit source.
+
+To enable this feature, add the 'sourceEdit' experimental feature to your settings.
+```
+"experimentalFeatures": {
+    "sourceEdit": true
+},
+```
+To use the feature, try `winget source edit winget-font` to set the Explicit state to the default.
+
 <!-- Nothing yet! -->
 
 ## Bug Fixes

doc/Settings.md

@@ -393,3 +393,13 @@ This feature enables support for fonts via `winget settings`. The `winget font l
         "fonts": true
   },
 ```
+
+### sourceEdit
+
+This feature enables support for additional source command improvements via `winget settings`. The `winget source edit` command will become available with this feature.
+
+```json
+  "experimentalFeatures": {
+        "sourceEdit": true
+  },
+```

src/AppInstallerCLICore/Argument.cpp

@@ -121,6 +121,8 @@ namespace AppInstaller::CLI
             return { type, "explicit"_liv };
         case Execution::Args::Type::SourceTrustLevel:
             return { type, "trust-level"_liv };
+        case Execution::Args::Type::SourceEditExplicit:
+            return { type, "explicit"_liv, 'e' };
 
         //Hash Command
         case Execution::Args::Type::HashFile:
@@ -410,6 +412,8 @@ namespace AppInstaller::CLI
             return Argument{ type, Resource::String::SourceTypeArgumentDescription, ArgumentType::Positional };
         case Args::Type::SourceExplicit:
             return Argument{ type, Resource::String::SourceExplicitArgumentDescription, ArgumentType::Flag };
+        case Args::Type::SourceEditExplicit:
+            return Argument{ type, Resource::String::SourceEditExplicitArgumentDescription, ArgumentType::Positional };
         case Args::Type::SourceTrustLevel:
             return Argument{ type, Resource::String::SourceTrustLevelArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help };
         case Args::Type::ValidateManifest:

src/AppInstallerCLICore/Commands/SourceCommand.cpp

@@ -21,6 +21,7 @@ namespace AppInstaller::CLI
             std::make_unique<SourceListCommand>(FullName()),
             std::make_unique<SourceUpdateCommand>(FullName()),
             std::make_unique<SourceRemoveCommand>(FullName()),
+            std::make_unique<SourceEditCommand>(FullName()),
             std::make_unique<SourceResetCommand>(FullName()),
             std::make_unique<SourceExportCommand>(FullName()),
             });
@@ -312,4 +313,55 @@ namespace AppInstaller::CLI
             Workflow::GetSourceListWithFilter <<
             Workflow::ExportSourceList;
     }
+
+    // Source Edit Command
+
+    std::vector<Argument> SourceEditCommand::GetArguments() const
+    {
+        return {
+            Argument::ForType(Args::Type::SourceName).SetRequired(true),
+            Argument::ForType(Args::Type::SourceEditExplicit),
+        };
+    }
+
+    Resource::LocString SourceEditCommand::ShortDescription() const
+    {
+        return { Resource::String::SourceEditCommandShortDescription };
+    }
+
+    Resource::LocString SourceEditCommand::LongDescription() const
+    {
+        return { Resource::String::SourceEditCommandLongDescription };
+    }
+
+    Utility::LocIndView SourceEditCommand::HelpLink() const
+    {
+        return s_SourceCommand_HelpLink;
+    }
+
+    void SourceEditCommand::ValidateArgumentsInternal(Execution::Args& execArgs) const
+    {
+        if (execArgs.Contains(Execution::Args::Type::SourceEditExplicit))
+        {
+            std::string_view explicitArg = execArgs.GetArg(Execution::Args::Type::SourceEditExplicit);
+            auto convertedArg = Utility::TryConvertStringToBool(explicitArg);
+            if (!convertedArg.has_value())
+            {
+                auto validOptions = Utility::Join(", "_liv, std::vector<Utility::LocIndString>{
+                    "true"_lis,
+                    "false"_lis,
+                });
+                throw CommandException(Resource::String::InvalidArgumentValueError(Argument::ForType(Execution::Args::Type::SourceEditExplicit).Name(), validOptions));
+            }
+        }
+    }
+
+    void SourceEditCommand::ExecuteInternal(Context& context) const
+    {
+        context <<
+            Workflow::EnsureFeatureEnabled(Settings::ExperimentalFeature::Feature::SourceEdit) <<
+            Workflow::EnsureRunningAsAdmin <<
+            Workflow::GetSourceListWithFilter <<
+            Workflow::EditSources;
+    }
 }

src/AppInstallerCLICore/Commands/SourceCommand.h

@@ -121,4 +121,20 @@ namespace AppInstaller::CLI
     protected:
         void ExecuteInternal(Execution::Context& context) const override;
     };
+
+    struct SourceEditCommand final : public Command
+    {
+        SourceEditCommand(std::string_view parent) : Command("edit", { "config", "set" }, parent, Settings::ExperimentalFeature::Feature::SourceEdit) {}
+
+        std::vector<Argument> GetArguments() const override;
+
+        Resource::LocString ShortDescription() const override;
+        Resource::LocString LongDescription() const override;
+
+        Utility::LocIndView HelpLink() const override;
+
+    protected:
+        void ValidateArgumentsInternal(Execution::Args& execArgs) const override;
+        void ExecuteInternal(Execution::Context& context) const override;
+    };
 }

src/AppInstallerCLICore/ExecutionArgs.h

@@ -65,6 +65,7 @@ namespace AppInstaller::CLI::Execution
             ForceSourceReset,
             SourceExplicit,
             SourceTrustLevel,
+            SourceEditExplicit,
 
             //Hash Command
             HashFile,

src/AppInstallerCLICore/Resources.h

@@ -687,6 +687,13 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(SourceArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(SourceCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(SourceCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditCommandLongDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditExplicitArgumentDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditNewValue);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditNoChanges);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditOldValue);
+        WINGET_DEFINE_RESOURCE_STRINGID(SourceEditOne);
         WINGET_DEFINE_RESOURCE_STRINGID(SourceExplicitArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(SourceExportCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(SourceExportCommandShortDescription);

src/AppInstallerCLICore/Workflows/SourceFlow.cpp

@@ -272,6 +272,40 @@ namespace AppInstaller::CLI::Workflow
         }
     }
 
+    void EditSources(Execution::Context& context)
+    {
+        // We are assuming there is only one match, as SourceName is a required parameter.
+        const std::vector<Repository::SourceDetails>& sources = context.Get<Data::SourceList>();
+
+        for (const auto& sd : sources)
+        {
+            // Get the current source with this name.
+            Repository::Source targetSource{ sd.Name };
+            auto oldExplicitValue = sd.Explicit;
+
+            std::optional<bool> isExplicit;
+            if (context.Args.Contains(Execution::Args::Type::SourceEditExplicit))
+            {
+                isExplicit = Utility::TryConvertStringToBool(context.Args.GetArg(Execution::Args::Type::SourceEditExplicit));
+            }
+
+            Repository::SourceEdit edits{ isExplicit };
+            if (!targetSource.RequiresChanges(edits))
+            {
+                context.Reporter.Info() << Resource::String::SourceEditNoChanges(Utility::LocIndView{ sd.Name }) << std::endl;
+                continue;
+            }
+
+            context.Reporter.Info() << Resource::String::SourceEditOne(Utility::LocIndView{ sd.Name }) << std::endl;
+            targetSource.Edit(edits);
+
+            // Output updated source information. Since only Explicit is editable, we will only list that field. The name of the source being edited is listed prior to the edits.
+            Execution::TableOutput<3> table(context.Reporter, { Resource::String::SourceListField, Resource::String::SourceEditOldValue, Resource::String::SourceEditNewValue });
+            table.OutputLine({ Resource::LocString(Resource::String::SourceListExplicit), std::string{ Utility::ConvertBoolToString(oldExplicitValue) }, std::string{ Utility::ConvertBoolToString(isExplicit.value()) } });
+            table.Complete();
+        }
+    }
+
     void QueryUserForSourceReset(Execution::Context& context)
     {
         if (!context.Args.Contains(Execution::Args::Type::ForceSourceReset))

src/AppInstallerCLICore/Workflows/SourceFlow.h

@@ -83,4 +83,10 @@ namespace AppInstaller::CLI::Workflow
     // Inputs: None
     // Outputs: None
     void ForceInstalledCacheUpdate(Execution::Context& context);
+
+    // Edits a source in SourceList.
+    // Required Args: SourceName
+    // Inputs: SourceList
+    // Outputs: None
+    void EditSources(Execution::Context& context);
 }

src/AppInstallerCLIE2ETests/Interop/GroupPolicyForInterop.cs

@@ -110,6 +110,10 @@ public void DisableWinGetPolicy()
             Assert.AreEqual(Constants.BlockByWinGetPolicyErrorMessage, groupPolicyException.Message);
             Assert.AreEqual(Constants.ErrorCode.ERROR_BLOCKED_BY_POLICY, groupPolicyException.HResult);
 
+            groupPolicyException = Assert.Catch<GroupPolicyException>(() => { EditPackageCatalogOptions packageManagerSettings = this.TestFactory.CreateEditPackageCatalogOptions(); });
+            Assert.AreEqual(Constants.BlockByWinGetPolicyErrorMessage, groupPolicyException.Message);
+            Assert.AreEqual(Constants.ErrorCode.ERROR_BLOCKED_BY_POLICY, groupPolicyException.HResult);
+
             // PackageManagerSettings is not implemented in context OutOfProcDev
             if (this.TestFactory.Context == ClsidContext.InProc)
             {