bb8719d82f52086a0e43b7d0e848b18228dad645
[WebKit-https.git] / Source / WebCore / Modules / notifications / Notification.cpp
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2009, 2011, 2012, 2016 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33
34 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
35
36 #include "Notification.h"
37
38 #include "DOMWindow.h"
39 #include "DOMWindowNotifications.h"
40 #include "Document.h"
41 #include "Event.h"
42 #include "EventNames.h"
43 #include "ExceptionCode.h"
44 #include "NotificationCenter.h"
45 #include "NotificationController.h"
46 #include "NotificationPermissionCallback.h"
47 #include "VoidCallback.h"
48 #include "WindowFocusAllowedIndicator.h"
49
50 namespace WebCore {
51
52 #if ENABLE(LEGACY_NOTIFICATIONS)
53
54 Notification::Notification(const String& title, const String& body, URL&& iconURL, ScriptExecutionContext& context, NotificationCenter& notificationCenter)
55     : ActiveDOMObject(&context)
56     , m_icon(WTFMove(iconURL))
57     , m_title(title)
58     , m_body(body)
59     , m_notificationCenter(&notificationCenter)
60 {
61 }
62
63 #endif
64
65 #if ENABLE(NOTIFICATIONS)
66
67 Notification::Notification(Document& document, const String& title)
68     : ActiveDOMObject(&document)
69     , m_title(title)
70     , m_state(Idle)
71     , m_notificationCenter(DOMWindowNotifications::webkitNotifications(*document.domWindow()))
72     , m_taskTimer(std::make_unique<Timer>([this] () { show(); }))
73 {
74     // FIXME: Seems that m_notificationCenter can be null so should not be changed from RefPtr to Ref.
75     // But the rest of the code in this class isn't trying to handle that case.
76     ASSERT(m_notificationCenter->client());
77     m_taskTimer->startOneShot(0_s);
78 }
79
80 #endif
81
82 Notification::~Notification() 
83 {
84 }
85
86 #if ENABLE(LEGACY_NOTIFICATIONS)
87
88 ExceptionOr<Ref<Notification>> Notification::create(const String& title, const String& body, const String& iconURL, ScriptExecutionContext& context, NotificationCenter& provider)
89
90     if (provider.checkPermission() != NotificationClient::PermissionAllowed)
91         return Exception { SECURITY_ERR };
92
93     URL completedIconURL = iconURL.isEmpty() ? URL() : context.completeURL(iconURL);
94     if (!completedIconURL.isEmpty() && !completedIconURL.isValid())
95         return Exception { SYNTAX_ERR };
96
97     auto notification = adoptRef(*new Notification(title, body, WTFMove(completedIconURL), context, provider));
98     notification.get().suspendIfNeeded();
99     return WTFMove(notification);
100 }
101
102 #endif
103
104 #if ENABLE(NOTIFICATIONS)
105
106 static String directionString(Notification::Direction direction)
107 {
108     // FIXME: Storing this as a string is not the right way to do it.
109     // FIXME: Seems highly unlikely that this does the right thing for Auto.
110     switch (direction) {
111     case Notification::Direction::Auto:
112         return ASCIILiteral("auto");
113     case Notification::Direction::Ltr:
114         return ASCIILiteral("ltr");
115     case Notification::Direction::Rtl:
116         return ASCIILiteral("rtl");
117     }
118     ASSERT_NOT_REACHED();
119     return { };
120 }
121
122 Ref<Notification> Notification::create(Document& context, const String& title, const Options& options)
123 {
124     auto notification = adoptRef(*new Notification(context, title));
125     notification.get().m_body = options.body;
126     notification.get().m_tag = options.tag;
127     notification.get().m_lang = options.lang;
128     notification.get().m_direction = directionString(options.dir);
129     if (!options.icon.isEmpty()) {
130         auto iconURL = context.completeURL(options.icon);
131         if (iconURL.isValid())
132             notification.get().m_icon = iconURL;
133     }
134     notification.get().suspendIfNeeded();
135     return notification;
136 }
137
138 #endif
139
140 void Notification::show() 
141 {
142     // prevent double-showing
143     if (m_state == Idle && m_notificationCenter->client()) {
144 #if ENABLE(NOTIFICATIONS)
145         auto* page = downcast<Document>(*scriptExecutionContext()).page();
146         if (!page)
147             return;
148         if (NotificationController::from(page)->client().checkPermission(scriptExecutionContext()) != NotificationClient::PermissionAllowed) {
149             dispatchErrorEvent();
150             return;
151         }
152 #endif
153         if (m_notificationCenter->client()->show(this)) {
154             m_state = Showing;
155             setPendingActivity(this);
156         }
157     }
158 }
159
160 void Notification::close()
161 {
162     switch (m_state) {
163     case Idle:
164         break;
165     case Showing:
166         if (m_notificationCenter->client())
167             m_notificationCenter->client()->cancel(this);
168         break;
169     case Closed:
170         break;
171     }
172 }
173
174 void Notification::contextDestroyed()
175 {
176     ActiveDOMObject::contextDestroyed();
177     if (m_notificationCenter->client())
178         m_notificationCenter->client()->notificationObjectDestroyed(this);
179 }
180
181 const char* Notification::activeDOMObjectName() const
182 {
183     return "Notification";
184 }
185
186 bool Notification::canSuspendForDocumentSuspension() const
187 {
188     // We can suspend if the Notification is not shown yet or after it is closed.
189     return m_state == Idle || m_state == Closed;
190 }
191
192 void Notification::finalize()
193 {
194     if (m_state == Closed)
195         return;
196     m_state = Closed;
197     unsetPendingActivity(this);
198 }
199
200 void Notification::dispatchShowEvent()
201 {
202     dispatchEvent(Event::create(eventNames().showEvent, false, false));
203 }
204
205 void Notification::dispatchClickEvent()
206 {
207     WindowFocusAllowedIndicator windowFocusAllowed;
208     dispatchEvent(Event::create(eventNames().clickEvent, false, false));
209 }
210
211 void Notification::dispatchCloseEvent()
212 {
213     dispatchEvent(Event::create(eventNames().closeEvent, false, false));
214     finalize();
215 }
216
217 void Notification::dispatchErrorEvent()
218 {
219     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
220 }
221
222 #if ENABLE(NOTIFICATIONS)
223
224 String Notification::permission(Document& document)
225 {
226     return permissionString(NotificationController::from(document.page())->client().checkPermission(&document));
227 }
228
229 String Notification::permissionString(NotificationClient::Permission permission)
230 {
231     switch (permission) {
232     case NotificationClient::PermissionAllowed:
233         return ASCIILiteral("granted");
234     case NotificationClient::PermissionDenied:
235         return ASCIILiteral("denied");
236     case NotificationClient::PermissionNotAllowed:
237         return ASCIILiteral("default");
238     }
239     ASSERT_NOT_REACHED();
240     return { };
241 }
242
243 void Notification::requestPermission(Document& document, RefPtr<NotificationPermissionCallback>&& callback)
244 {
245     NotificationController::from(document.page())->client().requestPermission(&document, WTFMove(callback));
246 }
247
248 #endif
249
250 } // namespace WebCore
251
252 #endif // ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)