SpecialProtectedpages.php

Go to the documentation of this file.

<?php
class SpecialProtectedpages extends SpecialPage {

    protected $IdLevel = 'level';
    protected $IdType = 'type';

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

    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $this->getOutput()->addModuleStyles( 'mediawiki.special' );

        // Purge expired entries on one in every 10 queries
        if ( !mt_rand( 0, 10 ) ) {
            Title::purgeExpiredRestrictions();
        }

        $request = $this->getRequest();
        $type = $request->getVal( $this->IdType );
        $level = $request->getVal( $this->IdLevel );
        $sizetype = $request->getVal( 'sizetype' );
        $size = $request->getIntOrNull( 'size' );
        $ns = $request->getIntOrNull( 'namespace' );
        $indefOnly = $request->getBool( 'indefonly' ) ? 1 : 0;
        $cascadeOnly = $request->getBool( 'cascadeonly' ) ? 1 : 0;
        $noRedirect = $request->getBool( 'noredirect' ) ? 1 : 0;

        $pager = new ProtectedPagesPager(
            $this,
            array(),
            $type,
            $level,
            $ns,
            $sizetype,
            $size,
            $indefOnly,
            $cascadeOnly,
            $noRedirect
        );

        $this->getOutput()->addHTML( $this->showOptions(
            $ns,
            $type,
            $level,
            $sizetype,
            $size,
            $indefOnly,
            $cascadeOnly,
            $noRedirect
        ) );

