MediaWiki  REL1_31
RevDelList.php
Go to the documentation of this file.
1 <?php
23 
30 abstract class RevDelList extends RevisionListBase {
32  parent::__construct( $context, $title );
33  $this->ids = $ids;
34  }
35 
42  public static function getRelationType() {
43  return null;
44  }
45 
52  public static function getRestriction() {
53  return null;
54  }
55 
62  public static function getRevdelConstant() {
63  return null;
64  }
65 
74  public static function suggestTarget( $target, array $ids ) {
75  return $target;
76  }
77 
83  public function areAnySuppressed() {
84  $bit = $this->getSuppressBit();
85 
87  foreach ( $this as $item ) {
88  if ( $item->getBits() & $bit ) {
89  return true;
90  }
91  }
92 
93  return false;
94  }
95 
108  public function setVisibility( array $params ) {
110 
112 
113  $bitPars = $params['value'];
114  $comment = $params['comment'];
115  $perItemStatus = isset( $params['perItemStatus'] ) ? $params['perItemStatus'] : false;
116 
117  // CAS-style checks are done on the _deleted fields so the select
118  // does not need to use FOR UPDATE nor be in the atomic section
119  $dbw = wfGetDB( DB_MASTER );
120  $this->res = $this->doQuery( $dbw );
121 
122  $status->merge( $this->acquireItemLocks() );
123  if ( !$status->isGood() ) {
124  return $status;
125  }
126 
127  $dbw->startAtomic( __METHOD__ );
128  $dbw->onTransactionResolution(
129  function () {
130  // Release locks on commit or error
131  $this->releaseItemLocks();
132  },
133  __METHOD__
134  );
135 
136  $missing = array_flip( $this->ids );
137  $this->clearFileOps();
138  $idsForLog = [];
139  $authorIds = $authorIPs = $authorActors = [];
140 
141  if ( $perItemStatus ) {
142  $status->itemStatuses = [];
143  }
144 
145  // For multi-item deletions, set the old/new bitfields in log_params such that "hid X"
146  // shows in logs if field X was hidden from ANY item and likewise for "unhid Y". Note the
147  // form does not let the same field get hidden and unhidden in different items at once.
148  $virtualOldBits = 0;
149  $virtualNewBits = 0;
150  $logType = 'delete';
151 
152  // Will be filled with id => [old, new bits] information and
153  // passed to doPostCommitUpdates().
154  $visibilityChangeMap = [];
155 
157  foreach ( $this as $item ) {
158  unset( $missing[$item->getId()] );
159 
160  if ( $perItemStatus ) {
161  $itemStatus = Status::newGood();
162  $status->itemStatuses[$item->getId()] = $itemStatus;
163  } else {
164  $itemStatus = $status;
165  }
166 
167  $oldBits = $item->getBits();
168  // Build the actual new rev_deleted bitfield
169  $newBits = RevisionDeleter::extractBitfield( $bitPars, $oldBits );
170 
171  if ( $oldBits == $newBits ) {
172  $itemStatus->warning(
173  'revdelete-no-change', $item->formatDate(), $item->formatTime() );
174  $status->failCount++;
175  continue;
176  } elseif ( $oldBits == 0 && $newBits != 0 ) {
177  $opType = 'hide';
178  } elseif ( $oldBits != 0 && $newBits == 0 ) {
179  $opType = 'show';
180  } else {
181  $opType = 'modify';
182  }
183 
184  if ( $item->isHideCurrentOp( $newBits ) ) {
185  // Cannot hide current version text
186  $itemStatus->error(
187  'revdelete-hide-current', $item->formatDate(), $item->formatTime() );
188  $status->failCount++;
189  continue;
190  } elseif ( !$item->canView() ) {
191  // Cannot access this revision
192  $msg = ( $opType == 'show' ) ?
193  'revdelete-show-no-access' : 'revdelete-modify-no-access';
194  $itemStatus->error( $msg, $item->formatDate(), $item->formatTime() );
195  $status->failCount++;
196  continue;
197  // Cannot just "hide from Sysops" without hiding any fields
198  } elseif ( $newBits == Revision::DELETED_RESTRICTED ) {
199  $itemStatus->warning(
200  'revdelete-only-restricted', $item->formatDate(), $item->formatTime() );
201  $status->failCount++;
202  continue;
203  }
204 
205  // Update the revision
206  $ok = $item->setBits( $newBits );
207 
208  if ( $ok ) {
209  $idsForLog[] = $item->getId();
210  // If any item field was suppressed or unsupressed
211  if ( ( $oldBits | $newBits ) & $this->getSuppressBit() ) {
212  $logType = 'suppress';
213  }
214  // Track which fields where (un)hidden for each item
215  $addedBits = ( $oldBits ^ $newBits ) & $newBits;
216  $removedBits = ( $oldBits ^ $newBits ) & $oldBits;
217  $virtualNewBits |= $addedBits;
218  $virtualOldBits |= $removedBits;
219 
220  $status->successCount++;
222  if ( $item->getAuthorId() > 0 ) {
223  $authorIds[] = $item->getAuthorId();
224  } elseif ( IP::isIPAddress( $item->getAuthorName() ) ) {
225  $authorIPs[] = $item->getAuthorName();
226  }
227  }
229  $authorActors[] = $item->getAuthorActor();
230  }
231 
232  // Save the old and new bits in $visibilityChangeMap for
233  // later use.
234  $visibilityChangeMap[$item->getId()] = [
235  'oldBits' => $oldBits,
236  'newBits' => $newBits,
237  ];
238  } else {
239  $itemStatus->error(
240  'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() );
241  $status->failCount++;
242  }
243  }
244 
245  // Handle missing revisions
246  foreach ( $missing as $id => $unused ) {
247  if ( $perItemStatus ) {
248  $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id );
249  } else {
250  $status->error( 'revdelete-modify-missing', $id );
251  }
252  $status->failCount++;
253  }
254 
255  if ( $status->successCount == 0 ) {
256  $dbw->endAtomic( __METHOD__ );
257  return $status;
258  }
259 
260  // Save success count
261  $successCount = $status->successCount;
262 
263  // Move files, if there are any
264  $status->merge( $this->doPreCommitUpdates() );
265  if ( !$status->isOK() ) {
266  // Fatal error, such as no configured archive directory or I/O failures
267  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
268  $lbFactory->rollbackMasterChanges( __METHOD__ );
269  return $status;
270  }
271 
272  // Log it
273  $authorFields = [];
275  $authorFields['authorIds'] = $authorIds;
276  $authorFields['authorIPs'] = $authorIPs;
277  }
279  $authorFields['authorActors'] = $authorActors;
280  }
281  $this->updateLog(
282  $logType,
283  [
284  'title' => $this->title,
285  'count' => $successCount,
286  'newBits' => $virtualNewBits,
287  'oldBits' => $virtualOldBits,
288  'comment' => $comment,
289  'ids' => $idsForLog,
290  'tags' => isset( $params['tags'] ) ? $params['tags'] : [],
291  ] + $authorFields
292  );
293 
294  // Clear caches after commit
296  function () use ( $visibilityChangeMap ) {
297  $this->doPostCommitUpdates( $visibilityChangeMap );
298  },
300  $dbw
301  );
302 
303  $dbw->endAtomic( __METHOD__ );
304 
305  return $status;
306  }
307 
308  final protected function acquireItemLocks() {
311  foreach ( $this as $item ) {
312  $status->merge( $item->lock() );
313  }
314 
315  return $status;
316  }
317 
318  final protected function releaseItemLocks() {
321  foreach ( $this as $item ) {
322  $status->merge( $item->unlock() );
323  }
324 
325  return $status;
326  }
327 
332  function reloadFromMaster() {
333  $dbw = wfGetDB( DB_MASTER );
334  $this->res = $this->doQuery( $dbw );
335  }
336 
352  private function updateLog( $logType, $params ) {
353  // Get the URL param's corresponding DB field
354  $field = RevisionDeleter::getRelationType( $this->getType() );
355  if ( !$field ) {
356  throw new MWException( "Bad log URL param type!" );
357  }
358  // Add params for affected page and ids
359  $logParams = $this->getLogParams( $params );
360  // Actually add the deletion log entry
361  $logEntry = new ManualLogEntry( $logType, $this->getLogAction() );
362  $logEntry->setTarget( $params['title'] );
363  $logEntry->setComment( $params['comment'] );
364  $logEntry->setParameters( $logParams );
365  $logEntry->setPerformer( $this->getUser() );
366  // Allow for easy searching of deletion log items for revision/log items
367  $relations = [
368  $field => $params['ids'],
369  ];
370  if ( isset( $params['authorIds'] ) ) {
371  $relations += [
372  'target_author_id' => $params['authorIds'],
373  'target_author_ip' => $params['authorIPs'],
374  ];
375  }
376  if ( isset( $params['authorActors'] ) ) {
377  $relations += [
378  'target_author_actor' => $params['authorActors'],
379  ];
380  }
381  $logEntry->setRelations( $relations );
382  // Apply change tags to the log entry
383  $logEntry->setTags( $params['tags'] );
384  $logId = $logEntry->insert();
385  $logEntry->publish( $logId );
386  }
387 
392  public function getLogAction() {
393  return 'revision';
394  }
395 
401  public function getLogParams( $params ) {
402  return [
403  '4::type' => $this->getType(),
404  '5::ids' => $params['ids'],
405  '6::ofield' => $params['oldBits'],
406  '7::nfield' => $params['newBits'],
407  ];
408  }
409 
414  public function clearFileOps() {
415  }
416 
422  public function doPreCommitUpdates() {
423  return Status::newGood();
424  }
425 
432  public function doPostCommitUpdates( array $visibilityChangeMap ) {
433  return Status::newGood();
434  }
435 
439  abstract public function getSuppressBit();
440 }
RevDelList\getSuppressBit
getSuppressBit()
Get the integer value of the flag used for suppression.
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:50
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
RevDelList\__construct
__construct(IContextSource $context, Title $title, array $ids)
Definition: RevDelList.php:31
RevisionListBase
List for revision table items for a single page.
Definition: RevisionList.php:30
array
the array() calling protocol came about after MediaWiki 1.4rc1.
RevDelList\clearFileOps
clearFileOps()
Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.
Definition: RevDelList.php:414
RevDelList\updateLog
updateLog( $logType, $params)
Record a log entry on the action.
Definition: RevDelList.php:352
RevDelList\getLogParams
getLogParams( $params)
Get log parameter array.
Definition: RevDelList.php:401
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
MIGRATION_WRITE_BOTH
const MIGRATION_WRITE_BOTH
Definition: Defines.php:303
RevDelList\reloadFromMaster
reloadFromMaster()
Reload the list data from the master DB.
Definition: RevDelList.php:332
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
RevDelList\doPreCommitUpdates
doPreCommitUpdates()
A hook for setVisibility(): do batch updates pre-commit.
Definition: RevDelList.php:422
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:37
RevDelList\releaseItemLocks
releaseItemLocks()
Definition: RevDelList.php:318
RevDelList\setVisibility
setVisibility(array $params)
Set the visibility for the revisions in this list.
Definition: RevDelList.php:108
MWException
MediaWiki exception.
Definition: MWException.php:26
RevisionListBase\doQuery
doQuery( $db)
Do the DB query to iterate through the objects.
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
RevDelList\getRevdelConstant
static getRevdelConstant()
Get the revision deletion constant for this list type Override this function.
Definition: RevDelList.php:62
title
title
Definition: parserTests.txt:219
RevisionListBase\$title
Title $title
Definition: RevisionList.php:32
RevDelList
Abstract base class for a list of deletable items.
Definition: RevDelList.php:30
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
RevDelList\areAnySuppressed
areAnySuppressed()
Indicate whether any item in this list is suppressed.
Definition: RevDelList.php:83
RevDelList\getRelationType
static getRelationType()
Get the DB field name associated with the ID list.
Definition: RevDelList.php:42
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
RevisionListBase\$ids
array $ids
Definition: RevisionList.php:35
RevDelList\getLogAction
getLogAction()
Get the log action for this list type.
Definition: RevDelList.php:392
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
RevDelList\getRestriction
static getRestriction()
Get the user right required for this list type Override this function.
Definition: RevDelList.php:52
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
RevDelList\acquireItemLocks
acquireItemLocks()
Definition: RevDelList.php:308
Title
Represents a title within MediaWiki.
Definition: Title.php:39
RevDelList\suggestTarget
static suggestTarget( $target, array $ids)
Suggest a target for the revision deletion Optionally override this function.
Definition: RevDelList.php:74
DeferredUpdates\PRESEND
const PRESEND
Definition: DeferredUpdates.php:60
RevisionDeleter\getRelationType
static getRelationType( $typeName)
Get DB field name for URL param...
Definition: RevisionDeleter.php:154
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:22
RevisionListBase\getType
getType()
Get the internal type name of this list.
Definition: RevisionList.php:66
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:432
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:25
RevisionDeleter\extractBitfield
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
Definition: RevisionDeleter.php:239
RevDelList\doPostCommitUpdates
doPostCommitUpdates(array $visibilityChangeMap)
A hook for setVisibility(): do any necessary updates post-commit.
Definition: RevDelList.php:432
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:111
IP\isIPAddress
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8878