FauxRequest.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Request;
 
use InvalidArgumentException;
use MediaWiki;
use MediaWiki\Exception\MWException;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\SessionManager;
 
class FauxRequest extends WebRequest {
    private bool $wasPosted;
    private ?string $requestUrl = null;
    private array $serverInfo;
 
    protected array $cookies = [];
    private array $uploadData = [];
 
    public function __construct( array $data = [], $wasPosted = false,
                                $session = null, $protocol = 'http'
    ) {
        $this->requestTime = microtime( true );
        $this->serverInfo = $_SERVER;
 
        $this->data = $data;
        $this->wasPosted = $wasPosted;
        if ( $session instanceof MediaWiki\Session\Session ) {
            $this->sessionId = $session->getSessionId();
        } elseif ( is_array( $session ) ) {
            $mwsession = SessionManager::singleton()->getEmptySession( $this );
            $this->sessionId = $mwsession->getSessionId();
            foreach ( $session as $key => $value ) {
                $mwsession->set( $key, $value );
            }
        } elseif ( $session !== null ) {
            throw new InvalidArgumentException( "MediaWiki\Request\FauxRequest() got bogus session" );
        }
        $this->protocol = $protocol;
    }
 
    public function response(): FauxResponse {
        /* Lazy initialization of response object for this request */
        if ( !$this->response ) {
            $this->response = new FauxResponse();
        }
        return $this->response;
    }
 
    protected function initHeaders() {
        // Nothing to init
    }
 
    public function getText( $name, $default = '' ) {
        # Override; don't recode since we're using internal data
        return (string)$this->getVal( $name, $default );
    }
 
    public function getQueryValues() {
        if ( $this->wasPosted ) {
            return [];
        } else {
            return $this->data;
        }
    }
 
    public function getQueryValuesOnly() {
        return $this->getQueryValues();
    }
 
    public function getMethod() {
        return $this->wasPosted ? 'POST' : 'GET';
    }
 
    public function wasPosted() {
        return $this->wasPosted;
    }
 
    public function getCookie( $key, $prefix = null, $default = null ) {
        if ( $prefix === null ) {
            $cookiePrefix = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::CookiePrefix );
            $prefix = $cookiePrefix;
        }
        $name = $prefix . $key;
        return $this->cookies[$name] ?? $default;
    }
 
    public function setCookie( $key, $value, $prefix = null ) {
        $this->setCookies( [ $key => $value ], $prefix );
    }
 
    public function setCookies( $cookies, $prefix = null ) {
        if ( $prefix === null ) {
            $cookiePrefix = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::CookiePrefix );
            $prefix = $cookiePrefix;
        }
        foreach ( $cookies as $key => $value ) {
            $name = $prefix . $key;
            $this->cookies[$name] = $value;
        }
    }
 
    public function setUploadData( $uploadData ) {
        foreach ( $uploadData as $key => $data ) {
            $this->setUpload( $key, $data );
        }
    }
 
    public function setUpload( $key, $data ) {
        if ( $data instanceof WebRequestUpload ) {
            // cannot reuse MediaWiki\Request\WebRequestUpload, because it contains the original web request object
            $data = [
                'name' => $data->getName(),
                'type' => $data->getType(),
                'tmp_name' => $data->getTempName(),
                'size' => $data->getSize(),
                'error' => $data->getError(),
            ];
        }
        // Check if everything is provided
        if ( !is_array( $data ) ||
            array_diff( WebRequestUpload::REQUIRED_FILEINFO_KEYS, array_keys( $data ) ) !== []
        ) {
            throw new InvalidArgumentException( __METHOD__ . ' got bogus data' );
        }
        $this->uploadData[$key] = $data;
    }
 
    public function getUpload( $key ) {
        return new FauxRequestUpload( $this->uploadData, $this, $key );
    }
 
    public function setRequestURL( string $url ) {
        $this->requestUrl = $url;
 
        if ( preg_match( '@^(.*)://@', $url, $m ) ) {
            $this->protocol = $m[1];
        }
    }
 
    public function hasRequestURL(): bool {
        return $this->requestUrl !== null;
    }
 
    protected function getServerInfo( $name, $default = null ): ?string {
        return $this->serverInfo[$name] ?? $default;
    }
 
    public function setServerInfo( array $info ) {
        $this->serverInfo = $info;
    }
 
    public function getRequestURL() {
        if ( $this->requestUrl === null ) {
            throw new MWException( 'Request URL not set' );
        }
        return $this->requestUrl;
    }
 
    public function getProtocol() {
        return $this->protocol;
    }
 
    public function setHeader( $name, $val ) {
        $this->setHeaders( [ $name => $val ] );
    }
 
    public function setHeaders( $headers ) {
        foreach ( $headers as $name => $val ) {
            $name = strtoupper( $name );
            $this->headers[$name] = $val;
        }
    }
 
    public function getSessionArray() {
        if ( $this->sessionId !== null ) {
            return iterator_to_array( $this->getSession() );
        }
        return null;
    }
 
    public function getPostValues() {
        return $this->wasPosted ? $this->data : [];
    }
 
    public function getRawQueryString() {
        return '';
    }
 
    public function getRawPostString() {
        return '';
    }
 
    public function getRawInput() {
        return '';
    }
 
    protected function getRawIP() {
        return '127.0.0.1';
    }
}