ApiPatrol.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use ChangeTags;
use MediaWiki\Revision\RevisionStore;
use RecentChange;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiPatrol extends ApiBase {
    private RevisionStore $revisionStore;
 
    public function __construct(
        ApiMain $main,
        string $action,
        RevisionStore $revisionStore
    ) {
        parent::__construct( $main, $action );
        $this->revisionStore = $revisionStore;
    }
 
    public function execute() {
        $params = $this->extractRequestParams();
        $this->requireOnlyOneParameter( $params, 'rcid', 'revid' );
 
        if ( isset( $params['rcid'] ) ) {
            $rc = RecentChange::newFromId( $params['rcid'] );
            if ( !$rc ) {
                $this->dieWithError( [ 'apierror-nosuchrcid', $params['rcid'] ] );
            }
        } else {
            $rev = $this->revisionStore->getRevisionById( $params['revid'] );
            if ( !$rev ) {
                $this->dieWithError( [ 'apierror-nosuchrevid', $params['revid'] ] );
            }
            $rc = $this->revisionStore->getRecentChange( $rev );
            if ( !$rc ) {
                $this->dieWithError( [ 'apierror-notpatrollable', $params['revid'] ] );
            }
        }
 
        $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 );
            }
        }
 
        $status = $rc->markPatrolled( $user, $tags );
 
        if ( !$status->isGood() ) {
            $this->dieStatus( $status );
        }
 
        $result = [ 'rcid' => (int)$rc->getAttribute( 'rc_id' ) ];
        ApiQueryBase::addTitleInfo( $result, $rc->getTitle() );
        $this->getResult()->addValue( null, $this->getModuleName(), $result );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'rcid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'revid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'tags' => [
                ParamValidator::PARAM_TYPE => 'tags',
                ParamValidator::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    public function needsToken() {
        return 'patrol';
    }
 
    protected function getExamplesMessages() {
        return [
            'action=patrol&token=123ABC&rcid=230672766'
                => 'apihelp-patrol-example-rcid',
            'action=patrol&token=123ABC&revid=230672766'
                => 'apihelp-patrol-example-revid',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Patrol';
    }
}
 
class_alias( ApiPatrol::class, 'ApiPatrol' );