mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2024-12-19 06:14:11 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/main' into dev/snickler/net8-upgrade

Browse Source
This commit is contained in:
Jeremy Sinclair 2023-10-11 14:59:32 -04:00
commit def115346f
49 changed files with 743 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/devdocs/modules/launcher/new-plugin-checklist.md
View File

@ -20,6 +20,10 @@
"IcoPathLight": string // Path to light theme icon. The path is relative to the root plugin folder
}
```
- [ ] Make sure your `Main` class contains a public, static string property for the `PluginID`. The plugin id has to be the same as the one in the `plugin.json`file.
```csharp
public static string PluginID => "xxxxxxx"; // The part xxxxxxx stands for the plugin ID.
```
- [ ] Do not use plugin name or PowerToys as prefixes for entities inside of the plugin project
- [ ] The plugin has to have Unit tests. Use MSTest framework
- [ ] Plugin's output code and assets have to be included in the installer [`Product.wxs`](/installer/PowerToysSetup/Product.wxs)

31
doc/gpo/README.md
View File

@ -94,3 +94,34 @@ If enabled, the automatic update checks are disabled.
If disabled or not configured, the automatic update checks are enabled.
-->
### PowerToys Run
#### Configure enabled state for all plugins
This policy configures the enabled state for all PowerToys Run plugins. All plugins will have the same state.
If you enable this setting, the plugins will be always enabled and the user won't be able to disable it.
If you disable this setting, the plugins will be always disabled and the user won't be able to enable it.
If you don't configure this setting, users are able to disable or enable the plugins.
You can override this policy for individual plugins using the policy "Configure enabled state for individual plugins".
Note: Changes require a restart of PowerToys Run.
#### Configure enabled state for individual plugins
With this policy you can configures an individual enabled state for each PowerToys Run plugin that you add to the list.
If you enable this setting, you can define the list of plugins and their enabled states:
- The value name (first column) is the plugin ID. You will find it in the plugin.json which is located in the plugin folder.
- The value (second column) is a numeric value: 0 for disabled, 1 for enabled and 2 for user takes control.
- Example to disable the Program plugin: `791FC278BA414111B8D1886DFE447410 | 0`
If you disable or don't configure this policy, either the user or the policy "Configure enabled state for all plugins" takes control over the enabled state of the plugins.
You can set the enabled state for all plugins not listed here using the policy "Configure enabled state for all plugins".
Note: Changes require a restart of PowerToys Run.

4
src/common/GPOWrapper/GPOWrapper.cpp
View File

@ -144,4 +144,8 @@ namespace winrt::PowerToys::GPOWrapper::implementation
{
return static_cast<GpoRuleConfigured>(powertoys_gpo::getAllowExperimentationValue());
}
GpoRuleConfigured GPOWrapper::GetRunPluginEnabledValue(winrt::hstring const& pluginID)
{
return static_cast<GpoRuleConfigured>(powertoys_gpo::getRunPluginEnabledValue(winrt::to_string(pluginID)));
}
}

1
src/common/GPOWrapper/GPOWrapper.h
View File

@ -42,6 +42,7 @@ namespace winrt::PowerToys::GPOWrapper::implementation
static GpoRuleConfigured GetConfiguredPeekEnabledValue();
static GpoRuleConfigured GetDisableAutomaticUpdateDownloadValue();
static GpoRuleConfigured GetAllowExperimentationValue();
static GpoRuleConfigured GetRunPluginEnabledValue(winrt::hstring const& pluginID);
};
}

1
src/common/GPOWrapper/GPOWrapper.idl
View File

@ -46,6 +46,7 @@ namespace PowerToys
static GpoRuleConfigured GetConfiguredPeekEnabledValue();
static GpoRuleConfigured GetDisableAutomaticUpdateDownloadValue();
static GpoRuleConfigured GetAllowExperimentationValue();
static GpoRuleConfigured GetRunPluginEnabledValue(String pluginID);
}
}
}

5
src/common/GPOWrapperProjection/GPOWrapper.cs
View File

@ -51,5 +51,10 @@ namespace PowerToys.GPOWrapperProjection
{
return (GpoRuleConfigured)PowerToys.GPOWrapper.GPOWrapper.GetConfiguredPeekEnabledValue();
}
public static GpoRuleConfigured GetRunPluginEnabledValue(string pluginID)
{
return (GpoRuleConfigured)PowerToys.GPOWrapper.GPOWrapper.GetRunPluginEnabledValue(pluginID);
}
}
}

4
src/common/interop/interop.cpp
View File

@ -203,6 +203,10 @@ public
return gcnew String(CommonSharedConstants::SHOW_POWEROCR_SHARED_EVENT);
}
static String ^ MouseJumpShowPreviewEvent() {
return gcnew String(CommonSharedConstants::MOUSE_JUMP_SHOW_PREVIEW_EVENT);
}
static String ^ AwakeExitEvent() {
return gcnew String(CommonSharedConstants::AWAKE_EXIT_EVENT);
}

3
src/common/interop/shared_constants.h
View File

@ -50,6 +50,9 @@ namespace CommonSharedConstants
// Path to the event used by PowerOCR
const wchar_t SHOW_POWEROCR_SHARED_EVENT[] = L"Local\\PowerOCREvent-dc864e06-e1af-4ecc-9078-f98bee745e3a";
// Path to the events used by Mouse Jump
const wchar_t MOUSE_JUMP_SHOW_PREVIEW_EVENT[] = L"Local\\MouseJumpEvent-aa0be051-3396-4976-b7ba-1a9cc7d236a5";
// Path to the event used by RegistryPreview
const wchar_t REGISTRY_PREVIEW_TRIGGER_EVENT[] = L"Local\\RegistryPreviewEvent-4C559468-F75A-4E7F-BC4F-9C9688316687";

120
src/common/utils/gpo.h
View File

@ -1,6 +1,7 @@
#pragma once
#include <Windows.h>
#include <optional>
namespace powertoys_gpo {
enum gpo_rule_configured_t {
@ -13,6 +14,7 @@ namespace powertoys_gpo {
// Registry path where gpo policy values are stored.
const std::wstring POLICIES_PATH = L"SOFTWARE\\Policies\\PowerToys";
const std::wstring POWER_LAUNCHER_INDIVIDUAL_PLUGIN_ENABLED_LIST_PATH = POLICIES_PATH + L"\\PowerLauncherIndividualPluginEnabledList";
// Registry scope where gpo policy values are stored.
const HKEY POLICIES_SCOPE_MACHINE = HKEY_LOCAL_MACHINE;
@ -62,6 +64,39 @@ namespace powertoys_gpo {
// The registry value names for other PowerToys policies.
const std::wstring POLICY_ALLOW_EXPERIMENTATION = L"AllowExperimentation";
const std::wstring POLICY_CONFIGURE_ENABLED_POWER_LAUNCHER_ALL_PLUGINS = L"PowerLauncherAllPluginsEnabledState";
inline std::optional<std::wstring> readRegistryStringValue(HKEY hRootKey, const std::wstring& subKey, const std::wstring& value_name)
{
DWORD reg_value_type = REG_SZ;
DWORD reg_flags = RRF_RT_REG_SZ;
DWORD string_buffer_capacity;
// Request required buffer capacity / string length
if (RegGetValueW(hRootKey, subKey.c_str(), value_name.c_str(), reg_flags, &reg_value_type, NULL, &string_buffer_capacity) != ERROR_SUCCESS)
{
return std::nullopt;
}
else if (string_buffer_capacity == 0)
{
return std::nullopt;
}
// RegGetValueW overshoots sometimes. Use a buffer first to not have characters past the string end.
wchar_t* temp_buffer = new wchar_t[string_buffer_capacity / sizeof(wchar_t) + 1];
// Read string
if (RegGetValueW(hRootKey, subKey.c_str(), value_name.c_str(), reg_flags, &reg_value_type, temp_buffer, &string_buffer_capacity) != ERROR_SUCCESS)
{
delete temp_buffer;
return std::nullopt;
}
// Convert buffer to std::wstring, delete buffer and return REG_SZ value
std::wstring string_value = temp_buffer;
delete temp_buffer;
return string_value;
}
inline gpo_rule_configured_t getConfiguredValue(const std::wstring& registry_value_name)
{
@ -117,6 +152,51 @@ namespace powertoys_gpo {
}
}
inline std::optional<std::wstring> getPolicyListValue(const std::wstring& registry_list_path, const std::wstring& registry_list_value_name)
{
// This function returns the value of an entry of an policy list. The user scope is only checked, if the list is not enabled for the machine to not mix the lists.
HKEY key{};
// Try to read from the machine list.
bool machine_list_found = false;
if (RegOpenKeyExW(POLICIES_SCOPE_MACHINE, registry_list_path.c_str(), 0, KEY_READ, &key) == ERROR_SUCCESS)
{
machine_list_found = true;
RegCloseKey(key);
// If the path exists in the machine registry, we try to read the value.
auto regValueData = readRegistryStringValue(POLICIES_SCOPE_MACHINE, registry_list_path, registry_list_value_name);
if (regValueData.has_value())
{
// Return the value from the machine list.
return *regValueData;
}
}
// If no list exists for machine, we try to read from the user list.
if (!machine_list_found)
{
if (RegOpenKeyExW(POLICIES_SCOPE_USER, registry_list_path.c_str(), 0, KEY_READ, &key) == ERROR_SUCCESS)
{
RegCloseKey(key);
// If the path exists in the user registry, we try to read the value.
auto regValueData = readRegistryStringValue(POLICIES_SCOPE_USER, registry_list_path, registry_list_value_name);
if (regValueData.has_value())
{
// Return the value from the user list.
return *regValueData;
}
}
}
// No list exists for machine and user, or no value was found in the list, or an error ocurred while reading the value.
return std::nullopt;
}
inline gpo_rule_configured_t getUtilityEnabledValue(const std::wstring& utility_name)
{
auto individual_value = getConfiguredValue(utility_name);
@ -321,4 +401,44 @@ namespace powertoys_gpo {
return getConfiguredValue(POLICY_ALLOW_EXPERIMENTATION);
}
inline gpo_rule_configured_t getRunPluginEnabledValue(std::string pluginID)
{
if (pluginID == "" || pluginID == " ")
{
// this plugin id can't exist in the registry
return gpo_rule_configured_not_configured;
}
std::wstring plugin_id(pluginID.begin(), pluginID.end());
auto individual_plugin_setting = getPolicyListValue(POWER_LAUNCHER_INDIVIDUAL_PLUGIN_ENABLED_LIST_PATH, plugin_id);
if (individual_plugin_setting.has_value())
{
if (*individual_plugin_setting == L"0")
{
// force disabled
return gpo_rule_configured_disabled;
}
else if (*individual_plugin_setting == L"1")
{
// force enabled
return gpo_rule_configured_enabled;
}
else if (*individual_plugin_setting == L"2")
{
// user takes control
return gpo_rule_configured_not_configured;
}
else
{
return gpo_rule_configured_wrong_value;
}
}
else
{
// If no individual plugin policy exists, we check the policy with the setting for all plugins.
return getConfiguredValue(POLICY_CONFIGURE_ENABLED_POWER_LAUNCHER_ALL_PLUGINS);
}
}
}

20
src/gpo/assets/PowerToys.admx
View File

@ -20,6 +20,9 @@
<category name="PowerToys" displayName="$(string.PowerToys)" />
<category name="InstallerUpdates" displayName="$(string.InstallerUpdates)">
<parentCategory ref="PowerToys" />
</category>
<category name="PowerToysRun" displayName="$(string.PowerToysRun)">
<parentCategory ref="PowerToys" />
</category>
</categories>
<policies>
@ -416,6 +419,23 @@
<disabledValue>
<decimal value="0" />
</disabledValue>
</policy>
<policy name="PowerToysRunAllPluginsEnabledState" class="Both" displayName="$(string.PowerToysRunAllPluginsEnabledState)" explainText="$(string.PowerToysRunAllPluginsEnabledStateDescription)" key="Software\Policies\PowerToys" valueName="PowerLauncherAllPluginsEnabledState">
<parentCategory ref="PowerToysRun" />
<supportedOn ref="SUPPORTED_POWERTOYS_0_75_0" />
<enabledValue>
<decimal value="1" />
</enabledValue>
<disabledValue>
<decimal value="0" />
</disabledValue>
</policy>
<policy name="PowerToysRunIndividualPluginEnabledState" class="Both" displayName="$(string.PowerToysRunIndividualPluginEnabledState)" explainText="$(string.PowerToysRunIndividualPluginEnabledStateDescription)" presentation="$(presentation.PowerToysRunIndividualPluginEnabledState)" key="Software\Policies\PowerToys\PowerLauncherIndividualPluginEnabledList">
<parentCategory ref="PowerToysRun" />
<supportedOn ref="SUPPORTED_POWERTOYS_0_75_0"/>
<elements>
<list id="PowerToysRunIndividualPluginEnabledList" explicitValue="true" />
</elements>
</policy>
</policies>
</policyDefinitions>

35
src/gpo/assets/en-US/PowerToys.adml
View File

@ -8,6 +8,7 @@
<stringTable>
<string id="PowerToys">Microsoft PowerToys</string>
<string id="InstallerUpdates">Installer and Updates</string>
<string id="PowerToysRun">PowerToys Run</string>
<string id="SUPPORTED_POWERTOYS_0_64_0">PowerToys version 0.64.0 or later</string>
<string id="SUPPORTED_POWERTOYS_0_68_0">PowerToys version 0.68.0 or later</string>
@ -80,6 +81,31 @@ If disabled or not configured, the automatic update checks are enabled.
If this setting is not configured or enabled, the user can control experimentation in the PowerToys settings menu.
If this setting is disabled, experimentation is not allowed.
</string>
<string id="PowerToysRunAllPluginsEnabledStateDescription">This policy configures the enabled state for all PowerToys Run plugins. All plugins will have the same state.
If you enable this setting, the plugins will be always enabled and the user won't be able to disable it.
If you disable this setting, the plugins will be always disabled and the user won't be able to enable it.
If you don't configure this setting, users are able to disable or enable the plugins.
You can override this policy for individual plugins using the policy "Configure enabled state for individual plugins".
Note: Changes require a restart of PowerToys Run.
</string>
<string id="PowerToysRunIndividualPluginEnabledStateDescription">With this policy you can configures an individual enabled state for each PowerToys Run plugin that you add to the list.
If you enable this setting, you can define the list of plugins and their enabled states:
- The value name (first column) is the plugin ID. You will find it in the plugin.json which is located in the plugin folder.
- The value (second column) is a numeric value: 0 for disabled, 1 for enabled and 2 for user takes control.
- Example to disable the Program plugin: 791FC278BA414111B8D1886DFE447410 | 0
If you disable or don't configure this policy, either the user or the policy "Configure enabled state for all plugins" takes control over the enabled state of the plugins.
You can set the enabled state for all plugins not listed here using the policy "Configure enabled state for all plugins".
Note: Changes require a restart of PowerToys Run.
</string>
<string id="ConfigureGlobalUtilityEnabledState">Configure global utility enabled state</string>
<string id="ConfigureEnabledUtilityAlwaysOnTop">Always On Top: Configure enabled state</string>
@ -120,7 +146,16 @@ If this setting is disabled, experimentation is not allowed.
<string id="SuspendNewUpdateToast">Suspend Action Center notification for new updates</string>
<string id="DisablePeriodicUpdateCheck">Disable automatic update checks</string>
<string id="AllowExperimentation">Allow Experimentation</string>
<string id="PowerToysRunAllPluginsEnabledState">Configure enabled state for all plugins</string>
<string id="PowerToysRunIndividualPluginEnabledState">Configure enabled state for individual plugins</string>
</stringTable>
<presentationTable>
<presentation id="PowerToysRunIndividualPluginEnabledState">
<listBox refId="PowerToysRunIndividualPluginEnabledList">List of managed plugins:</listBox>
</presentation>
</presentationTable>
</resources>
</policyDefinitionResources>

56
src/modules/MouseUtils/MouseJump/MouseJump.vcxproj.filters Normal file
View File

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<Filter Include="Source Files">
<UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
<Extensions>cpp;c;cc;cxx;c++;def;odl;idl;hpj;bat;asm;asmx</Extensions>
</Filter>
<Filter Include="Header Files">
<UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
<Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
</Filter>
<Filter Include="Resource Files">
<UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
<Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
</Filter>
<Filter Include="Generated Files">
<UniqueIdentifier>{875a08c6-f610-4667-bd0f-80171ed96072}</UniqueIdentifier>
</Filter>
</ItemGroup>
<ItemGroup>
<ClInclude Include="pch.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="Generated Files\resource.h">
<Filter>Generated Files</Filter>
</ClInclude>
<ClInclude Include="trace.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<ClCompile Include="dllmain.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="pch.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="trace.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<None Include="resource.h">
<Filter>Header Files</Filter>
</None>
<None Include="MouseJump.rc">
<Filter>Resource Files</Filter>
</None>
<None Include="packages.config" />
</ItemGroup>
<ItemGroup>
<ResourceCompile Include="Generated Files\MouseJump.rc">
<Filter>Resource Files</Filter>
</ResourceCompile>
</ItemGroup>
</Project>

101
src/modules/MouseUtils/MouseJump/dllmain.cpp
View File

@ -1,32 +1,32 @@
// dllmain.cpp : Defines the entry point for the DLL application.
#include "pch.h"
#include <interface/powertoy_module_interface.h>
//#include <interface/lowlevel_keyboard_event_data.h>
//#include <interface/win_hook_event_data.h>
#include <common/SettingsAPI/settings_objects.h>
#include "trace.h"
#include <common/utils/winapi_error.h>
#include <common/SettingsAPI/settings_objects.h>
#include <common/utils/resources.h>
#include <common/interop/shared_constants.h>
#include <common/utils/logger_helper.h>
#include <common/utils/winapi_error.h>
extern "C" IMAGE_DOS_HEADER __ImageBase;
HMODULE m_hModule;
BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID /*lpReserved*/)
BOOL APIENTRY DllMain(HMODULE /*hModule*/,
DWORD ul_reason_for_call,
LPVOID /*lpReserved*/)
{
m_hModule = hModule;
switch (ul_reason_for_call)
{
case DLL_PROCESS_ATTACH:
Trace::RegisterProvider();
break;
case DLL_THREAD_ATTACH:
break;
case DLL_THREAD_DETACH:
break;
case DLL_PROCESS_DETACH:
Trace::UnregisterProvider();
break;
}
return TRUE;
}
@ -54,9 +54,17 @@ private:
bool m_enabled = false;
// Hotkey to invoke the module
Hotkey m_hotkey;
HANDLE m_hProcess;
// Time to wait for process to close after sending WM_CLOSE signal
static const int MAX_WAIT_MILLISEC = 10000;
Hotkey m_hotkey;
// Handle to event used to invoke PowerOCR
HANDLE m_hInvokeEvent;
void parse_hotkey(PowerToysSettings::PowerToyValues& settings)
{
auto settingsObject = settings.get_raw_json();
@ -123,11 +131,21 @@ private:
}
// Load initial settings from the persisted values.
void init_settings();
void terminate_process()
void init_settings()
{
TerminateProcess(m_hProcess, 1);
try
{
// Load and parse the settings file for this PowerToy.
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file(get_key());
parse_hotkey(settings);
}
catch (std::exception&)
{
Logger::warn(L"An exception occurred while loading the settings file");
// Error while loading from the settings file. Let default values stay as they are.
}
}
public:
@ -135,6 +153,7 @@ public:
MouseJump()
{
LoggerHelpers::init_logger(MODULE_NAME, L"ModuleInterface", LogSettings::mouseJumpLoggerName);
m_hInvokeEvent = CreateDefaultEvent(CommonSharedConstants::MOUSE_JUMP_SHOW_PREVIEW_EVENT);
init_settings();
};
@ -142,7 +161,6 @@ public:
{
if (m_enabled)
{
terminate_process();
}
m_enabled = false;
}
@ -150,6 +168,7 @@ public:
// Destroy the powertoy and free memory
virtual void destroy() override
{
Logger::trace("MouseJump::destroy()");
delete this;
}
@ -180,12 +199,14 @@ public:
PowerToysSettings::Settings settings(hinstance, get_name());
settings.set_description(MODULE_DESC);
settings.set_overview_link(L"https://aka.ms/PowerToysOverview_MouseUtilities/#mouse-jump");
return settings.serialize_to_buffer(buffer, buffer_size);
}
// Signal from the Settings editor to call a custom action.
// This can be used to spawn more complex editors.
virtual void call_custom_action(const wchar_t* action) override
virtual void call_custom_action(const wchar_t* /*action*/) override
{
}
@ -199,7 +220,6 @@ public:
PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
parse_hotkey(values);
values.save_to_settings_file();
}
catch (std::exception&)
@ -211,6 +231,9 @@ public:
// Enable the powertoy
virtual void enable()
{
Logger::trace("MouseJump::enable()");
ResetEvent(m_hInvokeEvent);
launch_process();
m_enabled = true;
Trace::EnableJumpTool(true);
}
@ -218,33 +241,29 @@ public:
// Disable the powertoy
virtual void disable()
{
Logger::trace("MouseJump::disable()");
if (m_enabled)
{
terminate_process();
ResetEvent(m_hInvokeEvent);
TerminateProcess(m_hProcess, 1);
}
m_enabled = false;
Trace::EnableJumpTool(false);
}
// Returns if the powertoys is enabled
virtual bool is_enabled() override
{
return m_enabled;
}
virtual bool on_hotkey(size_t /*hotkeyId*/) override
{
if (m_enabled)
{
Logger::trace(L"MouseJump hotkey pressed");
Trace::InvokeJumpTool();
if (is_process_running())
if (!is_process_running())
{
terminate_process();
launch_process();
}
launch_process();
SetEvent(m_hInvokeEvent);
return true;
}
@ -268,6 +287,12 @@ public:
}
}
// Returns if the powertoys is enabled
virtual bool is_enabled() override
{
return m_enabled;
}
// Returns whether the PowerToys should be enabled by default
virtual bool is_enabled_by_default() const override
{
@ -276,26 +301,6 @@ public:
};
// Load the settings file.
void MouseJump::init_settings()
{
try
{
// Load and parse the settings file for this PowerToy.
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file(MouseJump::get_name());
parse_hotkey(settings);
}
catch (std::exception&)
{
Logger::warn(L"An exception occurred while loading the settings file");
// Error while loading from the settings file. Let default values stay as they are.
}
}
extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
{
return new MouseJump();

95
src/modules/MouseUtils/MouseJumpUI/Helpers/SettingsHelper.cs Normal file
View File

@ -0,0 +1,95 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.IO;
using System.IO.Abstractions;
using System.Threading;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.Library.Utilities;
namespace MouseJumpUI.Helpers;
internal class SettingsHelper
{
public SettingsHelper()
{
this.LockObject = new();
this.CurrentSettings = this.LoadSettings();
// delay loading settings on change by some time to avoid file in use exception
var throttledActionInvoker = new ThrottledActionInvoker();
this.FileSystemWatcher = Helper.GetFileWatcher(
moduleName: MouseJumpSettings.ModuleName,
fileName: "settings.json",
onChangedCallback: () => throttledActionInvoker.ScheduleAction(this.ReloadSettings, 250));
}
private IFileSystemWatcher FileSystemWatcher
{
get;
}
private object LockObject
{
get;
}
public MouseJumpSettings CurrentSettings
{
get;
private set;
}
private MouseJumpSettings LoadSettings()
{
lock (this.LockObject)
{
{
var settingsUtils = new SettingsUtils();
// set this to 1 to disable retries
var remainingRetries = 5;
while (remainingRetries > 0)
{
try
{
if (!settingsUtils.SettingsExists(MouseJumpSettings.ModuleName))
{
Logger.LogInfo("MouseJump settings.json was missing, creating a new one");
var defaultSettings = new MouseJumpSettings();
defaultSettings.Save(settingsUtils);
}
var settings = settingsUtils.GetSettingsOrDefault<MouseJumpSettings>(MouseJumpSettings.ModuleName);
return settings;
}
catch (IOException ex)
{
Logger.LogError("Failed to read changed settings", ex);
Thread.Sleep(250);
}
catch (Exception ex)
{
Logger.LogError("Failed to read changed settings", ex);
Thread.Sleep(250);
}
remainingRetries--;
}
}
}
const string message = "Failed to read changed settings - ran out of retries";
Logger.LogError(message);
throw new InvalidOperationException(message);
}
public void ReloadSettings()
{
this.CurrentSettings = this.LoadSettings();
}
}

47
src/modules/MouseUtils/MouseJumpUI/Helpers/ThrottledActionInvoker.cs Normal file
View File

@ -0,0 +1,47 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Windows.Threading;
namespace MouseJumpUI.Helpers;
internal sealed class ThrottledActionInvoker
{
private readonly object _invokerLock = new();
private readonly DispatcherTimer _timer;
private Action? _actionToRun;
public ThrottledActionInvoker()
{
_timer = new DispatcherTimer();
_timer.Tick += Timer_Tick;
}
public void ScheduleAction(Action action, int milliseconds)
{
lock (_invokerLock)
{
if (_timer.IsEnabled)
{
_timer.Stop();
}
_actionToRun = action;
_timer.Interval = new TimeSpan(0, 0, 0, 0, milliseconds);
_timer.Start();
}
}
private void Timer_Tick(object? sender, EventArgs? e)
{
lock (_invokerLock)
{
_timer.Stop();
_actionToRun?.Invoke();
}
}
}

61
src/modules/MouseUtils/MouseJumpUI/MainForm.cs
View File

@ -19,14 +19,13 @@ namespace MouseJumpUI;
internal partial class MainForm : Form
{
public MainForm(MouseJumpSettings settings)
public MainForm(SettingsHelper settingsHelper)
{
this.InitializeComponent();
this.Settings = settings ?? throw new ArgumentNullException(nameof(settings));
this.ShowThumbnail();
this.SettingsHelper = settingsHelper ?? throw new ArgumentNullException(nameof(settingsHelper));
}
public MouseJumpSettings Settings
public SettingsHelper SettingsHelper
{
get;
}
@ -104,14 +103,8 @@ internal partial class MainForm : Form
private void MainForm_Deactivate(object sender, EventArgs e)
{
this.Close();
if (this.Thumbnail.Image is not null)
{
var tmp = this.Thumbnail.Image;
this.Thumbnail.Image = null;
tmp.Dispose();
}
this.Hide();
this.ClearPreview();
}
private void Thumbnail_Click(object sender, EventArgs e)
@ -139,8 +132,11 @@ internal partial class MainForm : Form
this.OnDeactivate(EventArgs.Empty);
}
public void ShowThumbnail()
public void ShowPreview()
{
// hide the form while we redraw it...
this.Visible = false;
var stopwatch = Stopwatch.StartNew();
var layoutInfo = MainForm.GetLayoutInfo(this);
LayoutHelper.PositionForm(this, layoutInfo.FormBounds);
@ -148,7 +144,7 @@ internal partial class MainForm : Form
stopwatch.Stop();
// we have to activate the form to make sure the deactivate event fires
Microsoft.PowerToys.Telemetry.PowerToysTelemetry.Log.WriteEvent(new Telemetry.MouseJumpTeleportCursorEvent());
Microsoft.PowerToys.Telemetry.PowerToysTelemetry.Log.WriteEvent(new Telemetry.MouseJumpShowEvent());
this.Activate();
}
@ -175,6 +171,9 @@ internal partial class MainForm : Form
.Single(item => item.Screen.Handle == activatedScreenHandle.Value)
.Index;
// avoid a race condition - cache the current settings in case they change
var currentSettings = form.SettingsHelper.CurrentSettings;
var layoutConfig = new LayoutConfig(
virtualScreenBounds: ScreenHelper.GetVirtualScreen(),
screens: screens.Select(item => item.Screen).ToList(),
@ -182,13 +181,13 @@ internal partial class MainForm : Form
activatedScreenIndex: activatedScreenIndex,
activatedScreenNumber: activatedScreenIndex + 1,
maximumFormSize: new(
form.Settings.Properties.ThumbnailSize.Width,
form.Settings.Properties.ThumbnailSize.Height),
formPadding: new(
form.panel1.Padding.Left,
form.panel1.Padding.Top,
form.panel1.Padding.Right,
form.panel1.Padding.Bottom),
currentSettings.Properties.ThumbnailSize.Width,
currentSettings.Properties.ThumbnailSize.Height),
/*
don't read the panel padding values because they are affected by dpi scaling
and can give wrong values when moving between monitors with different dpi scaling
*/
formPadding: new(5, 5, 5, 5),
previewPadding: new(0));
Logger.LogInfo(string.Join(
'\n',
@ -295,10 +294,30 @@ internal partial class MainForm : Form
stopwatch.Stop();
}
private void ClearPreview()
{
if (this.Thumbnail.Image is null)
{
return;
}
var tmp = this.Thumbnail.Image;
this.Thumbnail.Image = null;
tmp.Dispose();
// force preview image memory to be released, otherwise
// all the disposed images can pile up without being GC'ed
GC.Collect();
}
private static void RefreshPreview(MainForm form)
{
if (!form.Visible)
{
// we seem to need to turn off topmost and then re-enable it again
// when we show the form, otherwise it doesn't get shown topmost...
form.TopMost = false;
form.TopMost = true;
form.Show();
}

1
src/modules/MouseUtils/MouseJumpUI/MouseJumpUI.csproj
View File

@ -62,6 +62,7 @@
<PackageReference Include="Microsoft.Windows.CsWinRT" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\common\Common.UI\Common.UI.csproj" />
<ProjectReference Include="..\..\..\common\GPOWrapper\GPOWrapper.vcxproj" />
<ProjectReference Include="..\..\..\common\interop\PowerToys.Interop.vcxproj" />
<ProjectReference Include="..\..\..\common\ManagedCommon\ManagedCommon.csproj" />

46
src/modules/MouseUtils/MouseJumpUI/Program.cs
View File

@ -4,10 +4,16 @@
using System;
using System.IO;
using System.Reflection;
using System.Text.Json;
using System.Threading;
using System.Windows.Forms;
using System.Windows.Threading;
using Common.UI;
using interop;
using ManagedCommon;
using Microsoft.PowerToys.Settings.UI.Library;
using MouseJumpUI.Helpers;
namespace MouseJumpUI;
@ -17,7 +23,7 @@ internal static class Program
/// The main entry point for the application.
/// </summary>
[STAThread]
private static void Main()
private static void Main(string[] args)
{
Logger.InitializeLogger("\\MouseJump\\Logs");
@ -38,10 +44,42 @@ internal static class Program
return;
}
var settings = Program.ReadSettings();
var mainForm = new MainForm(settings);
// validate command line arguments - we're expecting
// a single argument containing the runner pid
if ((args.Length != 1) || !int.TryParse(args[0], out var runnerPid))
{
var message = string.Join("\r\n", new[]
{
"Invalid command line arguments.",
"Expected usage is:",
string.Empty,
$"{Assembly.GetExecutingAssembly().GetName().Name} <RunnerPid>",
});
Logger.LogInfo(message);
throw new InvalidOperationException(message);
}
Application.Run(mainForm);
Logger.LogInfo($"Mouse Jump started from the PowerToys Runner. Runner pid={runnerPid}");
var cancellationTokenSource = new CancellationTokenSource();
RunnerHelper.WaitForPowerToysRunner(runnerPid, () =>
{
Logger.LogInfo("PowerToys Runner exited. Exiting Mouse Jump");
cancellationTokenSource.Cancel();
Application.Exit();
});
var settingsHelper = new SettingsHelper();
var mainForm = new MainForm(settingsHelper);
NativeEventWaiter.WaitForEventLoop(
Constants.MouseJumpShowPreviewEvent(),
mainForm.ShowPreview,
Dispatcher.CurrentDispatcher,
cancellationTokenSource.Token);
Application.Run();
}
private static MouseJumpSettings ReadSettings()

2
src/modules/launcher/Plugins/Community.PowerToys.Run.Plugin.UnitConverter/Main.cs
View File

@ -21,6 +21,8 @@ namespace Community.PowerToys.Run.Plugin.UnitConverter
public string Description => Properties.Resources.plugin_description;
public static string PluginID => "aa0ee9daff654fb7be452c2d77c471b9";
private PluginInitContext _context;
private static string _icon_path;
private bool _disposed;

2
src/modules/launcher/Plugins/Community.PowerToys.Run.Plugin.VSCodeWorkspaces/Main.cs
View File

@ -23,6 +23,8 @@ namespace Community.PowerToys.Run.Plugin.VSCodeWorkspaces
public string Description => GetTranslatedPluginDescription();
public static string PluginID => "525995402BEF4A8CA860D92F6D108092";
public Main()
{
VSCodeInstances.LoadVSCodeInstances();

2
src/modules/launcher/Plugins/Community.PowerToys.Run.Plugin.ValueGenerator/Main.cs
View File

@ -20,6 +20,8 @@ namespace Community.PowerToys.Run.Plugin.ValueGenerator
public string Description => Resources.plugin_description;
public static string PluginID => "a26b1bb4dbd911edafa10242ac120002";
private PluginInitContext _context;
private static bool _isLightTheme = true;
private bool _disposed;

2
src/modules/launcher/Plugins/Community.PowerToys.Run.Plugin.WebSearch/Main.cs
View File

@ -36,6 +36,8 @@ namespace Community.PowerToys.Run.Plugin.WebSearch
public string Description => Properties.Resources.plugin_description;
public static string PluginID => "9F1B49201C3F4BF781CAAD5CD88EA4DC";
public IEnumerable<PluginAdditionalOption> AdditionalOptions => new List<PluginAdditionalOption>()
{
new PluginAdditionalOption()

2
src/modules/launcher/Plugins/Microsoft.Plugin.Folder/Main.cs
View File

@ -44,6 +44,8 @@ namespace Microsoft.Plugin.Folder
public string Description => Properties.Resources.wox_plugin_folder_plugin_description;
public static string PluginID => "B4D3B69656E14D44865C8D818EAE47C4";
public void Save()
{
_storage.Save();

2
src/modules/launcher/Plugins/Microsoft.Plugin.Indexer/Main.cs
View File

@ -51,6 +51,8 @@ namespace Microsoft.Plugin.Indexer
public string Description => Properties.Resources.Microsoft_plugin_indexer_plugin_description;
public static string PluginID => "2140FC9819AD43A3A616E2735815C27C";
public IEnumerable<PluginAdditionalOption> AdditionalOptions => new List<PluginAdditionalOption>()
{
new PluginAdditionalOption()

2
src/modules/launcher/Plugins/Microsoft.Plugin.Program/Main.cs
View File

@ -37,6 +37,8 @@ namespace Microsoft.Plugin.Program
public string Description => Properties.Resources.wox_plugin_program_plugin_description;
public static string PluginID => "791FC278BA414111B8D1886DFE447410";
private static PluginInitContext _context;
private readonly PluginJsonStorage<ProgramPluginSettings> _settingsStorage;
private bool _disposed;

2
src/modules/launcher/Plugins/Microsoft.Plugin.Shell/Main.cs
View File

@ -39,6 +39,8 @@ namespace Microsoft.Plugin.Shell
public string Description => Properties.Resources.wox_plugin_cmd_plugin_description;
public static string PluginID => "D409510CD0D2481F853690A07E6DC426";
public IEnumerable<PluginAdditionalOption> AdditionalOptions => new List<PluginAdditionalOption>()
{
new PluginAdditionalOption()

2
src/modules/launcher/Plugins/Microsoft.Plugin.Uri/Main.cs
View File

@ -37,6 +37,8 @@ namespace Microsoft.Plugin.Uri
public string Description => Properties.Resources.Microsoft_plugin_uri_plugin_description;
public static string PluginID => "03276A39D4E9417C8FFD200B0EE5E871";
public List<ContextMenuResult> LoadContextMenus(Result selectedResult)
{
return new List<ContextMenuResult>(0);

2
src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Main.cs
View File

@ -29,6 +29,8 @@ namespace Microsoft.Plugin.WindowWalker
public string Description => Properties.Resources.wox_plugin_windowwalker_plugin_description;
public static string PluginID => "F737A9223560B3C6833B5FFB8CDF78E5";
internal static readonly VirtualDesktopHelper VirtualDesktopHelperInstance = new VirtualDesktopHelper();
public List<Result> Query(Query query)

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Calculator/Main.cs
View File

@ -30,6 +30,8 @@ namespace Microsoft.PowerToys.Run.Plugin.Calculator
public string Description => Resources.wox_plugin_calculator_plugin_description;
public static string PluginID => "CEA0FDFC6D3B4085823D60DC76F28855";
private bool _disposed;
public IEnumerable<PluginAdditionalOption> AdditionalOptions => new List<PluginAdditionalOption>()

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.History/Main.cs
View File

@ -22,6 +22,8 @@ namespace Microsoft.PowerToys.Run.Plugin.History
public string Description => Resources.wox_plugin_history_plugin_description;
public static string PluginID => "C88512156BB74580AADF7252E130BA8D";
private bool _disposed;
public List<Result> Query(Query query)

5
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote/Main.cs
View File

@ -59,6 +59,11 @@ namespace Microsoft.PowerToys.Run.Plugin.OneNote
/// </summary>
public string Description => Resources.PluginDescription;
/// <summary>
/// Gets the plugin ID for validation
/// </summary>
public static string PluginID => "0778F0C264114FEC8A3DF59447CF0A74";
/// <summary>
/// Initialize the plugin with the given <see cref="PluginInitContext"/>
/// </summary>

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.PowerToys/Main.cs
View File

@ -21,6 +21,8 @@ namespace Microsoft.PowerToys.Run.Plugin.PowerToys
public string Description => Resources.Plugin_Description;
public static string PluginID => "29DD65DB28C84A37BDEF1D2B43DA368B";
public string GetTranslatedPluginTitle() => Resources.Plugin_Name;
public string GetTranslatedPluginDescription() => Resources.Plugin_Description;

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Registry/Main.cs
View File

@ -46,6 +46,8 @@ namespace Microsoft.PowerToys.Run.Plugin.Registry
public string Description => Resources.PluginDescription;
public static string PluginID => "303417D927BF4C97BCFFC78A123BE0C8";
/// <summary>
/// Initializes a new instance of the <see cref="Main"/> class.
/// </summary>

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.Service/Main.cs
View File

@ -23,6 +23,8 @@ namespace Microsoft.PowerToys.Run.Plugin.Service
public string Description => Resources.wox_plugin_service_plugin_description;
public static string PluginID => "11A6C36E4E91439CA69F702CBD364EF7";
public void Init(PluginInitContext context)
{
_context = context;

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.System/Main.cs
View File

@ -31,6 +31,8 @@ namespace Microsoft.PowerToys.Run.Plugin.System
public string Description => Resources.Microsoft_plugin_sys_plugin_description;
public static string PluginID => "CEA08895D2544B019B2E9C5009600DF4";
public string IconTheme { get; set; }
public bool IsBootedInUefiMode { get; set; }

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Main.cs
View File

@ -25,6 +25,8 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate
public string Description => GetTranslatedPluginDescription();
public static string PluginID => "5D69806A5A474115821C3E4C56B9C793";
public IEnumerable<PluginAdditionalOption> AdditionalOptions
{
get

5
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.WindowsSettings/Main.cs
View File

@ -72,6 +72,11 @@ namespace Microsoft.PowerToys.Run.Plugin.WindowsSettings
/// </summary>
public string Description => Resources.PluginDescription;
/// <summary>
/// Gets the plugin ID for validation
/// </summary>
public static string PluginID => "5043CECEE6A748679CBE02D27D83747A";
/// <summary>
/// Initialize the plugin with the given <see cref="PluginInitContext"/>.
/// </summary>

2
src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.WindowsTerminal/Main.cs
View File

@ -34,6 +34,8 @@ namespace Microsoft.PowerToys.Run.Plugin.WindowsTerminal
public string Description => Resources.plugin_description;
public static string PluginID => "F59BA85006B14389A72A0EA756695F1D";
public IEnumerable<PluginAdditionalOption> AdditionalOptions => new List<PluginAdditionalOption>()
{
new PluginAdditionalOption()

21
src/modules/launcher/PowerLauncher/Plugin/PluginManager.cs
View File

@ -11,6 +11,8 @@ using System.IO.Abstractions;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;
using global::PowerToys.GPOWrapper;
using ManagedCommon;
using PowerLauncher.Properties;
using Wox.Infrastructure.Storage;
using Wox.Plugin;
@ -140,6 +142,25 @@ namespace PowerLauncher.Plugin
var failedPlugins = new ConcurrentQueue<PluginPair>();
Parallel.ForEach(AllPlugins, pair =>
{
// Check policy state for the plugin and update metadata
var enabledPolicyState = GPOWrapper.GetRunPluginEnabledValue(pair.Metadata.ID);
if (enabledPolicyState == GpoRuleConfigured.Enabled)
{
pair.Metadata.Disabled = false;
pair.Metadata.IsEnabledPolicyConfigured = true;
Log.Info($"The plugin <{pair.Metadata.Name}> is enabled by policy.", typeof(PluginManager));
}
else if (enabledPolicyState == GpoRuleConfigured.Disabled)
{
pair.Metadata.Disabled = true;
pair.Metadata.IsEnabledPolicyConfigured = true;
Log.Info($"The plugin <{pair.Metadata.Name}> is disabled by policy.", typeof(PluginManager));
}
else if (enabledPolicyState == GpoRuleConfigured.WrongValue)
{
Log.Warn($"Wrong policy value for enabled policy for plugin <{pair.Metadata.Name}>.", typeof(PluginManager));
}
if (pair.Metadata.Disabled)
{
return;

18
src/modules/launcher/PowerLauncher/SettingsReader.cs
View File

@ -9,6 +9,7 @@ using System.Linq;
using System.Threading;
using System.Windows.Input;
using Common.UI;
using global::PowerToys.GPOWrapper;
using Microsoft.PowerToys.Settings.UI.Library;
using PowerLauncher.Helper;
using PowerLauncher.Plugin;
@ -242,6 +243,7 @@ namespace PowerLauncher
IconPathDark = GetIcon(x.Metadata, x.Metadata.IcoPathDark),
IconPathLight = GetIcon(x.Metadata, x.Metadata.IcoPathLight),
AdditionalOptions = x.Plugin is ISettingProvider ? (x.Plugin as ISettingProvider).AdditionalOptions : new List<PluginAdditionalOption>(),
EnabledPolicyUiState = (int)GpoRuleConfigured.NotConfigured,
});
}
@ -253,14 +255,16 @@ namespace PowerLauncher
var defaultPlugins = GetDefaultPluginsSettings().ToDictionary(x => x.Id);
foreach (PowerLauncherPluginSettings plugin in settings.Plugins)
{
if (defaultPlugins.TryGetValue(plugin.Id, out PowerLauncherPluginSettings value))
if (defaultPlugins.ContainsKey(plugin.Id))
{
var additionalOptions = CombineAdditionalOptions(value.AdditionalOptions, plugin.AdditionalOptions);
plugin.Name = value.Name;
plugin.Description = value.Description;
plugin.Author = value.Author;
plugin.IconPathDark = value.IconPathDark;
plugin.IconPathLight = value.IconPathLight;
var additionalOptions = CombineAdditionalOptions(defaultPlugins[plugin.Id].AdditionalOptions, plugin.AdditionalOptions);
var enabledPolicyState = GPOWrapper.GetRunPluginEnabledValue(plugin.Id);
plugin.Name = defaultPlugins[plugin.Id].Name;
plugin.Description = defaultPlugins[plugin.Id].Description;
plugin.Author = defaultPlugins[plugin.Id].Author;
plugin.IconPathDark = defaultPlugins[plugin.Id].IconPathDark;
plugin.IconPathLight = defaultPlugins[plugin.Id].IconPathLight;
plugin.EnabledPolicyUiState = (int)enabledPolicyState;
defaultPlugins[plugin.Id] = plugin;
defaultPlugins[plugin.Id].AdditionalOptions = additionalOptions;
}

7
src/modules/launcher/Wox.Plugin/IPlugin.cs
View File

@ -2,6 +2,7 @@
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
namespace Wox.Plugin
@ -17,5 +18,11 @@ namespace Wox.Plugin
// Localized description
string Description { get; }
/* The two property lines are commented because they break the unit tests. (The Moq package used in the unit tests doesn't support the .Net 7 feature 'static abstract' properties yet.) - https://github.com/Moq/Moq/issues/1398
*
* // Plugin ID for validating the plugin.json entry (It must be static for accessing it before loading the plugin.)
* public static abstract string PluginID { get; }
*/
}
}

4
src/modules/launcher/Wox.Plugin/PluginMetadata.cs
View File

@ -32,6 +32,10 @@ namespace Wox.Plugin
public bool Disabled { get; set; }
// This property is used in PT Run only to decide whether to updated the Disabled property or not.
[JsonIgnore]
public bool IsEnabledPolicyConfigured { get; set; }
[JsonInclude]
public string ExecuteFilePath { get; private set; }

39
src/modules/launcher/Wox.Plugin/PluginPair.cs
View File

@ -63,20 +63,24 @@ namespace Wox.Plugin
return;
}
if (Metadata.Disabled && !setting.Disabled)
// If the enabled state is policy managed then we skip the update of the disabled state as it must be a manual settings.json manipulation.
if (!Metadata.IsEnabledPolicyConfigured)
{
Metadata.Disabled = false;
InitializePlugin(api);
if (!IsPluginInitialized)
if (Metadata.Disabled && !setting.Disabled)
{
string description = $"{Resources.FailedToLoadPluginDescription} {Metadata.Name}\n\n{Resources.FailedToLoadPluginDescriptionPartTwo}";
api.ShowMsg(Resources.FailedToLoadPluginTitle, description, string.Empty, false);
Metadata.Disabled = false;
InitializePlugin(api);
if (!IsPluginInitialized)
{
string description = $"{Resources.FailedToLoadPluginDescription} {Metadata.Name}\n\n{Resources.FailedToLoadPluginDescriptionPartTwo}";
api.ShowMsg(Resources.FailedToLoadPluginTitle, description, string.Empty, false);
}
}
else
{
Metadata.Disabled = setting.Disabled;
}
}
else
{
Metadata.Disabled = setting.Disabled;
}
Metadata.ActionKeyword = setting.ActionKeyword;
@ -167,6 +171,19 @@ namespace Wox.Plugin
return false;
}
// Validate plugin ID to prevent bypassing the GPO by changing the ID in the plugin.json file.
string pluginID = (string)type.GetProperty("PluginID", BindingFlags.Public | BindingFlags.Static)?.GetValue(null);
if (pluginID == null)
{
Log.Error($"Can't validate plugin ID of plugin <{Metadata.Name}> in {Metadata.ExecuteFilePath}: The static property <Main.PluginID> was not found.", MethodBase.GetCurrentMethod().DeclaringType);
return false;
}
else if (pluginID != Metadata.ID)
{
Log.Error($"Wrong plugin ID found in plugin.json of plugin <{Metadata.Name}>. ('{Metadata.ID}' != '{pluginID}')", MethodBase.GetCurrentMethod().DeclaringType);
return false;
}
try
{
Plugin = (IPlugin)Activator.CreateInstance(type);

18
src/settings-ui/Settings.UI.Library/MouseJumpSettings.cs
View File

@ -2,6 +2,8 @@
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.PowerToys.Settings.UI.Library.Interfaces;
@ -21,6 +23,22 @@ namespace Microsoft.PowerToys.Settings.UI.Library
Version = "1.0";
}
public void Save(ISettingsUtils settingsUtils)
{
// Save settings to file
var options = new JsonSerializerOptions
{
WriteIndented = true,
};
if (settingsUtils == null)
{
throw new ArgumentNullException(nameof(settingsUtils));
}
settingsUtils.SaveSettings(JsonSerializer.Serialize(this, options), ModuleName);
}
public string GetModuleName()
{
return Name;

4
src/settings-ui/Settings.UI.Library/PowerLauncherPluginSettings.cs
View File

@ -18,6 +18,10 @@ namespace Microsoft.PowerToys.Settings.UI.Library
public bool Disabled { get; set; }
// Use to communicate the state to settings UI (Using int type because we can't reference GPOWrapper.)
// This property should never be used inside of PT Run to get the policy state as it can be manipulated by changing the settings.json file.
public int EnabledPolicyUiState { get; set; }
public bool IsGlobal { get; set; }
public string ActionKeyword { get; set; }

10
src/settings-ui/Settings.UI/SettingsXAML/Views/PowerLauncherPage.xaml
View File

@ -238,7 +238,12 @@
</controls:SettingsCard>
<InfoBar
x:Uid="Run_SomePluginsAreGpoManaged"
IsClosable="False"
IsOpen="{x:Bind ViewModel.ShowPluginsAreGpoManagedInfo, Mode=OneWay}"
IsTabStop="{x:Bind ViewModel.ShowPluginsAreGpoManagedInfo, Mode=OneWay}"
Severity="Informational" />
<InfoBar
x:Uid="Run_AllPluginsDisabled"
IsClosable="False"
@ -293,7 +298,8 @@
Visibility="{x:Bind ShowBadgeOnPluginSettingError}" />
</Grid>
<ToggleSwitch x:Uid="PowerLauncher_EnablePluginToggle" IsOn="{x:Bind Path=Disabled, Converter={StaticResource BoolNegationConverter}, Mode=TwoWay}" />
<ToggleSwitch x:Uid="PowerLauncher_EnablePluginToggle" IsOn="{x:Bind Path=Disabled, Converter={StaticResource BoolNegationConverter}, Mode=TwoWay}" IsEnabled="{x:Bind Path=EnabledGpoRuleIsConfigured, Converter={StaticResource BoolNegationConverter}, Mode=OneWay}" />
</StackPanel>
<controls:SettingsExpander.Items>
<controls:SettingsCard x:Uid="PowerLauncher_ActionKeyword" IsEnabled="{x:Bind Enabled, Mode=OneWay}">

3
src/settings-ui/Settings.UI/Strings/en-us/Resources.resw
View File

@ -3680,6 +3680,9 @@ Activate by holding the key for the character you want to add an accent to, then
<data name="Run_PluginUseFindMorePlugins.Content" xml:space="preserve">
<value>Find more plugins</value>
</data>
<data name="Run_SomePluginsAreGpoManaged.Title" xml:space="preserve">
<value>The system administrator is managing the enabled state of some plugins.</value>
</data>
<data name="AlwaysOnTop_FrameOpacity.Header" xml:space="preserve">
<value>Opacity (%)</value>
</data>

23
src/settings-ui/Settings.UI/ViewModels/PowerLauncherPluginViewModel.cs
View File

@ -8,6 +8,7 @@ using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using global::PowerToys.GPOWrapper;
using Microsoft.PowerToys.Settings.UI.Library;
namespace Microsoft.PowerToys.Settings.UI.ViewModels
@ -33,6 +34,9 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
NotifyPropertyChanged(nameof(AdditionalOptions));
};
}
_enabledGpoRuleConfiguration = (GpoRuleConfigured)settings.EnabledPolicyUiState;
_enabledGpoRuleIsConfigured = _enabledGpoRuleConfiguration == GpoRuleConfigured.Disabled || _enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled;
}
public string Id { get => settings.Id; }
@ -43,11 +47,25 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
public string Author { get => settings.Author; }
private GpoRuleConfigured _enabledGpoRuleConfiguration;
private bool _enabledGpoRuleIsConfigured;
public bool Disabled
{
get
{
return settings.Disabled;
if (_enabledGpoRuleConfiguration == GpoRuleConfigured.Disabled)
{
return true;
}
else if (_enabledGpoRuleConfiguration == GpoRuleConfigured.Enabled)
{
return false;
}
else
{
return settings.Disabled;
}
}
set
@ -55,6 +73,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
if (settings.Disabled != value)
{
settings.Disabled = value;
NotifyPropertyChanged();
NotifyPropertyChanged(nameof(ShowNotAccessibleWarning));
NotifyPropertyChanged(nameof(Enabled));
@ -67,6 +86,8 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
public bool Enabled => !Disabled;
public bool EnabledGpoRuleIsConfigured => _enabledGpoRuleIsConfigured;
public double DisabledOpacity => Disabled ? 0.5 : 1;
public bool IsGlobalAndEnabled

10
src/settings-ui/Settings.UI/ViewModels/PowerLauncherViewModel.cs
View File

@ -132,6 +132,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
}
OnPropertyChanged(nameof(ShowAllPluginsDisabledWarning));
OnPropertyChanged(nameof(ShowPluginsAreGpoManagedInfo));
UpdateSettings();
}
@ -171,6 +172,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
OnPropertyChanged(nameof(EnablePowerLauncher));
OnPropertyChanged(nameof(ShowAllPluginsDisabledWarning));
OnPropertyChanged(nameof(ShowPluginsLoadingMessage));
OnPropertyChanged(nameof(ShowPluginsAreGpoManagedInfo));
OutGoingGeneralSettings outgoing = new OutGoingGeneralSettings(GeneralSettingsConfig);
SendConfigMSG(outgoing.ToString());
}
@ -183,6 +185,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
OnPropertyChanged(nameof(EnablePowerLauncher));
OnPropertyChanged(nameof(ShowAllPluginsDisabledWarning));
OnPropertyChanged(nameof(ShowPluginsLoadingMessage));
OnPropertyChanged(nameof(ShowPluginsAreGpoManagedInfo));
}
public bool IsEnabledGpoConfigured
@ -613,9 +616,14 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
}
}
public bool ShowPluginsAreGpoManagedInfo
{
get => EnablePowerLauncher && settings.Plugins.Any() && Plugins.Any(x => x.EnabledGpoRuleIsConfigured);
}
public bool ShowAllPluginsDisabledWarning
{
get => EnablePowerLauncher && settings.Plugins.Any() && settings.Plugins.All(x => x.Disabled);
get => EnablePowerLauncher && settings.Plugins.Any() && Plugins.All(x => x.Disabled);
}
public bool ShowPluginsLoadingMessage