File: RawResource.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (196 lines) | stat: -rw-r--r-- 7,331 bytes parent folder | download
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) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
    Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
    Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
    Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef RawResource_h
#define RawResource_h

#include "core/CoreExport.h"
#include "core/fetch/Resource.h"
#include "core/fetch/ResourceClient.h"
#include "public/platform/WebDataConsumerHandle.h"
#include "wtf/WeakPtr.h"
#include <memory>

namespace blink {
class FetchRequest;
class RawResourceClient;
class ResourceFetcher;
class SubstituteData;

class CORE_EXPORT RawResource final : public Resource {
 public:
  using ClientType = RawResourceClient;

  static RawResource* fetchSynchronously(FetchRequest&, ResourceFetcher*);
  static RawResource* fetch(FetchRequest&, ResourceFetcher*);
  static RawResource* fetchMainResource(FetchRequest&,
                                        ResourceFetcher*,
                                        const SubstituteData&);
  static RawResource* fetchImport(FetchRequest&, ResourceFetcher*);
  static RawResource* fetchMedia(FetchRequest&, ResourceFetcher*);
  static RawResource* fetchTextTrack(FetchRequest&, ResourceFetcher*);
  static RawResource* fetchManifest(FetchRequest&, ResourceFetcher*);

  // Exposed for testing
  static RawResource* create(const ResourceRequest& request, Type type) {
    return new RawResource(request, type, ResourceLoaderOptions());
  }

  // FIXME: AssociatedURLLoader shouldn't be a DocumentThreadableLoader and
  // therefore shouldn't use RawResource. However, it is, and it needs to be
  // able to defer loading. This can be fixed by splitting CORS preflighting out
  // of DocumentThreadableLoader.
  void setDefersLoading(bool);

  // Resource implementation
  bool canReuse(const ResourceRequest&) const override;
  bool willFollowRedirect(const ResourceRequest&,
                          const ResourceResponse&) override;

 private:
  class RawResourceFactory : public ResourceFactory {
   public:
    explicit RawResourceFactory(Resource::Type type) : ResourceFactory(type) {}

    Resource* create(const ResourceRequest& request,
                     const ResourceLoaderOptions& options,
                     const String& charset) const override {
      return new RawResource(request, m_type, options);
    }
  };

  RawResource(const ResourceRequest&, Type, const ResourceLoaderOptions&);

  // Resource implementation
  void didAddClient(ResourceClient*) override;
  void appendData(const char*, size_t) override;
  bool shouldIgnoreHTTPStatusCodeErrors() const override {
    return !isLinkPreload();
  }
  void willNotFollowRedirect() override;
  void responseReceived(const ResourceResponse&,
                        std::unique_ptr<WebDataConsumerHandle>) override;
  void setSerializedCachedMetadata(const char*, size_t) override;
  void didSendData(unsigned long long bytesSent,
                   unsigned long long totalBytesToBeSent) override;
  void didDownloadData(int) override;
  void reportResourceTimingToClients(const ResourceTimingInfo&) override;
};

#if ENABLE(SECURITY_ASSERT)
inline bool isRawResource(const Resource& resource) {
  Resource::Type type = resource.getType();
  return type == Resource::MainResource || type == Resource::Raw ||
         type == Resource::TextTrack || type == Resource::Media ||
         type == Resource::Manifest || type == Resource::ImportResource;
}
#endif
inline RawResource* toRawResource(Resource* resource) {
  SECURITY_DCHECK(!resource || isRawResource(*resource));
  return static_cast<RawResource*>(resource);
}

class CORE_EXPORT RawResourceClient : public ResourceClient {
 public:
  static bool isExpectedType(ResourceClient* client) {
    return client->getResourceClientType() == RawResourceType;
  }
  ResourceClientType getResourceClientType() const final {
    return RawResourceType;
  }

  // The order of the callbacks is as follows:
  // [Case 1] A successful load:
  // 0+  redirectReceived() and/or dataSent()
  // 1   responseReceived()
  // 0-1 setSerializedCachedMetadata()
  // 0+  dataReceived() or dataDownloaded(), but never both
  // 1   notifyFinished() with errorOccurred() = false
  // [Case 2] When redirect is blocked:
  // 0+  redirectReceived() and/or dataSent()
  // 1   redirectBlocked()
  // 1   notifyFinished() with errorOccurred() = true
  // [Case 3] Other failures:
  //     notifyFinished() with errorOccurred() = true is called at any time
  //     (unless notifyFinished() is already called).
  // In all cases:
  //     No callbacks are made after notifyFinished() or
  //     removeClient() is called.
  virtual void dataSent(Resource*,
                        unsigned long long /* bytesSent */,
                        unsigned long long /* totalBytesToBeSent */) {}
  virtual void responseReceived(Resource*,
                                const ResourceResponse&,
                                std::unique_ptr<WebDataConsumerHandle>) {}
  virtual void setSerializedCachedMetadata(Resource*, const char*, size_t) {}
  virtual void dataReceived(Resource*,
                            const char* /* data */,
                            size_t /* length */) {}
  virtual bool redirectReceived(Resource*,
                                const ResourceRequest&,
                                const ResourceResponse&) {
    return true;
  }
  virtual void redirectBlocked() {}
  virtual void dataDownloaded(Resource*, int) {}
  virtual void didReceiveResourceTiming(Resource*, const ResourceTimingInfo&) {}
};

// Checks the sequence of callbacks of RawResourceClient. This can be used only
// when a RawResourceClient is added as a client to at most one RawResource.
class CORE_EXPORT RawResourceClientStateChecker final {
 public:
  RawResourceClientStateChecker();
  ~RawResourceClientStateChecker();

  // Call before addClient()/removeClient() is called.
  void willAddClient();
  void willRemoveClient();

  // Call RawResourceClientStateChecker::f() at the beginning of
  // RawResourceClient::f().
  void redirectReceived();
  void redirectBlocked();
  void dataSent();
  void responseReceived();
  void setSerializedCachedMetadata();
  void dataReceived();
  void dataDownloaded();
  void notifyFinished(Resource*);

 private:
  enum State {
    NotAddedAsClient,
    Started,
    RedirectBlocked,
    ResponseReceived,
    SetSerializedCachedMetadata,
    DataReceived,
    DataDownloaded,
    NotifyFinished
  };
  State m_state;
};

}  // namespace blink

#endif  // RawResource_h