ImageListPager.php

Go to the documentation of this file.

<?php
class ImageListPager extends TablePager {

    protected $mFieldNames = null;

    // Subclasses should override buildQueryConds instead of using $mQueryConds variable.
    protected $mQueryConds = [];

    protected $mUserName = null;

    protected $mUser = null;

    protected $mSearch = '';

    protected $mIncluding = false;

    protected $mShowAll = false;

    protected $mTableName = 'image';

    function __construct( IContextSource $context, $userName = null, $search = '',
        $including = false, $showAll = false
    ) {
        $this->setContext( $context );
        $this->mIncluding = $including;
        $this->mShowAll = $showAll;

        if ( $userName !== null && $userName !== '' ) {
            $nt = Title::makeTitleSafe( NS_USER, $userName );
            if ( is_null( $nt ) ) {
                $this->outputUserDoesNotExist( $userName );
            } else {
                $this->mUserName = $nt->getText();
                $user = User::newFromName( $this->mUserName, false );
                if ( $user ) {
                    $this->mUser = $user;
                }
                if ( !$user || ( $user->isAnon() && !User::isIP( $user->getName() ) ) ) {
                    $this->outputUserDoesNotExist( $userName );
                }
            }
        }

        if ( $search !== '' && !$this->getConfig()->get( 'MiserMode' ) ) {
            $this->mSearch = $search;
            $nt = Title::newFromText( $this->mSearch );

            if ( $nt ) {
                $dbr = wfGetDB( DB_SLAVE );
                $this->mQueryConds[] = 'LOWER(img_name)' .
                    $dbr->buildLike( $dbr->anyString(),
                        strtolower( $nt->getDBkey() ), $dbr->anyString() );
            }
        }

        if ( !$including ) {
            if ( $this->getRequest()->getText( 'sort', 'img_date' ) == 'img_date' ) {
                $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
            } else {
                $this->mDefaultDirection = IndexPager::DIR_ASCENDING;
            }
        } else {
            $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
        }

        parent::__construct( $context );
    }

    function getRelevantUser() {
        return $this->mUser;
    }

    protected function outputUserDoesNotExist( $userName ) {
        $this->getOutput()->wrapWikiMsg(
            "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
            [
                'listfiles-userdoesnotexist',
                wfEscapeWikiText( $userName ),
            ]
        );
    }

    protected function buildQueryConds( $table ) {
        $prefix = $table === 'image' ? 'img' : 'oi';
        $conds = [];

        if ( !is_null( $this->mUserName ) ) {
            $conds[$prefix . '_user_text'] = $this->mUserName;
        }

        if ( $this->mSearch !== '' ) {
            $nt = Title::newFromText( $this->mSearch );
            if ( $nt ) {
                $dbr = wfGetDB( DB_SLAVE );
                $conds[] = 'LOWER(' . $prefix . '_name)' .
                    $dbr->buildLike( $dbr->anyString(),
                        strtolower( $nt->getDBkey() ), $dbr->anyString() );
            }
        }

        if ( $table === 'oldimage' ) {
            // Don't want to deal with revdel.
            // Future fixme: Show partial information as appropriate.
            // Would have to be careful about filtering by username when username is deleted.
            $conds['oi_deleted'] = 0;
        }

        // Add mQueryConds in case anyone was subclassing and using the old variable.
        return $conds + $this->mQueryConds;
    }

