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
|
/*
* Copyright (C) 2023 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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(WK_WEB_EXTENSIONS)
#include "JSWebExtensionAPIPort.h"
#include "WebExtensionAPIEvent.h"
#include "WebExtensionAPIObject.h"
#include "WebExtensionMessageSenderParameters.h"
#include "WebExtensionPortChannelIdentifier.h"
#include "WebPageProxyIdentifier.h"
#include <wtf/WeakPtr.h>
OBJC_CLASS NSDictionary;
OBJC_CLASS NSObject;
OBJC_CLASS NSString;
namespace WebKit {
class WebExtensionAPIPort : public WebExtensionAPIObject, public JSWebExtensionWrappable, public CanMakeWeakPtr<WebExtensionAPIPort> {
WEB_EXTENSION_DECLARE_JS_WRAPPER_CLASS(WebExtensionAPIPort, port, port);
public:
#if PLATFORM(COCOA)
using PortSet = HashSet<Ref<WebExtensionAPIPort>>;
static PortSet get(WebExtensionPortChannelIdentifier);
WebExtensionContentWorldType targetContentWorldType() const { return m_targetContentWorldType; }
WebExtensionPortChannelIdentifier channelIdentifier() const { return *m_channelIdentifier; }
std::optional<WebPageProxyIdentifier> owningPageProxyIdentifier() const { return m_owningPageProxyIdentifier; }
const std::optional<WebExtensionMessageSenderParameters>& senderParameters() const { return m_senderParameters; }
void postMessage(WebFrame&, NSString *, NSString **outExceptionString);
void disconnect();
bool isDisconnected() const { return m_disconnected; }
bool isQuarantined() const { return !m_channelIdentifier; }
NSString *name();
NSDictionary *sender();
JSValue *error();
void setError(JSValue *);
WebExtensionAPIEvent& onMessage();
WebExtensionAPIEvent& onDisconnect();
virtual ~WebExtensionAPIPort()
{
// Don't fire the disconnect event, since this port is being finalized
// and we can't call into JavaScript during garbage collection.
m_disconnected = true;
remove();
}
private:
friend class WebExtensionContextProxy;
explicit WebExtensionAPIPort(const WebExtensionAPIObject& parentObject, const String& name)
: WebExtensionAPIObject(parentObject)
, m_targetContentWorldType(WebExtensionContentWorldType::Main)
, m_name(name)
{
ASSERT(isQuarantined());
}
explicit WebExtensionAPIPort(const WebExtensionAPIObject& parentObject, WebPageProxyIdentifier owningPageProxyIdentifier, WebExtensionContentWorldType targetContentWorldType, const String& name)
: WebExtensionAPIObject(parentObject)
, m_targetContentWorldType(targetContentWorldType)
, m_owningPageProxyIdentifier(owningPageProxyIdentifier)
, m_channelIdentifier(WebExtensionPortChannelIdentifier::generate())
, m_name(name)
{
add();
}
explicit WebExtensionAPIPort(WebExtensionContentWorldType contentWorldType, WebExtensionAPIRuntimeBase& runtime, WebExtensionContextProxy& context, WebPageProxyIdentifier owningPageProxyIdentifier, WebExtensionContentWorldType targetContentWorldType, const String& name)
: WebExtensionAPIObject(contentWorldType, runtime, context)
, m_targetContentWorldType(targetContentWorldType)
, m_owningPageProxyIdentifier(owningPageProxyIdentifier)
, m_channelIdentifier(WebExtensionPortChannelIdentifier::generate())
, m_name(name)
{
add();
}
explicit WebExtensionAPIPort(const WebExtensionAPIObject& parentObject, WebPageProxyIdentifier owningPageProxyIdentifier, WebExtensionContentWorldType targetContentWorldType, const String& name, const WebExtensionMessageSenderParameters& senderParameters)
: WebExtensionAPIObject(parentObject)
, m_targetContentWorldType(targetContentWorldType)
, m_owningPageProxyIdentifier(owningPageProxyIdentifier)
, m_channelIdentifier(WebExtensionPortChannelIdentifier::generate())
, m_name(name)
, m_senderParameters(senderParameters)
{
add();
}
explicit WebExtensionAPIPort(const WebExtensionAPIObject& parentObject, WebPageProxyIdentifier owningPageProxyIdentifier, WebExtensionContentWorldType targetContentWorldType, WebExtensionPortChannelIdentifier channelIdentifier, const String& name, const WebExtensionMessageSenderParameters& senderParameters)
: WebExtensionAPIObject(parentObject)
, m_targetContentWorldType(targetContentWorldType)
, m_owningPageProxyIdentifier(owningPageProxyIdentifier)
, m_channelIdentifier(channelIdentifier)
, m_name(name)
, m_senderParameters(senderParameters)
{
add();
}
void add();
void remove();
void fireMessageEventIfNeeded(id message);
void fireDisconnectEventIfNeeded();
WebExtensionContentWorldType m_targetContentWorldType;
Markable<WebPageProxyIdentifier> m_owningPageProxyIdentifier;
Markable<WebExtensionPortChannelIdentifier> m_channelIdentifier;
bool m_disconnected { false };
String m_name;
RetainPtr<JSValue> m_error;
std::optional<WebExtensionMessageSenderParameters> m_senderParameters;
RefPtr<WebExtensionAPIEvent> m_onMessage;
RefPtr<WebExtensionAPIEvent> m_onDisconnect;
#endif
};
} // namespace WebKit
#endif // ENABLE(WK_WEB_EXTENSIONS)
|
