Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Validator for check not protected/available path
*
* Mask symbols from path:
* "?" - something directory with any name
* "*" - something directory structure, which can not exist
* Note: For set directory structure which must be exist, need to set mask "/?/{@*}"
* Mask symbols from filename:
* "*" - something symbols in file name
* Example:
* <code>
* //set available path
* $validator->setAvailablePath(array('/path/to/?/*fileMask.xml'));
* $validator->isValid('/path/to/MyDir/Some-fileMask.xml'); //return true
* $validator->setAvailablePath(array('/path/to/{@*}*.xml'));
* $validator->isValid('/path/to/my.xml'); //return true, because directory structure can't exist
* </code>
*
* @author Magento Core Team <core@magentocommerce.com>
*/
namespace Magento\MediaStorage\Model\File\Validator;
use Laminas\Validator\AbstractValidator;
class AvailablePath extends AbstractValidator
{
public const PROTECTED_PATH = 'protectedPath';
public const NOT_AVAILABLE_PATH = 'notAvailablePath';
public const PROTECTED_LFI = 'protectedLfi';
/**
* The path
*
* @var string
*/
protected $value;
/**
* @var string[]
*/
protected $_protectedPaths = [];
/**
* @var string[]
*/
protected $_availablePaths = [];
/**
* Cache of made regular expressions from path masks
*
* @var array
*/
protected $_pathsData;
/**
* @var array
*/
protected $messageTemplates;
/**
* Construct
*/
public function __construct()
{
$this->_initMessageTemplates();
parent::__construct();
}
/**
* Initialize message templates with translating
*
* @return $this
*/
protected function _initMessageTemplates()
{
if (!$this->messageTemplates) {
$this->messageTemplates = [
self::PROTECTED_PATH => __('Path "%value%" is protected and cannot be used.'),
self::NOT_AVAILABLE_PATH => __('Path "%value%" is not available and cannot be used.'),
self::PROTECTED_LFI => __('Path "%value%" may not include parent directory traversal ("../", "..\\").'),
];
}
return $this;
}
/**
* Set paths masks
*
* @param array $paths All paths masks types.
* E.g.: array('available' => array(...), 'protected' => array(...))
* @return $this
*/
public function setPaths(array $paths)
{
if (isset($paths['available']) && is_array($paths['available'])) {
$this->_availablePaths = $paths['available'];
}
if (isset($paths['protected']) && is_array($paths['protected'])) {
$this->_protectedPaths = $paths['protected'];
}
return $this;
}
/**
* Set protected paths masks
*
* @param array $paths
* @return $this
*/
public function setProtectedPaths(array $paths)
{
$this->_protectedPaths = $paths;
return $this;
}
/**
* Add protected paths masks
*
* @param string|string[] $path
* @return $this
*/
public function addProtectedPath($path)
{
if (is_array($path)) {
$this->_protectedPaths = array_merge($this->_protectedPaths, $path);
} else {
$this->_protectedPaths[] = $path;
}
return $this;
}
/**
* Get protected paths masks
*
* @return string[]
*/
public function getProtectedPaths()
{
return $this->_protectedPaths;
}
/**
* Set available paths masks
*
* @param array $paths
* @return $this
*/
public function setAvailablePaths(array $paths)
{
$this->_availablePaths = $paths;
return $this;
}
/**
* Add available paths mask
*
* @param string|string[] $path
* @return $this
*/
public function addAvailablePath($path)
{
if (is_array($path)) {
$this->_availablePaths = array_merge($this->_availablePaths, $path);
} else {
$this->_availablePaths[] = $path;
}
return $this;
}
/**
* Get available paths masks
*
* @return string[]
*/
public function getAvailablePaths()
{
return $this->_availablePaths;
}
/**
* Returns true if and only if $value meets the validation requirements
*
* If $value fails validation, then this method returns false, and
* getMessages() will return an array of messages that explain why the
* validation failed.
*
* @param string $value File/dir path
* @return bool
* @throws \Exception Throw exception on empty both paths masks types
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
public function isValid($value)
{
$value = $value !== null ? trim($value) : '';
$this->setValue($value);
if (!$this->_availablePaths && !$this->_protectedPaths) {
// phpcs:ignore Magento2.Exceptions.DirectThrow
throw new \Exception(__('Please set available and/or protected paths list(s) before validation.'));
}
if ($this->value && preg_match('#\.\.[\\\/]#', $this->value)) {
$this->error(self::PROTECTED_LFI, $this->value);
return false;
}
//validation
$value = str_replace('\\', '/', $this->value ?? '');
// phpcs:disable Magento2.Functions.DiscouragedFunction
$valuePathInfo = pathinfo(ltrim($value, '\\/'));
if ($valuePathInfo['dirname'] == '.' || $valuePathInfo['dirname'] == '/') {
$valuePathInfo['dirname'] = '';
}
if ($this->_protectedPaths && !$this->_isValidByPaths($valuePathInfo, $this->_protectedPaths, true)) {
$this->error(self::PROTECTED_PATH, $this->value);
return false;
}
if ($this->_availablePaths && !$this->_isValidByPaths($valuePathInfo, $this->_availablePaths, false)) {
$this->error(self::NOT_AVAILABLE_PATH, $this->value);
return false;
}
return true;
}
/**
* Validate value by path masks
*
* @param array $valuePathInfo Path info from value path
* @param string[] $paths Protected/available paths masks
* @param bool $protected Paths masks is protected?
* @return bool
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function _isValidByPaths($valuePathInfo, $paths, $protected)
{
foreach ($paths as $path) {
$path = $path !== null ? ltrim($path, '\\/') : '';
if (!isset($this->_pathsData[$path]['regFilename'])) {
// phpcs:disable Magento2.Functions.DiscouragedFunction
$pathInfo = pathinfo($path);
$options['file_mask'] = $pathInfo['basename'];
if ($pathInfo['dirname'] == '.' || $pathInfo['dirname'] == '/') {
$pathInfo['dirname'] = '';
} else {
$pathInfo['dirname'] = str_replace('\\', '/', $pathInfo['dirname'] ?? '');
}
$options['dir_mask'] = $pathInfo['dirname'];
$this->_pathsData[$path]['options'] = $options;
} else {
$options = $this->_pathsData[$path]['options'];
}
//file mask
if (false !== strpos($options['file_mask'] ?? '', '*')) {
if (!isset($this->_pathsData[$path]['regFilename'])) {
//make regular
$reg = $options['file_mask'] ?? '';
$reg = str_replace('.', '\.', $reg);
$reg = str_replace('*', '.*?', $reg);
$reg = "/^({$reg})\$/";
} else {
$reg = $this->_pathsData[$path]['regFilename'];
}
$resultFile = preg_match($reg, $valuePathInfo['basename'] ?? '');
} else {
$resultFile = $options['file_mask'] == $valuePathInfo['basename'];
}
//directory mask
$reg = $options['dir_mask'] . '/';
if (!isset($this->_pathsData[$path]['regDir'])) {
//make regular
$reg = str_replace('.', '\.', $reg);
$reg = str_replace('*\\', '||', $reg);
$reg = str_replace('*/', '||', $reg);
//$reg = str_replace('*', '||', $reg);
$reg = str_replace('/', '[\\/]', $reg);
$reg = str_replace('?', '([^\\/]+)', $reg);
$reg = str_replace('||', '(.*[\\/])?', $reg);
$reg = "/^{$reg}\$/";
} else {
$reg = $this->_pathsData[$path]['regDir'];
}
$resultDir = preg_match($reg, $valuePathInfo['dirname'] . '/');
if ($protected && ($resultDir && $resultFile)) {
return false;
} elseif (!$protected && ($resultDir && $resultFile)) {
//return true because one match with available path mask
return true;
}
}
if ($protected) {
return true;
} else {
//return false because no one match with available path mask
return false;
}
}
}