ApiProtect.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use InvalidArgumentException;
use MediaWiki\ChangeTags\ChangeTags;
use MediaWiki\MainConfigNames;
use MediaWiki\Permissions\RestrictionStore;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\Utils\MWTimestamp;
use MediaWiki\Watchlist\WatchedItemStoreInterface;
use MediaWiki\Watchlist\WatchlistManager;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class ApiProtect extends ApiBase {
 
    use ApiWatchlistTrait;
 
    public function __construct(
        ApiMain $mainModule,
        string $moduleName,
        WatchlistManager $watchlistManager,
        WatchedItemStoreInterface $watchedItemStore,
        UserOptionsLookup $userOptionsLookup,
        private readonly RestrictionStore $restrictionStore,
    ) {
        parent::__construct( $mainModule, $moduleName );
 
        // Variables needed in ApiWatchlistTrait trait
        $this->watchlistExpiryEnabled = $this->getConfig()->get( MainConfigNames::WatchlistExpiry );
        $this->watchlistMaxDuration =
            $this->getConfig()->get( MainConfigNames::WatchlistExpiryMaxDuration );
        $this->watchlistManager = $watchlistManager;
        $this->watchedItemStore = $watchedItemStore;
        $this->userOptionsLookup = $userOptionsLookup;
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
 
        $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
        $titleObj = $pageObj->getTitle();
        $this->getErrorFormatter()->setContextTitle( $titleObj );
 
        $this->checkTitleUserPermissions( $titleObj, 'protect' );
 
        $user = $this->getUser();
        $tags = $params['tags'];
 
        // Check if user can add tags
        if ( $tags !== null ) {
            $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $this->getAuthority() );
            if ( !$ableToTag->isOK() ) {
                $this->dieStatus( $ableToTag );
            }
        }
 
        $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->dieWithError( [
                    'apierror-toofewexpiries',
                    count( $expiry ),
                    count( $params['protections'] )
                ] );
            }
        }
 
        $restrictionTypes = $this->restrictionStore->listApplicableRestrictionTypes( $titleObj );
        $levels = $this->getPermissionManager()->getNamespaceRestrictionLevels(
            $titleObj->getNamespace(),
            $user
        );
 
        $protections = [];
        $expiries = [];
        $resultProtections = [];
        foreach ( $params['protections'] as $i => $prot ) {
            $p = explode( '=', $prot );
            $protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );
 
            if ( $titleObj->exists() && $p[0] == 'create' ) {
                $this->dieWithError( 'apierror-create-titleexists' );
            }
            if ( !$titleObj->exists() && $p[0] != 'create' ) {
                $this->dieWithError( 'apierror-missingtitle-createonly' );
            }
 
            if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
                $this->dieWithError( [ 'apierror-protect-invalidaction', wfEscapeWikiText( $p[0] ) ] );
            }
            if ( !in_array( $p[1], $levels ) && $p[1] != 'all' ) {
                $this->dieWithError( [ 'apierror-protect-invalidlevel', wfEscapeWikiText( $p[1] ) ] );
            }
 
            try {
                $expiries[$p[0]] = ExpiryDef::normalizeExpiry( $expiry[$i], TS::MW );
            } catch ( InvalidArgumentException ) {
                $this->dieWithError( [ 'apierror-invalidexpiry', wfEscapeWikiText( $expiry[$i] ) ] );
            }
            if ( $expiries[$p[0]] < MWTimestamp::now( TS::MW ) ) {
                $this->dieWithError( [ 'apierror-pastexpiry', wfEscapeWikiText( $expiry[$i] ) ] );
            }
 
            $resultProtections[] = [
                $p[0] => $protections[$p[0]],
                'expiry' => ApiResult::formatExpiry( $expiries[$p[0]], 'infinite' ),
            ];
        }
 
        $cascade = $params['cascade'];
 
        $watch = $params['watch'] ? 'watch' : $params['watchlist'];
        $watchlistExpiry = $this->getExpiryFromParams( $params, $titleObj, $user );
        $this->setWatch( $watch, $titleObj, $user, 'watchdefault', $watchlistExpiry );
 
        $status = $pageObj->doUpdateRestrictions(
            $protections,
            $expiries,
            $cascade,
            $params['reason'],
            $user,
            $tags ?? []
        );
 
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }
        $res = [
            'title' => $titleObj->getPrefixedText(),
            'reason' => $params['reason']
        ];
        if ( $cascade ) {
            $res['cascade'] = true;
        }
        $res['protections'] = $resultProtections;
        $result = $this->getResult();
        ApiResult::setIndexedTagName( $res['protections'], 'protection' );
        $result->addValue( null, $this->getModuleName(), $res );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'title' => [
                ParamValidator::PARAM_TYPE => 'string',
            ],
            'pageid' => [
                ParamValidator::PARAM_TYPE => 'integer',
            ],
            'protections' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_REQUIRED => true,
            ],
            'expiry' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_ALLOW_DUPLICATES => true,
                ParamValidator::PARAM_DEFAULT => 'infinite',
            ],
            'reason' => '',
            'tags' => [
                ParamValidator::PARAM_TYPE => 'tags',
                ParamValidator::PARAM_ISMULTI => true,
            ],
            'cascade' => false,
            'watch' => [
                ParamValidator::PARAM_DEFAULT => false,
                ParamValidator::PARAM_DEPRECATED => true,
            ],
        ] + $this->getWatchlistParams();
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        $title = Title::newMainPage()->getPrefixedText();
        $mp = rawurlencode( $title );
 
        return [
            "action=protect&title={$mp}&token=123ABC&" .
                'protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never'
                => 'apihelp-protect-example-protect',
            "action=protect&title={$mp}&token=123ABC&" .
                'protections=edit=all|move=all&reason=Lifting%20restrictions'
                => 'apihelp-protect-example-unprotect',
            "action=protect&title={$mp}&token=123ABC&" .
                'protections=&reason=Lifting%20restrictions'
                => 'apihelp-protect-example-unprotect2',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protect';
    }
}
 
class_alias( ApiProtect::class, 'ApiProtect' );