includes/api/ApiQueryDeletedrevs.php

   1 <?php
   2 /**
   3  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Query module to enumerate all deleted revisions.
  25  *
  26  * @ingroup API
  27  * @deprecated since 1.25
  28  */
  29 class ApiQueryDeletedrevs extends ApiQueryBase {
  30
  31         public function __construct( ApiQuery $query, $moduleName ) {
  32                 parent::__construct( $query, $moduleName, 'dr' );
  33         }
  34
  35         public function execute() {
  36                 // Before doing anything at all, let's check permissions
  37                 $this->checkUserRightsAny( 'deletedhistory' );
  38
  39                 $this->addDeprecation( 'apiwarn-deprecation-deletedrevs', 'action=query&list=deletedrevs' );
  40
  41                 $user = $this->getUser();
  42                 $db = $this->getDB();
  43                 $commentStore = new CommentStore( 'ar_comment' );
  44                 $params = $this->extractRequestParams( false );
  45                 $prop = array_flip( $params['prop'] );
  46                 $fld_parentid = isset( $prop['parentid'] );
  47                 $fld_revid = isset( $prop['revid'] );
  48                 $fld_user = isset( $prop['user'] );
  49                 $fld_userid = isset( $prop['userid'] );
  50                 $fld_comment = isset( $prop['comment'] );
  51                 $fld_parsedcomment = isset( $prop['parsedcomment'] );
  52                 $fld_minor = isset( $prop['minor'] );
  53                 $fld_len = isset( $prop['len'] );
  54                 $fld_sha1 = isset( $prop['sha1'] );
  55                 $fld_content = isset( $prop['content'] );
  56                 $fld_token = isset( $prop['token'] );
  57                 $fld_tags = isset( $prop['tags'] );
  58
  59                 if ( isset( $prop['token'] ) ) {
  60                         $p = $this->getModulePrefix();
  61                 }
  62
  63                 // If we're in a mode that breaks the same-origin policy, no tokens can
  64                 // be obtained
  65                 if ( $this->lacksSameOriginSecurity() ) {
  66                         $fld_token = false;
  67                 }
  68
  69                 // If user can't undelete, no tokens
  70                 if ( !$user->isAllowed( 'undelete' ) ) {
  71                         $fld_token = false;
  72                 }
  73
  74                 $result = $this->getResult();
  75                 $pageSet = $this->getPageSet();
  76                 $titles = $pageSet->getTitles();
  77
  78                 // This module operates in three modes:
  79                 // 'revs': List deleted revs for certain titles (1)
  80                 // 'user': List deleted revs by a certain user (2)
  81                 // 'all': List all deleted revs in NS (3)
  82                 $mode = 'all';
  83                 if ( count( $titles ) > 0 ) {
  84                         $mode = 'revs';
  85                 } elseif ( !is_null( $params['user'] ) ) {
  86                         $mode = 'user';
  87                 }
  88
  89                 if ( $mode == 'revs' || $mode == 'user' ) {
  90                         // Ignore namespace and unique due to inability to know whether they were purposely set
  91                         foreach ( [ 'from', 'to', 'prefix', /*'namespace', 'unique'*/ ] as $p ) {
  92                                 if ( !is_null( $params[$p] ) ) {
  93                                         $this->dieWithError( [ 'apierror-deletedrevs-param-not-1-2', $p ], 'badparams' );
  94                                 }
  95                         }
  96                 } else {
  97                         foreach ( [ 'start', 'end' ] as $p ) {
  98                                 if ( !is_null( $params[$p] ) ) {
  99                                         $this->dieWithError( [ 'apierror-deletedrevs-param-not-3', $p ], 'badparams' );
 100                                 }
 101                         }
 102                 }
 103
 104                 if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
 105                         $this->dieWithError( 'user and excludeuser cannot be used together', 'badparams' );
 106                 }
 107
 108                 $this->addTables( 'archive' );
 109                 $this->addFields( [ 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_deleted', 'ar_id' ] );
 110
 111                 $this->addFieldsIf( 'ar_parent_id', $fld_parentid );
 112                 $this->addFieldsIf( 'ar_rev_id', $fld_revid );
 113                 $this->addFieldsIf( 'ar_user_text', $fld_user );
 114                 $this->addFieldsIf( 'ar_user', $fld_userid );
 115                 $this->addFieldsIf( 'ar_minor_edit', $fld_minor );
 116                 $this->addFieldsIf( 'ar_len', $fld_len );
 117                 $this->addFieldsIf( 'ar_sha1', $fld_sha1 );
 118
 119                 if ( $fld_comment || $fld_parsedcomment ) {
 120                         $commentQuery = $commentStore->getJoin();
 121                         $this->addTables( $commentQuery['tables'] );
 122                         $this->addFields( $commentQuery['fields'] );
 123                         $this->addJoinConds( $commentQuery['joins'] );
 124                 }
 125
 126                 if ( $fld_tags ) {
 127                         $this->addTables( 'tag_summary' );
 128                         $this->addJoinConds(
 129                                 [ 'tag_summary' => [ 'LEFT JOIN', [ 'ar_rev_id=ts_rev_id' ] ] ]
 130                         );
 131                         $this->addFields( 'ts_tags' );
 132                 }
 133
 134                 if ( !is_null( $params['tag'] ) ) {
 135                         $this->addTables( 'change_tag' );
 136                         $this->addJoinConds(
 137                                 [ 'change_tag' => [ 'INNER JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
 138                         );
 139                         $this->addWhereFld( 'ct_tag', $params['tag'] );
 140                 }
 141
 142                 if ( $fld_content ) {
 143                         // Modern MediaWiki has the content for deleted revs in the 'text'
 144                         // table using fields old_text and old_flags. But revisions deleted
 145                         // pre-1.5 store the content in the 'archive' table directly using
 146                         // fields ar_text and ar_flags, and no corresponding 'text' row. So
 147                         // we have to LEFT JOIN and fetch all four fields, plus ar_text_id
 148                         // to be able to tell the difference.
 149                         $this->addTables( 'text' );
 150                         $this->addJoinConds(
 151                                 [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
 152                         );
 153                         $this->addFields( [ 'ar_text', 'ar_flags', 'ar_text_id', 'old_text', 'old_flags' ] );
 154
 155                         // This also means stricter restrictions
 156                         $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
 157                 }
 158                 // Check limits
 159                 $userMax = $fld_content ? ApiBase::LIMIT_SML1 : ApiBase::LIMIT_BIG1;
 160                 $botMax = $fld_content ? ApiBase::LIMIT_SML2 : ApiBase::LIMIT_BIG2;
 161
 162                 $limit = $params['limit'];
 163
 164                 if ( $limit == 'max' ) {
 165                         $limit = $this->getMain()->canApiHighLimits() ? $botMax : $userMax;
 166                         $this->getResult()->addParsedLimit( $this->getModuleName(), $limit );
 167                 }
 168
 169                 $this->validateLimit( 'limit', $limit, 1, $userMax, $botMax );
 170
 171                 if ( $fld_token ) {
 172                         // Undelete tokens are identical for all pages, so we cache one here
 173                         $token = $user->getEditToken( '', $this->getMain()->getRequest() );
 174                 }
 175
 176                 $dir = $params['dir'];
 177
 178                 // We need a custom WHERE clause that matches all titles.
 179                 if ( $mode == 'revs' ) {
 180                         $lb = new LinkBatch( $titles );
 181                         $where = $lb->constructSet( 'ar', $db );
 182                         $this->addWhere( $where );
 183                 } elseif ( $mode == 'all' ) {
 184                         $this->addWhereFld( 'ar_namespace', $params['namespace'] );
 185
 186                         $from = $params['from'] === null
 187                                 ? null
 188                                 : $this->titlePartToKey( $params['from'], $params['namespace'] );
 189                         $to = $params['to'] === null
 190                                 ? null
 191                                 : $this->titlePartToKey( $params['to'], $params['namespace'] );
 192                         $this->addWhereRange( 'ar_title', $dir, $from, $to );
 193
 194                         if ( isset( $params['prefix'] ) ) {
 195                                 $this->addWhere( 'ar_title' . $db->buildLike(
 196                                         $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
 197                                         $db->anyString() ) );
 198                         }
 199                 }
 200
 201                 if ( !is_null( $params['user'] ) ) {
 202                         $this->addWhereFld( 'ar_user_text', $params['user'] );
 203                 } elseif ( !is_null( $params['excludeuser'] ) ) {
 204                         $this->addWhere( 'ar_user_text != ' .
 205                                 $db->addQuotes( $params['excludeuser'] ) );
 206                 }
 207
 208                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 209                         // Paranoia: avoid brute force searches (T19342)
 210                         // (shouldn't be able to get here without 'deletedhistory', but
 211                         // check it again just in case)
 212                         if ( !$user->isAllowed( 'deletedhistory' ) ) {
 213                                 $bitmask = Revision::DELETED_USER;
 214                         } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 215                                 $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
 216                         } else {
 217                                 $bitmask = 0;
 218                         }
 219                         if ( $bitmask ) {
 220                                 $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
 221                         }
 222                 }
 223
 224                 if ( !is_null( $params['continue'] ) ) {
 225                         $cont = explode( '|', $params['continue'] );
 226                         $op = ( $dir == 'newer' ? '>' : '<' );
 227                         if ( $mode == 'all' || $mode == 'revs' ) {
 228                                 $this->dieContinueUsageIf( count( $cont ) != 4 );
 229                                 $ns = intval( $cont[0] );
 230                                 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
 231                                 $title = $db->addQuotes( $cont[1] );
 232                                 $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
 233                                 $ar_id = (int)$cont[3];
 234                                 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
 235                                 $this->addWhere( "ar_namespace $op $ns OR " .
 236                                         "(ar_namespace = $ns AND " .
 237                                         "(ar_title $op $title OR " .
 238                                         "(ar_title = $title AND " .
 239                                         "(ar_timestamp $op $ts OR " .
 240                                         "(ar_timestamp = $ts AND " .
 241                                         "ar_id $op= $ar_id)))))" );
 242                         } else {
 243                                 $this->dieContinueUsageIf( count( $cont ) != 2 );
 244                                 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
 245                                 $ar_id = (int)$cont[1];
 246                                 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
 247                                 $this->addWhere( "ar_timestamp $op $ts OR " .
 248                                         "(ar_timestamp = $ts AND " .
 249                                         "ar_id $op= $ar_id)" );
 250                         }
 251                 }
 252
 253                 $this->addOption( 'LIMIT', $limit + 1 );
 254                 $this->addOption(
 255                         'USE INDEX',
 256                         [ 'archive' => ( $mode == 'user' ? 'ar_usertext_timestamp' : 'name_title_timestamp' ) ]
 257                 );
 258                 if ( $mode == 'all' ) {
 259                         if ( $params['unique'] ) {
 260                                 // @todo Does this work on non-MySQL?
 261                                 $this->addOption( 'GROUP BY', 'ar_title' );
 262                         } else {
 263                                 $sort = ( $dir == 'newer' ? '' : ' DESC' );
 264                                 $this->addOption( 'ORDER BY', [
 265                                         'ar_title' . $sort,
 266                                         'ar_timestamp' . $sort,
 267                                         'ar_id' . $sort,
 268                                 ] );
 269                         }
 270                 } else {
 271                         if ( $mode == 'revs' ) {
 272                                 // Sort by ns and title in the same order as timestamp for efficiency
 273                                 $this->addWhereRange( 'ar_namespace', $dir, null, null );
 274                                 $this->addWhereRange( 'ar_title', $dir, null, null );
 275                         }
 276                         $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
 277                         // Include in ORDER BY for uniqueness
 278                         $this->addWhereRange( 'ar_id', $dir, null, null );
 279                 }
 280                 $res = $this->select( __METHOD__ );
 281                 $pageMap = []; // Maps ns&title to (fake) pageid
 282                 $count = 0;
 283                 $newPageID = 0;
 284                 foreach ( $res as $row ) {
 285                         if ( ++$count > $limit ) {
 286                                 // We've had enough
 287                                 if ( $mode == 'all' || $mode == 'revs' ) {
 288                                         $this->setContinueEnumParameter( 'continue',
 289                                                 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
 290                                         );
 291                                 } else {
 292                                         $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
 293                                 }
 294                                 break;
 295                         }
 296
 297                         $rev = [];
 298                         $anyHidden = false;
 299
 300                         $rev['timestamp'] = wfTimestamp( TS_ISO_8601, $row->ar_timestamp );
 301                         if ( $fld_revid ) {
 302                                 $rev['revid'] = intval( $row->ar_rev_id );
 303                         }
 304                         if ( $fld_parentid && !is_null( $row->ar_parent_id ) ) {
 305                                 $rev['parentid'] = intval( $row->ar_parent_id );
 306                         }
 307                         if ( $fld_user || $fld_userid ) {
 308                                 if ( $row->ar_deleted & Revision::DELETED_USER ) {
 309                                         $rev['userhidden'] = true;
 310                                         $anyHidden = true;
 311                                 }
 312                                 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_USER, $user ) ) {
 313                                         if ( $fld_user ) {
 314                                                 $rev['user'] = $row->ar_user_text;
 315                                         }
 316                                         if ( $fld_userid ) {
 317                                                 $rev['userid'] = (int)$row->ar_user;
 318                                         }
 319                                 }
 320                         }
 321
 322                         if ( $fld_comment || $fld_parsedcomment ) {
 323                                 if ( $row->ar_deleted & Revision::DELETED_COMMENT ) {
 324                                         $rev['commenthidden'] = true;
 325                                         $anyHidden = true;
 326                                 }
 327                                 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_COMMENT, $user ) ) {
 328                                         $comment = $commentStore->getComment( $row )->text;
 329                                         if ( $fld_comment ) {
 330                                                 $rev['comment'] = $comment;
 331                                         }
 332                                         if ( $fld_parsedcomment ) {
 333                                                 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 334                                                 $rev['parsedcomment'] = Linker::formatComment( $comment, $title );
 335                                         }
 336                                 }
 337                         }
 338
 339                         if ( $fld_minor ) {
 340                                 $rev['minor'] = $row->ar_minor_edit == 1;
 341                         }
 342                         if ( $fld_len ) {
 343                                 $rev['len'] = $row->ar_len;
 344                         }
 345                         if ( $fld_sha1 ) {
 346                                 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
 347                                         $rev['sha1hidden'] = true;
 348                                         $anyHidden = true;
 349                                 }
 350                                 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
 351                                         if ( $row->ar_sha1 != '' ) {
 352                                                 $rev['sha1'] = Wikimedia\base_convert( $row->ar_sha1, 36, 16, 40 );
 353                                         } else {
 354                                                 $rev['sha1'] = '';
 355                                         }
 356                                 }
 357                         }
 358                         if ( $fld_content ) {
 359                                 if ( $row->ar_deleted & Revision::DELETED_TEXT ) {
 360                                         $rev['texthidden'] = true;
 361                                         $anyHidden = true;
 362                                 }
 363                                 if ( Revision::userCanBitfield( $row->ar_deleted, Revision::DELETED_TEXT, $user ) ) {
 364                                         if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
 365                                                 // Pre-1.5 ar_text row (if condition from Revision::newFromArchiveRow)
 366                                                 ApiResult::setContentValue( $rev, 'text', Revision::getRevisionText( $row, 'ar_' ) );
 367                                         } else {
 368                                                 ApiResult::setContentValue( $rev, 'text', Revision::getRevisionText( $row ) );
 369                                         }
 370                                 }
 371                         }
 372
 373                         if ( $fld_tags ) {
 374                                 if ( $row->ts_tags ) {
 375                                         $tags = explode( ',', $row->ts_tags );
 376                                         ApiResult::setIndexedTagName( $tags, 'tag' );
 377                                         $rev['tags'] = $tags;
 378                                 } else {
 379                                         $rev['tags'] = [];
 380                                 }
 381                         }
 382
 383                         if ( $anyHidden && ( $row->ar_deleted & Revision::DELETED_RESTRICTED ) ) {
 384                                 $rev['suppressed'] = true;
 385                         }
 386
 387                         if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
 388                                 $pageID = $newPageID++;
 389                                 $pageMap[$row->ar_namespace][$row->ar_title] = $pageID;
 390                                 $a['revisions'] = [ $rev ];
 391                                 ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
 392                                 $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 393                                 ApiQueryBase::addTitleInfo( $a, $title );
 394                                 if ( $fld_token ) {
 395                                         $a['token'] = $token;
 396                                 }
 397                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], $pageID, $a );
 398                         } else {
 399                                 $pageID = $pageMap[$row->ar_namespace][$row->ar_title];
 400                                 $fit = $result->addValue(
 401                                         [ 'query', $this->getModuleName(), $pageID, 'revisions' ],
 402                                         null, $rev );
 403                         }
 404                         if ( !$fit ) {
 405                                 if ( $mode == 'all' || $mode == 'revs' ) {
 406                                         $this->setContinueEnumParameter( 'continue',
 407                                                 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
 408                                         );
 409                                 } else {
 410                                         $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
 411                                 }
 412                                 break;
 413                         }
 414                 }
 415                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
 416         }
 417
 418         public function isDeprecated() {
 419                 return true;
 420         }
 421
 422         public function getAllowedParams() {
 423                 return [
 424                         'start' => [
 425                                 ApiBase::PARAM_TYPE => 'timestamp',
 426                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
 427                         ],
 428                         'end' => [
 429                                 ApiBase::PARAM_TYPE => 'timestamp',
 430                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 2 ] ],
 431                         ],
 432                         'dir' => [
 433                                 ApiBase::PARAM_TYPE => [
 434                                         'newer',
 435                                         'older'
 436                                 ],
 437                                 ApiBase::PARAM_DFLT => 'older',
 438                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 439                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 1, 3 ] ],
 440                         ],
 441                         'from' => [
 442                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
 443                         ],
 444                         'to' => [
 445                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
 446                         ],
 447                         'prefix' => [
 448                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
 449                         ],
 450                         'unique' => [
 451                                 ApiBase::PARAM_DFLT => false,
 452                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
 453                         ],
 454                         'namespace' => [
 455                                 ApiBase::PARAM_TYPE => 'namespace',
 456                                 ApiBase::PARAM_DFLT => NS_MAIN,
 457                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'modes', 3 ] ],
 458                         ],
 459                         'tag' => null,
 460                         'user' => [
 461                                 ApiBase::PARAM_TYPE => 'user'
 462                         ],
 463                         'excludeuser' => [
 464                                 ApiBase::PARAM_TYPE => 'user'
 465                         ],
 466                         'prop' => [
 467                                 ApiBase::PARAM_DFLT => 'user|comment',
 468                                 ApiBase::PARAM_TYPE => [
 469                                         'revid',
 470                                         'parentid',
 471                                         'user',
 472                                         'userid',
 473                                         'comment',
 474                                         'parsedcomment',
 475                                         'minor',
 476                                         'len',
 477                                         'sha1',
 478                                         'content',
 479                                         'token',
 480                                         'tags'
 481                                 ],
 482                                 ApiBase::PARAM_ISMULTI => true
 483                         ],
 484                         'limit' => [
 485                                 ApiBase::PARAM_DFLT => 10,
 486                                 ApiBase::PARAM_TYPE => 'limit',
 487                                 ApiBase::PARAM_MIN => 1,
 488                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 489                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 490                         ],
 491                         'continue' => [
 492                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 493                         ],
 494                 ];
 495         }
 496
 497         protected function getExamplesMessages() {
 498                 return [
 499                         'action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&' .
 500                                 'drprop=user|comment|content'
 501                                 => 'apihelp-query+deletedrevs-example-mode1',
 502                         'action=query&list=deletedrevs&druser=Bob&drlimit=50'
 503                                 => 'apihelp-query+deletedrevs-example-mode2',
 504                         'action=query&list=deletedrevs&drdir=newer&drlimit=50'
 505                                 => 'apihelp-query+deletedrevs-example-mode3-main',
 506                         'action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
 507                                 => 'apihelp-query+deletedrevs-example-mode3-talk',
 508                 ];
 509         }
 510
 511         public function getHelpUrls() {
 512                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevs';
 513         }
 514 }