1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*
* Copyright (C) 2013 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef FetchContext_h
#define FetchContext_h
#include "core/CoreExport.h"
#include "core/fetch/CachePolicy.h"
#include "core/fetch/FetchInitiatorInfo.h"
#include "core/fetch/FetchRequest.h"
#include "core/fetch/Resource.h"
#include "platform/heap/Handle.h"
#include "platform/network/ResourceLoadPriority.h"
#include "platform/network/ResourceRequest.h"
#include "wtf/Forward.h"
#include "wtf/Noncopyable.h"
namespace blink {
class ClientHintsPreferences;
class KURL;
class MHTMLArchive;
class ResourceError;
class ResourceResponse;
class ResourceTimingInfo;
class WebTaskRunner;
enum class WebCachePolicy;
enum FetchResourceType { FetchMainResource, FetchSubresource };
// The FetchContext is an interface for performing context specific processing
// in response to events in the ResourceFetcher. The ResourceFetcher or its job
// class, ResourceLoader, may call the methods on a FetchContext.
//
// Any processing that depends on core/ components outside core/fetch/ should
// be implemented on a subclass of this interface, and then exposed to the
// ResourceFetcher via this interface.
class CORE_EXPORT FetchContext
: public GarbageCollectedFinalized<FetchContext> {
WTF_MAKE_NONCOPYABLE(FetchContext);
public:
enum LogMessageType { LogErrorMessage, LogWarningMessage };
static FetchContext& nullInstance();
virtual ~FetchContext() {}
DEFINE_INLINE_VIRTUAL_TRACE() {}
virtual bool isLiveContext() { return false; }
virtual void addAdditionalRequestHeaders(ResourceRequest&, FetchResourceType);
virtual CachePolicy getCachePolicy() const;
// Returns the cache policy for the resource. ResourceRequest is not passed as
// a const reference as a header needs to be added for doc.write blocking
// intervention.
virtual WebCachePolicy resourceRequestCachePolicy(
ResourceRequest&,
Resource::Type,
FetchRequest::DeferOption) const;
virtual void dispatchDidChangeResourcePriority(unsigned long identifier,
ResourceLoadPriority,
int intraPriorityValue);
// The last callback before a request is actually sent to the browser process.
virtual void dispatchWillSendRequest(
unsigned long identifier,
ResourceRequest&,
const ResourceResponse& redirectResponse,
const FetchInitiatorInfo& = FetchInitiatorInfo());
virtual void dispatchDidLoadResourceFromMemoryCache(
unsigned long identifier,
Resource*,
WebURLRequest::FrameType,
WebURLRequest::RequestContext);
virtual void dispatchDidReceiveResponse(unsigned long identifier,
const ResourceResponse&,
WebURLRequest::FrameType,
WebURLRequest::RequestContext,
Resource*);
virtual void dispatchDidReceiveData(unsigned long identifier,
const char* data,
int dataLength);
virtual void dispatchDidReceiveEncodedData(unsigned long identifier,
int encodedDataLength);
virtual void dispatchDidDownloadData(unsigned long identifier,
int dataLength,
int encodedDataLength);
virtual void dispatchDidFinishLoading(unsigned long identifier,
double finishTime,
int64_t encodedDataLength);
virtual void dispatchDidFail(unsigned long identifier,
const ResourceError&,
int64_t encodedDataLength,
bool isInternalRequest);
virtual bool shouldLoadNewResource(Resource::Type) const { return false; }
// Called when a resource load is first requested, which may not be when the
// load actually begins.
// TODO(toyoshim): Consider to use enum. See https://crbug.com/675883.
virtual void willStartLoadingResource(unsigned long identifier,
ResourceRequest&,
Resource::Type,
const AtomicString& fetchInitiatorName,
bool forPreload);
virtual void didLoadResource(Resource*);
virtual void addResourceTiming(const ResourceTimingInfo&);
virtual bool allowImage(bool, const KURL&) const { return false; }
// TODO(toyoshim): Consider to use enum. See https://crbug.com/675883.
virtual ResourceRequestBlockedReason canRequest(
Resource::Type,
const ResourceRequest&,
const KURL&,
const ResourceLoaderOptions&,
bool forPreload,
FetchRequest::OriginRestriction) const {
return ResourceRequestBlockedReason::Other;
}
virtual ResourceRequestBlockedReason allowResponse(
Resource::Type,
const ResourceRequest&,
const KURL&,
const ResourceLoaderOptions&) const {
return ResourceRequestBlockedReason::Other;
}
virtual bool isControlledByServiceWorker() const { return false; }
virtual int64_t serviceWorkerID() const { return -1; }
virtual bool isMainFrame() const { return true; }
virtual bool defersLoading() const { return false; }
virtual bool isLoadComplete() const { return false; }
virtual bool pageDismissalEventBeingDispatched() const { return false; }
virtual bool updateTimingInfoForIFrameNavigation(ResourceTimingInfo*) {
return false;
}
virtual void sendImagePing(const KURL&);
virtual void addConsoleMessage(const String&,
LogMessageType = LogErrorMessage) const;
virtual SecurityOrigin* getSecurityOrigin() const { return nullptr; }
// Populates the ResourceRequest using the given values and information
// stored in the FetchContext implementation. Used by ResourceFetcher to
// prepare a ResourceRequest instance at the start of resource loading.
virtual void populateResourceRequest(Resource::Type,
const ClientHintsPreferences&,
const FetchRequest::ResourceWidth&,
ResourceRequest&);
// Sets the first party for cookies and requestor origin using information
// stored in the FetchContext implementation.
virtual void setFirstPartyCookieAndRequestorOrigin(ResourceRequest&);
virtual MHTMLArchive* archive() const { return nullptr; }
virtual ResourceLoadPriority modifyPriorityForExperiments(
ResourceLoadPriority priority) {
return priority;
}
virtual RefPtr<WebTaskRunner> loadingTaskRunner() const { return nullptr; }
protected:
FetchContext() {}
};
} // namespace blink
#endif
|
