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
|
<?php
namespace ipl\Validator;
use ipl\I18n\Translation;
use ipl\Stdlib\Str;
use LogicException;
use Psr\Http\Message\UploadedFileInterface;
/**
* Validates an uploaded file
*/
class FileValidator extends BaseValidator
{
use Translation;
/** @var int Minimum allowed file size */
protected $minSize;
/** @var ?int Maximum allowed file size */
protected $maxSize;
/** @var ?string[] Allowed mime types */
protected $allowedMimeTypes;
/** @var ?int Maximum allowed file name length */
protected $maxFileNameLength;
/**
* Create a new FileValidator
*
* Optional options:
* - minSize: (int) Minimum allowed file size, by default 0
* - maxSize: (int) Maximum allowed file size, by default no limit
* - maxFileNameLength: (int) Maximum allowed file name length, by default no limit
* - mimeType: (array) Allowed mime types, by default no restriction
*/
public function __construct(array $options = [])
{
$this
->setMinSize($options['minSize'] ?? 0)
->setMaxSize($options['maxSize'] ?? null)
->setMaxFileNameLength($options['maxFileNameLength'] ?? null)
->setAllowedMimeTypes($options['mimeType'] ?? null);
}
/**
* Get the minimum allowed file size
*
* @return int
*/
public function getMinSize(): int
{
return $this->minSize;
}
/**
* Set the minimum allowed file size
*
* @param int $minSize
*
* @return $this
*/
public function setMinSize(int $minSize): self
{
if (($max = $this->getMaxSize()) !== null && $minSize > $max) {
throw new LogicException(
sprintf(
'The minSize must be less than or equal to the maxSize, but minSize: %d and maxSize: %d given.',
$minSize,
$max
)
);
}
$this->minSize = $minSize;
return $this;
}
/**
* Get the maximum allowed file size
*
* @return ?int
*/
public function getMaxSize(): ?int
{
return $this->maxSize;
}
/**
* Set the maximum allowed file size
*
* @param ?int $maxSize
*
* @return $this
*/
public function setMaxSize(?int $maxSize): self
{
if ($maxSize !== null && ($min = $this->getMinSize()) !== null && $maxSize < $min) {
throw new LogicException(
sprintf(
'The minSize must be less than or equal to the maxSize, but minSize: %d and maxSize: %d given.',
$min,
$maxSize
)
);
}
$this->maxSize = $maxSize;
return $this;
}
/**
* Get the allowed file mime types
*
* @return ?string[]
*/
public function getAllowedMimeTypes(): ?array
{
return $this->allowedMimeTypes;
}
/**
* Set the allowed file mime types
*
* @param ?string[] $allowedMimeTypes
*
* @return $this
*/
public function setAllowedMimeTypes(?array $allowedMimeTypes): self
{
$this->allowedMimeTypes = $allowedMimeTypes;
return $this;
}
/**
* Get maximum allowed file name length
*
* @return ?int
*/
public function getMaxFileNameLength(): ?int
{
return $this->maxFileNameLength;
}
/**
* Set maximum allowed file name length
*
* @param ?int $maxFileNameLength
*
* @return $this
*/
public function setMaxFileNameLength(?int $maxFileNameLength): self
{
$this->maxFileNameLength = $maxFileNameLength;
return $this;
}
public function isValid($value)
{
// Multiple isValid() calls must not stack validation messages
$this->clearMessages();
if (is_array($value)) {
foreach ($value as $file) {
if (! $this->validateFile($file)) {
return false;
}
}
return true;
}
return $this->validateFile($value);
}
private function validateFile(UploadedFileInterface $file): bool
{
$isValid = true;
if ($this->getMaxSize() && $file->getSize() > $this->getMaxSize()) {
$this->addMessage(sprintf(
$this->translate('File %s is bigger than the allowed maximum size of %d'),
$file->getClientFileName(),
$this->getMaxSize()
));
$isValid = false;
}
if ($this->getMinSize() && $file->getSize() < $this->getMinSize()) {
$this->addMessage(sprintf(
$this->translate('File %s is smaller than the minimum required size of %d'),
$file->getClientFileName(),
$this->getMinSize()
));
$isValid = false;
}
if ($this->getMaxFileNameLength()) {
$strValidator = new StringLengthValidator(['max' => $this->getMaxFileNameLength()]);
if (! $strValidator->isValid($file->getClientFilename())) {
$this->addMessage(sprintf(
$this->translate('File name is longer than the allowed length of %d characters.'),
$this->maxFileNameLength
));
$isValid = false;
}
}
if (! empty($this->getAllowedMimeTypes())) {
$hasAllowedMimeType = false;
foreach ($this->getAllowedMimeTypes() as $type) {
$fileMimetype = $file->getClientMediaType();
if (($pos = strpos($type, '/*')) !== false) { // image/*
$typePrefix = substr($type, 0, $pos);
if (Str::startsWith($fileMimetype, $typePrefix)) {
$hasAllowedMimeType = true;
break;
}
} elseif ($fileMimetype === $type) { // image/png
$hasAllowedMimeType = true;
break;
}
}
if (! $hasAllowedMimeType) {
$this->addMessage(sprintf(
$this->translate('File %s is of type %s. Only %s allowed.'),
$file->getClientFileName(),
$file->getClientMediaType(),
implode(', ', $this->allowedMimeTypes)
));
$isValid = false;
}
}
return $isValid;
}
}
|
