MediaWiki  1.23.2
ApiFileRevert.php
Go to the documentation of this file.
1 <?php
30 class ApiFileRevert extends ApiBase {
32  protected $file;
33 
35  protected $archiveName;
36 
38  protected $params;
39 
40  public function execute() {
41  $this->params = $this->extractRequestParams();
42  // Extract the file and archiveName from the request parameters
43  $this->validateParameters();
44 
45  // Check whether we're allowed to revert this file
46  $this->checkPermissions( $this->getUser() );
47 
48  $sourceUrl = $this->file->getArchiveVirtualUrl( $this->archiveName );
49  $status = $this->file->upload(
50  $sourceUrl,
51  $this->params['comment'],
52  $this->params['comment'],
53  0,
54  false,
55  false,
56  $this->getUser()
57  );
58 
59  if ( $status->isGood() ) {
60  $result = array( 'result' => 'Success' );
61  } else {
62  $result = array(
63  'result' => 'Failure',
64  'errors' => $this->getResult()->convertStatusToArray( $status ),
65  );
66  }
67 
68  $this->getResult()->addValue( null, $this->getModuleName(), $result );
69  }
70 
76  protected function checkPermissions( $user ) {
77  $title = $this->file->getTitle();
78  $permissionErrors = array_merge(
79  $title->getUserPermissionsErrors( 'edit', $user ),
80  $title->getUserPermissionsErrors( 'upload', $user )
81  );
82 
83  if ( $permissionErrors ) {
84  $this->dieUsageMsg( $permissionErrors[0] );
85  }
86  }
87 
92  protected function validateParameters() {
93  // Validate the input title
94  $title = Title::makeTitleSafe( NS_FILE, $this->params['filename'] );
95  if ( is_null( $title ) ) {
96  $this->dieUsageMsg( array( 'invalidtitle', $this->params['filename'] ) );
97  }
98  $localRepo = RepoGroup::singleton()->getLocalRepo();
99 
100  // Check if the file really exists
101  $this->file = $localRepo->newFile( $title );
102  if ( !$this->file->exists() ) {
103  $this->dieUsageMsg( 'notanarticle' );
104  }
105 
106  // Check if the archivename is valid for this file
107  $this->archiveName = $this->params['archivename'];
108  $oldFile = $localRepo->newFromArchiveName( $title, $this->archiveName );
109  if ( !$oldFile->exists() ) {
110  $this->dieUsageMsg( 'filerevert-badversion' );
111  }
112  }
113 
114  public function mustBePosted() {
115  return true;
116  }
117 
118  public function isWriteMode() {
119  return true;
120  }
121 
122  public function getAllowedParams() {
123  return array(
124  'filename' => array(
125  ApiBase::PARAM_TYPE => 'string',
126  ApiBase::PARAM_REQUIRED => true,
127  ),
128  'comment' => array(
129  ApiBase::PARAM_DFLT => '',
130  ),
131  'archivename' => array(
132  ApiBase::PARAM_TYPE => 'string',
133  ApiBase::PARAM_REQUIRED => true,
134  ),
135  'token' => array(
136  ApiBase::PARAM_TYPE => 'string',
138  ),
139  );
140  }
141 
142  public function getParamDescription() {
143  return array(
144  'filename' => 'Target filename without the File: prefix',
145  'token' => 'Edit token. You can get one of these through prop=info',
146  'comment' => 'Upload comment',
147  'archivename' => 'Archive name of the revision to revert to',
148  );
149  }
150 
151  public function getResultProperties() {
152  return array(
153  '' => array(
154  'result' => array(
156  'Success',
157  'Failure'
158  )
159  ),
160  'errors' => array(
161  ApiBase::PROP_TYPE => 'string',
162  ApiBase::PROP_NULLABLE => true
163  )
164  )
165  );
166  }
167 
168  public function getDescription() {
169  return array(
170  'Revert a file to an old version.'
171  );
172  }
173 
174  public function getPossibleErrors() {
175  return array_merge( parent::getPossibleErrors(),
176  array(
177  array( 'mustbeloggedin', 'upload' ),
178  array( 'badaccess-groups' ),
179  array( 'invalidtitle', 'title' ),
180  array( 'notanarticle' ),
181  array( 'filerevert-badversion' ),
182  )
183  );
184  }
185 
186  public function needsToken() {
187  return true;
188  }
189 
190  public function getTokenSalt() {
191  return '';
192  }
193 
194  public function getExamples() {
195  return array(
196  'api.php?action=filerevert&filename=Wiki.png&comment=Revert&' .
197  'archivename=20110305152740!Wiki.png&token=123ABC'
198  => 'Revert Wiki.png to the version of 20110305152740',
199  );
200  }
201 }
ApiFileRevert\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiFileRevert.php:115
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:53
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiFileRevert\checkPermissions
checkPermissions( $user)
Checks that the user has permissions to perform this revert.
Definition: ApiFileRevert.php:73
ApiBase\dieUsageMsg
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
ApiFileRevert\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiFileRevert.php:37
ApiFileRevert\needsToken
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiFileRevert.php:183
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
NS_FILE
const NS_FILE
Definition: Defines.php:85
ApiFileRevert
Definition: ApiFileRevert.php:30
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:132
ApiFileRevert\$params
array $params
Definition: ApiFileRevert.php:35
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiFileRevert\$file
LocalFile $file
Definition: ApiFileRevert.php:31
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:93
ApiFileRevert\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiFileRevert.php:111
ApiFileRevert\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiFileRevert.php:165
ApiFileRevert\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiFileRevert.php:191
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiBase\PROP_TYPE
const PROP_TYPE
Definition: ApiBase.php:74
LocalFile
Class to represent a local file in the wiki's own database.
Definition: LocalFile.php:46
ApiFileRevert\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiFileRevert.php:148
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:422
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
ApiBase\PROP_NULLABLE
const PROP_NULLABLE
Definition: ApiBase.php:76
ApiFileRevert\getPossibleErrors
getPossibleErrors()
Returns a list of all possible errors returned by the module.
Definition: ApiFileRevert.php:171
$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:237
ApiFileRevert\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiFileRevert.php:119
ApiFileRevert\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiFileRevert.php:139
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiFileRevert\getTokenSalt
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiFileRevert.php:187
ApiFileRevert\$archiveName
string $archiveName
Definition: ApiFileRevert.php:33
ApiFileRevert\validateParameters
validateParameters()
Validate the user parameters and set $this->archiveName and $this->file.
Definition: ApiFileRevert.php:89