<?php
/**
- * API for MediaWiki 1.8+
+ *
*
* Created on Jun 30, 2007
*
- * 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
* @file
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- // Eclipse helper - will be ignored in production
- require_once( "ApiBase.php" );
-}
-
/**
* API module that facilitates deleting pages. The API equivalent of action=delete.
* Requires API write mode to be enabled.
* @ingroup API
*/
class ApiDelete extends ApiBase {
-
- public function __construct( $main, $action ) {
- parent::__construct( $main, $action );
- }
-
/**
- * Extracts the title, token, and reason from the request parameters and invokes
+ * Extracts the title and reason from the request parameters and invokes
* the local delete() function with these as arguments. It does not make use of
* the delete function specified by Article.php. If the deletion succeeds, the
* details of the article deleted and the reason for deletion are added to the
* result object.
*/
public function execute() {
- $params = $this->extractRequestParams();
+ $this->useTransactionalTimeLimit();
- $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
+ $params = $this->extractRequestParams();
- if ( isset( $params['title'] ) ) {
- $titleObj = Title::newFromText( $params['title'] );
- if ( !$titleObj ) {
- $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
- }
- } elseif ( isset( $params['pageid'] ) ) {
- $titleObj = Title::newFromID( $params['pageid'] );
- if ( !$titleObj ) {
- $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
- }
- }
- if ( !$titleObj->exists() ) {
- $this->dieUsageMsg( array( 'notanarticle' ) );
+ $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
+ $titleObj = $pageObj->getTitle();
+ if ( !$pageObj->exists() &&
+ !( $titleObj->getNamespace() == NS_FILE && self::canDeleteFile( $pageObj->getFile() ) )
+ ) {
+ $this->dieWithError( 'apierror-missingtitle' );
}
- $reason = ( isset( $params['reason'] ) ? $params['reason'] : null );
- 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
- }
- } else {
- $articleObj = new Article( $titleObj );
- $retval = self::delete( $articleObj, $params['token'], $reason );
+ $reason = $params['reason'];
+ $user = $this->getUser();
- if ( count( $retval ) ) {
- $this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
- }
+ // Check that the user is allowed to carry out the deletion
+ $this->checkTitleUserPermissions( $titleObj, 'delete' );
- // Deprecated parameters
- if ( $params['watch'] ) {
- $watch = 'watch';
- } elseif ( $params['unwatch'] ) {
- $watch = 'unwatch';
- } else {
- $watch = $params['watchlist'];
+ // If change tagging was requested, check that the user is allowed to tag,
+ // and the tags are valid
+ if ( count( $params['tags'] ) ) {
+ $tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
+ if ( !$tagStatus->isOK() ) {
+ $this->dieStatus( $tagStatus );
}
- $this->setWatch( $watch, $titleObj, 'watchdeletion' );
}
- $r = array( 'title' => $titleObj->getPrefixedText(), 'reason' => $reason );
- $this->getResult()->addValue( null, $this->getModuleName(), $r );
- }
+ if ( $titleObj->getNamespace() == NS_FILE ) {
+ $status = self::deleteFile(
+ $pageObj,
+ $user,
+ $params['oldimage'],
+ $reason,
+ false,
+ $params['tags']
+ );
+ } else {
+ $status = self::delete( $pageObj, $user, $reason, $params['tags'] );
+ }
- /**
- *
- * @param &$title Title
- * @param $token String
- */
- private static function getPermissionsError( &$title, $token ) {
- global $wgUser;
+ if ( !$status->isGood() ) {
+ $this->dieStatus( $status );
+ }
- // Check permissions
- $errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
- if ( count( $errors ) > 0 ) {
- return $errors;
+ // Deprecated parameters
+ if ( $params['watch'] ) {
+ $watch = 'watch';
+ } elseif ( $params['unwatch'] ) {
+ $watch = 'unwatch';
+ } else {
+ $watch = $params['watchlist'];
}
+ $this->setWatch( $watch, $titleObj, 'watchdeletion' );
- return array();
+ $r = [
+ 'title' => $titleObj->getPrefixedText(),
+ 'reason' => $reason,
+ 'logid' => $status->value
+ ];
+ $this->getResult()->addValue( null, $this->getModuleName(), $r );
}
/**
* We have our own delete() function, since Article.php's implementation is split in two phases
*
- * @param $article Article object to work on
- * @param $token String: delete token (same as edit token)
- * @param $reason String: reason for the deletion. Autogenerated if NULL
- * @return Title::getUserPermissionsErrors()-like array
+ * @param Page|WikiPage $page Page or WikiPage object to work on
+ * @param User $user User doing the action
+ * @param string|null &$reason Reason for the deletion. Autogenerated if null
+ * @param array $tags Tags to tag the deletion with
+ * @return Status
*/
- 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 );
- if ( count( $errors ) ) {
- return $errors;
- }
+ protected static function delete( Page $page, User $user, &$reason = null, $tags = [] ) {
+ $title = $page->getTitle();
// Auto-generate a summary, if necessary
if ( is_null( $reason ) ) {
// Need to pass a throwaway variable because generateReason expects
// a reference
$hasHistory = false;
- $reason = $article->generateReason( $hasHistory );
+ $reason = $page->getAutoDeleteReason( $hasHistory );
if ( $reason === false ) {
- return array( array( 'cannotdelete' ) );
+ return Status::newFatal( 'cannotdelete', $title->getPrefixedText() );
}
}
$error = '';
- if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, &$error ) ) ) {
- return array( 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() ) );
- return array();
- }
- return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
+ return $page->doDeleteArticleReal( $reason, false, 0, true, $error, $user, $tags );
}
/**
- * @static
- * @param $token
- * @param $title
- * @param $oldimage
- * @param $reason
- * @param $suppress bool
- * @return \type|array|Title
+ * @param File $file
+ * @return bool
*/
- public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
- $errors = self::getPermissionsError( $title, $token );
- if ( count( $errors ) ) {
- return $errors;
- }
+ protected static function canDeleteFile( File $file ) {
+ return $file->exists() && $file->isLocal() && !$file->getRedirected();
+ }
- if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
- return array( array( 'invalidoldimage' ) );
+ /**
+ * @param Page $page Object to work on
+ * @param User $user User doing the action
+ * @param string $oldimage Archive name
+ * @param string &$reason Reason for the deletion. Autogenerated if null.
+ * @param bool $suppress Whether to mark all deleted versions as restricted
+ * @param array $tags Tags to tag the deletion with
+ * @return Status
+ */
+ protected static function deleteFile( Page $page, User $user, $oldimage,
+ &$reason = null, $suppress = false, $tags = []
+ ) {
+ $title = $page->getTitle();
+
+ $file = $page->getFile();
+ if ( !self::canDeleteFile( $file ) ) {
+ return self::delete( $page, $user, $reason, $tags );
}
- $file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
- $oldfile = false;
-
if ( $oldimage ) {
+ if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
+ return Status::newFatal( 'invalidoldimage' );
+ }
$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
+ if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
+ return Status::newFatal( 'nodeleteablefile' );
+ }
}
- 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() ) );
- }
-
- return array();
+ return FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress, $user, $tags );
}
public function mustBePosted() {
}
public function getAllowedParams() {
- return array(
+ return [
'title' => null,
- 'pageid' => array(
+ 'pageid' => [
ApiBase::PARAM_TYPE => 'integer'
- ),
- 'token' => null,
+ ],
'reason' => null,
- 'watch' => array(
+ 'tags' => [
+ ApiBase::PARAM_TYPE => 'tags',
+ ApiBase::PARAM_ISMULTI => true,
+ ],
+ 'watch' => [
ApiBase::PARAM_DFLT => false,
ApiBase::PARAM_DEPRECATED => true,
- ),
- 'watchlist' => array(
+ ],
+ 'watchlist' => [
ApiBase::PARAM_DFLT => 'preferences',
- ApiBase::PARAM_TYPE => array(
+ ApiBase::PARAM_TYPE => [
'watch',
'unwatch',
'preferences',
'nochange'
- ),
- ),
- 'unwatch' => array(
+ ],
+ ],
+ 'unwatch' => [
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 {$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',
- '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 'Delete a page';
- }
-
- public function getPossibleErrors() {
- return array_merge( parent::getPossibleErrors(), array(
- array( 'invalidtitle', 'title' ),
- array( 'nosuchpageid', 'pageid' ),
- array( 'notanarticle' ),
- array( 'hookaborted', 'error' ),
- ) );
+ ];
}
public function needsToken() {
- return true;
+ return 'csrf';
}
- public function getTokenSalt() {
- return '';
+ protected function getExamplesMessages() {
+ return [
+ 'action=delete&title=Main%20Page&token=123ABC'
+ => 'apihelp-delete-example-simple',
+ 'action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
+ => 'apihelp-delete-example-reason',
+ ];
}
- protected 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'
- );
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Delete';
}
-
- public function getVersion() {
- return __CLASS__ . ': $Id$';
- }
-}
\ No newline at end of file
+}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff