framework/validators/FileValidator.php
<?php
/**
* @link https://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/
namespace yii\validators;
use Yii;
use yii\helpers\FileHelper;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\StringHelper;
use yii\web\JsExpression;
use yii\web\UploadedFile;
/**
* FileValidator verifies if an attribute is receiving a valid uploaded file.
*
* Note that you should enable `fileinfo` PHP extension.
*
* @property-read int $sizeLimit The size limit for uploaded files.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class FileValidator extends Validator
{
/**
* @var array|string|null a list of file name extensions that are allowed to be uploaded.
* This can be either an array or a string consisting of file extension names
* separated by space or comma (e.g. "gif, jpg").
* Extension names are case-insensitive. Defaults to null, meaning all file name
* extensions are allowed.
* @see wrongExtension for the customized message for wrong file type.
*/
public $extensions;
/**
* @var bool whether to check file type (extension) with mime-type. If extension produced by
* file mime-type check differs from uploaded file extension, the file will be considered as invalid.
*/
public $checkExtensionByMimeType = true;
/**
* @var array|string|null a list of file MIME types that are allowed to be uploaded.
* This can be either an array or a string consisting of file MIME types
* separated by space or comma (e.g. "text/plain, image/png").
* The mask with the special character `*` can be used to match groups of mime types.
* For example `image/*` will pass all mime types, that begin with `image/` (e.g. `image/jpeg`, `image/png`).
* Mime type names are case-insensitive. Defaults to null, meaning all MIME types are allowed.
* @see wrongMimeType for the customized message for wrong MIME type.
*/
public $mimeTypes;
/**
* @var int|null the minimum number of bytes required for the uploaded file.
* Defaults to null, meaning no limit.
* @see tooSmall for the customized message for a file that is too small.
*/
public $minSize;
/**
* @var int|null the maximum number of bytes required for the uploaded file.
* Defaults to null, meaning no limit.
* Note, the size limit is also affected by `upload_max_filesize` and `post_max_size` INI setting
* and the 'MAX_FILE_SIZE' hidden field value. See [[getSizeLimit()]] for details.
* @see https://www.php.net/manual/en/ini.core.php#ini.upload-max-filesize
* @see https://www.php.net/post-max-size
* @see getSizeLimit
* @see tooBig for the customized message for a file that is too big.
*/
public $maxSize;
/**
* @var int the maximum file count the given attribute can hold.
* Defaults to 1, meaning single file upload. By defining a higher number,
* multiple uploads become possible. Setting it to `0` means there is no limit on
* the number of files that can be uploaded simultaneously.
*
* > Note: The maximum number of files allowed to be uploaded simultaneously is
* also limited with PHP directive `max_file_uploads`, which defaults to 20.
*
* @see https://www.php.net/manual/en/ini.core.php#ini.max-file-uploads
* @see tooMany for the customized message when too many files are uploaded.
*/
public $maxFiles = 1;
/**
* @var int the minimum file count the given attribute can hold.
* Defaults to 0. Higher value means at least that number of files should be uploaded.
*
* @see tooFew for the customized message when too few files are uploaded.
* @since 2.0.14
*/
public $minFiles = 0;
/**
* @var string the error message used when a file is not uploaded correctly.
*/
public $message;
/**
* @var string the error message used when no file is uploaded.
* Note that this is the text of the validation error message. To make uploading files required,
* you have to set [[skipOnEmpty]] to `false`.
*/
public $uploadRequired;
/**
* @var string the error message used when the uploaded file is too large.
* You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {file}: the uploaded file name
* - {limit}: the maximum size allowed (see [[getSizeLimit()]])
* - {formattedLimit}: the maximum size formatted
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]]
*/
public $tooBig;
/**
* @var string the error message used when the uploaded file is too small.
* You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {file}: the uploaded file name
* - {limit}: the value of [[minSize]]
* - {formattedLimit}: the value of [[minSize]] formatted
* with [[\yii\i18n\Formatter::asShortSize()|Formatter::asShortSize()]
*/
public $tooSmall;
/**
* @var string the error message used if the count of multiple uploads exceeds limit.
* You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {limit}: the value of [[maxFiles]]
*/
public $tooMany;
/**
* @var string the error message used if the count of multiple uploads less that minFiles.
* You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {limit}: the value of [[minFiles]]
*
* @since 2.0.14
*/
public $tooFew;
/**
* @var string the error message used when the uploaded file has an extension name
* that is not listed in [[extensions]]. You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {file}: the uploaded file name
* - {extensions}: the list of the allowed extensions.
*/
public $wrongExtension;
/**
* @var string the error message used when the file has an mime type
* that is not allowed by [[mimeTypes]] property.
* You may use the following tokens in the message:
*
* - {attribute}: the attribute name
* - {file}: the uploaded file name
* - {mimeTypes}: the value of [[mimeTypes]]
*/
public $wrongMimeType;
/**
* {@inheritdoc}
*/
public function init()
{
parent::init();
if ($this->message === null) {
$this->message = Yii::t('yii', 'File upload failed.');
}
if ($this->uploadRequired === null) {
$this->uploadRequired = Yii::t('yii', 'Please upload a file.');
}
if ($this->tooMany === null) {
$this->tooMany = Yii::t('yii', 'You can upload at most {limit, number} {limit, plural, one{file} other{files}}.');
}
if ($this->tooFew === null) {
$this->tooFew = Yii::t('yii', 'You should upload at least {limit, number} {limit, plural, one{file} other{files}}.');
}
if ($this->wrongExtension === null) {
$this->wrongExtension = Yii::t('yii', 'Only files with these extensions are allowed: {extensions}.');
}
if ($this->tooBig === null) {
$this->tooBig = Yii::t('yii', 'The file "{file}" is too big. Its size cannot exceed {formattedLimit}.');
}
if ($this->tooSmall === null) {
$this->tooSmall = Yii::t('yii', 'The file "{file}" is too small. Its size cannot be smaller than {formattedLimit}.');
}
if (!is_array($this->extensions)) {
$this->extensions = preg_split('/[\s,]+/', strtolower((string)$this->extensions), -1, PREG_SPLIT_NO_EMPTY);
} else {
$this->extensions = array_map('strtolower', $this->extensions);
}
if ($this->wrongMimeType === null) {
$this->wrongMimeType = Yii::t('yii', 'Only files with these MIME types are allowed: {mimeTypes}.');
}
if (!is_array($this->mimeTypes)) {
$this->mimeTypes = preg_split('/[\s,]+/', strtolower((string)$this->mimeTypes), -1, PREG_SPLIT_NO_EMPTY);
} else {
$this->mimeTypes = array_map('strtolower', $this->mimeTypes);
}
}
/**
* {@inheritdoc}
*/
public function validateAttribute($model, $attribute)
{
if ($this->maxFiles != 1 || $this->minFiles > 1) {
$rawFiles = $model->$attribute;
if (!is_array($rawFiles)) {
$this->addError($model, $attribute, $this->uploadRequired);
return;
}
$files = $this->filterFiles($rawFiles);
$model->$attribute = $files;
if (empty($files)) {
$this->addError($model, $attribute, $this->uploadRequired);
return;
}
$filesCount = count($files);
if ($this->maxFiles && $filesCount > $this->maxFiles) {
$this->addError($model, $attribute, $this->tooMany, ['limit' => $this->maxFiles]);
}
if ($this->minFiles && $this->minFiles > $filesCount) {
$this->addError($model, $attribute, $this->tooFew, ['limit' => $this->minFiles]);
}
foreach ($files as $file) {
$result = $this->validateValue($file);
if (!empty($result)) {
$this->addError($model, $attribute, $result[0], $result[1]);
}
}
} else {
$result = $this->validateValue($model->$attribute);
if (!empty($result)) {
$this->addError($model, $attribute, $result[0], $result[1]);
}
}
}
/**
* Files filter.
* @param array $files
* @return UploadedFile[]
*/
private function filterFiles(array $files)
{
$result = [];
foreach ($files as $fileName => $file) {
if ($file instanceof UploadedFile && $file->error !== UPLOAD_ERR_NO_FILE) {
$result[$fileName] = $file;
}
}
return $result;
}
/**
* {@inheritdoc}
*/
protected function validateValue($value)
{
if (!$value instanceof UploadedFile || $value->error == UPLOAD_ERR_NO_FILE) {
return [$this->uploadRequired, []];
}
switch ($value->error) {
case UPLOAD_ERR_OK:
if ($this->maxSize !== null && $value->size > $this->getSizeLimit()) {
return [
$this->tooBig,
[
'file' => $value->name,
'limit' => $this->getSizeLimit(),
'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
],
];
} elseif ($this->minSize !== null && $value->size < $this->minSize) {
return [
$this->tooSmall,
[
'file' => $value->name,
'limit' => $this->minSize,
'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
],
];
} elseif (!empty($this->extensions) && !$this->validateExtension($value)) {
return [$this->wrongExtension, ['file' => $value->name, 'extensions' => implode(', ', $this->extensions)]];
} elseif (!empty($this->mimeTypes) && !$this->validateMimeType($value)) {
return [$this->wrongMimeType, ['file' => $value->name, 'mimeTypes' => implode(', ', $this->mimeTypes)]];
}
return null;
case UPLOAD_ERR_INI_SIZE:
case UPLOAD_ERR_FORM_SIZE:
return [$this->tooBig, [
'file' => $value->name,
'limit' => $this->getSizeLimit(),
'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
]];
case UPLOAD_ERR_PARTIAL:
Yii::warning('File was only partially uploaded: ' . $value->name, __METHOD__);
break;
case UPLOAD_ERR_NO_TMP_DIR:
Yii::warning('Missing the temporary folder to store the uploaded file: ' . $value->name, __METHOD__);
break;
case UPLOAD_ERR_CANT_WRITE:
Yii::warning('Failed to write the uploaded file to disk: ' . $value->name, __METHOD__);
break;
case UPLOAD_ERR_EXTENSION:
Yii::warning('File upload was stopped by some PHP extension: ' . $value->name, __METHOD__);
break;
default:
break;
}
return [$this->message, []];
}
/**
* Returns the maximum size allowed for uploaded files.
*
* This is determined based on four factors:
*
* - 'upload_max_filesize' in php.ini
* - 'post_max_size' in php.ini
* - 'MAX_FILE_SIZE' hidden field
* - [[maxSize]]
*
* @return int the size limit for uploaded files.
*/
public function getSizeLimit()
{
// Get the lowest between post_max_size and upload_max_filesize, log a warning if the first is < than the latter
$limit = $this->sizeToBytes(ini_get('upload_max_filesize'));
$postLimit = $this->sizeToBytes(ini_get('post_max_size'));
if ($postLimit > 0 && $postLimit < $limit) {
Yii::warning('PHP.ini\'s \'post_max_size\' is less than \'upload_max_filesize\'.', __METHOD__);
$limit = $postLimit;
}
if ($this->maxSize !== null && $limit > 0 && $this->maxSize < $limit) {
$limit = $this->maxSize;
}
if (isset($_POST['MAX_FILE_SIZE']) && $_POST['MAX_FILE_SIZE'] > 0 && $_POST['MAX_FILE_SIZE'] < $limit) {
$limit = (int) $_POST['MAX_FILE_SIZE'];
}
return $limit;
}
/**
* {@inheritdoc}
* @param bool $trim
*/
public function isEmpty($value, $trim = false)
{
$value = is_array($value) ? reset($value) : $value;
return !($value instanceof UploadedFile) || $value->error == UPLOAD_ERR_NO_FILE;
}
/**
* Converts php.ini style size to bytes.
*
* @param string $sizeStr $sizeStr
* @return int
*/
private function sizeToBytes($sizeStr)
{
switch (substr($sizeStr, -1)) {
case 'M':
case 'm':
return (int) $sizeStr * 1048576;
case 'K':
case 'k':
return (int) $sizeStr * 1024;
case 'G':
case 'g':
return (int) $sizeStr * 1073741824;
default:
return (int) $sizeStr;
}
}
/**
* Checks if given uploaded file have correct type (extension) according current validator settings.
* @param UploadedFile $file
* @return bool
*/
protected function validateExtension($file)
{
$extension = mb_strtolower($file->extension, 'UTF-8');
if ($this->checkExtensionByMimeType) {
$mimeType = FileHelper::getMimeType($file->tempName, null, false);
if ($mimeType === null) {
return false;
}
$extensionsByMimeType = FileHelper::getExtensionsByMimeType($mimeType);
if (!in_array($extension, $extensionsByMimeType, true)) {
return false;
}
}
if (!empty($this->extensions)) {
foreach ((array) $this->extensions as $ext) {
if ($extension === $ext || StringHelper::endsWith($file->name, ".$ext", false)) {
return true;
}
}
return false;
}
return true;
}
/**
* {@inheritdoc}
*/
public function clientValidateAttribute($model, $attribute, $view)
{
ValidationAsset::register($view);
$options = $this->getClientOptions($model, $attribute);
return 'yii.validation.file(attribute, messages, ' . Json::htmlEncode($options) . ');';
}
/**
* {@inheritdoc}
*/
public function getClientOptions($model, $attribute)
{
$label = $model->getAttributeLabel($attribute);
$options = [];
if ($this->message !== null) {
$options['message'] = $this->formatMessage($this->message, [
'attribute' => $label,
]);
}
$options['skipOnEmpty'] = $this->skipOnEmpty;
if (!$this->skipOnEmpty) {
$options['uploadRequired'] = $this->formatMessage($this->uploadRequired, [
'attribute' => $label,
]);
}
if ($this->mimeTypes !== null) {
$mimeTypes = [];
foreach ($this->mimeTypes as $mimeType) {
$mimeTypes[] = new JsExpression(Html::escapeJsRegularExpression($this->buildMimeTypeRegexp($mimeType)));
}
$options['mimeTypes'] = $mimeTypes;
$options['wrongMimeType'] = $this->formatMessage($this->wrongMimeType, [
'attribute' => $label,
'mimeTypes' => implode(', ', $this->mimeTypes),
]);
}
if ($this->extensions !== null) {
$options['extensions'] = $this->extensions;
$options['wrongExtension'] = $this->formatMessage($this->wrongExtension, [
'attribute' => $label,
'extensions' => implode(', ', $this->extensions),
]);
}
if ($this->minSize !== null) {
$options['minSize'] = $this->minSize;
$options['tooSmall'] = $this->formatMessage($this->tooSmall, [
'attribute' => $label,
'limit' => $this->minSize,
'formattedLimit' => Yii::$app->formatter->asShortSize($this->minSize),
]);
}
if ($this->maxSize !== null) {
$options['maxSize'] = $this->maxSize;
$options['tooBig'] = $this->formatMessage($this->tooBig, [
'attribute' => $label,
'limit' => $this->getSizeLimit(),
'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
]);
}
if ($this->maxFiles !== null) {
$options['maxFiles'] = $this->maxFiles;
$options['tooMany'] = $this->formatMessage($this->tooMany, [
'attribute' => $label,
'limit' => $this->maxFiles,
]);
}
return $options;
}
/**
* Builds the RegExp from the $mask.
*
* @param string $mask
* @return string the regular expression
* @see mimeTypes
*/
private function buildMimeTypeRegexp($mask)
{
return '/^' . str_replace('\*', '.*', preg_quote($mask, '/')) . '$/i';
}
/**
* Checks the mimeType of the $file against the list in the [[mimeTypes]] property.
*
* @param UploadedFile $file
* @return bool whether the $file mimeType is allowed
* @throws \yii\base\InvalidConfigException
* @see mimeTypes
* @since 2.0.8
*/
protected function validateMimeType($file)
{
$fileMimeType = $this->getMimeTypeByFile($file->tempName);
if ($fileMimeType === null) {
return false;
}
foreach ($this->mimeTypes as $mimeType) {
if (strcasecmp($mimeType, $fileMimeType) === 0) {
return true;
}
if (strpos($mimeType, '*') !== false && preg_match($this->buildMimeTypeRegexp($mimeType), $fileMimeType)) {
return true;
}
}
return false;
}
/**
* Get MIME type by file path
*
* @param string $filePath
* @return string|null
* @throws \yii\base\InvalidConfigException
* @since 2.0.26
*/
protected function getMimeTypeByFile($filePath)
{
return FileHelper::getMimeType($filePath);
}
}