Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-06 03:07:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

[PowerPreview] simplify and use modulesRegistry API

Browse Source
This commit is contained in:
yuyoyuppe
2021-10-05 18:54:42 +03:00
committed by Andrey Nekrasov
parent c324cd5953
commit 092ee49139
28 changed files with 217 additions and 1399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

249
src/modules/previewpane/powerpreview/powerpreview.cpp
View File

@@ -2,7 +2,6 @@
#include <common/SettingsAPI/settings_objects.h>
#include "powerpreview.h"
#include "trace.h"
#include "settings.h"
#include "Generated Files/resource.h"
#include <common/notifications/dont_show_again.h>
#include <common/notifications/notifications.h>
@@ -10,62 +9,46 @@
#include <common/utils/elevation.h>
#include <common/utils/resources.h>
#include <common/utils/os-detect.h>
#include <common/utils/process_path.h>
// Constructor
PowerPreviewModule::PowerPreviewModule() :
m_moduleName(GET_RESOURCE_STRING(IDS_MODULE_NAME)),
app_key(powerpreviewConstants::ModuleKey)
{
// Initialize the preview modules.
m_fileExplorerModules.emplace_back(std::make_unique<PreviewHandlerSettings>(
true,
L"svg-previewer-toggle-setting",
GET_RESOURCE_STRING(IDS_PREVPANE_SVG_SETTINGS_DESCRIPTION),
L"{ddee2b8a-6807-48a6-bb20-2338174ff779}",
L"Svg Preview Handler",
std::make_unique<RegistryWrapper>()));
const std::wstring installationDir = get_module_folderpath();
const bool installPerUser = false;
m_fileExplorerModules.push_back({ .settingName = L"svg-previewer-toggle-setting",
.settingDescription = GET_RESOURCE_STRING(IDS_PREVPANE_SVG_SETTINGS_DESCRIPTION),
.registryChanges = getSvgPreviewHandlerChangset(installationDir, installPerUser) });
m_fileExplorerModules.emplace_back(std::make_unique<PreviewHandlerSettings>(
true,
L"md-previewer-toggle-setting",
GET_RESOURCE_STRING(IDS_PREVPANE_MD_SETTINGS_DESCRIPTION),
L"{45769bcc-e8fd-42d0-947e-02beef77a1f5}",
L"Markdown Preview Handler",
std::make_unique<RegistryWrapper>()));
m_fileExplorerModules.push_back({ .settingName = L"md-previewer-toggle-setting",
.settingDescription = GET_RESOURCE_STRING(IDS_PREVPANE_MD_SETTINGS_DESCRIPTION),
.registryChanges = getMdPreviewHandlerChangset(installationDir, installPerUser) });
m_fileExplorerModules.emplace_back(std::make_unique<PreviewHandlerSettings>(
true,
L"pdf-previewer-toggle-setting",
GET_RESOURCE_STRING(IDS_PREVPANE_PDF_SETTINGS_DESCRIPTION),
L"{07665729-6243-4746-95b7-79579308d1b2}",
L"PDF Preview Handler",
std::make_unique<RegistryWrapper>()));
m_fileExplorerModules.push_back({ .settingName = L"pdf-previewer-toggle-setting",
.settingDescription = GET_RESOURCE_STRING(IDS_PREVPANE_PDF_SETTINGS_DESCRIPTION),
.registryChanges = getPdfPreviewHandlerChangset(installationDir, installPerUser) });
m_fileExplorerModules.emplace_back(std::make_unique<ThumbnailProviderSettings>(
true,
L"svg-thumbnail-toggle-setting",
GET_RESOURCE_STRING(IDS_SVG_THUMBNAIL_PROVIDER_SETTINGS_DESCRIPTION),
L"{36B27788-A8BB-4698-A756-DF9F11F64F84}",
L"Svg Thumbnail Provider",
std::make_unique<RegistryWrapper>(),
L".svg\\shellex\\{E357FCCD-A995-4576-B01F-234630154E96}"));
m_fileExplorerModules.push_back({ .settingName = L"svg-thumbnail-toggle-setting",
.settingDescription = GET_RESOURCE_STRING(IDS_SVG_THUMBNAIL_PROVIDER_SETTINGS_DESCRIPTION),
.registryChanges = getSvgThumbnailHandlerChangset(installationDir, installPerUser) });
// PDF
m_fileExplorerModules.emplace_back(std::make_unique<ThumbnailProviderSettings>(
true,
L"pdf-thumbnail-toggle-setting",
GET_RESOURCE_STRING(IDS_PDF_THUMBNAIL_PROVIDER_SETTINGS_DESCRIPTION),
L"{BCC13D15-9720-4CC4-8371-EA74A274741E}",
L"Pdf Thumbnail Provider",
std::make_unique<RegistryWrapper>(),
L".pdf\\shellex\\{E357FCCD-A995-4576-B01F-234630154E96}"));
m_fileExplorerModules.push_back({ .settingName = L"pdf-thumbnail-toggle-setting",
.settingDescription = GET_RESOURCE_STRING(IDS_PDF_THUMBNAIL_PROVIDER_SETTINGS_DESCRIPTION),
.registryChanges = getPdfThumbnailHandlerChangset(installationDir, installPerUser) });
// Initialize the toggle states for each module.
init_settings();
try
{
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file(PowerPreviewModule::get_key());
// File Explorer might be disabled if user updated from old to new settings.
// Initialize the registry state in the constructor as PowerPreviewModule::enable/disable will not be called on startup
update_registry_to_match_toggles();
apply_settings(settings);
}
catch (std::exception const& e)
{
Trace::InitSetErrorLoadingFile(e.what());
}
}
// Destroy the powertoy and free memory.
@@ -109,9 +92,9 @@ bool PowerPreviewModule::get_config(_Out_ wchar_t* buffer, _Out_ int* buffer_siz
for (auto& fileExplorerModule : m_fileExplorerModules)
{
settings.add_bool_toggle(
fileExplorerModule->GetToggleSettingName(),
fileExplorerModule->GetToggleSettingDescription(),
fileExplorerModule->GetToggleSettingState());
fileExplorerModule.settingName,
fileExplorerModule.settingDescription,
fileExplorerModule.registryChanges.isApplied());
}
return settings.serialize_to_buffer(buffer, buffer_size);
@@ -122,21 +105,8 @@ void PowerPreviewModule::set_config(const wchar_t* config)
{
try
{
PowerToysSettings::PowerToyValues settings = PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
bool updateSuccess = true;
bool isElevated = is_process_elevated(false);
for (auto& fileExplorerModule : m_fileExplorerModules)
{
// The new settings interface does not have a toggle to modify enabled, consider File Explorer to always be enabled
updateSuccess = updateSuccess && fileExplorerModule->UpdateState(settings, true, isElevated);
}
if (!updateSuccess)
{
show_update_warning_message();
}
auto settings = PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
apply_settings(settings);
settings.save_to_settings_file();
}
catch (std::exception const& e)
@@ -145,135 +115,102 @@ void PowerPreviewModule::set_config(const wchar_t* config)
}
}
// Enable preview handlers.
void PowerPreviewModule::enable()
{
if (!this->m_enabled)
if (!m_enabled)
{
Trace::EnabledPowerPreview(true);
}
this->m_enabled = true;
m_enabled = true;
}
// Disable active preview handlers.
void PowerPreviewModule::disable()
{
elevation_check_wrapper([this]() {
// Check if the process is elevated in order to have permissions to modify HKLM registry
if (is_process_elevated(false))
{
for (auto& fileExplorerModule : m_fileExplorerModules)
{
fileExplorerModule->Disable();
fileExplorerModule.registryChanges.unapply();
}
});
}
else
{
show_update_warning_message();
}
if (this->m_enabled)
if (m_enabled)
{
Trace::EnabledPowerPreview(false);
}
this->m_enabled = false;
m_enabled = false;
}
// Returns if the powertoys is enabled
bool PowerPreviewModule::is_enabled()
{
return this->m_enabled;
}
// Load the settings file.
void PowerPreviewModule::init_settings()
{
try
{
// Load and parse the settings file for this PowerToy.
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file(PowerPreviewModule::get_key());
// Load settings states.
for (auto& fileExplorerModule : m_fileExplorerModules)
{
fileExplorerModule->LoadState(settings);
}
}
catch (std::exception const& e)
{
Trace::InitSetErrorLoadingFile(e.what());
}
}
// Function to check if the registry states need to be updated
bool PowerPreviewModule::is_registry_update_required()
{
for (auto& fileExplorerModule : m_fileExplorerModules)
{
if (fileExplorerModule->GetToggleSettingState() != fileExplorerModule->CheckRegistryState())
{
return true;
}
}
return false;
return m_enabled;
}
// Function to warn the user that PowerToys needs to run as administrator for changes to take effect
void PowerPreviewModule::show_update_warning_message()
{
using namespace notifications;
if (!is_toast_disabled(PreviewModulesDontShowAgainRegistryPath, PreviewModulesDisableIntervalInDays))
if (is_toast_disabled(PreviewModulesDontShowAgainRegistryPath, PreviewModulesDisableIntervalInDays))
{
std::vector<action_t> actions = {
link_button{ GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_OPEN_SETTINGS),
L"powertoys://open_settings/" },
link_button{ GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_DONT_SHOW_AGAIN),
L"powertoys://couldnt_toggle_powerpreview_modules_disable/" }
};
show_toast_with_activations(GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_DESCRIPTION),
GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_TITLE),
{},
std::move(actions));
return;
}
std::vector<action_t> actions = {
link_button{ GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_OPEN_SETTINGS),
L"powertoys://open_settings/" },
link_button{ GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_DONT_SHOW_AGAIN),
L"powertoys://couldnt_toggle_powerpreview_modules_disable/" }
};
show_toast_with_activations(GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_DESCRIPTION),
GET_RESOURCE_STRING(IDS_FILEEXPLORER_ADMIN_RESTART_WARNING_TITLE),
{},
std::move(actions));
}
// Function that checks if a registry method is required and if so checks if the process is elevated and accordingly executes the method or shows a warning
void PowerPreviewModule::registry_and_elevation_check_wrapper(std::function<void()> method)
void PowerPreviewModule::apply_settings(const PowerToysSettings::PowerToyValues& settings)
{
// Check if a registry update is required
if (is_registry_update_required())
{
elevation_check_wrapper(method);
}
}
// Function that checks if the process is elevated and accordingly executes the method or shows a warning
void PowerPreviewModule::elevation_check_wrapper(std::function<void()> method)
{
// Check if the process is elevated in order to have permissions to modify HKLM registry
if (is_process_elevated(false))
{
method();
}
// Show a warning if it doesn't have permissions
else
const bool isElevated = is_process_elevated(false);
bool notifyShell = false;
if (!isElevated)
{
show_update_warning_message();
return;
}
for (auto& fileExplorerModule : m_fileExplorerModules)
{
const auto toggle = settings.get_bool_value(fileExplorerModule.settingName);
// Skip if no need to update
if (!toggle.has_value() || *toggle == fileExplorerModule.registryChanges.isApplied())
{
continue;
}
// (Un)Apply registry changes depending on the new setting value
const bool updated = *toggle ? fileExplorerModule.registryChanges.apply() : fileExplorerModule.registryChanges.unapply();
if (updated)
{
notifyShell = true;
Trace::PowerPreviewSettingsUpdated(fileExplorerModule.settingName.c_str(), !*toggle, *toggle, true);
}
else
{
Trace::PowerPreviewSettingsUpdateFailed(fileExplorerModule.settingName.c_str(), !*toggle, *toggle, true);
}
}
if (notifyShell)
{
SHChangeNotify(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, NULL, NULL);
}
}
// Function that updates the registry state to match the toggle states
void PowerPreviewModule::update_registry_to_match_toggles()
{
registry_and_elevation_check_wrapper([this]() {
for (auto& fileExplorerModule : m_fileExplorerModules)
{
if (fileExplorerModule->GetToggleSettingState())
{
// Enable all the modules with initial state set as true.
fileExplorerModule->Enable();
}
else
{
fileExplorerModule->Disable();
}
}
});
}