Page MenuHomeWickedGov Phorge
Files F4109334

ApiTag.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

ApiTag.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\ChangeTags\ChangeTags;
use MediaWiki\ChangeTags\ChangeTagsStore;
use MediaWiki\RecentChanges\RecentChangeLookup;
use MediaWiki\Revision\RevisionStore;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDatabase;
/**
* @ingroup API
* @since 1.25
*/
class ApiTag extends ApiBase {
use ApiBlockInfoTrait;
private IDatabase $dbr;
private RevisionStore $revisionStore;
private ChangeTagsStore $changeTagsStore;
private RecentChangeLookup $recentChangeLookup;
public function __construct(
ApiMain $main,
string $action,
IConnectionProvider $dbProvider,
RevisionStore $revisionStore,
ChangeTagsStore $changeTagsStore,
RecentChangeLookup $recentChangeLookup
) {
parent::__construct( $main, $action );
$this->dbr = $dbProvider->getReplicaDatabase();
$this->revisionStore = $revisionStore;
$this->changeTagsStore = $changeTagsStore;
$this->recentChangeLookup = $recentChangeLookup;
}
public function execute() {
$params = $this->extractRequestParams();
$user = $this->getUser();
// make sure the user is allowed
$this->checkUserRightsAny( 'changetags' );
// Fail early if the user is sitewide blocked.
$block = $user->getBlock();
if ( $block && $block->isSitewide() ) {
$this->dieBlocked( $block );
}
// Check if user can add tags
if ( $params['tags'] ) {
$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $this->getAuthority() );
if ( !$ableToTag->isOK() ) {
$this->dieStatus( $ableToTag );
}
}
// 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 function validateLogId( int $logid ): bool {
$result = $this->dbr->newSelectQueryBuilder()
->select( 'log_id' )
->from( 'logging' )
->where( [ 'log_id' => $logid ] )
->caller( __METHOD__ )->fetchField();
return (bool)$result;
}
protected function processIndividual( string $type, array $params, int $id ): array {
$user = $this->getUser();
$idResult = [ $type => $id ];
// validate the ID
$valid = false;
switch ( $type ) {
case 'rcid':
$valid = $this->recentChangeLookup->getRecentChangeById( $id );
// TODO: replace use of PermissionManager
if ( $valid && $this->getPermissionManager()->isBlockedFrom( $user, $valid->getTitle() ) ) {
$idResult['status'] = 'error';
// @phan-suppress-next-line PhanTypeMismatchArgument
$idResult += $this->getErrorFormatter()->formatMessage( ApiMessage::create(
'apierror-blocked',
'blocked',
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable Block is checked and not null
[ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
) );
return $idResult;
}
break;
case 'revid':
$valid = $this->revisionStore->getRevisionById( $id );
// TODO: replace use of PermissionManager
if (
$valid &&
$this->getPermissionManager()->isBlockedFrom( $user, $valid->getPageAsLinkTarget() )
) {
$idResult['status'] = 'error';
// @phan-suppress-next-line PhanTypeMismatchArgument
$idResult += $this->getErrorFormatter()->formatMessage( ApiMessage::create(
'apierror-blocked',
'blocked',
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable Block is checked and not null
[ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
) );
return $idResult;
}
break;
case 'logid':
$valid = $this->validateLogId( $id );
break;
}
if ( !$valid ) {
$idResult['status'] = 'error';
// Messages: apierror-nosuchrcid apierror-nosuchrevid apierror-nosuchlogid
$idResult += $this->getErrorFormatter()->formatMessage( [ "apierror-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->getAuthority()
);
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 ( $status->value->logId === null ) {
$idResult['noop'] = true;
} 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' );
if ( $params['tags'] ) {
$this->changeTagsStore->addTags( $params['tags'], null, null, $status->value->logId );
}
}
}
return $idResult;
}
/** @inheritDoc */
public function mustBePosted() {
return true;
}
/** @inheritDoc */
public function isWriteMode() {
return true;
}
/** @inheritDoc */
public function getAllowedParams() {
return [
'rcid' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_ISMULTI => true,
],
'revid' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_ISMULTI => true,
],
'logid' => [
ParamValidator::PARAM_TYPE => 'integer',
ParamValidator::PARAM_ISMULTI => true,
],
'add' => [
ParamValidator::PARAM_TYPE => 'tags',
ParamValidator::PARAM_ISMULTI => true,
],
'remove' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_ISMULTI => true,
],
'reason' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_DEFAULT => '',
],
'tags' => [
ParamValidator::PARAM_TYPE => 'tags',
ParamValidator::PARAM_ISMULTI => true,
],
];
}
/** @inheritDoc */
public function needsToken() {
return 'csrf';
}
/** @inheritDoc */
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',
];
}
/** @inheritDoc */
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tag';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiTag::class, 'ApiTag' );

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 21:00 (1 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
55/32/53430b8c0a2902c6b535cf655773
Default Alt Text
ApiTag.php (6 KB)

Event Timeline