SpecialListFiles.php

Go to the documentation of this file.

<?php
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\CommentStore\CommentStore;
use MediaWiki\User\UserNamePrefixSearch;
use MediaWiki\User\UserNameUtils;
use MediaWiki\User\UserRigorOptions;
use Wikimedia\Rdbms\ILoadBalancer;
 
class SpecialListFiles extends IncludableSpecialPage {
 
    private $repoGroup;
 
    private $loadBalancer;
 
    private $commentStore;
 
    private $userNameUtils;
 
    private $userNamePrefixSearch;
 
    private $userCache;
 
    private $commentFormatter;
 
    public function __construct(
        RepoGroup $repoGroup,
        ILoadBalancer $loadBalancer,
        CommentStore $commentStore,
        UserNameUtils $userNameUtils,
        UserNamePrefixSearch $userNamePrefixSearch,
        UserCache $userCache,
        CommentFormatter $commentFormatter
    ) {
        parent::__construct( 'Listfiles' );
        $this->repoGroup = $repoGroup;
        $this->loadBalancer = $loadBalancer;
        $this->commentStore = $commentStore;
        $this->userNameUtils = $userNameUtils;
        $this->userNamePrefixSearch = $userNamePrefixSearch;
        $this->userCache = $userCache;
        $this->commentFormatter = $commentFormatter;
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $this->addHelpLink( 'Help:Managing_files' );
 
        if ( $this->including() ) {
            $userName = (string)$par;
            $search = '';
            $showAll = false;
        } else {
            $userName = $this->getRequest()->getText( 'user', $par ?? '' );
            $search = $this->getRequest()->getText( 'ilsearch', '' );
            $showAll = $this->getRequest()->getBool( 'ilshowall', false );
        }
        // Sanitize usernames to avoid symbols in the title of page.
        $sanitizedUserName = $this->userNameUtils->getCanonical( $userName, UserRigorOptions::RIGOR_NONE );
        if ( $sanitizedUserName ) {
            $userName = $sanitizedUserName;
        }
 
        if ( $userName ) {
            $pageTitle = $this->msg( 'listfiles_subpage', $userName );
        } else {
            $pageTitle = $this->msg( 'listfiles' );
        }
 
        $pager = new ImageListPager(
            $this->getContext(),
            $this->commentStore,
            $this->getLinkRenderer(),
            $this->loadBalancer,
            $this->repoGroup,
            $this->userCache,
            $this->userNameUtils,
            $this->commentFormatter,
            $userName,
            $search,
            $this->including(),
            $showAll
        );
 
        $out = $this->getOutput();
        $out->setPageTitle( $pageTitle );
        $out->addModuleStyles( 'mediawiki.special' );
        if ( $this->including() ) {
            $out->addParserOutputContent( $pager->getBodyOutput() );
        } else {
            $user = $pager->getRelevantUser();
            if ( $user ) {
                $this->getSkin()->setRelevantUser( $user );
            }
            $pager->getForm();
            $out->addParserOutputContent( $pager->getFullOutput() );
        }
    }
 
    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $search = $this->userNameUtils->getCanonical( $search );
        if ( !$search ) {
            // No prefix suggestion for invalid user
            return [];
        }
        // Autocomplete subpage as user list - public to allow caching
        return $this->userNamePrefixSearch
            ->search( UserNamePrefixSearch::AUDIENCE_PUBLIC, $search, $limit, $offset );
    }
 
    protected function getGroupName() {
        return 'media';
    }
}