        if ( $pager->getNumRows() ) {
            $this->getOutput()->addHTML(
                $pager->getNavigationBar() .
                    $pager->getBody() .
                    $pager->getNavigationBar()
            );
        } else {
            $this->getOutput()->addWikiMsg( 'protectedpagesempty' );
        }
    }

    protected function showOptions( $namespace, $type = 'edit', $level, $sizetype,
        $size, $indefOnly, $cascadeOnly, $noRedirect
    ) {
        global $wgScript;

        $title = $this->getPageTitle();

        return Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
            Xml::openElement( 'fieldset' ) .
            Xml::element( 'legend', array(), $this->msg( 'protectedpages' )->text() ) .
            Html::hidden( 'title', $title->getPrefixedDBkey() ) . "\n" .
            $this->getNamespaceMenu( $namespace ) . "&#160;\n" .
            $this->getTypeMenu( $type ) . "&#160;\n" .
            $this->getLevelMenu( $level ) . "&#160;\n" .
            "<br /><span style='white-space: nowrap'>" .
            $this->getExpiryCheck( $indefOnly ) . "&#160;\n" .
            $this->getCascadeCheck( $cascadeOnly ) . "&#160;\n" .
            $this->getRedirectCheck( $noRedirect ) . "&#160;\n" .
            "</span><br /><span style='white-space: nowrap'>" .
            $this->getSizeLimit( $sizetype, $size ) . "&#160;\n" .
            "</span>" .
            "&#160;" . Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n" .
            Xml::closeElement( 'fieldset' ) .
            Xml::closeElement( 'form' );
    }

    protected function getNamespaceMenu( $namespace = null ) {
        return Html::rawElement( 'span', array( 'style' => 'white-space: nowrap;' ),
            Html::namespaceSelector(
                array(
                    'selected' => $namespace,
                    'all' => '',
                    'label' => $this->msg( 'namespace' )->text()
                ), array(
                    'name' => 'namespace',
                    'id' => 'namespace',
                    'class' => 'namespaceselector',
                )
            )
        );
    }

    protected function getExpiryCheck( $indefOnly ) {
        return Xml::checkLabel(
            $this->msg( 'protectedpages-indef' )->text(),
            'indefonly',
            'indefonly',
            $indefOnly
        ) . "\n";
    }

    protected function getCascadeCheck( $cascadeOnly ) {
        return Xml::checkLabel(
            $this->msg( 'protectedpages-cascade' )->text(),
            'cascadeonly',
            'cascadeonly',
            $cascadeOnly
        ) . "\n";
    }

    protected function getRedirectCheck( $noRedirect ) {
        return Xml::checkLabel(
            $this->msg( 'protectedpages-noredirect' )->text(),
            'noredirect',
            'noredirect',
            $noRedirect
        ) . "\n";
    }

    protected function getSizeLimit( $sizetype, $size ) {
        $max = $sizetype === 'max';

        return Xml::radioLabel(
            $this->msg( 'minimum-size' )->text(),
            'sizetype',
            'min',
            'wpmin',
            !$max
        ) .
            '&#160;' .
            Xml::radioLabel(
                $this->msg( 'maximum-size' )->text(),
                'sizetype',
                'max',
                'wpmax',
                $max
            ) .
            '&#160;' .
            Xml::input( 'size', 9, $size, array( 'id' => 'wpsize' ) ) .
            '&#160;' .
            Xml::label( $this->msg( 'pagesize' )->text(), 'wpsize' );
    }

    protected function getTypeMenu( $pr_type ) {
        $m = array(); // Temporary array
        $options = array();

        // First pass to load the log names
        foreach ( Title::getFilteredRestrictionTypes( true ) as $type ) {
            // Messages: restriction-edit, restriction-move, restriction-create, restriction-upload
            $text = $this->msg( "restriction-$type" )->text();
            $m[$text] = $type;
        }

        // Third pass generates sorted XHTML content
        foreach ( $m as $text => $type ) {
            $selected = ( $type == $pr_type );
            $options[] = Xml::option( $text, $type, $selected ) . "\n";
        }

        return "<span style='white-space: nowrap'>" .
            Xml::label( $this->msg( 'restriction-type' )->text(), $this->IdType ) . '&#160;' .
            Xml::tags( 'select',
                array( 'id' => $this->IdType, 'name' => $this->IdType ),
                implode( "\n", $options ) ) . "</span>";
    }

    protected function getLevelMenu( $pr_level ) {
        global $wgRestrictionLevels;

        // Temporary array
        $m = array( $this->msg( 'restriction-level-all' )->text() => 0 );
        $options = array();

        // First pass to load the log names
        foreach ( $wgRestrictionLevels as $type ) {
            // Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
            if ( $type != '' && $type != '*' ) {
                $text = $this->msg( "restriction-level-$type" )->text();
                $m[$text] = $type;
            }
        }

        // Third pass generates sorted XHTML content
        foreach ( $m as $text => $type ) {
            $selected = ( $type == $pr_level );
            $options[] = Xml::option( $text, $type, $selected );
        }

        return "<span style='white-space: nowrap'>" .
            Xml::label( $this->msg( 'restriction-level' )->text(), $this->IdLevel ) . ' ' .
            Xml::tags( 'select',
                array( 'id' => $this->IdLevel, 'name' => $this->IdLevel ),
                implode( "\n", $options ) ) . "</span>";
    }

    protected function getGroupName() {
        return 'maintenance';
    }
}

class ProtectedPagesPager extends TablePager {
    public $mForm, $mConds;
    private $type, $level, $namespace, $sizetype, $size, $indefonly, $cascadeonly, $noredirect;

    function __construct( $form, $conds = array(), $type, $level, $namespace,
        $sizetype = '', $size = 0, $indefonly = false, $cascadeonly = false, $noredirect = false
    ) {
        $this->mForm = $form;
        $this->mConds = $conds;
        $this->type = ( $type ) ? $type : 'edit';
        $this->level = $level;
        $this->namespace = $namespace;
        $this->sizetype = $sizetype;
        $this->size = intval( $size );
        $this->indefonly = (bool)$indefonly;
        $this->cascadeonly = (bool)$cascadeonly;
        $this->noredirect = (bool)$noredirect;
        parent::__construct( $form->getContext() );
    }

