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();

        // 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;

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

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

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

    public function formatRow( $row ) {
        wfProfileIn( __METHOD__ );

        static $infinity = null;

        if ( is_null( $infinity ) ) {
            $infinity = wfGetDB( DB_SLAVE )->getInfinity();
        }

        $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
        if ( !$title ) {
            wfProfileOut( __METHOD__ );

            return Html::rawElement(
                'li',
                array(),
                Html::element(
                    'span',
                    array( 'class' => 'mw-invalidtitle' ),
                    Linker::getInvalidTitleDescription(
                        $this->getContext(),
                        $row->page_namespace,
                        $row->page_title
                    )
                )
            ) . "\n";
        }

        $link = Linker::link( $title );

        $description_items = array();

        // Messages: restriction-level-sysop, restriction-level-autoconfirmed
        $protType = $this->msg( 'restriction-level-' . $row->pr_level )->escaped();

        $description_items[] = $protType;

        if ( $row->pr_cascade ) {
            $description_items[] = $this->msg( 'protect-summary-cascade' )->text();
        }

        $stxt = '';
        $lang = $this->getLanguage();

        $expiry = $lang->formatExpiry( $row->pr_expiry, TS_MW );
        if ( $expiry != $infinity ) {
            $user = $this->getUser();
            $description_items[] = $this->msg(
                'protect-expiring-local',
                $lang->userTimeAndDate( $expiry, $user ),
                $lang->userDate( $expiry, $user ),
                $lang->userTime( $expiry, $user )
            )->escaped();
        }

        if ( !is_null( $size = $row->page_len ) ) {
            $stxt = $lang->getDirMark() . ' ' . Linker::formatRevisionSize( $size );
        }

        // Show a link to the change protection form for allowed users otherwise
        // a link to the protection log
        if ( $this->getUser()->isAllowed( 'protect' ) ) {
            $changeProtection = Linker::linkKnown(
                $title,
                $this->msg( 'protect_change' )->escaped(),
                array(),
                array( 'action' => 'unprotect' )
            );
        } else {
            $ltitle = SpecialPage::getTitleFor( 'Log' );
            $changeProtection = Linker::linkKnown(
                $ltitle,
                $this->msg( 'protectlogpage' )->escaped(),
                array(),
                array(
                    'type' => 'protect',
                    'page' => $title->getPrefixedText()
                )
            );
        }

        $changeProtection = ' ' . $this->msg( 'parentheses' )->rawParams( $changeProtection )
            ->escaped();

        wfProfileOut( __METHOD__ );

        return Html::rawElement(
            'li',
            array(),
            $lang->specialList( $link . $stxt, $lang->commaList( $description_items ), false ) .
                $changeProtection
        ) . "\n";
    }

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

        $title = $this->getTitle();

        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" .
            "</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 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 AlphabeticPager {
    public $mForm, $mConds;
    private $type, $level, $namespace, $sizetype, $size, $indefonly;

    function __construct( $form, $conds = array(), $type, $level, $namespace,
        $sizetype = '', $size = 0, $indefonly = false, $cascadeonly = 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;
        parent::__construct( $form->getContext() );
    }

    function getStartBody() {
        # Do a link batch query
        $lb = new LinkBatch;
        foreach ( $this->mResult as $row ) {
            $lb->add( $row->page_namespace, $row->page_title );
        }
        $lb->execute();

        return '';
    }

    function formatRow( $row ) {
        return $this->mForm->formatRow( $row );
    }

    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->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_restrictions', 'page' ),
            'fields' => array( 'pr_id', 'page_namespace', 'page_title', 'page_len',
                'pr_type', 'pr_level', 'pr_expiry', 'pr_cascade' ),
            'conds' => $conds
        );
    }

    function getIndexField() {
        return 'pr_id';
    }
}