MediaWiki  1.33.0
ApiQueryDeletedRevisions.php
Go to the documentation of this file.
1 <?php
29 
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  parent::__construct( $query, $moduleName, 'drv' );
39  }
40 
41  protected function run( ApiPageSet $resultPageSet = null ) {
42  $user = $this->getUser();
43  // Before doing anything at all, let's check permissions
44  $this->checkUserRightsAny( 'deletedhistory' );
45 
46  $pageSet = $this->getPageSet();
47  $pageMap = $pageSet->getGoodAndMissingTitlesByNamespace();
48  $pageCount = count( $pageSet->getGoodAndMissingTitles() );
49  $revCount = $pageSet->getRevisionCount();
50  if ( $revCount === 0 && $pageCount === 0 ) {
51  // Nothing to do
52  return;
53  }
54  if ( $revCount !== 0 && count( $pageSet->getDeletedRevisionIDs() ) === 0 ) {
55  // Nothing to do, revisions were supplied but none are deleted
56  return;
57  }
58 
59  $params = $this->extractRequestParams( false );
60 
61  $db = $this->getDB();
62  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
63 
64  $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
65 
66  if ( $resultPageSet === null ) {
67  $this->parseParameters( $params );
68  $arQuery = $revisionStore->getArchiveQueryInfo();
69  $this->addTables( $arQuery['tables'] );
70  $this->addFields( $arQuery['fields'] );
71  $this->addJoinConds( $arQuery['joins'] );
72  $this->addFields( [ 'ar_title', 'ar_namespace' ] );
73  } else {
74  $this->limit = $this->getParameter( 'limit' ) ?: 10;
75  $this->addTables( 'archive' );
76  $this->addFields( [ 'ar_title', 'ar_namespace', 'ar_timestamp', 'ar_rev_id', 'ar_id' ] );
77  }
78 
79  if ( $this->fld_tags ) {
80  $this->addFields( [ 'ts_tags' => ChangeTags::makeTagSummarySubquery( 'archive' ) ] );
81  }
82 
83  if ( !is_null( $params['tag'] ) ) {
84  $this->addTables( 'change_tag' );
85  $this->addJoinConds(
86  [ 'change_tag' => [ 'JOIN', [ 'ar_rev_id=ct_rev_id' ] ] ]
87  );
88  $changeTagDefStore = MediaWikiServices::getInstance()->getChangeTagDefStore();
89  try {
90  $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
91  } catch ( NameTableAccessException $exception ) {
92  // Return nothing.
93  $this->addWhere( '1=0' );
94  }
95  }
96 
97  if ( $this->fetchContent ) {
98  $this->addTables( 'text' );
99  $this->addJoinConds(
100  [ 'text' => [ 'LEFT JOIN', [ 'ar_text_id=old_id' ] ] ]
101  );
102  $this->addFields( [ 'old_text', 'old_flags' ] );
103 
104  // This also means stricter restrictions
105  $this->checkUserRightsAny( [ 'deletedtext', 'undelete' ] );
106  }
107 
108  $dir = $params['dir'];
109 
110  if ( $revCount !== 0 ) {
111  $this->addWhere( [
112  'ar_rev_id' => array_keys( $pageSet->getDeletedRevisionIDs() )
113  ] );
114  } else {
115  // We need a custom WHERE clause that matches all titles.
116  $lb = new LinkBatch( $pageSet->getGoodAndMissingTitles() );
117  $where = $lb->constructSet( 'ar', $db );
118  $this->addWhere( $where );
119  }
120 
121  if ( !is_null( $params['user'] ) ) {
122  // Don't query by user ID here, it might be able to use the ar_usertext_timestamp index.
123  $actorQuery = ActorMigration::newMigration()
124  ->getWhere( $db, 'ar_user', User::newFromName( $params['user'], false ), false );
125  $this->addTables( $actorQuery['tables'] );
126  $this->addJoinConds( $actorQuery['joins'] );
127  $this->addWhere( $actorQuery['conds'] );
128  } elseif ( !is_null( $params['excludeuser'] ) ) {
129  // Here there's no chance of using ar_usertext_timestamp.
130  $actorQuery = ActorMigration::newMigration()
131  ->getWhere( $db, 'ar_user', User::newFromName( $params['excludeuser'], false ) );
132  $this->addTables( $actorQuery['tables'] );
133  $this->addJoinConds( $actorQuery['joins'] );
134  $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
135  }
136 
137  if ( !is_null( $params['user'] ) || !is_null( $params['excludeuser'] ) ) {
138  // Paranoia: avoid brute force searches (T19342)
139  // (shouldn't be able to get here without 'deletedhistory', but
140  // check it again just in case)
141  if ( !$user->isAllowed( 'deletedhistory' ) ) {
142  $bitmask = RevisionRecord::DELETED_USER;
143  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
144  $bitmask = RevisionRecord::DELETED_USER | RevisionRecord::DELETED_RESTRICTED;
145  } else {
146  $bitmask = 0;
147  }
148  if ( $bitmask ) {
149  $this->addWhere( $db->bitAnd( 'ar_deleted', $bitmask ) . " != $bitmask" );
150  }
151  }
152 
153  if ( !is_null( $params['continue'] ) ) {
154  $cont = explode( '|', $params['continue'] );
155  $op = ( $dir == 'newer' ? '>' : '<' );
156  if ( $revCount !== 0 ) {
157  $this->dieContinueUsageIf( count( $cont ) != 2 );
158  $rev = (int)$cont[0];
159  $this->dieContinueUsageIf( strval( $rev ) !== $cont[0] );
160  $ar_id = (int)$cont[1];
161  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[1] );
162  $this->addWhere( "ar_rev_id $op $rev OR " .
163  "(ar_rev_id = $rev AND " .
164  "ar_id $op= $ar_id)" );
165  } else {
166  $this->dieContinueUsageIf( count( $cont ) != 4 );
167  $ns = (int)$cont[0];
168  $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
169  $title = $db->addQuotes( $cont[1] );
170  $ts = $db->addQuotes( $db->timestamp( $cont[2] ) );
171  $ar_id = (int)$cont[3];
172  $this->dieContinueUsageIf( strval( $ar_id ) !== $cont[3] );
173  $this->addWhere( "ar_namespace $op $ns OR " .
174  "(ar_namespace = $ns AND " .
175  "(ar_title $op $title OR " .
176  "(ar_title = $title AND " .
177  "(ar_timestamp $op $ts OR " .
178  "(ar_timestamp = $ts AND " .
179  "ar_id $op= $ar_id)))))" );
180  }
181  }
182 
183  $this->addOption( 'LIMIT', $this->limit + 1 );
184 
185  if ( $revCount !== 0 ) {
186  // Sort by ar_rev_id when querying by ar_rev_id
187  $this->addWhereRange( 'ar_rev_id', $dir, null, null );
188  } else {
189  // Sort by ns and title in the same order as timestamp for efficiency
190  // But only when not already unique in the query
191  if ( count( $pageMap ) > 1 ) {
192  $this->addWhereRange( 'ar_namespace', $dir, null, null );
193  }
194  $oneTitle = key( reset( $pageMap ) );
195  foreach ( $pageMap as $pages ) {
196  if ( count( $pages ) > 1 || key( $pages ) !== $oneTitle ) {
197  $this->addWhereRange( 'ar_title', $dir, null, null );
198  break;
199  }
200  }
201  $this->addTimestampWhereRange( 'ar_timestamp', $dir, $params['start'], $params['end'] );
202  }
203  // Include in ORDER BY for uniqueness
204  $this->addWhereRange( 'ar_id', $dir, null, null );
205 
206  $res = $this->select( __METHOD__ );
207  $count = 0;
208  $generated = [];
209  foreach ( $res as $row ) {
210  if ( ++$count > $this->limit ) {
211  // We've had enough
212  $this->setContinueEnumParameter( 'continue',
213  $revCount
214  ? "$row->ar_rev_id|$row->ar_id"
215  : "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
216  );
217  break;
218  }
219 
220  if ( $resultPageSet !== null ) {
221  $generated[] = $row->ar_rev_id;
222  } else {
223  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
224  // Was it converted?
225  $title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
226  $converted = $pageSet->getConvertedTitles();
227  if ( $title && isset( $converted[$title->getPrefixedText()] ) ) {
228  $title = Title::newFromText( $converted[$title->getPrefixedText()] );
229  if ( $title && isset( $pageMap[$title->getNamespace()][$title->getDBkey()] ) ) {
230  $pageMap[$row->ar_namespace][$row->ar_title] =
231  $pageMap[$title->getNamespace()][$title->getDBkey()];
232  }
233  }
234  }
235  if ( !isset( $pageMap[$row->ar_namespace][$row->ar_title] ) ) {
237  __METHOD__,
238  "Found row in archive (ar_id={$row->ar_id}) that didn't get processed by ApiPageSet"
239  );
240  }
241 
242  $fit = $this->addPageSubItem(
243  $pageMap[$row->ar_namespace][$row->ar_title],
244  $this->extractRevisionInfo( $revisionStore->newRevisionFromArchiveRow( $row ), $row ),
245  'rev'
246  );
247  if ( !$fit ) {
248  $this->setContinueEnumParameter( 'continue',
249  $revCount
250  ? "$row->ar_rev_id|$row->ar_id"
251  : "$row->ar_namespace|$row->ar_title|$row->ar_timestamp|$row->ar_id"
252  );
253  break;
254  }
255  }
256  }
257 
258  if ( $resultPageSet !== null ) {
259  $resultPageSet->populateFromRevisionIDs( $generated );
260  }
261  }
262 
263  public function getAllowedParams() {
264  return parent::getAllowedParams() + [
265  'start' => [
266  ApiBase::PARAM_TYPE => 'timestamp',
267  ],
268  'end' => [
269  ApiBase::PARAM_TYPE => 'timestamp',
270  ],
271  'dir' => [
273  'newer',
274  'older'
275  ],
276  ApiBase::PARAM_DFLT => 'older',
277  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
278  ],
279  'tag' => null,
280  'user' => [
281  ApiBase::PARAM_TYPE => 'user'
282  ],
283  'excludeuser' => [
284  ApiBase::PARAM_TYPE => 'user'
285  ],
286  'continue' => [
287  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
288  ],
289  ];
290  }
291 
292  protected function getExamplesMessages() {
293  return [
294  'action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&' .
295  'drvslots=*&drvprop=user|comment|content'
296  => 'apihelp-query+deletedrevisions-example-titles',
297  'action=query&prop=deletedrevisions&revids=123456'
298  => 'apihelp-query+deletedrevisions-example-revids',
299  ];
300  }
301 
302  public function getHelpUrls() {
303  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Deletedrevisions';
304  }
305 }
ApiQueryDeletedRevisions\run
run(ApiPageSet $resultPageSet=null)
Definition: ApiQueryDeletedRevisions.php:41
ApiQueryRevisionsBase\parseParameters
parseParameters( $params)
Parse the parameters into the various instance fields.
Definition: ApiQueryRevisionsBase.php:77
ChangeTags\makeTagSummarySubquery
static makeTagSummarySubquery( $tables)
Make the tag summary subquery based on the given tables and return it.
Definition: ChangeTags.php:793
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:190
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
Revision\RevisionRecord
Page revision base class.
Definition: RevisionRecord.php:45
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
ApiQueryDeletedRevisions
Query module to enumerate deleted revisions for pages.
Definition: ApiQueryDeletedRevisions.php:35
captcha-old.count
count
Definition: captcha-old.py:249
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:335
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\checkUserRightsAny
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2105
$params
$params
Definition: styleTest.css.php:44
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
$res
$res
Definition: database.txt:21
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:347
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:111
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
ApiQueryRevisionsBase
A base class for functions common to producing a list of revisions.
Definition: ApiQueryRevisionsBase.php:34
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1588
ApiQueryDeletedRevisions\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryDeletedRevisions.php:292
ApiQueryGeneratorBase\getPageSet
getPageSet()
Get the PageSet object to work on.
Definition: ApiQueryGeneratorBase.php:58
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:105
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:158
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:372
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:743
ApiQueryDeletedRevisions\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryDeletedRevisions.php:302
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:576
ApiQueryBase\$where
$where
Definition: ApiQueryBase.php:35
ApiQueryBase\addWhereRange
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
Definition: ApiQueryBase.php:300
key
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
Definition: hooks.txt:2154
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:2176
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:179
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:258
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:913
ApiQueryDeletedRevisions\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryDeletedRevisions.php:263
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
$rev
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1769
ApiBase\getParameter
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:858
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
MediaWiki\Storage\NameTableAccessException
Exception representing a failure to look up a row from a name table.
Definition: NameTableAccessException.php:32
ApiQueryDeletedRevisions\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryDeletedRevisions.php:37
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:225
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
ApiQueryBase\addPageSubItem
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Definition: ApiQueryBase.php:538
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2188