API: Some raw message cleanup
[mediawiki.git] / includes / FileDeleteForm.php
blob65638f286f70c2df3938022699fe8699202684b3
1 <?php
2 /**
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
20 * @file
21 * @author Rob Church <robchur@gmail.com>
22 * @ingroup Media
25 /**
26 * File deletion user interface
28 * @ingroup Media
30 class FileDeleteForm {
32 /**
33 * @var Title
35 private $title = null;
37 /**
38 * @var File
40 private $file = null;
42 /**
43 * @var File
45 private $oldfile = null;
46 private $oldimage = '';
48 /**
49 * Constructor
51 * @param File $file File object we're deleting
53 public function __construct( $file ) {
54 $this->title = $file->getTitle();
55 $this->file = $file;
58 /**
59 * Fulfil the request; shows the form or deletes the file,
60 * pending authentication, confirmation, etc.
62 public function execute() {
63 global $wgOut, $wgRequest, $wgUser, $wgUploadMaintenance;
65 $permissionErrors = $this->title->getUserPermissionsErrors( 'delete', $wgUser );
66 if ( count( $permissionErrors ) ) {
67 throw new PermissionsError( 'delete', $permissionErrors );
70 if ( wfReadOnly() ) {
71 throw new ReadOnlyError;
74 if ( $wgUploadMaintenance ) {
75 throw new ErrorPageError( 'filedelete-maintenance-title', 'filedelete-maintenance' );
78 $this->setHeaders();
80 $this->oldimage = $wgRequest->getText( 'oldimage', false );
81 $token = $wgRequest->getText( 'wpEditToken' );
82 # Flag to hide all contents of the archived revisions
83 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
85 if ( $this->oldimage ) {
86 $this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName(
87 $this->title,
88 $this->oldimage
92 if ( !self::haveDeletableFile( $this->file, $this->oldfile, $this->oldimage ) ) {
93 $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
94 $wgOut->addReturnTo( $this->title );
95 return;
98 // Perform the deletion if appropriate
99 if ( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
100 $deleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
101 $deleteReason = $wgRequest->getText( 'wpReason' );
103 if ( $deleteReasonList == 'other' ) {
104 $reason = $deleteReason;
105 } elseif ( $deleteReason != '' ) {
106 // Entry from drop down menu + additional comment
107 $reason = $deleteReasonList . wfMessage( 'colon-separator' )
108 ->inContentLanguage()->text() . $deleteReason;
109 } else {
110 $reason = $deleteReasonList;
113 $status = self::doDelete(
114 $this->title,
115 $this->file,
116 $this->oldimage,
117 $reason,
118 $suppress,
119 $wgUser
122 if ( !$status->isGood() ) {
123 $wgOut->addHTML( '<h2>' . $this->prepareMessage( 'filedeleteerror-short' ) . "</h2>\n" );
124 $wgOut->addWikiText( '<div class="error">' .
125 $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' )
126 . '</div>' );
128 if ( $status->ok ) {
129 $wgOut->setPageTitle( wfMessage( 'actioncomplete' ) );
130 $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
131 // Return to the main page if we just deleted all versions of the
132 // file, otherwise go back to the description page
133 $wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
135 WatchAction::doWatchOrUnwatch( $wgRequest->getCheck( 'wpWatch' ), $this->title, $wgUser );
137 return;
140 $this->showForm();
141 $this->showLogEntries();
145 * Really delete the file
147 * @param Title $title
148 * @param File $file
149 * @param string $oldimage Archive name
150 * @param string $reason Reason of the deletion
151 * @param bool $suppress Whether to mark all deleted versions as restricted
152 * @param User $user User object performing the request
153 * @throws MWException
154 * @return bool|Status
156 public static function doDelete( &$title, &$file, &$oldimage, $reason,
157 $suppress, User $user = null
159 if ( $user === null ) {
160 global $wgUser;
161 $user = $wgUser;
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;
175 $logtype = $suppress ? 'suppress' : 'delete';
177 $logEntry = new ManualLogEntry( $logtype, 'delete' );
178 $logEntry->setPerformer( $user );
179 $logEntry->setTarget( $title );
180 $logEntry->setComment( $logComment );
181 $logid = $logEntry->insert();
182 $logEntry->publish( $logid );
184 $status->value = $logid;
186 } else {
187 $status = Status::newFatal( 'cannotdelete',
188 wfEscapeWikiText( $title->getPrefixedText() )
190 $page = WikiPage::factory( $title );
191 $dbw = wfGetDB( DB_MASTER );
192 $dbw->startAtomic( __METHOD__ );
193 // delete the associated article first
194 $error = '';
195 $deleteStatus = $page->doDeleteArticleReal( $reason, $suppress, 0, false, $error, $user );
196 // doDeleteArticleReal() returns a non-fatal error status if the page
197 // or revision is missing, so check for isOK() rather than isGood()
198 if ( $deleteStatus->isOK() ) {
199 $status = $file->delete( $reason, $suppress, $user );
200 if ( $status->isOK() ) {
201 $status->value = $deleteStatus->value; // log id
202 $dbw->endAtomic( __METHOD__ );
203 } else {
204 // Page deleted but file still there? rollback page delete
205 wfGetLBFactory()->rollbackMasterChanges( __METHOD__ );
207 } else {
208 // Done; nothing changed
209 $dbw->endAtomic( __METHOD__ );
213 if ( $status->isOK() ) {
214 Hooks::run( 'FileDeleteComplete', [ &$file, &$oldimage, &$page, &$user, &$reason ] );
217 return $status;
221 * Show the confirmation form
223 private function showForm() {
224 global $wgOut, $wgUser, $wgRequest;
226 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
227 $suppress = "<tr id=\"wpDeleteSuppressRow\">
228 <td></td>
229 <td class='mw-input'><strong>" .
230 Xml::checkLabel( wfMessage( 'revdelete-suppress' )->text(),
231 'wpSuppress', 'wpSuppress', false, [ 'tabindex' => '3' ] ) .
232 "</strong></td>
233 </tr>";
234 } else {
235 $suppress = '';
238 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $wgUser->isWatched( $this->title );
239 $form = Xml::openElement( 'form', [ 'method' => 'post', 'action' => $this->getAction(),
240 'id' => 'mw-img-deleteconfirm' ] ) .
241 Xml::openElement( 'fieldset' ) .
242 Xml::element( 'legend', null, wfMessage( 'filedelete-legend' )->text() ) .
243 Html::hidden( 'wpEditToken', $wgUser->getEditToken( $this->oldimage ) ) .
244 $this->prepareMessage( 'filedelete-intro' ) .
245 Xml::openElement( 'table', [ 'id' => 'mw-img-deleteconfirm-table' ] ) .
246 "<tr>
247 <td class='mw-label'>" .
248 Xml::label( wfMessage( 'filedelete-comment' )->text(), 'wpDeleteReasonList' ) .
249 "</td>
250 <td class='mw-input'>" .
251 Xml::listDropDown(
252 'wpDeleteReasonList',
253 wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->text(),
254 wfMessage( 'filedelete-reason-otherlist' )->inContentLanguage()->text(),
256 'wpReasonDropDown',
259 "</td>
260 </tr>
261 <tr>
262 <td class='mw-label'>" .
263 Xml::label( wfMessage( 'filedelete-otherreason' )->text(), 'wpReason' ) .
264 "</td>
265 <td class='mw-input'>" .
266 Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
267 [ 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ] ) .
268 "</td>
269 </tr>
270 {$suppress}";
271 if ( $wgUser->isLoggedIn() ) {
272 $form .= "
273 <tr>
274 <td></td>
275 <td class='mw-input'>" .
276 Xml::checkLabel( wfMessage( 'watchthis' )->text(),
277 'wpWatch', 'wpWatch', $checkWatch, [ 'tabindex' => '3' ] ) .
278 "</td>
279 </tr>";
281 $form .= "
282 <tr>
283 <td></td>
284 <td class='mw-submit'>" .
285 Xml::submitButton(
286 wfMessage( 'filedelete-submit' )->text(),
288 'name' => 'mw-filedelete-submit',
289 'id' => 'mw-filedelete-submit',
290 'tabindex' => '4'
293 "</td>
294 </tr>" .
295 Xml::closeElement( 'table' ) .
296 Xml::closeElement( 'fieldset' ) .
297 Xml::closeElement( 'form' );
299 if ( $wgUser->isAllowed( 'editinterface' ) ) {
300 $title = wfMessage( 'filedelete-reason-dropdown' )->inContentLanguage()->getTitle();
301 $link = Linker::linkKnown(
302 $title,
303 wfMessage( 'filedelete-edit-reasonlist' )->escaped(),
305 [ 'action' => 'edit' ]
307 $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
310 $wgOut->addHTML( $form );
314 * Show deletion log fragments pertaining to the current file
316 private function showLogEntries() {
317 global $wgOut;
318 $deleteLogPage = new LogPage( 'delete' );
319 $wgOut->addHTML( '<h2>' . $deleteLogPage->getName()->escaped() . "</h2>\n" );
320 LogEventsList::showLogExtract( $wgOut, 'delete', $this->title );
324 * Prepare a message referring to the file being deleted,
325 * showing an appropriate message depending upon whether
326 * it's a current file or an old version
328 * @param string $message Message base
329 * @return string
331 private function prepareMessage( $message ) {
332 global $wgLang;
333 if ( $this->oldimage ) {
334 # Message keys used:
335 # 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
336 return wfMessage(
337 "{$message}-old",
338 wfEscapeWikiText( $this->title->getText() ),
339 $wgLang->date( $this->getTimestamp(), true ),
340 $wgLang->time( $this->getTimestamp(), true ),
341 wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ), PROTO_CURRENT ) )->parseAsBlock();
342 } else {
343 return wfMessage(
344 $message,
345 wfEscapeWikiText( $this->title->getText() )
346 )->parseAsBlock();
351 * Set headers, titles and other bits
353 private function setHeaders() {
354 global $wgOut;
355 $wgOut->setPageTitle( wfMessage( 'filedelete', $this->title->getText() ) );
356 $wgOut->setRobotPolicy( 'noindex,nofollow' );
357 $wgOut->addBacklinkSubtitle( $this->title );
361 * Is the provided `oldimage` value valid?
363 * @param string $oldimage
364 * @return bool
366 public static function isValidOldSpec( $oldimage ) {
367 return strlen( $oldimage ) >= 16
368 && strpos( $oldimage, '/' ) === false
369 && strpos( $oldimage, '\\' ) === false;
373 * Could we delete the file specified? If an `oldimage`
374 * value was provided, does it correspond to an
375 * existing, local, old version of this file?
377 * @param File $file
378 * @param File $oldfile
379 * @param File $oldimage
380 * @return bool
382 public static function haveDeletableFile( &$file, &$oldfile, $oldimage ) {
383 return $oldimage
384 ? $oldfile && $oldfile->exists() && $oldfile->isLocal()
385 : $file && $file->exists() && $file->isLocal();
389 * Prepare the form action
391 * @return string
393 private function getAction() {
394 $q = [];
395 $q['action'] = 'delete';
397 if ( $this->oldimage ) {
398 $q['oldimage'] = $this->oldimage;
401 return $this->title->getLocalURL( $q );
405 * Extract the timestamp of the old version
407 * @return string
409 private function getTimestamp() {
410 return $this->oldfile->getTimestamp();