Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
33.33% covered (danger)
33.33%
1 / 3
 CRAP
87.23% covered (warning)
87.23%
41 / 47
HttpApiLookup
0.00% covered (danger)
0.00%
0 / 1
33.33% covered (danger)
33.33%
1 / 3
 13.35
87.23% covered (warning)
87.23%
41 / 47
 __construct
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
3 / 3
 setLogger
n/a
0 / 0
 1
n/a
0 / 0
 getApiUrl
0.00% covered (danger)
0.00%
0 / 1
 3.10
77.78% covered (warning)
77.78%
7 / 9
 actuallyGetApiUrl
0.00% covered (danger)
0.00%
0 / 1
 8.10
88.57% covered (warning)
88.57%
31 / 35
<?php
namespace FileImporter\Remote\MediaWiki;
use DOMDocument;
use DOMElement;
use FileImporter\Data\SourceUrl;
use FileImporter\Exceptions\HttpRequestException;
use FileImporter\Exceptions\ImportException;
use FileImporter\Exceptions\LocalizedImportException;
use FileImporter\Services\Http\HttpRequestExecutor;
use Message;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
 * Lookup that can take a MediaWiki site URL and return the URL of the action API.
 * This service caches APIs that have been found for the lifetime of the object.
 *
 * @license GPL-2.0-or-later
 * @author Addshore
 */
class HttpApiLookup implements LoggerAwareInterface {
    /**
     * @var LoggerInterface
     */
    private $logger;
    /**
     * @var HttpRequestExecutor
     */
    private $httpRequestExecutor;
    /**
     * @var string[] url => apiUrl
     */
    private $resultCache = [];
    /**
     * @param HttpRequestExecutor $httpRequestExecutor
     */
    public function __construct( HttpRequestExecutor $httpRequestExecutor ) {
        $this->httpRequestExecutor = $httpRequestExecutor;
        $this->logger = new NullLogger();
    }
    /**
     * @param LoggerInterface $logger
     * @codeCoverageIgnore
     */
    public function setLogger( LoggerInterface $logger ) {
        $this->logger = $logger;
    }
    /**
     * @param SourceUrl $sourceUrl A URL that points to any editable HTML page in any MediaWiki
     *  wiki. The page is expected to contain a <link rel="EditURI" href="…"> element.
     *
     * @return string URL of api.php
     * @throws ImportException when the request failed
     */
    public function getApiUrl( SourceUrl $sourceUrl ) {
        $pageUrl = $sourceUrl->getUrl();
        if ( array_key_exists( $pageUrl, $this->resultCache ) ) {
            return $this->resultCache[$pageUrl];
        }
        $api = $this->actuallyGetApiUrl( $pageUrl );
        if ( $api ) {
            $this->resultCache[$pageUrl] = $api;
            return $api;
        }
        $this->logger->error( 'Failed to get MediaWiki API from SourceUrl.' );
        throw new LocalizedImportException( 'fileimporter-mediawiki-api-notfound' );
    }
    /**
     * @param string $pageUrl
     *
     * @return string|null
     * @throws ImportException when the request failed
     */
    private function actuallyGetApiUrl( $pageUrl ) {
        try {
            $req = $this->httpRequestExecutor->execute( $pageUrl );
        } catch ( HttpRequestException $ex ) {
            $statusCode = $ex->getHttpRequest()->getStatus();
            $errors = $ex->getStatusValue()->getErrors();
            $error = reset( $errors );
            if ( $statusCode === 404 ) {
                $msg = [ 'fileimporter-api-file-notfound', Message::plaintextParam( $pageUrl ) ];
            } else {
                $msg = [
                    'fileimporter-api-failedtofindapi',
                    $pageUrl,
                    // Note: If a parameter to a Message is another Message, it will be forced to
                    // use the same language.
                    $statusCode !== 200
                        ? wfMessage( 'fileimporter-http-statuscode', $statusCode )
                        : '',
                    $error
                        ? wfMessage( $error['message'], $error['params'] )
                        : ''
                ];
            }
            $this->logger->error( 'Failed to discover API location from: ' . $pageUrl, [
                'statusCode' => $statusCode,
                'previousMessage' => $error ? $error['message'] : '',
                'responseContent' => $ex->getHttpRequest()->getContent(),
            ] );
            throw new LocalizedImportException( $msg );
        }
        $document = new DOMDocument();
        $oldXmlErrorUsage = libxml_use_internal_errors( true );
        $document->loadHTML( $req->getContent() );
        libxml_clear_errors();
        libxml_use_internal_errors( $oldXmlErrorUsage );
        $elements = $document->getElementsByTagName( 'link' );
        foreach ( $elements as $element ) {
            /** @var DOMElement $element */
            if ( $element->getAttribute( 'rel' ) === 'EditURI' ) {
                $editUri = $element->getAttribute( 'href' );
                $api = str_replace( '?action=rsd', '', $editUri );
                // Always prefer HTTPS because of (optional) edit/delete requests, see T228851
                return wfExpandUrl( $api, PROTO_HTTPS );
            }
        }
        $this->logger->error(
            'Failed to discover API location from: "' . $pageUrl . '".',
            [
                'responseContent' => $req->getContent(),
            ]
        );
        return null;
    }
}