<?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' ) ) {
}
/**
- * 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 ( isset( $params['watch'] ) && params( $show['unwatch'] ) ) {
- $this->dieUsageMsg( array( 'show' ) );
- }
if ( isset( $params['title'] ) ) {
$titleObj = Title::newFromText( $params['title'] );
$this->dieUsageMsg( reset( $retval ) ); // We don't care about multiple errors, just report one of them
}
- if ( $params['watch'] || $wgUser->getOption( 'watchdeletion' ) ) {
- $articleObj->doWatch();
+ // Deprecated parameters
+ if ( $params['watch'] ) {
+ $watch = 'watch';
} elseif ( $params['unwatch'] ) {
- $articleObj->doUnwatch();
+ $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 );
}
+ /**
+ *
+ * @param &$title Title
+ * @param $token String
+ */
private static function getPermissionsError( &$title, $token ) {
global $wgUser;
}
$error = '';
- if ( !wfRunHooks( 'ArticleDelete', array( &$article, &$wgUser, &$reason, $error ) ) ) {
- $this->dieUsageMsg( array( 'hookaborted', $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
return array( array( 'cannotdelete', $article->mTitle->getPrefixedText() ) );
}
+ /**
+ * @static
+ * @param $token
+ * @param $title
+ * @param $oldimage
+ * @param $reason
+ * @param $suppress bool
+ * @return \type|array|Title
+ */
public static function deleteFile( $token, &$title, $oldimage, &$reason = null, $suppress = false ) {
$errors = self::getPermissionsError( $title, $token );
if ( count( $errors ) ) {
),
'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( 'code' => 'missingparam', 'info' => 'One of the parameters title, pageid is required' ),
+ array( 'code' => 'invalidparammix', 'info' => 'The parameters title, pageid can not be used together' ),
array( 'invalidtitle', 'title' ),
array( 'nosuchpageid', 'pageid' ),
array( 'notanarticle' ),
) );
}
+ public function needsToken() {
+ return true;
+ }
+
public function getTokenSalt() {
return '';
}