    function preprocessResults( $result ) {
        # Do a link batch query
        $lb = new LinkBatch;
        $userids = array();

        foreach ( $result as $row ) {
            $lb->add( $row->page_namespace, $row->page_title );
            // field is nullable, maybe null on old protections
            if ( $row->log_user !== null ) {
                $userids[] = $row->log_user;
            }
        }

        // fill LinkBatch with user page and user talk
        if ( count( $userids ) ) {
            $userCache = UserCache::singleton();
            $userCache->doQuery( $userids, array(), __METHOD__ );
            foreach ( $userids as $userid ) {
                $name = $userCache->getProp( $userid, 'name' );
                if ( $name !== false ) {
                    $lb->add( NS_USER, $name );
                    $lb->add( NS_USER_TALK, $name );
                }
            }
        }

        $lb->execute();
    }

    function getFieldNames() {
        static $headers = null;

        if ( $headers == array() ) {
            $headers = array(
                'log_timestamp' => 'protectedpages-timestamp',
                'pr_page' => 'protectedpages-page',
                'pr_expiry' => 'protectedpages-expiry',
                'log_user' => 'protectedpages-performer',
                'pr_params' => 'protectedpages-params',
                'log_comment' => 'protectedpages-reason',
            );
            foreach ( $headers as $key => $val ) {
                $headers[$key] = $this->msg( $val )->text();
            }
        }

        return $headers;
    }

    function formatValue( $field, $value ) {
        $row = $this->mCurrentRow;

        $formatted = '';

        switch ( $field ) {
            case 'log_timestamp':
                // when timestamp is null, this is a old protection row
                if ( $value === null ) {
                    $formatted = Html::rawElement(
                        'span',
                        array( 'class' => 'mw-protectedpages-unknown' ),
                        $this->msg( 'protectedpages-unknown-timestamp' )->escaped()
                    );
                } else {
                    $formatted = $this->getLanguage()->userTimeAndDate( $value, $this->getUser() );
                }
                break;

            case 'pr_page':
                $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
                if ( !$title ) {
                    $formatted = Html::element(
                        'span',
                        array( 'class' => 'mw-invalidtitle' ),
                        Linker::getInvalidTitleDescription(
                            $this->getContext(),
                            $row->page_namespace,
                            $row->page_title
                        )
                    );
                } else {
                    $formatted = Linker::link( $title );
                }
                if ( !is_null( $row->page_len ) ) {
                    $formatted .= $this->getLanguage()->getDirMark() .
                        ' ' . Html::rawElement(
                        'span',
                        array( 'class' => 'mw-protectedpages-length' ),
                        Linker::formatRevisionSize( $row->page_len )
                    );
                }
                break;

            case 'pr_expiry':
                $formatted = $this->getLanguage()->formatExpiry( $value, /* User preference timezone */true );
                $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
                if ( $this->getUser()->isAllowed( 'protect' ) && $title ) {
                    $changeProtection = Linker::linkKnown(
                        $title,
                        $this->msg( 'protect_change' )->escaped(),
                        array(),
                        array( 'action' => 'unprotect' )
                    );
                    $formatted .= ' ' . Html::rawElement(
                        'span',
                        array( 'class' => 'mw-protectedpages-actions' ),
                        $this->msg( 'parentheses' )->rawParams( $changeProtection )->escaped()
                    );
                }
                break;

            case 'log_user':
                // when timestamp is null, this is a old protection row
                if ( $row->log_timestamp === null ) {
                    $formatted = Html::rawElement(
                        'span',
                        array( 'class' => 'mw-protectedpages-unknown' ),
                        $this->msg( 'protectedpages-unknown-performer' )->escaped()
                    );
                } else {
                    $username = UserCache::singleton()->getProp( $value, 'name' );
                    if ( LogEventsList::userCanBitfield( $row->log_deleted, LogPage::DELETED_USER, $this->getUser() ) ) {
                        if ( $username === false ) {
                            $formatted = htmlspecialchars( $value );
                        } else {
                            $formatted = Linker::userLink( $value, $username )
                                . Linker::userToolLinks( $value, $username );
                        }
                    } else {
                        $formatted = $this->msg( 'rev-deleted-user' )->escaped();
                    }
                    if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
                        $formatted = '<span class="history-deleted">' . $formatted . '</span>';
                    }
                }
                break;

            case 'pr_params':
                $params = array();
                // Messages: restriction-level-sysop, restriction-level-autoconfirmed
                $params[] = $this->msg( 'restriction-level-' . $row->pr_level )->escaped();
                if ( $row->pr_cascade ) {
                    $params[] = $this->msg( 'protect-summary-cascade' )->text();
                }
                $formatted = $this->getLanguage()->commaList( $params );
                break;

            case 'log_comment':
                // when timestamp is null, this is an old protection row
                if ( $row->log_timestamp === null ) {
                    $formatted = Html::rawElement(
                        'span',
                        array( 'class' => 'mw-protectedpages-unknown' ),
                        $this->msg( 'protectedpages-unknown-reason' )->escaped()
                    );
                } else {
                    if ( LogEventsList::userCanBitfield( $row->log_deleted, LogPage::DELETED_COMMENT, $this->getUser() ) ) {
                        $formatted = Linker::formatComment( $value !== null ? $value : '' );
                    } else {
                        $formatted = $this->msg( 'rev-deleted-comment' )->escaped();
                    }
                    if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
                        $formatted = '<span class="history-deleted">' . $formatted . '</span>';
                    }
                }
                break;

