UploadStashPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials\Pager;
 
use MediaWiki\Context\IContextSource;
use MediaWiki\FileRepo\File\File;
use MediaWiki\FileRepo\LocalRepo;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Pager\IndexPager;
use MediaWiki\Pager\TablePager;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Upload\UploadStash;
use MediaWiki\Upload\UploadStashFile;
use UnexpectedValueException;
use Wikimedia\Rdbms\IConnectionProvider;
 
class UploadStashPager extends TablePager {
 
    protected $mFieldNames = null;
 
    private array $files = [];
 
    public function __construct(
        IContextSource $context,
        LinkRenderer $linkRenderer,
        IConnectionProvider $dbProvider,
        private readonly UploadStash $stash,
        private readonly LocalRepo $localRepo,
    ) {
        $this->setContext( $context );
 
        // Set database before parent constructor to avoid setting it there
        $this->mDb = $dbProvider->getReplicaDatabase();
        $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
 
        parent::__construct( $context, $linkRenderer );
    }
 
    protected function getFieldNames() {
        if ( !$this->mFieldNames ) {
            $this->mFieldNames = [
                'us_timestamp' => $this->msg( 'uploadstash-header-date' )->text(),
                'us_key' => $this->msg( 'uploadstash-header-filekey' )->text(),
                'thumb' => $this->msg( 'uploadstash-header-thumb' )->text(),
                'us_size' => $this->msg( 'uploadstash-header-dimensions' )->text(),
            ];
        }
 
        return $this->mFieldNames;
    }
 
    protected function isFieldSortable( $field ) {
        return in_array( $field, [ 'us_timestamp', 'us_key' ] );
    }
 
    public function getQueryInfo() {
        return [
            'tables' => [ 'uploadstash' ],
            'fields' => [
                'us_id',
                'us_timestamp',
                'us_key',
                'us_size',
                'us_path',
                'us_sha1',
                'us_mime',
                'us_status',
            ],
            'conds' => [ 'us_user' => $this->getUser()->getId() ],
            'options' => [],
            'join_conds' => [],
        ];
    }
 
    public function getIndexField() {
        return [ [ 'us_timestamp', 'us_id' ] ];
    }
 
    public function getDefaultSort() {
        return 'us_timestamp';
    }
 
    public function formatValue( $field, $value ) {
        $linkRenderer = $this->getLinkRenderer();
 
        switch ( $field ) {
            case 'us_timestamp':
                // We may want to make this a link to the "old" version when displaying old files
                return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
            case 'us_key':
                $linkRenderer = $this->getLinkRenderer();
                $html = $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'UploadStash', "file/$value" ),
                    $value
                );
                if ( $this->mCurrentRow->us_status === 'finished' ) {
                    $html .= '<br />' . Html::rawElement( 'span', [ 'class' => 'mw-uploadstash-tryagain' ],
                        $this->msg( 'parentheses' )->rawParams( $linkRenderer->makeKnownLink(
                            SpecialPage::getTitleFor( 'Upload' ),
                            $this->msg( 'uploadstash-pager-tryagain' )->text(),
                            [],
                            [ 'wpSourceType' => 'Stash', 'wpSessionKey' => $value ]
                        ) )->escaped()
                    );
                }
                return $html;
            case 'thumb':
                $file = $this->getCurrentFile();
                if ( $file->allowInlineDisplay() ) {
                    $thumbnail = $file->transform( [
                        'width' => '120',
                        'height' => '120',
                    ] );
                    if ( $thumbnail ) {
                        return $thumbnail->toHtml( [ 'loading' => 'lazy' ] );
                    }
                }
                return $this->msg( 'uploadstash-nothumb' )->escaped();
            case 'us_size':
                $file = $this->getCurrentFile();
                return htmlspecialchars( $file->getDimensionsString() )
                    . $this->msg( 'word-separator' )->escaped()
                    . Html::element( 'span', [ 'style' => 'white-space: nowrap;' ],
                        $this->msg( 'parentheses' )->sizeParams( (int)$value )->text()
                    );
            default:
                throw new UnexpectedValueException( "Unknown field '$field'" );
        }
    }
 
    private function getCurrentFile(): File {
        $fileKey = $this->mCurrentRow->us_key;
        return $this->files[$fileKey]
            ?? new UploadStashFile(
                $this->localRepo,
                $this->mCurrentRow->us_path,
                $fileKey,
                $this->mCurrentRow->us_sha1,
                $this->mCurrentRow->us_mime ?? false
            );
    }
 
    private function getEscapedLimitSelectList(): array {
        $list = $this->getLimitSelectList();
        $result = [];
        foreach ( $list as $key => $value ) {
            $result[htmlspecialchars( $key )] = $value;
        }
        return $result;
    }
 
    public function getForm() {
        $formDescriptor = [];
        $formDescriptor['limit'] = [
            'type' => 'radio',
            'name' => 'limit',
            'label-message' => 'table_pager_limit_label',
            'options' => $this->getEscapedLimitSelectList(),
            'flatlist' => true,
            'default' => $this->mLimit
        ];
 
        HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
            ->setMethod( 'get' )
            ->setId( 'mw-uploadstash-form' )
            ->setTitle( $this->getTitle() )
            ->setSubmitTextMsg( 'uploadstash-pager-submit' )
            ->setWrapperLegendMsg( 'uploadstash' )
            ->prepareForm()
            ->displayForm( '' );
    }
 
    protected function getTableClass() {
        return parent::getTableClass() . ' uploadstash';
    }
 
    protected function getNavClass() {
        return parent::getNavClass() . ' uploadstash_nav';
    }
 
    protected function getSortHeaderClass() {
        return parent::getSortHeaderClass() . ' uploadstash_sort';
    }
}
 
class_alias( UploadStashPager::class, 'MediaWiki\\Pager\\UploadStashPager' );