// Copyright (c) 2015 Felix Rieseberg and Jason Poon // . All rights reserved. // Copyright (c) 2015 Ryan McShane and Brandon Smith // // Thanks to both of those folks mentioned above who first thought up a bunch of // this code // and released it as MIT to the world. #include "brightray/browser/win/windows_toast_notification.h" #include #include #include "base/environment.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/notification_delegate.h" #include "brightray/browser/win/notification_presenter_win.h" #include "brightray/browser/win/scoped_hstring.h" #include "brightray/common/application_info.h" #include "content/public/browser/browser_thread.h" using ABI::Windows::Data::Xml::Dom::IXmlAttribute; using ABI::Windows::Data::Xml::Dom::IXmlDocument; using ABI::Windows::Data::Xml::Dom::IXmlElement; using ABI::Windows::Data::Xml::Dom::IXmlNamedNodeMap; using ABI::Windows::Data::Xml::Dom::IXmlNode; using ABI::Windows::Data::Xml::Dom::IXmlNodeList; using ABI::Windows::Data::Xml::Dom::IXmlText; namespace brightray { namespace { bool IsDebuggingNotifications() { return base::Environment::Create()->HasVar("ELECTRON_DEBUG_NOTIFICATIONS"); } } // namespace // static ComPtr WindowsToastNotification::toast_manager_; // static ComPtr WindowsToastNotification::toast_notifier_; // static bool WindowsToastNotification::Initialize() { // Just initialize, don't care if it fails or already initialized. Windows::Foundation::Initialize(RO_INIT_MULTITHREADED); ScopedHString toast_manager_str( RuntimeClass_Windows_UI_Notifications_ToastNotificationManager); if (!toast_manager_str.success()) return false; if (FAILED(Windows::Foundation::GetActivationFactory(toast_manager_str, &toast_manager_))) return false; if (IsRunningInDesktopBridge()) { // Ironically, the Desktop Bridge / UWP environment // requires us to not give Windows an appUserModelId. return SUCCEEDED(toast_manager_->CreateToastNotifier(&toast_notifier_)); } else { ScopedHString app_id; if (!GetAppUserModelID(&app_id)) return false; return SUCCEEDED( toast_manager_->CreateToastNotifierWithId(app_id, &toast_notifier_)); } } WindowsToastNotification::WindowsToastNotification( NotificationDelegate* delegate, NotificationPresenter* presenter) : Notification(delegate, presenter) {} WindowsToastNotification::~WindowsToastNotification() { // Remove the notification on exit. if (toast_notification_) { RemoveCallbacks(toast_notification_.Get()); Dismiss(); } } void WindowsToastNotification::Show(const NotificationOptions& options) { auto* presenter_win = static_cast(presenter()); std::wstring icon_path = presenter_win->SaveIconToFilesystem(options.icon, options.icon_url); ComPtr toast_xml; if (FAILED(GetToastXml(toast_manager_.Get(), options.title, options.msg, icon_path, options.silent, &toast_xml))) { NotificationFailed(); return; } ScopedHString toast_str( RuntimeClass_Windows_UI_Notifications_ToastNotification); if (!toast_str.success()) { NotificationFailed(); return; } ComPtr toast_factory; if (FAILED(Windows::Foundation::GetActivationFactory(toast_str, &toast_factory))) { NotificationFailed(); return; } if (FAILED(toast_factory->CreateToastNotification(toast_xml.Get(), &toast_notification_))) { NotificationFailed(); return; } if (!SetupCallbacks(toast_notification_.Get())) { NotificationFailed(); return; } if (FAILED(toast_notifier_->Show(toast_notification_.Get()))) { NotificationFailed(); return; } if (IsDebuggingNotifications()) LOG(INFO) << "Notification created"; if (delegate()) delegate()->NotificationDisplayed(); } void WindowsToastNotification::Dismiss() { if (IsDebuggingNotifications()) LOG(INFO) << "Hiding notification"; toast_notifier_->Hide(toast_notification_.Get()); } bool WindowsToastNotification::GetToastXml( ABI::Windows::UI::Notifications::IToastNotificationManagerStatics* toastManager, const std::wstring& title, const std::wstring& msg, const std::wstring& icon_path, bool silent, IXmlDocument** toast_xml) { ABI::Windows::UI::Notifications::ToastTemplateType template_type; if (title.empty() || msg.empty()) { // Single line toast. template_type = icon_path.empty() ? ABI::Windows::UI::Notifications::ToastTemplateType_ToastText01 : ABI::Windows::UI::Notifications:: ToastTemplateType_ToastImageAndText01; if (FAILED(toast_manager_->GetTemplateContent(template_type, toast_xml))) return false; if (!SetXmlText(*toast_xml, title.empty() ? msg : title)) return false; } else { // Title and body toast. template_type = icon_path.empty() ? ABI::Windows::UI::Notifications::ToastTemplateType_ToastText02 : ABI::Windows::UI::Notifications:: ToastTemplateType_ToastImageAndText02; if (FAILED(toastManager->GetTemplateContent(template_type, toast_xml))) { if (IsDebuggingNotifications()) LOG(INFO) << "Fetching XML template failed"; return false; } if (!SetXmlText(*toast_xml, title, msg)) { if (IsDebuggingNotifications()) LOG(INFO) << "Setting text fields on template failed"; return false; } } // Configure the toast's notification sound if (silent) { if (FAILED(SetXmlAudioSilent(*toast_xml))) { if (IsDebuggingNotifications()) { LOG(INFO) << "Setting \"silent\" option on notification failed"; } return false; } } // Configure the toast's image if (!icon_path.empty()) return SetXmlImage(*toast_xml, icon_path); return true; } bool WindowsToastNotification::SetXmlAudioSilent(IXmlDocument* doc) { ScopedHString tag(L"toast"); if (!tag.success()) return false; ComPtr node_list; if (FAILED(doc->GetElementsByTagName(tag, &node_list))) return false; ComPtr root; if (FAILED(node_list->Item(0, &root))) return false; ComPtr audio_element; ScopedHString audio_str(L"audio"); if (FAILED(doc->CreateElement(audio_str, &audio_element))) return false; ComPtr audio_node_tmp; if (FAILED(audio_element.As(&audio_node_tmp))) return false; // Append audio node to toast xml ComPtr audio_node; if (FAILED(root->AppendChild(audio_node_tmp.Get(), &audio_node))) return false; // Create silent attribute ComPtr attributes; if (FAILED(audio_node->get_Attributes(&attributes))) return false; ComPtr silent_attribute; ScopedHString silent_str(L"silent"); if (FAILED(doc->CreateAttribute(silent_str, &silent_attribute))) return false; ComPtr silent_attribute_node; if (FAILED(silent_attribute.As(&silent_attribute_node))) return false; // Set silent attribute to true ScopedHString silent_value(L"true"); if (!silent_value.success()) return false; ComPtr silent_text; if (FAILED(doc->CreateTextNode(silent_value, &silent_text))) return false; ComPtr silent_node; if (FAILED(silent_text.As(&silent_node))) return false; ComPtr child_node; if (FAILED( silent_attribute_node->AppendChild(silent_node.Get(), &child_node))) return false; ComPtr silent_attribute_pnode; return SUCCEEDED(attributes.Get()->SetNamedItem(silent_attribute_node.Get(), &silent_attribute_pnode)); } bool WindowsToastNotification::SetXmlText(IXmlDocument* doc, const std::wstring& text) { ScopedHString tag; ComPtr node_list; if (!GetTextNodeList(&tag, doc, &node_list, 1)) return false; ComPtr node; if (FAILED(node_list->Item(0, &node))) return false; return AppendTextToXml(doc, node.Get(), text); } bool WindowsToastNotification::SetXmlText(IXmlDocument* doc, const std::wstring& title, const std::wstring& body) { ScopedHString tag; ComPtr node_list; if (!GetTextNodeList(&tag, doc, &node_list, 2)) return false; ComPtr node; if (FAILED(node_list->Item(0, &node))) return false; if (!AppendTextToXml(doc, node.Get(), title)) return false; if (FAILED(node_list->Item(1, &node))) return false; return AppendTextToXml(doc, node.Get(), body); } bool WindowsToastNotification::SetXmlImage(IXmlDocument* doc, const std::wstring& icon_path) { ScopedHString tag(L"image"); if (!tag.success()) return false; ComPtr node_list; if (FAILED(doc->GetElementsByTagName(tag, &node_list))) return false; ComPtr image_node; if (FAILED(node_list->Item(0, &image_node))) return false; ComPtr attrs; if (FAILED(image_node->get_Attributes(&attrs))) return false; ScopedHString src(L"src"); if (!src.success()) return false; ComPtr src_attr; if (FAILED(attrs->GetNamedItem(src, &src_attr))) return false; ScopedHString img_path(icon_path.c_str()); if (!img_path.success()) return false; ComPtr src_text; if (FAILED(doc->CreateTextNode(img_path, &src_text))) return false; ComPtr src_node; if (FAILED(src_text.As(&src_node))) return false; ComPtr child_node; return SUCCEEDED(src_attr->AppendChild(src_node.Get(), &child_node)); } bool WindowsToastNotification::GetTextNodeList(ScopedHString* tag, IXmlDocument* doc, IXmlNodeList** node_list, uint32_t req_length) { tag->Reset(L"text"); if (!tag->success()) return false; if (FAILED(doc->GetElementsByTagName(*tag, node_list))) return false; uint32_t node_length; if (FAILED((*node_list)->get_Length(&node_length))) return false; return node_length >= req_length; } bool WindowsToastNotification::AppendTextToXml(IXmlDocument* doc, IXmlNode* node, const std::wstring& text) { ScopedHString str(text); if (!str.success()) return false; ComPtr xml_text; if (FAILED(doc->CreateTextNode(str, &xml_text))) return false; ComPtr text_node; if (FAILED(xml_text.As(&text_node))) return false; ComPtr append_node; return SUCCEEDED(node->AppendChild(text_node.Get(), &append_node)); } bool WindowsToastNotification::SetupCallbacks( ABI::Windows::UI::Notifications::IToastNotification* toast) { event_handler_ = Make(this); if (FAILED(toast->add_Activated(event_handler_.Get(), &activated_token_))) return false; if (FAILED(toast->add_Dismissed(event_handler_.Get(), &dismissed_token_))) return false; return SUCCEEDED(toast->add_Failed(event_handler_.Get(), &failed_token_)); } bool WindowsToastNotification::RemoveCallbacks( ABI::Windows::UI::Notifications::IToastNotification* toast) { if (FAILED(toast->remove_Activated(activated_token_))) return false; if (FAILED(toast->remove_Dismissed(dismissed_token_))) return false; return SUCCEEDED(toast->remove_Failed(failed_token_)); } /* / Toast Event Handler */ ToastEventHandler::ToastEventHandler(Notification* notification) : notification_(notification->GetWeakPtr()) {} ToastEventHandler::~ToastEventHandler() {} IFACEMETHODIMP ToastEventHandler::Invoke( ABI::Windows::UI::Notifications::IToastNotification* sender, IInspectable* args) { content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(&Notification::NotificationClicked, notification_)); if (IsDebuggingNotifications()) LOG(INFO) << "Notification clicked"; return S_OK; } IFACEMETHODIMP ToastEventHandler::Invoke( ABI::Windows::UI::Notifications::IToastNotification* sender, ABI::Windows::UI::Notifications::IToastDismissedEventArgs* e) { content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(&Notification::NotificationDismissed, notification_)); if (IsDebuggingNotifications()) LOG(INFO) << "Notification dismissed"; return S_OK; } IFACEMETHODIMP ToastEventHandler::Invoke( ABI::Windows::UI::Notifications::IToastNotification* sender, ABI::Windows::UI::Notifications::IToastFailedEventArgs* e) { content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(&Notification::NotificationFailed, notification_)); if (IsDebuggingNotifications()) LOG(INFO) << "Notification failed"; return S_OK; } } // namespace brightray