MediaWiki master
RevisionDeleter.php
Go to the documentation of this file.
1<?php
29
41 private const ALLOWED_TYPES = [
42 'revision' => [
43 'class' => RevDelRevisionList::class,
44 'services' => [
45 'DBLoadBalancerFactory',
46 'HookContainer',
47 'HtmlCacheUpdater',
48 'RevisionStore',
49 ],
50 ],
51 'archive' => [
52 'class' => RevDelArchiveList::class,
53 'services' => [
54 'DBLoadBalancerFactory',
55 'HookContainer',
56 'HtmlCacheUpdater',
57 'RevisionStore',
58 ],
59 ],
60 'oldimage' => [
61 'class' => RevDelFileList::class,
62 'services' => [
63 'DBLoadBalancerFactory',
64 'HtmlCacheUpdater',
65 'RepoGroup',
66 ],
67 ],
68 'filearchive' => [
69 'class' => RevDelArchivedFileList::class,
70 'services' => [
71 'DBLoadBalancerFactory',
72 'HtmlCacheUpdater',
73 'RepoGroup',
74 ],
75 ],
76 'logging' => [
77 'class' => RevDelLogList::class,
78 'services' => [
79 'DBLoadBalancerFactory',
80 'CommentStore',
81 ],
82 ],
83 ];
84
86 private const DEPRECATED_TYPE_MAP = [
87 'oldid' => 'revision',
88 'artimestamp' => 'archive',
89 'oldimage' => 'oldimage',
90 'fileid' => 'filearchive',
91 'logid' => 'logging',
92 ];
93
100 public static function getTypes() {
101 return array_keys( self::ALLOWED_TYPES );
102 }
103
111 public static function getCanonicalTypeName( $typeName ) {
112 if ( isset( self::DEPRECATED_TYPE_MAP[$typeName] ) ) {
113 $typeName = self::DEPRECATED_TYPE_MAP[$typeName];
114 }
115 return isset( self::ALLOWED_TYPES[$typeName] ) ? $typeName : null;
116 }
117
128 public static function createList( $typeName, IContextSource $context, PageIdentity $page, array $ids ) {
129 $typeName = self::getCanonicalTypeName( $typeName );
130 if ( !$typeName ) {
131 throw new InvalidArgumentException( __METHOD__ . ": Unknown RevDel type '$typeName'" );
132 }
133 $spec = self::ALLOWED_TYPES[$typeName];
134 $objectFactory = MediaWikiServices::getInstance()->getObjectFactory();
135
136 // ObjectFactory::createObject accepts an array, not just a callable (phan bug)
137 // @phan-suppress-next-line PhanTypeInvalidCallableArrayKey
138 return $objectFactory->createObject(
139 $spec,
140 [
141 'extraArgs' => [ $context, $page, $ids ],
142 'assertClass' => RevDelList::class,
143 ]
144 );
145 }
146
158 protected static function checkItem( $desc, $field, $diff, $new, &$arr ) {
159 if ( $diff & $field ) {
160 $arr[( $new & $field ) ? 0 : 1][] = $desc;
161 }
162 }
163
182 public static function getChanges( $n, $o ) {
183 $diff = $n ^ $o;
184 $ret = [ 0 => [], 1 => [], 2 => [] ];
185 // Build bitfield changes in language
186 self::checkItem( 'revdelete-content',
187 RevisionRecord::DELETED_TEXT, $diff, $n, $ret );
188 self::checkItem( 'revdelete-summary',
189 RevisionRecord::DELETED_COMMENT, $diff, $n, $ret );
190 self::checkItem( 'revdelete-uname',
191 RevisionRecord::DELETED_USER, $diff, $n, $ret );
192 // Restriction application to sysops
193 if ( $diff & RevisionRecord::DELETED_RESTRICTED ) {
194 if ( $n & RevisionRecord::DELETED_RESTRICTED ) {
195 $ret[2][] = 'revdelete-restricted';
196 } else {
197 $ret[2][] = 'revdelete-unrestricted';
198 }
199 }
200 return $ret;
201 }
202
209 public static function getRelationType( $typeName ) {
210 $typeName = self::getCanonicalTypeName( $typeName );
211 if ( !$typeName ) {
212 return null;
213 }
214 return call_user_func( [ self::ALLOWED_TYPES[$typeName]['class'], 'getRelationType' ] );
215 }
216
223 public static function getRestriction( $typeName ) {
224 $typeName = self::getCanonicalTypeName( $typeName );
225 if ( !$typeName ) {
226 return null;
227 }
228 return call_user_func( [ self::ALLOWED_TYPES[$typeName]['class'], 'getRestriction' ] );
229 }
230
237 public static function getRevdelConstant( $typeName ) {
238 $typeName = self::getCanonicalTypeName( $typeName );
239 if ( !$typeName ) {
240 return null;
241 }
242 return call_user_func( [ self::ALLOWED_TYPES[$typeName]['class'], 'getRevdelConstant' ] );
243 }
244
253 public static function suggestTarget( $typeName, $target, array $ids ) {
254 $typeName = self::getCanonicalTypeName( $typeName );
255 if ( !$typeName ) {
256 return $target;
257 }
258 return call_user_func(
259 [ self::ALLOWED_TYPES[$typeName]['class'], 'suggestTarget' ],
260 $target,
261 $ids
262 );
263 }
264
272 public static function extractBitfield( array $bitPars, $oldfield ) {
273 // Build the actual new rev_deleted bitfield
274 $newBits = 0;
275 foreach ( $bitPars as $const => $val ) {
276 if ( $val == 1 ) {
277 $newBits |= $const; // $const is the *_deleted const
278 } elseif ( $val == -1 ) {
279 $newBits |= ( $oldfield & $const ); // use existing
280 }
281 }
282 return $newBits;
283 }
284}
Service locator for MediaWiki core services.
Page revision base class.
Represents a title within MediaWiki.
Definition Title.php:79
General controller for RevDel, used by both SpecialRevisiondelete and ApiRevisionDelete.
static getCanonicalTypeName( $typeName)
Gets the canonical type name, if any.
static getTypes()
Lists the valid possible types for revision deletion.
static checkItem( $desc, $field, $diff, $new, &$arr)
Checks for a change in the bitfield for a certain option and updates the provided array accordingly.
static getRelationType( $typeName)
Get DB field name for URL param... Future code for other things may also track other types of revisio...
static getChanges( $n, $o)
Gets an array of message keys describing the changes made to the visibility of the revision.
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
static extractBitfield(array $bitPars, $oldfield)
Put together a rev_deleted bitfield.
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
static getRestriction( $typeName)
Get the user right required for the RevDel type.
static createList( $typeName, IContextSource $context, PageIdentity $page, array $ids)
Instantiate the appropriate list class for a given list of IDs.
Interface for objects which can provide a MediaWiki context on request.
Interface for objects (potentially) representing an editable wiki page.