NewFilesPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Pager;
 
use ImageGalleryBase;
use ImageGalleryClassNotFoundException;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Context\IContextSource;
use MediaWiki\Html\FormOptions;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\Permissions\GroupPermissionsLookup;
use MediaWiki\RecentChanges\RecentChange;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\ExternalUserNames;
use Wikimedia\Rdbms\IConnectionProvider;
 
class NewFilesPager extends RangeChronologicalPager {
 
    protected ?ImageGalleryBase $gallery = null;
    protected FormOptions $opts;
 
    private GroupPermissionsLookup $groupPermissionsLookup;
    private LinkBatchFactory $linkBatchFactory;
    private int $migrationStage;
 
    public function __construct(
        IContextSource $context,
        GroupPermissionsLookup $groupPermissionsLookup,
        LinkBatchFactory $linkBatchFactory,
        LinkRenderer $linkRenderer,
        IConnectionProvider $dbProvider,
        FormOptions $opts
    ) {
        // Set database before parent constructor to avoid setting it there
        $this->mDb = $dbProvider->getReplicaDatabase();
 
        parent::__construct( $context, $linkRenderer );
 
        $this->opts = $opts;
        $this->groupPermissionsLookup = $groupPermissionsLookup;
        $this->linkBatchFactory = $linkBatchFactory;
        $this->setLimit( $opts->getValue( 'limit' ) );
 
        $startTimestamp = '';
        $endTimestamp = '';
        if ( $opts->getValue( 'start' ) ) {
            $startTimestamp = $opts->getValue( 'start' ) . ' 00:00:00';
        }
        if ( $opts->getValue( 'end' ) ) {
            $endTimestamp = $opts->getValue( 'end' ) . ' 23:59:59';
        }
        $this->getDateRangeCond( $startTimestamp, $endTimestamp );
        $this->migrationStage = $context->getConfig()->get(
            MainConfigNames::FileSchemaMigrationStage
        );
    }
 
    public function getQueryInfo() {
        $opts = $this->opts;
        $conds = [];
        $dbr = $this->getDatabase();
        if ( $this->migrationStage & SCHEMA_COMPAT_READ_OLD ) {
            $tables = [ 'image' ];
            $nameField = 'img_name';
            $actorField = 'img_actor';
            $timestampField = 'img_timestamp';
            $jconds = [];
 
        } else {
            $tables = [ 'file', 'filerevision' ];
            $nameField = 'file_name';
            $actorField = 'fr_actor';
            $timestampField = 'fr_timestamp';
            $jconds = [ 'filerevision' => [ 'JOIN', 'file_latest=fr_id' ] ];
        }
        $tables[] = 'actor';
        $fields = [ 'img_name' => $nameField, 'img_timestamp' => $timestampField, 'actor_user', 'actor_name' ];
        $options = [];
        $jconds['actor'] = [ 'JOIN', 'actor_id=' . $actorField ];
 
        $user = $opts->getValue( 'user' );
        if ( $user !== '' ) {
            $conds['actor_name'] = $user;
        }
 
        if ( !$opts->getValue( 'showbots' ) ) {
            $groupsWithBotPermission = $this->groupPermissionsLookup->getGroupsWithPermission( 'bot' );
 
            if ( count( $groupsWithBotPermission ) ) {
                $tables[] = 'user_groups';
                $conds['ug_group'] = null;
                $jconds['user_groups'] = [
                    'LEFT JOIN',
                    [
                        'ug_group' => $groupsWithBotPermission,
                        'ug_user = actor_user',
                        $dbr->expr( 'ug_expiry', '=', null )->or( 'ug_expiry', '>=', $dbr->timestamp() )
                    ]
                ];
            }
        }
 
        if ( $opts->getValue( 'hidepatrolled' ) ) {
            $tables[] = 'recentchanges';
            $conds['rc_type'] = RC_LOG;
            $conds['rc_log_type'] = 'upload';
            $conds['rc_patrolled'] = RecentChange::PRC_UNPATROLLED;
            $conds['rc_namespace'] = NS_FILE;
 
            $jconds['recentchanges'] = [
                'JOIN',
                [
                    'rc_title = ' . $nameField,
                    'rc_actor = ' . $actorField,
                    'rc_timestamp = ' . $timestampField,
                ]
            ];
        }
 
        if ( $opts->getValue( 'mediatype' ) ) {
            if ( $this->migrationStage & SCHEMA_COMPAT_READ_OLD ) {
                $conds['img_media_type'] = $opts->getValue( 'mediatype' );
            } else {
                $tables[] = 'filetypes';
                $jconds['filetypes'] = [ 'JOIN', 'file_type = ft_id' ];
                $conds['ft_media_type'] = $opts->getValue( 'mediatype' );
            }
        }
 
        // We're ordering by img_timestamp, but MariaDB sometimes likes to query other tables first
        // and filesort the result set later.
        // See T124205 / https://mariadb.atlassian.net/browse/MDEV-8880, and T244533
        // Twist: This would cause issues if the user is set and we need to check user existence first
        if ( $user === '' ) {
            $options[] = 'STRAIGHT_JOIN';
        }
 
        $query = [
            'tables' => $tables,
            'fields' => $fields,
            'join_conds' => $jconds,
            'conds' => $conds,
            'options' => $options,
        ];
 
        return $query;
    }
 
    public function getIndexField() {
        return [ [ 'img_timestamp', 'img_name' ] ];
    }
 
    protected function getStartBody() {
        if ( !$this->gallery ) {
            // Note that null for mode is taken to mean use default.
            $mode = $this->getRequest()->getVal( 'gallerymode', null );
            try {
                $this->gallery = ImageGalleryBase::factory( $mode, $this->getContext() );
            } catch ( ImageGalleryClassNotFoundException ) {
                // User specified something invalid, fallback to default.
                $this->gallery = ImageGalleryBase::factory( false, $this->getContext() );
            }
        }
 
        return '';
    }
 
    protected function getEndBody() {
        return $this->gallery->toHTML();
    }
 
    protected function doBatchLookups() {
        $this->mResult->seek( 0 );
        $lb = $this->linkBatchFactory->newLinkBatch()->setCaller( __METHOD__ );
        foreach ( $this->mResult as $row ) {
            if ( $row->actor_user ) {
                $lb->add( NS_USER, $row->actor_name );
            }
        }
        $lb->execute();
    }
 
    public function formatRow( $row ) {
        $username = $row->actor_name;
 
        if ( ExternalUserNames::isExternal( $username ) ) {
            $ul = htmlspecialchars( $username );
        } else {
            $ul = $this->getLinkRenderer()->makeLink(
                new TitleValue( NS_USER, $username ),
                $username
            );
        }
        $time = $this->getLanguage()->userTimeAndDate( $row->img_timestamp, $this->getUser() );
 
        $this->gallery->add(
            Title::makeTitle( NS_FILE, $row->img_name ),
            "$ul<br />\n<i>"
                . htmlspecialchars( $time )
                . "</i><br />\n",
            '',
            '',
            [],
            ImageGalleryBase::LOADING_LAZY
        );
 
        return '';
    }
}
 
class_alias( NewFilesPager::class, 'NewFilesPager' );