1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef ToastNotificationHandler_h__
#define ToastNotificationHandler_h__
#include <windows.ui.notifications.h>
#include <windows.data.xml.dom.h>
#include <wrl.h>
#include "nsCOMPtr.h"
#include "nsICancelable.h"
#include "nsIFile.h"
#include "nsIWindowsAlertsService.h"
#include "nsString.h"
#include "mozilla/Result.h"
namespace mozilla {
namespace widget {
enum class ImagePlacement {
eInline,
eHero,
eIcon,
};
class ToastNotification;
class ToastNotificationHandler final
: public nsIAlertNotificationImageListener {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIALERTNOTIFICATIONIMAGELISTENER
ToastNotificationHandler(
ToastNotification* backend, const nsAString& aAumid,
nsIAlertNotification* aAlertNotification, nsIObserver* aAlertListener,
const nsAString& aName, const nsAString& aCookie, const nsAString& aTitle,
const nsAString& aMsg, const nsAString& aHostPort, bool aClickable,
bool aRequireInteraction,
const nsTArray<RefPtr<nsIAlertAction>>& aActions, bool aIsSystemPrincipal,
const nsAString& aOpaqueRelaunchData, bool aInPrivateBrowsing,
bool aIsSilent, ImagePlacement aImagePlacement = ImagePlacement::eInline)
: mBackend(backend),
mAumid(aAumid),
mHasImage(false),
mAlertNotification(aAlertNotification),
mAlertListener(aAlertListener),
mName(aName),
mCookie(aCookie),
mTitle(aTitle),
mMsg(aMsg),
mHostPort(aHostPort),
mClickable(aClickable),
mRequireInteraction(aRequireInteraction),
mInPrivateBrowsing(aInPrivateBrowsing),
mActions(aActions.Clone()),
mIsSystemPrincipal(aIsSystemPrincipal),
mOpaqueRelaunchData(aOpaqueRelaunchData),
mIsSilent(aIsSilent),
mSentFinished(!aAlertListener),
mImagePlacement(aImagePlacement) {}
nsresult InitAlertAsync();
void OnWriteImageFinished(nsresult rv);
void HideAlert();
bool IsPrivate();
// Called to stop listening events from Windows for this notification.
// This allows clearing up resources bound to the listener callbacks.
void UnregisterHandler();
// Called when Alerts Service closes notification.
// This will clear up resources and also ping the observer for further
// downstream cleanup.
void HandleCloseFromBrowser();
nsString ActionArgsJSONString(
const nsString& aAction,
const nsString& aOpaqueRelaunchData /* = u""_ns */);
nsresult CreateToastXmlString(const nsAString& aImageURL, nsAString& aString);
nsresult GetWindowsTag(nsAString& aWindowsTag);
nsresult SetWindowsTag(const nsAString& aWindowsTag);
// Exposed for consumption by `ToastNotification.cpp`.
static nsresult FindNotificationDataForWindowsTag(
const nsAString& aWindowsTag, const nsAString& aAumid, bool& aFoundTag,
nsAString& aNotificationData);
protected:
virtual ~ToastNotificationHandler();
using IXmlDocument = ABI::Windows::Data::Xml::Dom::IXmlDocument;
using IToastNotifier = ABI::Windows::UI::Notifications::IToastNotifier;
using IToastNotification =
ABI::Windows::UI::Notifications::IToastNotification;
using IToastDismissedEventArgs =
ABI::Windows::UI::Notifications::IToastDismissedEventArgs;
using IToastFailedEventArgs =
ABI::Windows::UI::Notifications::IToastFailedEventArgs;
using ToastTemplateType = ABI::Windows::UI::Notifications::ToastTemplateType;
template <typename T>
using ComPtr = Microsoft::WRL::ComPtr<T>;
Result<nsString, nsresult> GetLaunchArgument();
ComPtr<IToastNotification> mNotification;
ComPtr<IToastNotifier> mNotifier;
RefPtr<ToastNotification> mBackend;
nsString mAumid;
nsString mWindowsTag;
nsCOMPtr<nsICancelable> mImageRequest;
nsCOMPtr<nsIFile> mImageFile;
nsString mImageUri;
bool mHasImage;
EventRegistrationToken mActivatedToken{};
EventRegistrationToken mDismissedToken{};
EventRegistrationToken mFailedToken{};
nsCOMPtr<nsIAlertNotification> mAlertNotification;
nsCOMPtr<nsIObserver> mAlertListener;
nsString mName;
nsString mCookie;
nsString mTitle;
nsString mMsg;
nsString mHostPort;
bool mClickable;
bool mRequireInteraction;
bool mInPrivateBrowsing;
nsTArray<RefPtr<nsIAlertAction>> mActions;
bool mIsSystemPrincipal;
nsString mOpaqueRelaunchData;
bool mIsSilent;
bool mSentFinished;
ImagePlacement mImagePlacement;
nsresult TryShowAlert();
bool ShowAlert();
nsresult AsyncSaveImage(imgIRequest* aRequest);
nsresult OnWriteImageSuccess();
// Pings the alert observer with alertfinish.
void SendFinished();
// Called either when Windows tells us the notification is closed or failed to
// open.
void HandleCloseFromSystem();
bool CreateWindowsNotificationFromXml(ComPtr<IXmlDocument>& aToastXml);
ComPtr<IXmlDocument> CreateToastXmlDocument();
HRESULT OnActivate(const ComPtr<IToastNotification>& notification,
const ComPtr<IInspectable>& inspectable);
HRESULT OnDismiss(const ComPtr<IToastNotification>& notification,
const ComPtr<IToastDismissedEventArgs>& aArgs);
HRESULT OnFail(const ComPtr<IToastNotification>& notification,
const ComPtr<IToastFailedEventArgs>& aArgs);
static ComPtr<IToastNotification> FindNotificationByTag(
const nsAString& aWindowsTag, const nsAString& aAumid);
};
} // namespace widget
} // namespace mozilla
#endif
|