MediaWiki REL1_33
RevDelList.php
Go to the documentation of this file.
1<?php
23
30abstract 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 $status = Status::newGood();
112
113 $bitPars = $params['value'];
114 $comment = $params['comment'];
115 $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 unsuppressed
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 }
228 $actorId = $item->getAuthorActor();
229 // During migration, the actor field might be empty. If so, populate
230 // it here.
231 if ( !$actorId ) {
232 if ( $item->getAuthorId() > 0 ) {
233 $user = User::newFromId( $item->getAuthorId() );
234 } else {
235 $user = User::newFromName( $item->getAuthorName(), false );
236 }
237 $actorId = $user->getActorId( $dbw );
238 }
239 $authorActors[] = $actorId;
240 }
242 $authorActors[] = $item->getAuthorActor();
243 }
244
245 // Save the old and new bits in $visibilityChangeMap for
246 // later use.
247 $visibilityChangeMap[$item->getId()] = [
248 'oldBits' => $oldBits,
249 'newBits' => $newBits,
250 ];
251 } else {
252 $itemStatus->error(
253 'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() );
254 $status->failCount++;
255 }
256 }
257
258 // Handle missing revisions
259 foreach ( $missing as $id => $unused ) {
260 if ( $perItemStatus ) {
261 $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id );
262 } else {
263 $status->error( 'revdelete-modify-missing', $id );
264 }
265 $status->failCount++;
266 }
267
268 if ( $status->successCount == 0 ) {
269 $dbw->endAtomic( __METHOD__ );
270 return $status;
271 }
272
273 // Save success count
274 $successCount = $status->successCount;
275
276 // Move files, if there are any
277 $status->merge( $this->doPreCommitUpdates() );
278 if ( !$status->isOK() ) {
279 // Fatal error, such as no configured archive directory or I/O failures
280 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
281 $lbFactory->rollbackMasterChanges( __METHOD__ );
282 return $status;
283 }
284
285 // Log it
286 $authorFields = [];
288 $authorFields['authorIds'] = $authorIds;
289 $authorFields['authorIPs'] = $authorIPs;
290 }
292 $authorFields['authorActors'] = $authorActors;
293 }
294 $this->updateLog(
295 $logType,
296 [
297 'title' => $this->title,
298 'count' => $successCount,
299 'newBits' => $virtualNewBits,
300 'oldBits' => $virtualOldBits,
301 'comment' => $comment,
302 'ids' => $idsForLog,
303 'tags' => $params['tags'] ?? [],
304 ] + $authorFields
305 );
306
307 // Clear caches after commit
308 DeferredUpdates::addCallableUpdate(
309 function () use ( $visibilityChangeMap ) {
310 $this->doPostCommitUpdates( $visibilityChangeMap );
311 },
312 DeferredUpdates::PRESEND,
313 $dbw
314 );
315
316 $dbw->endAtomic( __METHOD__ );
317
318 return $status;
319 }
320
321 final protected function acquireItemLocks() {
322 $status = Status::newGood();
324 foreach ( $this as $item ) {
325 $status->merge( $item->lock() );
326 }
327
328 return $status;
329 }
330
331 final protected function releaseItemLocks() {
332 $status = Status::newGood();
334 foreach ( $this as $item ) {
335 $status->merge( $item->unlock() );
336 }
337
338 return $status;
339 }
340
345 function reloadFromMaster() {
346 $dbw = wfGetDB( DB_MASTER );
347 $this->res = $this->doQuery( $dbw );
348 }
349
365 private function updateLog( $logType, $params ) {
366 // Get the URL param's corresponding DB field
367 $field = RevisionDeleter::getRelationType( $this->getType() );
368 if ( !$field ) {
369 throw new MWException( "Bad log URL param type!" );
370 }
371 // Add params for affected page and ids
372 $logParams = $this->getLogParams( $params );
373 // Actually add the deletion log entry
374 $logEntry = new ManualLogEntry( $logType, $this->getLogAction() );
375 $logEntry->setTarget( $params['title'] );
376 $logEntry->setComment( $params['comment'] );
377 $logEntry->setParameters( $logParams );
378 $logEntry->setPerformer( $this->getUser() );
379 // Allow for easy searching of deletion log items for revision/log items
380 $relations = [
381 $field => $params['ids'],
382 ];
383 if ( isset( $params['authorIds'] ) ) {
384 $relations += [
385 'target_author_id' => $params['authorIds'],
386 'target_author_ip' => $params['authorIPs'],
387 ];
388 }
389 if ( isset( $params['authorActors'] ) ) {
390 $relations += [
391 'target_author_actor' => $params['authorActors'],
392 ];
393 }
394 $logEntry->setRelations( $relations );
395 // Apply change tags to the log entry
396 $logEntry->setTags( $params['tags'] );
397 $logId = $logEntry->insert();
398 $logEntry->publish( $logId );
399 }
400
405 public function getLogAction() {
406 return 'revision';
407 }
408
414 public function getLogParams( $params ) {
415 return [
416 '4::type' => $this->getType(),
417 '5::ids' => $params['ids'],
418 '6::ofield' => $params['oldBits'],
419 '7::nfield' => $params['newBits'],
420 ];
421 }
422
427 public function clearFileOps() {
428 }
429
435 public function doPreCommitUpdates() {
436 return Status::newGood();
437 }
438
445 public function doPostCommitUpdates( array $visibilityChangeMap ) {
446 return Status::newGood();
447 }
448
452 abstract public function getSuppressBit();
453}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
IContextSource $context
MediaWiki exception.
Class for creating new log entries and inserting them into the database.
Definition LogEntry.php:441
MediaWikiServices is the service locator for the application scope of MediaWiki.
Abstract base class for a list of deletable items.
setVisibility(array $params)
Set the visibility for the revisions in this list.
areAnySuppressed()
Indicate whether any item in this list is suppressed.
static suggestTarget( $target, array $ids)
Suggest a target for the revision deletion Optionally override this function.
doPreCommitUpdates()
A hook for setVisibility(): do batch updates pre-commit.
__construct(IContextSource $context, Title $title, array $ids)
static getRestriction()
Get the user right required for this list type Override this function.
getLogAction()
Get the log action for this list type.
clearFileOps()
Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() STUB.
static getRelationType()
Get the DB field name associated with the ID list.
doPostCommitUpdates(array $visibilityChangeMap)
A hook for setVisibility(): do any necessary updates post-commit.
getSuppressBit()
Get the integer value of the flag used for suppression.
getLogParams( $params)
Get log parameter array.
static getRevdelConstant()
Get the revision deletion constant for this list type Override this function.
updateLog( $logType, $params)
Record a log entry on the action.
reloadFromMaster()
Reload the list data from the master DB.
static getRelationType( $typeName)
Get DB field name for URL param... Future code for other things may also track other types of revisio...
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
List for revision table items for a single page.
getType()
Get the internal type name of this list.
doQuery( $db)
Do the DB query to iterate through the objects.
const DELETED_RESTRICTED
Definition Revision.php:49
Represents a title within MediaWiki.
Definition Title.php:40
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:585
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition User.php:609
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
const SCHEMA_COMPAT_WRITE_OLD
Definition Defines.php:293
const SCHEMA_COMPAT_WRITE_NEW
Definition Defines.php:295
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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:1266
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
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
Interface for objects which can provide a MediaWiki context on request.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
title
const DB_MASTER
Definition defines.php:26
$params