<?php
-
/**
+ *
+ *
* Created on Jun 30, 2007
- * API for MediaWiki 1.8+
*
- * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- // Eclipse helper - will be ignored in production
- require_once( "ApiBase.php" );
-}
-
/**
- * API module that facilitates deleting pages. The API eqivalent of action=delete.
+ * API module that facilitates deleting pages. The API equivalent of action=delete.
* Requires API write mode to be enabled.
*
* @ingroup API
* result object.
*/
public function execute() {
- global $wgUser;
-
$params = $this->extractRequestParams();
$this->requireOnlyOneParameter( $params, 'title', 'pageid' );
}
}
if ( !$titleObj->exists() ) {
- $this->dieUsageMsg( array( 'notanarticle' ) );
+ $this->dieUsageMsg( 'notanarticle' );
}
$reason = ( isset( $params['reason'] ) ? $params['reason'] : null );
+ $pageObj = WikiPage::factory( $titleObj );
+ $user = $this->getUser();
+
if ( $titleObj->getNamespace() == NS_FILE ) {
- $retval = self::deleteFile( $params['token'], $titleObj, $params['oldimage'], $reason, false );
- if ( count( $retval ) ) {
- $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
- }
+ $retval = self::deleteFile( $pageObj, $user, $params['token'], $params['oldimage'], $reason, false );
} else {
- $articleObj = new Article( $titleObj );
- $retval = self::delete( $articleObj, $params['token'], $reason );
+ $retval = self::delete( $pageObj, $user, $params['token'], $reason );
+ }
- if ( count( $retval ) ) {
- $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
- }
+ if ( count( $retval ) ) {
+ $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
+ }
- if ( $params['watch'] || $wgUser->getOption( 'watchdeletion' ) ) {
- $articleObj->doWatch();
- } elseif ( $params['unwatch'] ) {
- $articleObj->doUnwatch();
- }
+ // Deprecated parameters
+ if ( $params['watch'] ) {
+ $watch = 'watch';
+ } elseif ( $params['unwatch'] ) {
+ $watch = 'unwatch';
+ } else {
+ $watch = $params['watchlist'];
}
+ $this->setWatch( $watch, $titleObj, 'watchdeletion' );
$r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
$this->getResult()->addValue( null, $this->getModuleName(), $r );
}
- private static function getPermissionsError( &$title, $token ) {
- global $wgUser;
-
+ /**
+ * @param $title Title
+ * @param $user User doing the action
+ * @param $token String
+ * @return array
+ */
+ private static function getPermissionsError( $title, $user, $token ) {
// Check permissions
- $errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
- if ( count( $errors ) > 0 ) {
- return $errors;
- }
-
- return array();
+ return $title->getUserPermissionsErrors( 'delete', $user );
}
/**
* We have our own delete() function, since Article.php's implementation is split in two phases
*
- * @param Article $article - Article object to work on
- * @param string $token - Delete token (same as edit token)
- * @param string $reason - Reason for the deletion. Autogenerated if NULL
+ * @param $page WikiPage object to work on
+ * @param $user User doing the action
+ * @param $token String: delete token (same as edit token)
+ * @param $reason String: reason for the deletion. Autogenerated if NULL
* @return Title::getUserPermissionsErrors()-like array
*/
- public static function delete( &$article, $token, &$reason = null ) {
- global $wgUser;
- if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
- global $wgDeleteRevisionsLimit;
- return array( array( 'delete-toobig', $wgDeleteRevisionsLimit ) );
- }
- $title = $article->getTitle();
- $errors = self::getPermissionsError( $title, $token );
+ public static function delete( Page $page, User $user, $token, &$reason = null ) {
+ $title = $page->getTitle();
+ $errors = self::getPermissionsError( $title, $user, $token );
if ( count( $errors ) ) {
return $errors;
}
// Need to pass a throwaway variable because generateReason expects
// a reference
$hasHistory = false;
- $reason = $article->generateReason( $hasHistory );
+ $reason = $page->getAutoDeleteReason( $hasHistory ); #FIXME: use ContentHandler::getAutoDeleteReason()
if ( $reason === false ) {
- return array( array( 'cannotdelete' ) );
+ return array( array( 'cannotdelete', $title->getPrefixedText() ) );
}
}
$error = '';
- if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $error ) ) ) {
- $this->dieUsageMsg( array( 'hookaborted', $error ) );
- }
-
// Luckily, Article.php provides a reusable delete function that does the hard work for us
- if ( $article->doDeleteArticle( $reason ) ) {
- wfRunHooks( 'ArticleDeleteComplete', array( &$article, &$wgUser, $reason, $article->getId() ) );
+ if ( $page->doDeleteArticle( $reason, false, 0, true, $error ) ) {
return array();
+ } else {
+ return array( array( 'cannotdelete', $title->getPrefixedText() ) );
}
- return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
}
- public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
- $errors = self::getPermissionsError( $title, $token );
+ /**
+ * @param $page WikiPage object to work on
+ * @param $user User doing the action
+ * @param $token
+ * @param $oldimage
+ * @param $reason
+ * @param $suppress bool
+ * @return array|Title
+ */
+ public static function deleteFile( Page $page, User $user, $token, $oldimage, &$reason = null, $suppress = false ) {
+ $title = $page->getTitle();
+ $errors = self::getPermissionsError( $title, $user, $token );
if ( count( $errors ) ) {
return $errors;
}
- if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
- return array( array( 'invalidoldimage' ) );
+ $file = $page->getFile();
+ if ( !$file->exists() || !$file->isLocal() || $file->getRedirected() ) {
+ return self::delete( $page, $user, $token, $reason );
}
- $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
- $oldfile = false;
-
if ( $oldimage ) {
+ if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
+ return array( array( 'invalidoldimage' ) );
+ }
$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
+ if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
+ return array( array( 'nodeleteablefile' ) );
+ }
+ } else {
+ $oldfile = false;
}
- if ( !FileDeleteForm::haveDeletableFile( $file, $oldfile, $oldimage ) ) {
- return self::delete( new Article( $title ), $token, $reason );
- }
if ( is_null( $reason ) ) { // Log and RC don't like null reasons
$reason = '';
}
$status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
-
if ( !$status->isGood() ) {
return array( array( 'cannotdelete', $title->getPrefixedText() ) );
}
),
'token' => null,
'reason' => null,
- 'watch' => false,
- 'unwatch' => false,
- 'oldimage' => null
+ 'watch' => array(
+ ApiBase::PARAM_DFLT => false,
+ ApiBase::PARAM_DEPRECATED => true,
+ ),
+ 'watchlist' => array(
+ ApiBase::PARAM_DFLT => 'preferences',
+ ApiBase::PARAM_TYPE => array(
+ 'watch',
+ 'unwatch',
+ 'preferences',
+ 'nochange'
+ ),
+ ),
+ 'unwatch' => array(
+ ApiBase::PARAM_DFLT => false,
+ ApiBase::PARAM_DEPRECATED => true,
+ ),
+ 'oldimage' => null,
);
}
public function getParamDescription() {
+ $p = $this->getModulePrefix();
return array(
- 'title' => 'Title of the page you want to delete. Cannot be used together with pageid',
- 'pageid' => 'Page ID of the page you want to delete. Cannot be used together with title',
+ 'title' => "Title of the page you want to delete. Cannot be used together with {$p}pageid",
+ 'pageid' => "Page ID of the page you want to delete. Cannot be used together with {$p}title",
'token' => 'A delete token previously retrieved through prop=info',
- 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used.',
+ 'reason' => 'Reason for the deletion. If not set, an automatically generated reason will be used',
'watch' => 'Add the page to your watchlist',
+ 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
'unwatch' => 'Remove the page from your watchlist',
'oldimage' => 'The name of the old image to delete as provided by iiprop=archivename'
);
}
public function getDescription() {
- return array(
- 'Delete a page.'
- );
+ return 'Delete a page';
}
public function getPossibleErrors() {
- return array_merge( parent::getPossibleErrors(), array(
- array( 'invalidtitle', 'title' ),
- array( 'nosuchpageid', 'pageid' ),
- array( 'notanarticle' ),
- array( 'hookaborted', 'error' ),
- ) );
+ return array_merge( parent::getPossibleErrors(),
+ $this->getRequireOnlyOneParameterErrorMessages( array( 'title', 'pageid' ) ),
+ array(
+ array( 'invalidtitle', 'title' ),
+ array( 'nosuchpageid', 'pageid' ),
+ array( 'notanarticle' ),
+ array( 'hookaborted', 'error' ),
+ array( 'delete-toobig', 'limit' ),
+ array( 'cannotdelete', 'title' ),
+ array( 'invalidoldimage' ),
+ array( 'nodeleteablefile' ),
+ )
+ );
+ }
+
+ public function needsToken() {
+ return true;
}
public function getTokenSalt() {
return '';
}
- protected function getExamples() {
+ public function getExamples() {
return array(
- 'api.php?action=delete&title=Main%20Page&token=123ABC',
- 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
+ 'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Delete the Main Page',
+ 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Delete the Main Page with the reason "Preparing for move"',
);
}
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Delete';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
-}
\ No newline at end of file
+}
dépôts / lhc / web / wiklou.git / blobdiff