WebKit.ApplicationManifestBasic API test is failing when enabling PSON
[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 "WebBackForwardListItem.h"
31 #include <WebCore/Process.h>
32 #include <WebCore/ResourceRequest.h>
33 #include <WebCore/SecurityOriginData.h>
34 #include <wtf/Ref.h>
35
36 namespace WebCore {
37 enum class FrameLoadType : uint8_t;
38 }
39
40 namespace WebKit {
41 class WebNavigationState;
42 }
43
44 namespace API {
45
46 struct SubstituteData {
47     WTF_MAKE_FAST_ALLOCATED;
48 public:
49     SubstituteData(Vector<uint8_t>&& content, const WTF::String& MIMEType, const WTF::String& encoding, const WTF::String& baseURL, API::Object* userData)
50         : content(WTFMove(content))
51         , MIMEType(MIMEType)
52         , encoding(encoding)
53         , baseURL(baseURL)
54         , userData(userData)
55     { }
56
57     Vector<uint8_t> content;
58     WTF::String MIMEType;
59     WTF::String encoding;
60     WTF::String baseURL;
61     RefPtr<API::Object> userData;
62 };
63
64 class Navigation : public ObjectImpl<Object::Type::Navigation> {
65     WTF_MAKE_NONCOPYABLE(Navigation);
66 public:
67     static Ref<Navigation> create(WebKit::WebNavigationState& state)
68     {
69         return adoptRef(*new Navigation(state));
70     }
71
72     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebKit::WebBackForwardListItem& targetItem, WebKit::WebBackForwardListItem* fromItem, WebCore::FrameLoadType backForwardFrameLoadType)
73     {
74         return adoptRef(*new Navigation(state, targetItem, fromItem, backForwardFrameLoadType));
75     }
76
77     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebCore::ResourceRequest&& request, WebKit::WebBackForwardListItem* fromItem)
78     {
79         return adoptRef(*new Navigation(state, WTFMove(request), fromItem));
80     }
81
82     static Ref<Navigation> create(WebKit::WebNavigationState& state, std::unique_ptr<SubstituteData>&& substituteData)
83     {
84         return adoptRef(*new Navigation(state, WTFMove(substituteData)));
85     }
86
87     virtual ~Navigation();
88
89     uint64_t navigationID() const { return m_navigationID; }
90
91     const WebCore::ResourceRequest& originalRequest() const { return m_originalRequest; }
92     void setCurrentRequest(WebCore::ResourceRequest&&, WebCore::ProcessIdentifier);
93     const WebCore::ResourceRequest& currentRequest() const { return m_currentRequest; }
94     std::optional<WebCore::ProcessIdentifier> currentRequestProcessIdentifier() const { return m_currentRequestProcessIdentifier; }
95
96     void setCurrentRequestIsRedirect(bool isRedirect) { m_isRedirect = isRedirect; }
97     bool currentRequestIsRedirect() const { return m_isRedirect; }
98
99     void setTargetItem(WebKit::WebBackForwardListItem& item) { m_targetItem = &item; }
100     WebKit::WebBackForwardListItem* targetItem() const { return m_targetItem.get(); }
101     WebKit::WebBackForwardListItem* fromItem() const { return m_fromItem.get(); }
102     std::optional<WebCore::FrameLoadType> backForwardFrameLoadType() const { return m_backForwardFrameLoadType; }
103
104     void appendRedirectionURL(const WebCore::URL&);
105     Vector<WebCore::URL> takeRedirectChain() { return WTFMove(m_redirectChain); }
106
107     void setWasUserInitiated(bool value) { m_wasUserInitiated = value; }
108     bool wasUserInitiated() const { return m_wasUserInitiated; }
109
110     void setShouldForceDownload(bool value) { m_shouldForceDownload = value; }
111     bool shouldForceDownload() const { return m_shouldForceDownload; }
112
113     void setTreatAsSameOriginNavigation(bool value) { m_treatAsSameOriginNavigation = value; }
114     bool treatAsSameOriginNavigation() const { return m_treatAsSameOriginNavigation; }
115
116     void setHasOpenedFrames(bool value) { m_hasOpenedFrames = value; }
117     bool hasOpenedFrames() const { return m_hasOpenedFrames; }
118
119     bool openedViaWindowOpenWithOpener() const { return m_openedViaWindowOpenWithOpener; }
120     void setOpenedViaWindowOpenWithOpener() { m_openedViaWindowOpenWithOpener = true; }
121
122     void setOpener(const std::optional<std::pair<uint64_t, uint64_t>>& opener) { m_opener = opener; }
123     const std::optional<std::pair<uint64_t, uint64_t>>& opener() const { return m_opener; }
124
125     void setRequesterOrigin(const WebCore::SecurityOriginData& origin) { m_requesterOrigin = origin; }
126     const WebCore::SecurityOriginData& requesterOrigin() const { return m_requesterOrigin; }
127
128     void setLockHistory(WebCore::LockHistory lockHistory) { m_lockHistory = lockHistory; }
129     WebCore::LockHistory lockHistory() const { return m_lockHistory; }
130
131     void setLockBackForwardList(WebCore::LockBackForwardList lockBackForwardList) { m_lockBackForwardList = lockBackForwardList; }
132     WebCore::LockBackForwardList lockBackForwardList() const { return m_lockBackForwardList; }
133
134     void setClientRedirectSourceForHistory(const WTF::String& clientRedirectSourceForHistory) { m_clientRedirectSourceForHistory = clientRedirectSourceForHistory; }
135     WTF::String clientRedirectSourceForHistory() const { return m_clientRedirectSourceForHistory; }
136
137 #if !LOG_DISABLED
138     const char* loggingString() const;
139 #endif
140
141     const std::unique_ptr<SubstituteData>& substituteData() const { return m_substituteData; }
142
143 private:
144     explicit Navigation(WebKit::WebNavigationState&);
145     Navigation(WebKit::WebNavigationState&, WebCore::ResourceRequest&&, WebKit::WebBackForwardListItem* fromItem);
146     Navigation(WebKit::WebNavigationState&, WebKit::WebBackForwardListItem& targetItem, WebKit::WebBackForwardListItem* fromItem, WebCore::FrameLoadType);
147     Navigation(WebKit::WebNavigationState&, std::unique_ptr<SubstituteData>&&);
148
149     uint64_t m_navigationID;
150     WebCore::ResourceRequest m_originalRequest;
151     WebCore::ResourceRequest m_currentRequest;
152     std::optional<WebCore::ProcessIdentifier> m_currentRequestProcessIdentifier;
153     Vector<WebCore::URL> m_redirectChain;
154     bool m_wasUserInitiated { true };
155     bool m_shouldForceDownload { false };
156     bool m_isRedirect { false };
157
158     RefPtr<WebKit::WebBackForwardListItem> m_targetItem;
159     RefPtr<WebKit::WebBackForwardListItem> m_fromItem;
160     std::optional<WebCore::FrameLoadType> m_backForwardFrameLoadType;
161     bool m_treatAsSameOriginNavigation { false };
162     bool m_hasOpenedFrames { false };
163     bool m_openedViaWindowOpenWithOpener { false };
164     std::optional<std::pair<uint64_t, uint64_t>> m_opener;
165     WebCore::SecurityOriginData m_requesterOrigin;
166     WebCore::LockHistory m_lockHistory;
167     WebCore::LockBackForwardList m_lockBackForwardList;
168     WTF::String m_clientRedirectSourceForHistory;
169     std::unique_ptr<SubstituteData> m_substituteData;
170 };
171
172 } // namespace API