50797ae3baeceaed5463b7725b156bf608b3a2e5
[WebKit-https.git] / Source / WebCore / Modules / notifications / Notification.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2009, 2011, 2012 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 #ifndef Notification_h  
33 #define Notification_h
34
35 #include "ActiveDOMObject.h"
36 #include "EventNames.h"
37 #include "EventTarget.h"
38 #include "URL.h"
39 #include "NotificationClient.h"
40 #include "TextDirection.h"
41 #include "ThreadableLoaderClient.h"
42 #include <wtf/PassRefPtr.h>
43 #include <wtf/RefCounted.h>
44 #include <wtf/RefPtr.h>
45 #include <wtf/text/AtomicStringHash.h>
46
47 #if ENABLE(NOTIFICATIONS)
48 #include "Timer.h"
49 #endif
50
51 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
52 namespace WebCore {
53
54 class Dictionary;
55 class NotificationCenter;
56 class NotificationPermissionCallback;
57 class ResourceError;
58 class ResourceResponse;
59 class ScriptExecutionContext;
60 class ThreadableLoader;
61
62 typedef int ExceptionCode;
63
64 class Notification final : public RefCounted<Notification>, public ActiveDOMObject, public EventTargetWithInlineData {
65     WTF_MAKE_FAST_ALLOCATED;
66 public:
67     WEBCORE_EXPORT Notification();
68 #if ENABLE(LEGACY_NOTIFICATIONS)
69     static PassRef<Notification> create(const String& title, const String& body, const String& iconURI, ScriptExecutionContext*, ExceptionCode&, PassRefPtr<NotificationCenter> provider);
70 #endif
71 #if ENABLE(NOTIFICATIONS)
72     static PassRef<Notification> create(ScriptExecutionContext&, const String& title, const Dictionary& options);
73 #endif
74     
75     WEBCORE_EXPORT virtual ~Notification();
76
77     void show();
78 #if ENABLE(LEGACY_NOTIFICATIONS)
79     void cancel() { close(); }
80 #endif
81     void close();
82
83     URL iconURL() const { return m_icon; }
84     void setIconURL(const URL& url) { m_icon = url; }
85
86     String title() const { return m_title; }
87     String body() const { return m_body; }
88
89     String lang() const { return m_lang; }
90     void setLang(const String& lang) { m_lang = lang; }
91
92     String dir() const { return m_direction; }
93     void setDir(const String& dir) { m_direction = dir; }
94
95 #if ENABLE(LEGACY_NOTIFICATIONS)
96     String replaceId() const { return tag(); }
97     void setReplaceId(const String& replaceId) { setTag(replaceId); }
98 #endif
99
100     String tag() const { return m_tag; }
101     void setTag(const String& tag) { m_tag = tag; }
102
103     TextDirection direction() const { return dir() == "rtl" ? RTL : LTR; }
104
105 #if ENABLE(LEGACY_NOTIFICATIONS)
106     EventListener* ondisplay() { return getAttributeEventListener(eventNames().showEvent); }
107     void setOndisplay(PassRefPtr<EventListener> listener) { setAttributeEventListener(eventNames().showEvent, listener); }
108 #endif
109     DEFINE_ATTRIBUTE_EVENT_LISTENER(show);
110     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
111     DEFINE_ATTRIBUTE_EVENT_LISTENER(close);
112     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
113     
114     WEBCORE_EXPORT void dispatchClickEvent();
115     WEBCORE_EXPORT void dispatchCloseEvent();
116     WEBCORE_EXPORT void dispatchErrorEvent();
117     WEBCORE_EXPORT void dispatchShowEvent();
118
119     using RefCounted<Notification>::ref;
120     using RefCounted<Notification>::deref;
121
122     // EventTarget interface
123     virtual EventTargetInterface eventTargetInterface() const override { return NotificationEventTargetInterfaceType; }
124     virtual ScriptExecutionContext* scriptExecutionContext() const override { return ActiveDOMObject::scriptExecutionContext(); }
125
126     void stopLoadingIcon();
127
128     // Deprecated. Use functions from NotificationCenter.
129     void detachPresenter() { }
130
131     WEBCORE_EXPORT void finalize();
132
133 #if ENABLE(NOTIFICATIONS)
134     static const String permission(ScriptExecutionContext*);
135     WEBCORE_EXPORT static const String permissionString(NotificationClient::Permission);
136     static void requestPermission(ScriptExecutionContext*, PassRefPtr<NotificationPermissionCallback> = 0);
137 #endif
138
139 private:
140 #if ENABLE(LEGACY_NOTIFICATIONS)
141     Notification(const String& title, const String& body, const String& iconURI, ScriptExecutionContext*, ExceptionCode&, PassRefPtr<NotificationCenter>);
142 #endif
143 #if ENABLE(NOTIFICATIONS)
144     Notification(ScriptExecutionContext&, const String& title);
145 #endif
146
147     void setBody(const String& body) { m_body = body; }
148
149     // ActiveDOMObject interface
150     virtual void contextDestroyed() override;
151
152     // EventTarget interface
153     virtual void refEventTarget() override { ref(); }
154     virtual void derefEventTarget() override { deref(); }
155
156     void startLoadingIcon();
157     void finishLoadingIcon();
158
159 #if ENABLE(NOTIFICATIONS)
160     void taskTimerFired();
161 #endif
162
163     // Text notifications.
164     URL m_icon;
165     String m_title;
166     String m_body;
167     String m_direction;
168     String m_lang;
169     String m_tag;
170
171     enum NotificationState {
172         Idle = 0,
173         Showing = 1,
174         Closed = 2,
175     };
176
177     NotificationState m_state;
178
179     RefPtr<NotificationCenter> m_notificationCenter;
180
181 #if ENABLE(NOTIFICATIONS)
182     std::unique_ptr<Timer> m_taskTimer;
183 #endif
184 };
185
186 } // namespace WebCore
187
188 #endif // ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
189
190 #endif // Notifications_h