            default:
                throw new MWException( "Unknown field '$field'" );
        }

        return $formatted;
    }

    function getQueryInfo() {
        $conds = $this->mConds;
        $conds[] = 'pr_expiry > ' . $this->mDb->addQuotes( $this->mDb->timestamp() ) .
            'OR pr_expiry IS NULL';
        $conds[] = 'page_id=pr_page';
        $conds[] = 'pr_type=' . $this->mDb->addQuotes( $this->type );

        if ( $this->sizetype == 'min' ) {
            $conds[] = 'page_len>=' . $this->size;
        } elseif ( $this->sizetype == 'max' ) {
            $conds[] = 'page_len<=' . $this->size;
        }

        if ( $this->indefonly ) {
            $infinity = $this->mDb->addQuotes( $this->mDb->getInfinity() );
            $conds[] = "pr_expiry = $infinity OR pr_expiry IS NULL";
        }
        if ( $this->cascadeonly ) {
            $conds[] = 'pr_cascade = 1';
        }
        if ( $this->noredirect ) {
            $conds[] = 'page_is_redirect = 0';
        }

        if ( $this->level ) {
            $conds[] = 'pr_level=' . $this->mDb->addQuotes( $this->level );
        }
        if ( !is_null( $this->namespace ) ) {
            $conds[] = 'page_namespace=' . $this->mDb->addQuotes( $this->namespace );
        }

        return array(
            'tables' => array( 'page', 'page_restrictions', 'log_search', 'logging' ),
            'fields' => array(
                'pr_id',
                'page_namespace',
                'page_title',
                'page_len',
                'pr_type',
                'pr_level',
                'pr_expiry',
                'pr_cascade',
                'log_timestamp',
                'log_user',
                'log_comment',
                'log_deleted',
            ),
            'conds' => $conds,
            'join_conds' => array(
                'log_search' => array(
                    'LEFT JOIN', array(
                        'ls_field' => 'pr_id', 'ls_value = pr_id'
                    )
                ),
                'logging' => array(
                    'LEFT JOIN', array(
                        'ls_log_id = log_id'
                    )
                )
            )
        );
    }

    public function getTableClass() {
        return 'TablePager mw-protectedpages';
    }

    function getIndexField() {
        return 'pr_id';
    }

    function getDefaultSort() {
        return 'pr_id';
    }

    function isFieldSortable( $field ) {
        // no index for sorting exists
        return false;
    }
}