includes/api/ApiQueryAllDeletedRevisions.php

   1 <?php
   2 /**
   3  * Copyright © 2014 Wikimedia Foundation and contributors
   4  *
   5  * Heavily based on ApiQueryDeletedrevs,
   6  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27 use MediaWiki\Revision\RevisionRecord;
  28 use MediaWiki\Storage\NameTableAccessException;
  29
  30 /**
  31  * Query module to enumerate all deleted revisions.
  32  *
  33  * @ingroup API
  34  */
  35 class ApiQueryAllDeletedRevisions extends ApiQueryRevisionsBase {
  36
  37         public function __construct( ApiQuery $query, $moduleName ) {
  38                 parent::__construct( $query, $moduleName, 'adr' );
  39         }
  40
  41         /**
  42          * @param ApiPageSet|null $resultPageSet
  43          * @return void
  44          */
  45         protected function run( ApiPageSet $resultPageSet = null ) {
  46                 // Before doing anything at all, let's check permissions
  47                 $this->checkUserRightsAny( 'deletedhistory' );
  48
  49                 $user = $this->getUser();
  50                 $db = $this->getDB();
  51                 $params = $this->extractRequestParams( false );
  52                 $services = MediaWikiServices::getInstance();
  53                 $revisionStore = $services->getRevisionStore();
  54
  55                 $result = $this->getResult();
  56
  57                 // If the user wants no namespaces, they get no pages.
  58                 if ( $params['namespace'] === [] ) {
  59                         if ( $resultPageSet === null ) {
  60                                 $result->addValue( 'query', $this->getModuleName(), [] );
  61                         }
  62                         return;
  63                 }
  64
  65                 // This module operates in two modes:
  66                 // 'user': List deleted revs by a certain user
  67                 // 'all': List all deleted revs in NS
  68                 $mode = 'all';
  69                 if ( !is_null( $params['user'] ) ) {
  70                         $mode = 'user';
  71                 }
  72
  73                 if ( $mode == 'user' ) {
  74                         foreach ( [ 'from', 'to', 'prefix', 'excludeuser' ] as $param ) {
  75                                 if ( !is_null( $params[$param] ) ) {
  76                                         $p = $this->getModulePrefix();
  77                                         $this->dieWithError(
  78                                                 [ 'apierror-invalidparammix-cannotusewith', $p . $param, "{$p}user" ],
  79                                                 'invalidparammix'
  80                                         );
  81                                 }
  82                         }
  83                 } else {
  84                         foreach ( [ 'start', 'end' ] as $param ) {
  85                                 if ( !is_null( $params[$param] ) ) {
  86                                         $p = $this->getModulePrefix();
  87                                         $this->dieWithError(
  88                                                 [ 'apierror-invalidparammix-mustusewith', $p . $param, "{$p}user" ],
  89                                                 'invalidparammix'
  90                                         );
  91                                 }
  92                         }
  93                 }
  94
  95                 // If we're generating titles only, we can use DISTINCT for a better
  96                 // query. But we can't do that in 'user' mode (wrong index), and we can
  97                 // only do it when sorting ASC (because MySQL apparently can't use an
  98                 // index backwards for grouping even though it can for ORDER BY, WTF?)
  99                 $dir = $params['dir'];
 100                 $optimizeGenerateTitles = false;
 101                 if ( $mode === 'all' && $params['generatetitles'] && $resultPageSet !== null ) {
 102                         if ( $dir === 'newer' ) {
 103                                 $optimizeGenerateTitles = true;
 104                         } else {
 105                                 $p = $this->getModulePrefix();
 106                                 $this->addWarning( [ 'apiwarn-alldeletedrevisions-performance', $p ], 'performance' );
 107                         }
 108                 }
 109
 110                 if ( $resultPageSet === null ) {
 111                         $this->parseParameters( $params );
 112                         $arQuery = $revisionStore->getArchiveQueryInfo();
 113                         $this->addTables( $arQuery['tables'] );
 114                         $this->addJoinConds( $arQuery['joins'] );
 115                         $this->addFields( $arQuery['fields'] );
 116                         $this->addFields( [ 'ar_title', 'ar_namespace' ] );
 117                 } else {
 118                         $this->limit = $this->getParameter( 'limit' ) ?: 10;
 119                         $this->addTables( 'archive' );
 120                         $this->addFields( [ 'ar_title', 'ar_namespace' ] );
 121                         if ( $optimizeGenerateTitles ) {
 122                                 $this->addOption( 'DISTINCT' );
 123                         } else {
 124                                 $this->addFields( [ 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
 125                         }
 126                 }
 127
 128                 if ( $this->fld_tags ) {
 129                         $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'archive' ) ] );
 130                 }
 131
 132                 if ( !is_null( $params['tag'] ) ) {
 133                         $this->addTables( 'change_tag' );
 134                         $this->addJoinConds(
 135                                 [ 'change_tag' => [ 'JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
 136                         );
 137                         $changeTagDefStore = $services->getChangeTagDefStore();
 138                         try {
 139                                 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
 140                         } catch ( NameTableAccessException $exception ) {
 141                                 // Return nothing.
 142                                 $this->addWhere( '1=0' );
 143                         }
 144                 }
 145
 146                 // This means stricter restrictions
 147                 if ( $this->fetchContent ) {
 148                         $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
 149                 }
 150
 151                 $miser_ns = null;
 152
 153                 if ( $mode == 'all' ) {
 154                         $namespaces = $params['namespace'] ??
 155                                 $services->getNamespaceInfo()->getValidNamespaces();
 156                         $this->addWhereFld( 'ar_namespace', $namespaces );
 157
 158                         // For from/to/prefix, we have to consider the potential
 159                         // transformations of the title in all specified namespaces.
 160                         // Generally there will be only one transformation, but wikis with
 161                         // some namespaces case-sensitive could have two.
 162                         if ( $params['from'] !== null || $params['to'] !== null ) {
 163                                 $isDirNewer = ( $dir === 'newer' );
 164                                 $after = ( $isDirNewer ? '>=' : '<=' );
 165                                 $before = ( $isDirNewer ? '<=' : '>=' );
 166                                 $where = [];
 167                                 foreach ( $namespaces as $ns ) {
 168                                         $w = [];
 169                                         if ( $params['from'] !== null ) {
 170                                                 $w[] = 'ar_title' . $after .
 171                                                         $db->addQuotes( $this->titlePartToKey( $params['from'], $ns ) );
 172                                         }
 173                                         if ( $params['to'] !== null ) {
 174                                                 $w[] = 'ar_title' . $before .
 175                                                         $db->addQuotes( $this->titlePartToKey( $params['to'], $ns ) );
 176                                         }
 177                                         $w = $db->makeList( $w, LIST_AND );
 178                                         $where[$w][] = $ns;
 179                                 }
 180                                 if ( count( $where ) == 1 ) {
 181                                         $where = key( $where );
 182                                         $this->addWhere( $where );
 183                                 } else {
 184                                         $where2 = [];
 185                                         foreach ( $where as $w => $ns ) {
 186                                                 $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
 187                                         }
 188                                         $this->addWhere( $db->makeList( $where2, LIST_OR ) );
 189                                 }
 190                         }
 191
 192                         if ( isset( $params['prefix'] ) ) {
 193                                 $where = [];
 194                                 foreach ( $namespaces as $ns ) {
 195                                         $w = 'ar_title' . $db->buildLike(
 196                                                 $this->titlePartToKey( $params['prefix'], $ns ),
 197                                                 $db->anyString() );
 198                                         $where[$w][] = $ns;
 199                                 }
 200                                 if ( count( $where ) == 1 ) {
 201                                         $where = key( $where );
 202                                         $this->addWhere( $where );
 203                                 } else {
 204                                         $where2 = [];
 205                                         foreach ( $where as $w => $ns ) {
 206                                                 $where2[] = $db->makeList( [ $w, 'ar_namespace' => $ns ], LIST_AND );
 207                                         }
 208                                         $this->addWhere( $db->makeList( $where2, LIST_OR ) );
 209                                 }
 210                         }
 211                 } else {
 212                         if ( $this->getConfig()->get( 'MiserMode' ) ) {
 213                                 $miser_ns = $params['namespace'];
 214                         } else {
 215                                 $this->addWhereFld( 'ar_namespace', $params['namespace'] );
 216                         }
 217                         $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
 218                 }
 219
 220                 if ( !is_null( $params['user'] ) ) {
 221                         // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
 222                         $actorQuery = ActorMigration::newMigration()
 223                                 ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
 224                         $this->addTables( $actorQuery['tables'] );
 225                         $this->addJoinConds( $actorQuery['joins'] );
 226                         $this->addWhere( $actorQuery['conds'] );
 227                 } elseif ( !is_null( $params['excludeuser'] ) ) {
 228                         // Here there's no chance of using ar_usertext_timestamp.
 229                         $actorQuery = ActorMigration::newMigration()
 230                                 ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
 231                         $this->addTables( $actorQuery['tables'] );
 232                         $this->addJoinConds( $actorQuery['joins'] );
 233                         $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
 234                 }
 235
 236                 if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
 237                         // Paranoia: avoid brute force searches (T19342)
 238                         // (shouldn't be able to get here without 'deletedhistory', but
 239                         // check it again just in case)
 240                         if ( !$this->getPermissionManager()->userHasRight( $user, 'deletedhistory' ) ) {
 241                                 $bitmask = RevisionRecord::DELETED_USER;
 242                         } elseif ( !$this->getPermissionManager()
 243                                 ->userHasAnyRight( $user, 'suppressrevision', 'viewsuppressed' )
 244                         ) {
 245                                 $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
 246                         } else {
 247                                 $bitmask = 0;
 248                         }
 249                         if ( $bitmask ) {
 250                                 $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
 251                         }
 252                 }
 253
 254                 if ( !is_null( $params['continue'] ) ) {
 255                         $cont = explode( '|', $params['continue'] );
 256                         $op = ( $dir == 'newer' ? '>' : '<' );
 257                         if ( $optimizeGenerateTitles ) {
 258                                 $this->dieContinueUsageIf( count( $cont ) != 2 );
 259                                 $ns = (int)$cont[0];
 260                                 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
 261                                 $title = $db->addQuotes( $cont[1] );
 262                                 $this->addWhere( "ar_namespace $op $ns OR " .
 263                                         "(ar_namespace = $ns AND ar_title $op= $title)" );
 264                         } elseif ( $mode == 'all' ) {
 265                                 $this->dieContinueUsageIf( count( $cont ) != 4 );
 266                                 $ns = (int)$cont[0];
 267                                 $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
 268                                 $title = $db->addQuotes( $cont[1] );
 269                                 $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
 270                                 $ar_id = (int)$cont[3];
 271                                 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
 272                                 $this->addWhere( "ar_namespace $op $ns OR " .
 273                                         "(ar_namespace = $ns AND " .
 274                                         "(ar_title $op $title OR " .
 275                                         "(ar_title = $title AND " .
 276                                         "(ar_timestamp $op $ts OR " .
 277                                         "(ar_timestamp = $ts AND " .
 278                                         "ar_id $op= $ar_id)))))" );
 279                         } else {
 280                                 $this->dieContinueUsageIf( count( $cont ) != 2 );
 281                                 $ts = $db->addQuotes( $db->timestamp( $cont[0] ) );
 282                                 $ar_id = (int)$cont[1];
 283                                 $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
 284                                 $this->addWhere( "ar_timestamp $op $ts OR " .
 285                                         "(ar_timestamp = $ts AND " .
 286                                         "ar_id $op= $ar_id)" );
 287                         }
 288                 }
 289
 290                 $this->addOption( 'LIMIT', $this->limit + 1 );
 291
 292                 $sort = ( $dir == 'newer' ? '' : ' DESC' );
 293                 $orderby = [];
 294                 if ( $optimizeGenerateTitles ) {
 295                         // Targeting index name_title_timestamp
 296                         if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
 297                                 $orderby[] = "ar_namespace $sort";
 298                         }
 299                         $orderby[] = "ar_title $sort";
 300                 } elseif ( $mode == 'all' ) {
 301                         // Targeting index name_title_timestamp
 302                         if ( $params['namespace'] === null || count( array_unique( $params['namespace'] ) ) > 1 ) {
 303                                 $orderby[] = "ar_namespace $sort";
 304                         }
 305                         $orderby[] = "ar_title $sort";
 306                         $orderby[] = "ar_timestamp $sort";
 307                         $orderby[] = "ar_id $sort";
 308                 } else {
 309                         // Targeting index usertext_timestamp
 310                         // 'user' is always constant.
 311                         $orderby[] = "ar_timestamp $sort";
 312                         $orderby[] = "ar_id $sort";
 313                 }
 314                 $this->addOption( 'ORDER BY', $orderby );
 315
 316                 $res = $this->select( __METHOD__ );
 317                 $pageMap = []; // Maps ns&title to array index
 318                 $count = 0;
 319                 $nextIndex = 0;
 320                 $generated = [];
 321                 foreach ( $res as $row ) {
 322                         if ( ++$count > $this->limit ) {
 323                                 // We've had enough
 324                                 if ( $optimizeGenerateTitles ) {
 325                                         $this->setContinueEnumParameter( 'continue', "$row->ar_namespace|$row->ar_title" );
 326                                 } elseif ( $mode == 'all' ) {
 327                                         $this->setContinueEnumParameter( 'continue',
 328                                                 "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
 329                                         );
 330                                 } else {
 331                                         $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
 332                                 }
 333                                 break;
 334                         }
 335
 336                         // Miser mode namespace check
 337                         if ( $miser_ns !== null && !in_array( $row->ar_namespace, $miser_ns ) ) {
 338                                 continue;
 339                         }
 340
 341                         if ( $resultPageSet !== null ) {
 342                                 if ( $params['generatetitles'] ) {
 343                                         $key = "{$row->ar_namespace}:{$row->ar_title}";
 344                                         if ( !isset( $generated[$key] ) ) {
 345                                                 $generated[$key] = Title::makeTitle( $row->ar_namespace, $row->ar_title );
 346                                         }
 347                                 } else {
 348                                         $generated[] = $row->ar_rev_id;
 349                                 }
 350                         } else {
 351                                 $revision = $revisionStore->newRevisionFromArchiveRow( $row );
 352                                 $rev = $this->extractRevisionInfo( $revision, $row );
 353
 354                                 if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
 355                                         $index = $nextIndex++;
 356                                         $pageMap[$row->ar_namespace][$row->ar_title] = $index;
 357                                         $title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
 358                                         $a = [
 359                                                 'pageid' => $title->getArticleID(),
 360                                                 'revisions' => [ $rev ],
 361                                         ];
 362                                         ApiResult::setIndexedTagName( $a['revisions'], 'rev' );
 363                                         ApiQueryBase::addTitleInfo( $a, $title );
 364                                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], $index, $a );
 365                                 } else {
 366                                         $index = $pageMap[$row->ar_namespace][$row->ar_title];
 367                                         $fit = $result->addValue(
 368                                                 [ 'query', $this->getModuleName(), $index, 'revisions' ],
 369                                                 null, $rev );
 370                                 }
 371                                 if ( !$fit ) {
 372                                         if ( $mode == 'all' ) {
 373                                                 $this->setContinueEnumParameter( 'continue',
 374                                                         "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
 375                                                 );
 376                                         } else {
 377                                                 $this->setContinueEnumParameter( 'continue', "$row->ar_timestamp|$row->ar_id" );
 378                                         }
 379                                         break;
 380                                 }
 381                         }
 382                 }
 383
 384                 if ( $resultPageSet !== null ) {
 385                         if ( $params['generatetitles'] ) {
 386                                 $resultPageSet->populateFromTitles( $generated );
 387                         } else {
 388                                 $resultPageSet->populateFromRevisionIDs( $generated );
 389                         }
 390                 } else {
 391                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
 392                 }
 393         }
 394
 395         public function getAllowedParams() {
 396                 $ret = parent::getAllowedParams() + [
 397                         'user' => [
 398                                 ApiBase::PARAM_TYPE => 'user'
 399                         ],
 400                         'namespace' => [
 401                                 ApiBase::PARAM_ISMULTI => true,
 402                                 ApiBase::PARAM_TYPE => 'namespace',
 403                         ],
 404                         'start' => [
 405                                 ApiBase::PARAM_TYPE => 'timestamp',
 406                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
 407                         ],
 408                         'end' => [
 409                                 ApiBase::PARAM_TYPE => 'timestamp',
 410                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'useronly' ] ],
 411                         ],
 412                         'dir' => [
 413                                 ApiBase::PARAM_TYPE => [
 414                                         'newer',
 415                                         'older'
 416                                 ],
 417                                 ApiBase::PARAM_DFLT => 'older',
 418                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
 419                         ],
 420                         'from' => [
 421                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
 422                         ],
 423                         'to' => [
 424                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
 425                         ],
 426                         'prefix' => [
 427                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
 428                         ],
 429                         'excludeuser' => [
 430                                 ApiBase::PARAM_TYPE => 'user',
 431                                 ApiBase::PARAM_HELP_MSG_INFO => [ [ 'nonuseronly' ] ],
 432                         ],
 433                         'tag' => null,
 434                         'continue' => [
 435                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 436                         ],
 437                         'generatetitles' => [
 438                                 ApiBase::PARAM_DFLT => false
 439                         ],
 440                 ];
 441
 442                 if ( $this->getConfig()->get( 'MiserMode' ) ) {
 443                         $ret['user'][ApiBase::PARAM_HELP_MSG_APPEND] = [
 444                                 'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
 445                         ];
 446                         $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
 447                                 'apihelp-query+alldeletedrevisions-param-miser-user-namespace',
 448                         ];
 449                 }
 450
 451                 return $ret;
 452         }
 453
 454         protected function getExamplesMessages() {
 455                 return [
 456                         'action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50'
 457                                 => 'apihelp-query+alldeletedrevisions-example-user',
 458                         'action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50'
 459                                 => 'apihelp-query+alldeletedrevisions-example-ns-main',
 460                 ];
 461         }
 462
 463         public function getHelpUrls() {
 464                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Alldeletedrevisions';
 465         }
 466 }