mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-24 04:00:02 +01:00
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request This PR fixes an issue where context menu runtime registration wasn't properly cleaned up when GPO (Group Policy Object) policies disabled the module. The problem occurred because the module constructor didn't consider GPO policies when determining its initial enabled state. <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [x] Closes: #41387 - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [ ] **Tests:** Added/updated and all pass - [ ] **Localization:** All end-user-facing strings can be localized - [ ] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [ ] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx <!-- Provide a more detailed description of the PR, other things fixed, or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed This pull request refactors how context menu registration and unregistration are handled across several PowerToys modules. The main improvement is the introduction of a new `UpdateRegistration` helper method in each module, which centralizes and simplifies the logic for registering or unregistering context menus when the module is enabled or disabled. This reduces code duplication and ensures consistent behavior. **Context menu registration logic refactor:** * Added a private `UpdateRegistration` method to each of the following modules to handle context menu registration and unregistration based on the enabled state: - `FileLocksmithModule` in `PowerToysModule.cpp` - `NewModule` in `powertoys_module.cpp` - `ImageResizerModule` in `dllmain.cpp` - `PowerRenameModule` in `dllmain.cpp` * Replaced direct calls to registration/unregistration functions in `enable`, `disable`, and `init_settings` methods with calls to the new `UpdateRegistration` method in all affected modules, ensuring consistent and centralized handling [[1]](diffhunk://#diff-256ed936dafec1bf6ff17849b4797dd276f5b07bebe2e483bc1580c8f06e92d9L91-R122) [[2]](diffhunk://#diff-256ed936dafec1bf6ff17849b4797dd276f5b07bebe2e483bc1580c8f06e92d9R155) [[3]](diffhunk://#diff-4a3942d548f3daec02a833983ed9b2b69f75e2cd1b74a8ce1b874f3fd33fde55L101-R125) [[4]](diffhunk://#diff-4a3942d548f3daec02a833983ed9b2b69f75e2cd1b74a8ce1b874f3fd33fde55L153-R177) [[5]](diffhunk://#diff-0c0a89e812ff4625d165417da14f1c3f203e5ac7907555ae4fde122f3dddcf7aL115-L130) [[6]](diffhunk://#diff-34581ec47c37b0d2e1d9b59696225c47342930694e732db06cbdf653ceb2c2d7L205-R234) [[7]](diffhunk://#diff-34581ec47c37b0d2e1d9b59696225c47342930694e732db06cbdf653ceb2c2d7R334). These changes improve maintainability and reduce the risk of inconsistent registration behavior across modules. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
183 lines
5.0 KiB
C++
183 lines
5.0 KiB
C++
#include "pch.h"
|
|
|
|
#include <filesystem>
|
|
#include <string>
|
|
|
|
#include <winrt/Windows.Data.Json.h>
|
|
|
|
#include <common/SettingsAPI/settings_objects.h>
|
|
#include <common/utils/gpo.h>
|
|
#include <common/utils/process_path.h>
|
|
#include <common/utils/resources.h>
|
|
#include <interface/powertoy_module_interface.h>
|
|
|
|
#include "constants.h"
|
|
#include "settings.h"
|
|
#include "trace.h"
|
|
#include "new_utilities.h"
|
|
#include "Generated Files/resource.h"
|
|
#include "RuntimeRegistration.h"
|
|
|
|
// Note: Settings are managed via Settings and UI Settings
|
|
class NewModule : public PowertoyModuleIface
|
|
{
|
|
private:
|
|
// Update registration based on enabled state
|
|
void UpdateRegistration(bool enabled)
|
|
{
|
|
if (enabled)
|
|
{
|
|
#if defined(ENABLE_REGISTRATION) || defined(NDEBUG)
|
|
NewPlusRuntimeRegistration::EnsureRegisteredWin10();
|
|
Logger::info(L"New+ context menu registered");
|
|
#endif
|
|
}
|
|
else
|
|
{
|
|
#if defined(ENABLE_REGISTRATION) || defined(NDEBUG)
|
|
NewPlusRuntimeRegistration::Unregister();
|
|
Logger::info(L"New+ context menu unregistered");
|
|
#endif
|
|
}
|
|
}
|
|
|
|
public:
|
|
NewModule()
|
|
{
|
|
init_settings();
|
|
}
|
|
|
|
virtual const wchar_t* get_name() override
|
|
{
|
|
static const std::wstring localized_context_menu_item =
|
|
GET_RESOURCE_STRING_FALLBACK(IDS_CONTEXT_MENU_ITEM_NEW, L"New+");
|
|
|
|
return localized_context_menu_item.c_str();
|
|
}
|
|
|
|
virtual const wchar_t* get_key() override
|
|
{
|
|
// This setting key must match EnabledModules.cs [JsonPropertyName("NewPlus")]
|
|
return newplus::constants::non_localizable::powertoy_key;
|
|
}
|
|
|
|
virtual powertoys_gpo::gpo_rule_configured_t gpo_policy_enabled_configuration() override
|
|
{
|
|
return powertoys_gpo::getConfiguredNewPlusEnabledValue();
|
|
}
|
|
|
|
virtual bool get_config(_Out_ PWSTR buffer, _Out_ int* buffer_size) override
|
|
{
|
|
// Not implemented as Settings are propagating via json
|
|
return true;
|
|
}
|
|
|
|
virtual void set_config(const wchar_t* config) override
|
|
{
|
|
// The following just checks to see if the Template Location was changed for metrics purposes
|
|
// Note: We are not saving the settings here and instead relying on read/write of json in Settings App .cs code paths
|
|
try
|
|
{
|
|
// Parse the input JSON string.
|
|
PowerToysSettings::PowerToyValues values =
|
|
PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
|
|
|
|
values.save_to_settings_file();
|
|
NewSettingsInstance().Load();
|
|
|
|
auto templateValue = values.get_string_value(newplus::constants::non_localizable::settings_json_key_template_location);
|
|
if (templateValue.has_value())
|
|
{
|
|
const auto latest_location_value = templateValue.value();
|
|
const auto existing_location_value = NewSettingsInstance().GetTemplateLocation();
|
|
if (!newplus::utilities::wstring_same_when_comparing_ignore_case(latest_location_value, existing_location_value))
|
|
{
|
|
Trace::EventChangedTemplateLocation();
|
|
}
|
|
}
|
|
|
|
}
|
|
catch (std::exception& e)
|
|
{
|
|
Logger::error("Configuration parsing failed: {}", std::string{ e.what() });
|
|
}
|
|
}
|
|
|
|
virtual bool is_enabled_by_default() const override
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual void enable() override
|
|
{
|
|
Logger::info("New+ enabled via Settings UI");
|
|
|
|
// Log telemetry
|
|
Trace::EventToggleOnOff(true);
|
|
if (package::IsWin11OrGreater())
|
|
{
|
|
newplus::utilities::register_msix_package();
|
|
}
|
|
|
|
powertoy_new_enabled = true;
|
|
UpdateRegistration(powertoy_new_enabled);
|
|
}
|
|
|
|
virtual void disable() override
|
|
{
|
|
Logger::info("New+ disabled via Settings UI");
|
|
Disable(true);
|
|
}
|
|
|
|
virtual bool is_enabled() override
|
|
{
|
|
return powertoy_new_enabled;
|
|
}
|
|
|
|
virtual void hide_file_extension(bool hide_file_extension)
|
|
{
|
|
Logger::info("New+ hide file extension {}", hide_file_extension);
|
|
}
|
|
|
|
virtual void hide_starting_digits(bool hide_starting_digits)
|
|
{
|
|
Logger::info("New+ hide starting digits {}", hide_starting_digits);
|
|
}
|
|
|
|
virtual void template_location(std::wstring path_location)
|
|
{
|
|
Logger::info("New+ template location");
|
|
}
|
|
|
|
virtual void destroy() override
|
|
{
|
|
Disable(false);
|
|
delete this;
|
|
}
|
|
|
|
private:
|
|
bool powertoy_new_enabled = false;
|
|
|
|
void Disable(bool const traceEvent)
|
|
{
|
|
// Log telemetry
|
|
if (traceEvent)
|
|
{
|
|
Trace::EventToggleOnOff(false);
|
|
}
|
|
powertoy_new_enabled = false;
|
|
UpdateRegistration(powertoy_new_enabled);
|
|
}
|
|
|
|
void init_settings()
|
|
{
|
|
powertoy_new_enabled = NewSettingsInstance().GetEnabled();
|
|
UpdateRegistration(powertoy_new_enabled);
|
|
}
|
|
};
|
|
|
|
extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
|
|
{
|
|
return new NewModule();
|
|
}
|