ExtraRoutesModule.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Module;
 
use AppendIterator;
use ArrayIterator;
use Iterator;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Rest\BasicAccess\BasicAuthorizerInterface;
use MediaWiki\Rest\Handler\RedirectHandler;
use MediaWiki\Rest\JsonLocalizer;
use MediaWiki\Rest\PathTemplateMatcher\ModuleConfigurationException;
use MediaWiki\Rest\Reporter\ErrorReporter;
use MediaWiki\Rest\ResponseFactory;
use MediaWiki\Rest\RouteDefinitionException;
use MediaWiki\Rest\Router;
use MediaWiki\Rest\Validator\Validator;
use Wikimedia\ObjectFactory\ObjectFactory;
 
class ExtraRoutesModule extends MatcherBasedModule {
 
    private array $routeFiles;
 
    private array $extraRoutes;
 
    private JsonLocalizer $jsonLocalizer;
 
    private ?array $routesFromFiles = null;
 
    private ?array $routeFileTimestamps = null;
 
    private ?string $configHash = null;
 
    public function __construct(
        array $routeFiles,
        array $extraRoutes,
        Router $router,
        ResponseFactory $responseFactory,
        BasicAuthorizerInterface $basicAuth,
        ObjectFactory $objectFactory,
        Validator $restValidator,
        ErrorReporter $errorReporter,
        HookContainer $hookContainer
    ) {
        parent::__construct(
            $router,
            '',
            $responseFactory,
            $basicAuth,
            $objectFactory,
            $restValidator,
            $errorReporter,
            $hookContainer
        );
        $this->routeFiles = $routeFiles;
        $this->extraRoutes = $extraRoutes;
        $this->jsonLocalizer = new JsonLocalizer( $responseFactory );
    }
 
    protected function getConfigHash(): string {
        if ( $this->configHash === null ) {
            $this->configHash = md5( json_encode( [
                'class' => __CLASS__,
                'version' => 1,
                'extraRoutes' => $this->extraRoutes,
                'fileTimestamps' => $this->getRouteFileTimestamps()
            ] ) );
        }
        return $this->configHash;
    }
 
    private function getRoutesFromFiles(): array {
        if ( $this->routesFromFiles !== null ) {
            return $this->routesFromFiles;
        }
 
        $this->routesFromFiles = [];
        $this->routeFileTimestamps = [];
        foreach ( $this->routeFiles as $fileName ) {
            $this->routeFileTimestamps[$fileName] = filemtime( $fileName );
 
            $routes = $this->loadJsonFile( $fileName );
 
            $this->routesFromFiles = array_merge( $this->routesFromFiles, $routes );
        }
 
        return $this->routesFromFiles;
    }
 
    private function getRouteFileTimestamps(): array {
        if ( $this->routeFileTimestamps === null ) {
            $this->routeFileTimestamps = [];
            foreach ( $this->routeFiles as $fileName ) {
                $this->routeFileTimestamps[$fileName] = filemtime( $fileName );
            }
        }
        return $this->routeFileTimestamps;
    }
 
    public function getDefinedPaths(): array {
        $paths = [];
        foreach ( $this->getAllRoutes() as $spec ) {
            $key = $spec['path'];
 
            $methods = isset( $spec['method'] ) ? (array)$spec['method'] : [ 'GET' ];
 
            $paths[$key] = array_merge( $paths[$key] ?? [], $methods );
        }
 
        return $paths;
    }
 
    private function getAllRoutes() {
        $iterator = new AppendIterator;
        $iterator->append( new ArrayIterator( $this->getRoutesFromFiles() ) );
        $iterator->append( new ArrayIterator( $this->extraRoutes ) );
        return $iterator;
    }
 
    protected function initRoutes(): void {
        $routeDefs = $this->getAllRoutes();
 
        foreach ( $routeDefs as $route ) {
            if ( !isset( $route['path'] ) ) {
                throw new RouteDefinitionException( 'Missing path' );
            }
 
            $path = $route['path'];
            $method = $route['method'] ?? 'GET';
            $info = $this->makeRouteInfo( $route );
 
            $this->addRoute( $method, $path, $info );
        }
    }
 
    private function makeRouteInfo( array $route ): array {
        static $objectSpecKeys = [
            'class',
            'factory',
            'services',
            'optional_services',
            'args',
        ];
 
        if ( isset( $route['redirect'] ) ) {
            // Redirect shorthand
            $info = [
                'spec' => [ 'class' => RedirectHandler::class ],
                'config' => $route,
            ];
        } else {
            // Object spec at the top level
            $info = [
                'spec' => array_intersect_key( $route, array_flip( $objectSpecKeys ) ),
                'config' => array_diff_key( $route, array_flip( $objectSpecKeys ) ),
            ];
        }
        if ( isset( $route['openApiSpec'] ) ) {
            $info['openApiSpec'] = $this->jsonLocalizer->localizeJson( $route['openApiSpec'] );
        }
 
        $info['path'] = $route['path'];
        return $info;
    }
 
    public function getOpenApiInfo() {
        // Note that mwapi-1.0 is based on OAS 3.0, so it doesn't support the
        // "summary" property introduced in 3.1.
        return [
            'title' => $this->jsonLocalizer->getFormattedMessage( 'rest-module-extra-routes-title' ),
            'description' => $this->jsonLocalizer->getFormattedMessage( 'rest-module-extra-routes-desc' ),
            'version' => 'undefined',
        ];
    }
}