mirror of
https://github.com/microsoft/PowerToys.git
synced 2025-12-16 11:48:06 +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 Implements comprehensive hotkey conflict detection and resolution system for PowerToys, providing real-time conflict checking and centralized management interface. ## PR Checklist - [ ] **Closes:** #xxx - [x] **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 - [x] **Localization:** All end-user-facing strings can be localized - [x] **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) - [x] **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: [Shortcut conflict detction dev spec](https://github.com/MicrosoftDocs/windows-dev-docs/pull/5519) ## TODO Lists - [x] Add real-time hotkey validation functionality to the hotkey dialog - [x] Immediately detect conflicts and update shortcut conflict status after applying new shortcuts - [x] Return conflict list from runner hotkey conflict detector for conflict checking. - [x] Implement the Tooltip for every shortcut control - [x] Add dialog UI for showing all the shortcut conflicts - [x] Support changing shortcut directly inside the shortcut conflict window/dialog, no need to nav to the settings page. - [x] Redesign the `ShortcutConflictDialogContentControl` to align with the spec - [x] Add navigating and changing hotkey auctionability to the `ShortcutConflictDialogContentControl` - [x] Add telemetry. Impemented in [another PR](https://github.com/shuaiyuanxx/PowerToys/pull/47) ## Shortcut Conflict Support Modules  <details> <summary>Demo videos</summary> https://github.com/user-attachments/assets/476d992c-c6ca-4bcd-a3f2-b26cc612d1b9 https://github.com/user-attachments/assets/1c1a2537-de54-4db2-bdbf-6f1908ff1ce7 https://github.com/user-attachments/assets/9c992254-fc2b-402c-beec-20fceef25e6b https://github.com/user-attachments/assets/d66abc1c-b8bf-45f8-a552-ec989dab310f </details> <!-- 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 Manually validation performed. --------- Signed-off-by: Shawn Yuan <shuaiyuan@microsoft.com> Signed-off-by: Shuai Yuan <shuai.yuan.zju@gmail.com> Co-authored-by: Niels Laute <niels.laute@live.nl>
855 lines
33 KiB
C++
855 lines
33 KiB
C++
// dllmain.cpp : Defines the entry point for the DLL application.
|
|
#include "pch.h"
|
|
|
|
#include "AdvancedPasteConstants.h"
|
|
#include "AdvancedPasteProcessManager.h"
|
|
#include <interface/powertoy_module_interface.h>
|
|
#include "trace.h"
|
|
#include "Generated Files/resource.h"
|
|
#include <common/logger/logger.h>
|
|
#include <common/SettingsAPI/settings_helpers.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>
|
|
#include <common/utils/gpo.h>
|
|
|
|
#include <winrt/Windows.Security.Credentials.h>
|
|
#include <vector>
|
|
|
|
BOOL APIENTRY DllMain(HMODULE /*hModule*/, DWORD ul_reason_for_call, LPVOID /*lpReserved*/)
|
|
{
|
|
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;
|
|
}
|
|
|
|
namespace
|
|
{
|
|
const wchar_t JSON_KEY_PROPERTIES[] = L"properties";
|
|
const wchar_t JSON_KEY_CUSTOM_ACTIONS[] = L"custom-actions";
|
|
const wchar_t JSON_KEY_ADDITIONAL_ACTIONS[] = L"additional-actions";
|
|
const wchar_t JSON_KEY_SHORTCUT[] = L"shortcut";
|
|
const wchar_t JSON_KEY_IS_SHOWN[] = L"isShown";
|
|
const wchar_t JSON_KEY_ID[] = L"id";
|
|
const wchar_t JSON_KEY_WIN[] = L"win";
|
|
const wchar_t JSON_KEY_ALT[] = L"alt";
|
|
const wchar_t JSON_KEY_CTRL[] = L"ctrl";
|
|
const wchar_t JSON_KEY_SHIFT[] = L"shift";
|
|
const wchar_t JSON_KEY_CODE[] = L"code";
|
|
const wchar_t JSON_KEY_PASTE_AS_PLAIN_HOTKEY[] = L"paste-as-plain-hotkey";
|
|
const wchar_t JSON_KEY_ADVANCED_PASTE_UI_HOTKEY[] = L"advanced-paste-ui-hotkey";
|
|
const wchar_t JSON_KEY_PASTE_AS_MARKDOWN_HOTKEY[] = L"paste-as-markdown-hotkey";
|
|
const wchar_t JSON_KEY_PASTE_AS_JSON_HOTKEY[] = L"paste-as-json-hotkey";
|
|
const wchar_t JSON_KEY_IS_ADVANCED_AI_ENABLED[] = L"IsAdvancedAIEnabled";
|
|
const wchar_t JSON_KEY_SHOW_CUSTOM_PREVIEW[] = L"ShowCustomPreview";
|
|
const wchar_t JSON_KEY_VALUE[] = L"value";
|
|
|
|
const wchar_t OPENAI_VAULT_RESOURCE[] = L"https://platform.openai.com/api-keys";
|
|
const wchar_t OPENAI_VAULT_USERNAME[] = L"PowerToys_AdvancedPaste_OpenAIKey";
|
|
}
|
|
|
|
class AdvancedPaste : public PowertoyModuleIface
|
|
{
|
|
private:
|
|
|
|
AdvancedPasteProcessManager m_process_manager;
|
|
bool m_enabled = false;
|
|
|
|
std::wstring app_name;
|
|
|
|
//contains the non localized key of the powertoy
|
|
std::wstring app_key;
|
|
|
|
static const constexpr int NUM_DEFAULT_HOTKEYS = 4;
|
|
|
|
Hotkey m_paste_as_plain_hotkey = { .win = true, .ctrl = true, .shift = false, .alt = true, .key = 'V' };
|
|
Hotkey m_advanced_paste_ui_hotkey = { .win = true, .ctrl = false, .shift = true, .alt = false, .key = 'V' };
|
|
Hotkey m_paste_as_markdown_hotkey{};
|
|
Hotkey m_paste_as_json_hotkey{};
|
|
|
|
template<class Id>
|
|
struct ActionData
|
|
{
|
|
Id id;
|
|
Hotkey hotkey;
|
|
};
|
|
|
|
using AdditionalAction = ActionData<std::wstring>;
|
|
std::vector<AdditionalAction> m_additional_actions;
|
|
|
|
using CustomAction = ActionData<int>;
|
|
std::vector<CustomAction> m_custom_actions;
|
|
|
|
bool m_is_advanced_ai_enabled = false;
|
|
bool m_preview_custom_format_output = true;
|
|
|
|
Hotkey parse_single_hotkey(const wchar_t* keyName, const winrt::Windows::Data::Json::JsonObject& settingsObject)
|
|
{
|
|
try
|
|
{
|
|
const auto jsonHotkeyObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).GetNamedObject(keyName);
|
|
return parse_single_hotkey(jsonHotkeyObject);
|
|
}
|
|
catch (...)
|
|
{
|
|
Logger::error("Failed to initialize AdvancedPaste shortcut from settings. Value will keep unchanged.");
|
|
}
|
|
|
|
return {};
|
|
}
|
|
|
|
static Hotkey parse_single_hotkey(const winrt::Windows::Data::Json::JsonObject& jsonHotkeyObject, bool isShown = true)
|
|
{
|
|
try
|
|
{
|
|
Hotkey hotkey;
|
|
hotkey.win = jsonHotkeyObject.GetNamedBoolean(JSON_KEY_WIN);
|
|
hotkey.alt = jsonHotkeyObject.GetNamedBoolean(JSON_KEY_ALT);
|
|
hotkey.shift = jsonHotkeyObject.GetNamedBoolean(JSON_KEY_SHIFT);
|
|
hotkey.ctrl = jsonHotkeyObject.GetNamedBoolean(JSON_KEY_CTRL);
|
|
hotkey.key = static_cast<unsigned char>(jsonHotkeyObject.GetNamedNumber(JSON_KEY_CODE));
|
|
hotkey.isShown = isShown;
|
|
return hotkey;
|
|
}
|
|
catch (...)
|
|
{
|
|
Logger::error("Failed to initialize AdvancedPaste shortcut from settings. Value will keep unchanged.");
|
|
}
|
|
|
|
return {};
|
|
}
|
|
|
|
static json::JsonObject to_json_object(const Hotkey& hotkey)
|
|
{
|
|
json::JsonObject jsonObject;
|
|
jsonObject.SetNamedValue(JSON_KEY_WIN, json::value(hotkey.win));
|
|
jsonObject.SetNamedValue(JSON_KEY_ALT, json::value(hotkey.alt));
|
|
jsonObject.SetNamedValue(JSON_KEY_SHIFT, json::value(hotkey.shift));
|
|
jsonObject.SetNamedValue(JSON_KEY_CTRL, json::value(hotkey.ctrl));
|
|
jsonObject.SetNamedValue(JSON_KEY_CODE, json::value(hotkey.key));
|
|
|
|
return jsonObject;
|
|
}
|
|
|
|
static bool open_ai_key_exists()
|
|
{
|
|
try
|
|
{
|
|
winrt::Windows::Security::Credentials::PasswordVault().Retrieve(OPENAI_VAULT_RESOURCE, OPENAI_VAULT_USERNAME);
|
|
return true;
|
|
}
|
|
catch (const winrt::hresult_error& ex)
|
|
{
|
|
// Looks like the only way to access the PasswordVault is through an API that throws an exception in case the resource doesn't exist.
|
|
// If the debugger breaks here, just continue.
|
|
// If you want to disable breaking here in a more permanent way, just add a condition in Visual Studio's Exception Settings to not break on win::hresult_error, but that might make you not hit other exceptions you might want to catch.
|
|
if (ex.code() == HRESULT_FROM_WIN32(ERROR_NOT_FOUND))
|
|
{
|
|
return false; // Credential doesn't exist.
|
|
}
|
|
Logger::error("Unexpected error while retrieving OpenAI key from vault: {}", winrt::to_string(ex.message()));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
bool is_open_ai_enabled()
|
|
{
|
|
return gpo_policy_enabled_configuration() != powertoys_gpo::gpo_rule_configured_disabled &&
|
|
powertoys_gpo::getAllowedAdvancedPasteOnlineAIModelsValue() != powertoys_gpo::gpo_rule_configured_disabled &&
|
|
open_ai_key_exists();
|
|
}
|
|
|
|
static std::wstring kebab_to_pascal_case(const std::wstring& kebab_str)
|
|
{
|
|
std::wstring result;
|
|
bool capitalize_next = true;
|
|
|
|
for (const auto ch : kebab_str)
|
|
{
|
|
if (ch == L'-')
|
|
{
|
|
capitalize_next = true;
|
|
}
|
|
else
|
|
{
|
|
if (capitalize_next)
|
|
{
|
|
result += std::towupper(ch);
|
|
capitalize_next = false;
|
|
}
|
|
else
|
|
{
|
|
result += ch;
|
|
}
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
bool migrate_data_and_remove_data_file(Hotkey& old_paste_as_plain_hotkey)
|
|
{
|
|
const wchar_t OLD_JSON_KEY_ACTIVATION_SHORTCUT[] = L"ActivationShortcut";
|
|
const wchar_t OLD_MODULE_KEY[] = L"PastePlain";
|
|
|
|
try
|
|
{
|
|
const std::wstring save_file_location = PTSettingsHelper::get_module_save_file_location(OLD_MODULE_KEY);
|
|
if (std::filesystem::exists(save_file_location))
|
|
{
|
|
PowerToysSettings::PowerToyValues settings =
|
|
PowerToysSettings::PowerToyValues::load_from_settings_file(OLD_MODULE_KEY);
|
|
|
|
auto settingsObject = settings.get_raw_json();
|
|
if (settingsObject.GetView().Size())
|
|
{
|
|
old_paste_as_plain_hotkey = parse_single_hotkey(OLD_JSON_KEY_ACTIVATION_SHORTCUT, settingsObject);
|
|
|
|
std::filesystem::remove(save_file_location);
|
|
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
catch (std::exception)
|
|
{
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void process_additional_action(const winrt::hstring& actionName, const winrt::Windows::Data::Json::IJsonValue& actionValue, bool actionsGroupIsShown = true)
|
|
{
|
|
bool actionIsShown = true;
|
|
|
|
if (actionValue.ValueType() != winrt::Windows::Data::Json::JsonValueType::Object)
|
|
{
|
|
return;
|
|
}
|
|
|
|
const auto action = actionValue.GetObjectW();
|
|
|
|
if (!action.GetNamedBoolean(JSON_KEY_IS_SHOWN, false) || !actionsGroupIsShown)
|
|
{
|
|
actionIsShown = false;
|
|
}
|
|
|
|
if (action.HasKey(JSON_KEY_SHORTCUT))
|
|
{
|
|
const AdditionalAction additionalAction
|
|
{
|
|
actionName.c_str(),
|
|
parse_single_hotkey(action.GetNamedObject(JSON_KEY_SHORTCUT), actionIsShown)
|
|
};
|
|
|
|
m_additional_actions.push_back(additionalAction);
|
|
}
|
|
else
|
|
{
|
|
for (const auto& [subActionName, subAction] : action)
|
|
{
|
|
process_additional_action(subActionName, subAction, actionIsShown);
|
|
}
|
|
}
|
|
}
|
|
|
|
void read_settings(PowerToysSettings::PowerToyValues& settings)
|
|
{
|
|
const auto settingsObject = settings.get_raw_json();
|
|
|
|
// Migrate Paste As Plain text shortcut
|
|
Hotkey old_paste_as_plain_hotkey;
|
|
bool old_data_migrated = migrate_data_and_remove_data_file(old_paste_as_plain_hotkey);
|
|
if (old_data_migrated)
|
|
{
|
|
m_paste_as_plain_hotkey = old_paste_as_plain_hotkey;
|
|
|
|
// override settings file
|
|
const auto new_hotkey_value = to_json_object(old_paste_as_plain_hotkey);
|
|
|
|
if (!settingsObject.HasKey(JSON_KEY_PROPERTIES))
|
|
{
|
|
settingsObject.SetNamedValue(JSON_KEY_PROPERTIES, json::JsonObject{});
|
|
}
|
|
|
|
settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).SetNamedValue(JSON_KEY_PASTE_AS_PLAIN_HOTKEY, new_hotkey_value);
|
|
|
|
const auto ui_hotkey = to_json_object(m_advanced_paste_ui_hotkey);
|
|
settingsObject.GetNamedObject(JSON_KEY_PROPERTIES).SetNamedValue(JSON_KEY_ADVANCED_PASTE_UI_HOTKEY, ui_hotkey);
|
|
|
|
settings.save_to_settings_file();
|
|
}
|
|
else
|
|
{
|
|
if (settingsObject.GetView().Size())
|
|
{
|
|
const std::array<std::pair<Hotkey*, LPCWSTR>, NUM_DEFAULT_HOTKEYS> defaultHotkeys{
|
|
{ { &m_paste_as_plain_hotkey, JSON_KEY_PASTE_AS_PLAIN_HOTKEY },
|
|
{ &m_advanced_paste_ui_hotkey, JSON_KEY_ADVANCED_PASTE_UI_HOTKEY },
|
|
{ &m_paste_as_markdown_hotkey, JSON_KEY_PASTE_AS_MARKDOWN_HOTKEY },
|
|
{ &m_paste_as_json_hotkey, JSON_KEY_PASTE_AS_JSON_HOTKEY } }
|
|
};
|
|
|
|
for (auto& [hotkey, keyName] : defaultHotkeys)
|
|
{
|
|
*hotkey = parse_single_hotkey(keyName, settingsObject);
|
|
}
|
|
|
|
m_additional_actions.clear();
|
|
m_custom_actions.clear();
|
|
|
|
if (settingsObject.HasKey(JSON_KEY_PROPERTIES))
|
|
{
|
|
const auto propertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES);
|
|
|
|
if (propertiesObject.HasKey(JSON_KEY_ADDITIONAL_ACTIONS))
|
|
{
|
|
const auto additionalActions = propertiesObject.GetNamedObject(JSON_KEY_ADDITIONAL_ACTIONS);
|
|
|
|
// Define the expected order to ensure consistent hotkey ID assignment
|
|
const std::vector<winrt::hstring> expectedOrder = {
|
|
L"image-to-text",
|
|
L"paste-as-file",
|
|
L"transcode"
|
|
};
|
|
|
|
// Process actions in the predefined order
|
|
for (auto& actionKey : expectedOrder)
|
|
{
|
|
if (additionalActions.HasKey(actionKey))
|
|
{
|
|
const auto actionValue = additionalActions.GetNamedValue(actionKey);
|
|
process_additional_action(actionKey, actionValue);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (propertiesObject.HasKey(JSON_KEY_CUSTOM_ACTIONS))
|
|
{
|
|
const auto customActions = propertiesObject.GetNamedObject(JSON_KEY_CUSTOM_ACTIONS).GetNamedArray(JSON_KEY_VALUE);
|
|
if (customActions.Size() > 0 && is_open_ai_enabled())
|
|
{
|
|
for (const auto& customAction : customActions)
|
|
{
|
|
const auto object = customAction.GetObjectW();
|
|
bool actionIsShown = object.GetNamedBoolean(JSON_KEY_IS_SHOWN, false);
|
|
|
|
const CustomAction customActionData{
|
|
static_cast<int>(object.GetNamedNumber(JSON_KEY_ID)),
|
|
parse_single_hotkey(object.GetNamedObject(JSON_KEY_SHORTCUT), actionIsShown)
|
|
};
|
|
|
|
m_custom_actions.push_back(customActionData);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (settingsObject.GetView().Size())
|
|
{
|
|
const auto propertiesObject = settingsObject.GetNamedObject(JSON_KEY_PROPERTIES);
|
|
|
|
if (propertiesObject.HasKey(JSON_KEY_IS_ADVANCED_AI_ENABLED))
|
|
{
|
|
m_is_advanced_ai_enabled = propertiesObject.GetNamedObject(JSON_KEY_IS_ADVANCED_AI_ENABLED).GetNamedBoolean(JSON_KEY_VALUE);
|
|
}
|
|
|
|
if (propertiesObject.HasKey(JSON_KEY_SHOW_CUSTOM_PREVIEW))
|
|
{
|
|
m_preview_custom_format_output = propertiesObject.GetNamedObject(JSON_KEY_SHOW_CUSTOM_PREVIEW).GetNamedBoolean(JSON_KEY_VALUE);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Load the settings file.
|
|
void init_settings()
|
|
{
|
|
try
|
|
{
|
|
// Load and parse the settings file for this PowerToy.
|
|
PowerToysSettings::PowerToyValues settings =
|
|
PowerToysSettings::PowerToyValues::load_from_settings_file(get_key());
|
|
|
|
read_settings(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.
|
|
}
|
|
}
|
|
|
|
void try_inject_modifier_key_up(std::vector<INPUT>& inputs, short modifier)
|
|
{
|
|
// Most significant bit is set if key is down
|
|
if ((GetAsyncKeyState(static_cast<int>(modifier)) & 0x8000) != 0)
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = modifier;
|
|
input_event.ki.dwFlags = KEYEVENTF_KEYUP;
|
|
inputs.push_back(input_event);
|
|
}
|
|
}
|
|
|
|
void try_inject_modifier_key_restore(std::vector<INPUT>& inputs, short modifier)
|
|
{
|
|
// Most significant bit is set if key is down
|
|
if ((GetAsyncKeyState(static_cast<int>(modifier)) & 0x8000) != 0)
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = modifier;
|
|
inputs.push_back(input_event);
|
|
}
|
|
}
|
|
|
|
void try_to_paste_as_plain_text()
|
|
{
|
|
std::wstring clipboard_text;
|
|
|
|
{
|
|
// Read clipboard data begin
|
|
|
|
if (!OpenClipboard(NULL))
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't open the clipboard to get the text. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"read.OpenClipboard");
|
|
return;
|
|
}
|
|
HANDLE h_clipboard_data = GetClipboardData(CF_UNICODETEXT);
|
|
|
|
if (h_clipboard_data == NULL)
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Failed to get clipboard data. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"read.GetClipboardData");
|
|
CloseClipboard();
|
|
return;
|
|
}
|
|
|
|
wchar_t* pch_data = static_cast<wchar_t*>(GlobalLock(h_clipboard_data));
|
|
|
|
if (NULL == pch_data)
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't lock the buffer to get the unformatted text from the clipboard. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"read.GlobalLock");
|
|
CloseClipboard();
|
|
return;
|
|
}
|
|
|
|
clipboard_text = pch_data;
|
|
GlobalUnlock(h_clipboard_data);
|
|
|
|
CloseClipboard();
|
|
// Read clipboard data end
|
|
}
|
|
|
|
{
|
|
// Copy text to clipboard begin
|
|
UINT no_clipboard_history_or_roaming_format = 0;
|
|
|
|
// Get the format identifier for not adding the data to the clipboard history or roaming.
|
|
// https://learn.microsoft.com/windows/win32/dataxchg/clipboard-formats#cloud-clipboard-and-clipboard-history-formats
|
|
if (0 == (no_clipboard_history_or_roaming_format = RegisterClipboardFormat(L"ExcludeClipboardContentFromMonitorProcessing")))
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't get the clipboard data format type that would allow excluding the data from the clipboard history / roaming. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"write.RegisterClipboardFormat");
|
|
return;
|
|
}
|
|
|
|
if (!OpenClipboard(NULL))
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't open the clipboard to copy the unformatted text. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"write.OpenClipboard");
|
|
return;
|
|
}
|
|
|
|
HGLOBAL h_clipboard_data;
|
|
|
|
if (NULL == (h_clipboard_data = GlobalAlloc(GMEM_MOVEABLE, (clipboard_text.length() + 1) * sizeof(wchar_t))))
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't allocate a buffer for the unformatted text. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"write.GlobalAlloc");
|
|
CloseClipboard();
|
|
return;
|
|
}
|
|
wchar_t* pch_data = static_cast<wchar_t*>(GlobalLock(h_clipboard_data));
|
|
|
|
if (NULL == pch_data)
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't lock the buffer to send the unformatted text to the clipboard. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
GlobalFree(h_clipboard_data);
|
|
CloseClipboard();
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"write.GlobalLock");
|
|
return;
|
|
}
|
|
|
|
wcscpy_s(pch_data, clipboard_text.length() + 1, clipboard_text.c_str());
|
|
|
|
EmptyClipboard();
|
|
|
|
if (NULL == SetClipboardData(CF_UNICODETEXT, h_clipboard_data))
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"Couldn't set the clipboard data to the unformatted text. {}", errorMessage.has_value() ? errorMessage.value() : L"");
|
|
GlobalUnlock(h_clipboard_data);
|
|
GlobalFree(h_clipboard_data);
|
|
CloseClipboard();
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"write.SetClipboardData");
|
|
return;
|
|
}
|
|
|
|
// Don't show in history or allow data roaming.
|
|
SetClipboardData(no_clipboard_history_or_roaming_format, 0);
|
|
|
|
CloseClipboard();
|
|
// Copy text to clipboard end
|
|
}
|
|
{
|
|
// Clear kb state and send Ctrl+V begin
|
|
|
|
// we can assume that the last pressed key is...
|
|
// (1) not a modifier key and
|
|
// (2) marked as handled (so it never gets a key down input event).
|
|
// So, let's check which modifiers were pressed,
|
|
// and, if they were, inject a key up event for each of them
|
|
std::vector<INPUT> inputs;
|
|
try_inject_modifier_key_up(inputs, VK_LCONTROL);
|
|
try_inject_modifier_key_up(inputs, VK_RCONTROL);
|
|
try_inject_modifier_key_up(inputs, VK_LWIN);
|
|
try_inject_modifier_key_up(inputs, VK_RWIN);
|
|
try_inject_modifier_key_up(inputs, VK_LSHIFT);
|
|
try_inject_modifier_key_up(inputs, VK_RSHIFT);
|
|
try_inject_modifier_key_up(inputs, VK_LMENU);
|
|
try_inject_modifier_key_up(inputs, VK_RMENU);
|
|
|
|
// send Ctrl+V (key downs and key ups)
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = VK_CONTROL;
|
|
inputs.push_back(input_event);
|
|
}
|
|
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = 0x56; // V
|
|
// Avoid triggering detection by the centralized keyboard hook. Allows using Control+V as activation.
|
|
input_event.ki.dwExtraInfo = CENTRALIZED_KEYBOARD_HOOK_DONT_TRIGGER_FLAG;
|
|
inputs.push_back(input_event);
|
|
}
|
|
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = 0x56; // V
|
|
input_event.ki.dwFlags = KEYEVENTF_KEYUP;
|
|
// Avoid triggering detection by the centralized keyboard hook. Allows using Control+V as activation.
|
|
input_event.ki.dwExtraInfo = CENTRALIZED_KEYBOARD_HOOK_DONT_TRIGGER_FLAG;
|
|
inputs.push_back(input_event);
|
|
}
|
|
|
|
{
|
|
INPUT input_event = {};
|
|
input_event.type = INPUT_KEYBOARD;
|
|
input_event.ki.wVk = VK_CONTROL;
|
|
input_event.ki.dwFlags = KEYEVENTF_KEYUP;
|
|
inputs.push_back(input_event);
|
|
}
|
|
|
|
try_inject_modifier_key_restore(inputs, VK_LCONTROL);
|
|
try_inject_modifier_key_restore(inputs, VK_RCONTROL);
|
|
try_inject_modifier_key_restore(inputs, VK_LWIN);
|
|
try_inject_modifier_key_restore(inputs, VK_RWIN);
|
|
try_inject_modifier_key_restore(inputs, VK_LSHIFT);
|
|
try_inject_modifier_key_restore(inputs, VK_RSHIFT);
|
|
try_inject_modifier_key_restore(inputs, VK_LMENU);
|
|
try_inject_modifier_key_restore(inputs, VK_RMENU);
|
|
|
|
// After restoring the modifier keys send a dummy key to prevent Start Menu from activating
|
|
INPUT dummyEvent = {};
|
|
dummyEvent.type = INPUT_KEYBOARD;
|
|
dummyEvent.ki.wVk = 0xFF;
|
|
dummyEvent.ki.dwFlags = KEYEVENTF_KEYUP;
|
|
inputs.push_back(dummyEvent);
|
|
|
|
auto uSent = SendInput(static_cast<UINT>(inputs.size()), inputs.data(), sizeof(INPUT));
|
|
if (uSent != inputs.size())
|
|
{
|
|
DWORD errorCode = GetLastError();
|
|
auto errorMessage = get_last_error_message(errorCode);
|
|
Logger::error(L"SendInput failed. Expected to send {} inputs and sent only {}. {}", inputs.size(), uSent, errorMessage.has_value() ? errorMessage.value() : L"");
|
|
Trace::AdvancedPaste_Error(errorCode, errorMessage.has_value() ? errorMessage.value() : L"", L"input.SendInput");
|
|
return;
|
|
}
|
|
|
|
// Clear kb state and send Ctrl+V end
|
|
}
|
|
}
|
|
|
|
public:
|
|
AdvancedPaste()
|
|
{
|
|
app_name = GET_RESOURCE_STRING(IDS_ADVANCED_PASTE_NAME);
|
|
app_key = AdvancedPasteConstants::ModuleKey;
|
|
LoggerHelpers::init_logger(app_key, L"ModuleInterface", "AdvancedPaste");
|
|
init_settings();
|
|
}
|
|
|
|
~AdvancedPaste()
|
|
{
|
|
if (m_enabled)
|
|
{
|
|
}
|
|
m_enabled = false;
|
|
}
|
|
|
|
// Destroy the powertoy and free memory
|
|
virtual void destroy() override
|
|
{
|
|
Disable(false);
|
|
|
|
Logger::trace("AdvancedPaste::destroy()");
|
|
delete this;
|
|
}
|
|
|
|
// Return the localized display name of the powertoy
|
|
virtual const wchar_t* get_name() override
|
|
{
|
|
return app_name.c_str();
|
|
}
|
|
|
|
// Return the non localized key of the powertoy, this will be cached by the runner
|
|
virtual const wchar_t* get_key() override
|
|
{
|
|
return app_key.c_str();
|
|
}
|
|
|
|
// Return the configured status for the gpo policy for the module
|
|
virtual powertoys_gpo::gpo_rule_configured_t gpo_policy_enabled_configuration() override
|
|
{
|
|
return powertoys_gpo::getConfiguredAdvancedPasteEnabledValue();
|
|
}
|
|
|
|
virtual bool get_config(wchar_t* buffer, int* buffer_size) override
|
|
{
|
|
HINSTANCE hinstance = reinterpret_cast<HINSTANCE>(&__ImageBase);
|
|
|
|
// Create a Settings object.
|
|
PowerToysSettings::Settings settings(hinstance, get_name());
|
|
settings.set_description(GET_RESOURCE_STRING(IDS_ADVANCED_PASTE_SETTINGS_DESC));
|
|
|
|
settings.set_overview_link(L"https://aka.ms/PowerToysOverview_AdvancedPaste");
|
|
|
|
return settings.serialize_to_buffer(buffer, buffer_size);
|
|
}
|
|
|
|
virtual void call_custom_action(const wchar_t* /*action*/) override
|
|
{
|
|
}
|
|
|
|
virtual void set_config(const wchar_t* config) override
|
|
{
|
|
try
|
|
{
|
|
// Parse the input JSON string.
|
|
PowerToysSettings::PowerToyValues values =
|
|
PowerToysSettings::PowerToyValues::from_json_string(config, get_key());
|
|
|
|
read_settings(values);
|
|
|
|
std::unordered_map<std::wstring, Hotkey> additionalActionMap;
|
|
for (const auto& action : m_additional_actions)
|
|
{
|
|
additionalActionMap[kebab_to_pascal_case(action.id)] = action.hotkey;
|
|
}
|
|
|
|
// order of args matter
|
|
Trace::AdvancedPaste_SettingsTelemetry(m_paste_as_plain_hotkey,
|
|
m_advanced_paste_ui_hotkey,
|
|
m_paste_as_markdown_hotkey,
|
|
m_paste_as_json_hotkey,
|
|
m_is_advanced_ai_enabled,
|
|
m_preview_custom_format_output,
|
|
additionalActionMap);
|
|
|
|
// If you don't need to do any custom processing of the settings, proceed
|
|
// to persists the values calling:
|
|
values.save_to_settings_file();
|
|
// Otherwise call a custom function to process the settings before saving them to disk:
|
|
// save_settings();
|
|
}
|
|
catch (std::exception&)
|
|
{
|
|
// Improper JSON.
|
|
}
|
|
}
|
|
|
|
virtual void enable()
|
|
{
|
|
Logger::trace("AdvancedPaste::enable()");
|
|
Trace::AdvancedPaste_Enable(true);
|
|
m_enabled = true;
|
|
m_process_manager.start();
|
|
};
|
|
|
|
void Disable(bool traceEvent)
|
|
{
|
|
if (m_enabled)
|
|
{
|
|
m_process_manager.stop();
|
|
|
|
if (traceEvent)
|
|
{
|
|
Trace::AdvancedPaste_Enable(false);
|
|
}
|
|
}
|
|
|
|
m_enabled = false;
|
|
}
|
|
|
|
virtual void disable()
|
|
{
|
|
Logger::trace("AdvancedPaste::disable()");
|
|
Disable(true);
|
|
}
|
|
|
|
virtual bool on_hotkey(size_t hotkeyId) override
|
|
{
|
|
Logger::trace(L"AdvancedPaste hotkey pressed");
|
|
if (m_enabled)
|
|
{
|
|
m_process_manager.start();
|
|
|
|
// hotkeyId in same order as set by get_hotkeys
|
|
if (hotkeyId == 0)
|
|
{ // m_paste_as_plain_hotkey
|
|
Logger::trace(L"Paste as plain text hotkey pressed");
|
|
|
|
std::thread([=]() {
|
|
// hotkey work should be kept to a minimum, or Windows might deregister our low level keyboard hook.
|
|
// Move work to another thread.
|
|
try_to_paste_as_plain_text();
|
|
}).detach();
|
|
|
|
Trace::AdvancedPaste_Invoked(L"PastePlainTextDirect");
|
|
return true;
|
|
}
|
|
|
|
if (hotkeyId == 1)
|
|
{ // m_advanced_paste_ui_hotkey
|
|
Logger::trace(L"Setting start up event");
|
|
|
|
m_process_manager.bring_to_front();
|
|
m_process_manager.send_message(CommonSharedConstants::ADVANCED_PASTE_SHOW_UI_MESSAGE);
|
|
Trace::AdvancedPaste_Invoked(L"AdvancedPasteUI");
|
|
return true;
|
|
}
|
|
if (hotkeyId == 2)
|
|
{ // m_paste_as_markdown_hotkey
|
|
Logger::trace(L"Starting paste as markdown directly");
|
|
m_process_manager.send_message(CommonSharedConstants::ADVANCED_PASTE_MARKDOWN_MESSAGE);
|
|
Trace::AdvancedPaste_Invoked(L"MarkdownDirect");
|
|
return true;
|
|
}
|
|
if (hotkeyId == 3)
|
|
{ // m_paste_as_json_hotkey
|
|
Logger::trace(L"Starting paste as json directly");
|
|
m_process_manager.send_message(CommonSharedConstants::ADVANCED_PASTE_JSON_MESSAGE);
|
|
Trace::AdvancedPaste_Invoked(L"JsonDirect");
|
|
return true;
|
|
}
|
|
|
|
|
|
const auto additional_action_index = hotkeyId - NUM_DEFAULT_HOTKEYS;
|
|
if (additional_action_index < m_additional_actions.size())
|
|
{
|
|
const auto& id = m_additional_actions.at(additional_action_index).id;
|
|
|
|
Logger::trace(L"Starting additional action id={}", id);
|
|
|
|
Trace::AdvancedPaste_Invoked(std::format(L"{}Direct", kebab_to_pascal_case(id)));
|
|
|
|
m_process_manager.send_message(CommonSharedConstants::ADVANCED_PASTE_ADDITIONAL_ACTION_MESSAGE, id);
|
|
return true;
|
|
}
|
|
|
|
const auto custom_action_index = additional_action_index - m_additional_actions.size();
|
|
if (custom_action_index < m_custom_actions.size())
|
|
{
|
|
const auto id = m_custom_actions.at(custom_action_index).id;
|
|
|
|
Logger::trace(L"Starting custom action id={}", id);
|
|
|
|
m_process_manager.send_message(CommonSharedConstants::ADVANCED_PASTE_CUSTOM_ACTION_MESSAGE, std::to_wstring(id));
|
|
Trace::AdvancedPaste_Invoked(L"CustomActionDirect");
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
virtual size_t get_hotkeys(Hotkey* hotkeys, size_t buffer_size) override
|
|
{
|
|
const size_t num_hotkeys = NUM_DEFAULT_HOTKEYS + m_additional_actions.size() + m_custom_actions.size();
|
|
|
|
if (hotkeys && buffer_size >= num_hotkeys)
|
|
{
|
|
const std::array default_hotkeys = { m_paste_as_plain_hotkey,
|
|
m_advanced_paste_ui_hotkey,
|
|
m_paste_as_markdown_hotkey,
|
|
m_paste_as_json_hotkey };
|
|
std::copy(default_hotkeys.begin(), default_hotkeys.end(), hotkeys);
|
|
|
|
const auto get_action_hotkey = [](const auto& action) { return action.hotkey; };
|
|
std::transform(m_additional_actions.begin(), m_additional_actions.end(), hotkeys + NUM_DEFAULT_HOTKEYS, get_action_hotkey);
|
|
std::transform(m_custom_actions.begin(), m_custom_actions.end(), hotkeys + NUM_DEFAULT_HOTKEYS + m_additional_actions.size(), get_action_hotkey);
|
|
}
|
|
|
|
return num_hotkeys;
|
|
}
|
|
|
|
virtual bool is_enabled() override
|
|
{
|
|
return m_enabled;
|
|
}
|
|
};
|
|
|
|
extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
|
|
{
|
|
return new AdvancedPaste();
|
|
}
|