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
184
185
186
|
/*
* Copyright (C) 2006-2018 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.
* 3. Neither the name of Apple Inc. ("Apple") 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 APPLE 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 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
#include "BackForwardItemIdentifier.h"
#include "CrossOriginOpenerPolicy.h"
#include "FrameLoaderTypes.h"
#include "GlobalFrameIdentifier.h"
#include "LayoutPoint.h"
#include "NavigationRequester.h"
#include "PrivateClickMeasurement.h"
#include "ResourceRequest.h"
#include "SecurityOrigin.h"
#include "UserGestureIndicator.h"
#include <wtf/Forward.h>
namespace WebCore {
class Document;
class Event;
class HistoryItem;
class MouseEvent;
class UIEventWithKeyState;
enum class SyntheticClickType : uint8_t;
enum class MouseButton : int8_t;
enum class NavigationNavigationType : uint8_t;
// NavigationAction should never hold a strong reference to the originating document either directly
// or indirectly as doing so prevents its destruction even after navigating away from it because
// DocumentLoader keeps around the NavigationAction for the last navigation.
class NavigationAction {
public:
NavigationAction();
WEBCORE_EXPORT NavigationAction(Document&, const ResourceRequest&, InitiatedByMainFrame, bool, NavigationType = NavigationType::Other, ShouldOpenExternalURLsPolicy = ShouldOpenExternalURLsPolicy::ShouldNotAllow, Event* = nullptr, const AtomString& downloadAttribute = nullAtom());
NavigationAction(Document&, const ResourceRequest&, InitiatedByMainFrame, bool, FrameLoadType, bool isFormSubmission, Event* = nullptr, ShouldOpenExternalURLsPolicy = ShouldOpenExternalURLsPolicy::ShouldNotAllow, const AtomString& downloadAttribute = nullAtom());
WEBCORE_EXPORT ~NavigationAction();
WEBCORE_EXPORT NavigationAction(const NavigationAction&);
NavigationAction& operator=(const NavigationAction&);
NavigationAction(NavigationAction&&);
NavigationAction& operator=(NavigationAction&&);
const std::optional<NavigationRequester>& requester() const { return m_requester; }
struct UIEventWithKeyStateData {
UIEventWithKeyStateData(const UIEventWithKeyState&);
bool isTrusted;
bool shiftKey;
bool ctrlKey;
bool altKey;
bool metaKey;
};
struct MouseEventData : UIEventWithKeyStateData {
MouseEventData(const MouseEvent&);
LayoutPoint absoluteLocation;
FloatPoint locationInRootViewCoordinates;
MouseButton button;
SyntheticClickType syntheticClickType;
bool buttonDown;
};
const std::optional<UIEventWithKeyStateData>& keyStateEventData() const { return m_keyStateEventData; }
const std::optional<MouseEventData>& mouseEventData() const { return m_mouseEventData; }
NavigationAction copyWithShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy) const;
bool isEmpty() const { return !m_requester || m_requester->url.isEmpty() || m_originalRequest.url().isEmpty(); }
URL url() const { return m_originalRequest.url(); }
const ResourceRequest& originalRequest() const { return m_originalRequest; }
NavigationType type() const { return m_type; }
bool processingUserGesture() const { return m_userGestureToken ? m_userGestureToken->processingUserGesture() : false; }
RefPtr<UserGestureToken> userGestureToken() const { return m_userGestureToken; }
ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy() const { return m_shouldOpenExternalURLsPolicy; }
void setShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy policy) { m_shouldOpenExternalURLsPolicy = policy; }
InitiatedByMainFrame initiatedByMainFrame() const { return m_initiatedByMainFrame; }
const AtomString& downloadAttribute() const { return m_downloadAttribute; }
bool treatAsSameOriginNavigation() const { return m_treatAsSameOriginNavigation; }
bool hasOpenedFrames() const { return m_hasOpenedFrames; }
void setHasOpenedFrames(bool value) { m_hasOpenedFrames = value; }
bool openedByDOMWithOpener() const { return m_openedByDOMWithOpener; }
void setOpenedByDOMWithOpener() { m_openedByDOMWithOpener = true; }
NewFrameOpenerPolicy newFrameOpenerPolicy() const { return m_newFrameOpenerPolicy; }
void setNewFrameOpenerPolicy(NewFrameOpenerPolicy newFrameOpenerPolicy) { m_newFrameOpenerPolicy = newFrameOpenerPolicy; }
void setTargetBackForwardItem(HistoryItem&);
const std::optional<BackForwardItemIdentifier>& targetBackForwardItemIdentifier() const { return m_targetBackForwardItemIdentifier; }
void setSourceBackForwardItem(HistoryItem*);
const std::optional<BackForwardItemIdentifier>& sourceBackForwardItemIdentifier() const { return m_sourceBackForwardItemIdentifier; }
LockHistory lockHistory() const { return m_lockHistory; }
void setLockHistory(LockHistory lockHistory) { m_lockHistory = lockHistory; }
LockBackForwardList lockBackForwardList() const { return m_lockBackForwardList; }
void setLockBackForwardList(LockBackForwardList lockBackForwardList) { m_lockBackForwardList = lockBackForwardList; }
const std::optional<PrivateClickMeasurement>& privateClickMeasurement() const { return m_privateClickMeasurement; };
void setPrivateClickMeasurement(PrivateClickMeasurement&& privateClickMeasurement) { m_privateClickMeasurement = privateClickMeasurement; };
// The shouldReplaceDocumentIfJavaScriptURL parameter will go away when the FIXME to eliminate the
// corresponding parameter from ScriptController::executeIfJavaScriptURL() is addressed.
ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL() const { return m_shouldReplaceDocumentIfJavaScriptURL; }
void setShouldReplaceDocumentIfJavaScriptURL(ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL) { m_shouldReplaceDocumentIfJavaScriptURL = shouldReplaceDocumentIfJavaScriptURL; }
bool isRequestFromClientOrUserInput() const { return m_isRequestFromClientOrUserInput; }
void setIsRequestFromClientOrUserInput(bool isRequestFromClientOrUserInput) { m_isRequestFromClientOrUserInput = isRequestFromClientOrUserInput; }
bool isInitialFrameSrcLoad() const { return m_isInitialFrameSrcLoad; }
void setIsInitialFrameSrcLoad(bool isInitialFrameSrcLoad) { m_isInitialFrameSrcLoad = isInitialFrameSrcLoad; }
std::optional<NavigationNavigationType> navigationAPIType() const { return m_navigationAPIType; }
void setNavigationAPIType(NavigationNavigationType navigationAPIType) { m_navigationAPIType = navigationAPIType; }
bool isFromNavigationAPI() const { return m_isFromNavigationAPI; }
void setIsFromNavigationAPI(bool isFromNavigationAPI) { m_isFromNavigationAPI = isFromNavigationAPI; }
private:
// Do not add a strong reference to the originating document or a subobject that holds the
// originating document. See comment above the class for more details.
std::optional<NavigationRequester> m_requester;
ResourceRequest m_originalRequest;
std::optional<UIEventWithKeyStateData> m_keyStateEventData;
std::optional<MouseEventData> m_mouseEventData;
RefPtr<UserGestureToken> m_userGestureToken { UserGestureIndicator::currentUserGesture() };
AtomString m_downloadAttribute;
std::optional<BackForwardItemIdentifier> m_targetBackForwardItemIdentifier;
std::optional<BackForwardItemIdentifier> m_sourceBackForwardItemIdentifier;
std::optional<PrivateClickMeasurement> m_privateClickMeasurement;
ShouldReplaceDocumentIfJavaScriptURL m_shouldReplaceDocumentIfJavaScriptURL { ReplaceDocumentIfJavaScriptURL };
NavigationType m_type;
std::optional<NavigationNavigationType> m_navigationAPIType;
ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy;
InitiatedByMainFrame m_initiatedByMainFrame;
bool m_treatAsSameOriginNavigation { false };
bool m_hasOpenedFrames { false };
bool m_openedByDOMWithOpener { false };
bool m_isRequestFromClientOrUserInput { false };
bool m_isInitialFrameSrcLoad { false };
LockHistory m_lockHistory { LockHistory::No };
LockBackForwardList m_lockBackForwardList { LockBackForwardList::No };
NewFrameOpenerPolicy m_newFrameOpenerPolicy { NewFrameOpenerPolicy::Allow };
bool m_isFromNavigationAPI { false };
};
} // namespace WebCore
|
