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
|
/*
* Copyright (C) 2009 Google Inc. All rights reserved.
* Copyright (C) 2009, 2011, 2012, 2016, 2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(NOTIFICATIONS)
#include "ActiveDOMObject.h"
#include "ContextDestructionObserverInlines.h"
#include "EventTarget.h"
#include "NotificationDirection.h"
#include "NotificationPayload.h"
#include "NotificationPermission.h"
#include "NotificationResources.h"
#include "ScriptExecutionContextIdentifier.h"
#include "SerializedScriptValue.h"
#include <wtf/CompletionHandler.h>
#include <wtf/URL.h>
#include <wtf/UUID.h>
#include "WritingMode.h"
namespace WebCore {
class DeferredPromise;
class Document;
class NotificationClient;
class NotificationPermissionCallback;
class NotificationResourcesLoader;
struct NotificationData;
class Notification final : public RefCounted<Notification>, public ActiveDOMObject, public EventTarget {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED_EXPORT(Notification, WEBCORE_EXPORT);
public:
void ref() const final { RefCounted::ref(); }
void deref() const final { RefCounted::deref(); }
using Permission = NotificationPermission;
using Direction = NotificationDirection;
struct Options {
Direction dir;
String lang;
String body;
String tag;
String icon;
JSC::JSValue data;
RefPtr<SerializedScriptValue> serializedData;
RefPtr<JSON::Value> jsonData;
std::optional<bool> silent;
#if ENABLE(DECLARATIVE_WEB_PUSH)
String navigate;
#endif
};
// For JS constructor only.
static ExceptionOr<Ref<Notification>> create(ScriptExecutionContext&, String&& title, Options&&);
static ExceptionOr<Ref<Notification>> createForServiceWorker(ScriptExecutionContext&, String&& title, Options&&, const URL&);
static Ref<Notification> create(ScriptExecutionContext&, NotificationData&&);
static Ref<Notification> create(ScriptExecutionContext&, const URL& registrationURL, const NotificationPayload&);
WEBCORE_EXPORT virtual ~Notification();
void show(CompletionHandler<void()>&& = [] { });
void close();
#if ENABLE(DECLARATIVE_WEB_PUSH)
const URL& navigate() const { return m_navigate; }
#endif
const String& title() const { return m_title; }
Direction dir() const { return m_direction; }
const String& body() const { return m_body; }
const String& lang() const { return m_lang; }
const String& tag() const { return m_tag; }
const URL& icon() const { return m_icon; }
JSC::JSValue dataForBindings(JSC::JSGlobalObject&);
std::optional<bool> silent() const { return m_silent; }
TextDirection direction() const { return m_direction == Direction::Rtl ? TextDirection::RTL : TextDirection::LTR; }
WEBCORE_EXPORT void dispatchClickEvent();
WEBCORE_EXPORT void dispatchCloseEvent();
WEBCORE_EXPORT void dispatchErrorEvent();
WEBCORE_EXPORT void dispatchShowEvent();
WEBCORE_EXPORT void finalize();
static Permission permission(ScriptExecutionContext&);
static void requestPermission(Document&, RefPtr<NotificationPermissionCallback>&&, Ref<DeferredPromise>&&);
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
WEBCORE_EXPORT NotificationData data() const;
RefPtr<NotificationResources> resources() const { return m_resources; }
void markAsShown();
void showSoon();
WTF::UUID identifier() const { return m_identifier; }
bool isPersistent() const { return !m_serviceWorkerRegistrationURL.isNull(); }
WEBCORE_EXPORT static void ensureOnNotificationThread(ScriptExecutionContextIdentifier, WTF::UUID notificationIdentifier, Function<void(Notification*)>&&);
WEBCORE_EXPORT static void ensureOnNotificationThread(const NotificationData&, Function<void(Notification*)>&&);
private:
Notification(ScriptExecutionContext&, WTF::UUID, const String& title, Options&&, Ref<SerializedScriptValue>&&);
NotificationClient* clientFromContext();
enum EventTargetInterfaceType eventTargetInterface() const final { return EventTargetInterfaceType::Notification; }
void stopResourcesLoader();
// ActiveDOMObject
void suspend(ReasonForSuspension);
void stop() final;
bool virtualHasPendingActivity() const final;
// EventTarget
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
void eventListenersDidChange() final;
WTF::UUID m_identifier;
#if ENABLE(DECLARATIVE_WEB_PUSH)
URL m_navigate;
#endif
String m_title;
Direction m_direction;
String m_lang;
String m_body;
String m_tag;
URL m_icon;
Ref<SerializedScriptValue> m_dataForBindings;
std::optional<bool> m_silent;
enum State { Idle, Showing, Closed };
State m_state { Idle };
bool m_hasRelevantEventListener { false };
enum class NotificationSource : uint8_t {
DedicatedWorker,
Document,
ServiceWorker,
};
NotificationSource m_notificationSource;
URL m_serviceWorkerRegistrationURL;
std::unique_ptr<NotificationResourcesLoader> m_resourcesLoader;
RefPtr<NotificationResources> m_resources;
};
} // namespace WebCore
#endif // ENABLE(NOTIFICATIONS)
|