SpecialListfiles.php

Go to the documentation of this file.

<?php
class SpecialListFiles extends IncludableSpecialPage {

        public function __construct(){
                parent::__construct( 'Listfiles' );
        }

        public function execute( $par ){
                $this->setHeaders();
                $this->outputHeader();

                if ( $this->including() ) {
                        $userName = $par;
                        $search = '';
                } else {
                        $userName = $this->getRequest()->getText( 'user', $par );
                        $search = $this->getRequest()->getText( 'ilsearch', '' );
                }

                $pager = new ImageListPager( $this->getContext(), $userName, $search, $this->including() );

                if ( $this->including() ) {
                        $html = $pager->getBody();
                } else {
                        $form = $pager->getForm();
                        $body = $pager->getBody();
                        $nav = $pager->getNavigationBar();
                        $html = "$form<br />\n$body<br />\n$nav";
                }
                $this->getOutput()->addHTML( $html );
        }
}

class ImageListPager extends TablePager {
        var $mFieldNames = null;
        var $mQueryConds = array();
        var $mUserName = null;
        var $mSearch = '';
        var $mIncluding = false;

        function __construct( IContextSource $context, $userName = null, $search = '', $including = false ) {
                global $wgMiserMode;

                $this->mIncluding = $including;

                if ( $userName ) {
                        $nt = Title::newFromText( $userName, NS_USER );
                        if ( !is_null( $nt ) ) {
                                $this->mUserName = $nt->getText();
                                $this->mQueryConds['img_user_text'] = $this->mUserName;
                        }
                }

                if ( $search != '' && !$wgMiserMode ) {
                        $this->mSearch = $search;
                        $nt = Title::newFromURL( $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 ( $context->getRequest()->getText( 'sort', 'img_date' ) == 'img_date' ) {
                                $this->mDefaultDirection = true;
                        } else {
                                $this->mDefaultDirection = false;
                        }
                } else {
                        $this->mDefaultDirection = true;
                }

                parent::__construct( $context );
        }

        function getFieldNames() {
                if ( !$this->mFieldNames ) {
                        global $wgMiserMode;
                        $this->mFieldNames = array(
                                '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(),
                                'img_user_text' => $this->msg( 'listfiles_user' )->text(),
                                'img_description' => $this->msg( 'listfiles_description' )->text(),
                        );
                        if( !$wgMiserMode ) {
                                $this->mFieldNames['count'] = $this->msg( 'listfiles_count' )->text();
                        }
                }
                return $this->mFieldNames;
        }

        function isFieldSortable( $field ) {
                if ( $this->mIncluding ) {
                        return false;
                }
                static $sortable = array( 'img_timestamp', 'img_name' );
                if ( $field == 'img_size' ) {
                        # No index for both img_size and img_user_text
                        return !isset( $this->mQueryConds['img_user_text'] );
                }
                return in_array( $field, $sortable );
        }

        function getQueryInfo() {
                $tables = array( 'image' );
                $fields = array_keys( $this->getFieldNames() );
                $fields[] = 'img_user';
                $fields[array_search('thumb', $fields)] = 'img_name AS thumb';
                $options = $join_conds = array();

                # Depends on $wgMiserMode
                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 = array( 'GROUP BY' => 'img_name' );
                        } else {
                                $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
                                $options = array( 'GROUP BY' => array_merge( array( 'img_user' ), $columnlist ) );
                        }
                        $join_conds = array( 'oldimage' => array( 'LEFT JOIN', 'oi_name = img_name' ) );
                }
                return array(
                        'tables'     => $tables,
                        'fields'     => $fields,
                        'conds'      => $this->mQueryConds,
                        'options'    => $options,
                        'join_conds' => $join_conds
                );
        }

        function getDefaultSort() {
                return 'img_timestamp';
        }

        function doBatchLookups() {
                $userIds = array();
                $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, array( 'userpage' ), __METHOD__ );
        }

        function formatValue( $field, $value ) {
                switch ( $field ) {
                        case 'thumb':
                                $file = wfLocalFile( $value );
                                $thumb = $file->transform( array( 'width' => 180, 'height' => 360 ) );
                                return $thumb->toHtml( array( 'desc-link' => true ) );
                        case 'img_timestamp':
                                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',
                                                array( 'href' => wfLocalFile( $filePage )->getURL() ),
                                                $imgfile
                                        );
                                        $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
                                        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::commentBlock( $value );
                        case 'count':
                                return intval( $value ) + 1;
                }
        }

        function getForm() {
                global $wgScript, $wgMiserMode;
                $inputForm = array();
                $inputForm['table_pager_limit_label'] = $this->getLimitSelect();
                if ( !$wgMiserMode ) {
                        $inputForm['listfiles_search_for'] = Html::input( 'ilsearch', $this->mSearch, 'text',
                                array(
                                        'size'          => '40',
                                        'maxlength' => '255',
                                        'id'            => 'mw-ilsearch',
                        ) );
                }
                $inputForm['username'] = Html::input( 'user', $this->mUserName, 'text', array(
                        'size'          => '40',
                        'maxlength' => '255',
                        'id'            => 'mw-listfiles-user',
                ) );
                return Html::openElement( 'form',
                                array( 'method' => 'get', 'action' => $wgScript, 'id' => 'mw-listfiles-form' ) ) .
                        Xml::fieldset( $this->msg( 'listfiles' )->text() ) .
                        Html::hidden( 'title', $this->getTitle()->getPrefixedText() ) .
                        Xml::buildForm( $inputForm, 'table_pager_limit_submit' ) .
                        $this->getHiddenFields( array( 'limit', 'ilsearch', 'user', 'title' ) ) .
                        Html::closeElement( 'fieldset' ) .
                        Html::closeElement( 'form' ) . "\n";
        }

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

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

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

        function getPagingQueries() {
                $queries = parent::getPagingQueries();
                if ( !is_null( $this->mUserName ) ) {
                        # Append the username to the query string
                        foreach ( $queries as &$query ) {
                                $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' );
        }
}