HttpRequestFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Http;

use CurlHttpRequest;
use GuzzleHttpRequest;
use Http;
use MediaWiki\Logger\LoggerFactory;
use MWHttpRequest;
use PhpHttpRequest;
use Profiler;
use RuntimeException;
use Status;

class HttpRequestFactory {
    public function create( $url, array $options = [], $caller = __METHOD__ ) {
        if ( !Http::$httpEngine ) {
            Http::$httpEngine = 'guzzle';
        }

        if ( !isset( $options['logger'] ) ) {
            $options['logger'] = LoggerFactory::getInstance( 'http' );
        }

        switch ( Http::$httpEngine ) {
            case 'guzzle':
                return new GuzzleHttpRequest( $url, $options, $caller, Profiler::instance() );
            case 'curl':
                return new CurlHttpRequest( $url, $options, $caller, Profiler::instance() );
            case 'php':
                return new PhpHttpRequest( $url, $options, $caller, Profiler::instance() );
            default:
                throw new RuntimeException( __METHOD__ . ': The requested engine is not valid.' );
        }
    }

    public function canMakeRequests() {
        return function_exists( 'curl_init' ) || wfIniGetBool( 'allow_url_fopen' );
    }

    public function request( $method, $url, array $options = [], $caller = __METHOD__ ) {
        $logger = LoggerFactory::getInstance( 'http' );
        $logger->debug( "$method: $url" );

        $options['method'] = strtoupper( $method );

        if ( !isset( $options['timeout'] ) ) {
            $options['timeout'] = 'default';
        }
        if ( !isset( $options['connectTimeout'] ) ) {
            $options['connectTimeout'] = 'default';
        }

        $req = $this->create( $url, $options, $caller );
        $status = $req->execute();

        if ( $status->isOK() ) {
            return $req->getContent();
        } else {
            $errors = $status->getErrorsByType( 'error' );
            $logger->warning( Status::wrap( $status )->getWikiText( false, false, 'en' ),
                [ 'error' => $errors, 'caller' => $caller, 'content' => $req->getContent() ] );
            return null;
        }
    }

    public function get( $url, array $options = [], $caller = __METHOD__ ) {
        return $this->request( 'GET', $url, $options, $caller );
    }

    public function post( $url, array $options = [], $caller = __METHOD__ ) {
        return $this->request( 'POST', $url, $options, $caller );
    }

    public function getUserAgent() {
        global $wgVersion;

        return "MediaWiki/$wgVersion";
    }
}