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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 mozilla_dom_notification_h__
#define mozilla_dom_notification_h__
#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/dom/DOMTypes.h"
#include "mozilla/dom/NotificationBinding.h"
#include "mozilla/dom/notification/NotificationChild.h"
#include "nsCycleCollectionParticipant.h"
#include "nsISupports.h"
class nsIPrincipal;
class nsIVariant;
namespace mozilla::dom {
class NotificationRef;
class WorkerNotificationObserver;
class Promise;
class StrongWorkerRef;
namespace notification {
enum class PermissionCheckPurpose : uint8_t;
}
/*
* A Notification gets a corresponding IPC actor after successful construction.
* The notification object and the actor do not own each other and their
* lifetimes are controlled semi-independently.
*
* The Notification object can be cycle collected when either:
* - no one is listening for the events, or
* - the backend notification is closed.
*
* The actor goes away when either:
* - the backend notification is closed, or
* - the tab is closed or bfcached.
*
* (It cannot just go away on cycle collection because nsIAlertsService wants to
* know whether the triggered page is still open to decide whether to open a new
* tab or focus on the existing tab.)
*/
class Notification : public DOMEventTargetHelper, public SupportsWeakPtr {
friend class CloseNotificationRunnable;
friend class NotificationTask;
friend class NotificationPermissionRequest;
friend class MainThreadNotificationObserver;
friend class NotificationStorageCallback;
friend class ServiceWorkerNotificationObserver;
friend class WorkerGetRunnable;
friend class WorkerNotificationObserver;
public:
IMPL_EVENT_HANDLER(click)
IMPL_EVENT_HANDLER(show)
IMPL_EVENT_HANDLER(error)
IMPL_EVENT_HANDLER(close)
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(Notification,
DOMEventTargetHelper)
static bool PrefEnabled(JSContext* aCx, JSObject* aObj);
static already_AddRefed<Notification> Constructor(
const GlobalObject& aGlobal, const nsAString& aTitle,
const NotificationOptions& aOption, ErrorResult& aRv);
/**
* Used when retrieving notification objects from the parent process.
*/
static Result<already_AddRefed<Notification>, nsresult> ConstructFromIPC(
nsIGlobalObject* aGlobal, const IPCNotification& aIPCNotification,
const nsAString& aServiceWorkerRegistrationScope);
void GetID(nsAString& aRetval) { aRetval = mIPCNotification.id(); }
void GetTitle(nsAString& aRetval) {
aRetval = mIPCNotification.options().title();
}
NotificationDirection Dir() { return mIPCNotification.options().dir(); }
void GetLang(nsAString& aRetval) {
aRetval = mIPCNotification.options().lang();
}
void GetBody(nsAString& aRetval) {
aRetval = mIPCNotification.options().body();
}
void GetTag(nsAString& aRetval) {
aRetval = mIPCNotification.options().tag();
}
void GetIcon(nsAString& aRetval) {
aRetval = mIPCNotification.options().icon();
}
void MaybeNotifyClose();
static bool RequestPermissionEnabledForScope(JSContext* aCx,
JSObject* /* unused */);
static already_AddRefed<Promise> RequestPermission(
const GlobalObject& aGlobal,
const Optional<OwningNonNull<NotificationPermissionCallback> >& aCallback,
ErrorResult& aRv);
static NotificationPermission GetPermission(const GlobalObject& aGlobal,
ErrorResult& aRv);
static uint32_t MaxActions(const GlobalObject& aGlobal);
// Notification implementation of
// ServiceWorkerRegistration.showNotification.
//
//
// Note that aCx may not be in the compartment of aGlobal, but aOptions will
// have its JS things in the compartment of aCx.
static already_AddRefed<Promise> ShowPersistentNotification(
JSContext* aCx, nsIGlobalObject* aGlobal, const nsAString& aScope,
const nsAString& aTitle, const NotificationOptions& aOptions,
const ServiceWorkerRegistrationDescriptor& aDescriptor, ErrorResult& aRv);
void Close();
nsIGlobalObject* GetParentObject() const { return GetOwnerGlobal(); }
JSObject* WrapObject(JSContext*, JS::Handle<JSObject*> aGivenProto) override;
bool RequireInteraction() const;
bool Silent() const;
void GetVibrate(nsTArray<uint32_t>& aRetval) const;
void GetData(JSContext* aCx, JS::MutableHandle<JS::Value> aRetval);
void GetActions(nsTArray<NotificationAction>& aRetVal);
static NotificationPermission GetPermission(
nsIGlobalObject* aGlobal, notification::PermissionCheckPurpose aPurpose,
ErrorResult& aRv);
bool DispatchClickEvent();
nsresult DispatchToMainThread(already_AddRefed<nsIRunnable>&& aRunnable);
protected:
Notification(nsIGlobalObject* aGlobal,
const IPCNotification& aIPCNotification,
const nsAString& aScope);
void Deactivate();
static NotificationPermission GetPermissionInternal(
nsPIDOMWindowInner* aWindow,
notification::PermissionCheckPurpose aPurpose, ErrorResult& rv);
WeakPtr<notification::NotificationChild> mActor;
const IPCNotification mIPCNotification;
// It's null until GetData is first called
JS::Heap<JS::Value> mData;
nsString mScope;
bool mIsClosed = false;
private:
virtual ~Notification();
// Creates a Notification and shows it. Returns a reference to the
// Notification if result is NS_OK. The lifetime of this Notification is tied
// to an underlying NotificationRef. Do not hold a non-stack raw pointer to
// it. Be careful about thread safety if acquiring a strong reference.
//
// Note that aCx may not be in the compartment of aGlobal, but aOptions will
// have its JS things in the compartment of aCx.
static already_AddRefed<Notification> ValidateAndCreate(
JSContext* aCx, nsIGlobalObject* aGlobal, const nsAString& aTitle,
const NotificationOptions& aOptions, const nsAString& aScope,
ErrorResult& aRv);
bool CreateActor();
bool SendShow(Promise* aPromise);
static nsresult ResolveIconURL(nsIGlobalObject* aGlobal,
const nsAString& aIconURL,
nsString& aResolvedURL);
};
} // namespace mozilla::dom
#endif // mozilla_dom_notification_h__
|
