WebRequestUpload.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Request;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Sanitizer;
 
// The point of this class is to be a wrapper around super globals
// phpcs:disable MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
 
class WebRequestUpload {
    public const REQUIRED_FILEINFO_KEYS = [ 'name', 'size', 'tmp_name', 'type', 'error', ];
    protected $request;
    protected $doesExist;
    protected $fileInfo;
 
    public function __construct( $request, $key ) {
        $this->request = $request;
        $this->doesExist = isset( $_FILES[$key] );
        if ( $this->doesExist ) {
            $this->fileInfo = $_FILES[$key];
        }
    }
 
    public function exists() {
        return $this->doesExist;
    }
 
    public function getName() {
        if ( !$this->exists() ) {
            return null;
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        $name = $this->fileInfo['name'];
 
        # Safari sends filenames in HTML-encoded Unicode form D...
        # Horrid and evil! Let's try to make some kind of sense of it.
        $name = Sanitizer::decodeCharReferences( $name );
        $name = MediaWikiServices::getInstance()->getContentLanguage()->normalize( $name );
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        wfDebug( __METHOD__ . ": {$this->fileInfo['name']} normalized to '$name'" );
        return $name;
    }
 
    public function getSize() {
        if ( !$this->exists() ) {
            return 0;
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        return $this->fileInfo['size'];
    }
 
    public function getTempName() {
        if ( !$this->exists() ) {
            return null;
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        return $this->fileInfo['tmp_name'];
    }
 
    public function getType() {
        if ( !$this->exists() ) {
            return null;
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        return $this->fileInfo['type'];
    }
 
    public function getError() {
        if ( !$this->exists() ) {
            return 0; # UPLOAD_ERR_OK
        }
 
        // @phan-suppress-next-line PhanTypeArraySuspiciousNullable Okay after exists check
        return $this->fileInfo['error'];
    }
 
    public function isIniSizeOverflow() {
        if ( $this->getError() == UPLOAD_ERR_INI_SIZE ) {
            # PHP indicated that upload_max_filesize is exceeded
            return true;
        }
 
        $contentLength = $this->request->getHeader( 'Content-Length' );
        $maxPostSize = wfShorthandToInteger( ini_get( 'post_max_size' ), 0 );
 
        if ( $maxPostSize && $contentLength > $maxPostSize ) {
            # post_max_size is exceeded
            return true;
        }
 
        return false;
    }
}