    function getFieldNames() {
        if ( !$this->mFieldNames ) {
            $this->mFieldNames = [
                'img_timestamp' => $this->msg( 'listfiles_date' )->text(),
                'img_name' => $this->msg( 'listfiles_name' )->text(),
                'thumb' => $this->msg( 'listfiles_thumb' )->text(),
                'img_size' => $this->msg( 'listfiles_size' )->text(),
            ];
            if ( is_null( $this->mUserName ) ) {
                // Do not show username if filtering by username
                $this->mFieldNames['img_user_text'] = $this->msg( 'listfiles_user' )->text();
            }
            // img_description down here, in order so that its still after the username field.
            $this->mFieldNames['img_description'] = $this->msg( 'listfiles_description' )->text();

            if ( !$this->getConfig()->get( 'MiserMode' ) && !$this->mShowAll ) {
                $this->mFieldNames['count'] = $this->msg( 'listfiles_count' )->text();
            }
            if ( $this->mShowAll ) {
                $this->mFieldNames['top'] = $this->msg( 'listfiles-latestversion' )->text();
            }
        }

        return $this->mFieldNames;
    }

    function isFieldSortable( $field ) {
        if ( $this->mIncluding ) {
            return false;
        }
        $sortable = [ 'img_timestamp', 'img_name', 'img_size' ];
        /* For reference, the indicies we can use for sorting are:
         * On the image table: img_usertext_timestamp, img_size, img_timestamp
         * On oldimage: oi_usertext_timestamp, oi_name_timestamp
         *
         * In particular that means we cannot sort by timestamp when not filtering
         * by user and including old images in the results. Which is sad.
         */
        if ( $this->getConfig()->get( 'MiserMode' ) && !is_null( $this->mUserName ) ) {
            // If we're sorting by user, the index only supports sorting by time.
            if ( $field === 'img_timestamp' ) {
                return true;
            } else {
                return false;
            }
        } elseif ( $this->getConfig()->get( 'MiserMode' )
            && $this->mShowAll /* && mUserName === null */
        ) {
            // no oi_timestamp index, so only alphabetical sorting in this case.
            if ( $field === 'img_name' ) {
                return true;
            } else {
                return false;
            }
        }

        return in_array( $field, $sortable );
    }

    function getQueryInfo() {
        // Hacky Hacky Hacky - I want to get query info
        // for two different tables, without reimplementing
        // the pager class.
        $qi = $this->getQueryInfoReal( $this->mTableName );

        return $qi;
    }

    protected function getQueryInfoReal( $table ) {
        $prefix = $table === 'oldimage' ? 'oi' : 'img';

        $tables = [ $table ];
        $fields = array_keys( $this->getFieldNames() );

        if ( $table === 'oldimage' ) {
            foreach ( $fields as $id => &$field ) {
                if ( substr( $field, 0, 4 ) !== 'img_' ) {
                    continue;
                }
                $field = $prefix . substr( $field, 3 ) . ' AS ' . $field;
            }
            $fields[array_search( 'top', $fields )] = "'no' AS top";
        } else {
            if ( $this->mShowAll ) {
                $fields[array_search( 'top', $fields )] = "'yes' AS top";
            }
        }
        $fields[] = $prefix . '_user AS img_user';
        $fields[array_search( 'thumb', $fields )] = $prefix . '_name AS thumb';

        $options = $join_conds = [];

        # Depends on $wgMiserMode
        # Will also not happen if mShowAll is true.
        if ( isset( $this->mFieldNames['count'] ) ) {
            $tables[] = 'oldimage';

            # Need to rewrite this one
            foreach ( $fields as &$field ) {
                if ( $field == 'count' ) {
                    $field = 'COUNT(oi_archive_name) AS count';
                }
            }
            unset( $field );

            $dbr = wfGetDB( DB_SLAVE );
            if ( $dbr->implicitGroupby() ) {
                $options = [ 'GROUP BY' => 'img_name' ];
            } else {
                $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
                $options = [ 'GROUP BY' => array_merge( [ 'img_user' ], $columnlist ) ];
            }
            $join_conds = [ 'oldimage' => [ 'LEFT JOIN', 'oi_name = img_name' ] ];
        }

        return [
            'tables' => $tables,
            'fields' => $fields,
            'conds' => $this->buildQueryConds( $table ),
            'options' => $options,
            'join_conds' => $join_conds
        ];
    }

