includes/api/ApiRevisionDelete.php

   1 <?php
   2 /**
   3  * Created on Jun 25, 2013
   4  *
   5  * Copyright © 2013 Brad Jorsch <bjorsch@wikimedia.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @since 1.23
  24  */
  25
  26 /**
  27  * API interface to RevDel. The API equivalent of Special:RevisionDelete.
  28  * Requires API write mode to be enabled.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiRevisionDelete extends ApiBase {
  33
  34         public function execute() {
  35                 $this->useTransactionalTimeLimit();
  36
  37                 $params = $this->extractRequestParams();
  38                 $user = $this->getUser();
  39
  40                 if ( !$user->isAllowed( RevisionDeleter::getRestriction( $params['type'] ) ) ) {
  41                         $this->dieUsageMsg( 'badaccess-group0' );
  42                 }
  43
  44                 if ( !$params['ids'] ) {
  45                         $this->dieUsage( "At least one value is required for 'ids'", 'badparams' );
  46                 }
  47
  48                 $hide = $params['hide'] ?: array();
  49                 $show = $params['show'] ?: array();
  50                 if ( array_intersect( $hide, $show ) ) {
  51                         $this->dieUsage( "Mutually exclusive values for 'hide' and 'show'", 'badparams' );
  52                 } elseif ( !$hide && !$show ) {
  53                         $this->dieUsage( "At least one value is required for 'hide' or 'show'", 'badparams' );
  54                 }
  55                 $bits = array(
  56                         'content' => RevisionDeleter::getRevdelConstant( $params['type'] ),
  57                         'comment' => Revision::DELETED_COMMENT,
  58                         'user' => Revision::DELETED_USER,
  59                 );
  60                 $bitfield = array();
  61                 foreach ( $bits as $key => $bit ) {
  62                         if ( in_array( $key, $hide ) ) {
  63                                 $bitfield[$bit] = 1;
  64                         } elseif ( in_array( $key, $show ) ) {
  65                                 $bitfield[$bit] = 0;
  66                         } else {
  67                                 $bitfield[$bit] = -1;
  68                         }
  69                 }
  70
  71                 if ( $params['suppress'] === 'yes' ) {
  72                         if ( !$user->isAllowed( 'suppressrevision' ) ) {
  73                                 $this->dieUsageMsg( 'badaccess-group0' );
  74                         }
  75                         $bitfield[Revision::DELETED_RESTRICTED] = 1;
  76                 } elseif ( $params['suppress'] === 'no' ) {
  77                         $bitfield[Revision::DELETED_RESTRICTED] = 0;
  78                 } else {
  79                         $bitfield[Revision::DELETED_RESTRICTED] = -1;
  80                 }
  81
  82                 $targetObj = null;
  83                 if ( $params['target'] ) {
  84                         $targetObj = Title::newFromText( $params['target'] );
  85                 }
  86                 $targetObj = RevisionDeleter::suggestTarget( $params['type'], $targetObj, $params['ids'] );
  87                 if ( $targetObj === null ) {
  88                         $this->dieUsage( 'A target title is required for this RevDel type', 'needtarget' );
  89                 }
  90
  91                 $list = RevisionDeleter::createList(
  92                         $params['type'], $this->getContext(), $targetObj, $params['ids']
  93                 );
  94                 $status = $list->setVisibility(
  95                         array( 'value' => $bitfield, 'comment' => $params['reason'], 'perItemStatus' => true )
  96                 );
  97
  98                 $result = $this->getResult();
  99                 $data = $this->extractStatusInfo( $status );
 100                 $data['target'] = $targetObj->getFullText();
 101                 $data['items'] = array();
 102
 103                 foreach ( $status->itemStatuses as $id => $s ) {
 104                         $data['items'][$id] = $this->extractStatusInfo( $s );
 105                         $data['items'][$id]['id'] = $id;
 106                 }
 107
 108                 $list->reloadFromMaster();
 109                 // @codingStandardsIgnoreStart Avoid function calls in a FOR loop test part
 110                 for ( $item = $list->reset(); $list->current(); $item = $list->next() ) {
 111                         $data['items'][$item->getId()] += $item->getApiData( $this->getResult() );
 112                 }
 113                 // @codingStandardsIgnoreEnd
 114
 115                 $data['items'] = array_values( $data['items'] );
 116                 ApiResult::setIndexedTagName( $data['items'], 'i' );
 117                 $result->addValue( null, $this->getModuleName(), $data );
 118         }
 119
 120         private function extractStatusInfo( $status ) {
 121                 $ret = array(
 122                         'status' => $status->isOK() ? 'Success' : 'Fail',
 123                 );
 124                 $errors = $this->formatStatusMessages( $status->getErrorsByType( 'error' ) );
 125                 if ( $errors ) {
 126                         ApiResult::setIndexedTagName( $errors, 'e' );
 127                         $ret['errors'] = $errors;
 128                 }
 129                 $warnings = $this->formatStatusMessages( $status->getErrorsByType( 'warning' ) );
 130                 if ( $warnings ) {
 131                         ApiResult::setIndexedTagName( $warnings, 'w' );
 132                         $ret['warnings'] = $warnings;
 133                 }
 134
 135                 return $ret;
 136         }
 137
 138         private function formatStatusMessages( $messages ) {
 139                 if ( !$messages ) {
 140                         return array();
 141                 }
 142                 $ret = array();
 143                 foreach ( $messages as $m ) {
 144                         if ( $m['message'] instanceof Message ) {
 145                                 $msg = $m['message'];
 146                                 $message = array( 'message' => $msg->getKey() );
 147                                 if ( $msg->getParams() ) {
 148                                         $message['params'] = $msg->getParams();
 149                                         ApiResult::setIndexedTagName( $message['params'], 'p' );
 150                                 }
 151                         } else {
 152                                 $message = array( 'message' => $m['message'] );
 153                                 $msg = wfMessage( $m['message'] );
 154                                 if ( isset( $m['params'] ) ) {
 155                                         $message['params'] = $m['params'];
 156                                         ApiResult::setIndexedTagName( $message['params'], 'p' );
 157                                         $msg->params( $m['params'] );
 158                                 }
 159                         }
 160                         $message['rendered'] = $msg->useDatabase( false )->inLanguage( 'en' )->plain();
 161                         $ret[] = $message;
 162                 }
 163
 164                 return $ret;
 165         }
 166
 167         public function mustBePosted() {
 168                 return true;
 169         }
 170
 171         public function isWriteMode() {
 172                 return true;
 173         }
 174
 175         public function getAllowedParams() {
 176                 return array(
 177                         'type' => array(
 178                                 ApiBase::PARAM_TYPE => RevisionDeleter::getTypes(),
 179                                 ApiBase::PARAM_REQUIRED => true
 180                         ),
 181                         'target' => null,
 182                         'ids' => array(
 183                                 ApiBase::PARAM_ISMULTI => true,
 184                                 ApiBase::PARAM_REQUIRED => true
 185                         ),
 186                         'hide' => array(
 187                                 ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
 188                                 ApiBase::PARAM_ISMULTI => true,
 189                         ),
 190                         'show' => array(
 191                                 ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
 192                                 ApiBase::PARAM_ISMULTI => true,
 193                         ),
 194                         'suppress' => array(
 195                                 ApiBase::PARAM_TYPE => array( 'yes', 'no', 'nochange' ),
 196                                 ApiBase::PARAM_DFLT => 'nochange',
 197                         ),
 198                         'reason' => null,
 199                 );
 200         }
 201
 202         public function needsToken() {
 203                 return 'csrf';
 204         }
 205
 206         protected function getExamplesMessages() {
 207                 return array(
 208                         'action=revisiondelete&target=Main%20Page&type=revision&ids=12345&' .
 209                                 'hide=content&token=123ABC'
 210                                 => 'apihelp-revisiondelete-example-revision',
 211                         'action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&' .
 212                                 'reason=BLP%20violation&token=123ABC'
 213                                 => 'apihelp-revisiondelete-example-log',
 214                 );
 215         }
 216
 217         public function getHelpUrls() {
 218                 return 'https://www.mediawiki.org/wiki/API:Revisiondelete';
 219         }
 220 }