Remove Cocoa CFURLConnection loading code
[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     virtual void releaseResources();
93     const ResourceResponse& response() const { return m_response; }
94
95     SharedBuffer* resourceData() const { return m_resourceData.get(); }
96     void clearResourceData();
97     
98     virtual bool isSubresourceLoader();
99
100     virtual void willSendRequest(ResourceRequest&&, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&& callback);
101     virtual void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent);
102     virtual void didReceiveResponse(const ResourceResponse&);
103     virtual void didReceiveData(const char*, unsigned, long long encodedDataLength, DataPayloadType);
104     virtual void didReceiveBuffer(Ref<SharedBuffer>&&, long long encodedDataLength, DataPayloadType);
105     virtual void didFinishLoading(const NetworkLoadMetrics&);
106     virtual void didFail(const ResourceError&);
107     virtual void didRetrieveDerivedDataFromCache(const String& type, SharedBuffer&);
108
109     virtual bool shouldUseCredentialStorage();
110     virtual void didReceiveAuthenticationChallenge(const AuthenticationChallenge&);
111 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
112     virtual bool canAuthenticateAgainstProtectionSpace(const ProtectionSpace&);
113 #endif
114     virtual void receivedCancellation(const AuthenticationChallenge&);
115
116 #if USE(QUICK_LOOK)
117     bool isQuickLookResource() const;
118 #endif
119
120     const URL& url() const { return m_request.url(); }
121     ResourceHandle* handle() const { return m_handle.get(); }
122     bool shouldSendResourceLoadCallbacks() const { return m_options.sendLoadCallbacks == SendCallbacks; }
123     void setSendCallbackPolicy(SendCallbackPolicy sendLoadCallbacks) { m_options.sendLoadCallbacks = sendLoadCallbacks; }
124     bool shouldSniffContent() const { return m_options.sniffContent == SniffContent; }
125     bool shouldSniffContentEncoding() const { return m_options.sniffContentEncoding == ContentEncodingSniffingPolicy::Sniff; }
126     WEBCORE_EXPORT bool isAllowedToAskUserForCredentials() const;
127     bool shouldIncludeCertificateInfo() const { return m_options.certificateInfoPolicy == IncludeCertificateInfo; }
128
129     bool reachedTerminalState() const { return m_reachedTerminalState; }
130
131
132     const ResourceRequest& request() const { return m_request; }
133
134     void setDataBufferingPolicy(DataBufferingPolicy);
135
136     void willSwitchToSubstituteResource();
137
138     const LoadTiming& loadTiming() { return m_loadTiming; }
139
140 #if PLATFORM(COCOA)
141     void schedule(WTF::SchedulePair&);
142     void unschedule(WTF::SchedulePair&);
143 #endif
144
145     const Frame* frame() const { return m_frame.get(); }
146     WEBCORE_EXPORT bool isAlwaysOnLoggingAllowed() const;
147
148     const ResourceLoaderOptions& options() const { return m_options; }
149
150 protected:
151     ResourceLoader(Frame&, ResourceLoaderOptions);
152
153     void didFinishLoadingOnePart(const NetworkLoadMetrics&);
154     void cleanupForError(const ResourceError&);
155
156     bool wasCancelled() const { return m_cancellationStatus >= Cancelled; }
157
158     void didReceiveDataOrBuffer(const char*, unsigned, RefPtr<SharedBuffer>&&, long long encodedDataLength, DataPayloadType);
159
160 #if PLATFORM(COCOA)
161     NSCachedURLResponse* willCacheResponse(ResourceHandle*, NSCachedURLResponse*) override;
162 #endif
163
164     virtual void willSendRequestInternal(ResourceRequest&&, const ResourceResponse& redirectResponse, CompletionHandler<void(ResourceRequest&&)>&&);
165
166     RefPtr<ResourceHandle> m_handle;
167     RefPtr<Frame> m_frame;
168     RefPtr<DocumentLoader> m_documentLoader;
169     ResourceResponse m_response;
170     LoadTiming m_loadTiming;
171 #if USE(QUICK_LOOK)
172     std::unique_ptr<PreviewLoader> m_previewLoader;
173 #endif
174
175 private:
176     virtual void willCancel(const ResourceError&) = 0;
177     virtual void didCancel(const ResourceError&) = 0;
178
179     void addDataOrBuffer(const char*, unsigned, SharedBuffer*, DataPayloadType);
180     void loadDataURL();
181     void finishNetworkLoad();
182
183     // ResourceHandleClient
184     void didSendData(ResourceHandle*, unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override;
185     void didReceiveResponseAsync(ResourceHandle*, ResourceResponse&&) override;
186     void willSendRequestAsync(ResourceHandle*, ResourceRequest&&, ResourceResponse&&, CompletionHandler<void(ResourceRequest&&)>&&) override;
187     void didReceiveData(ResourceHandle*, const char*, unsigned, int encodedDataLength) override;
188     void didReceiveBuffer(ResourceHandle*, Ref<SharedBuffer>&&, int encodedDataLength) override;
189     void didFinishLoading(ResourceHandle*) override;
190     void didFail(ResourceHandle*, const ResourceError&) override;
191     void wasBlocked(ResourceHandle*) override;
192     void cannotShowURL(ResourceHandle*) override;
193     bool shouldUseCredentialStorage(ResourceHandle*) override { return shouldUseCredentialStorage(); }
194     void didReceiveAuthenticationChallenge(ResourceHandle*, const AuthenticationChallenge& challenge) override { didReceiveAuthenticationChallenge(challenge); } 
195 #if USE(PROTECTION_SPACE_AUTH_CALLBACK)
196     void canAuthenticateAgainstProtectionSpaceAsync(ResourceHandle*, const ProtectionSpace&) override;
197 #endif
198     void receivedCancellation(ResourceHandle*, const AuthenticationChallenge& challenge) override { receivedCancellation(challenge); }
199 #if PLATFORM(IOS)
200     RetainPtr<CFDictionaryRef> connectionProperties(ResourceHandle*) override;
201 #endif
202 #if USE(CFURLCONNECTION)
203     // FIXME: Windows should use willCacheResponse - <https://bugs.webkit.org/show_bug.cgi?id=57257>.
204     bool shouldCacheResponse(ResourceHandle*, CFCachedURLResponseRef) override;
205 #endif
206
207     bool isMixedContent(const URL&) const;
208
209     ResourceRequest m_request;
210     ResourceRequest m_originalRequest; // Before redirects.
211     RefPtr<SharedBuffer> m_resourceData;
212     
213     unsigned long m_identifier { 0 };
214
215     bool m_reachedTerminalState { false };
216     bool m_notifiedLoadComplete { false };
217
218     enum CancellationStatus {
219         NotCancelled,
220         CalledWillCancel,
221         Cancelled,
222         FinishedCancel
223     };
224     CancellationStatus m_cancellationStatus { NotCancelled };
225
226     bool m_defersLoading;
227     bool m_canAskClientForCredentials;
228     ResourceRequest m_deferredRequest;
229     ResourceLoaderOptions m_options;
230
231 #if ENABLE(CONTENT_EXTENSIONS)
232 protected:
233     ResourceType m_resourceType { ResourceType::Invalid };
234 #endif
235 };
236
237 } // namespace WebCore