ApiProtect.php

Go to the documentation of this file.

<?php
class ApiProtect extends ApiBase {

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }

        public function execute() {
                global $wgRestrictionLevels;
                $params = $this->extractRequestParams();

                $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
                $titleObj = $pageObj->getTitle();

                $errors = $titleObj->getUserPermissionsErrors( 'protect', $this->getUser() );
                if ( $errors ) {
                        // We don't care about multiple errors, just report one of them
                        $this->dieUsageMsg( reset( $errors ) );
                }

                $expiry = (array)$params['expiry'];
                if ( count( $expiry ) != count( $params['protections'] ) ) {
                        if ( count( $expiry ) == 1 ) {
                                $expiry = array_fill( 0, count( $params['protections'] ), $expiry[0] );
                        } else {
                                $this->dieUsageMsg( array( 'toofewexpiries', count( $expiry ), count( $params['protections'] ) ) );
                        }
                }

                $restrictionTypes = $titleObj->getRestrictionTypes();
                $db = $this->getDB();

                $protections = array();
                $expiryarray = array();
                $resultProtections = array();
                foreach ( $params['protections'] as $i => $prot ) {
                        $p = explode( '=', $prot );
                        $protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );

                        if ( $titleObj->exists() && $p[0] == 'create' ) {
                                $this->dieUsageMsg( 'create-titleexists' );
                        }
                        if ( !$titleObj->exists() && $p[0] != 'create' ) {
                                $this->dieUsageMsg( 'missingtitle-createonly' );
                        }

                        if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
                                $this->dieUsageMsg( array( 'protect-invalidaction', $p[0] ) );
                        }
                        if ( !in_array( $p[1], $wgRestrictionLevels ) && $p[1] != 'all' ) {
                                $this->dieUsageMsg( array( 'protect-invalidlevel', $p[1] ) );
                        }

                        if ( in_array( $expiry[$i], array( 'infinite', 'indefinite', 'never' ) ) ) {
                                $expiryarray[$p[0]] = $db->getInfinity();
                        } else {
                                $exp = strtotime( $expiry[$i] );
                                if ( $exp < 0 || !$exp ) {
                                        $this->dieUsageMsg( array( 'invalidexpiry', $expiry[$i] ) );
                                }

                                $exp = wfTimestamp( TS_MW, $exp );
                                if ( $exp < wfTimestampNow() ) {
                                        $this->dieUsageMsg( array( 'pastexpiry', $expiry[$i] ) );
                                }
                                $expiryarray[$p[0]] = $exp;
                        }
                        $resultProtections[] = array( $p[0] => $protections[$p[0]],
                                        'expiry' => ( $expiryarray[$p[0]] == $db->getInfinity() ?
                                                                'infinite' :
                                                                wfTimestamp( TS_ISO_8601, $expiryarray[$p[0]] ) ) );
                }

                $cascade = $params['cascade'];

                $watch = $params['watch'] ? 'watch' : $params['watchlist'];
                $this->setWatch( $watch, $titleObj );

                $status = $pageObj->doUpdateRestrictions( $protections, $expiryarray, $cascade, $params['reason'], $this->getUser() );

                if ( !$status->isOK() ) {
                        $errors = $status->getErrorsArray();
                        $this->dieUsageMsg( $errors[0] );
                }
                $res = array(
                        'title' => $titleObj->getPrefixedText(),
                        'reason' => $params['reason']
                );
                if ( $cascade ) {
                        $res['cascade'] = '';
                }
                $res['protections'] = $resultProtections;
                $result = $this->getResult();
                $result->setIndexedTagName( $res['protections'], 'protection' );
                $result->addValue( null, $this->getModuleName(), $res );
        }

        public function mustBePosted() {
                return true;
        }

        public function isWriteMode() {
                return true;
        }

        public function getAllowedParams() {
                return array(
                        'title' => array(
                                ApiBase::PARAM_TYPE => 'string',
                        ),
                        'pageid' => array(
                                ApiBase::PARAM_TYPE => 'integer',
                        ),
                        'token' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                        'protections' => array(
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_REQUIRED => true,
                        ),
                        'expiry' => array(
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_ALLOW_DUPLICATES => true,
                                ApiBase::PARAM_DFLT => 'infinite',
                        ),
                        'reason' => '',
                        'cascade' => false,
                        'watch' => array(
                                ApiBase::PARAM_DFLT => false,
                                ApiBase::PARAM_DEPRECATED => true,
                        ),
                        'watchlist' => array(
                                ApiBase::PARAM_DFLT => 'preferences',
                                ApiBase::PARAM_TYPE => array(
                                        'watch',
                                        'unwatch',
                                        'preferences',
                                        'nochange'
                                ),
                        ),
                );
        }

        public function getParamDescription() {
                $p = $this->getModulePrefix();
                return array(
                        'title' => "Title of the page you want to (un)protect. Cannot be used together with {$p}pageid",
                        'pageid' => "ID of the page you want to (un)protect. Cannot be used together with {$p}title",
                        'token' => 'A protect token previously retrieved through prop=info',
                        'protections' => 'List of protection levels, formatted action=group (e.g. edit=sysop)',
                        'expiry' => array( 'Expiry timestamps. If only one timestamp is set, it\'ll be used for all protections.',
                                        'Use \'infinite\', \'indefinite\' or \'never\', for a neverexpiring protection.' ),
                        'reason' => 'Reason for (un)protecting',
                        'cascade' => array( 'Enable cascading protection (i.e. protect pages included in this page)',
                                        'Ignored if not all protection levels are \'sysop\' or \'protect\'' ),
                        'watch' => 'If set, add the page being (un)protected to your watchlist',
                        'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                'title' => 'string',
                                'reason' => 'string',
                                'cascade' => 'boolean'
                        )
                );
        }

        public function getDescription() {
                return 'Change the protection level of a page';
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(),
                        $this->getTitleOrPageIdErrorMessage(),
                        array(
                                array( 'toofewexpiries', 'noofexpiries', 'noofprotections' ),
                                array( 'create-titleexists' ),
                                array( 'missingtitle-createonly' ),
                                array( 'protect-invalidaction', 'action' ),
                                array( 'protect-invalidlevel', 'level' ),
                                array( 'invalidexpiry', 'expiry' ),
                                array( 'pastexpiry', 'expiry' ),
                        )
                );
        }

        public function needsToken() {
                return true;
        }

        public function getTokenSalt() {
                return '';
        }

        public function getExamples() {
                return array(
                        'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never',
                        'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions'
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Protect';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}