REGRESSION(PSON, r240660): Navigation over process boundary is flashy when using...
[WebKit-https.git] / Source / WebCore / loader / NavigationAction.cpp
1 /*
2  * Copyright (C) 2006-2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "NavigationAction.h"
31
32 #include "Document.h"
33 #include "FrameLoader.h"
34 #include "FrameLoaderClient.h"
35 #include "HistoryItem.h"
36 #include "MouseEvent.h"
37
38 namespace WebCore {
39
40 NavigationAction::Requester::Requester(const Document& document)
41     : m_url { URL { document.url() } }
42     , m_origin { makeRefPtr(document.securityOrigin()) }
43     , m_pageIDAndFrameIDPair { document.frame() ? std::make_pair(document.frame()->loader().client().pageID().valueOr(0), document.frame()->loader().client().frameID().valueOr(0)) : std::make_pair<uint64_t, uint64_t>(0, 0) }
44 {
45 }
46
47 NavigationAction::UIEventWithKeyStateData::UIEventWithKeyStateData(const UIEventWithKeyState& uiEvent)
48     : isTrusted { uiEvent.isTrusted() }
49     , shiftKey { uiEvent.shiftKey() }
50     , ctrlKey { uiEvent.ctrlKey() }
51     , altKey { uiEvent.altKey() }
52     , metaKey { uiEvent.metaKey() }
53 {
54 }
55
56 NavigationAction::MouseEventData::MouseEventData(const MouseEvent& mouseEvent)
57     : UIEventWithKeyStateData { mouseEvent }
58     , absoluteLocation { mouseEvent.absoluteLocation() }
59     , locationInRootViewCoordinates { mouseEvent.locationInRootViewCoordinates() }
60     , button { mouseEvent.button() }
61     , syntheticClickType { mouseEvent.syntheticClickType() }
62     , buttonDown { mouseEvent.buttonDown() }
63 {
64 }
65
66 NavigationAction::NavigationAction() = default;
67 NavigationAction::~NavigationAction() = default;
68
69 NavigationAction::NavigationAction(const NavigationAction&) = default;
70 NavigationAction::NavigationAction(NavigationAction&&) = default;
71
72 NavigationAction& NavigationAction::operator=(const NavigationAction&) = default;
73 NavigationAction& NavigationAction::operator=(NavigationAction&&) = default;
74
75 static bool shouldTreatAsSameOriginNavigation(const Document& document, const URL& url)
76 {
77     return url.protocolIsAbout() || url.protocolIsData() || (url.protocolIsBlob() && document.securityOrigin().canRequest(url));
78 }
79
80 static Optional<NavigationAction::UIEventWithKeyStateData> keyStateDataForFirstEventWithKeyState(Event* event)
81 {
82     if (UIEventWithKeyState* uiEvent = findEventWithKeyState(event))
83         return NavigationAction::UIEventWithKeyStateData { *uiEvent };
84     return WTF::nullopt;
85 }
86
87 static Optional<NavigationAction::MouseEventData> mouseEventDataForFirstMouseEvent(Event* event)
88 {
89     for (Event* e = event; e; e = e->underlyingEvent()) {
90         if (e->isMouseEvent())
91             return NavigationAction::MouseEventData { static_cast<const MouseEvent&>(*e) };
92     }
93     return WTF::nullopt;
94 }
95
96 NavigationAction::NavigationAction(Document& requester, const ResourceRequest& resourceRequest, InitiatedByMainFrame initiatedByMainFrame, NavigationType type, ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy, Event* event, const AtomicString& downloadAttribute)
97     : m_requester { requester }
98     , m_resourceRequest { resourceRequest }
99     , m_type { type }
100     , m_shouldOpenExternalURLsPolicy { shouldOpenExternalURLsPolicy }
101     , m_initiatedByMainFrame { initiatedByMainFrame }
102     , m_keyStateEventData { keyStateDataForFirstEventWithKeyState(event) }
103     , m_mouseEventData { mouseEventDataForFirstMouseEvent(event) }
104     , m_downloadAttribute { downloadAttribute }
105     , m_treatAsSameOriginNavigation { shouldTreatAsSameOriginNavigation(requester, resourceRequest.url()) }
106 {
107 }
108
109 static NavigationType navigationType(FrameLoadType frameLoadType, bool isFormSubmission, bool haveEvent)
110 {
111     if (isFormSubmission)
112         return NavigationType::FormSubmitted;
113     if (haveEvent)
114         return NavigationType::LinkClicked;
115     if (isReload(frameLoadType))
116         return NavigationType::Reload;
117     if (isBackForwardLoadType(frameLoadType))
118         return NavigationType::BackForward;
119     return NavigationType::Other;
120 }
121
122 NavigationAction::NavigationAction(Document& requester, const ResourceRequest& resourceRequest, InitiatedByMainFrame initiatedByMainFrame, FrameLoadType frameLoadType, bool isFormSubmission, Event* event, ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy, const AtomicString& downloadAttribute)
123     : m_requester { requester }
124     , m_resourceRequest { resourceRequest }
125     , m_type { navigationType(frameLoadType, isFormSubmission, !!event) }
126     , m_shouldOpenExternalURLsPolicy { shouldOpenExternalURLsPolicy }
127     , m_initiatedByMainFrame { initiatedByMainFrame }
128     , m_keyStateEventData { keyStateDataForFirstEventWithKeyState(event) }
129     , m_mouseEventData { mouseEventDataForFirstMouseEvent(event) }
130     , m_downloadAttribute { downloadAttribute }
131     , m_treatAsSameOriginNavigation { shouldTreatAsSameOriginNavigation(requester, resourceRequest.url()) }
132 {
133 }
134
135 NavigationAction NavigationAction::copyWithShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy) const
136 {
137     NavigationAction result(*this);
138     result.m_shouldOpenExternalURLsPolicy = shouldOpenExternalURLsPolicy;
139     return result;
140 }
141
142 void NavigationAction::setTargetBackForwardItem(HistoryItem& item)
143 {
144     m_targetBackForwardItemIdentifier = item.identifier();
145 }
146
147 void NavigationAction::setSourceBackForwardItem(HistoryItem* item)
148 {
149     m_sourceBackForwardItemIdentifier = item ? makeOptional(item->identifier()) : WTF::nullopt;
150 }
151
152 }