3b21bbc88be77daf36d3d6fac0b25e69cab4ec47
[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, 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 #pragma once
33
34 #if ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)
35
36 #include "ActiveDOMObject.h"
37 #include "EventTarget.h"
38 #include "ExceptionOr.h"
39 #include "NotificationClient.h"
40 #include "Timer.h"
41 #include "URL.h"
42 #include "WritingMode.h"
43
44 namespace WebCore {
45
46 class Document;
47 class NotificationCenter;
48 class NotificationPermissionCallback;
49
50 class Notification final : public RefCounted<Notification>, public ActiveDOMObject, public EventTargetWithInlineData {
51     WTF_MAKE_FAST_ALLOCATED;
52 public:
53 #if ENABLE(LEGACY_NOTIFICATIONS)
54     static ExceptionOr<Ref<Notification>> create(const String& title, const String& body, const String& iconURL, ScriptExecutionContext&, NotificationCenter&);
55 #endif
56
57 #if ENABLE(NOTIFICATIONS)
58     enum class Direction { Auto, Ltr, Rtl };
59     struct Options {
60         Direction dir;
61         String lang;
62         String body;
63         String tag;
64         String icon;
65     };
66     static Ref<Notification> create(Document&, const String& title, const Options&);
67 #endif
68     
69     virtual ~Notification();
70
71     void show();
72     void close();
73
74     const URL& iconURL() const { return m_icon; }
75     const String& title() const { return m_title; }
76     const String& body() const { return m_body; }
77     const String& lang() const { return m_lang; }
78
79     const String& dir() const { return m_direction; }
80     void setDir(const String& dir) { m_direction = dir; }
81
82     const String& replaceId() const { return m_tag; }
83     void setReplaceId(const String& replaceId) { m_tag = replaceId; }
84
85     const String& tag() const { return m_tag; }
86     void setTag(const String& tag) { m_tag = tag; }
87
88     TextDirection direction() const { return m_direction == "rtl" ? RTL : LTR; }
89
90     WEBCORE_EXPORT void dispatchClickEvent();
91     WEBCORE_EXPORT void dispatchCloseEvent();
92     WEBCORE_EXPORT void dispatchErrorEvent();
93     WEBCORE_EXPORT void dispatchShowEvent();
94
95     WEBCORE_EXPORT void finalize();
96
97 #if ENABLE(NOTIFICATIONS)
98     static String permission(Document&);
99     WEBCORE_EXPORT static String permissionString(NotificationClient::Permission);
100     static void requestPermission(Document&, RefPtr<NotificationPermissionCallback>&&);
101 #endif
102
103     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
104
105     using RefCounted::ref;
106     using RefCounted::deref;
107
108 private:
109 #if ENABLE(LEGACY_NOTIFICATIONS)
110     Notification(const String& title, const String& body, URL&& iconURL, ScriptExecutionContext&, NotificationCenter&);
111 #endif
112
113 #if ENABLE(NOTIFICATIONS)
114     Notification(Document&, const String& title);
115 #endif
116
117     EventTargetInterface eventTargetInterface() const final { return NotificationEventTargetInterfaceType; }
118
119     void contextDestroyed() final;
120     const char* activeDOMObjectName() const final;
121     bool canSuspendForDocumentSuspension() const final;
122
123     void refEventTarget() final { ref(); }
124     void derefEventTarget() final { deref(); }
125
126     URL m_icon;
127     String m_title;
128     String m_body;
129     String m_direction;
130     String m_lang;
131     String m_tag;
132
133     enum State { Idle, Showing, Closed };
134     State m_state { Idle };
135
136     RefPtr<NotificationCenter> m_notificationCenter;
137
138 #if ENABLE(NOTIFICATIONS)
139     std::unique_ptr<Timer> m_taskTimer;
140 #endif
141 };
142
143 } // namespace WebCore
144
145 #endif // ENABLE(NOTIFICATIONS) || ENABLE(LEGACY_NOTIFICATIONS)