[WK2] Add API to query if a download was user-initiated
[WebKit-https.git] / Source / WebKit / UIProcess / WebFrameProxy.h
1 /*
2  * Copyright (C) 2010 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 "FrameLoadState.h"
30 #include "GenericCallback.h"
31 #include "WebFrameListenerProxy.h"
32 #include <WebCore/FrameLoaderTypes.h>
33 #include <wtf/Forward.h>
34 #include <wtf/Function.h>
35 #include <wtf/text/WTFString.h>
36
37 #if ENABLE(CONTENT_FILTERING)
38 #include <WebCore/ContentFilterUnblockHandler.h>
39 #endif
40
41 namespace API {
42 class Navigation;
43 }
44
45 namespace IPC {
46 class Connection;
47 class Decoder;
48 }
49
50 namespace WebKit {
51 class WebCertificateInfo;
52 class WebFramePolicyListenerProxy;
53 class WebPageProxy;
54 struct WebsitePolicies;
55
56 typedef GenericCallback<API::Data*> DataCallback;
57
58 class WebFrameProxy : public API::ObjectImpl<API::Object::Type::Frame> {
59 public:
60     static Ref<WebFrameProxy> create(WebPageProxy* page, uint64_t frameID)
61     {
62         return adoptRef(*new WebFrameProxy(page, frameID));
63     }
64
65     virtual ~WebFrameProxy();
66
67     uint64_t frameID() const { return m_frameID; }
68     WebPageProxy* page() const { return m_page; }
69
70     void webProcessWillShutDown();
71
72     bool isMainFrame() const;
73
74     void setIsFrameSet(bool value) { m_isFrameSet = value; }
75     bool isFrameSet() const { return m_isFrameSet; }
76
77     FrameLoadState& frameLoadState() { return m_frameLoadState; }
78
79     void loadURL(const WebCore::URL&);
80     void stopLoading() const;
81
82     const WebCore::URL& url() const { return m_frameLoadState.url(); }
83     const WebCore::URL& provisionalURL() const { return m_frameLoadState.provisionalURL(); }
84
85     void setUnreachableURL(const WebCore::URL&);
86     const WebCore::URL& unreachableURL() const { return m_frameLoadState.unreachableURL(); }
87
88     const String& mimeType() const { return m_MIMEType; }
89     bool containsPluginDocument() const { return m_containsPluginDocument; }
90
91     const String& title() const { return m_title; }
92
93     WebCertificateInfo* certificateInfo() const { return m_certificateInfo.get(); }
94
95     bool canProvideSource() const;
96     bool canShowMIMEType(const String& mimeType) const;
97
98     bool isDisplayingStandaloneImageDocument() const;
99     bool isDisplayingStandaloneMediaDocument() const;
100     bool isDisplayingMarkupDocument() const;
101     bool isDisplayingPDFDocument() const;
102
103     void getWebArchive(Function<void (API::Data*, CallbackBase::Error)>&&);
104     void getMainResourceData(Function<void (API::Data*, CallbackBase::Error)>&&);
105     void getResourceData(API::URL*, Function<void (API::Data*, CallbackBase::Error)>&&);
106
107     void didStartProvisionalLoad(const WebCore::URL&);
108     void didReceiveServerRedirectForProvisionalLoad(const WebCore::URL&);
109     void didFailProvisionalLoad();
110     void didCommitLoad(const String& contentType, WebCertificateInfo&, bool containsPluginDocument);
111     void didFinishLoad();
112     void didFailLoad();
113     void didSameDocumentNavigation(const WebCore::URL&); // eg. anchor navigation, session state change.
114     void didChangeTitle(const String&);
115
116     // Policy operations.
117     void receivedPolicyDecision(WebCore::PolicyAction, uint64_t listenerID, API::Navigation*, const WebsitePolicies&);
118     WebFramePolicyListenerProxy& setUpPolicyListenerProxy(uint64_t listenerID);
119
120 #if ENABLE(CONTENT_FILTERING)
121     void contentFilterDidBlockLoad(WebCore::ContentFilterUnblockHandler contentFilterUnblockHandler) { m_contentFilterUnblockHandler = WTFMove(contentFilterUnblockHandler); }
122     bool didHandleContentFilterUnblockNavigation(const WebCore::ResourceRequest&);
123 #endif
124
125 #if PLATFORM(GTK)
126     void collapseSelection();
127 #endif
128
129 private:
130     WebFrameProxy(WebPageProxy* page, uint64_t frameID);
131
132     WebPageProxy* m_page;
133
134     FrameLoadState m_frameLoadState;
135
136     String m_MIMEType;
137     String m_title;
138     bool m_isFrameSet;
139     bool m_containsPluginDocument { false };
140     RefPtr<WebCertificateInfo> m_certificateInfo;
141     RefPtr<WebFrameListenerProxy> m_activeListener;
142     uint64_t m_frameID;
143 #if ENABLE(CONTENT_FILTERING)
144     WebCore::ContentFilterUnblockHandler m_contentFilterUnblockHandler;
145 #endif
146 };
147
148 } // namespace WebKit