9af98721f15d754c3ca96967702e6ed901474e9b
[WebKit-https.git] / Source / WebCore / loader / SubresourceLoader.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 "FrameLoaderTypes.h"
32 #include "ResourceLoader.h"
33 #include <wtf/text/WTFString.h>
34  
35 namespace WebCore {
36
37 class CachedResource;
38 class CachedResourceLoader;
39 class NetworkLoadMetrics;
40 class ResourceRequest;
41 class SecurityOrigin;
42
43 class SubresourceLoader final : public ResourceLoader {
44 public:
45     WEBCORE_EXPORT static RefPtr<SubresourceLoader> create(Frame&, CachedResource&, const ResourceRequest&, const ResourceLoaderOptions&);
46
47     virtual ~SubresourceLoader();
48
49     void cancelIfNotFinishing();
50     bool isSubresourceLoader() override;
51     CachedResource* cachedResource();
52
53     SecurityOrigin* origin() { return m_origin.get(); }
54 #if PLATFORM(IOS)
55     bool startLoading() override;
56
57     // FIXME: What is an "iOS" original request? Why is it necessary?
58     const ResourceRequest& iOSOriginalRequest() const override { return m_iOSOriginalRequest; }
59 #endif
60
61     unsigned redirectCount() const { return m_redirectCount; }
62
63 private:
64     SubresourceLoader(Frame&, CachedResource&, const ResourceLoaderOptions&);
65
66     bool init(const ResourceRequest&) override;
67
68     void willSendRequestInternal(ResourceRequest&, const ResourceResponse& redirectResponse) override;
69     void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override;
70     void didReceiveResponse(const ResourceResponse&) override;
71     void didReceiveData(const char*, unsigned, long long encodedDataLength, DataPayloadType) override;
72     void didReceiveBuffer(Ref<SharedBuffer>&&, long long encodedDataLength, DataPayloadType) override;
73     void didFinishLoading(const NetworkLoadMetrics&) override;
74     void didFail(const ResourceError&) override;
75     void willCancel(const ResourceError&) override;
76     void didCancel(const ResourceError&) override;
77     void didRetrieveDerivedDataFromCache(const String& type, SharedBuffer&) override;
78
79 #if PLATFORM(COCOA) && !USE(CFURLCONNECTION)
80     NSCachedURLResponse *willCacheResponse(ResourceHandle*, NSCachedURLResponse*) override;
81 #endif
82 #if PLATFORM(COCOA) && USE(CFURLCONNECTION)
83     CFCachedURLResponseRef willCacheResponse(ResourceHandle*, CFCachedURLResponseRef) override;
84 #endif
85
86     void releaseResources() override;
87
88 #if USE(SOUP)
89     char* getOrCreateReadBuffer(size_t requestedSize, size_t& actualSize) override;
90 #endif
91
92     bool checkForHTTPStatusCodeError();
93     bool checkResponseCrossOriginAccessControl(const ResourceResponse&, String&);
94     bool checkRedirectionCrossOriginAccessControl(const ResourceRequest& previousRequest, const ResourceResponse&, ResourceRequest& newRequest, String&);
95
96     void didReceiveDataOrBuffer(const char*, int, RefPtr<SharedBuffer>&&, long long encodedDataLength, DataPayloadType);
97
98     void notifyDone();
99
100     void reportResourceTiming(const NetworkLoadMetrics&);
101
102 #if USE(QUICK_LOOK)
103     bool shouldCreatePreviewLoaderForResponse(const ResourceResponse&) const;
104 #endif
105
106     enum SubresourceLoaderState {
107         Uninitialized,
108         Initialized,
109         Finishing,
110 #if PLATFORM(IOS)
111         CancelledWhileInitializing
112 #endif
113     };
114
115     class RequestCountTracker {
116 #if !COMPILER(MSVC)
117         WTF_MAKE_FAST_ALLOCATED;
118 #endif
119     public:
120         RequestCountTracker(CachedResourceLoader&, const CachedResource&);
121         ~RequestCountTracker();
122     private:
123         CachedResourceLoader& m_cachedResourceLoader;
124         const CachedResource& m_resource;
125     };
126
127 #if PLATFORM(IOS)
128     ResourceRequest m_iOSOriginalRequest;
129 #endif
130     CachedResource* m_resource;
131     SubresourceLoaderState m_state;
132     std::optional<RequestCountTracker> m_requestCountTracker;
133     RefPtr<SecurityOrigin> m_origin;
134     unsigned m_redirectCount { 0 };
135     bool m_loadingMultipartContent { false };
136 };
137
138 }