ApiTag.php

Go to the documentation of this file.

<?php

class ApiTag extends ApiBase {

    public function execute() {
        $params = $this->extractRequestParams();
        $user = $this->getUser();

        // make sure the user is allowed
        if ( !$user->isAllowed( 'changetags' ) ) {
            $this->dieUsage( "You don't have permission to add or remove change tags from individual edits",
                'permissiondenied' );
        }

        if ( $user->isBlocked() ) {
            $this->dieBlocked( $user->getBlock() );
        }

        // validate and process each revid, rcid and logid
        $this->requireAtLeastOneParameter( $params, 'revid', 'rcid', 'logid' );
        $ret = [];
        if ( $params['revid'] ) {
            foreach ( $params['revid'] as $id ) {
                $ret[] = $this->processIndividual( 'revid', $params, $id );
            }
        }
        if ( $params['rcid'] ) {
            foreach ( $params['rcid'] as $id ) {
                $ret[] = $this->processIndividual( 'rcid', $params, $id );
            }
        }
        if ( $params['logid'] ) {
            foreach ( $params['logid'] as $id ) {
                $ret[] = $this->processIndividual( 'logid', $params, $id );
            }
        }

        ApiResult::setIndexedTagName( $ret, 'result' );
        $this->getResult()->addValue( null, $this->getModuleName(), $ret );
    }

    protected static function validateLogId( $logid ) {
        $dbr = wfGetDB( DB_SLAVE );
        $result = $dbr->selectField( 'logging', 'log_id', [ 'log_id' => $logid ],
            __METHOD__ );
        return (bool)$result;
    }

    protected function processIndividual( $type, $params, $id ) {
        $idResult = [ $type => $id ];

        // validate the ID
        $valid = false;
        switch ( $type ) {
            case 'rcid':
                $valid = RecentChange::newFromId( $id );
                break;
            case 'revid':
                $valid = Revision::newFromId( $id );
                break;
            case 'logid':
                $valid = self::validateLogId( $id );
                break;
        }

        if ( !$valid ) {
            $idResult['status'] = 'error';
            $idResult += $this->parseMsg( [ "nosuch$type", $id ] );
            return $idResult;
        }

        $status = ChangeTags::updateTagsWithChecks( $params['add'],
            $params['remove'],
            ( $type === 'rcid' ? $id : null ),
            ( $type === 'revid' ? $id : null ),
            ( $type === 'logid' ? $id : null ),
            null,
            $params['reason'],
            $this->getUser() );

        if ( !$status->isOK() ) {
            if ( $status->hasMessage( 'actionthrottledtext' ) ) {
                $idResult['status'] = 'skipped';
            } else {
                $idResult['status'] = 'failure';
                $idResult['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status, 'error' );
            }
        } else {
            $idResult['status'] = 'success';
            if ( is_null( $status->value->logId ) ) {
                $idResult['noop'] = '';
            } else {
                $idResult['actionlogid'] = $status->value->logId;
                $idResult['added'] = $status->value->addedTags;
                ApiResult::setIndexedTagName( $idResult['added'], 't' );
                $idResult['removed'] = $status->value->removedTags;
                ApiResult::setIndexedTagName( $idResult['removed'], 't' );
            }
        }
        return $idResult;
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function getAllowedParams() {
        return [
            'rcid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'revid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'logid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'add' => [
                ApiBase::PARAM_TYPE => 'tags',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'remove' => [
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'reason' => [
                ApiBase::PARAM_DFLT => '',
            ],
        ];
    }

    public function needsToken() {
        return 'csrf';
    }

    protected function getExamplesMessages() {
        return [
            'action=tag&revid=123&add=vandalism&token=123ABC'
                => 'apihelp-tag-example-rev',
            'action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC'
                => 'apihelp-tag-example-log',
        ];
    }

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