ApiQueryFileRepoInfo.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\FileRepo\FileRepo;
use MediaWiki\FileRepo\RepoGroup;
use MediaWiki\MainConfigNames;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiQueryFileRepoInfo extends ApiQueryBase {
 
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        private readonly RepoGroup $repoGroup,
    ) {
        parent::__construct( $query, $moduleName, 'fri' );
    }
 
    public function execute() {
        $conf = $this->getConfig();
 
        $params = $this->extractRequestParams();
        $props = array_fill_keys( $params['prop'], true );
 
        $repos = [];
 
        $foreignTargets = $conf->get( MainConfigNames::ForeignUploadTargets );
 
        $this->repoGroup->forEachForeignRepo(
            static function ( FileRepo $repo ) use ( &$repos, $props, $foreignTargets ) {
                $repoProps = $repo->getInfo();
                $repoProps['canUpload'] = in_array( $repoProps['name'], $foreignTargets );
 
                $repos[] = array_intersect_key( $repoProps, $props );
            }
        );
 
        $localInfo = $this->repoGroup->getLocalRepo()->getInfo();
        $localInfo['canUpload'] = $conf->get( MainConfigNames::EnableUploads );
        $repos[] = array_intersect_key( $localInfo, $props );
 
        $result = $this->getResult();
        ApiResult::setIndexedTagName( $repos, 'repo' );
        ApiResult::setArrayTypeRecursive( $repos, 'assoc' );
        ApiResult::setArrayType( $repos, 'array' );
        $result->addValue( [ 'query' ], 'repos', $repos );
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        $props = $this->getProps();
 
        return [
            'prop' => [
                ParamValidator::PARAM_DEFAULT => implode( '|', $props ),
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_TYPE => $props,
                ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
            ],
        ];
    }
 
    public function getProps(): array {
        $props = [];
        $this->repoGroup->forEachForeignRepo( static function ( FileRepo $repo ) use ( &$props ) {
            $props = array_merge( $props, array_keys( $repo->getInfo() ) );
        } );
 
        $propValues = array_values( array_unique( array_merge(
            $props,
            array_keys( $this->repoGroup->getLocalRepo()->getInfo() )
        ) ) );
 
        $propValues[] = 'canUpload';
 
        sort( $propValues );
        return $propValues;
    }
 
    protected function getExamplesMessages() {
        $examples = [];
 
        $props = array_intersect( [ 'apiurl', 'name', 'displayname' ], $this->getProps() );
        if ( $props ) {
            $examples['action=query&meta=filerepoinfo&friprop=' . implode( '|', $props )] =
                'apihelp-query+filerepoinfo-example-simple';
        }
 
        return $examples;
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filerepoinfo';
    }
}
 
class_alias( ApiQueryFileRepoInfo::class, 'ApiQueryFileRepoInfo' );