Process swapping on navigation needs to handle server redirects.
[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 <WebCore/Process.h>
30 #include <WebCore/ResourceRequest.h>
31 #include <wtf/Ref.h>
32
33 namespace WebCore {
34 enum class FrameLoadType;
35 }
36
37 namespace WebKit {
38 class WebBackForwardListItem;
39 class WebNavigationState;
40 }
41
42 namespace API {
43
44 class Navigation : public ObjectImpl<Object::Type::Navigation> {
45     WTF_MAKE_NONCOPYABLE(Navigation);
46 public:
47     static Ref<Navigation> create(WebKit::WebNavigationState& state)
48     {
49         return adoptRef(*new Navigation(state));
50     }
51
52     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebKit::WebBackForwardListItem& item, WebCore::FrameLoadType backForwardFrameLoadType)
53     {
54         return adoptRef(*new Navigation(state, item, backForwardFrameLoadType));
55     }
56
57     static Ref<Navigation> create(WebKit::WebNavigationState& state, WebCore::ResourceRequest&& request)
58     {
59         return adoptRef(*new Navigation(state, WTFMove(request)));
60     }
61
62     virtual ~Navigation();
63
64     uint64_t navigationID() const { return m_navigationID; }
65
66     const WebCore::ResourceRequest& originalRequest() const { return m_originalRequest; }
67     void setCurrentRequest(WebCore::ResourceRequest&&, WebCore::ProcessIdentifier);
68     const WebCore::ResourceRequest& currentRequest() const { return m_currentRequest; }
69     std::optional<WebCore::ProcessIdentifier> currentRequestProcessIdentifier() const { return m_currentRequestProcessIdentifier; }
70
71     void setCurrentRequestIsRedirect(bool isRedirect) { m_isRedirect = isRedirect; }
72     bool currentRequestIsRedirect() const { return m_isRedirect; }
73
74     WebKit::WebBackForwardListItem* backForwardListItem() { return m_backForwardListItem.get(); }
75     std::optional<WebCore::FrameLoadType> backForwardFrameLoadType() const { return m_backForwardFrameLoadType; }
76
77     void appendRedirectionURL(const WebCore::URL&);
78     Vector<WebCore::URL> takeRedirectChain() { return WTFMove(m_redirectChain); }
79
80     void setWasUserInitiated(bool value) { m_wasUserInitiated = value; }
81     bool wasUserInitiated() const { return m_wasUserInitiated; }
82
83     void setShouldForceDownload(bool value) { m_shouldForceDownload = value; }
84     bool shouldForceDownload() const { return m_shouldForceDownload; }
85
86     void setIsCrossOriginWindowOpenNavigation(bool value) { m_isCrossOriginWindowOpenNavigation = value; }
87     bool isCrossOriginWindowOpenNavigation() const { return m_isCrossOriginWindowOpenNavigation; }
88
89     void setOpener(const std::optional<std::pair<uint64_t, uint64_t>>& opener) { m_opener = opener; }
90     const std::optional<std::pair<uint64_t, uint64_t>>& opener() const { return m_opener; }
91
92 #if !LOG_DISABLED
93     WTF::String loggingString() const;
94 #endif
95
96 private:
97     explicit Navigation(WebKit::WebNavigationState&);
98     Navigation(WebKit::WebNavigationState&, WebCore::ResourceRequest&&);
99     Navigation(WebKit::WebNavigationState&, WebKit::WebBackForwardListItem&, WebCore::FrameLoadType);
100
101     uint64_t m_navigationID;
102     WebCore::ResourceRequest m_originalRequest;
103     WebCore::ResourceRequest m_currentRequest;
104     std::optional<WebCore::ProcessIdentifier> m_currentRequestProcessIdentifier;
105     Vector<WebCore::URL> m_redirectChain;
106     bool m_wasUserInitiated { true };
107     bool m_shouldForceDownload { false };
108     bool m_isRedirect { false };
109
110     RefPtr<WebKit::WebBackForwardListItem> m_backForwardListItem;
111     std::optional<WebCore::FrameLoadType> m_backForwardFrameLoadType;
112     bool m_isCrossOriginWindowOpenNavigation { false };
113     std::optional<std::pair<uint64_t, uint64_t>> m_opener;
114 };
115
116 } // namespace API