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
|
/*
* Copyright (C) 2010 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 THIRD_PARTY_BLINK_RENDERER_CORE_FILEAPI_FILE_READER_LOADER_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_FILEAPI_FILE_READER_LOADER_H_
#include <memory>
#include "base/memory/weak_ptr.h"
#include "mojo/public/cpp/bindings/binding.h"
#include "third_party/blink/public/mojom/blob/blob.mojom-blink.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/fileapi/file_error.h"
#include "third_party/blink/renderer/platform/heap/persistent.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/text/text_encoding.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "third_party/blink/renderer/platform/wtf/typed_arrays/array_buffer.h"
namespace blink {
class BlobDataHandle;
class DOMArrayBuffer;
class FileReaderLoaderClient;
class TextResourceDecoder;
// Reads a Blob's content into memory.
//
// Blobs are typically stored on disk, and should be read asynchronously
// whenever possible. Synchronous loading is implemented to support Web Platform
// features that we cannot (yet) remove, such as FileReaderSync and synchronous
// XMLHttpRequest.
//
// Each FileReaderLoader instance is only good for reading one Blob, and will
// leak resources if used multiple times.
class CORE_EXPORT FileReaderLoader : public mojom::blink::BlobReaderClient {
USING_FAST_MALLOC(FileReaderLoader);
public:
enum ReadType {
kReadAsArrayBuffer,
kReadAsBinaryString,
kReadAsText,
kReadAsDataURL,
kReadByClient
};
// If client is given, do the loading asynchronously. Otherwise, load
// synchronously.
FileReaderLoader(ReadType,
FileReaderLoaderClient*,
scoped_refptr<base::SingleThreadTaskRunner>);
~FileReaderLoader() override;
void Start(scoped_refptr<BlobDataHandle>);
void Cancel();
DOMArrayBuffer* ArrayBufferResult();
String StringResult();
// Returns the total bytes received. Bytes ignored by m_rawData won't be
// counted.
//
// This value doesn't grow more than numeric_limits<unsigned> when
// m_readType is not set to ReadByClient.
uint64_t BytesLoaded() const { return bytes_loaded_; }
// Before OnCalculatedSize() is called: Returns nullopt.
// After OnCalculatedSize() is called: Returns the size of the resource.
base::Optional<uint64_t> TotalBytes() const { return total_bytes_; }
FileErrorCode GetErrorCode() const { return error_code_; }
int32_t GetNetError() const { return net_error_; }
void SetEncoding(const String&);
void SetDataType(const String& data_type) { data_type_ = data_type; }
bool HasFinishedLoading() const { return finished_loading_; }
private:
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class FailureType {
kMojoPipeCreation = 0,
kSyncDataNotAllLoaded = 1,
kSyncOnCompleteNotReceived = 2,
kTotalBytesTooLarge = 3,
kArrayBufferBuilderCreation = 4,
kArrayBufferBuilderAppend = 5,
kBackendReadError = 6,
kReadSizesIncorrect = 7,
kDataPipeNotReadableWithBytesLeft = 8,
kMojoPipeClosedEarly = 9,
// Any MojoResult error we aren't expecting during data pipe reading falls
// into this bucket. If there are a large number of errors reported here,
// then there can be a new enumeration reported for mojo pipe errors.
kMojoPipeUnexpectedReadError = 10,
kCount
};
void Cleanup();
void Failed(FileErrorCode, FailureType type);
void OnStartLoading(uint64_t total_bytes);
void OnReceivedData(const char* data, unsigned data_length);
void OnFinishLoading();
bool IsSyncLoad() const { return !client_; }
// BlobReaderClient:
void OnCalculatedSize(uint64_t total_size,
uint64_t expected_content_size) override;
void OnComplete(int32_t status, uint64_t data_length) override;
void OnDataPipeReadable(MojoResult);
void AdjustReportedMemoryUsageToV8(int64_t usage);
void UnadjustReportedMemoryUsageToV8();
String ConvertToText();
String ConvertToDataURL();
void SetStringResult(const String&);
ReadType read_type_;
FileReaderLoaderClient* client_;
WTF::TextEncoding encoding_;
String data_type_;
scoped_refptr<ArrayBuffer> raw_data_;
bool is_raw_data_converted_ = false;
Persistent<DOMArrayBuffer> array_buffer_result_;
String string_result_;
// The decoder used to decode the text data.
std::unique_ptr<TextResourceDecoder> decoder_;
bool finished_loading_ = false;
uint64_t bytes_loaded_ = 0;
// total_bytes_ is set to the total size of the blob being loaded as soon as
// it is known, and the buffer for receiving data of total_bytes_ is
// allocated and never grow even when extra data is appended.
base::Optional<uint64_t> total_bytes_;
int64_t memory_usage_reported_to_v8_ = 0;
int32_t net_error_ = 0; // net::OK
FileErrorCode error_code_ = FileErrorCode::kOK;
mojo::ScopedDataPipeConsumerHandle consumer_handle_;
mojo::SimpleWatcher handle_watcher_;
mojo::Binding<mojom::blink::BlobReaderClient> binding_;
bool received_all_data_ = false;
bool received_on_complete_ = false;
#if DCHECK_IS_ON()
bool started_loading_ = false;
#endif // DCHECK_IS_ON()
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
base::WeakPtrFactory<FileReaderLoader> weak_factory_{this};
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_FILEAPI_FILE_READER_LOADER_H_
|
