From a8799c3d9ae21e548c98aef69bc73d2fb1634487 Mon Sep 17 00:00:00 2001 From: Federico Terzi Date: Sat, 17 Jul 2021 15:58:19 +0200 Subject: [PATCH] feat(ui): refactor windows notification system away from WinToast --- espanso-ui/Cargo.toml | 2 + espanso-ui/build.rs | 2 - espanso-ui/src/win32/WinToast/README.md | 3 - espanso-ui/src/win32/WinToast/wintoastlib.cpp | 1129 ----------------- espanso-ui/src/win32/WinToast/wintoastlib.h | 217 ---- espanso-ui/src/win32/mod.rs | 61 +- espanso-ui/src/win32/native.cpp | 54 +- espanso-ui/src/win32/native.h | 4 - espanso-ui/src/win32/notification.rs | 102 ++ 9 files changed, 122 insertions(+), 1452 deletions(-) delete mode 100644 espanso-ui/src/win32/WinToast/README.md delete mode 100644 espanso-ui/src/win32/WinToast/wintoastlib.cpp delete mode 100644 espanso-ui/src/win32/WinToast/wintoastlib.h create mode 100644 espanso-ui/src/win32/notification.rs diff --git a/espanso-ui/Cargo.toml b/espanso-ui/Cargo.toml index ff27dd4..da2f630 100644 --- a/espanso-ui/Cargo.toml +++ b/espanso-ui/Cargo.toml @@ -20,6 +20,8 @@ thiserror = "1.0.23" [target.'cfg(windows)'.dependencies] widestring = "0.4.3" lazycell = "1.3.0" +winrt-notification = "0.3.1" +lazy_static = "1.4.0" [target.'cfg(target_os="macos")'.dependencies] lazycell = "1.3.0" diff --git a/espanso-ui/build.rs b/espanso-ui/build.rs index 892f936..cf17272 100644 --- a/espanso-ui/build.rs +++ b/espanso-ui/build.rs @@ -24,10 +24,8 @@ fn cc_config() { cc::Build::new() .cpp(true) .include("src/win32/native.h") - .include("src/win32/WinToast/wintoastlib.h") .include("src/win32/json/json.hpp") .file("src/win32/native.cpp") - .file("src/win32/WinToast/wintoastlib.cpp") .compile("espansoui"); println!("cargo:rustc-link-lib=static=espansoui"); diff --git a/espanso-ui/src/win32/WinToast/README.md b/espanso-ui/src/win32/WinToast/README.md deleted file mode 100644 index 42c5987..0000000 --- a/espanso-ui/src/win32/WinToast/README.md +++ /dev/null @@ -1,3 +0,0 @@ -In order to support native notifications on Windows, espanso wraps -WinToast, a great and lightweight C++ library. -More info: https://github.com/mohabouje/WinToast \ No newline at end of file diff --git a/espanso-ui/src/win32/WinToast/wintoastlib.cpp b/espanso-ui/src/win32/WinToast/wintoastlib.cpp deleted file mode 100644 index 0895ff7..0000000 --- a/espanso-ui/src/win32/WinToast/wintoastlib.cpp +++ /dev/null @@ -1,1129 +0,0 @@ -/* * Copyright (C) 2016-2019 Mohammed Boujemaoui - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -#include "wintoastlib.h" -#include -#include -#include -#include - -#pragma comment(lib,"shlwapi") -#pragma comment(lib,"user32") - -#ifdef NDEBUG - #define DEBUG_MSG(str) do { } while ( false ) -#else - #define DEBUG_MSG(str) do { std::wcout << str << std::endl; } while( false ) -#endif - -#define DEFAULT_SHELL_LINKS_PATH L"\\Microsoft\\Windows\\Start Menu\\Programs\\" -#define DEFAULT_LINK_FORMAT L".lnk" -#define STATUS_SUCCESS (0x00000000) - - -// Quickstart: Handling toast activations from Win32 apps in Windows 10 -// https://blogs.msdn.microsoft.com/tiles_and_toasts/2015/10/16/quickstart-handling-toast-activations-from-win32-apps-in-windows-10/ -using namespace WinToastLib; -namespace DllImporter { - - // Function load a function from library - template - HRESULT loadFunctionFromLibrary(HINSTANCE library, LPCSTR name, Function &func) { - if (!library) { - return E_INVALIDARG; - } - func = reinterpret_cast(GetProcAddress(library, name)); - return (func != nullptr) ? S_OK : E_FAIL; - } - - typedef HRESULT(FAR STDAPICALLTYPE *f_SetCurrentProcessExplicitAppUserModelID)(__in PCWSTR AppID); - typedef HRESULT(FAR STDAPICALLTYPE *f_PropVariantToString)(_In_ REFPROPVARIANT propvar, _Out_writes_(cch) PWSTR psz, _In_ UINT cch); - typedef HRESULT(FAR STDAPICALLTYPE *f_RoGetActivationFactory)(_In_ HSTRING activatableClassId, _In_ REFIID iid, _COM_Outptr_ void ** factory); - typedef HRESULT(FAR STDAPICALLTYPE *f_WindowsCreateStringReference)(_In_reads_opt_(length + 1) PCWSTR sourceString, UINT32 length, _Out_ HSTRING_HEADER * hstringHeader, _Outptr_result_maybenull_ _Result_nullonfailure_ HSTRING * string); - typedef PCWSTR(FAR STDAPICALLTYPE *f_WindowsGetStringRawBuffer)(_In_ HSTRING string, _Out_ UINT32 *length); - typedef HRESULT(FAR STDAPICALLTYPE *f_WindowsDeleteString)(_In_opt_ HSTRING string); - - static f_SetCurrentProcessExplicitAppUserModelID SetCurrentProcessExplicitAppUserModelID; - static f_PropVariantToString PropVariantToString; - static f_RoGetActivationFactory RoGetActivationFactory; - static f_WindowsCreateStringReference WindowsCreateStringReference; - static f_WindowsGetStringRawBuffer WindowsGetStringRawBuffer; - static f_WindowsDeleteString WindowsDeleteString; - - - template - _Check_return_ __inline HRESULT _1_GetActivationFactory(_In_ HSTRING activatableClassId, _COM_Outptr_ T** factory) { - return RoGetActivationFactory(activatableClassId, IID_INS_ARGS(factory)); - } - - template - inline HRESULT Wrap_GetActivationFactory(_In_ HSTRING activatableClassId, _Inout_ Details::ComPtrRef factory) noexcept { - return _1_GetActivationFactory(activatableClassId, factory.ReleaseAndGetAddressOf()); - } - - inline HRESULT initialize() { - HINSTANCE LibShell32 = LoadLibraryW(L"SHELL32.DLL"); - HRESULT hr = loadFunctionFromLibrary(LibShell32, "SetCurrentProcessExplicitAppUserModelID", SetCurrentProcessExplicitAppUserModelID); - if (SUCCEEDED(hr)) { - HINSTANCE LibPropSys = LoadLibraryW(L"PROPSYS.DLL"); - hr = loadFunctionFromLibrary(LibPropSys, "PropVariantToString", PropVariantToString); - if (SUCCEEDED(hr)) { - HINSTANCE LibComBase = LoadLibraryW(L"COMBASE.DLL"); - const bool succeded = SUCCEEDED(loadFunctionFromLibrary(LibComBase, "RoGetActivationFactory", RoGetActivationFactory)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsCreateStringReference", WindowsCreateStringReference)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsGetStringRawBuffer", WindowsGetStringRawBuffer)) - && SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsDeleteString", WindowsDeleteString)); - return succeded ? S_OK : E_FAIL; - } - } - return hr; - } -} - -class WinToastStringWrapper { -public: - WinToastStringWrapper(_In_reads_(length) PCWSTR stringRef, _In_ UINT32 length) noexcept { - HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef, length, &_header, &_hstring); - if (!SUCCEEDED(hr)) { - RaiseException(static_cast(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr); - } - } - - WinToastStringWrapper(_In_ const std::wstring &stringRef) noexcept { - HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef.c_str(), static_cast(stringRef.length()), &_header, &_hstring); - if (FAILED(hr)) { - RaiseException(static_cast(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr); - } - } - - ~WinToastStringWrapper() { - DllImporter::WindowsDeleteString(_hstring); - } - - inline HSTRING Get() const noexcept { - return _hstring; - } -private: - HSTRING _hstring; - HSTRING_HEADER _header; - -}; - -class InternalDateTime : public IReference { -public: - static INT64 Now() { - FILETIME now; - GetSystemTimeAsFileTime(&now); - return ((((INT64)now.dwHighDateTime) << 32) | now.dwLowDateTime); - } - - InternalDateTime(DateTime dateTime) : _dateTime(dateTime) {} - - InternalDateTime(INT64 millisecondsFromNow) { - _dateTime.UniversalTime = Now() + millisecondsFromNow * 10000; - } - - virtual ~InternalDateTime() = default; - - operator INT64() { - return _dateTime.UniversalTime; - } - - HRESULT STDMETHODCALLTYPE get_Value(DateTime *dateTime) { - *dateTime = _dateTime; - return S_OK; - } - - HRESULT STDMETHODCALLTYPE QueryInterface(const IID& riid, void** ppvObject) { - if (!ppvObject) { - return E_POINTER; - } - if (riid == __uuidof(IUnknown) || riid == __uuidof(IReference)) { - *ppvObject = static_cast(static_cast*>(this)); - return S_OK; - } - return E_NOINTERFACE; - } - - ULONG STDMETHODCALLTYPE Release() { - return 1; - } - - ULONG STDMETHODCALLTYPE AddRef() { - return 2; - } - - HRESULT STDMETHODCALLTYPE GetIids(ULONG*, IID**) { - return E_NOTIMPL; - } - - HRESULT STDMETHODCALLTYPE GetRuntimeClassName(HSTRING*) { - return E_NOTIMPL; - } - - HRESULT STDMETHODCALLTYPE GetTrustLevel(TrustLevel*) { - return E_NOTIMPL; - } - -protected: - DateTime _dateTime; -}; - -namespace Util { - - typedef LONG NTSTATUS, *PNTSTATUS; - typedef NTSTATUS(WINAPI* RtlGetVersionPtr)(PRTL_OSVERSIONINFOW); - inline RTL_OSVERSIONINFOW getRealOSVersion() { - HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll"); - if (hMod) { - RtlGetVersionPtr fxPtr = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion"); - if (fxPtr != nullptr) { - RTL_OSVERSIONINFOW rovi = { 0 }; - rovi.dwOSVersionInfoSize = sizeof(rovi); - if (STATUS_SUCCESS == fxPtr(&rovi)) { - return rovi; - } - } - } - RTL_OSVERSIONINFOW rovi = { 0 }; - return rovi; - } - - inline HRESULT defaultExecutablePath(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { - DWORD written = GetModuleFileNameExW(GetCurrentProcess(), nullptr, path, nSize); - DEBUG_MSG("Default executable path: " << path); - return (written > 0) ? S_OK : E_FAIL; - } - - - inline HRESULT defaultShellLinksDirectory(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { - DWORD written = GetEnvironmentVariableW(L"APPDATA", path, nSize); - HRESULT hr = written > 0 ? S_OK : E_INVALIDARG; - if (SUCCEEDED(hr)) { - errno_t result = wcscat_s(path, nSize, DEFAULT_SHELL_LINKS_PATH); - hr = (result == 0) ? S_OK : E_INVALIDARG; - DEBUG_MSG("Default shell link path: " << path); - } - return hr; - } - - inline HRESULT defaultShellLinkPath(const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) { - HRESULT hr = defaultShellLinksDirectory(path, nSize); - if (SUCCEEDED(hr)) { - const std::wstring appLink(appname + DEFAULT_LINK_FORMAT); - errno_t result = wcscat_s(path, nSize, appLink.c_str()); - hr = (result == 0) ? S_OK : E_INVALIDARG; - DEBUG_MSG("Default shell link file path: " << path); - } - return hr; - } - - - inline PCWSTR AsString(ComPtr &xmlDocument) { - HSTRING xml; - ComPtr ser; - HRESULT hr = xmlDocument.As(&ser); - hr = ser->GetXml(&xml); - if (SUCCEEDED(hr)) - return DllImporter::WindowsGetStringRawBuffer(xml, nullptr); - return nullptr; - } - - inline PCWSTR AsString(HSTRING hstring) { - return DllImporter::WindowsGetStringRawBuffer(hstring, nullptr); - } - - inline HRESULT setNodeStringValue(const std::wstring& string, IXmlNode *node, IXmlDocument *xml) { - ComPtr textNode; - HRESULT hr = xml->CreateTextNode( WinToastStringWrapper(string).Get(), &textNode); - if (SUCCEEDED(hr)) { - ComPtr stringNode; - hr = textNode.As(&stringNode); - if (SUCCEEDED(hr)) { - ComPtr appendedChild; - hr = node->AppendChild(stringNode.Get(), &appendedChild); - } - } - return hr; - } - - inline HRESULT setEventHandlers(_In_ IToastNotification* notification, _In_ std::shared_ptr eventHandler, _In_ INT64 expirationTime) { - EventRegistrationToken activatedToken, dismissedToken, failedToken; - HRESULT hr = notification->add_Activated( - Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( - [eventHandler](IToastNotification*, IInspectable* inspectable) - { - IToastActivatedEventArgs *activatedEventArgs; - HRESULT hr = inspectable->QueryInterface(&activatedEventArgs); - if (SUCCEEDED(hr)) { - HSTRING argumentsHandle; - hr = activatedEventArgs->get_Arguments(&argumentsHandle); - if (SUCCEEDED(hr)) { - PCWSTR arguments = Util::AsString(argumentsHandle); - if (arguments && *arguments) { - eventHandler->toastActivated(static_cast(wcstol(arguments, nullptr, 10))); - return S_OK; - } - } - } - eventHandler->toastActivated(); - return S_OK; - }).Get(), &activatedToken); - - if (SUCCEEDED(hr)) { - hr = notification->add_Dismissed(Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( - [eventHandler, expirationTime](IToastNotification*, IToastDismissedEventArgs* e) - { - ToastDismissalReason reason; - if (SUCCEEDED(e->get_Reason(&reason))) - { - if (reason == ToastDismissalReason_UserCanceled && expirationTime && InternalDateTime::Now() >= expirationTime) - reason = ToastDismissalReason_TimedOut; - eventHandler->toastDismissed(static_cast(reason)); - } - return S_OK; - }).Get(), &dismissedToken); - if (SUCCEEDED(hr)) { - hr = notification->add_Failed(Callback < Implements < RuntimeClassFlags, - ITypedEventHandler> >( - [eventHandler](IToastNotification*, IToastFailedEventArgs*) - { - eventHandler->toastFailed(); - return S_OK; - }).Get(), &failedToken); - } - } - return hr; - } - - inline HRESULT addAttribute(_In_ IXmlDocument *xml, const std::wstring &name, IXmlNamedNodeMap *attributeMap) { - ComPtr srcAttribute; - HRESULT hr = xml->CreateAttribute(WinToastStringWrapper(name).Get(), &srcAttribute); - if (SUCCEEDED(hr)) { - ComPtr node; - hr = srcAttribute.As(&node); - if (SUCCEEDED(hr)) { - ComPtr pNode; - hr = attributeMap->SetNamedItem(node.Get(), &pNode); - } - } - return hr; - } - - inline HRESULT createElement(_In_ IXmlDocument *xml, _In_ const std::wstring& root_node, _In_ const std::wstring& element_name, _In_ const std::vector& attribute_names) { - ComPtr rootList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(root_node).Get(), &rootList); - if (SUCCEEDED(hr)) { - ComPtr root; - hr = rootList->Item(0, &root); - if (SUCCEEDED(hr)) { - ComPtr audioElement; - hr = xml->CreateElement(WinToastStringWrapper(element_name).Get(), &audioElement); - if (SUCCEEDED(hr)) { - ComPtr audioNodeTmp; - hr = audioElement.As(&audioNodeTmp); - if (SUCCEEDED(hr)) { - ComPtr audioNode; - hr = root->AppendChild(audioNodeTmp.Get(), &audioNode); - if (SUCCEEDED(hr)) { - ComPtr attributes; - hr = audioNode->get_Attributes(&attributes); - if (SUCCEEDED(hr)) { - for (const auto& it : attribute_names) { - hr = addAttribute(xml, it, attributes.Get()); - } - } - } - } - } - } - } - return hr; - } -} - -WinToast* WinToast::instance() { - static WinToast instance; - return &instance; -} - -WinToast::WinToast() : - _isInitialized(false), - _hasCoInitialized(false) -{ - if (!isCompatible()) { - DEBUG_MSG(L"Warning: Your system is not compatible with this library "); - } -} - -WinToast::~WinToast() { - if (_hasCoInitialized) { - CoUninitialize(); - } -} - -void WinToast::setAppName(_In_ const std::wstring& appName) { - _appName = appName; -} - - -void WinToast::setAppUserModelId(_In_ const std::wstring& aumi) { - _aumi = aumi; - DEBUG_MSG(L"Default App User Model Id: " << _aumi.c_str()); -} - -bool WinToast::isCompatible() { - DllImporter::initialize(); - return !((DllImporter::SetCurrentProcessExplicitAppUserModelID == nullptr) - || (DllImporter::PropVariantToString == nullptr) - || (DllImporter::RoGetActivationFactory == nullptr) - || (DllImporter::WindowsCreateStringReference == nullptr) - || (DllImporter::WindowsDeleteString == nullptr)); -} - -bool WinToastLib::WinToast::isSupportingModernFeatures() { - constexpr auto MinimumSupportedVersion = 6; - return Util::getRealOSVersion().dwMajorVersion > MinimumSupportedVersion; - -} -std::wstring WinToast::configureAUMI(_In_ const std::wstring &companyName, - _In_ const std::wstring &productName, - _In_ const std::wstring &subProduct, - _In_ const std::wstring &versionInformation) -{ - std::wstring aumi = companyName; - aumi += L"." + productName; - if (subProduct.length() > 0) { - aumi += L"." + subProduct; - if (versionInformation.length() > 0) { - aumi += L"." + versionInformation; - } - } - - if (aumi.length() > SCHAR_MAX) { - DEBUG_MSG("Error: max size allowed for AUMI: 128 characters."); - } - return aumi; -} - -const std::wstring& WinToast::strerror(WinToastError error) { - static const std::unordered_map Labels = { - {WinToastError::NoError, L"No error. The process was executed correctly"}, - {WinToastError::NotInitialized, L"The library has not been initialized"}, - {WinToastError::SystemNotSupported, L"The OS does not support WinToast"}, - {WinToastError::ShellLinkNotCreated, L"The library was not able to create a Shell Link for the app"}, - {WinToastError::InvalidAppUserModelID, L"The AUMI is not a valid one"}, - {WinToastError::InvalidParameters, L"The parameters used to configure the library are not valid normally because an invalid AUMI or App Name"}, - {WinToastError::NotDisplayed, L"The toast was created correctly but WinToast was not able to display the toast"}, - {WinToastError::UnknownError, L"Unknown error"} - }; - - const auto iter = Labels.find(error); - assert(iter != Labels.end()); - return iter->second; -} - -enum WinToast::ShortcutResult WinToast::createShortcut() { - if (_aumi.empty() || _appName.empty()) { - DEBUG_MSG(L"Error: App User Model Id or Appname is empty!"); - return SHORTCUT_MISSING_PARAMETERS; - } - - if (!isCompatible()) { - DEBUG_MSG(L"Your OS is not compatible with this library! =("); - return SHORTCUT_INCOMPATIBLE_OS; - } - - if (!_hasCoInitialized) { - HRESULT initHr = CoInitializeEx(nullptr, COINIT::COINIT_MULTITHREADED); - if (initHr != RPC_E_CHANGED_MODE) { - if (FAILED(initHr) && initHr != S_FALSE) { - DEBUG_MSG(L"Error on COM library initialization!"); - return SHORTCUT_COM_INIT_FAILURE; - } - else { - _hasCoInitialized = true; - } - } - } - - bool wasChanged; - HRESULT hr = validateShellLinkHelper(wasChanged); - if (SUCCEEDED(hr)) - return wasChanged ? SHORTCUT_WAS_CHANGED : SHORTCUT_UNCHANGED; - - hr = createShellLinkHelper(); - return SUCCEEDED(hr) ? SHORTCUT_WAS_CREATED : SHORTCUT_CREATE_FAILED; -} - -bool WinToast::initialize(_Out_ WinToastError* error) { - _isInitialized = false; - setError(error, WinToastError::NoError); - - if (!isCompatible()) { - setError(error, WinToastError::SystemNotSupported); - DEBUG_MSG(L"Error: system not supported."); - return false; - } - - - if (_aumi.empty() || _appName.empty()) { - setError(error, WinToastError::InvalidParameters); - DEBUG_MSG(L"Error while initializing, did you set up a valid AUMI and App name?"); - return false; - } - - if (createShortcut() < 0) { - setError(error, WinToastError::ShellLinkNotCreated); - DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =("); - return false; - } - - if (FAILED(DllImporter::SetCurrentProcessExplicitAppUserModelID(_aumi.c_str()))) { - setError(error, WinToastError::InvalidAppUserModelID); - DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =("); - return false; - } - - _isInitialized = true; - return _isInitialized; -} - -bool WinToast::isInitialized() const { - return _isInitialized; -} - -const std::wstring& WinToast::appName() const { - return _appName; -} - -const std::wstring& WinToast::appUserModelId() const { - return _aumi; -} - - -HRESULT WinToast::validateShellLinkHelper(_Out_ bool& wasChanged) { - WCHAR path[MAX_PATH] = { L'\0' }; - Util::defaultShellLinkPath(_appName, path); - // Check if the file exist - DWORD attr = GetFileAttributesW(path); - if (attr >= 0xFFFFFFF) { - DEBUG_MSG("Error, shell link not found. Try to create a new one in: " << path); - return E_FAIL; - } - - // Let's load the file as shell link to validate. - // - Create a shell link - // - Create a persistant file - // - Load the path as data for the persistant file - // - Read the property AUMI and validate with the current - // - Review if AUMI is equal. - ComPtr shellLink; - HRESULT hr = CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&shellLink)); - if (SUCCEEDED(hr)) { - ComPtr persistFile; - hr = shellLink.As(&persistFile); - if (SUCCEEDED(hr)) { - hr = persistFile->Load(path, STGM_READWRITE); - if (SUCCEEDED(hr)) { - ComPtr propertyStore; - hr = shellLink.As(&propertyStore); - if (SUCCEEDED(hr)) { - PROPVARIANT appIdPropVar; - hr = propertyStore->GetValue(PKEY_AppUserModel_ID, &appIdPropVar); - if (SUCCEEDED(hr)) { - WCHAR AUMI[MAX_PATH]; - hr = DllImporter::PropVariantToString(appIdPropVar, AUMI, MAX_PATH); - wasChanged = false; - if (FAILED(hr) || _aumi != AUMI) { - // AUMI Changed for the same app, let's update the current value! =) - wasChanged = true; - PropVariantClear(&appIdPropVar); - hr = InitPropVariantFromString(_aumi.c_str(), &appIdPropVar); - if (SUCCEEDED(hr)) { - hr = propertyStore->SetValue(PKEY_AppUserModel_ID, appIdPropVar); - if (SUCCEEDED(hr)) { - hr = propertyStore->Commit(); - if (SUCCEEDED(hr) && SUCCEEDED(persistFile->IsDirty())) { - hr = persistFile->Save(path, TRUE); - } - } - } - } - PropVariantClear(&appIdPropVar); - } - } - } - } - } - return hr; -} - - - -HRESULT WinToast::createShellLinkHelper() { - WCHAR exePath[MAX_PATH]{L'\0'}; - WCHAR slPath[MAX_PATH]{L'\0'}; - Util::defaultShellLinkPath(_appName, slPath); - Util::defaultExecutablePath(exePath); - ComPtr shellLink; - HRESULT hr = CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&shellLink)); - if (SUCCEEDED(hr)) { - hr = shellLink->SetPath(exePath); - if (SUCCEEDED(hr)) { - hr = shellLink->SetArguments(L""); - if (SUCCEEDED(hr)) { - hr = shellLink->SetWorkingDirectory(exePath); - if (SUCCEEDED(hr)) { - ComPtr propertyStore; - hr = shellLink.As(&propertyStore); - if (SUCCEEDED(hr)) { - PROPVARIANT appIdPropVar; - hr = InitPropVariantFromString(_aumi.c_str(), &appIdPropVar); - if (SUCCEEDED(hr)) { - hr = propertyStore->SetValue(PKEY_AppUserModel_ID, appIdPropVar); - if (SUCCEEDED(hr)) { - hr = propertyStore->Commit(); - if (SUCCEEDED(hr)) { - ComPtr persistFile; - hr = shellLink.As(&persistFile); - if (SUCCEEDED(hr)) { - hr = persistFile->Save(slPath, TRUE); - } - } - } - PropVariantClear(&appIdPropVar); - } - } - } - } - } - } - return hr; -} - -INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler, _Out_ WinToastError* error) { - setError(error, WinToastError::NoError); - INT64 id = -1; - if (!isInitialized()) { - setError(error, WinToastError::NotInitialized); - DEBUG_MSG("Error when launching the toast. WinToast is not initialized."); - return id; - } - if (!handler) { - setError(error, WinToastError::InvalidHandler); - DEBUG_MSG("Error when launching the toast. Handler cannot be nullptr."); - return id; - } - - ComPtr notificationManager; - HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); - if (SUCCEEDED(hr)) { - ComPtr notifier; - hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier); - if (SUCCEEDED(hr)) { - ComPtr notificationFactory; - hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotification).Get(), ¬ificationFactory); - if (SUCCEEDED(hr)) { - ComPtr xmlDocument; - HRESULT hr = notificationManager->GetTemplateContent(ToastTemplateType(toast.type()), &xmlDocument); - if (SUCCEEDED(hr)) { - for (std::size_t i = 0, fieldsCount = toast.textFieldsCount(); i < fieldsCount && SUCCEEDED(hr); i++) { - hr = setTextFieldHelper(xmlDocument.Get(), toast.textField(WinToastTemplate::TextField(i)), i); - } - - // Modern feature are supported Windows > Windows 10 - if (SUCCEEDED(hr) && isSupportingModernFeatures()) { - - // Note that we do this *after* using toast.textFieldsCount() to - // iterate/fill the template's text fields, since we're adding yet another text field. - if (SUCCEEDED(hr) - && !toast.attributionText().empty()) { - hr = setAttributionTextFieldHelper(xmlDocument.Get(), toast.attributionText()); - } - - std::array buf; - for (std::size_t i = 0, actionsCount = toast.actionsCount(); i < actionsCount && SUCCEEDED(hr); i++) { - _snwprintf_s(buf.data(), buf.size(), _TRUNCATE, L"%zd", i); - hr = addActionHelper(xmlDocument.Get(), toast.actionLabel(i), buf.data()); - } - - if (SUCCEEDED(hr)) { - hr = (toast.audioPath().empty() && toast.audioOption() == WinToastTemplate::AudioOption::Default) - ? hr : setAudioFieldHelper(xmlDocument.Get(), toast.audioPath(), toast.audioOption()); - } - - if (SUCCEEDED(hr) && toast.duration() != WinToastTemplate::Duration::System) { - hr = addDurationHelper(xmlDocument.Get(), - (toast.duration() == WinToastTemplate::Duration::Short) ? L"short" : L"long"); - } - - } else { - DEBUG_MSG("Modern features (Actions/Sounds/Attributes) not supported in this os version"); - } - - if (SUCCEEDED(hr)) { - hr = toast.hasImage() ? setImageFieldHelper(xmlDocument.Get(), toast.imagePath()) : hr; - if (SUCCEEDED(hr)) { - ComPtr notification; - hr = notificationFactory->CreateToastNotification(xmlDocument.Get(), ¬ification); - if (SUCCEEDED(hr)) { - INT64 expiration = 0, relativeExpiration = toast.expiration(); - if (relativeExpiration > 0) { - InternalDateTime expirationDateTime(relativeExpiration); - expiration = expirationDateTime; - hr = notification->put_ExpirationTime(&expirationDateTime); - } - - if (SUCCEEDED(hr)) { - hr = Util::setEventHandlers(notification.Get(), std::shared_ptr(handler), expiration); - if (FAILED(hr)) { - setError(error, WinToastError::InvalidHandler); - } - } - - if (SUCCEEDED(hr)) { - GUID guid; - hr = CoCreateGuid(&guid); - if (SUCCEEDED(hr)) { - id = guid.Data1; - _buffer[id] = notification; - DEBUG_MSG("xml: " << Util::AsString(xmlDocument)); - hr = notifier->Show(notification.Get()); - if (FAILED(hr)) { - setError(error, WinToastError::NotDisplayed); - } - } - } - } - } - } - } - } - } - } - return FAILED(hr) ? -1 : id; -} - -ComPtr WinToast::notifier(_In_ bool* succeded) const { - ComPtr notificationManager; - ComPtr notifier; - HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager); - if (SUCCEEDED(hr)) { - hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier); - } - *succeded = SUCCEEDED(hr); - return notifier; -} - -bool WinToast::hideToast(_In_ INT64 id) { - if (!isInitialized()) { - DEBUG_MSG("Error when hiding the toast. WinToast is not initialized."); - return false; - } - - if (_buffer.find(id) != _buffer.end()) { - auto succeded = false; - auto notify = notifier(&succeded); - if (succeded) { - auto result = notify->Hide(_buffer[id].Get()); - _buffer.erase(id); - return SUCCEEDED(result); - } - } - return false; -} - -void WinToast::clear() { - auto succeded = false; - auto notify = notifier(&succeded); - if (succeded) { - auto end = _buffer.end(); - for (auto it = _buffer.begin(); it != end; ++it) { - notify->Hide(it->second.Get()); - } - _buffer.clear(); - } -} - -// -// Available as of Windows 10 Anniversary Update -// Ref: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts -// -// NOTE: This will add a new text field, so be aware when iterating over -// the toast's text fields or getting a count of them. -// -HRESULT WinToast::setAttributionTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text) { - Util::createElement(xml, L"binding", L"text", { L"placement" }); - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList); - if (SUCCEEDED(hr)) { - UINT32 nodeListLength; - hr = nodeList->get_Length(&nodeListLength); - if (SUCCEEDED(hr)) { - for (UINT32 i = 0; i < nodeListLength; i++) { - ComPtr textNode; - hr = nodeList->Item(i, &textNode); - if (SUCCEEDED(hr)) { - ComPtr attributes; - hr = textNode->get_Attributes(&attributes); - if (SUCCEEDED(hr)) { - ComPtr editedNode; - if (SUCCEEDED(hr)) { - hr = attributes->GetNamedItem(WinToastStringWrapper(L"placement").Get(), &editedNode); - if (FAILED(hr) || !editedNode) { - continue; - } - hr = Util::setNodeStringValue(L"attribution", editedNode.Get(), xml); - if (SUCCEEDED(hr)) { - return setTextFieldHelper(xml, text, i); - } - } - } - } - } - } - } - return hr; -} - -HRESULT WinToast::addDurationHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& duration) { - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList); - if (SUCCEEDED(hr)) { - UINT32 length; - hr = nodeList->get_Length(&length); - if (SUCCEEDED(hr)) { - ComPtr toastNode; - hr = nodeList->Item(0, &toastNode); - if (SUCCEEDED(hr)) { - ComPtr toastElement; - hr = toastNode.As(&toastElement); - if (SUCCEEDED(hr)) { - hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), - WinToastStringWrapper(duration).Get()); - } - } - } - } - return hr; -} - -HRESULT WinToast::setTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text, _In_ UINT32 pos) { - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList); - if (SUCCEEDED(hr)) { - ComPtr node; - hr = nodeList->Item(pos, &node); - if (SUCCEEDED(hr)) { - hr = Util::setNodeStringValue(text, node.Get(), xml); - } - } - return hr; -} - - -HRESULT WinToast::setImageFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path) { - assert(path.size() < MAX_PATH); - - wchar_t imagePath[MAX_PATH] = L"file:///"; - HRESULT hr = StringCchCatW(imagePath, MAX_PATH, path.c_str()); - if (SUCCEEDED(hr)) { - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"image").Get(), &nodeList); - if (SUCCEEDED(hr)) { - ComPtr node; - hr = nodeList->Item(0, &node); - if (SUCCEEDED(hr)) { - ComPtr attributes; - hr = node->get_Attributes(&attributes); - if (SUCCEEDED(hr)) { - ComPtr editedNode; - hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode); - if (SUCCEEDED(hr)) { - Util::setNodeStringValue(imagePath, editedNode.Get(), xml); - } - } - } - } - } - return hr; -} - -HRESULT WinToast::setAudioFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path, _In_opt_ WinToastTemplate::AudioOption option) { - std::vector attrs; - if (!path.empty()) attrs.push_back(L"src"); - if (option == WinToastTemplate::AudioOption::Loop) attrs.push_back(L"loop"); - if (option == WinToastTemplate::AudioOption::Silent) attrs.push_back(L"silent"); - Util::createElement(xml, L"toast", L"audio", attrs); - - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"audio").Get(), &nodeList); - if (SUCCEEDED(hr)) { - ComPtr node; - hr = nodeList->Item(0, &node); - if (SUCCEEDED(hr)) { - ComPtr attributes; - hr = node->get_Attributes(&attributes); - if (SUCCEEDED(hr)) { - ComPtr editedNode; - if (!path.empty()) { - if (SUCCEEDED(hr)) { - hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode); - if (SUCCEEDED(hr)) { - hr = Util::setNodeStringValue(path, editedNode.Get(), xml); - } - } - } - - if (SUCCEEDED(hr)) { - switch (option) { - case WinToastTemplate::AudioOption::Loop: - hr = attributes->GetNamedItem(WinToastStringWrapper(L"loop").Get(), &editedNode); - if (SUCCEEDED(hr)) { - hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml); - } - break; - case WinToastTemplate::AudioOption::Silent: - hr = attributes->GetNamedItem(WinToastStringWrapper(L"silent").Get(), &editedNode); - if (SUCCEEDED(hr)) { - hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml); - } - default: - break; - } - } - } - } - } - return hr; -} - -HRESULT WinToast::addActionHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& content, _In_ const std::wstring& arguments) { - ComPtr nodeList; - HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"actions").Get(), &nodeList); - if (SUCCEEDED(hr)) { - UINT32 length; - hr = nodeList->get_Length(&length); - if (SUCCEEDED(hr)) { - ComPtr actionsNode; - if (length > 0) { - hr = nodeList->Item(0, &actionsNode); - } else { - hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList); - if (SUCCEEDED(hr)) { - hr = nodeList->get_Length(&length); - if (SUCCEEDED(hr)) { - ComPtr toastNode; - hr = nodeList->Item(0, &toastNode); - if (SUCCEEDED(hr)) { - ComPtr toastElement; - hr = toastNode.As(&toastElement); - if (SUCCEEDED(hr)) - hr = toastElement->SetAttribute(WinToastStringWrapper(L"template").Get(), WinToastStringWrapper(L"ToastGeneric").Get()); - if (SUCCEEDED(hr)) - hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), WinToastStringWrapper(L"long").Get()); - if (SUCCEEDED(hr)) { - ComPtr actionsElement; - hr = xml->CreateElement(WinToastStringWrapper(L"actions").Get(), &actionsElement); - if (SUCCEEDED(hr)) { - hr = actionsElement.As(&actionsNode); - if (SUCCEEDED(hr)) { - ComPtr appendedChild; - hr = toastNode->AppendChild(actionsNode.Get(), &appendedChild); - } - } - } - } - } - } - } - if (SUCCEEDED(hr)) { - ComPtr actionElement; - hr = xml->CreateElement(WinToastStringWrapper(L"action").Get(), &actionElement); - if (SUCCEEDED(hr)) - hr = actionElement->SetAttribute(WinToastStringWrapper(L"content").Get(), WinToastStringWrapper(content).Get()); - if (SUCCEEDED(hr)) - hr = actionElement->SetAttribute(WinToastStringWrapper(L"arguments").Get(), WinToastStringWrapper(arguments).Get()); - if (SUCCEEDED(hr)) { - ComPtr actionNode; - hr = actionElement.As(&actionNode); - if (SUCCEEDED(hr)) { - ComPtr appendedChild; - hr = actionsNode->AppendChild(actionNode.Get(), &appendedChild); - } - } - } - } - } - return hr; -} - -void WinToast::setError(_Out_ WinToastError* error, _In_ WinToastError value) { - if (error) { - *error = value; - } -} - -WinToastTemplate::WinToastTemplate(_In_ WinToastTemplateType type) : _type(type) { - static constexpr std::size_t TextFieldsCount[] = { 1, 2, 2, 3, 1, 2, 2, 3}; - _textFields = std::vector(TextFieldsCount[type], L""); -} - -WinToastTemplate::~WinToastTemplate() { - _textFields.clear(); -} - -void WinToastTemplate::setTextField(_In_ const std::wstring& txt, _In_ WinToastTemplate::TextField pos) { - const auto position = static_cast(pos); - assert(position < _textFields.size()); - _textFields[position] = txt; -} - -void WinToastTemplate::setImagePath(_In_ const std::wstring& imgPath) { - _imagePath = imgPath; -} - -void WinToastTemplate::setAudioPath(_In_ const std::wstring& audioPath) { - _audioPath = audioPath; -} - -void WinToastTemplate::setAudioPath(_In_ AudioSystemFile file) { - static const std::unordered_map Files = { - {AudioSystemFile::DefaultSound, L"ms-winsoundevent:Notification.Default"}, - {AudioSystemFile::IM, L"ms-winsoundevent:Notification.IM"}, - {AudioSystemFile::Mail, L"ms-winsoundevent:Notification.Mail"}, - {AudioSystemFile::Reminder, L"ms-winsoundevent:Notification.Reminder"}, - {AudioSystemFile::SMS, L"ms-winsoundevent:Notification.SMS"}, - {AudioSystemFile::Alarm, L"ms-winsoundevent:Notification.Looping.Alarm"}, - {AudioSystemFile::Alarm2, L"ms-winsoundevent:Notification.Looping.Alarm2"}, - {AudioSystemFile::Alarm3, L"ms-winsoundevent:Notification.Looping.Alarm3"}, - {AudioSystemFile::Alarm4, L"ms-winsoundevent:Notification.Looping.Alarm4"}, - {AudioSystemFile::Alarm5, L"ms-winsoundevent:Notification.Looping.Alarm5"}, - {AudioSystemFile::Alarm6, L"ms-winsoundevent:Notification.Looping.Alarm6"}, - {AudioSystemFile::Alarm7, L"ms-winsoundevent:Notification.Looping.Alarm7"}, - {AudioSystemFile::Alarm8, L"ms-winsoundevent:Notification.Looping.Alarm8"}, - {AudioSystemFile::Alarm9, L"ms-winsoundevent:Notification.Looping.Alarm9"}, - {AudioSystemFile::Alarm10, L"ms-winsoundevent:Notification.Looping.Alarm10"}, - {AudioSystemFile::Call, L"ms-winsoundevent:Notification.Looping.Call"}, - {AudioSystemFile::Call1, L"ms-winsoundevent:Notification.Looping.Call1"}, - {AudioSystemFile::Call2, L"ms-winsoundevent:Notification.Looping.Call2"}, - {AudioSystemFile::Call3, L"ms-winsoundevent:Notification.Looping.Call3"}, - {AudioSystemFile::Call4, L"ms-winsoundevent:Notification.Looping.Call4"}, - {AudioSystemFile::Call5, L"ms-winsoundevent:Notification.Looping.Call5"}, - {AudioSystemFile::Call6, L"ms-winsoundevent:Notification.Looping.Call6"}, - {AudioSystemFile::Call7, L"ms-winsoundevent:Notification.Looping.Call7"}, - {AudioSystemFile::Call8, L"ms-winsoundevent:Notification.Looping.Call8"}, - {AudioSystemFile::Call9, L"ms-winsoundevent:Notification.Looping.Call9"}, - {AudioSystemFile::Call10, L"ms-winsoundevent:Notification.Looping.Call10"}, - }; - const auto iter = Files.find(file); - assert(iter != Files.end()); - _audioPath = iter->second; -} - -void WinToastTemplate::setAudioOption(_In_ WinToastTemplate::AudioOption audioOption) { - _audioOption = audioOption; -} - -void WinToastTemplate::setFirstLine(const std::wstring &text) { - setTextField(text, WinToastTemplate::FirstLine); -} - -void WinToastTemplate::setSecondLine(const std::wstring &text) { - setTextField(text, WinToastTemplate::SecondLine); -} - -void WinToastTemplate::setThirdLine(const std::wstring &text) { - setTextField(text, WinToastTemplate::ThirdLine); -} - -void WinToastTemplate::setDuration(_In_ Duration duration) { - _duration = duration; -} - -void WinToastTemplate::setExpiration(_In_ INT64 millisecondsFromNow) { - _expiration = millisecondsFromNow; -} - -void WinToastTemplate::setAttributionText(_In_ const std::wstring& attributionText) { - _attributionText = attributionText; -} - -void WinToastTemplate::addAction(_In_ const std::wstring & label) { - _actions.push_back(label); -} - -std::size_t WinToastTemplate::textFieldsCount() const { - return _textFields.size(); -} - -std::size_t WinToastTemplate::actionsCount() const { - return _actions.size(); -} - -bool WinToastTemplate::hasImage() const { - return _type < WinToastTemplateType::Text01; -} - -const std::vector& WinToastTemplate::textFields() const { - return _textFields; -} - -const std::wstring& WinToastTemplate::textField(_In_ TextField pos) const { - const auto position = static_cast(pos); - assert(position < _textFields.size()); - return _textFields[position]; -} - -const std::wstring& WinToastTemplate::actionLabel(_In_ std::size_t position) const { - assert(position < _actions.size()); - return _actions[position]; -} - -const std::wstring& WinToastTemplate::imagePath() const { - return _imagePath; -} - -const std::wstring& WinToastTemplate::audioPath() const { - return _audioPath; -} - -const std::wstring& WinToastTemplate::attributionText() const { - return _attributionText; -} - -INT64 WinToastTemplate::expiration() const { - return _expiration; -} - -WinToastTemplate::WinToastTemplateType WinToastTemplate::type() const { - return _type; -} - -WinToastTemplate::AudioOption WinToastTemplate::audioOption() const { - return _audioOption; -} - -WinToastTemplate::Duration WinToastTemplate::duration() const { - return _duration; -} diff --git a/espanso-ui/src/win32/WinToast/wintoastlib.h b/espanso-ui/src/win32/WinToast/wintoastlib.h deleted file mode 100644 index 68b1cb1..0000000 --- a/espanso-ui/src/win32/WinToast/wintoastlib.h +++ /dev/null @@ -1,217 +0,0 @@ -/* * Copyright (C) 2016-2019 Mohammed Boujemaoui - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - */ - -#ifndef WINTOASTLIB_H -#define WINTOASTLIB_H -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -using namespace Microsoft::WRL; -using namespace ABI::Windows::Data::Xml::Dom; -using namespace ABI::Windows::Foundation; -using namespace ABI::Windows::UI::Notifications; -using namespace Windows::Foundation; - - -namespace WinToastLib { - - class IWinToastHandler { - public: - enum WinToastDismissalReason { - UserCanceled = ToastDismissalReason::ToastDismissalReason_UserCanceled, - ApplicationHidden = ToastDismissalReason::ToastDismissalReason_ApplicationHidden, - TimedOut = ToastDismissalReason::ToastDismissalReason_TimedOut - }; - virtual ~IWinToastHandler() = default; - virtual void toastActivated() const = 0; - virtual void toastActivated(int actionIndex) const = 0; - virtual void toastDismissed(WinToastDismissalReason state) const = 0; - virtual void toastFailed() const = 0; - }; - - class WinToastTemplate { - public: - enum Duration { System, Short, Long }; - enum AudioOption { Default = 0, Silent, Loop }; - enum TextField { FirstLine = 0, SecondLine, ThirdLine }; - enum WinToastTemplateType { - ImageAndText01 = ToastTemplateType::ToastTemplateType_ToastImageAndText01, - ImageAndText02 = ToastTemplateType::ToastTemplateType_ToastImageAndText02, - ImageAndText03 = ToastTemplateType::ToastTemplateType_ToastImageAndText03, - ImageAndText04 = ToastTemplateType::ToastTemplateType_ToastImageAndText04, - Text01 = ToastTemplateType::ToastTemplateType_ToastText01, - Text02 = ToastTemplateType::ToastTemplateType_ToastText02, - Text03 = ToastTemplateType::ToastTemplateType_ToastText03, - Text04 = ToastTemplateType::ToastTemplateType_ToastText04, - }; - - enum AudioSystemFile { - DefaultSound, - IM, - Mail, - Reminder, - SMS, - Alarm, - Alarm2, - Alarm3, - Alarm4, - Alarm5, - Alarm6, - Alarm7, - Alarm8, - Alarm9, - Alarm10, - Call, - Call1, - Call2, - Call3, - Call4, - Call5, - Call6, - Call7, - Call8, - Call9, - Call10, - }; - - - WinToastTemplate(_In_ WinToastTemplateType type = WinToastTemplateType::ImageAndText02); - ~WinToastTemplate(); - - void setFirstLine(_In_ const std::wstring& text); - void setSecondLine(_In_ const std::wstring& text); - void setThirdLine(_In_ const std::wstring& text); - void setTextField(_In_ const std::wstring& txt, _In_ TextField pos); - void setAttributionText(_In_ const std::wstring & attributionText); - void setImagePath(_In_ const std::wstring& imgPath); - void setAudioPath(_In_ WinToastTemplate::AudioSystemFile audio); - void setAudioPath(_In_ const std::wstring& audioPath); - void setAudioOption(_In_ WinToastTemplate::AudioOption audioOption); - void setDuration(_In_ Duration duration); - void setExpiration(_In_ INT64 millisecondsFromNow); - void addAction(_In_ const std::wstring& label); - - std::size_t textFieldsCount() const; - std::size_t actionsCount() const; - bool hasImage() const; - const std::vector& textFields() const; - const std::wstring& textField(_In_ TextField pos) const; - const std::wstring& actionLabel(_In_ std::size_t pos) const; - const std::wstring& imagePath() const; - const std::wstring& audioPath() const; - const std::wstring& attributionText() const; - INT64 expiration() const; - WinToastTemplateType type() const; - WinToastTemplate::AudioOption audioOption() const; - Duration duration() const; - private: - std::vector _textFields{}; - std::vector _actions{}; - std::wstring _imagePath{}; - std::wstring _audioPath{}; - std::wstring _attributionText{}; - INT64 _expiration{0}; - AudioOption _audioOption{WinToastTemplate::AudioOption::Default}; - WinToastTemplateType _type{WinToastTemplateType::Text01}; - Duration _duration{Duration::System}; - }; - - class WinToast { - public: - enum WinToastError { - NoError = 0, - NotInitialized, - SystemNotSupported, - ShellLinkNotCreated, - InvalidAppUserModelID, - InvalidParameters, - InvalidHandler, - NotDisplayed, - UnknownError - }; - - enum ShortcutResult { - SHORTCUT_UNCHANGED = 0, - SHORTCUT_WAS_CHANGED = 1, - SHORTCUT_WAS_CREATED = 2, - - SHORTCUT_MISSING_PARAMETERS = -1, - SHORTCUT_INCOMPATIBLE_OS = -2, - SHORTCUT_COM_INIT_FAILURE = -3, - SHORTCUT_CREATE_FAILED = -4 - }; - - WinToast(void); - virtual ~WinToast(); - static WinToast* instance(); - static bool isCompatible(); - static bool isSupportingModernFeatures(); - static std::wstring configureAUMI(_In_ const std::wstring& companyName, - _In_ const std::wstring& productName, - _In_ const std::wstring& subProduct = std::wstring(), - _In_ const std::wstring& versionInformation = std::wstring()); - static const std::wstring& strerror(_In_ WinToastError error); - virtual bool initialize(_Out_ WinToastError* error = nullptr); - virtual bool isInitialized() const; - virtual bool hideToast(_In_ INT64 id); - virtual INT64 showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler, _Out_ WinToastError* error = nullptr); - virtual void clear(); - virtual enum ShortcutResult createShortcut(); - - const std::wstring& appName() const; - const std::wstring& appUserModelId() const; - void setAppUserModelId(_In_ const std::wstring& aumi); - void setAppName(_In_ const std::wstring& appName); - - protected: - bool _isInitialized{false}; - bool _hasCoInitialized{false}; - std::wstring _appName{}; - std::wstring _aumi{}; - std::map> _buffer{}; - - HRESULT validateShellLinkHelper(_Out_ bool& wasChanged); - HRESULT createShellLinkHelper(); - HRESULT setImageFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path); - HRESULT setAudioFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path, _In_opt_ WinToastTemplate::AudioOption option = WinToastTemplate::AudioOption::Default); - HRESULT setTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text, _In_ UINT32 pos); - HRESULT setAttributionTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text); - HRESULT addActionHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& action, _In_ const std::wstring& arguments); - HRESULT addDurationHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& duration); - ComPtr notifier(_In_ bool* succeded) const; - void setError(_Out_ WinToastError* error, _In_ WinToastError value); - }; -} -#endif // WINTOASTLIB_H diff --git a/espanso-ui/src/win32/mod.rs b/espanso-ui/src/win32/mod.rs index 981ef42..427919b 100644 --- a/espanso-ui/src/win32/mod.rs +++ b/espanso-ui/src/win32/mod.rs @@ -22,6 +22,7 @@ use std::{ collections::HashMap, ffi::{c_void, CString}, os::raw::c_char, + path::PathBuf, sync::{ atomic::{AtomicPtr, Ordering}, Arc, @@ -29,6 +30,8 @@ use std::{ thread::ThreadId, }; +mod notification; + use anyhow::Result; use lazycell::LazyCell; use log::{error, trace}; @@ -51,8 +54,6 @@ pub struct RawUIOptions { pub icon_paths: [[u16; MAX_FILE_PATH]; MAX_ICON_COUNT], pub icon_paths_count: i32, - - pub notification_icon_path: [u16; MAX_FILE_PATH], } // Take a look at the native.h header file for an explanation of the fields #[repr(C)] @@ -76,7 +77,6 @@ extern "C" { pub fn ui_destroy(window_handle: *const c_void) -> i32; pub fn ui_exit(window_handle: *const c_void) -> i32; pub fn ui_update_tray_icon(window_handle: *const c_void, index: i32); - pub fn ui_show_notification(window_handle: *const c_void, message: *const u16); pub fn ui_show_context_menu(window_handle: *const c_void, payload: *const c_char); } @@ -102,13 +102,12 @@ pub fn create(options: Win32UIOptions) -> Result<(Win32Remote, Win32EventLoop)> icons.push(path.clone()); } - let eventloop = Win32EventLoop::new( - handle.clone(), - icons, - options.show_icon, - options.notification_icon_path, + let eventloop = Win32EventLoop::new(handle.clone(), icons, options.show_icon); + let remote = Win32Remote::new( + handle, + icon_indexes, + PathBuf::from(options.notification_icon_path), ); - let remote = Win32Remote::new(handle, icon_indexes); Ok((remote, eventloop)) } @@ -118,7 +117,6 @@ pub struct Win32EventLoop { show_icon: bool, icons: Vec, - notification_icon_path: String, // Internal _event_callback: LazyCell, @@ -126,17 +124,11 @@ pub struct Win32EventLoop { } impl Win32EventLoop { - pub(crate) fn new( - handle: Arc>, - icons: Vec, - show_icon: bool, - notification_icon_path: String, - ) -> Self { + pub(crate) fn new(handle: Arc>, icons: Vec, show_icon: bool) -> Self { Self { handle, icons, show_icon, - notification_icon_path, _event_callback: LazyCell::new(), _init_thread_id: LazyCell::new(), } @@ -160,17 +152,10 @@ impl UIEventLoop for Win32EventLoop { icon_path[0..len].clone_from_slice(&wide_path.as_slice()[..len]); } - let wide_notification_icon_path = - widestring::WideCString::from_str(&self.notification_icon_path)?; - let mut wide_notification_icon_path_buffer: [u16; MAX_FILE_PATH] = [0; MAX_FILE_PATH]; - wide_notification_icon_path_buffer[..wide_notification_icon_path.as_slice().len()] - .clone_from_slice(wide_notification_icon_path.as_slice()); - let options = RawUIOptions { show_icon: if self.show_icon { 1 } else { 0 }, icon_paths, icon_paths_count: self.icons.len() as i32, - notification_icon_path: wide_notification_icon_path_buffer, }; let mut error_code = 0; @@ -190,12 +175,6 @@ impl UIEventLoop for Win32EventLoop { ) .into(), ), - -3 => Err( - Win32UIError::EventLoopInitError( - "Unable to initialize Win32EventLoop, initializing notifications".to_string(), - ) - .into(), - ), _ => Err( Win32UIError::EventLoopInitError( "Unable to initialize Win32EventLoop, unknown error".to_string(), @@ -284,7 +263,12 @@ impl Win32Remote { pub(crate) fn new( handle: Arc>, icon_indexes: HashMap, + notification_icon_path: PathBuf, ) -> Self { + if let Err(err) = notification::initialize_notification_thread(notification_icon_path) { + error!("unable to initialize notification thread: {}", err); + } + Self { handle, icon_indexes, @@ -308,21 +292,8 @@ impl UIRemote for Win32Remote { } fn show_notification(&self, message: &str) { - let handle = self.handle.load(Ordering::Acquire); - if handle.is_null() { - error!("Unable to show notification, pointer is null"); - return; - } - - let wide_message = widestring::WideCString::from_str(message); - match wide_message { - Ok(wide_message) => unsafe { ui_show_notification(handle, wide_message.as_ptr()) }, - Err(error) => { - error!( - "Unable to show notification, invalid message encoding {}", - error - ); - } + if let Err(err) = notification::show_notification(message) { + error!("Unable to show notification: {}", err); } } diff --git a/espanso-ui/src/win32/native.cpp b/espanso-ui/src/win32/native.cpp index 6610087..9c7502d 100644 --- a/espanso-ui/src/win32/native.cpp +++ b/espanso-ui/src/win32/native.cpp @@ -43,16 +43,12 @@ #include -#include "WinToast/wintoastlib.h" -using namespace WinToastLib; - #include "json/json.hpp" using json = nlohmann::json; #define APPWM_ICON_CLICK (WM_APP + 1) #define APPWM_SHOW_CONTEXT_MENU (WM_APP + 2) #define APPWM_UPDATE_TRAY_ICON (WM_APP + 3) -#define APPWM_SHOW_NOTIFICATION (WM_APP + 4) const wchar_t *const ui_winclass = L"EspansoUI"; @@ -61,7 +57,6 @@ typedef struct UIOptions options; NOTIFYICONDATA nid; HICON g_icons[MAX_ICON_COUNT]; - wchar_t notification_icon_path[MAX_FILE_PATH]; // Rust interop void *rust_instance; @@ -71,16 +66,6 @@ typedef struct // Needed to detect when Explorer crashes UINT WM_TASKBARCREATED = RegisterWindowMessage(L"TaskbarCreated"); -// Notification handler using: https://mohabouje.github.io/WinToast/ -class EspansoNotificationHandler : public IWinToastHandler -{ -public: - void toastActivated() const {} - void toastActivated(int actionIndex) const {} - void toastDismissed(WinToastDismissalReason state) const {} - void toastFailed() const {} -}; - /* * Message handler procedure for the window */ @@ -154,19 +139,6 @@ LRESULT CALLBACK ui_window_procedure(HWND window, unsigned int msg, WPARAM wp, L break; } - case APPWM_SHOW_NOTIFICATION: - { - std::unique_ptr message(reinterpret_cast(lp)); - - std::cout << "hello" << variables->notification_icon_path << std::endl; - - WinToastTemplate templ = WinToastTemplate(WinToastTemplate::ImageAndText02); - templ.setImagePath(variables->notification_icon_path); - templ.setTextField(L"Espanso", WinToastTemplate::FirstLine); - templ.setTextField(message.get(), WinToastTemplate::SecondLine); - WinToast::instance()->showToast(templ, new EspansoNotificationHandler()); - break; - } case APPWM_ICON_CLICK: // Click on the tray icon { switch (lp) @@ -240,7 +212,6 @@ void *ui_initialize(void *_self, UIOptions _options, int32_t *error_code) UIVariables *variables = new UIVariables(); variables->options = _options; variables->rust_instance = _self; - wcscpy(variables->notification_icon_path, _options.notification_icon_path); SetWindowLongPtrW(window, GWLP_USERDATA, reinterpret_cast<::LONG_PTR>(variables)); // Load the tray icons @@ -252,11 +223,11 @@ void *ui_initialize(void *_self, UIOptions _options, int32_t *error_code) // Hide the window ShowWindow(window, SW_HIDE); - // Setup the icon in the notification space + // Setup the icon in the tray space SendMessage(window, WM_SETICON, ICON_BIG, (LPARAM)variables->g_icons[0]); SendMessage(window, WM_SETICON, ICON_SMALL, (LPARAM)variables->g_icons[0]); - // Notification + // Tray icon variables->nid.cbSize = sizeof(variables->nid); variables->nid.hWnd = window; variables->nid.uID = 1; @@ -283,16 +254,6 @@ void *ui_initialize(void *_self, UIOptions _options, int32_t *error_code) return nullptr; } - // Initialize the notification handler - WinToast::instance()->setAppName(L"Espanso"); - const auto aumi = WinToast::configureAUMI(L"federico.terzi", L"Espanso", L"Core", L"1.0.0"); - WinToast::instance()->setAppUserModelId(aumi); - if (!WinToast::instance()->initialize()) - { - *error_code = -3; - return nullptr; - } - return window; } @@ -337,17 +298,6 @@ void ui_update_tray_icon(void *window, int32_t index) } } -int32_t ui_show_notification(void *window, wchar_t *message) -{ - if (window) - { - wchar_t *message_copy = _wcsdup(message); - PostMessage((HWND)window, APPWM_SHOW_NOTIFICATION, 0, (LPARAM)message_copy); - return 0; - } - return -1; -} - // Menu related methods void _insert_separator_menu(HMENU parent) diff --git a/espanso-ui/src/win32/native.h b/espanso-ui/src/win32/native.h index c03c5d1..fd0d783 100644 --- a/espanso-ui/src/win32/native.h +++ b/espanso-ui/src/win32/native.h @@ -35,7 +35,6 @@ typedef struct { wchar_t icon_paths[MAX_ICON_COUNT][MAX_FILE_PATH]; int32_t icon_paths_count; - wchar_t notification_icon_path[MAX_FILE_PATH]; } UIOptions; typedef struct { @@ -61,9 +60,6 @@ extern "C" void ui_exit(void * window); // the icon within the UIOptions.icon_paths array. extern "C" void ui_update_tray_icon(void * window, int32_t index); -// Show a native Windows 10 notification -extern "C" int32_t ui_show_notification(void * window, wchar_t * message); - // Display the context menu on the tray icon. // Payload is passed as JSON as given the complex structure, parsing // this manually would have been complex. diff --git a/espanso-ui/src/win32/notification.rs b/espanso-ui/src/win32/notification.rs new file mode 100644 index 0000000..cb86d87 --- /dev/null +++ b/espanso-ui/src/win32/notification.rs @@ -0,0 +1,102 @@ +/* + * This file is part of espanso. + * + * Copyright (C) 2019-2021 Federico Terzi + * + * espanso is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * espanso is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with espanso. If not, see . + */ + +use std::{path::{PathBuf}, sync::{Arc, Mutex, mpsc::{Sender, channel}}}; + +use anyhow::{Result, anyhow, bail}; +use lazy_static::lazy_static; +use log::{error, warn}; +use std::process::Command; +use winrt_notification::{IconCrop, Toast}; +use std::os::windows::process::CommandExt; + +const ESPANSO_APP_USER_MODEL_ID: &str = "{5E3B6C0F-1A4D-45C4-8872-D8174702101A}"; + +lazy_static! { + static ref SEND_CHANNEL: Arc>>> = Arc::new(Mutex::new(None)); +} + +pub fn initialize_notification_thread(notification_icon_path: PathBuf) -> Result<()> { + let (sender, receiver) = channel::(); + + { + let mut lock = SEND_CHANNEL.lock().map_err(|e| anyhow!("failed to define shared notification sender: {}", e))?; + *lock = Some(sender); + } + + std::thread::Builder::new().name("notification-thread".to_string()).spawn(move || { + // First determine which AppUserModelID we can use + lazy_static! { + static ref APP_USER_MODEL_ID: &'static str = if is_espanso_app_user_model_id_set() { + ESPANSO_APP_USER_MODEL_ID + } else { + warn!("unable to find espanso AppUserModelID in the list of registered ones, falling back to Powershell"); + Toast::POWERSHELL_APP_ID + }; + } + + while let Ok(message) = receiver.recv() { + if let Err(err) = Toast::new(&APP_USER_MODEL_ID) + .icon(¬ification_icon_path, IconCrop::Square, "Espanso") + .title("Espanso") + .text1(&message) + .sound(None) + .show() + .map_err(|e| anyhow!("failed to show notification: {}", e)) { + error!("unable to show notification: {}", err); + } + } + })?; + + Ok(()) +} + +pub fn show_notification(msg: &str) -> Result<()> { + let mut lock = SEND_CHANNEL.lock().map_err(|e| anyhow!("unable to acquire notification send channel: {}", e))?; + match &mut *lock { + Some(sender) => { + sender.send(msg.to_string())?; + Ok(()) + }, + None => bail!("notification sender not available"), + } +} + +fn is_espanso_app_user_model_id_set() -> bool { + match Command::new("powershell") + .args(&["-c", "get-startapps"]) + .creation_flags(0x08000000) + .output() + { + Ok(output) => { + let output_str = String::from_utf8_lossy(&output.stdout); + // Check if espanso is present + output_str + .lines() + .any(|line| line.contains(ESPANSO_APP_USER_MODEL_ID)) + } + Err(err) => { + error!( + "unable to determine if AppUserModelID was registered: {}", + err + ); + false + } + } +} \ No newline at end of file