Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / UIProcess / API / APINavigation.h
1 /*
2  * Copyright (C) 2015 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "APIObject.h"
29 #include "DataReference.h"
30 #include "FrameInfoData.h"
31 #include "NavigationActionData.h"
32 #include "WebBackForwardListItem.h"
33 #include <WebCore/Process.h>
34 #include <WebCore/ResourceRequest.h>
35 #include <WebCore/SecurityOriginData.h>
36 #include <wtf/Ref.h>
37
38 namespace WebCore {
39 enum class FrameLoadType : uint8_t;
40 }
41
42 namespace WebKit {
43 class WebNavigationState;
44 }
45
46 namespace API {
47
48 struct SubstituteData {
49     WTF_MAKE_FAST_ALLOCATED;
50 public:
51     SubstituteData(Vector<uint8_t>&& content, const WTF::String& MIMEType, const WTF::String& encoding, const WTF::String& baseURL, API::Object* userData)
52         : content(WTFMove(content))
53         , MIMEType(MIMEType)
54         , encoding(encoding)
55         , baseURL(baseURL)
56         , userData(userData)
57     { }
58
59     Vector<uint8_t> content;
60     WTF::String MIMEType;
61     WTF::String encoding;
62     WTF::String baseURL;
63     RefPtr<API::Object> userData;
64 };
65
66 class Navigation : public ObjectImpl<Object::Type::Navigation> {
67     WTF_MAKE_NONCOPYABLE(Navigation);
68 public:
69     static Ref<Navigation> create(WebKit::WebNavigationState& state)
70     {
71         return adoptRef(*new Navigation(state));
72     }
73
74     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebKit::WebBackForwardListItem& targetItem, WebKit::WebBackForwardListItem* fromItem, WebCore::FrameLoadType backForwardFrameLoadType)
75     {
76         return adoptRef(*new Navigation(state, targetItem, fromItem, backForwardFrameLoadType));
77     }
78
79     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebCore::ResourceRequest&& request, WebKit::WebBackForwardListItem* fromItem)
80     {
81         return adoptRef(*new Navigation(state, WTFMove(request), fromItem));
82     }
83
84     static Ref<Navigation> create(WebKit::WebNavigationState& state, std::unique_ptr<SubstituteData>&& substituteData)
85     {
86         return adoptRef(*new Navigation(state, WTFMove(substituteData)));
87     }
88
89     virtual ~Navigation();
90
91     uint64_t navigationID() const { return m_navigationID; }
92
93     const WebCore::ResourceRequest& originalRequest() const { return m_originalRequest; }
94     void setCurrentRequest(WebCore::ResourceRequest&&, WebCore::ProcessIdentifier);
95     const WebCore::ResourceRequest& currentRequest() const { return m_currentRequest; }
96     std::optional<WebCore::ProcessIdentifier> currentRequestProcessIdentifier() const { return m_currentRequestProcessIdentifier; }
97
98     bool currentRequestIsRedirect() const { return m_lastNavigationAction.isRedirect; }
99
100     void setTargetItem(WebKit::WebBackForwardListItem& item) { m_targetItem = &item; }
101     WebKit::WebBackForwardListItem* targetItem() const { return m_targetItem.get(); }
102     WebKit::WebBackForwardListItem* fromItem() const { return m_fromItem.get(); }
103     std::optional<WebCore::FrameLoadType> backForwardFrameLoadType() const { return m_backForwardFrameLoadType; }
104
105     void appendRedirectionURL(const WTF::URL&);
106     Vector<WTF::URL> takeRedirectChain() { return WTFMove(m_redirectChain); }
107
108     bool wasUserInitiated() const { return !!m_lastNavigationAction.userGestureTokenIdentifier; }
109
110     bool shouldForceDownload() const
111     {
112 #if USE(SYSTEM_PREVIEW)
113         return !m_lastNavigationAction.downloadAttribute.isNull() || currentRequest().isSystemPreview();
114 #else
115         return !m_lastNavigationAction.downloadAttribute.isNull();
116 #endif
117     }
118
119     bool treatAsSameOriginNavigation() const { return m_lastNavigationAction.treatAsSameOriginNavigation; }
120     bool hasOpenedFrames() const { return m_lastNavigationAction.hasOpenedFrames; }
121     bool openedViaWindowOpenWithOpener() const { return m_lastNavigationAction.openedViaWindowOpenWithOpener; }
122     const std::optional<std::pair<uint64_t, uint64_t>>& opener() const { return m_lastNavigationAction.opener; }
123     const WebCore::SecurityOriginData& requesterOrigin() const { return m_lastNavigationAction.requesterOrigin; }
124
125     WebCore::LockHistory lockHistory() const { return m_lastNavigationAction.lockHistory; }
126     WebCore::LockBackForwardList lockBackForwardList() const { return m_lastNavigationAction.lockBackForwardList; }
127
128     WTF::String clientRedirectSourceForHistory() const { return m_lastNavigationAction.clientRedirectSourceForHistory; }
129
130     void setLastNavigationAction(const WebKit::NavigationActionData& navigationAction) { m_lastNavigationAction = navigationAction; }
131     const WebKit::NavigationActionData& lastNavigationAction() const { return m_lastNavigationAction; }
132
133     void setOriginatingFrameInfo(const WebKit::FrameInfoData& frameInfo) { m_originatingFrameInfo = frameInfo; }
134     const WebKit::FrameInfoData& originatingFrameInfo() const { return m_originatingFrameInfo; }
135
136     void setDestinationFrameSecurityOrigin(const WebCore::SecurityOriginData& origin) { m_destinationFrameSecurityOrigin = origin; }
137     const WebCore::SecurityOriginData& destinationFrameSecurityOrigin() const { return m_destinationFrameSecurityOrigin; }
138
139 #if !LOG_DISABLED
140     const char* loggingString() const;
141 #endif
142
143     const std::unique_ptr<SubstituteData>& substituteData() const { return m_substituteData; }
144
145 private:
146     explicit Navigation(WebKit::WebNavigationState&);
147     Navigation(WebKit::WebNavigationState&, WebCore::ResourceRequest&&, WebKit::WebBackForwardListItem* fromItem);
148     Navigation(WebKit::WebNavigationState&, WebKit::WebBackForwardListItem& targetItem, WebKit::WebBackForwardListItem* fromItem, WebCore::FrameLoadType);
149     Navigation(WebKit::WebNavigationState&, std::unique_ptr<SubstituteData>&&);
150
151     uint64_t m_navigationID;
152     WebCore::ResourceRequest m_originalRequest;
153     WebCore::ResourceRequest m_currentRequest;
154     std::optional<WebCore::ProcessIdentifier> m_currentRequestProcessIdentifier;
155     Vector<WTF::URL> m_redirectChain;
156
157     RefPtr<WebKit::WebBackForwardListItem> m_targetItem;
158     RefPtr<WebKit::WebBackForwardListItem> m_fromItem;
159     std::optional<WebCore::FrameLoadType> m_backForwardFrameLoadType;
160     std::unique_ptr<SubstituteData> m_substituteData;
161     WebKit::NavigationActionData m_lastNavigationAction;
162     WebKit::FrameInfoData m_originatingFrameInfo;
163     WebCore::SecurityOriginData m_destinationFrameSecurityOrigin;
164 };
165
166 } // namespace API