vendor/symfony/http-foundation/File/UploadedFile.php line 32

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpFoundation\File;
  14. use Symfony\Component\HttpFoundation\File\Exception\CannotWriteFileException;
  15. use Symfony\Component\HttpFoundation\File\Exception\ExtensionFileException;
  16. use Symfony\Component\HttpFoundation\File\Exception\FileException;
  17. use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;
  18. use Symfony\Component\HttpFoundation\File\Exception\FormSizeFileException;
  19. use Symfony\Component\HttpFoundation\File\Exception\IniSizeFileException;
  20. use Symfony\Component\HttpFoundation\File\Exception\NoFileException;
  21. use Symfony\Component\HttpFoundation\File\Exception\NoTmpDirFileException;
  22. use Symfony\Component\HttpFoundation\File\Exception\PartialFileException;
  23. use Symfony\Component\Mime\MimeTypes;
  25. /**
  26.  * A file uploaded through a form.
  27.  *
  28.  * @author Bernhard Schussek <bschussek@gmail.com>
  29.  * @author Florian Eckerstorfer <florian@eckerstorfer.org>
  30.  * @author Fabien Potencier <fabien@symfony.com>
  31.  */
  32. class UploadedFile extends File
  33. {
  34.     private $test;
  35.     private $originalName;
  36.     private $mimeType;
  37.     private $error;
  39.     /**
  40.      * Accepts the information of the uploaded file as provided by the PHP global $_FILES.
  41.      *
  42.      * The file object is only created when the uploaded file is valid (i.e. when the
  43.      * isValid() method returns true). Otherwise the only methods that could be called
  44.      * on an UploadedFile instance are:
  45.      *
  46.      *   * getClientOriginalName,
  47.      *   * getClientMimeType,
  48.      *   * isValid,
  49.      *   * getError.
  50.      *
  51.      * Calling any other method on an non-valid instance will cause an unpredictable result.
  52.      *
  53.      * @param string      $path         The full temporary path to the file
  54.      * @param string      $originalName The original file name of the uploaded file
  55.      * @param string|null $mimeType     The type of the file as provided by PHP; null defaults to application/octet-stream
  56.      * @param int|null    $error        The error constant of the upload (one of PHP's UPLOAD_ERR_XXX constants); null defaults to UPLOAD_ERR_OK
  57.      * @param bool        $test         Whether the test mode is active
  58.      *                                  Local files are used in test mode hence the code should not enforce HTTP uploads
  59.      *
  60.      * @throws FileException         If file_uploads is disabled
  61.      * @throws FileNotFoundException If the file does not exist
  62.      */
  63.     public function __construct(string $path, string $originalName, string $mimeType = null, int $error = null, $test = false)
  64.     {
  65.         $this->originalName = $this->getName($originalName);
  66.         $this->mimeType = $mimeType ?: 'application/octet-stream';
  68.         if (4 < \func_num_args() ? !\is_bool($test) : null !== $error && @filesize($path) === $error) {
  69.             @trigger_error(sprintf('Passing a size as 4th argument to the constructor of "%s" is deprecated since Symfony 4.1.', __CLASS__), \E_USER_DEPRECATED);
  70.             $error = $test;
  71.             $test = 5 < \func_num_args() ? func_get_arg(5) : false;
  72.         }
  74.         $this->error = $error ?: \UPLOAD_ERR_OK;
  75.         $this->test = $test;
  77.         parent::__construct($path, \UPLOAD_ERR_OK === $this->error);
  78.     }
  80.     /**
  81.      * Returns the original file name.
  82.      *
  83.      * It is extracted from the request from which the file has been uploaded.
  84.      * Then it should not be considered as a safe value.
  85.      *
  86.      * @return string The original name
  87.      */
  88.     public function getClientOriginalName()
  89.     {
  90.         return $this->originalName;
  91.     }
  93.     /**
  94.      * Returns the original file extension.
  95.      *
  96.      * It is extracted from the original file name that was uploaded.
  97.      * Then it should not be considered as a safe value.
  98.      *
  99.      * @return string The extension
  100.      */
  101.     public function getClientOriginalExtension()
  102.     {
  103.         return pathinfo($this->originalName, \PATHINFO_EXTENSION);
  104.     }
  106.     /**
  107.      * Returns the file mime type.
  108.      *
  109.      * The client mime type is extracted from the request from which the file
  110.      * was uploaded, so it should not be considered as a safe value.
  111.      *
  112.      * For a trusted mime type, use getMimeType() instead (which guesses the mime
  113.      * type based on the file content).
  114.      *
  115.      * @return string The mime type
  116.      *
  117.      * @see getMimeType()
  118.      */
  119.     public function getClientMimeType()
  120.     {
  121.         return $this->mimeType;
  122.     }
  124.     /**
  125.      * Returns the extension based on the client mime type.
  126.      *
  127.      * If the mime type is unknown, returns null.
  128.      *
  129.      * This method uses the mime type as guessed by getClientMimeType()
  130.      * to guess the file extension. As such, the extension returned
  131.      * by this method cannot be trusted.
  132.      *
  133.      * For a trusted extension, use guessExtension() instead (which guesses
  134.      * the extension based on the guessed mime type for the file).
  135.      *
  136.      * @return string|null The guessed extension or null if it cannot be guessed
  137.      *
  138.      * @see guessExtension()
  139.      * @see getClientMimeType()
  140.      */
  141.     public function guessClientExtension()
  142.     {
  143.         return MimeTypes::getDefault()->getExtensions($this->getClientMimeType())[0] ?? null;
  144.     }
  146.     /**
  147.      * Returns the file size.
  148.      *
  149.      * It is extracted from the request from which the file has been uploaded.
  150.      * Then it should not be considered as a safe value.
  151.      *
  152.      * @deprecated since Symfony 4.1, use getSize() instead.
  153.      *
  154.      * @return int|null The file sizes
  155.      */
  156.     public function getClientSize()
  157.     {
  158.         @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.1. Use getSize() instead.', __METHOD__), \E_USER_DEPRECATED);
  160.         return $this->getSize();
  161.     }
  163.     /**
  164.      * Returns the upload error.
  165.      *
  166.      * If the upload was successful, the constant UPLOAD_ERR_OK is returned.
  167.      * Otherwise one of the other UPLOAD_ERR_XXX constants is returned.
  168.      *
  169.      * @return int The upload error
  170.      */
  171.     public function getError()
  172.     {
  173.         return $this->error;
  174.     }
  176.     /**
  177.      * Returns whether the file was uploaded successfully.
  178.      *
  179.      * @return bool True if the file has been uploaded with HTTP and no error occurred
  180.      */
  181.     public function isValid()
  182.     {
  183.         $isOk = \UPLOAD_ERR_OK === $this->error;
  185.         return $this->test ? $isOk : $isOk && is_uploaded_file($this->getPathname());
  186.     }
  188.     /**
  189.      * Moves the file to a new location.
  190.      *
  191.      * @param string $directory The destination folder
  192.      * @param string $name      The new file name
  193.      *
  194.      * @return File A File object representing the new file
  195.      *
  196.      * @throws FileException if, for any reason, the file could not have been moved
  197.      */
  198.     public function move($directory, $name = null)
  199.     {
  200.         if ($this->isValid()) {
  201.             if ($this->test) {
  202.                 return parent::move($directory, $name);
  203.             }
  205.             $target = $this->getTargetFile($directory, $name);
  207.             set_error_handler(function ($type, $msg) use (&$error) { $error = $msg; });
  208.             $moved = move_uploaded_file($this->getPathname(), $target);
  209.             restore_error_handler();
  210.             if (!$moved) {
  211.                 throw new FileException(sprintf('Could not move the file "%s" to "%s" (%s).', $this->getPathname(), $target, strip_tags($error)));
  212.             }
  214.             @chmod($target, 0666 & ~umask());
  216.             return $target;
  217.         }
  219.         switch ($this->error) {
  220.             case \UPLOAD_ERR_INI_SIZE:
  221.                 throw new IniSizeFileException($this->getErrorMessage());
  222.             case \UPLOAD_ERR_FORM_SIZE:
  223.                 throw new FormSizeFileException($this->getErrorMessage());
  224.             case \UPLOAD_ERR_PARTIAL:
  225.                 throw new PartialFileException($this->getErrorMessage());
  226.             case \UPLOAD_ERR_NO_FILE:
  227.                 throw new NoFileException($this->getErrorMessage());
  228.             case \UPLOAD_ERR_CANT_WRITE:
  229.                 throw new CannotWriteFileException($this->getErrorMessage());
  230.             case \UPLOAD_ERR_NO_TMP_DIR:
  231.                 throw new NoTmpDirFileException($this->getErrorMessage());
  232.             case \UPLOAD_ERR_EXTENSION:
  233.                 throw new ExtensionFileException($this->getErrorMessage());
  234.         }
  236.         throw new FileException($this->getErrorMessage());
  237.     }
  239.     /**
  240.      * Returns the maximum size of an uploaded file as configured in php.ini.
  241.      *
  242.      * @return int|float The maximum size of an uploaded file in bytes (returns float if size > PHP_INT_MAX)
  243.      */
  244.     public static function getMaxFilesize()
  245.     {
  246.         $sizePostMax = self::parseFilesize(ini_get('post_max_size'));
  247.         $sizeUploadMax = self::parseFilesize(ini_get('upload_max_filesize'));
  249.         return min($sizePostMax ?: \PHP_INT_MAX, $sizeUploadMax ?: \PHP_INT_MAX);
  250.     }
  252.     /**
  253.      * Returns the given size from an ini value in bytes.
  254.      *
  255.      * @return int|float Returns float if size > PHP_INT_MAX
  256.      */
  257.     private static function parseFilesize($size)
  258.     {
  259.         if ('' === $size) {
  260.             return 0;
  261.         }
  263.         $size = strtolower($size);
  265.         $max = ltrim($size, '+');
  266.         if (0 === strpos($max, '0x')) {
  267.             $max = \intval($max, 16);
  268.         } elseif (0 === strpos($max, '0')) {
  269.             $max = \intval($max, 8);
  270.         } else {
  271.             $max = (int) $max;
  272.         }
  274.         switch (substr($size, -1)) {
  275.             case 't': $max *= 1024;
  276.             // no break
  277.             case 'g': $max *= 1024;
  278.             // no break
  279.             case 'm': $max *= 1024;
  280.             // no break
  281.             case 'k': $max *= 1024;
  282.         }
  284.         return $max;
  285.     }
  287.     /**
  288.      * Returns an informative upload error message.
  289.      *
  290.      * @return string The error message regarding the specified error code
  291.      */
  292.     public function getErrorMessage()
  293.     {
  294.         static $errors = [
  295.             \UPLOAD_ERR_INI_SIZE => 'The file "%s" exceeds your upload_max_filesize ini directive (limit is %d KiB).',
  296.             \UPLOAD_ERR_FORM_SIZE => 'The file "%s" exceeds the upload limit defined in your form.',
  297.             \UPLOAD_ERR_PARTIAL => 'The file "%s" was only partially uploaded.',
  298.             \UPLOAD_ERR_NO_FILE => 'No file was uploaded.',
  299.             \UPLOAD_ERR_CANT_WRITE => 'The file "%s" could not be written on disk.',
  300.             \UPLOAD_ERR_NO_TMP_DIR => 'File could not be uploaded: missing temporary directory.',
  301.             \UPLOAD_ERR_EXTENSION => 'File upload was stopped by a PHP extension.',
  302.         ];
  304.         $errorCode = $this->error;
  305.         $maxFilesize = \UPLOAD_ERR_INI_SIZE === $errorCode ? self::getMaxFilesize() / 1024 : 0;
  306.         $message = $errors[$errorCode] ?? 'The file "%s" was not uploaded due to an unknown error.';
  308.         return sprintf($message, $this->getClientOriginalName(), $maxFilesize);
  309.     }
  310. }