[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright   (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license     GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Form\Rule;
  11  
  12  use Joomla\CMS\Filesystem\Folder;
  13  use Joomla\CMS\Filesystem\Path;
  14  use Joomla\CMS\Form\Form;
  15  use Joomla\Registry\Registry;
  16  
  17  // phpcs:disable PSR1.Files.SideEffects
  18  \defined('JPATH_PLATFORM') or die;
  19  // phpcs:enable PSR1.Files.SideEffects
  20  
  21  /**
  22   * Form Rule class for the Joomla CMS.
  23   *
  24   * @since  4.0.0
  25   */
  26  class FolderPathExistsRule extends FilePathRule
  27  {
  28      /**
  29       * Method to test if the folder path is valid and points to an existing folder below the Joomla root
  30       *
  31       * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
  32       * @param   mixed              $value    The form field value to validate.
  33       * @param   string             $group    The field name group control value. This acts as an array container for the field.
  34       *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  35       *                                       full field name would end up being "bar[foo]".
  36       * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
  37       * @param   Form               $form     The form object for which the field is being tested.
  38       *
  39       * @return  boolean  True if the value is valid and points to an existing folder below the Joomla root, false otherwise.
  40       *
  41       * @since   4.0.0
  42       */
  43      public function test(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
  44      {
  45          if (!parent::test($element, $value, $group, $input, $form)) {
  46              return false;
  47          }
  48  
  49          // If the field is empty and not required so the previous test hasn't failed, the field is valid.
  50          if ($value === '' || $value === null) {
  51              return true;
  52          }
  53  
  54          // Spaces only would result in Joomla root which is not allowed
  55          if (!trim($value)) {
  56              return false;
  57          }
  58  
  59          $pathCleaned = rtrim(Path::clean(JPATH_ROOT . '/' . $value), \DIRECTORY_SEPARATOR);
  60          $rootCleaned = rtrim(Path::clean(JPATH_ROOT), \DIRECTORY_SEPARATOR);
  61  
  62          // JPATH_ROOT is not allowed
  63          if ($pathCleaned === $rootCleaned) {
  64              return false;
  65          }
  66  
  67          return Folder::exists($pathCleaned);
  68      }
  69  }