includes/api/ApiQueryDeletedrevs.php

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