SpecialListFiles.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials;
 
use MediaWiki\CommentFormatter\RowCommentFormatter;
use MediaWiki\CommentStore\CommentStore;
use MediaWiki\FileRepo\RepoGroup;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Pager\ImageListPager;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\SpecialPage\IncludableSpecialPage;
use MediaWiki\User\UserNamePrefixSearch;
use MediaWiki\User\UserNameUtils;
use MediaWiki\User\UserRigorOptions;
use Wikimedia\Rdbms\IConnectionProvider;
 
class SpecialListFiles extends IncludableSpecialPage {
 
    public function __construct(
        private readonly RepoGroup $repoGroup,
        private readonly IConnectionProvider $dbProvider,
        private readonly CommentStore $commentStore,
        private readonly UserNameUtils $userNameUtils,
        private readonly UserNamePrefixSearch $userNamePrefixSearch,
        private readonly RowCommentFormatter $rowCommentFormatter,
        private readonly LinkBatchFactory $linkBatchFactory,
    ) {
        parent::__construct( 'Listfiles' );
    }
 
    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 !== false ) {
            $userName = $sanitizedUserName;
        }
 
        if ( $userName !== '' ) {
            $pageTitle = $this->msg( 'listfiles_subpage' )->plaintextParams( $userName );
        } else {
            $pageTitle = $this->msg( 'listfiles' );
        }
 
        $pager = new ImageListPager(
            $this->getContext(),
            $this->commentStore,
            $this->getLinkRenderer(),
            $this->dbProvider,
            $this->repoGroup,
            $this->userNameUtils,
            $this->rowCommentFormatter,
            $this->linkBatchFactory,
            $userName,
            $search,
            $this->including(),
            $showAll
        );
 
        $out = $this->getOutput();
        $out->setPageTitleMsg( $pageTitle );
        $out->addModuleStyles( 'mediawiki.special' );
        $parserOptions = ParserOptions::newFromContext( $this->getContext() );
        if ( $this->including() ) {
            $out->addParserOutputContent( $pager->getBodyOutput(), $parserOptions );
        } else {
            $user = $pager->getRelevantUser();
            if ( $user ) {
                $this->getSkin()->setRelevantUser( $user );
            }
            $pager->getForm();
            $out->addParserOutputContent( $pager->getFullOutput(), $parserOptions );
        }
    }
 
    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';
    }
}
 
class_alias( SpecialListFiles::class, 'SpecialListFiles' );