includes/api/ApiTag.php

   1 <?php
   2
   3 /**
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  */
  21
  22 use MediaWiki\MediaWikiServices;
  23
  24 /**
  25  * @ingroup API
  26  * @since 1.25
  27  */
  28 class ApiTag extends ApiBase {
  29
  30         use ApiBlockInfoTrait;
  31
  32         /** @var \MediaWiki\Revision\RevisionStore */
  33         private $revisionStore;
  34
  35         public function execute() {
  36                 $this->revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
  37
  38                 $params = $this->extractRequestParams();
  39                 $user = $this->getUser();
  40
  41                 // make sure the user is allowed
  42                 $this->checkUserRightsAny( 'changetags' );
  43
  44                 // Fail early if the user is sitewide blocked.
  45                 $block = $user->getBlock();
  46                 if ( $block && $block->isSitewide() ) {
  47                         $this->dieBlocked( $block );
  48                 }
  49
  50                 // Check if user can add tags
  51                 if ( $params['tags'] ) {
  52                         $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
  53                         if ( !$ableToTag->isOK() ) {
  54                                 $this->dieStatus( $ableToTag );
  55                         }
  56                 }
  57
  58                 // validate and process each revid, rcid and logid
  59                 $this->requireAtLeastOneParameter( $params, 'revid', 'rcid', 'logid' );
  60                 $ret = [];
  61                 if ( $params['revid'] ) {
  62                         foreach ( $params['revid'] as $id ) {
  63                                 $ret[] = $this->processIndividual( 'revid', $params, $id );
  64                         }
  65                 }
  66                 if ( $params['rcid'] ) {
  67                         foreach ( $params['rcid'] as $id ) {
  68                                 $ret[] = $this->processIndividual( 'rcid', $params, $id );
  69                         }
  70                 }
  71                 if ( $params['logid'] ) {
  72                         foreach ( $params['logid'] as $id ) {
  73                                 $ret[] = $this->processIndividual( 'logid', $params, $id );
  74                         }
  75                 }
  76
  77                 ApiResult::setIndexedTagName( $ret, 'result' );
  78                 $this->getResult()->addValue( null, $this->getModuleName(), $ret );
  79         }
  80
  81         protected static function validateLogId( $logid ) {
  82                 $dbr = wfGetDB( DB_REPLICA );
  83                 $result = $dbr->selectField( 'logging', 'log_id', [ 'log_id' => $logid ],
  84                         __METHOD__ );
  85                 return (bool)$result;
  86         }
  87
  88         protected function processIndividual( $type, $params, $id ) {
  89                 $user = $this->getUser();
  90                 $idResult = [ $type => $id ];
  91
  92                 // validate the ID
  93                 $valid = false;
  94                 switch ( $type ) {
  95                         case 'rcid':
  96                                 $valid = RecentChange::newFromId( $id );
  97                                 if ( $valid && $this->getPermissionManager()->isBlockedFrom( $user, $valid->getTitle() ) ) {
  98                                         $idResult['status'] = 'error';
  99                                         // @phan-suppress-next-line PhanTypeMismatchArgument
 100                                         $idResult += $this->getErrorFormatter()->formatMessage( ApiMessage::create(
 101                                                 'apierror-blocked',
 102                                                 'blocked',
 103                                                 [ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
 104                                         ) );
 105                                         return $idResult;
 106                                 }
 107                                 break;
 108                         case 'revid':
 109                                 $valid = $this->revisionStore->getRevisionById( $id );
 110                                 if (
 111                                         $valid &&
 112                                         $this->getPermissionManager()->isBlockedFrom( $user, $valid->getPageAsLinkTarget() )
 113                                 ) {
 114                                         $idResult['status'] = 'error';
 115                                         // @phan-suppress-next-line PhanTypeMismatchArgument
 116                                         $idResult += $this->getErrorFormatter()->formatMessage( ApiMessage::create(
 117                                                         'apierror-blocked',
 118                                                         'blocked',
 119                                                         [ 'blockinfo' => $this->getBlockDetails( $user->getBlock() ) ]
 120                                         ) );
 121                                         return $idResult;
 122                                 }
 123                                 break;
 124                         case 'logid':
 125                                 $valid = self::validateLogId( $id );
 126                                 break;
 127                 }
 128
 129                 if ( !$valid ) {
 130                         $idResult['status'] = 'error';
 131                         // Messages: apierror-nosuchrcid apierror-nosuchrevid apierror-nosuchlogid
 132                         $idResult += $this->getErrorFormatter()->formatMessage( [ "apierror-nosuch$type", $id ] );
 133                         return $idResult;
 134                 }
 135
 136                 $status = ChangeTags::updateTagsWithChecks( $params['add'],
 137                         $params['remove'],
 138                         ( $type === 'rcid' ? $id : null ),
 139                         ( $type === 'revid' ? $id : null ),
 140                         ( $type === 'logid' ? $id : null ),
 141                         null,
 142                         $params['reason'],
 143                         $this->getUser() );
 144
 145                 if ( !$status->isOK() ) {
 146                         if ( $status->hasMessage( 'actionthrottledtext' ) ) {
 147                                 $idResult['status'] = 'skipped';
 148                         } else {
 149                                 $idResult['status'] = 'failure';
 150                                 $idResult['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status, 'error' );
 151                         }
 152                 } else {
 153                         $idResult['status'] = 'success';
 154                         if ( is_null( $status->value->logId ) ) {
 155                                 $idResult['noop'] = true;
 156                         } else {
 157                                 $idResult['actionlogid'] = $status->value->logId;
 158                                 $idResult['added'] = $status->value->addedTags;
 159                                 ApiResult::setIndexedTagName( $idResult['added'], 't' );
 160                                 $idResult['removed'] = $status->value->removedTags;
 161                                 ApiResult::setIndexedTagName( $idResult['removed'], 't' );
 162
 163                                 if ( $params['tags'] ) {
 164                                         ChangeTags::addTags( $params['tags'], null, null, $status->value->logId );
 165                                 }
 166                         }
 167                 }
 168                 return $idResult;
 169         }
 170
 171         public function mustBePosted() {
 172                 return true;
 173         }
 174
 175         public function isWriteMode() {
 176                 return true;
 177         }
 178
 179         public function getAllowedParams() {
 180                 return [
 181                         'rcid' => [
 182                                 ApiBase::PARAM_TYPE => 'integer',
 183                                 ApiBase::PARAM_ISMULTI => true,
 184                         ],
 185                         'revid' => [
 186                                 ApiBase::PARAM_TYPE => 'integer',
 187                                 ApiBase::PARAM_ISMULTI => true,
 188                         ],
 189                         'logid' => [
 190                                 ApiBase::PARAM_TYPE => 'integer',
 191                                 ApiBase::PARAM_ISMULTI => true,
 192                         ],
 193                         'add' => [
 194                                 ApiBase::PARAM_TYPE => 'tags',
 195                                 ApiBase::PARAM_ISMULTI => true,
 196                         ],
 197                         'remove' => [
 198                                 ApiBase::PARAM_TYPE => 'string',
 199                                 ApiBase::PARAM_ISMULTI => true,
 200                         ],
 201                         'reason' => [
 202                                 ApiBase::PARAM_DFLT => '',
 203                         ],
 204                         'tags' => [
 205                                 ApiBase::PARAM_TYPE => 'tags',
 206                                 ApiBase::PARAM_ISMULTI => true,
 207                         ],
 208                 ];
 209         }
 210
 211         public function needsToken() {
 212                 return 'csrf';
 213         }
 214
 215         protected function getExamplesMessages() {
 216                 return [
 217                         'action=tag&revid=123&add=vandalism&token=123ABC'
 218                                 => 'apihelp-tag-example-rev',
 219                         'action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC'
 220                                 => 'apihelp-tag-example-log',
 221                 ];
 222         }
 223
 224         public function getHelpUrls() {
 225                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tag';
 226         }
 227 }