<?php
-/*
+/**
* Created on Jun 30, 2007
* API for MediaWiki 1.8+
*
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
*
* 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
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ( "ApiBase.php" );
+ require_once( "ApiBase.php" );
}
/**
class ApiDelete extends ApiBase {
public function __construct( $main, $action ) {
- parent :: __construct( $main, $action );
+ parent::__construct( $main, $action );
}
/**
*/
public function execute() {
global $wgUser;
+
$params = $this->extractRequestParams();
$this->requireOnlyOneParameter( $params, 'title', 'pageid' );
- if ( !isset( $params['token'] ) )
- $this->dieUsageMsg( array( 'missingparam', 'token' ) );
- if ( isset( $params['title'] ) )
- {
+ if ( isset( $params['title'] ) ) {
$titleObj = Title::newFromText( $params['title'] );
- if ( !$titleObj )
+ if ( !$titleObj ) {
$this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
- }
- else if ( isset( $params['pageid'] ) )
- {
+ }
+ } elseif ( isset( $params['pageid'] ) ) {
$titleObj = Title::newFromID( $params['pageid'] );
- if ( !$titleObj )
+ if ( !$titleObj ) {
$this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
+ }
}
- if ( !$titleObj->exists() )
+ if ( !$titleObj->exists() ) {
$this->dieUsageMsg( array( 'notanarticle' ) );
+ }
$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 ) )
+ 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 );
-
- if ( count( $retval ) )
+
+ 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();
- else if ( $params['unwatch'] )
- $articleObj->doUnwatch();
+ $watch = 'nochange';
+ // 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 );
private static function getPermissionsError( &$title, $token ) {
global $wgUser;
-
+
// Check permissions
$errors = $title->getUserPermissionsErrors( 'delete', $wgUser );
- if ( count( $errors ) > 0 ) return $errors;
-
- // Check token
- if ( !$wgUser->matchEditToken( $token ) )
- return array( array( 'sessionfailure' ) );
+ if ( count( $errors ) > 0 ) {
+ return $errors;
+ }
+
return array();
}
/**
* 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 $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
*/
- public static function delete( &$article, $token, &$reason = null )
- {
+ public static function delete( &$article, $token, &$reason = null ) {
global $wgUser;
if ( $article->isBigDeletion() && !$wgUser->isAllowed( 'bigdelete' ) ) {
global $wgDeleteRevisionsLimit;
}
$title = $article->getTitle();
$errors = self::getPermissionsError( $title, $token );
- if ( count( $errors ) ) return $errors;
+ if ( count( $errors ) ) {
+ return $errors;
+ }
// Auto-generate a summary, if necessary
- if ( is_null( $reason ) )
- {
+ if ( is_null( $reason ) ) {
// Need to pass a throwaway variable because generateReason expects
// a reference
$hasHistory = false;
$reason = $article->generateReason( $hasHistory );
- if ( $reason === false )
+ if ( $reason === false ) {
return array( array( 'cannotdelete' ) );
+ }
}
$error = '';
- if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $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 ) ) {
return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
}
- public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false )
- {
+ public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
$errors = self::getPermissionsError( $title, $token );
- if ( count( $errors ) ) return $errors;
+ if ( count( $errors ) ) {
+ return $errors;
+ }
- if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) )
+ if ( $oldimage && !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
return array( array( 'invalidoldimage' ) );
+ }
$file = wfFindFile( $title, array( 'ignoreRedirect' => true ) );
$oldfile = false;
-
- if ( $oldimage )
+
+ if ( $oldimage ) {
$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
-
- if ( !FileDeleteForm::haveDeletableFile( $file, $oldfile, $oldimage ) )
+ }
+
+ 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
+ }
+ if ( is_null( $reason ) ) { // Log and RC don't like null reasons
$reason = '';
+ }
$status = FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress );
-
- if ( !$status->isGood() )
+
+ if ( !$status->isGood() ) {
return array( array( 'cannotdelete', $title->getPrefixedText() ) );
-
+ }
+
return array();
}
-
- public function mustBePosted() { return true; }
+
+ public function mustBePosted() {
+ return true;
+ }
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
- return array (
+ return array(
'title' => null,
'pageid' => array(
ApiBase::PARAM_TYPE => 'integer'
),
'token' => null,
'reason' => null,
- 'watch' => false,
+ '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' => false,
'oldimage' => null
);
}
public function getParamDescription() {
- 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',
+ $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.',
+ '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.'
+ 'Delete a page'
);
}
-
- public function getPossibleErrors() {
+
+ public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
- array( 'missingparam', 'token' ),
array( 'invalidtitle', 'title' ),
array( 'nosuchpageid', 'pageid' ),
array( 'notanarticle' ),
array( 'hookaborted', 'error' ),
- ) );
+ ) );
+ }
+
+ public function getTokenSalt() {
+ return '';
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=delete&title=Main%20Page&token=123ABC',
'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
);
dépôts / lhc / web / wiklou.git / blobdiff