d45a0e3f6dc9bbaec51a1c981719258d7dd69ba6
[WebKit-https.git] / Source / WebCore / loader / ResourceLoader.h
1 /*
2  * Copyright (C) 2005-2017 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #pragma once
30
31 #include "LoadTiming.h"
32 #include "ResourceHandleClient.h"
33 #include "ResourceLoaderOptions.h"
34 #include "ResourceLoaderTypes.h"
35 #include "ResourceRequest.h"
36 #include "ResourceResponse.h"
37 #include <wtf/Forward.h>
38
39 #if ENABLE(CONTENT_EXTENSIONS)
40 #include "ResourceLoadInfo.h"
41 #endif
42
43 namespace WTF {
44 class SchedulePair;
45 }
46
47 namespace WebCore {
48
49 class AuthenticationChallenge;
50 class DocumentLoader;
51 class Frame;
52 class FrameLoader;
53 class NetworkLoadMetrics;
54 class PreviewLoader;
55 class URL;
56
57 class ResourceLoader : public RefCounted<ResourceLoader>, protected ResourceHandleClient {
58 public:
59     virtual ~ResourceLoader() = 0;
60
61     WEBCORE_EXPORT void cancel();
62
63     virtual void init(ResourceRequest&&, CompletionHandler<void(bool)>&&);
64
65     void deliverResponseAndData(const ResourceResponse&, RefPtr<SharedBuffer>&&);
66
67 #if PLATFORM(IOS)
68     virtual void startLoading()
69     {
70         start();
71     }
72
73     virtual const ResourceRequest& iOSOriginalRequest() const { return request(); }
74 #endif
75
76     WEBCORE_EXPORT FrameLoader* frameLoader() const;
77     DocumentLoader* documentLoader() const { return m_documentLoader.get(); }
78     const ResourceRequest& originalRequest() const { return m_originalRequest; }
79
80     WEBCORE_EXPORT void start();
81     WEBCORE_EXPORT void cancel(const ResourceError&);
82     WEBCORE_EXPORT ResourceError cancelledError();
83     ResourceError blockedError();
84     ResourceError blockedByContentBlockerError();
85     ResourceError cannotShowURLError();
86     
87     virtual void setDefersLoading(bool);
88     bool defersLoading() const { return m_defersLoading; }
89
90     unsigned long identifier() const { return m_identifier; }
91
92     bool wasAuthenticationChallengeBlocked() const { return m_wasAuthenticationChallengeBlocked; }
93
94     virtual void releaseResources();
95     const ResourceResponse& response() const { return m_response; }
96
97     SharedBuffer* resourceData() const { return m_resourceData.get(); }
98     void clearResourceData();
99     
100     virtual bool isSubresourceLoader() const;
101
102     virtual void willSendRequest(ResourceRequest&&, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&& callback);
103     virtual void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent);
104     virtual void didReceiveResponse(const ResourceResponse&, CompletionHandler<void()>&& policyCompletionHandler);
105     virtual void didReceiveData(const char*, unsigned, long long encodedDataLength, DataPayloadType);
106     virtual void didReceiveBuffer(Ref<SharedBuffer>&&, long long encodedDataLength, DataPayloadType);
107     virtual void didFinishLoading(const NetworkLoadMetrics&);
108     virtual void didFail(const ResourceError&);
109     virtual void didRetrieveDerivedDataFromCache(const String& type, SharedBuffer&);
110
111     WEBCORE_EXPORT void didBlockAuthenticationChallenge();
112
113     virtual bool shouldUseCredentialStorage();
114 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
115     virtual bool canAuthenticateAgainstProtectionSpace(const ProtectionSpace&);
116 #endif
117     virtual void receivedCancellation(const AuthenticationChallenge&);
118
119 #if USE(QUICK_LOOK)
120     bool isQuickLookResource() const;
121 #endif
122
123     const URL& url() const { return m_request.url(); }
124     ResourceHandle* handle() const { return m_handle.get(); }
125     bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
126     void setSendCallbackPolicy(SendCallbackPolicy sendLoadCallbacks) { m_options.sendLoadCallbacks = sendLoadCallbacks; }
127     bool shouldSniffContent() const { return m_options.sniffContent == SniffContent; }
128     bool shouldSniffContentEncoding() const { return m_options.sniffContentEncoding == ContentEncodingSniffingPolicy::Sniff; }
129     WEBCORE_EXPORT bool isAllowedToAskUserForCredentials() const;
130     bool shouldIncludeCertificateInfo() const { return m_options.certificateInfoPolicy == IncludeCertificateInfo; }
131
132     bool reachedTerminalState() const { return m_reachedTerminalState; }
133
134
135     const ResourceRequest& request() const { return m_request; }
136
137     void setDataBufferingPolicy(DataBufferingPolicy);
138
139     void willSwitchToSubstituteResource();
140
141     const LoadTiming& loadTiming() { return m_loadTiming; }
142
143 #if PLATFORM(COCOA)
144     void schedule(WTF::SchedulePair&);
145     void unschedule(WTF::SchedulePair&);
146 #endif
147
148     const Frame* frame() const { return m_frame.get(); }
149     WEBCORE_EXPORT bool isAlwaysOnLoggingAllowed() const;
150
151     const ResourceLoaderOptions& options() const { return m_options; }
152
153 protected:
154     ResourceLoader(Frame&, ResourceLoaderOptions);
155
156     void didFinishLoadingOnePart(const NetworkLoadMetrics&);
157     void cleanupForError(const ResourceError&);
158
159     bool wasCancelled() const { return m_cancellationStatus >= Cancelled; }
160
161     void didReceiveDataOrBuffer(const char*, unsigned, RefPtr<SharedBuffer>&&, long long encodedDataLength, DataPayloadType);
162
163 #if PLATFORM(COCOA)
164     NSCachedURLResponse* willCacheResponse(ResourceHandle*, NSCachedURLResponse*) override;
165 #endif
166
167     virtual void willSendRequestInternal(ResourceRequest&&, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&&);
168
169     RefPtr<ResourceHandle> m_handle;
170     RefPtr<Frame> m_frame;
171     RefPtr<DocumentLoader> m_documentLoader;
172     ResourceResponse m_response;
173     LoadTiming m_loadTiming;
174 #if USE(QUICK_LOOK)
175     std::unique_ptr<PreviewLoader> m_previewLoader;
176 #endif
177     bool m_canCrossOriginRequestsAskUserForCredentials { true };
178
179 private:
180     virtual void willCancel(const ResourceError&) = 0;
181     virtual void didCancel(const ResourceError&) = 0;
182
183     void addDataOrBuffer(const char*, unsigned, SharedBuffer*, DataPayloadType);
184     void loadDataURL();
185     void finishNetworkLoad();
186
187     bool shouldAllowResourceToAskForCredentials() const;
188
189     // ResourceHandleClient
190     void didSendData(ResourceHandle*, unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override;
191     void didReceiveResponseAsync(ResourceHandle*, ResourceResponse&&, CompletionHandler<void()>&&) override;
192     void willSendRequestAsync(ResourceHandle*, ResourceRequest&&, ResourceResponse&&, CompletionHandler<void(ResourceRequest&&)>&&) override;
193     void didReceiveData(ResourceHandle*, const char*, unsigned, int encodedDataLength) override;
194     void didReceiveBuffer(ResourceHandle*, Ref<SharedBuffer>&&, int encodedDataLength) override;
195     void didFinishLoading(ResourceHandle*) override;
196     void didFail(ResourceHandle*, const ResourceError&) override;
197     void wasBlocked(ResourceHandle*) override;
198     void cannotShowURL(ResourceHandle*) override;
199     bool shouldUseCredentialStorage(ResourceHandle*) override { return shouldUseCredentialStorage(); }
200     void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge&) override;
201 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
202     void canAuthenticateAgainstProtectionSpaceAsync(ResourceHandle*, const ProtectionSpace&) override;
203 #endif
204     void receivedCancellation(ResourceHandle*, const AuthenticationChallenge& challenge) override { receivedCancellation(challenge); }
205 #if PLATFORM(IOS)
206     RetainPtr<CFDictionaryRef> connectionProperties(ResourceHandle*) override;
207 #endif
208 #if USE(CFURLCONNECTION)
209     // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
210     bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef) override;
211 #endif
212
213     ResourceRequest m_request;
214     ResourceRequest m_originalRequest; // Before redirects.
215     RefPtr<SharedBuffer> m_resourceData;
216     
217     unsigned long m_identifier { 0 };
218
219     bool m_reachedTerminalState { false };
220     bool m_notifiedLoadComplete { false };
221
222     enum CancellationStatus {
223         NotCancelled,
224         CalledWillCancel,
225         Cancelled,
226         FinishedCancel
227     };
228     CancellationStatus m_cancellationStatus { NotCancelled };
229
230     bool m_defersLoading;
231     bool m_wasAuthenticationChallengeBlocked { false };
232     ResourceRequest m_deferredRequest;
233     ResourceLoaderOptions m_options;
234
235 #if ENABLE(CONTENT_EXTENSIONS)
236 protected:
237     ResourceType m_resourceType { ResourceType::Invalid };
238 #endif
239 };
240
241 } // namespace WebCore