-<?php\r
-\r
-/*\r
- * Created on Jun 20, 2007\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiRollback extends ApiBase {\r
-\r
- public function __construct($main, $action) {\r
- parent :: __construct($main, $action);\r
- }\r
-\r
- public function execute() {\r
- global $wgUser;\r
- $this->getMain()->equestWriteMode();\r
- $params = $this->extractRequestParams();\r
- \r
- $titleObj = NULL;\r
- if(!isset($params['title']))\r
- $this->dieUsage('The title parameter must be set', 'notitle');\r
- if(!isset($params['user']))\r
- $this->dieUsage('The user parameter must be set', 'nouser');\r
- if(!isset($params['token']))\r
- $this->dieUsage('The token parameter must be set', 'notoken');\r
-\r
- // doRollback() also checks for these, but we wanna save some work\r
- if($wgUser->isBlocked())\r
- $this->dieUsage('You have been blocked from editing', 'blocked');\r
- if(wfReadOnly())\r
- $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-\r
- $titleObj = Title::newFromText($params['title']);\r
- if(!$titleObj)\r
- $this->dieUsage("Bad title ``{$params['title']}''", 'invalidtitle');\r
- if(!$titleObj->userCan('rollback'))\r
- $this->dieUsage('You don\'t have permission to rollback', 'permissiondenied');\r
-\r
- $username = User::getCanonicalName($params['user']);\r
- if(!$username)\r
- $this->dieUsage("Invalid username ``{$params['user']}''", 'invaliduser');\r
-\r
- $articleObj = new Article($titleObj);\r
- $summary = (isset($params['summary']) ? $params['summary'] : "");\r
- $details = NULL;\r
- $dbw = wfGetDb(DB_MASTER);\r
- $dbw->begin();\r
- $retval = $articleObj->doRollback($username, $summary, $params['token'], $params['markbot'], &$details);\r
-\r
- switch($retval)\r
- {\r
- case Article::SUCCESS:\r
- break; // We'll deal with that later\r
- case Article::PERM_DENIED:\r
- $this->dieUsage("You don't have permission to rollback", 'permissiondenied');\r
- case Article::BLOCKED: // If we get BLOCKED or PERM_DENIED that's very weird, but it's possible\r
- $this->dieUsage('You have been blocked from editing', 'blocked');\r
- case Article::READONLY:\r
- $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
- case Article::BAD_TOKEN:\r
- $this->dieUsage('Invalid token', 'badtoken');\r
- case Article::BAD_TITLE:\r
- $this->dieUsage("``{$params['title']}'' doesn't exist", 'missingtitle');\r
- case Article::ALREADYROLLED:\r
- $current = $details['current'];\r
- $currentID = $current->getId();\r
- $this->dieUsage("The edit(s) you tried to rollback is/are already rolled back." .\r
- "The current revision ID is ``$currentID''", 'alreadyrolled');\r
- case Article::ONLY_AUTHOR:\r
- $this->dieUsage("User ``$username'' is the only author of the page", 'onlyauthor');\r
- case Article::RATE_LIMITED:\r
- $this->dieUsage("You can't rollback too many articles in too short a time. Please wait a little while and try again", 'ratelimited');\r
- default:\r
- // rollback() has apparently invented a new error, which is extremely weird\r
- $this->dieDebug(__METHOD__, "rollback() returned an unknown error ($retval)");\r
- }\r
- // $retval has to be Article::SUCCESS if we get here\r
- $dbw->commit();\r
- $current = $target = $summary = NULL;\r
- extract($details);\r
-\r
- $info = array(\r
- 'title' => $titleObj->getPrefixedText(),\r
- 'pageid' => $current->getPage(),\r
- 'summary' => $summary,\r
- 'revid' => $titleObj->getLatestRevID(),\r
- 'old_revid' => $current->getID(),\r
- 'last_revid' => $target->getID()\r
- );\r
-\r
- $this->getResult()->addValue(null, $this->getModuleName(), $info);\r
- }\r
-\r
- protected function getAllowedParams() {\r
- return array (\r
- 'title' => null,\r
- 'user' => null,\r
- 'token' => null,\r
- 'summary' => null,\r
- 'markbot' => false\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'title' => 'Title of the page you want to rollback.',\r
- 'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',\r
- 'token' => 'A rollback token previously retrieved through prop=info',\r
- 'summary' => 'Custom edit summary. If not set, default summary will be used.',\r
- 'markbot' => 'Mark the reverted edits and the revert as bot edits'\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return array(\r
- 'Undoes the last edit to the page. If the last user who edited the page made multiple edits in a row,',\r
- 'they will all be rolled back. You need to be logged in as a sysop to use this function, see also action=login.'\r
- );\r
- }\r
-\r
- protected function getExamples() {\r
- return array (\r
- 'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',\r
- 'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'\r
- );\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id: ApiRollback.php 22289 2007-05-20 23:31:44Z yurik $';\r
- }\r
-}\r
+<?php
+/**
+ *
+ *
+ * Created on Jun 20, 2007
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * @ingroup API
+ */
+class ApiRollback extends ApiBase {
+
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
+ }
+
+ /**
+ * @var Title
+ */
+ private $mTitleObj = null;
+
+ /**
+ * @var User
+ */
+ private $mUser = null;
+
+ public function execute() {
+ $params = $this->extractRequestParams();
+
+ // User and title already validated in call to getTokenSalt from Main
+ $titleObj = $this->getRbTitle();
+ $pageObj = WikiPage::factory( $titleObj );
+ $summary = ( isset( $params['summary'] ) ? $params['summary'] : '' );
+ $details = array();
+ $retval = $pageObj->doRollback( $this->getRbUser(), $summary, $params['token'], $params['markbot'], $details, $this->getUser() );
+
+ if ( $retval ) {
+ // We don't care about multiple errors, just report one of them
+ $this->dieUsageMsg( reset( $retval ) );
+ }
+
+ $this->setWatch( $params['watchlist'], $titleObj );
+
+ $info = array(
+ 'title' => $titleObj->getPrefixedText(),
+ 'pageid' => intval( $details['current']->getPage() ),
+ 'summary' => $details['summary'],
+ 'revid' => intval( $details['newid'] ),
+ 'old_revid' => intval( $details['current']->getID() ),
+ 'last_revid' => intval( $details['target']->getID() )
+ );
+
+ $this->getResult()->addValue( null, $this->getModuleName(), $info );
+ }
+
+ public function mustBePosted() {
+ return true;
+ }
+
+ public function isWriteMode() {
+ return true;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'title' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true
+ ),
+ 'user' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true
+ ),
+ 'token' => null,
+ 'summary' => null,
+ 'markbot' => false,
+ 'watchlist' => array(
+ ApiBase::PARAM_DFLT => 'preferences',
+ ApiBase::PARAM_TYPE => array(
+ 'watch',
+ 'unwatch',
+ 'preferences',
+ 'nochange'
+ ),
+ ),
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'title' => 'Title of the page you want to rollback.',
+ 'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',
+ 'token' => "A rollback token previously retrieved through {$this->getModulePrefix()}prop=revisions",
+ 'summary' => 'Custom edit summary. If not set, default summary will be used',
+ 'markbot' => 'Mark the reverted edits and the revert as bot edits',
+ 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
+ );
+ }
+
+ public function getDescription() {
+ return array(
+ 'Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,',
+ 'they will all be rolled back'
+ );
+ }
+
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'invalidtitle', 'title' ),
+ array( 'notanarticle' ),
+ array( 'invaliduser', 'user' ),
+ ) );
+ }
+
+ public function needsToken() {
+ return true;
+ }
+
+ public function getTokenSalt() {
+ return array( $this->getRbTitle()->getPrefixedText(), $this->getRbUser() );
+ }
+
+ private function getRbUser() {
+ if ( $this->mUser !== null ) {
+ return $this->mUser;
+ }
+
+ $params = $this->extractRequestParams();
+
+ // We need to be able to revert IPs, but getCanonicalName rejects them
+ $this->mUser = User::isIP( $params['user'] )
+ ? $params['user']
+ : User::getCanonicalName( $params['user'] );
+ if ( !$this->mUser ) {
+ $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
+ }
+
+ return $this->mUser;
+ }
+
+ /**
+ * @return Title
+ */
+ private function getRbTitle() {
+ if ( $this->mTitleObj !== null ) {
+ return $this->mTitleObj;
+ }
+
+ $params = $this->extractRequestParams();
+
+ $this->mTitleObj = Title::newFromText( $params['title'] );
+
+ if ( !$this->mTitleObj ) {
+ $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
+ }
+ if ( !$this->mTitleObj->exists() ) {
+ $this->dieUsageMsg( 'notanarticle' );
+ }
+
+ return $this->mTitleObj;
+ }
+
+ public function getExamples() {
+ return array(
+ 'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
+ 'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&token=123ABC&summary=Reverting%20vandalism&markbot=1'
+ );
+ }
+
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Rollback';
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff