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 $permissionManager = MediaWikiServices
::getInstance()->getPermissionManager();
83 $suppress = $wgRequest->getCheck( 'wpSuppress' ) &&
84 $permissionManager->userHasRight( $wgUser, 'suppressrevision' );
86 if ( $this->oldimage
) {
87 $this->oldfile
= RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName(
93 if ( !self
::haveDeletableFile( $this->file
, $this->oldfile
, $this->oldimage
) ) {
94 $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
95 $wgOut->addReturnTo( $this->title
);
99 // Perform the deletion if appropriate
100 if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage
) ) {
101 $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
102 $deleteReason = $wgRequest->getText( 'wpReason' );
104 if ( $deleteReasonList == 'other' ) {
105 $reason = $deleteReason;
106 } elseif ( $deleteReason != '' ) {
107 // Entry from drop down menu + additional comment
108 $reason = $deleteReasonList . wfMessage( 'colon-separator' )
109 ->inContentLanguage()->text() . $deleteReason;
111 $reason = $deleteReasonList;
114 $status = self
::doDelete(
123 if ( !$status->isGood() ) {
124 $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
125 $wgOut->wrapWikiTextAsInterface(
127 $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
130 if ( $status->isOK() ) {
131 $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
132 $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
133 // Return to the main page if we just deleted all versions of the
134 // file, otherwise go back to the description page
135 $wgOut->addReturnTo( $this->oldimage ?
$this->title
: Title
::newMainPage() );
137 WatchAction
::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title
, $wgUser );
143 $this->showLogEntries();
147 * Really delete the file
149 * @param Title &$title
150 * @param LocalFile &$file
151 * @param string &$oldimage Archive name
152 * @param string $reason Reason of the deletion
153 * @param bool $suppress Whether to mark all deleted versions as restricted
154 * @param User|null $user User object performing the request
155 * @param array $tags Tags to apply to the deletion action
156 * @throws MWException
159 public static function doDelete( &$title, &$file, &$oldimage, $reason,
160 $suppress, User
$user = null, $tags = []
162 if ( $user === null ) {
169 $status = $file->deleteOld( $oldimage, $reason, $suppress, $user );
170 if ( $status->isOK() ) {
171 // Need to do a log item
172 $logComment = wfMessage( 'deletedrevision', $oldimage )->inContentLanguage()->text();
173 if ( trim( $reason ) != '' ) {
174 $logComment .= wfMessage( 'colon-separator' )
175 ->inContentLanguage()->text() . $reason;
178 $logtype = $suppress ?
'suppress' : 'delete';
180 $logEntry = new ManualLogEntry( $logtype, 'delete' );
181 $logEntry->setPerformer( $user );
182 $logEntry->setTarget( $title );
183 $logEntry->setComment( $logComment );
184 $logEntry->addTags( $tags );
185 $logid = $logEntry->insert();
186 $logEntry->publish( $logid );
188 $status->value
= $logid;
191 $status = Status
::newFatal( 'cannotdelete',
192 wfEscapeWikiText( $title->getPrefixedText() )
194 $page = WikiPage
::factory( $title );
195 $dbw = wfGetDB( DB_MASTER
);
196 $dbw->startAtomic( __METHOD__
);
197 // delete the associated article first
199 $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error,
201 // doDeleteArticleReal() returns a non-fatal error status if the page
202 // or revision is missing, so check for isOK() rather than isGood()
203 if ( $deleteStatus->isOK() ) {
204 $status = $file->delete( $reason, $suppress, $user );
205 if ( $status->isOK() ) {
206 if ( $deleteStatus->value
=== null ) {
207 // No log ID from doDeleteArticleReal(), probably
208 // because the page/revision didn't exist, so create
210 $logtype = $suppress ?
'suppress' : 'delete';
211 $logEntry = new ManualLogEntry( $logtype, 'delete' );
212 $logEntry->setPerformer( $user );
213 $logEntry->setTarget( clone $title );
214 $logEntry->setComment( $reason );
215 $logEntry->addTags( $tags );
216 $logid = $logEntry->insert();
217 $dbw->onTransactionPreCommitOrIdle(
218 function () use ( $logEntry, $logid ) {
219 $logEntry->publish( $logid );
223 $status->value
= $logid;
225 $status->value
= $deleteStatus->value
; // log id
227 $dbw->endAtomic( __METHOD__
);
229 // Page deleted but file still there? rollback page delete
230 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
231 $lbFactory->rollbackMasterChanges( __METHOD__
);
234 $dbw->endAtomic( __METHOD__
);
238 if ( $status->isOK() ) {
239 Hooks
::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
246 * Show the confirmation form
248 private function showForm() {
249 global $wgOut, $wgUser, $wgRequest;
250 $permissionManager = MediaWikiServices
::getInstance()->getPermissionManager();
252 $wgOut->addModules( 'mediawiki.action.delete.file' );
254 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$wgUser->isWatched( $this->title
);
256 $wgOut->enableOOUI();
260 $fields[] = new OOUI\
LabelWidget( [ 'label' => new OOUI\
HtmlSnippet(
261 $this->prepareMessage( 'filedelete-intro' ) ) ]
264 $options = Xml
::listDropDownOptions(
265 $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
266 [ 'other' => $wgOut->msg( 'filedelete-reason-otherlist' )->inContentLanguage()->text() ]
268 $options = Xml
::listDropDownOptionsOoui( $options );
270 $fields[] = new OOUI\
FieldLayout(
271 new OOUI\
DropdownInputWidget( [
272 'name' => 'wpDeleteReasonList',
273 'inputId' => 'wpDeleteReasonList',
277 'options' => $options,
280 'label' => $wgOut->msg( 'filedelete-comment' )->text(),
285 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
286 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
287 // Unicode codepoints.
288 $fields[] = new OOUI\
FieldLayout(
289 new OOUI\
TextInputWidget( [
290 'name' => 'wpReason',
291 'inputId' => 'wpReason',
293 'maxLength' => CommentStore
::COMMENT_CHARACTER_LIMIT
,
295 'value' => $wgRequest->getText( 'wpReason' ),
299 'label' => $wgOut->msg( 'filedelete-otherreason' )->text(),
304 if ( $permissionManager->userHasRight( $wgUser, 'suppressrevision' ) ) {
305 $fields[] = new OOUI\
FieldLayout(
306 new OOUI\
CheckboxInputWidget( [
307 'name' => 'wpSuppress',
308 'inputId' => 'wpSuppress',
313 'label' => $wgOut->msg( 'revdelete-suppress' )->text(),
320 if ( $wgUser->isLoggedIn() ) {
321 $fields[] = new OOUI\
FieldLayout(
322 new OOUI\
CheckboxInputWidget( [
324 'inputId' => 'wpWatch',
326 'selected' => $checkWatch,
329 'label' => $wgOut->msg( 'watchthis' )->text(),
336 $fields[] = new OOUI\
FieldLayout(
337 new OOUI\
ButtonInputWidget( [
338 'name' => 'mw-filedelete-submit',
339 'inputId' => 'mw-filedelete-submit',
341 'value' => $wgOut->msg( 'filedelete-submit' )->text(),
342 'label' => $wgOut->msg( 'filedelete-submit' )->text(),
343 'flags' => [ 'primary', 'destructive' ],
351 $fieldset = new OOUI\
FieldsetLayout( [
352 'label' => $wgOut->msg( 'filedelete-legend' )->text(),
356 $form = new OOUI\
FormLayout( [
358 'action' => $this->getAction(),
359 'id' => 'mw-img-deleteconfirm',
361 $form->appendContent(
363 new OOUI\
HtmlSnippet(
364 Html
::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage
) )
369 new OOUI\
PanelLayout( [
370 'classes' => [ 'deletepage-wrapper' ],
378 if ( $permissionManager->userHasRight( $wgUser, 'editinterface' ) ) {
379 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
380 $link = $linkRenderer->makeKnownLink(
381 $wgOut->msg( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle(),
382 wfMessage( 'filedelete-edit-reasonlist' )->text(),
384 [ 'action' => 'edit' ]
386 $wgOut->addHTML( '<p class="mw-filedelete-editreasons">' . $link . '</p>' );
391 * Show deletion log fragments pertaining to the current file
393 private function showLogEntries() {
395 $deleteLogPage = new LogPage( 'delete' );
396 $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
397 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->title
);
401 * Prepare a message referring to the file being deleted,
402 * showing an appropriate message depending upon whether
403 * it's a current file or an old version
405 * @param string $message Message base
408 private function prepareMessage( $message ) {
410 if ( $this->oldimage
) {
412 # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
415 wfEscapeWikiText( $this->title
->getText() ),
416 $wgLang->date( $this->getTimestamp(), true ),
417 $wgLang->time( $this->getTimestamp(), true ),
418 wfExpandUrl( $this->file
->getArchiveUrl( $this->oldimage
), PROTO_CURRENT
) )->parseAsBlock();
422 wfEscapeWikiText( $this->title
->getText() )
428 * Set headers, titles and other bits
430 private function setHeaders() {
432 $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title
->getText() ) );
433 $wgOut->setRobotPolicy( 'noindex,nofollow' );
434 $wgOut->addBacklinkSubtitle( $this->title
);
438 * Is the provided `oldimage` value valid?
440 * @param string $oldimage
443 public static function isValidOldSpec( $oldimage ) {
444 return strlen( $oldimage ) >= 16
445 && strpos( $oldimage, '/' ) === false
446 && strpos( $oldimage, '\\' ) === false;
450 * Could we delete the file specified? If an `oldimage`
451 * value was provided, does it correspond to an
452 * existing, local, old version of this file?
455 * @param File &$oldfile
456 * @param File $oldimage
459 public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
461 ?
$oldfile && $oldfile->exists() && $oldfile->isLocal()
462 : $file && $file->exists() && $file->isLocal();
466 * Prepare the form action
470 private function getAction() {
472 $q['action'] = 'delete';
474 if ( $this->oldimage
) {
475 $q['oldimage'] = $this->oldimage
;
478 return $this->title
->getLocalURL( $q );
482 * Extract the timestamp of the old version
486 private function getTimestamp() {
487 return $this->oldfile
->getTimestamp();