    function reallyDoQuery( $offset, $limit, $asc ) {
        $prevTableName = $this->mTableName;
        $this->mTableName = 'image';
        list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
            $this->buildQueryInfo( $offset, $limit, $asc );
        $imageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
        $this->mTableName = $prevTableName;

        if ( !$this->mShowAll ) {
            return $imageRes;
        }

        $this->mTableName = 'oldimage';

        # Hacky...
        $oldIndex = $this->mIndexField;
        if ( substr( $this->mIndexField, 0, 4 ) !== 'img_' ) {
            throw new MWException( "Expected to be sorting on an image table field" );
        }
        $this->mIndexField = 'oi_' . substr( $this->mIndexField, 4 );

        list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
            $this->buildQueryInfo( $offset, $limit, $asc );
        $oldimageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );

        $this->mTableName = $prevTableName;
        $this->mIndexField = $oldIndex;

        return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
    }

    protected function combineResult( $res1, $res2, $limit, $ascending ) {
        $res1->rewind();
        $res2->rewind();
        $topRes1 = $res1->next();
        $topRes2 = $res2->next();
        $resultArray = [];
        for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++ ) {
            if ( strcmp( $topRes1->{$this->mIndexField}, $topRes2->{$this->mIndexField} ) > 0 ) {
                if ( !$ascending ) {
                    $resultArray[] = $topRes1;
                    $topRes1 = $res1->next();
                } else {
                    $resultArray[] = $topRes2;
                    $topRes2 = $res2->next();
                }
            } else {
                if ( !$ascending ) {
                    $resultArray[] = $topRes2;
                    $topRes2 = $res2->next();
                } else {
                    $resultArray[] = $topRes1;
                    $topRes1 = $res1->next();
                }
            }
        }

        // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
        for ( ; $i < $limit && $topRes1; $i++ ) {
            // @codingStandardsIgnoreEnd
            $resultArray[] = $topRes1;
            $topRes1 = $res1->next();
        }

        // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
        for ( ; $i < $limit && $topRes2; $i++ ) {
            // @codingStandardsIgnoreEnd
            $resultArray[] = $topRes2;
            $topRes2 = $res2->next();
        }

        return new FakeResultWrapper( $resultArray );
    }

    function getDefaultSort() {
        if ( $this->mShowAll && $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName ) ) {
            // Unfortunately no index on oi_timestamp.
            return 'img_name';
        } else {
            return 'img_timestamp';
        }
    }

    function doBatchLookups() {
        $userIds = [];
        $this->mResult->seek( 0 );
        foreach ( $this->mResult as $row ) {
            $userIds[] = $row->img_user;
        }
        # Do a link batch query for names and userpages
        UserCache::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__ );
    }

    function formatValue( $field, $value ) {
        switch ( $field ) {
            case 'thumb':
                $opt = [ 'time' => wfTimestamp( TS_MW, $this->mCurrentRow->img_timestamp ) ];
                $file = RepoGroup::singleton()->getLocalRepo()->findFile( $value, $opt );
                // If statement for paranoia
                if ( $file ) {
                    $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );

                    return $thumb->toHtml( [ 'desc-link' => true ] );
                } else {
                    return htmlspecialchars( $value );
                }
            case 'img_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 'img_name':
                static $imgfile = null;
                if ( $imgfile === null ) {
                    $imgfile = $this->msg( 'imgfile' )->text();
                }

                // Weird files can maybe exist? Bug 22227
                $filePage = Title::makeTitleSafe( NS_FILE, $value );
                if ( $filePage ) {
                    $link = Linker::linkKnown(
                        $filePage,
                        htmlspecialchars( $filePage->getText() )
                    );
                    $download = Xml::element( 'a',
                        [ 'href' => wfLocalFile( $filePage )->getUrl() ],
                        $imgfile
                    );
                    $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();

                    // Add delete links if allowed
                    // From https://github.com/Wikia/app/pull/3859
                    if ( $filePage->userCan( 'delete', $this->getUser() ) ) {
                        $deleteMsg = $this->msg( 'listfiles-delete' )->escaped();

                        $delete = Linker::linkKnown(
                            $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
                        );
                        $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();

                        return "$link $download $delete";
                    }

                    return "$link $download";
                } else {
                    return htmlspecialchars( $value );
                }
            case 'img_user_text':
                if ( $this->mCurrentRow->img_user ) {
                    $name = User::whoIs( $this->mCurrentRow->img_user );
                    $link = Linker::link(
                        Title::makeTitle( NS_USER, $name ),
                        htmlspecialchars( $name )
                    );
                } else {
                    $link = htmlspecialchars( $value );
                }

                return $link;
            case 'img_size':
                return htmlspecialchars( $this->getLanguage()->formatSize( $value ) );
            case 'img_description':
                return Linker::formatComment( $value );
            case 'count':
                return $this->getLanguage()->formatNum( intval( $value ) + 1 );
            case 'top':
                // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
                return $this->msg( 'listfiles-latestversion-' . $value );
            default:
                throw new MWException( "Unknown field '$field'" );
        }
    }

    function getForm() {
        $fields = [];
        $fields['limit'] = [
            'type' => 'select',
            'name' => 'limit',
            'label-message' => 'table_pager_limit_label',
            'options' => $this->getLimitSelectList(),
            'default' => $this->mLimit,
        ];

        if ( !$this->getConfig()->get( 'MiserMode' ) ) {
            $fields['ilsearch'] = [
                'type' => 'text',
                'name' => 'ilsearch',
                'id' => 'mw-ilsearch',
                'label-message' => 'listfiles_search_for',
                'default' => $this->mSearch,
                'size' => '40',
                'maxlength' => '255',
            ];
        }

        $this->getOutput()->addModules( 'mediawiki.userSuggest' );
        $fields['user'] = [
            'type' => 'text',
            'name' => 'user',
            'id' => 'mw-listfiles-user',
            'label-message' => 'username',
            'default' => $this->mUserName,
            'size' => '40',
            'maxlength' => '255',
            'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
        ];

        $fields['ilshowall'] = [
            'type' => 'check',
            'name' => 'ilshowall',
            'id' => 'mw-listfiles-show-all',
            'label-message' => 'listfiles-show-all',
            'default' => $this->mShowAll,
        ];

        $query = $this->getRequest()->getQueryValues();
        unset( $query['title'] );
        unset( $query['limit'] );
        unset( $query['ilsearch'] );
        unset( $query['ilshowall'] );
        unset( $query['user'] );

        $form = new HTMLForm( $fields, $this->getContext() );

        $form->setMethod( 'get' );
        $form->setTitle( $this->getTitle() );
        $form->setId( 'mw-listfiles-form' );
        $form->setWrapperLegendMsg( 'listfiles' );
        $form->setSubmitTextMsg( 'table_pager_limit_submit' );
        $form->addHiddenFields( $query );

        $form->prepareForm();
        $form->displayForm( '' );
    }

    protected function getTableClass() {
        return parent::getTableClass() . ' listfiles';
    }

    protected function getNavClass() {
        return parent::getNavClass() . ' listfiles_nav';
    }

    protected function getSortHeaderClass() {
        return parent::getSortHeaderClass() . ' listfiles_sort';
    }

    function getPagingQueries() {
        $queries = parent::getPagingQueries();
        if ( !is_null( $this->mUserName ) ) {
            # Append the username to the query string
            foreach ( $queries as &$query ) {
                if ( $query !== false ) {
                    $query['user'] = $this->mUserName;
                }
            }
        }

        return $queries;
    }

    function getDefaultQuery() {
        $queries = parent::getDefaultQuery();
        if ( !isset( $queries['user'] ) && !is_null( $this->mUserName ) ) {
            $queries['user'] = $this->mUserName;
        }

        return $queries;
    }

    function getTitle() {
        return SpecialPage::getTitleFor( 'Listfiles' );
    }
}