/
FormFlashFile.php
257 lines (221 loc) · 5.71 KB
/
FormFlashFile.php
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?php
/**
* @package Grav\Framework\Form
*
* @copyright Copyright (c) 2015 - 2022 Trilby Media, LLC. All rights reserved.
* @license MIT License; see LICENSE file for details.
*/
namespace Grav\Framework\Form;
use Grav\Common\Security;
use Grav\Common\Utils;
use Grav\Framework\Psr7\Stream;
use InvalidArgumentException;
use JsonSerializable;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use RuntimeException;
use function copy;
use function fopen;
use function is_string;
use function sprintf;
/**
* Class FormFlashFile
* @package Grav\Framework\Form
*/
class FormFlashFile implements UploadedFileInterface, JsonSerializable
{
/** @var string */
private $field;
/** @var bool */
private $moved = false;
/** @var array */
private $upload;
/** @var FormFlash */
private $flash;
/**
* FormFlashFile constructor.
* @param string $field
* @param array $upload
* @param FormFlash $flash
*/
public function __construct(string $field, array $upload, FormFlash $flash)
{
$this->field = $field;
$this->upload = $upload;
$this->flash = $flash;
$tmpFile = $this->getTmpFile();
if (!$tmpFile && $this->isOk()) {
$this->upload['error'] = \UPLOAD_ERR_NO_FILE;
}
if (!isset($this->upload['size'])) {
$this->upload['size'] = $tmpFile && $this->isOk() ? filesize($tmpFile) : 0;
}
}
/**
* @return StreamInterface
*/
public function getStream()
{
$this->validateActive();
$tmpFile = $this->getTmpFile();
if (null === $tmpFile) {
throw new RuntimeException('No temporary file');
}
$resource = fopen($tmpFile, 'rb');
if (false === $resource) {
throw new RuntimeException('No temporary file');
}
return Stream::create($resource);
}
/**
* @param string $targetPath
* @return void
*/
public function moveTo($targetPath)
{
$this->validateActive();
if (!is_string($targetPath) || empty($targetPath)) {
throw new InvalidArgumentException('Invalid path provided for move operation; must be a non-empty string');
}
$tmpFile = $this->getTmpFile();
if (null === $tmpFile) {
throw new RuntimeException('No temporary file');
}
$this->moved = copy($tmpFile, $targetPath);
if (false === $this->moved) {
throw new RuntimeException(sprintf('Uploaded file could not be moved to %s', $targetPath));
}
$filename = $this->getClientFilename();
if ($filename) {
$this->flash->removeFile($filename, $this->field);
}
}
/**
* @return string
*/
public function getField(): string
{
return $this->field;
}
/**
* @return int
*/
public function getSize()
{
return $this->upload['size'];
}
/**
* @return int
*/
public function getError()
{
return $this->upload['error'] ?? \UPLOAD_ERR_OK;
}
/**
* @return string
*/
public function getClientFilename()
{
return $this->upload['name'] ?? 'unknown';
}
/**
* @return string
*/
public function getClientMediaType()
{
return $this->upload['type'] ?? 'application/octet-stream';
}
/**
* @return bool
*/
public function isMoved(): bool
{
return $this->moved;
}
/**
* @return array
*/
public function getMetaData(): array
{
if (isset($this->upload['crop'])) {
return ['crop' => $this->upload['crop']];
}
return [];
}
/**
* @return string
*/
public function getDestination()
{
return $this->upload['path'] ?? '';
}
/**
* @return array
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return $this->upload;
}
/**
* @return void
*/
public function checkXss(): void
{
$tmpFile = $this->getTmpFile();
$mime = $this->getClientMediaType();
if (Utils::contains($mime, 'svg', false)) {
$response = Security::detectXssFromSvgFile($tmpFile);
if ($response) {
throw new RuntimeException(sprintf('SVG file XSS check failed on %s', $response));
}
}
}
/**
* @return string|null
*/
public function getTmpFile(): ?string
{
$tmpName = $this->upload['tmp_name'] ?? null;
if (!$tmpName) {
return null;
}
$tmpFile = $this->flash->getTmpDir() . '/' . $tmpName;
return file_exists($tmpFile) ? $tmpFile : null;
}
/**
* @return array
*/
#[\ReturnTypeWillChange]
public function __debugInfo()
{
return [
'field:private' => $this->field,
'moved:private' => $this->moved,
'upload:private' => $this->upload,
];
}
/**
* @return void
* @throws RuntimeException if is moved or not ok
*/
private function validateActive(): void
{
if (!$this->isOk()) {
throw new RuntimeException('Cannot retrieve stream due to upload error');
}
if ($this->moved) {
throw new RuntimeException('Cannot retrieve stream after it has already been moved');
}
if (!$this->getTmpFile()) {
throw new RuntimeException('Cannot retrieve stream as the file is missing');
}
}
/**
* @return bool return true if there is no upload error
*/
private function isOk(): bool
{
return \UPLOAD_ERR_OK === $this->getError();
}
}