MediaWiki  1.30.0
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 
111  $bitPars = $params['value'];
112  $comment = $params['comment'];
113  $perItemStatus = isset( $params['perItemStatus'] ) ? $params['perItemStatus'] : false;
114 
115  // CAS-style checks are done on the _deleted fields so the select
116  // does not need to use FOR UPDATE nor be in the atomic section
117  $dbw = wfGetDB( DB_MASTER );
118  $this->res = $this->doQuery( $dbw );
119 
120  $status->merge( $this->acquireItemLocks() );
121  if ( !$status->isGood() ) {
122  return $status;
123  }
124 
125  $dbw->startAtomic( __METHOD__ );
126  $dbw->onTransactionResolution(
127  function () {
128  // Release locks on commit or error
129  $this->releaseItemLocks();
130  },
131  __METHOD__
132  );
133 
134  $missing = array_flip( $this->ids );
135  $this->clearFileOps();
136  $idsForLog = [];
137  $authorIds = $authorIPs = [];
138 
139  if ( $perItemStatus ) {
140  $status->itemStatuses = [];
141  }
142 
143  // For multi-item deletions, set the old/new bitfields in log_params such that "hid X"
144  // shows in logs if field X was hidden from ANY item and likewise for "unhid Y". Note the
145  // form does not let the same field get hidden and unhidden in different items at once.
146  $virtualOldBits = 0;
147  $virtualNewBits = 0;
148  $logType = 'delete';
149 
150  // Will be filled with id => [old, new bits] information and
151  // passed to doPostCommitUpdates().
152  $visibilityChangeMap = [];
153 
155  foreach ( $this as $item ) {
156  unset( $missing[$item->getId()] );
157 
158  if ( $perItemStatus ) {
159  $itemStatus = Status::newGood();
160  $status->itemStatuses[$item->getId()] = $itemStatus;
161  } else {
162  $itemStatus = $status;
163  }
164 
165  $oldBits = $item->getBits();
166  // Build the actual new rev_deleted bitfield
167  $newBits = RevisionDeleter::extractBitfield( $bitPars, $oldBits );
168 
169  if ( $oldBits == $newBits ) {
170  $itemStatus->warning(
171  'revdelete-no-change', $item->formatDate(), $item->formatTime() );
172  $status->failCount++;
173  continue;
174  } elseif ( $oldBits == 0 && $newBits != 0 ) {
175  $opType = 'hide';
176  } elseif ( $oldBits != 0 && $newBits == 0 ) {
177  $opType = 'show';
178  } else {
179  $opType = 'modify';
180  }
181 
182  if ( $item->isHideCurrentOp( $newBits ) ) {
183  // Cannot hide current version text
184  $itemStatus->error(
185  'revdelete-hide-current', $item->formatDate(), $item->formatTime() );
186  $status->failCount++;
187  continue;
188  } elseif ( !$item->canView() ) {
189  // Cannot access this revision
190  $msg = ( $opType == 'show' ) ?
191  'revdelete-show-no-access' : 'revdelete-modify-no-access';
192  $itemStatus->error( $msg, $item->formatDate(), $item->formatTime() );
193  $status->failCount++;
194  continue;
195  // Cannot just "hide from Sysops" without hiding any fields
196  } elseif ( $newBits == Revision::DELETED_RESTRICTED ) {
197  $itemStatus->warning(
198  'revdelete-only-restricted', $item->formatDate(), $item->formatTime() );
199  $status->failCount++;
200  continue;
201  }
202 
203  // Update the revision
204  $ok = $item->setBits( $newBits );
205 
206  if ( $ok ) {
207  $idsForLog[] = $item->getId();
208  // If any item field was suppressed or unsupressed
209  if ( ( $oldBits | $newBits ) & $this->getSuppressBit() ) {
210  $logType = 'suppress';
211  }
212  // Track which fields where (un)hidden for each item
213  $addedBits = ( $oldBits ^ $newBits ) & $newBits;
214  $removedBits = ( $oldBits ^ $newBits ) & $oldBits;
215  $virtualNewBits |= $addedBits;
216  $virtualOldBits |= $removedBits;
217 
218  $status->successCount++;
219  if ( $item->getAuthorId() > 0 ) {
220  $authorIds[] = $item->getAuthorId();
221  } elseif ( IP::isIPAddress( $item->getAuthorName() ) ) {
222  $authorIPs[] = $item->getAuthorName();
223  }
224 
225  // Save the old and new bits in $visibilityChangeMap for
226  // later use.
227  $visibilityChangeMap[$item->getId()] = [
228  'oldBits' => $oldBits,
229  'newBits' => $newBits,
230  ];
231  } else {
232  $itemStatus->error(
233  'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() );
234  $status->failCount++;
235  }
236  }
237 
238  // Handle missing revisions
239  foreach ( $missing as $id => $unused ) {
240  if ( $perItemStatus ) {
241  $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id );
242  } else {
243  $status->error( 'revdelete-modify-missing', $id );
244  }
245  $status->failCount++;
246  }
247 
248  if ( $status->successCount == 0 ) {
249  $dbw->endAtomic( __METHOD__ );
250  return $status;
251  }
252 
253  // Save success count
254  $successCount = $status->successCount;
255 
256  // Move files, if there are any
257  $status->merge( $this->doPreCommitUpdates() );
258  if ( !$status->isOK() ) {
259  // Fatal error, such as no configured archive directory or I/O failures
260  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
261  $lbFactory->rollbackMasterChanges( __METHOD__ );
262  return $status;
263  }
264 
265  // Log it
266  $this->updateLog(
267  $logType,
268  [
269  'title' => $this->title,
270  'count' => $successCount,
271  'newBits' => $virtualNewBits,
272  'oldBits' => $virtualOldBits,
273  'comment' => $comment,
274  'ids' => $idsForLog,
275  'authorIds' => $authorIds,
276  'authorIPs' => $authorIPs,
277  'tags' => isset( $params['tags'] ) ? $params['tags'] : [],
278  ]
279  );
280 
281  // Clear caches after commit
283  function () use ( $visibilityChangeMap ) {
284  $this->doPostCommitUpdates( $visibilityChangeMap );
285  },
287  $dbw
288  );
289 
290  $dbw->endAtomic( __METHOD__ );
291 
292  return $status;
293  }
294 
295  final protected function acquireItemLocks() {
298  foreach ( $this as $item ) {
299  $status->merge( $item->lock() );
300  }
301 
302  return $status;
303  }
304 
305  final protected function releaseItemLocks() {
308  foreach ( $this as $item ) {
309  $status->merge( $item->unlock() );
310  }
311 
312  return $status;
313  }
314 
319  function reloadFromMaster() {
320  $dbw = wfGetDB( DB_MASTER );
321  $this->res = $this->doQuery( $dbw );
322  }
323 
338  private function updateLog( $logType, $params ) {
339  // Get the URL param's corresponding DB field
340  $field = RevisionDeleter::getRelationType( $this->getType() );
341  if ( !$field ) {
342  throw new MWException( "Bad log URL param type!" );
343  }
344  // Add params for affected page and ids
345  $logParams = $this->getLogParams( $params );
346  // Actually add the deletion log entry
347  $logEntry = new ManualLogEntry( $logType, $this->getLogAction() );
348  $logEntry->setTarget( $params['title'] );
349  $logEntry->setComment( $params['comment'] );
350  $logEntry->setParameters( $logParams );
351  $logEntry->setPerformer( $this->getUser() );
352  // Allow for easy searching of deletion log items for revision/log items
353  $logEntry->setRelations( [
354  $field => $params['ids'],
355  'target_author_id' => $params['authorIds'],
356  'target_author_ip' => $params['authorIPs'],
357  ] );
358  // Apply change tags to the log entry
359  $logEntry->setTags( $params['tags'] );
360  $logId = $logEntry->insert();
361  $logEntry->publish( $logId );
362  }
363 
368  public function getLogAction() {
369  return 'revision';
370  }
371 
377  public function getLogParams( $params ) {
378  return [
379  '4::type' => $this->getType(),
380  '5::ids' => $params['ids'],
381  '6::ofield' => $params['oldBits'],
382  '7::nfield' => $params['newBits'],
383  ];
384  }
385 
390  public function clearFileOps() {
391  }
392 
398  public function doPreCommitUpdates() {
399  return Status::newGood();
400  }
401 
408  public function doPostCommitUpdates( array $visibilityChangeMap ) {
409  return Status::newGood();
410  }
411 
415  abstract public function getSuppressBit();
416 }
RevDelList\getSuppressBit
getSuppressBit()
Get the integer value of the flag used for suppression.
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:34
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:93
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
RevDelList\clearFileOps
clearFileOps()
Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.
Definition: RevDelList.php:390
RevDelList\updateLog
updateLog( $logType, $params)
Record a log entry on the action.
Definition: RevDelList.php:338
$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). '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:1245
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
RevDelList\getLogParams
getLogParams( $params)
Get log parameter array.
Definition: RevDelList.php:377
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
RevDelList\reloadFromMaster
reloadFromMaster()
Reload the list data from the master DB.
Definition: RevDelList.php:319
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
RevDelList\doPreCommitUpdates
doPreCommitUpdates()
A hook for setVisibility(): do batch updates pre-commit.
Definition: RevDelList.php:398
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
RevDelList\releaseItemLocks
releaseItemLocks()
Definition: RevDelList.php:305
RevDelList\setVisibility
setVisibility(array $params)
Set the visibility for the revisions in this list.
Definition: RevDelList.php:108
title
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
Definition: All_system_messages.txt:2696
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, IDatabase $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:111
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:2856
RevDelList\getRevdelConstant
static getRevdelConstant()
Get the revision deletion constant for this list type Override this function.
Definition: RevDelList.php:62
RevisionListBase\$title
Title $title
Definition: RevisionList.php:32
RevDelList
Abstract base class for a list of deletable items.
Definition: RevDelList.php:30
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:368
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:55
RevDelList\acquireItemLocks
acquireItemLocks()
Definition: RevDelList.php:295
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:9
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:400
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
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:408
IP\isIPAddress
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
array
the array() calling protocol came about after MediaWiki 1.4rc1.