- md5
- 67c96d9e7be3f4e0080f30c94cf99c19
- sha1
- 40c08243a4ae5d8279709224b0b500656e94750f
- sha256
- b42d0737b5190033d14040754d537814b3a13a8785eceddb1c789f84e763b795
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Form\Rule;
use Joomla\CMS\Filesystem\Folder;
use Joomla\CMS\Filesystem\Path;
use Joomla\CMS\Form\Form;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Form Rule class for the Joomla CMS.
*
* @since 4.0.0
*/
class FolderPathExistsRule extends FilePathRule
{
/**
* Method to test if the folder path is valid and points to an existing folder below the Joomla root
*
* @param \SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control value. This acts as an array container for the field.
* For example if the field has name="foo" and the group value is set to "bar" then the
* full field name would end up being "bar[foo]".
* @param Registry $input An optional Registry object with the entire data set to validate against the entire form.
* @param Form $form The form object for which the field is being tested.
*
* @return boolean True if the value is valid and points to an existing folder below the Joomla root, false otherwise.
*
* @since 4.0.0
*/
public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
{
if (!parent::test($element, $value, $group, $input, $form)) {
return false;
}
// If the field is empty and not required so the previous test hasn't failed, the field is valid.
if ($value === '' || $value === null) {
return true;
}
// Spaces only would result in Joomla root which is not allowed
if (!trim($value)) {
return false;
}
$pathCleaned = rtrim(Path::clean(JPATH_ROOT . '/' . $value), \DIRECTORY_SEPARATOR);
$rootCleaned = rtrim(Path::clean(JPATH_ROOT), \DIRECTORY_SEPARATOR);
// JPATH_ROOT is not allowed
if ($pathCleaned === $rootCleaned) {
return false;
}
return Folder::exists($pathCleaned);
}
}
The same content is in 33 releases, Joomla 4.2.1 to 4.3.4. See them all, or every version of this file.