pgleadershipbook
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
pgleadershipbook / trunk / system / HTTP / Files / UploadedFile.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\HTTP\Files; use CodeIgniter\Files\File; use CodeIgniter\HTTP\Exceptions\HTTPException; use Config\Mimes; use Exception; /** * Value object representing a single file uploaded through an * HTTP request. Used by the IncomingRequest class to * provide files. * * Typically, implementors will extend the SplFileInfo class. * * @package CodeIgniter\HTTP */ class UploadedFile extends File implements UploadedFileInterface { /** * The path to the temporary file. * * @var string */ protected $path; /** * The original filename as provided by the client. * * @var string */ protected $originalName; /** * The filename given to a file during a move. * * @var string */ protected $name; /** * The type of file as provided by PHP * * @var string */ protected $originalMimeType; /** * The error constant of the upload * (one of PHP's UPLOADERRXXX constants) * * @var integer */ protected $error; /** * Whether the file has been moved already or not. * * @var boolean */ protected $hasMoved = false; //-------------------------------------------------------------------- /** * Accepts the file information as would be filled in from the $_FILES array. * * @param string $path The temporary location of the uploaded file. * @param string $originalName The client-provided filename. * @param string $mimeType The type of file as provided by PHP * @param integer $size The size of the file, in bytes * @param integer $error The error constant of the upload (one of PHP's UPLOADERRXXX constants) */ public function __construct(string $path, string $originalName, string $mimeType = null, int $size = null, int $error = null) { $this->path = $path; $this->name = $originalName; $this->originalName = $originalName; $this->originalMimeType = $mimeType; $this->size = $size; $this->error = $error; parent::__construct($path, false); } //-------------------------------------------------------------------- /** * Move the uploaded file to a new location. * * $targetPath may be an absolute path, or a relative path. If it is a * relative path, resolution should be the same as used by PHP's rename() * function. * * The original file MUST be removed on completion. * * If this method is called more than once, any subsequent calls MUST raise * an exception. * * When used in an SAPI environment where $_FILES is populated, when writing * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be * used to ensure permissions and upload status are verified correctly. * * If you wish to move to a stream, use getStream(), as SAPI operations * cannot guarantee writing to stream destinations. * * @see http://php.net/is_uploaded_file * @see http://php.net/move_uploaded_file * * @param string $targetPath Path to which to move the uploaded file. * @param string $name the name to rename the file to. * @param boolean $overwrite State for indicating whether to overwrite the previously generated file with the same * name or not. * * @return boolean * * @throws \InvalidArgumentException if the $path specified is invalid. * @throws \RuntimeException on any error during the move operation. * @throws \RuntimeException on the second or subsequent call to the method. */ public function move(string $targetPath, string $name = null, bool $overwrite = false) { $targetPath = $this->setPath($targetPath); //set the target path if ($this->hasMoved) { throw HTTPException::forAlreadyMoved(); } if (! $this->isValid()) { throw HTTPException::forInvalidFile(); } $targetPath = rtrim($targetPath, '/') . '/'; $name = is_null($name) ? $this->getName() : $name; $destination = $overwrite ? $targetPath . $name : $this->getDestination($targetPath . $name); try { move_uploaded_file($this->path, $destination); } catch (Exception $e) { $error = error_get_last(); $message = isset($error['message']) ? strip_tags($error['message']) : ''; throw HTTPException::forMoveFailed(basename($this->path), $targetPath, $message); } @chmod($targetPath, 0777 & ~umask()); // Success, so store our new information $this->path = $targetPath; $this->name = basename($destination); $this->hasMoved = true; return true; } /** * create file target path if * the set path does not exist * * @param string $path * * @return string The path set or created. */ protected function setPath(string $path): string { if (! is_dir($path)) { mkdir($path, 0777, true); //create the index.html file if (! is_file($path . 'index.html')) { $file = fopen($path . 'index.html', 'x+'); fclose($file); } } return $path; } //-------------------------------------------------------------------- /** * Returns whether the file has been moved or not. If it has, * the move() method will not work and certain properties, like * the tempName, will no longer be available. * * @return boolean */ public function hasMoved(): bool { return $this->hasMoved; } //-------------------------------------------------------------------- /** * Retrieve the error associated with the uploaded file. * * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants. * * If the file was uploaded successfully, this method MUST return * UPLOAD_ERR_OK. * * Implementations SHOULD return the value stored in the "error" key of * the file in the $_FILES array. * * @see http://php.net/manual/en/features.file-upload.errors.php * @return integer One of PHP's UPLOAD_ERR_XXX constants. */ public function getError(): int { if (is_null($this->error)) { return UPLOAD_ERR_OK; } return $this->error; } //-------------------------------------------------------------------- /** * Get error string * * @return string */ public function getErrorString(): string { $errors = [ UPLOAD_ERR_OK => lang('HTTP.uploadErrOk'), UPLOAD_ERR_INI_SIZE => lang('HTTP.uploadErrIniSize'), UPLOAD_ERR_FORM_SIZE => lang('HTTP.uploadErrFormSize'), UPLOAD_ERR_PARTIAL => lang('HTTP.uploadErrPartial'), UPLOAD_ERR_NO_FILE => lang('HTTP.uploadErrNoFile'), UPLOAD_ERR_CANT_WRITE => lang('HTTP.uploadErrCantWrite'), UPLOAD_ERR_NO_TMP_DIR => lang('HTTP.uploadErrNoTmpDir'), UPLOAD_ERR_EXTENSION => lang('HTTP.uploadErrExtension'), ]; $error = is_null($this->error) ? UPLOAD_ERR_OK : $this->error; return sprintf($errors[$error] ?? lang('HTTP.uploadErrUnknown'), $this->getName()); } //-------------------------------------------------------------------- /** * Returns the mime type as provided by the client. * This is NOT a trusted value. * For a trusted version, use getMimeType() instead. * * @return string The media type sent by the client or null if none was provided. */ public function getClientMimeType(): string { return $this->originalMimeType; } //-------------------------------------------------------------------- /** * Retrieve the filename. This will typically be the filename sent * by the client, and should not be trusted. If the file has been * moved, this will return the final name of the moved file. * * @return string The filename sent by the client or null if none was provided. */ public function getName(): string { return $this->name; } //-------------------------------------------------------------------- /** * Returns the name of the file as provided by the client during upload. * * @return string */ public function getClientName(): string { return $this->originalName; } //-------------------------------------------------------------------- /** * Gets the temporary filename where the file was uploaded to. * * @return string */ public function getTempName(): string { return $this->path; } //-------------------------------------------------------------------- /** * Overrides SPLFileInfo's to work with uploaded files, since * the temp file that's been uploaded doesn't have an extension. * * Is simply an alias for guessExtension for a safer method * than simply relying on the provided extension. * Additionally it will return clientExtension in case if there are * other extensions with the same mime type. */ public function getExtension(): string { return $this->guessExtension(); } /** * Attempts to determine the best file extension. * * @return string|null */ public function guessExtension(): string { return Mimes::guessExtensionFromType($this->getClientMimeType(), $this->getClientExtension()) ?? $this->getClientExtension(); } //-------------------------------------------------------------------- /** * Returns the original file extension, based on the file name that * was uploaded. This is NOT a trusted source. * For a trusted version, use guessExtension() instead. * * @return string */ public function getClientExtension(): string { return pathinfo($this->originalName, PATHINFO_EXTENSION) ?? ''; } //-------------------------------------------------------------------- /** * Returns whether the file was uploaded successfully, based on whether * it was uploaded via HTTP and has no errors. * * @return boolean */ public function isValid(): bool { return is_uploaded_file($this->path) && $this->error === UPLOAD_ERR_OK; } /** * Save the uploaded file to a new location. * * By default, upload files are saved in writable/uploads directory. The YYYYMMDD folder * and random file name will be created. * * @param string $folderName the folder name to writable/uploads directory. * @param string $fileName the name to rename the file to. * @return string file full path */ public function store(string $folderName = null, string $fileName = null): string { $folderName = rtrim($folderName ?? date('Ymd'), '/') . '/' ; $fileName = $fileName ?? $this->getRandomName(); // Move the uploaded file to a new location. return ($this->move(WRITEPATH . 'uploads/' . $folderName, $fileName)) ? $folderName . $this->name : null; } //-------------------------------------------------------------------- } |
Commits for pgleadershipbook/trunk/system/HTTP/Files/UploadedFile.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Thu 04 Feb, 2021 09:33:04 +0000 | PG Leadership book initial commit |