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