diff --git a/src/snoretoasts.cpp b/src/snoretoasts.cpp index 0d4e009..ceca72d 100644 --- a/src/snoretoasts.cpp +++ b/src/snoretoasts.cpp @@ -1,610 +1,612 @@ /* SnoreToast is capable to invoke Windows 8 toast notifications. Copyright (C) 2013-2019 Hannah von Reth SnoreToast is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. SnoreToast 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with SnoreToast. If not, see . */ #include "snoretoasts.h" #include "toasteventhandler.h" #include "linkhelper.h" #include "utils.h" #include "config.h" #include #include #include using namespace Microsoft::WRL; using namespace ABI::Windows::UI; using namespace ABI::Windows::UI::Notifications; using namespace ABI::Windows::Data::Xml::Dom; using namespace Windows::Foundation; using namespace Wrappers; namespace { constexpr DWORD EVENT_TIMEOUT = 60 * 1000; // one minute should be more than enough } class SnoreToastsPrivate { public: SnoreToastsPrivate(SnoreToasts *parent, const std::wstring &appID) : m_parent(parent), m_appID(appID), m_id(std::to_wstring(GetCurrentProcessId())) { HRESULT hr = GetActivationFactory( HStringReference(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager) .Get(), &m_toastManager); if (!SUCCEEDED(hr)) { std::wcerr << L"SnoreToasts: Failed to register com Factory, please make sure you " L"correctly initialised with RO_INIT_MULTITHREADED" << std::endl; m_action = SnoreToastActions::Actions::Error; } } SnoreToasts *m_parent; std::wstring m_appID; std::filesystem::path m_pipeName; std::filesystem::path m_application; std::wstring m_title; std::wstring m_body; std::filesystem::path m_image; std::wstring m_sound = L"Notification.Default"; std::wstring m_id; std::wstring m_buttons; bool m_silent = false; bool m_textbox = false; SnoreToastActions::Actions m_action = SnoreToastActions::Actions::Clicked; ComPtr m_toastXml; ComPtr m_toastManager; ComPtr m_notifier; ComPtr m_notification; ComPtr m_eventHanlder; static HANDLE ctoastEvent() { static HANDLE _event = [] { std::wstringstream eventName; eventName << L"ToastActivationEvent" << GetCurrentProcessId(); return CreateEvent(nullptr, true, false, eventName.str().c_str()); }(); return _event; } ComPtr getHistory() { ComPtr toastStatics2; if (ST_CHECK_RESULT(m_toastManager.As(&toastStatics2))) { ComPtr nativeHistory; ST_CHECK_RESULT(toastStatics2->get_History(&nativeHistory)); return nativeHistory; } return {}; } }; SnoreToasts::SnoreToasts(const std::wstring &appID) : d(new SnoreToastsPrivate(this, appID)) { Utils::registerActivator(); } SnoreToasts::~SnoreToasts() { Utils::unregisterActivator(); delete d; } HRESULT SnoreToasts::displayToast(const std::wstring &title, const std::wstring &body, const std::filesystem::path &image) { // asume that we fail d->m_action = SnoreToastActions::Actions::Error; d->m_title = title; d->m_body = body; d->m_image = std::filesystem::absolute(image); if (!d->m_image.empty()) { ST_RETURN_ON_ERROR(d->m_toastManager->GetTemplateContent( ToastTemplateType_ToastImageAndText02, &d->m_toastXml)); } else { ST_RETURN_ON_ERROR(d->m_toastManager->GetTemplateContent(ToastTemplateType_ToastText02, &d->m_toastXml)); } ComPtr rootList; ST_RETURN_ON_ERROR( d->m_toastXml->GetElementsByTagName(HStringReference(L"toast").Get(), &rootList)); ComPtr root; ST_RETURN_ON_ERROR(rootList->Item(0, &root)); ComPtr rootAttributes; ST_RETURN_ON_ERROR(root->get_Attributes(&rootAttributes)); const auto data = formatAction(SnoreToastActions::Actions::Clicked); ST_RETURN_ON_ERROR(addAttribute(L"launch", rootAttributes.Get(), data)); // Adding buttons if (!d->m_buttons.empty()) { setButtons(root); } else if (d->m_textbox) { setTextBox(root); } ComPtr audioElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"audio").Get(), &audioElement)); ComPtr audioNodeTmp; ST_RETURN_ON_ERROR(audioElement.As(&audioNodeTmp)); ComPtr audioNode; ST_RETURN_ON_ERROR(root->AppendChild(audioNodeTmp.Get(), &audioNode)); ComPtr attributes; ST_RETURN_ON_ERROR(audioNode->get_Attributes(&attributes)); ST_RETURN_ON_ERROR(addAttribute(L"src", attributes.Get())); ST_RETURN_ON_ERROR(addAttribute(L"silent", attributes.Get())); // printXML(); if (!d->m_image.empty()) { ST_RETURN_ON_ERROR(setImage()); } ST_RETURN_ON_ERROR(setSound()); ST_RETURN_ON_ERROR(setTextValues()); printXML(); ST_RETURN_ON_ERROR(createToast()); d->m_action = SnoreToastActions::Actions::Clicked; return S_OK; } SnoreToastActions::Actions SnoreToasts::userAction() { if (d->m_eventHanlder.Get()) { HANDLE event = d->m_eventHanlder.Get()->event(); if (WaitForSingleObject(event, EVENT_TIMEOUT) == WAIT_TIMEOUT) { d->m_action = SnoreToastActions::Actions::Error; } else { d->m_action = d->m_eventHanlder.Get()->userAction(); } // the initial value is SnoreToastActions::Actions::Hidden so if no action happend when we // end up here, a hide was requested if (d->m_action == SnoreToastActions::Actions::Hidden) { d->m_notifier->Hide(d->m_notification.Get()); tLog << L"The application hid the toast using ToastNotifier.hide()"; } CloseHandle(event); } return d->m_action; } bool SnoreToasts::closeNotification() { std::wstringstream eventName; eventName << L"ToastEvent" << d->m_id; HANDLE event = OpenEventW(EVENT_ALL_ACCESS, FALSE, eventName.str().c_str()); if (event) { SetEvent(event); return true; } if (auto history = d->getHistory()) { if (ST_CHECK_RESULT(history->RemoveGroupedTagWithId( HStringReference(d->m_id.c_str()).Get(), HStringReference(L"SnoreToast").Get(), HStringReference(d->m_appID.c_str()).Get()))) { return true; } } tLog << "Notification " << d->m_id << " does not exist"; return false; } void SnoreToasts::setSound(const std::wstring &soundFile) { d->m_sound = soundFile; } void SnoreToasts::setSilent(bool silent) { d->m_silent = silent; } void SnoreToasts::setId(const std::wstring &id) { if (!id.empty()) { d->m_id = id; } } std::wstring SnoreToasts::id() const { return d->m_id; } void SnoreToasts::setButtons(const std::wstring &buttons) { d->m_buttons = buttons; } void SnoreToasts::setTextBoxEnabled(bool textBoxEnabled) { d->m_textbox = textBoxEnabled; } // Set the value of the "src" attribute of the "image" node HRESULT SnoreToasts::setImage() { ComPtr nodeList; ST_RETURN_ON_ERROR( d->m_toastXml->GetElementsByTagName(HStringReference(L"image").Get(), &nodeList)); ComPtr imageNode; ST_RETURN_ON_ERROR(nodeList->Item(0, &imageNode)); ComPtr attributes; ST_RETURN_ON_ERROR(imageNode->get_Attributes(&attributes)); ComPtr srcAttribute; ST_RETURN_ON_ERROR(attributes->GetNamedItem(HStringReference(L"src").Get(), &srcAttribute)); return setNodeValueString(HStringReference(d->m_image.wstring().c_str()).Get(), srcAttribute.Get()); } HRESULT SnoreToasts::setSound() { ComPtr nodeList; ST_RETURN_ON_ERROR( d->m_toastXml->GetElementsByTagName(HStringReference(L"audio").Get(), &nodeList)); ComPtr audioNode; ST_RETURN_ON_ERROR(nodeList->Item(0, &audioNode)); ComPtr attributes; ST_RETURN_ON_ERROR(audioNode->get_Attributes(&attributes)); ComPtr srcAttribute; ST_RETURN_ON_ERROR(attributes->GetNamedItem(HStringReference(L"src").Get(), &srcAttribute)); std::wstring sound; if (d->m_sound.find(L"ms-winsoundevent:") == std::wstring::npos) { sound = L"ms-winsoundevent:"; sound.append(d->m_sound); } else { sound = d->m_sound; } ST_RETURN_ON_ERROR( setNodeValueString(HStringReference(sound.c_str()).Get(), srcAttribute.Get())); ST_RETURN_ON_ERROR(attributes->GetNamedItem(HStringReference(L"silent").Get(), &srcAttribute)); return setNodeValueString(HStringReference(d->m_silent ? L"true" : L"false").Get(), srcAttribute.Get()); } // Set the values of each of the text nodes HRESULT SnoreToasts::setTextValues() { ComPtr nodeList; ST_RETURN_ON_ERROR( d->m_toastXml->GetElementsByTagName(HStringReference(L"text").Get(), &nodeList)); // create the title ComPtr textNode; ST_RETURN_ON_ERROR(nodeList->Item(0, &textNode)); ST_RETURN_ON_ERROR( setNodeValueString(HStringReference(d->m_title.c_str()).Get(), textNode.Get())); ST_RETURN_ON_ERROR(nodeList->Item(1, &textNode)); return setNodeValueString(HStringReference(d->m_body.c_str()).Get(), textNode.Get()); } HRESULT SnoreToasts::setButtons(ComPtr root) { ComPtr actionsElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"actions").Get(), &actionsElement)); ComPtr actionsNodeTmp; ST_RETURN_ON_ERROR(actionsElement.As(&actionsNodeTmp)); ComPtr actionsNode; ST_RETURN_ON_ERROR(root->AppendChild(actionsNodeTmp.Get(), &actionsNode)); std::wstring buttonText; std::wstringstream wss(d->m_buttons); while (std::getline(wss, buttonText, L';')) { ST_RETURN_ON_ERROR(createNewActionButton(actionsNode, buttonText)); } return S_OK; } HRESULT SnoreToasts::setTextBox(ComPtr root) { ComPtr actionsElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"actions").Get(), &actionsElement)); ComPtr actionsNodeTmp; ST_RETURN_ON_ERROR(actionsElement.As(&actionsNodeTmp)); ComPtr actionsNode; ST_RETURN_ON_ERROR(root->AppendChild(actionsNodeTmp.Get(), &actionsNode)); ComPtr inputElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"input").Get(), &inputElement)); ComPtr inputNodeTmp; ST_RETURN_ON_ERROR(inputElement.As(&inputNodeTmp)); ComPtr inputNode; ST_RETURN_ON_ERROR(actionsNode->AppendChild(inputNodeTmp.Get(), &inputNode)); ComPtr inputAttributes; ST_RETURN_ON_ERROR(inputNode->get_Attributes(&inputAttributes)); ST_RETURN_ON_ERROR(addAttribute(L"id", inputAttributes.Get(), L"textBox")); ST_RETURN_ON_ERROR(addAttribute(L"type", inputAttributes.Get(), L"text")); ST_RETURN_ON_ERROR(addAttribute(L"placeHolderContent", inputAttributes.Get(), L"Type a reply")); ComPtr actionElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"action").Get(), &actionElement)); ComPtr actionNodeTmp; ST_RETURN_ON_ERROR(actionElement.As(&actionNodeTmp)); ComPtr actionNode; ST_RETURN_ON_ERROR(actionsNode->AppendChild(actionNodeTmp.Get(), &actionNode)); ComPtr actionAttributes; ST_RETURN_ON_ERROR(actionNode->get_Attributes(&actionAttributes)); ST_RETURN_ON_ERROR(addAttribute(L"content", actionAttributes.Get(), L"Send")); const auto data = formatAction(SnoreToastActions::Actions::ButtonClicked); ST_RETURN_ON_ERROR(addAttribute(L"arguments", actionAttributes.Get(), data)); return addAttribute(L"hint-inputId", actionAttributes.Get(), L"textBox"); } HRESULT SnoreToasts::setEventHandler(ComPtr toast) { // Register the event handlers EventRegistrationToken activatedToken, dismissedToken, failedToken; ComPtr eventHandler(new ToastEventHandler(*this)); ST_RETURN_ON_ERROR(toast->add_Activated(eventHandler.Get(), &activatedToken)); ST_RETURN_ON_ERROR(toast->add_Dismissed(eventHandler.Get(), &dismissedToken)); ST_RETURN_ON_ERROR(toast->add_Failed(eventHandler.Get(), &failedToken)); d->m_eventHanlder = eventHandler; return S_OK; } HRESULT SnoreToasts::setNodeValueString(const HSTRING &inputString, IXmlNode *node) { ComPtr inputText; ST_RETURN_ON_ERROR(d->m_toastXml->CreateTextNode(inputString, &inputText)); ComPtr inputTextNode; ST_RETURN_ON_ERROR(inputText.As(&inputTextNode)); ComPtr pAppendedChild; return node->AppendChild(inputTextNode.Get(), &pAppendedChild); } HRESULT SnoreToasts::addAttribute(const std::wstring &name, IXmlNamedNodeMap *attributeMap) { ComPtr srcAttribute; HRESULT hr = d->m_toastXml->CreateAttribute(HStringReference(name.c_str()).Get(), &srcAttribute); if (SUCCEEDED(hr)) { ComPtr node; hr = srcAttribute.As(&node); if (SUCCEEDED(hr)) { ComPtr pNode; hr = attributeMap->SetNamedItem(node.Get(), &pNode); } } return hr; } HRESULT SnoreToasts::addAttribute(const std::wstring &name, IXmlNamedNodeMap *attributeMap, const std::wstring &value) { ComPtr srcAttribute; ST_RETURN_ON_ERROR( d->m_toastXml->CreateAttribute(HStringReference(name.c_str()).Get(), &srcAttribute)); ComPtr node; ST_RETURN_ON_ERROR(srcAttribute.As(&node)); ComPtr pNode; ST_RETURN_ON_ERROR(attributeMap->SetNamedItem(node.Get(), &pNode)); return setNodeValueString(HStringReference(value.c_str()).Get(), node.Get()); } HRESULT SnoreToasts::createNewActionButton(ComPtr actionsNode, const std::wstring &value) { ComPtr actionElement; ST_RETURN_ON_ERROR( d->m_toastXml->CreateElement(HStringReference(L"action").Get(), &actionElement)); ComPtr actionNodeTmp; ST_RETURN_ON_ERROR(actionElement.As(&actionNodeTmp)); ComPtr actionNode; ST_RETURN_ON_ERROR(actionsNode->AppendChild(actionNodeTmp.Get(), &actionNode)); ComPtr actionAttributes; ST_RETURN_ON_ERROR(actionNode->get_Attributes(&actionAttributes)); ST_RETURN_ON_ERROR(addAttribute(L"content", actionAttributes.Get(), value)); const auto data = formatAction(SnoreToastActions::Actions::ButtonClicked, { { L"button", value } }); ST_RETURN_ON_ERROR(addAttribute(L"arguments", actionAttributes.Get(), data)); return addAttribute(L"activationType", actionAttributes.Get(), L"foreground"); } void SnoreToasts::printXML() { ComPtr s; ComPtr ss(d->m_toastXml); ss.As(&s); HSTRING string; s->GetXml(&string); PCWSTR str = WindowsGetStringRawBuffer(string, nullptr); tLog << L"------------------------\n\t\t\t" << str << L"\n\t\t" << L"------------------------"; } std::filesystem::path SnoreToasts::pipeName() const { return d->m_pipeName; } void SnoreToasts::setPipeName(const std::filesystem::path &pipeName) { d->m_pipeName = pipeName; } std::filesystem::path SnoreToasts::application() const { return d->m_application; } void SnoreToasts::setApplication(const std::filesystem::path &application) { d->m_application = application; } std::wstring SnoreToasts::formatAction( const SnoreToastActions::Actions &action, const std::vector> &extraData) const { const auto pipe = d->m_pipeName.wstring(); const auto application = d->m_application.wstring(); std::vector> data = { { L"action", SnoreToastActions::getActionString(action) }, { L"notificationId", std::wstring_view(d->m_id) }, { L"pipe", std::wstring_view(pipe) }, { L"application", std::wstring_view(application) } }; data.insert(data.end(), extraData.cbegin(), extraData.cend()); return Utils::formatData(data); } // Create and display the toast HRESULT SnoreToasts::createToast() { ST_RETURN_ON_ERROR(d->m_toastManager->CreateToastNotifierWithId( HStringReference(d->m_appID.c_str()).Get(), &d->m_notifier)); ComPtr factory; ST_RETURN_ON_ERROR(GetActivationFactory( HStringReference(RuntimeClass_Windows_UI_Notifications_ToastNotification).Get(), &factory)); ST_RETURN_ON_ERROR(factory->CreateToastNotification(d->m_toastXml.Get(), &d->m_notification)); ComPtr toastV2; if (SUCCEEDED(d->m_notification.As(&toastV2))) { ST_RETURN_ON_ERROR(toastV2->put_Tag(HStringReference(d->m_id.c_str()).Get())); ST_RETURN_ON_ERROR(toastV2->put_Group(HStringReference(L"SnoreToast").Get())); } std::wstring error; NotificationSetting setting = NotificationSetting_Enabled; if (!ST_CHECK_RESULT(d->m_notifier->get_Setting(&setting))) { tLog << "Failed to retreive NotificationSettings ensure your appId is registered"; } switch (setting) { case NotificationSetting_Enabled: ST_RETURN_ON_ERROR(setEventHandler(d->m_notification)); - return d->m_notifier->Show(d->m_notification.Get()); + break; case NotificationSetting_DisabledForApplication: error = L"DisabledForApplication"; break; case NotificationSetting_DisabledForUser: error = L"DisabledForUser"; break; case NotificationSetting_DisabledByGroupPolicy: error = L"DisabledByGroupPolicy"; break; case NotificationSetting_DisabledByManifest: error = L"DisabledByManifest"; break; } - std::wstringstream err; - err << L"Notifications are disabled\n" - << L"Reason: " << error << L"Please make sure that the app id is set correctly.\n" - << L"Command Line: " << GetCommandLineW(); - tLog << err.str(); - std::wcerr << err.str() << std::endl; - return S_FALSE; + if (!error.empty()) { + std::wstringstream err; + err << L"Notifications are disabled\n" + << L"Reason: " << error << L" Please make sure that the app id is set correctly.\n" + << L"Command Line: " << GetCommandLineW(); + tLog << err.str(); + std::wcerr << err.str() << std::endl; + } + return d->m_notifier->Show(d->m_notification.Get()); } std::wstring SnoreToasts::version() { static std::wstring ver = [] { std::wstringstream st; st << SNORETOAST_VERSION_MAJOR << L"." << SNORETOAST_VERSION_MINOR << L"." << SNORETOAST_VERSION_PATCH; return st.str(); }(); return ver; } HRESULT SnoreToasts::backgroundCallback(const std::wstring &appUserModelId, const std::wstring &invokedArgs, const std::wstring &msg) { tLog << "CToastNotificationActivationCallback::Activate: " << appUserModelId << " : " << invokedArgs << " : " << msg; const auto dataMap = Utils::splitData(invokedArgs); const auto action = SnoreToastActions::getAction(dataMap.at(L"action")); std::wstring dataString; if (action == SnoreToastActions::Actions::TextEntered) { std::wstringstream sMsg; sMsg << invokedArgs << L"text=" << msg; dataString = sMsg.str(); } else { dataString = invokedArgs; } const auto pipe = dataMap.find(L"pipe"); if (pipe != dataMap.cend()) { if (!Utils::writePipe(pipe->second, dataString)) { const auto app = dataMap.find(L"application"); if (app != dataMap.cend()) { if (Utils::startProcess(app->second)) { Utils::writePipe(pipe->second, dataString, true); } } } } tLog << dataString; if (!SetEvent(SnoreToastsPrivate::ctoastEvent())) { tLog << "SetEvent failed" << GetLastError(); return S_FALSE; } return S_OK; } void SnoreToasts::waitForCallbackActivation() { Utils::registerActivator(); WaitForSingleObject(SnoreToastsPrivate::ctoastEvent(), EVENT_TIMEOUT); Utils::unregisterActivator(); }