MediaWiki REL1_30
FileDeleteForm.php
Go to the documentation of this file.
1<?php
25
32
36 private $title = null;
37
41 private $file = null;
42
46 private $oldfile = null;
47 private $oldimage = '';
48
52 public function __construct( $file ) {
53 $this->title = $file->getTitle();
54 $this->file = $file;
55 }
56
61 public function execute() {
63
64 $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
65 if ( count( $permissionErrors ) ) {
66 throw new PermissionsError( 'delete', $permissionErrors );
67 }
68
69 if ( wfReadOnly() ) {
70 throw new ReadOnlyError;
71 }
72
74 throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
75 }
76
77 $this->setHeaders();
78
79 $this->oldimage = $wgRequest->getText( 'oldimage', false );
80 $token = $wgRequest->getText( 'wpEditToken' );
81 # Flag to hide all contents of the archived revisions
82 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
83
84 if ( $this->oldimage ) {
85 $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
86 $this->title,
87 $this->oldimage
88 );
89 }
90
91 if ( !self::haveDeletableFile( $this->file, $this->oldfile, $this->oldimage ) ) {
92 $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
93 $wgOut->addReturnTo( $this->title );
94 return;
95 }
96
97 // Perform the deletion if appropriate
98 if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
99 $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
100 $deleteReason = $wgRequest->getText( 'wpReason' );
101
102 if ( $deleteReasonList == 'other' ) {
103 $reason = $deleteReason;
104 } elseif ( $deleteReason != '' ) {
105 // Entry from drop down menu + additional comment
106 $reason = $deleteReasonList . wfMessage( 'colon-separator' )
107 ->inContentLanguage()->text() . $deleteReason;
108 } else {
109 $reason = $deleteReasonList;
110 }
111
113 $this->title,
114 $this->file,
115 $this->oldimage,
116 $reason,
117 $suppress,
118 $wgUser
119 );
120
121 if ( !$status->isGood() ) {
122 $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
123 $wgOut->addWikiText( '<div class="error">' .
124 $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
125 . '</div>' );
126 }
127 if ( $status->isOK() ) {
128 $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
129 $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
130 // Return to the main page if we just deleted all versions of the
131 // file, otherwise go back to the description page
132 $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
133
134 WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
135 }
136 return;
137 }
138
139 $this->showForm();
140 $this->showLogEntries();
141 }
142
156 public static function doDelete( &$title, &$file, &$oldimage, $reason,
157 $suppress, User $user = null, $tags = []
158 ) {
159 if ( $user === null ) {
160 global $wgUser;
161 $user = $wgUser;
162 }
163
164 if ( $oldimage ) {
165 $page = null;
166 $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
167 if ( $status->ok ) {
168 // Need to do a log item
169 $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
170 if ( trim( $reason ) != '' ) {
171 $logComment .= wfMessage( 'colon-separator' )
172 ->inContentLanguage()->text() . $reason;
173 }
174
175 $logtype = $suppress ? 'suppress' : 'delete';
176
177 $logEntry = new ManualLogEntry( $logtype, 'delete' );
178 $logEntry->setPerformer( $user );
179 $logEntry->setTarget( $title );
180 $logEntry->setComment( $logComment );
181 $logEntry->setTags( $tags );
182 $logid = $logEntry->insert();
183 $logEntry->publish( $logid );
184
185 $status->value = $logid;
186 }
187 } else {
188 $status = Status::newFatal( 'cannotdelete',
189 wfEscapeWikiText( $title->getPrefixedText() )
190 );
191 $page = WikiPage::factory( $title );
192 $dbw = wfGetDB( DB_MASTER );
193 $dbw->startAtomic( __METHOD__ );
194 // delete the associated article first
195 $error = '';
196 $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
197 $user, $tags );
198 // doDeleteArticleReal() returns a non-fatal error status if the page
199 // or revision is missing, so check for isOK() rather than isGood()
200 if ( $deleteStatus->isOK() ) {
201 $status = $file->delete( $reason, $suppress, $user );
202 if ( $status->isOK() ) {
203 if ( $deleteStatus->value === null ) {
204 // No log ID from doDeleteArticleReal(), probably
205 // because the page/revision didn't exist, so create
206 // one here.
207 $logtype = $suppress ? 'suppress' : 'delete';
208 $logEntry = new ManualLogEntry( $logtype, 'delete' );
209 $logEntry->setPerformer( $user );
210 $logEntry->setTarget( clone $title );
211 $logEntry->setComment( $reason );
212 $logEntry->setTags( $tags );
213 $logid = $logEntry->insert();
214 $dbw->onTransactionPreCommitOrIdle(
215 function () use ( $dbw, $logEntry, $logid ) {
216 $logEntry->publish( $logid );
217 },
218 __METHOD__
219 );
220 $status->value = $logid;
221 } else {
222 $status->value = $deleteStatus->value; // log id
223 }
224 $dbw->endAtomic( __METHOD__ );
225 } else {
226 // Page deleted but file still there? rollback page delete
227 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
228 $lbFactory->rollbackMasterChanges( __METHOD__ );
229 }
230 } else {
231 // Done; nothing changed
232 $dbw->endAtomic( __METHOD__ );
233 }
234 }
235
236 if ( $status->isOK() ) {
237 Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
238 }
239
240 return $status;
241 }
242
246 private function showForm() {
247 global $wgOut, $wgUser, $wgRequest;
248
249 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
250 $suppress = "<tr id=\"wpDeleteSuppressRow\">
251 <td></td>
252 <td class='mw-input'><strong>" .
253 Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
254 'wpSuppress', 'wpSuppress', false, [ 'tabindex' => '3' ] ) .
255 "</strong></td>
256 </tr>";
257 } else {
258 $suppress = '';
259 }
260
261 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
262 $form = Xml::openElement( 'form', [ 'method' => 'post', 'action' => $this->getAction(),
263 'id' => 'mw-img-deleteconfirm' ] ) .
264 Xml::openElement( 'fieldset' ) .
265 Xml::element( 'legend', null, wfMessage( 'filedelete-legend' )->text() ) .
266 Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) ) .
267 $this->prepareMessage( 'filedelete-intro' ) .
268 Xml::openElement( 'table', [ 'id' => 'mw-img-deleteconfirm-table' ] ) .
269 "<tr>
270 <td class='mw-label'>" .
271 Xml::label( wfMessage( 'filedelete-comment' )->text(), 'wpDeleteReasonList' ) .
272 "</td>
273 <td class='mw-input'>" .
274 Xml::listDropDown(
275 'wpDeleteReasonList',
276 wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
277 wfMessage( 'filedelete-reason-otherlist' )->inContentLanguage()->text(),
278 '',
279 'wpReasonDropDown',
280 1
281 ) .
282 "</td>
283 </tr>
284 <tr>
285 <td class='mw-label'>" .
286 Xml::label( wfMessage( 'filedelete-otherreason' )->text(), 'wpReason' ) .
287 "</td>
288 <td class='mw-input'>" .
289 Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
290 [ 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ] ) .
291 "</td>
292 </tr>
293 {$suppress}";
294 if ( $wgUser->isLoggedIn() ) {
295 $form .= "
296 <tr>
297 <td></td>
298 <td class='mw-input'>" .
299 Xml::checkLabel( wfMessage( 'watchthis' )->text(),
300 'wpWatch', 'wpWatch', $checkWatch, [ 'tabindex' => '3' ] ) .
301 "</td>
302 </tr>";
303 }
304 $form .= "
305 <tr>
306 <td></td>
307 <td class='mw-submit'>" .
308 Xml::submitButton(
309 wfMessage( 'filedelete-submit' )->text(),
310 [
311 'name' => 'mw-filedelete-submit',
312 'id' => 'mw-filedelete-submit',
313 'tabindex' => '4'
314 ]
315 ) .
316 "</td>
317 </tr>" .
318 Xml::closeElement( 'table' ) .
319 Xml::closeElement( 'fieldset' ) .
320 Xml::closeElement( 'form' );
321
322 if ( $wgUser->isAllowed( 'editinterface' ) ) {
323 $title = wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle();
324 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
325 $link = $linkRenderer->makeKnownLink(
326 $title,
327 wfMessage( 'filedelete-edit-reasonlist' )->text(),
328 [],
329 [ 'action' => 'edit' ]
330 );
331 $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
332 }
333
334 $wgOut->addHTML( $form );
335 }
336
340 private function showLogEntries() {
341 global $wgOut;
342 $deleteLogPage = new LogPage( 'delete' );
343 $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
344 LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
345 }
346
355 private function prepareMessage( $message ) {
356 global $wgLang;
357 if ( $this->oldimage ) {
358 # Message keys used:
359 # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
360 return wfMessage(
361 "{$message}-old",
362 wfEscapeWikiText( $this->title->getText() ),
363 $wgLang->date( $this->getTimestamp(), true ),
364 $wgLang->time( $this->getTimestamp(), true ),
365 wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
366 } else {
367 return wfMessage(
368 $message,
369 wfEscapeWikiText( $this->title->getText() )
370 )->parseAsBlock();
371 }
372 }
373
377 private function setHeaders() {
378 global $wgOut;
379 $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
380 $wgOut->setRobotPolicy( 'noindex,nofollow' );
381 $wgOut->addBacklinkSubtitle( $this->title );
382 }
383
390 public static function isValidOldSpec( $oldimage ) {
391 return strlen( $oldimage ) >= 16
392 && strpos( $oldimage, '/' ) === false
393 && strpos( $oldimage, '\\' ) === false;
394 }
395
406 public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
407 return $oldimage
409 : $file && $file->exists() && $file->isLocal();
410 }
411
417 private function getAction() {
418 $q = [];
419 $q['action'] = 'delete';
420
421 if ( $this->oldimage ) {
422 $q['oldimage'] = $this->oldimage;
423 }
424
425 return $this->title->getLocalURL( $q );
426 }
427
433 private function getTimestamp() {
434 return $this->oldfile->getTimestamp();
435 }
436}
$wgUploadMaintenance
To disable file delete/restore temporarily.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
$wgUser
Definition Setup.php:817
$wgOut
Definition Setup.php:827
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:662
An error page which can definitely be safely rendered using the OutputPage.
File deletion user interface.
getAction()
Prepare the form action.
static haveDeletableFile(&$file, &$oldfile, $oldimage)
Could we delete the file specified? If an oldimage value was provided, does it correspond to an exist...
prepareMessage( $message)
Prepare a message referring to the file being deleted, showing an appropriate message depending upon ...
getTimestamp()
Extract the timestamp of the old version.
showForm()
Show the confirmation form.
static doDelete(&$title, &$file, &$oldimage, $reason, $suppress, User $user=null, $tags=[])
Really delete the file.
execute()
Fulfil the request; shows the form or deletes the file, pending authentication, confirmation,...
showLogEntries()
Show deletion log fragments pertaining to the current file.
setHeaders()
Set headers, titles and other bits.
static isValidOldSpec( $oldimage)
Is the provided oldimage value valid?
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:51
isLocal()
Returns true if the file comes from the local file repository.
Definition File.php:1835
exists()
Returns true if file exists in the repository.
Definition File.php:877
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Class to simplify the use of log pages.
Definition LogPage.php:31
Class for creating log entries manually, to inject them into the database.
Definition LogEntry.php:400
MediaWikiServices is the service locator for the application scope of MediaWiki.
Show an error when a user tries to do something they do not have the necessary permissions for.
Show an error when the wiki is locked/read-only and the user tries to do something that requires writ...
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
static doWatchOrUnwatch( $watch, Title $title, User $user)
Watch or unwatch a page.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
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:1049
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 just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition hooks.txt:2026
const PROTO_CURRENT
Definition Defines.php:223
const DB_MASTER
Definition defines.php:26