MediaWiki  REL1_31
RevisionDeleter.php
Go to the documentation of this file.
1 <?php
31  private static $allowedTypes = [
32  'revision' => RevDelRevisionList::class,
33  'archive' => RevDelArchiveList::class,
34  'oldimage' => RevDelFileList::class,
35  'filearchive' => RevDelArchivedFileList::class,
36  'logging' => RevDelLogList::class,
37  ];
38 
40  private static $deprecatedTypeMap = [
41  'oldid' => 'revision',
42  'artimestamp' => 'archive',
43  'oldimage' => 'oldimage',
44  'fileid' => 'filearchive',
45  'logid' => 'logging',
46  ];
47 
54  public static function getTypes() {
55  return array_keys( self::$allowedTypes );
56  }
57 
65  public static function getCanonicalTypeName( $typeName ) {
66  if ( isset( self::$deprecatedTypeMap[$typeName] ) ) {
67  $typeName = self::$deprecatedTypeMap[$typeName];
68  }
69  return isset( self::$allowedTypes[$typeName] ) ? $typeName : null;
70  }
71 
83  public static function createList( $typeName, IContextSource $context, Title $title, array $ids ) {
84  $typeName = self::getCanonicalTypeName( $typeName );
85  if ( !$typeName ) {
86  throw new MWException( __METHOD__ . ": Unknown RevDel type '$typeName'" );
87  }
88  $class = self::$allowedTypes[$typeName];
89  return new $class( $context, $title, $ids );
90  }
91 
103  protected static function checkItem( $desc, $field, $diff, $new, &$arr ) {
104  if ( $diff & $field ) {
105  $arr[( $new & $field ) ? 0 : 1][] = $desc;
106  }
107  }
108 
127  public static function getChanges( $n, $o ) {
128  $diff = $n ^ $o;
129  $ret = [ 0 => [], 1 => [], 2 => [] ];
130  // Build bitfield changes in language
131  self::checkItem( 'revdelete-content',
132  Revision::DELETED_TEXT, $diff, $n, $ret );
133  self::checkItem( 'revdelete-summary',
134  Revision::DELETED_COMMENT, $diff, $n, $ret );
135  self::checkItem( 'revdelete-uname',
136  Revision::DELETED_USER, $diff, $n, $ret );
137  // Restriction application to sysops
138  if ( $diff & Revision::DELETED_RESTRICTED ) {
139  if ( $n & Revision::DELETED_RESTRICTED ) {
140  $ret[2][] = 'revdelete-restricted';
141  } else {
142  $ret[2][] = 'revdelete-unrestricted';
143  }
144  }
145  return $ret;
146  }
147 
154  public static function getRelationType( $typeName ) {
155  $typeName = self::getCanonicalTypeName( $typeName );
156  if ( !$typeName ) {
157  return null;
158  }
159  return call_user_func( [ self::$allowedTypes[$typeName], 'getRelationType' ] );
160  }
161 
168  public static function getRestriction( $typeName ) {
169  $typeName = self::getCanonicalTypeName( $typeName );
170  if ( !$typeName ) {
171  return null;
172  }
173  return call_user_func( [ self::$allowedTypes[$typeName], 'getRestriction' ] );
174  }
175 
182  public static function getRevdelConstant( $typeName ) {
183  $typeName = self::getCanonicalTypeName( $typeName );
184  if ( !$typeName ) {
185  return null;
186  }
187  return call_user_func( [ self::$allowedTypes[$typeName], 'getRevdelConstant' ] );
188  }
189 
198  public static function suggestTarget( $typeName, $target, array $ids ) {
199  $typeName = self::getCanonicalTypeName( $typeName );
200  if ( !$typeName ) {
201  return $target;
202  }
203  return call_user_func( [ self::$allowedTypes[$typeName], 'suggestTarget' ], $target, $ids );
204  }
205 
215  public static function checkRevisionExistence( $title, $revid ) {
216  $dbr = wfGetDB( DB_REPLICA );
217  $exists = $dbr->selectField( 'revision', '1',
218  [ 'rev_id' => $revid ], __METHOD__ );
219 
220  if ( $exists ) {
221  return true;
222  }
223 
224  $timestamp = $dbr->selectField( 'archive', 'ar_timestamp',
225  [ 'ar_namespace' => $title->getNamespace(),
226  'ar_title' => $title->getDBkey(),
227  'ar_rev_id' => $revid ], __METHOD__ );
228 
229  return $timestamp;
230  }
231 
239  public static function extractBitfield( array $bitPars, $oldfield ) {
240  // Build the actual new rev_deleted bitfield
241  $newBits = 0;
242  foreach ( $bitPars as $const => $val ) {
243  if ( $val == 1 ) {
244  $newBits |= $const; // $const is the *_deleted const
245  } elseif ( $val == -1 ) {
246  $newBits |= ( $oldfield & $const ); // use existing
247  }
248  }
249  return $newBits;
250  }
251 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:49
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:50
Revision\DELETED_COMMENT
const DELETED_COMMENT
Definition: Revision.php:48
array
the array() calling protocol came about after MediaWiki 1.4rc1.
RevisionDeleter
General controller for RevDel, used by both SpecialRevisiondelete and ApiRevisionDelete.
Definition: RevisionDeleter.php:29
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:2005
RevisionDeleter\$allowedTypes
static $allowedTypes
List of known revdel types, with their corresponding list classes.
Definition: RevisionDeleter.php:31
RevisionDeleter\checkRevisionExistence
static checkRevisionExistence( $title, $revid)
Checks if a revision still exists in the revision table.
Definition: RevisionDeleter.php:215
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
$dbr
$dbr
Definition: testCompression.php:50
MWException
MediaWiki exception.
Definition: MWException.php:26
RevisionDeleter\getTypes
static getTypes()
Lists the valid possible types for revision deletion.
Definition: RevisionDeleter.php:54
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
RevisionDeleter\$deprecatedTypeMap
static $deprecatedTypeMap
Type map to support old log entries.
Definition: RevisionDeleter.php:40
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
RevisionDeleter\createList
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
Definition: RevisionDeleter.php:83
RevisionDeleter\checkItem
static checkItem( $desc, $field, $diff, $new, &$arr)
Checks for a change in the bitfield for a certain option and updates the provided array accordingly.
Definition: RevisionDeleter.php:103
RevisionDeleter\getRevdelConstant
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
Definition: RevisionDeleter.php:182
RevisionDeleter\getChanges
static getChanges( $n, $o)
Gets an array of message keys describing the changes made to the visibility of the revision.
Definition: RevisionDeleter.php:127
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
Title
Represents a title within MediaWiki.
Definition: Title.php:39
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
RevisionDeleter\getCanonicalTypeName
static getCanonicalTypeName( $typeName)
Gets the canonical type name, if any.
Definition: RevisionDeleter.php:65
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
RevisionDeleter\extractBitfield
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
Definition: RevisionDeleter.php:239
RevisionDeleter\suggestTarget
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
Definition: RevisionDeleter.php:198
RevisionDeleter\getRestriction
static getRestriction( $typeName)
Get the user right required for the RevDel type.
Definition: RevisionDeleter.php:168
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47