3 * File deletion user interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Rob Church <robchur@gmail.com>
24 use MediaWiki\MediaWikiServices
;
27 * File deletion user interface
31 class FileDeleteForm
{
36 private $title = null;
46 private $oldfile = null;
47 private $oldimage = '';
50 * @param File $file File object we're deleting
52 public function __construct( $file ) {
53 $this->title
= $file->getTitle();
58 * Fulfil the request; shows the form or deletes the file,
59 * pending authentication, confirmation, etc.
61 public function execute() {
62 global $wgOut, $wgRequest, $wgUser, $wgUploadMaintenance;
64 $permissionErrors = $this->title
->getUserPermissionsErrors( 'delete', $wgUser );
65 if ( count( $permissionErrors ) ) {
66 throw new PermissionsError( 'delete', $permissionErrors );
70 throw new ReadOnlyError
;
73 if ( $wgUploadMaintenance ) {
74 throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
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' );
84 if ( $this->oldimage
) {
85 $this->oldfile
= RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName(
91 if ( !self
::haveDeletableFile( $this->file
, $this->oldfile
, $this->oldimage
) ) {
92 $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
93 $wgOut->addReturnTo( $this->title
);
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' );
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;
109 $reason = $deleteReasonList;
112 $status = self
::doDelete(
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' )
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() );
134 WatchAction
::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title
, $wgUser );
140 $this->showLogEntries();
144 * Really delete the file
146 * @param Title &$title
148 * @param string &$oldimage Archive name
149 * @param string $reason Reason of the deletion
150 * @param bool $suppress Whether to mark all deleted versions as restricted
151 * @param User $user User object performing the request
152 * @param array $tags Tags to apply to the deletion action
153 * @throws MWException
156 public static function doDelete( &$title, &$file, &$oldimage, $reason,
157 $suppress, User
$user = null, $tags = []
159 if ( $user === null ) {
166 $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
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;
175 $logtype = $suppress ?
'suppress' : 'delete';
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 );
185 $status->value
= $logid;
188 $status = Status
::newFatal( 'cannotdelete',
189 wfEscapeWikiText( $title->getPrefixedText() )
191 $page = WikiPage
::factory( $title );
192 $dbw = wfGetDB( DB_MASTER
);
193 $dbw->startAtomic( __METHOD__
);
194 // delete the associated article first
196 $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
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
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 );
220 $status->value
= $logid;
222 $status->value
= $deleteStatus->value
; // log id
224 $dbw->endAtomic( __METHOD__
);
226 // Page deleted but file still there? rollback page delete
227 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
228 $lbFactory->rollbackMasterChanges( __METHOD__
);
231 // Done; nothing changed
232 $dbw->endAtomic( __METHOD__
);
236 if ( $status->isOK() ) {
237 Hooks
::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
244 * Show the confirmation form
246 private function showForm() {
247 global $wgOut, $wgUser, $wgRequest;
249 $conf = RequestContext
::getMain()->getConfig();
250 $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD
;
252 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
253 $suppress = "<tr id=\"wpDeleteSuppressRow\">
255 <td class='mw-input'><strong>" .
256 Xml
::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
257 'wpSuppress', 'wpSuppress', false, [ 'tabindex' => '3' ] ) .
264 $wgOut->addModules( 'mediawiki.action.delete.file' );
266 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$wgUser->isWatched( $this->title
);
267 $form = Xml
::openElement( 'form', [ 'method' => 'post', 'action' => $this->getAction(),
268 'id' => 'mw-img-deleteconfirm' ] ) .
269 Xml
::openElement( 'fieldset' ) .
270 Xml
::element( 'legend', null, wfMessage( 'filedelete-legend' )->text() ) .
271 Html
::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage
) ) .
272 $this->prepareMessage( 'filedelete-intro' ) .
273 Xml
::openElement( 'table', [ 'id' => 'mw-img-deleteconfirm-table' ] ) .
275 <td class='mw-label'>" .
276 Xml
::label( wfMessage( 'filedelete-comment' )->text(), 'wpDeleteReasonList' ) .
278 <td class='mw-input'>" .
280 'wpDeleteReasonList',
281 wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
282 wfMessage( 'filedelete-reason-otherlist' )->inContentLanguage()->text(),
290 <td class='mw-label'>" .
291 Xml
::label( wfMessage( 'filedelete-otherreason' )->text(), 'wpReason' ) .
293 <td class='mw-input'>" .
294 Xml
::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ), [
296 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
297 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
298 // Unicode codepoints (or 255 UTF-8 bytes for old schema).
299 'maxlength' => $oldCommentSchema ?
255 : CommentStore
::COMMENT_CHARACTER_LIMIT
,
306 if ( $wgUser->isLoggedIn() ) {
310 <td class='mw-input'>" .
311 Xml
::checkLabel( wfMessage( 'watchthis' )->text(),
312 'wpWatch', 'wpWatch', $checkWatch, [ 'tabindex' => '3' ] ) .
319 <td class='mw-submit'>" .
321 wfMessage( 'filedelete-submit' )->text(),
323 'name' => 'mw-filedelete-submit',
324 'id' => 'mw-filedelete-submit',
330 Xml
::closeElement( 'table' ) .
331 Xml
::closeElement( 'fieldset' ) .
332 Xml
::closeElement( 'form' );
334 if ( $wgUser->isAllowed( 'editinterface' ) ) {
335 $title = wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle();
336 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
337 $link = $linkRenderer->makeKnownLink(
339 wfMessage( 'filedelete-edit-reasonlist' )->text(),
341 [ 'action' => 'edit' ]
343 $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
346 $wgOut->addHTML( $form );
350 * Show deletion log fragments pertaining to the current file
352 private function showLogEntries() {
354 $deleteLogPage = new LogPage( 'delete' );
355 $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
356 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->title
);
360 * Prepare a message referring to the file being deleted,
361 * showing an appropriate message depending upon whether
362 * it's a current file or an old version
364 * @param string $message Message base
367 private function prepareMessage( $message ) {
369 if ( $this->oldimage
) {
371 # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
374 wfEscapeWikiText( $this->title
->getText() ),
375 $wgLang->date( $this->getTimestamp(), true ),
376 $wgLang->time( $this->getTimestamp(), true ),
377 wfExpandUrl( $this->file
->getArchiveUrl( $this->oldimage
), PROTO_CURRENT
) )->parseAsBlock();
381 wfEscapeWikiText( $this->title
->getText() )
387 * Set headers, titles and other bits
389 private function setHeaders() {
391 $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title
->getText() ) );
392 $wgOut->setRobotPolicy( 'noindex,nofollow' );
393 $wgOut->addBacklinkSubtitle( $this->title
);
397 * Is the provided `oldimage` value valid?
399 * @param string $oldimage
402 public static function isValidOldSpec( $oldimage ) {
403 return strlen( $oldimage ) >= 16
404 && strpos( $oldimage, '/' ) === false
405 && strpos( $oldimage, '\\' ) === false;
409 * Could we delete the file specified? If an `oldimage`
410 * value was provided, does it correspond to an
411 * existing, local, old version of this file?
414 * @param File &$oldfile
415 * @param File $oldimage
418 public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
420 ?
$oldfile && $oldfile->exists() && $oldfile->isLocal()
421 : $file && $file->exists() && $file->isLocal();
425 * Prepare the form action
429 private function getAction() {
431 $q['action'] = 'delete';
433 if ( $this->oldimage
) {
434 $q['oldimage'] = $this->oldimage
;
437 return $this->title
->getLocalURL( $q );
441 * Extract the timestamp of the old version
445 private function getTimestamp() {
446 return $this->oldfile
->getTimestamp();