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