4 * File deletion user interface
7 * @author Rob Church <robchur@gmail.com>
11 private $title = null;
14 private $oldfile = null;
15 private $oldimage = '';
20 * @param $file File object we're deleting
22 public function __construct( $file ) {
23 $this->title
= $file->getTitle();
28 * Fulfil the request; shows the form or deletes the file,
29 * pending authentication, confirmation, etc.
31 public function execute() {
32 global $wgOut, $wgRequest, $wgUser;
36 $wgOut->readOnlyPage();
39 $permission_errors = $this->title
->getUserPermissionsErrors('delete', $wgUser);
40 if (count($permission_errors)>0) {
41 $wgOut->showPermissionsErrorPage( $permission_errors );
45 $this->oldimage
= $wgRequest->getText( 'oldimage', false );
46 $token = $wgRequest->getText( 'wpEditToken' );
47 # Flag to hide all contents of the archived revisions
48 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed('suppressrevision');
50 if( $this->oldimage
&& !self
::isValidOldSpec($this->oldimage
) ) {
51 $wgOut->showUnexpectedValueError( 'oldimage', htmlspecialchars( $this->oldimage
) );
55 $this->oldfile
= RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $this->title
, $this->oldimage
);
57 if( !self
::haveDeletableFile($this->file
, $this->oldfile
, $this->oldimage
) ) {
58 $wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
59 $wgOut->addReturnTo( $this->title
);
63 // Perform the deletion if appropriate
64 if( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage
) ) {
65 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList' );
66 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
67 $reason = $this->DeleteReasonList
;
68 if ( $reason != 'other' && $this->DeleteReason
!= '') {
69 // Entry from drop down menu + additional comment
70 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
71 } elseif ( $reason == 'other' ) {
72 $reason = $this->DeleteReason
;
75 $status = self
::doDelete( $this->title
, $this->file
, $this->oldimage
, $reason, $suppress );
77 if( !$status->isGood() )
78 $wgOut->addWikiText( $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' ) );
80 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
81 $wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
82 // Return to the main page if we just deleted all versions of the
83 // file, otherwise go back to the description page
84 $wgOut->addReturnTo( $this->oldimage ?
$this->title
: Title
::newMainPage() );
90 $this->showLogEntries();
94 * Really delete the file
96 * @param $title Title object
97 * @param $file File object
98 * @param $oldimage String: archive name
99 * @param $reason String: reason of the deletion
100 * @param $suppress Boolean: whether to mark all deleted versions as restricted
102 public static function doDelete( &$title, &$file, &$oldimage, $reason, $suppress ) {
105 $status = Status
::newFatal( 'error' );
108 $status = $file->deleteOld( $oldimage, $reason, $suppress );
110 // Need to do a log item
111 $log = new LogPage( 'delete' );
112 $logComment = wfMsgForContent( 'deletedrevision', $oldimage );
113 if( trim( $reason ) != '' ) {
114 $logComment .= wfMsgForContent( 'colon-separator' ) . $reason;
116 $log->addEntry( 'delete', $title, $logComment );
119 $id = $title->getArticleID( Title
::GAID_FOR_UPDATE
);
120 $article = new Article( $title );
121 $dbw = wfGetDB( DB_MASTER
);
123 // delete the associated article first
124 if( $article->doDeleteArticle( $reason, $suppress, $id, false ) ) {
126 if( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
127 Action
::factory( 'watch', $article )->execute();
128 } elseif( $title->userIsWatching() ) {
129 Action
::factory( 'unwatch', $article )->execute();
131 $status = $file->delete( $reason, $suppress );
134 wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $id ) );
139 } catch ( MWException
$e ) {
140 // rollback before returning to prevent UI from displaying incorrect "View or restore N deleted edits?"
145 if( $status->isGood() )
146 wfRunHooks('FileDeleteComplete', array( &$file, &$oldimage, &$article, &$wgUser, &$reason));
152 * Show the confirmation form
154 private function showForm() {
155 global $wgOut, $wgUser, $wgRequest;
157 if( $wgUser->isAllowed( 'suppressrevision' ) ) {
158 $suppress = "<tr id=\"wpDeleteSuppressRow\">
160 <td class='mw-input'><strong>" .
161 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
162 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '3' ) ) .
169 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->title
->userIsWatching();
170 $form = Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction(),
171 'id' => 'mw-img-deleteconfirm' ) ) .
172 Xml
::openElement( 'fieldset' ) .
173 Xml
::element( 'legend', null, wfMsg( 'filedelete-legend' ) ) .
174 Html
::hidden( 'wpEditToken', $wgUser->editToken( $this->oldimage
) ) .
175 $this->prepareMessage( 'filedelete-intro' ) .
176 Xml
::openElement( 'table', array( 'id' => 'mw-img-deleteconfirm-table' ) ) .
178 <td class='mw-label'>" .
179 Xml
::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' ) .
181 <td class='mw-input'>" .
182 Xml
::listDropDown( 'wpDeleteReasonList',
183 wfMsgForContent( 'filedelete-reason-dropdown' ),
184 wfMsgForContent( 'filedelete-reason-otherlist' ), '', 'wpReasonDropDown', 1 ) .
188 <td class='mw-label'>" .
189 Xml
::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' ) .
191 <td class='mw-input'>" .
192 Xml
::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
193 array( 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ) ) .
197 if( $wgUser->isLoggedIn() ) {
201 <td class='mw-input'>" .
202 Xml
::checkLabel( wfMsg( 'watchthis' ),
203 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
210 <td class='mw-submit'>" .
211 Xml
::submitButton( wfMsg( 'filedelete-submit' ),
212 array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit', 'tabindex' => '4' ) ) .
215 Xml
::closeElement( 'table' ) .
216 Xml
::closeElement( 'fieldset' ) .
217 Xml
::closeElement( 'form' );
219 if ( $wgUser->isAllowed( 'editinterface' ) ) {
220 $skin = $wgUser->getSkin();
221 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Filedelete-reason-dropdown' );
224 wfMsgHtml( 'filedelete-edit-reasonlist' ),
226 array( 'action' => 'edit' )
228 $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
231 $wgOut->addHTML( $form );
235 * Show deletion log fragments pertaining to the current file
237 private function showLogEntries() {
239 $wgOut->addHTML( '<h2>' . htmlspecialchars( LogPage
::logName( 'delete' ) ) . "</h2>\n" );
240 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->title
->getPrefixedText() );
244 * Prepare a message referring to the file being deleted,
245 * showing an appropriate message depending upon whether
246 * it's a current file or an old version
248 * @param $message String: message base
251 private function prepareMessage( $message ) {
253 if( $this->oldimage
) {
255 "{$message}-old", # To ensure grep will find them: 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
257 $this->title
->getText(),
258 $wgLang->date( $this->getTimestamp(), true ),
259 $wgLang->time( $this->getTimestamp(), true ),
260 wfExpandUrl( $this->file
->getArchiveUrl( $this->oldimage
) ) );
265 $this->title
->getText()
271 * Set headers, titles and other bits
273 private function setHeaders() {
274 global $wgOut, $wgUser;
275 $wgOut->setPageTitle( wfMsg( 'filedelete', $this->title
->getText() ) );
276 $wgOut->setRobotPolicy( 'noindex,nofollow' );
277 $wgOut->setSubtitle( wfMsg(
278 'filedelete-backlink',
279 $wgUser->getSkin()->link(
284 array( 'known', 'noclasses' )
290 * Is the provided `oldimage` value valid?
294 public static function isValidOldSpec($oldimage) {
295 return strlen( $oldimage ) >= 16
296 && strpos( $oldimage, '/' ) === false
297 && strpos( $oldimage, '\\' ) === false;
301 * Could we delete the file specified? If an `oldimage`
302 * value was provided, does it correspond to an
303 * existing, local, old version of this file?
307 public static function haveDeletableFile(&$file, &$oldfile, $oldimage) {
309 ?
$oldfile && $oldfile->exists() && $oldfile->isLocal()
310 : $file && $file->exists() && $file->isLocal();
314 * Prepare the form action
318 private function getAction() {
320 $q['action'] = 'delete';
322 if( $this->oldimage
)
323 $q['oldimage'] = $this->oldimage
;
325 return $this->title
->getLocalUrl( $q );
329 * Extract the timestamp of the old version
333 private function getTimestamp() {
334 return $this->oldfile
->getTimestamp();