HttpRequestFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Http;
 
use GuzzleHttp\Client;
use InvalidArgumentException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\Profiler\Profiler;
use MediaWiki\Status\Status;
use Psr\Log\LoggerInterface;
use Wikimedia\Http\MultiHttpClient;
use Wikimedia\Http\TelemetryHeadersInterface;
 
class HttpRequestFactory {
    public const CONSTRUCTOR_OPTIONS = [
        MainConfigNames::HTTPTimeout,
        MainConfigNames::HTTPConnectTimeout,
        MainConfigNames::HTTPMaxTimeout,
        MainConfigNames::HTTPMaxConnectTimeout,
        MainConfigNames::HTTPUserAgentContact,
        MainConfigNames::LocalVirtualHosts,
        MainConfigNames::LocalHTTPProxy,
    ];
 
    public function __construct(
        private readonly ServiceOptions $options,
        private readonly LoggerInterface $logger,
        private readonly ?TelemetryHeadersInterface $telemetry = null,
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
    }
 
    public function create( $url, array $options = [], $caller = __METHOD__ ) {
        if ( !isset( $options['logger'] ) ) {
            $options['logger'] = $this->logger;
        }
        $options['timeout'] = $this->normalizeTimeout(
            $options['timeout'] ?? null,
            $options['maxTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxTimeout ) ?: INF
        );
        $options['connectTimeout'] = $this->normalizeTimeout(
            $options['connectTimeout'] ?? null,
            $options['maxConnectTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPConnectTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxConnectTimeout ) ?: INF
        );
        $client = new GuzzleHttpRequest( $url, $options, $caller, Profiler::instance() );
        if ( $this->telemetry ) {
            $client->addTelemetry( $this->telemetry );
        }
        return $client;
    }
 
    private function normalizeTimeout( $parameter, $maxParameter, $default, $maxConfigured ) {
        if ( $parameter === 'default' || $parameter === null ) {
            if ( !is_numeric( $default ) ) {
                throw new InvalidArgumentException(
                    '$wgHTTPTimeout and $wgHTTPConnectTimeout must be set to a number' );
            }
            $value = $default;
        } else {
            $value = $parameter;
        }
        $max = $maxParameter ?? $maxConfigured;
        if ( $max && $value > $max ) {
            return $max;
        }
 
        return $value;
    }
 
    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 );
 
        $req = $this->create( $url, $options, $caller );
        $status = $req->execute();
 
        if ( $status->isOK() ) {
            return $req->getContent();
        } else {
            $errors = array_map( static fn ( $msg ) => $msg->getKey(), $status->getMessages( '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() {
        // T245170: Also applied to MultiHttpClient.
        // T400881, T422686: Also applied to ForeignAPIRepo, and others.
        $contact = $this->options->get( MainConfigNames::HTTPUserAgentContact );
        return 'MediaWiki/' . MW_VERSION . " ($contact)";
    }
 
    public function createMultiClient( $options = [] ) {
        $options['reqTimeout'] = $this->normalizeTimeout(
            $options['reqTimeout'] ?? $options['timeout'] ?? null,
            $options['maxReqTimeout'] ?? $options['maxTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxTimeout ) ?: INF
        );
        $options['connTimeout'] = $this->normalizeTimeout(
            $options['connTimeout'] ?? $options['connectTimeout'] ?? null,
            $options['maxConnTimeout'] ?? $options['maxConnectTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPConnectTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxConnectTimeout ) ?: INF
        );
        $options += [
            'maxReqTimeout' => $this->options->get( MainConfigNames::HTTPMaxTimeout ) ?: INF,
            'maxConnTimeout' =>
                $this->options->get( MainConfigNames::HTTPMaxConnectTimeout ) ?: INF,
            'userAgent' => $this->getUserAgent(),
            'logger' => $this->logger,
            'localProxy' => $this->options->get( MainConfigNames::LocalHTTPProxy ),
            'localVirtualHosts' => $this->options->get( MainConfigNames::LocalVirtualHosts ),
            'telemetry' => Telemetry::getInstance(),
        ];
        return new MultiHttpClient( $options );
    }
 
    public function createGuzzleClient( array $config = [] ): Client {
        $config['timeout'] = $this->normalizeTimeout(
            $config['timeout'] ?? null,
            $config['maxTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxTimeout ) ?: INF
        );
 
        $config['connect_timeout'] = $this->normalizeTimeout(
            $config['connect_timeout'] ?? null,
            $config['maxConnectTimeout'] ?? null,
            $this->options->get( MainConfigNames::HTTPConnectTimeout ),
            $this->options->get( MainConfigNames::HTTPMaxConnectTimeout ) ?: INF
        );
 
        if ( !isset( $config['headers']['User-Agent'] ) ) {
            $config['headers']['User-Agent'] = $this->getUserAgent();
        }
        if ( $this->telemetry ) {
            $config['headers'] = array_merge(
                $this->telemetry->getRequestHeaders(), $config['headers']
            );
        }
 
        return new Client( $config );
    }
}