6dc8136d12
* Actions come in two flavours: the show-a-form-then-do-something-with-the-result (delete, protect, edit, etc) and the just-do-something (watch, rollback, patrol, etc). Create abstract base classes Action and FormlessAction to support these two cases. HTMLForm is an integral part of the form-based structure. * Look mum, no globals! :D Fully context-based. * Implement watch/unwatch, credits and delete actions in the new system as proof-of-concept. This also gives the delete frontend a much-needed overhaul. * Stub out the newly-deprecated functions from Article.php. This already reduces its linecount by about 15%, and there are plenty more actions still to do. * Centralising actions like this is going to render a lot of hooks type-incompatible. There's simply nowhere you can put the ArticleConfirmDelete hook, for instance, where it can be passed an OutputPage as the second parameter. On the other hand, we can implement new hooks like ActionModifyFormFields and ActionBeforeFormDisplay, which can do much prettier stuff to the forms, like adding extra fields the 'right' way. Update LiquidThreads to use these new hooks where appropriate.
337 lines
9.8 KiB
PHP
337 lines
9.8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* File deletion user interface
|
|
*
|
|
* @ingroup Media
|
|
* @author Rob Church <robchur@gmail.com>
|
|
*/
|
|
class FileDeleteForm {
|
|
|
|
private $title = null;
|
|
private $file = null;
|
|
|
|
private $oldfile = null;
|
|
private $oldimage = '';
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param $file File object we're deleting
|
|
*/
|
|
public function __construct( $file ) {
|
|
$this->title = $file->getTitle();
|
|
$this->file = $file;
|
|
}
|
|
|
|
/**
|
|
* Fulfil the request; shows the form or deletes the file,
|
|
* pending authentication, confirmation, etc.
|
|
*/
|
|
public function execute() {
|
|
global $wgOut, $wgRequest, $wgUser;
|
|
$this->setHeaders();
|
|
|
|
if( wfReadOnly() ) {
|
|
$wgOut->readOnlyPage();
|
|
return;
|
|
}
|
|
$permission_errors = $this->title->getUserPermissionsErrors('delete', $wgUser);
|
|
if (count($permission_errors)>0) {
|
|
$wgOut->showPermissionsErrorPage( $permission_errors );
|
|
return;
|
|
}
|
|
|
|
$this->oldimage = $wgRequest->getText( 'oldimage', false );
|
|
$token = $wgRequest->getText( 'wpEditToken' );
|
|
# Flag to hide all contents of the archived revisions
|
|
$suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed('suppressrevision');
|
|
|
|
if( $this->oldimage && !self::isValidOldSpec($this->oldimage) ) {
|
|
$wgOut->showUnexpectedValueError( 'oldimage', htmlspecialchars( $this->oldimage ) );
|
|
return;
|
|
}
|
|
if( $this->oldimage )
|
|
$this->oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $this->title, $this->oldimage );
|
|
|
|
if( !self::haveDeletableFile($this->file, $this->oldfile, $this->oldimage) ) {
|
|
$wgOut->addHTML( $this->prepareMessage( 'filedelete-nofile' ) );
|
|
$wgOut->addReturnTo( $this->title );
|
|
return;
|
|
}
|
|
|
|
// Perform the deletion if appropriate
|
|
if( $wgRequest->wasPosted() && $wgUser->matchEditToken( $token, $this->oldimage ) ) {
|
|
$this->DeleteReasonList = $wgRequest->getText( 'wpDeleteReasonList' );
|
|
$this->DeleteReason = $wgRequest->getText( 'wpReason' );
|
|
$reason = $this->DeleteReasonList;
|
|
if ( $reason != 'other' && $this->DeleteReason != '') {
|
|
// Entry from drop down menu + additional comment
|
|
$reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
|
|
} elseif ( $reason == 'other' ) {
|
|
$reason = $this->DeleteReason;
|
|
}
|
|
|
|
$status = self::doDelete( $this->title, $this->file, $this->oldimage, $reason, $suppress );
|
|
|
|
if( !$status->isGood() )
|
|
$wgOut->addWikiText( $status->getWikiText( 'filedeleteerror-short', 'filedeleteerror-long' ) );
|
|
if( $status->ok ) {
|
|
$wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
|
|
$wgOut->addHTML( $this->prepareMessage( 'filedelete-success' ) );
|
|
// Return to the main page if we just deleted all versions of the
|
|
// file, otherwise go back to the description page
|
|
$wgOut->addReturnTo( $this->oldimage ? $this->title : Title::newMainPage() );
|
|
}
|
|
return;
|
|
}
|
|
|
|
$this->showForm();
|
|
$this->showLogEntries();
|
|
}
|
|
|
|
/**
|
|
* Really delete the file
|
|
*
|
|
* @param $title Title object
|
|
* @param $file File object
|
|
* @param $oldimage String: archive name
|
|
* @param $reason String: reason of the deletion
|
|
* @param $suppress Boolean: whether to mark all deleted versions as restricted
|
|
*/
|
|
public static function doDelete( &$title, &$file, &$oldimage, $reason, $suppress ) {
|
|
global $wgUser;
|
|
$article = null;
|
|
$status = Status::newFatal( 'error' );
|
|
|
|
if( $oldimage ) {
|
|
$status = $file->deleteOld( $oldimage, $reason, $suppress );
|
|
if( $status->ok ) {
|
|
// Need to do a log item
|
|
$log = new LogPage( 'delete' );
|
|
$logComment = wfMsgForContent( 'deletedrevision', $oldimage );
|
|
if( trim( $reason ) != '' ) {
|
|
$logComment .= wfMsgForContent( 'colon-separator' ) . $reason;
|
|
}
|
|
$log->addEntry( 'delete', $title, $logComment );
|
|
}
|
|
} else {
|
|
$id = $title->getArticleID( Title::GAID_FOR_UPDATE );
|
|
$article = new Article( $title );
|
|
$error = '';
|
|
$dbw = wfGetDB( DB_MASTER );
|
|
try {
|
|
// delete the associated article first
|
|
if( $article->doDeleteArticle( $reason, $suppress, $id, false ) ) {
|
|
global $wgRequest;
|
|
if( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
|
|
Action::factory( 'watch', $article )->execute();
|
|
} elseif( $title->userIsWatching() ) {
|
|
Action::factory( 'unwatch', $article )->execute();
|
|
}
|
|
$status = $file->delete( $reason, $suppress );
|
|
if( $status->ok ) {
|
|
$dbw->commit();
|
|
wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $id ) );
|
|
} else {
|
|
$dbw->rollback();
|
|
}
|
|
}
|
|
} catch ( MWException $e ) {
|
|
// rollback before returning to prevent UI from displaying incorrect "View or restore N deleted edits?"
|
|
$dbw->rollback();
|
|
throw $e;
|
|
}
|
|
}
|
|
if( $status->isGood() )
|
|
wfRunHooks('FileDeleteComplete', array( &$file, &$oldimage, &$article, &$wgUser, &$reason));
|
|
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* Show the confirmation form
|
|
*/
|
|
private function showForm() {
|
|
global $wgOut, $wgUser, $wgRequest;
|
|
|
|
if( $wgUser->isAllowed( 'suppressrevision' ) ) {
|
|
$suppress = "<tr id=\"wpDeleteSuppressRow\">
|
|
<td></td>
|
|
<td class='mw-input'><strong>" .
|
|
Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
|
|
'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '3' ) ) .
|
|
"</strong></td>
|
|
</tr>";
|
|
} else {
|
|
$suppress = '';
|
|
}
|
|
|
|
$checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->title->userIsWatching();
|
|
$form = Xml::openElement( 'form', array( 'method' => 'post', 'action' => $this->getAction(),
|
|
'id' => 'mw-img-deleteconfirm' ) ) .
|
|
Xml::openElement( 'fieldset' ) .
|
|
Xml::element( 'legend', null, wfMsg( 'filedelete-legend' ) ) .
|
|
Html::hidden( 'wpEditToken', $wgUser->editToken( $this->oldimage ) ) .
|
|
$this->prepareMessage( 'filedelete-intro' ) .
|
|
Xml::openElement( 'table', array( 'id' => 'mw-img-deleteconfirm-table' ) ) .
|
|
"<tr>
|
|
<td class='mw-label'>" .
|
|
Xml::label( wfMsg( 'filedelete-comment' ), 'wpDeleteReasonList' ) .
|
|
"</td>
|
|
<td class='mw-input'>" .
|
|
Xml::listDropDown( 'wpDeleteReasonList',
|
|
wfMsgForContent( 'filedelete-reason-dropdown' ),
|
|
wfMsgForContent( 'filedelete-reason-otherlist' ), '', 'wpReasonDropDown', 1 ) .
|
|
"</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='mw-label'>" .
|
|
Xml::label( wfMsg( 'filedelete-otherreason' ), 'wpReason' ) .
|
|
"</td>
|
|
<td class='mw-input'>" .
|
|
Xml::input( 'wpReason', 60, $wgRequest->getText( 'wpReason' ),
|
|
array( 'type' => 'text', 'maxlength' => '255', 'tabindex' => '2', 'id' => 'wpReason' ) ) .
|
|
"</td>
|
|
</tr>
|
|
{$suppress}";
|
|
if( $wgUser->isLoggedIn() ) {
|
|
$form .= "
|
|
<tr>
|
|
<td></td>
|
|
<td class='mw-input'>" .
|
|
Xml::checkLabel( wfMsg( 'watchthis' ),
|
|
'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
|
|
"</td>
|
|
</tr>";
|
|
}
|
|
$form .= "
|
|
<tr>
|
|
<td></td>
|
|
<td class='mw-submit'>" .
|
|
Xml::submitButton( wfMsg( 'filedelete-submit' ),
|
|
array( 'name' => 'mw-filedelete-submit', 'id' => 'mw-filedelete-submit', 'tabindex' => '4' ) ) .
|
|
"</td>
|
|
</tr>" .
|
|
Xml::closeElement( 'table' ) .
|
|
Xml::closeElement( 'fieldset' ) .
|
|
Xml::closeElement( 'form' );
|
|
|
|
if ( $wgUser->isAllowed( 'editinterface' ) ) {
|
|
$skin = $wgUser->getSkin();
|
|
$title = Title::makeTitle( NS_MEDIAWIKI, 'Filedelete-reason-dropdown' );
|
|
$link = $skin->link(
|
|
$title,
|
|
wfMsgHtml( 'filedelete-edit-reasonlist' ),
|
|
array(),
|
|
array( 'action' => 'edit' )
|
|
);
|
|
$form .= '<p class="mw-filedelete-editreasons">' . $link . '</p>';
|
|
}
|
|
|
|
$wgOut->addHTML( $form );
|
|
}
|
|
|
|
/**
|
|
* Show deletion log fragments pertaining to the current file
|
|
*/
|
|
private function showLogEntries() {
|
|
global $wgOut;
|
|
$wgOut->addHTML( '<h2>' . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
|
|
LogEventsList::showLogExtract( $wgOut, 'delete', $this->title->getPrefixedText() );
|
|
}
|
|
|
|
/**
|
|
* Prepare a message referring to the file being deleted,
|
|
* showing an appropriate message depending upon whether
|
|
* it's a current file or an old version
|
|
*
|
|
* @param $message String: message base
|
|
* @return String
|
|
*/
|
|
private function prepareMessage( $message ) {
|
|
global $wgLang;
|
|
if( $this->oldimage ) {
|
|
return wfMsgExt(
|
|
"{$message}-old", # To ensure grep will find them: 'filedelete-intro-old', 'filedelete-nofile-old', 'filedelete-success-old'
|
|
'parse',
|
|
$this->title->getText(),
|
|
$wgLang->date( $this->getTimestamp(), true ),
|
|
$wgLang->time( $this->getTimestamp(), true ),
|
|
wfExpandUrl( $this->file->getArchiveUrl( $this->oldimage ) ) );
|
|
} else {
|
|
return wfMsgExt(
|
|
$message,
|
|
'parse',
|
|
$this->title->getText()
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set headers, titles and other bits
|
|
*/
|
|
private function setHeaders() {
|
|
global $wgOut, $wgUser;
|
|
$wgOut->setPageTitle( wfMsg( 'filedelete', $this->title->getText() ) );
|
|
$wgOut->setRobotPolicy( 'noindex,nofollow' );
|
|
$wgOut->setSubtitle( wfMsg(
|
|
'filedelete-backlink',
|
|
$wgUser->getSkin()->link(
|
|
$this->title,
|
|
null,
|
|
array(),
|
|
array(),
|
|
array( 'known', 'noclasses' )
|
|
)
|
|
) );
|
|
}
|
|
|
|
/**
|
|
* Is the provided `oldimage` value valid?
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function isValidOldSpec($oldimage) {
|
|
return strlen( $oldimage ) >= 16
|
|
&& strpos( $oldimage, '/' ) === false
|
|
&& strpos( $oldimage, '\\' ) === false;
|
|
}
|
|
|
|
/**
|
|
* Could we delete the file specified? If an `oldimage`
|
|
* value was provided, does it correspond to an
|
|
* existing, local, old version of this file?
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function haveDeletableFile(&$file, &$oldfile, $oldimage) {
|
|
return $oldimage
|
|
? $oldfile && $oldfile->exists() && $oldfile->isLocal()
|
|
: $file && $file->exists() && $file->isLocal();
|
|
}
|
|
|
|
/**
|
|
* Prepare the form action
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getAction() {
|
|
$q = array();
|
|
$q['action'] = 'delete';
|
|
|
|
if( $this->oldimage )
|
|
$q['oldimage'] = $this->oldimage;
|
|
|
|
return $this->title->getLocalUrl( $q );
|
|
}
|
|
|
|
/**
|
|
* Extract the timestamp of the old version
|
|
*
|
|
* @return string
|
|
*/
|
|
private function getTimestamp() {
|
|
return $this->oldfile->getTimestamp();
|
|
}
|
|
}
|