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 File 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();
38 } elseif( !$wgUser->isLoggedIn() ) {
39 $wgOut->showErrorPage( 'uploadnologin', 'uploadnologintext' );
41 } elseif( !$wgUser->isAllowed( 'delete' ) ) {
42 $wgOut->permissionRequired( 'delete' );
44 } elseif( $wgUser->isBlocked() ) {
45 $wgOut->blockedPage();
49 $this->oldimage
= $wgRequest->getText( 'oldimage', false );
50 $token = $wgRequest->getText( 'wpEditToken' );
51 # Flag to hide all contents of the archived revisions
52 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed('deleterevision');
54 if( $this->oldimage
&& !$this->isValidOldSpec() ) {
55 $wgOut->showUnexpectedValueError( 'oldimage', htmlspecialchars( $this->oldimage
) );
59 $this->oldfile
= RepoGroup
::singleton()->getLocalRepo()->newFromArchiveName( $this->title
, $this->oldimage
);
61 if( !$this->haveDeletableFile() ) {
62 $wgOut->addHtml( $this->prepareMessage( 'filedelete-nofile' ) );
63 $wgOut->addReturnTo( $this->title
);
67 // Perform the deletion if appropriate
68 if( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage
) ) {
69 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList' );
70 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
71 $reason = $this->DeleteReasonList
;
72 if ( $reason != 'other' && $this->DeleteReason
!= '') {
73 // Entry from drop down menu + additional comment
74 $reason .= ': ' . $this->DeleteReason
;
75 } elseif ( $reason == 'other' ) {
76 $reason = $this->DeleteReason
;
79 $status = self
::doDelete( $this->title
, $this->file
, $this->oldimage
, $reason, $suppress );
81 if( !$status->isGood() )
82 $wgOut->addWikiText( $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' ) );
84 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
85 $wgOut->addHtml( $this->prepareMessage( 'filedelete-success' ) );
86 // Return to the main page if we just deleted all versions of the
87 // file, otherwise go back to the description page
88 $wgOut->addReturnTo( $this->oldimage ?
$this->title
: Title
::newMainPage() );
94 $this->showLogEntries();
97 public static function doDelete( &$title, &$file, &$oldimage, $reason, $suppress ) {
100 $status = $file->deleteOld( $oldimage, $reason, $suppress );
102 // Need to do a log item
103 $log = new LogPage( 'delete' );
104 $logComment = wfMsgForContent( 'deletedrevision', $oldimage );
105 if( trim( $reason ) != '' )
106 $logComment .= ": {$reason}";
107 $log->addEntry( 'delete', $title, $logComment );
110 $status = $file->delete( $reason, $suppress );
112 // Need to delete the associated article
113 $article = new Article( $title );
114 if( wfRunHooks('ArticleDelete', array(&$article, &$wgUser, &$reason)) ) {
115 if( $article->doDeleteArticle( $reason, $suppress ) )
116 wfRunHooks('ArticleDeleteComplete', array(&$article, &$wgUser, $reason));
120 if( $status->isGood() ) wfRunHooks('FileDeleteComplete', array(
121 &$file, &$oldimage, &$article, &$wgUser, &$reason));
127 * Show the confirmation form
129 private function showForm() {
130 global $wgOut, $wgUser, $wgRequest, $wgContLang;
131 $align = $wgContLang->isRtl() ?
'left' : 'right';
133 if( $wgUser->isAllowed( 'deleterevision' ) ) {
134 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\"><td></td><td>";
135 $suppress .= Xml
::checkLabel( wfMsg( 'revdelete-suppress' ), 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '2' ) );
136 $suppress .= "</td></tr>";
141 $form = Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction() ) ) .
142 Xml
::openElement( 'fieldset' ) .
143 Xml
::element( 'legend', null, wfMsg( 'filedelete-legend' ) ) .
144 Xml
::hidden( 'wpEditToken', $wgUser->editToken( $this->oldimage
) ) .
145 $this->prepareMessage( 'filedelete-intro' ) .
146 Xml
::openElement( 'table' ) .
148 <td align='$align'>" .
149 Xml
::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' ) .
152 Xml
::listDropDown( 'wpDeleteReasonList',
153 wfMsgForContent( 'filedelete-reason-dropdown' ),
154 wfMsgForContent( 'filedelete-reason-otherlist' ), '', 'wpReasonDropDown', 1 ) .
158 <td align='$align'>" .
159 Xml
::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' ) .
162 Xml
::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ), array( 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ) ) .
169 Xml
::submitButton( wfMsg( 'filedelete-submit' ), array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit', 'tabindex' => '3' ) ) .
172 Xml
::closeElement( 'table' ) .
173 Xml
::closeElement( 'fieldset' ) .
174 Xml
::closeElement( 'form' );
176 if ( $wgUser->isAllowed( 'editinterface' ) ) {
177 $skin = $wgUser->getSkin();
178 $link = $skin->makeLink ( 'MediaWiki:Filedelete-reason-dropdown', wfMsgHtml( 'filedelete-edit-reasonlist' ) );
179 $form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
182 $wgOut->addHtml( $form );
186 * Show deletion log fragments pertaining to the current file
188 private function showLogEntries() {
190 $wgOut->addHtml( '<h2>' . htmlspecialchars( LogPage
::logName( 'delete' ) ) . "</h2>\n" );
191 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->title
->getPrefixedText() );
195 * Prepare a message referring to the file being deleted,
196 * showing an appropriate message depending upon whether
197 * it's a current file or an old version
199 * @param string $message Message base
202 private function prepareMessage( $message ) {
204 if( $this->oldimage
) {
205 $url = $this->file
->getArchiveUrl( $this->oldimage
);
207 "{$message}-old", # To ensure grep will find them: 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
209 $this->title
->getText(),
210 $wgLang->date( $this->getTimestamp(), true ),
211 $wgLang->time( $this->getTimestamp(), true ),
212 wfExpandUrl( $this->file
->getArchiveUrl( $this->oldimage
) ) );
217 $this->title
->getText()
223 * Set headers, titles and other bits
225 private function setHeaders() {
226 global $wgOut, $wgUser;
227 $wgOut->setPageTitle( wfMsg( 'filedelete', $this->title
->getText() ) );
228 $wgOut->setRobotPolicy( 'noindex,nofollow' );
229 $wgOut->setSubtitle( wfMsg( 'filedelete-backlink', $wgUser->getSkin()->makeKnownLinkObj( $this->title
) ) );
233 * Is the provided `oldimage` value valid?
237 private function isValidOldSpec() {
238 return strlen( $this->oldimage
) >= 16
239 && strpos( $this->oldimage
, '/' ) === false
240 && strpos( $this->oldimage
, '\\' ) === false;
244 * Could we delete the file specified? If an `oldimage`
245 * value was provided, does it correspond to an
246 * existing, local, old version of this file?
250 private function haveDeletableFile() {
251 return $this->oldimage
252 ?
$this->oldfile
&& $this->oldfile
->exists() && $this->oldfile
->isLocal()
253 : $this->file
&& $this->file
->exists() && $this->file
->isLocal();
257 * Prepare the form action
261 private function getAction() {
263 $q[] = 'action=delete';
264 if( $this->oldimage
)
265 $q[] = 'oldimage=' . urlencode( $this->oldimage
);
266 return $this->title
->getLocalUrl( implode( '&', $q ) );
270 * Extract the timestamp of the old version
274 private function getTimestamp() {
275 return $this->oldfile
->getTimestamp();