MediaWiki  REL1_31
ApiRollback.php
Go to the documentation of this file.
1 <?php
26 class ApiRollback extends ApiBase {
27 
31  private $mTitleObj = null;
32 
36  private $mUser = null;
37 
38  public function execute() {
40 
41  $user = $this->getUser();
42  $params = $this->extractRequestParams();
43 
44  $titleObj = $this->getRbTitle( $params );
45  $pageObj = WikiPage::factory( $titleObj );
46  $summary = $params['summary'];
47  $details = [];
48 
49  // If change tagging was requested, check that the user is allowed to tag,
50  // and the tags are valid
51  if ( $params['tags'] ) {
53  if ( !$tagStatus->isOK() ) {
54  $this->dieStatus( $tagStatus );
55  }
56  }
57 
58  $retval = $pageObj->doRollback(
59  $this->getRbUser( $params ),
60  $summary,
61  $params['token'],
62  $params['markbot'],
63  $details,
64  $user,
65  $params['tags']
66  );
67 
68  if ( $retval ) {
69  $this->dieStatus( $this->errorArrayToStatus( $retval, $user ) );
70  }
71 
72  $watch = 'preferences';
73  if ( isset( $params['watchlist'] ) ) {
74  $watch = $params['watchlist'];
75  }
76 
77  // Watch pages
78  $this->setWatch( $watch, $titleObj, 'watchrollback' );
79 
80  $info = [
81  'title' => $titleObj->getPrefixedText(),
82  'pageid' => intval( $details['current']->getPage() ),
83  'summary' => $details['summary'],
84  'revid' => intval( $details['newid'] ),
85  // The revision being reverted (previously the current revision of the page)
86  'old_revid' => intval( $details['current']->getID() ),
87  // The revision being restored (the last revision before revision(s) by the reverted user)
88  'last_revid' => intval( $details['target']->getID() )
89  ];
90 
91  $this->getResult()->addValue( null, $this->getModuleName(), $info );
92  }
93 
94  public function mustBePosted() {
95  return true;
96  }
97 
98  public function isWriteMode() {
99  return true;
100  }
101 
102  public function getAllowedParams() {
103  return [
104  'title' => null,
105  'pageid' => [
106  ApiBase::PARAM_TYPE => 'integer'
107  ],
108  'tags' => [
109  ApiBase::PARAM_TYPE => 'tags',
110  ApiBase::PARAM_ISMULTI => true,
111  ],
112  'user' => [
113  ApiBase::PARAM_TYPE => 'user',
115  ],
116  'summary' => '',
117  'markbot' => false,
118  'watchlist' => [
119  ApiBase::PARAM_DFLT => 'preferences',
121  'watch',
122  'unwatch',
123  'preferences',
124  'nochange'
125  ],
126  ],
127  'token' => [
128  // Standard definition automatically inserted
129  ApiBase::PARAM_HELP_MSG_APPEND => [ 'api-help-param-token-webui' ],
130  ],
131  ];
132  }
133 
134  public function needsToken() {
135  return 'rollback';
136  }
137 
143  private function getRbUser( array $params ) {
144  if ( $this->mUser !== null ) {
145  return $this->mUser;
146  }
147 
148  // We need to be able to revert IPs, but getCanonicalName rejects them
149  $this->mUser = User::isIP( $params['user'] )
150  ? $params['user']
151  : User::getCanonicalName( $params['user'] );
152  if ( !$this->mUser ) {
153  $this->dieWithError( [ 'apierror-invaliduser', wfEscapeWikiText( $params['user'] ) ] );
154  }
155 
156  return $this->mUser;
157  }
158 
164  private function getRbTitle( array $params ) {
165  if ( $this->mTitleObj !== null ) {
166  return $this->mTitleObj;
167  }
168 
169  $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
170 
171  if ( isset( $params['title'] ) ) {
172  $this->mTitleObj = Title::newFromText( $params['title'] );
173  if ( !$this->mTitleObj || $this->mTitleObj->isExternal() ) {
174  $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ] );
175  }
176  } elseif ( isset( $params['pageid'] ) ) {
177  $this->mTitleObj = Title::newFromID( $params['pageid'] );
178  if ( !$this->mTitleObj ) {
179  $this->dieWithError( [ 'apierror-nosuchpageid', $params['pageid'] ] );
180  }
181  }
182 
183  if ( !$this->mTitleObj->exists() ) {
184  $this->dieWithError( 'apierror-missingtitle' );
185  }
186 
187  return $this->mTitleObj;
188  }
189 
190  protected function getExamplesMessages() {
191  return [
192  'action=rollback&title=Main%20Page&user=Example&token=123ABC' =>
193  'apihelp-rollback-example-simple',
194  'action=rollback&title=Main%20Page&user=192.0.2.5&' .
195  'token=123ABC&summary=Reverting%20vandalism&markbot=1' =>
196  'apihelp-rollback-example-summary',
197  ];
198  }
199 
200  public function getHelpUrls() {
201  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Rollback';
202  }
203 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:111
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ApiRollback\$mUser
User $mUser
Definition: ApiRollback.php:36
ApiRollback
Definition: ApiRollback.php:26
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiRollback\$mTitleObj
Title $mTitleObj
Definition: ApiRollback.php:31
$params
$params
Definition: styleTest.css.php:40
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiBase\PARAM_HELP_MSG_APPEND
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:131
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiRollback\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiRollback.php:38
ApiRollback\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiRollback.php:94
ApiRollback\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiRollback.php:190
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
ApiRollback\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiRollback.php:98
ApiRollback\getRbTitle
getRbTitle(array $params)
Definition: ApiRollback.php:164
User\isIP
static isIP( $name)
Does the string match an anonymous IP address?
Definition: User.php:943
ApiRollback\getRbUser
getRbUser(array $params)
Definition: ApiRollback.php:143
ApiBase\setWatch
setWatch( $watch, $titleObj, $userOption=null)
Set a watch (or unwatch) based the based on a watchlist parameter.
Definition: ApiBase.php:1656
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiBase\useTransactionalTimeLimit
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: ApiBase.php:2643
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
ApiBase\requireOnlyOneParameter
requireOnlyOneParameter( $params, $required)
Die if none or more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:785
ChangeTags\canAddTagsAccompanyingChange
static canAddTagsAccompanyingChange(array $tags, User $user=null)
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the cha...
Definition: ChangeTags.php:483
ApiRollback\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiRollback.php:200
Title
Represents a title within MediaWiki.
Definition: Title.php:39
ApiRollback\needsToken
needsToken()
Returns the token type this module requires in order to execute.
Definition: ApiRollback.php:134
User\getCanonicalName
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition: User.php:1210
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
ApiBase\dieStatus
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:1960
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
ApiRollback\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiRollback.php:102
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Title\newFromID
static newFromID( $id, $flags=0)
Create a new Title from an article ID.
Definition: Title.php:416
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
ApiBase\errorArrayToStatus
errorArrayToStatus(array $errors, User $user=null)
Turn an array of message keys or key+param arrays into a Status.
Definition: ApiBase.php:1766