[Content Filtering] Determine navigation and content policy before continuing to...
[WebKit-https.git] / Source / WebCore / loader / SubresourceLoader.h
1 /*
2  * Copyright (C) 2005, 2006, 2009 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 #ifndef SubresourceLoader_h
30 #define SubresourceLoader_h
31
32 #include "FrameLoaderTypes.h"
33 #include "ResourceLoader.h"
34
35 #include <wtf/text/WTFString.h>
36  
37 namespace WebCore {
38
39 class CachedResource;
40 class CachedResourceLoader;
41 class Document;
42 class ResourceRequest;
43
44 class SubresourceLoader final : public ResourceLoader {
45 public:
46     WEBCORE_EXPORT static RefPtr<SubresourceLoader> create(Frame*, CachedResource*, const ResourceRequest&, const ResourceLoaderOptions&);
47
48     virtual ~SubresourceLoader();
49
50     void cancelIfNotFinishing();
51     virtual bool isSubresourceLoader() override;
52     CachedResource* cachedResource();
53
54 #if PLATFORM(IOS)
55     virtual bool startLoading() override;
56
57     // FIXME: What is an "iOS" original request? Why is it necessary?
58     virtual const ResourceRequest& iOSOriginalRequest() const override { return m_iOSOriginalRequest; }
59 #endif
60
61 private:
62     SubresourceLoader(Frame*, CachedResource*, const ResourceLoaderOptions&);
63
64     virtual bool init(const ResourceRequest&) override;
65
66     virtual void willSendRequestInternal(ResourceRequest&, const ResourceResponse& redirectResponse) override;
67     virtual void didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent) override;
68     virtual void didReceiveResponse(const ResourceResponse&) override;
69     virtual void didReceiveData(const char*, unsigned, long long encodedDataLength, DataPayloadType) override;
70     virtual void didReceiveBuffer(PassRefPtr<SharedBuffer>, long long encodedDataLength, DataPayloadType) override;
71     virtual void didFinishLoading(double finishTime) override;
72     virtual void didFail(const ResourceError&) override;
73     virtual void willCancel(const ResourceError&) override;
74     virtual void didCancel(const ResourceError&) override;
75
76 #if PLATFORM(COCOA) && !USE(CFNETWORK)
77     virtual NSCachedURLResponse *willCacheResponse(ResourceHandle*, NSCachedURLResponse*) override;
78 #endif
79 #if PLATFORM(COCOA) && USE(CFNETWORK)
80     virtual CFCachedURLResponseRef willCacheResponse(ResourceHandle*, CFCachedURLResponseRef) override;
81 #endif
82
83 #if USE(NETWORK_CFDATA_ARRAY_CALLBACK)
84     virtual bool supportsDataArray() override { return true; }
85     virtual void didReceiveDataArray(CFArrayRef) override;
86 #endif
87     virtual void releaseResources() override;
88
89 #if USE(SOUP)
90     virtual char* getOrCreateReadBuffer(size_t requestedSize, size_t& actualSize) override;
91 #endif
92
93     bool checkForHTTPStatusCodeError();
94
95     void didReceiveDataOrBuffer(const char*, int, PassRefPtr<SharedBuffer>, long long encodedDataLength, DataPayloadType);
96
97     void notifyDone();
98
99     enum SubresourceLoaderState {
100         Uninitialized,
101         Initialized,
102         Finishing,
103 #if PLATFORM(IOS)
104         CancelledWhileInitializing
105 #endif
106     };
107
108     class RequestCountTracker {
109 #if !COMPILER(MSVC)
110         WTF_MAKE_FAST_ALLOCATED;
111 #endif
112     public:
113         RequestCountTracker(CachedResourceLoader&, CachedResource*);
114         ~RequestCountTracker();
115     private:
116         CachedResourceLoader& m_cachedResourceLoader;
117         CachedResource* m_resource;
118     };
119
120 #if PLATFORM(IOS)
121     ResourceRequest m_iOSOriginalRequest;
122 #endif
123     CachedResource* m_resource;
124     bool m_loadingMultipartContent;
125     SubresourceLoaderState m_state;
126     std::unique_ptr<RequestCountTracker> m_requestCountTracker;
127 };
128
129 }
130
131 #endif // SubresourceLoader_h