SpecialProtectedtitles.php

Go to the documentation of this file.

<?php
class SpecialProtectedtitles extends SpecialPage {
    protected $IdLevel = 'level';
    protected $IdType = 'type';

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

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

        $pager = new ProtectedTitlesPager( $this, array(), $type, $level, $NS, $sizetype, $size );

        $this->getOutput()->addHTML( $this->showOptions( $NS, $type, $level ) );

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

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

        static $infinity = null;

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

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

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

        $link = Linker::link( $title );
        $description_items = array();
        // Messages: restriction-level-sysop, restriction-level-autoconfirmed
        $protType = $this->msg( 'restriction-level-' . $row->pt_create_perm )->escaped();
        $description_items[] = $protType;
        $lang = $this->getLanguage();
        $expiry = strlen( $row->pt_expiry ) ?
            $lang->formatExpiry( $row->pt_expiry, TS_MW ) :
            $infinity;

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

        wfProfileOut( __METHOD__ );

        // @todo i18n: This should use a comma separator instead of a hard coded comma, right?
        return '<li>' . $lang->specialList( $link, implode( $description_items, ', ' ) ) . "</li>\n";
    }

    function showOptions( $namespace, $type = 'edit', $level ) {
        $action = htmlspecialchars( wfScript() );
        $title = $this->getPageTitle();
        $special = htmlspecialchars( $title->getPrefixedDBkey() );

        return "<form action=\"$action\" method=\"get\">\n" .
            '<fieldset>' .
            Xml::element( 'legend', array(), $this->msg( 'protectedtitles' )->text() ) .
            Html::hidden( 'title', $special ) . "&#160;\n" .
            $this->getNamespaceMenu( $namespace ) . "&#160;\n" .
            $this->getLevelMenu( $level ) . "&#160;\n" .
            "&#160;" . Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n" .
            "</fieldset></form>";
    }

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

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

        // First pass to load the log names
        foreach ( $this->getConfig()->get( 'RestrictionLevels' ) as $type ) {
            if ( $type != '' && $type != '*' ) {
                // Messages: restriction-level-sysop, restriction-level-autoconfirmed
                $text = $this->msg( "restriction-level-$type" )->text();
                $m[$text] = $type;
            }
        }

        // Is there only one level (aside from "all")?
        if ( count( $m ) <= 2 ) {
            return '';
        }
        // Third pass generates sorted XHTML content
        foreach ( $m as $text => $type ) {
            $selected = ( $type == $pr_level );
            $options[] = Xml::option( $text, $type, $selected );
        }

        return Xml::label( $this->msg( 'restriction-level' )->text(), $this->IdLevel ) . '&#160;' .
            Xml::tags( 'select',
                array( 'id' => $this->IdLevel, 'name' => $this->IdLevel ),
                implode( "\n", $options ) );
    }

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

class ProtectedTitlesPager extends AlphabeticPager {
    public $mForm, $mConds;

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

    function getStartBody() {
        wfProfileIn( __METHOD__ );
        # Do a link batch query
        $this->mResult->seek( 0 );
        $lb = new LinkBatch;

        foreach ( $this->mResult as $row ) {
            $lb->add( $row->pt_namespace, $row->pt_title );
        }

        $lb->execute();
        wfProfileOut( __METHOD__ );

        return '';
    }

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

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

    function getQueryInfo() {
        $conds = $this->mConds;
        $conds[] = 'pt_expiry>' . $this->mDb->addQuotes( $this->mDb->timestamp() );
        if ( $this->level ) {
            $conds['pt_create_perm'] = $this->level;
        }

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

        return array(
            'tables' => 'protected_titles',
            'fields' => array( 'pt_namespace', 'pt_title', 'pt_create_perm',
                'pt_expiry', 'pt_timestamp' ),
            'conds' => $conds
        );
    }

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