MediaWiki  1.23.2
ApiRevisionDelete.php
Go to the documentation of this file.
1 <?php
32 class ApiRevisionDelete extends ApiBase {
33 
34  public function execute() {
35  $params = $this->extractRequestParams();
36  $user = $this->getUser();
37 
38  if ( !$user->isAllowed( RevisionDeleter::getRestriction( $params['type'] ) ) ) {
39  $this->dieUsageMsg( 'badaccess-group0' );
40  }
41 
42  if ( !$params['ids'] ) {
43  $this->dieUsage( "At least one value is required for 'ids'", 'badparams' );
44  }
45 
46  $hide = $params['hide'] ?: array();
47  $show = $params['show'] ?: array();
48  if ( array_intersect( $hide, $show ) ) {
49  $this->dieUsage( "Mutually exclusive values for 'hide' and 'show'", 'badparams' );
50  } elseif ( !$hide && !$show ) {
51  $this->dieUsage( "At least one value is required for 'hide' or 'show'", 'badparams' );
52  }
53  $bits = array(
54  'content' => RevisionDeleter::getRevdelConstant( $params['type'] ),
55  'comment' => Revision::DELETED_COMMENT,
56  'user' => Revision::DELETED_USER,
57  );
58  $bitfield = array();
59  foreach ( $bits as $key => $bit ) {
60  if ( in_array( $key, $hide ) ) {
61  $bitfield[$bit] = 1;
62  } elseif ( in_array( $key, $show ) ) {
63  $bitfield[$bit] = 0;
64  } else {
65  $bitfield[$bit] = -1;
66  }
67  }
68 
69  if ( $params['suppress'] === 'yes' ) {
70  if ( !$user->isAllowed( 'suppressrevision' ) ) {
71  $this->dieUsageMsg( 'badaccess-group0' );
72  }
73  $bitfield[Revision::DELETED_RESTRICTED] = 1;
74  } elseif ( $params['suppress'] === 'no' ) {
75  $bitfield[Revision::DELETED_RESTRICTED] = 0;
76  } else {
77  $bitfield[Revision::DELETED_RESTRICTED] = -1;
78  }
79 
80  $targetObj = null;
81  if ( $params['target'] ) {
82  $targetObj = Title::newFromText( $params['target'] );
83  }
84  $targetObj = RevisionDeleter::suggestTarget( $params['type'], $targetObj, $params['ids'] );
85  if ( $targetObj === null ) {
86  $this->dieUsage( 'A target title is required for this RevDel type', 'needtarget' );
87  }
88 
90  $params['type'], $this->getContext(), $targetObj, $params['ids']
91  );
92  $status = $list->setVisibility(
93  array( 'value' => $bitfield, 'comment' => $params['reason'], 'perItemStatus' => true )
94  );
95 
96  $result = $this->getResult();
97  $data = $this->extractStatusInfo( $status );
98  $data['target'] = $targetObj->getFullText();
99  $data['items'] = array();
100 
101  foreach ( $status->itemStatuses as $id => $s ) {
102  $data['items'][$id] = $this->extractStatusInfo( $s );
103  $data['items'][$id]['id'] = $id;
104  }
105 
106  $list->reloadFromMaster();
107  // @codingStandardsIgnoreStart Avoid function calls in a FOR loop test part
108  for ( $item = $list->reset(); $list->current(); $item = $list->next() ) {
109  $data['items'][$item->getId()] += $item->getApiData( $this->getResult() );
110  }
111  // @codingStandardsIgnoreEnd
112 
113  $data['items'] = array_values( $data['items'] );
114  $result->setIndexedTagName( $data['items'], 'i' );
115  $result->addValue( null, $this->getModuleName(), $data );
116  }
117 
118  private function extractStatusInfo( $status ) {
119  $ret = array(
120  'status' => $status->isOK() ? 'Success' : 'Fail',
121  );
122  $errors = $this->formatStatusMessages( $status->getErrorsByType( 'error' ) );
123  if ( $errors ) {
124  $this->getResult()->setIndexedTagName( $errors, 'e' );
125  $ret['errors'] = $errors;
126  }
127  $warnings = $this->formatStatusMessages( $status->getErrorsByType( 'warning' ) );
128  if ( $warnings ) {
129  $this->getResult()->setIndexedTagName( $warnings, 'w' );
130  $ret['warnings'] = $warnings;
131  }
132 
133  return $ret;
134  }
135 
136  private function formatStatusMessages( $messages ) {
137  if ( !$messages ) {
138  return array();
139  }
140  $result = $this->getResult();
141  $ret = array();
142  foreach ( $messages as $m ) {
143  $message = array();
144  if ( $m['message'] instanceof Message ) {
145  $msg = $m['message'];
146  $message = array( 'message' => $msg->getKey() );
147  if ( $msg->getParams() ) {
148  $message['params'] = $msg->getParams();
149  $result->setIndexedTagName( $message['params'], 'p' );
150  }
151  } else {
152  $message = array( 'message' => $m['message'] );
153  $msg = wfMessage( $m['message'] );
154  if ( isset( $m['params'] ) ) {
155  $message['params'] = $m['params'];
156  $result->setIndexedTagName( $message['params'], 'p' );
157  $msg->params( $m['params'] );
158  }
159  }
160  $message['rendered'] = $msg->useDatabase( false )->inLanguage( 'en' )->plain();
161  $ret[] = $message;
162  }
163 
164  return $ret;
165  }
166 
167  public function mustBePosted() {
168  return true;
169  }
170 
171  public function isWriteMode() {
172  return true;
173  }
174 
175  public function getAllowedParams() {
176  return array(
177  'type' => array(
180  ),
181  'target' => null,
182  'ids' => array(
183  ApiBase::PARAM_ISMULTI => true,
185  ),
186  'hide' => array(
187  ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
188  ApiBase::PARAM_ISMULTI => true,
189  ),
190  'show' => array(
191  ApiBase::PARAM_TYPE => array( 'content', 'comment', 'user' ),
192  ApiBase::PARAM_ISMULTI => true,
193  ),
194  'suppress' => array(
195  ApiBase::PARAM_TYPE => array( 'yes', 'no', 'nochange' ),
196  ApiBase::PARAM_DFLT => 'nochange',
197  ),
198  'token' => array(
199  ApiBase::PARAM_TYPE => 'string',
201  ),
202  'reason' => null,
203  );
204  }
205 
206  public function getParamDescription() {
207  return array(
208  'type' => 'Type of revision deletion being performed',
209  'target' => 'Page title for the revision deletion, if required for the type',
210  'ids' => 'Identifiers for the revisions to be deleted',
211  'hide' => 'What to hide for each revision',
212  'show' => 'What to unhide for each revision',
213  'suppress' => 'Whether to suppress data from administrators as well as others',
214  'token' => 'A delete token previously retrieved through action=tokens',
215  'reason' => 'Reason for the deletion/undeletion',
216  );
217  }
218 
219  public function getDescription() {
220  return 'Delete/undelete revisions.';
221  }
222 
223  public function getPossibleErrors() {
224  return array_merge( parent::getPossibleErrors(),
225  array(
226  array( 'code' => 'needtarget',
227  'info' => 'A target title is required for this RevDel type' ),
228  array( 'code' => 'badparams', 'info' => 'Bad value for some parameter' ),
229  )
230  );
231  }
232 
233  public function needsToken() {
234  return true;
235  }
236 
237  public function getTokenSalt() {
238  return '';
239  }
240 
241  public function getExamples() {
242  return array(
243  'api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&' .
244  'hide=content&token=123ABC'
245  => 'Hide content for revision 12345 on the Main Page',
246  'api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&' .
247  'reason=BLP%20violation&token=123ABC'
248  => 'Hide all data on log entry 67890 with the reason "BLP violation"',
249  );
250  }
251 
252  public function getHelpUrls() {
253  return 'https://www.mediawiki.org/wiki/API:Revisiondelete';
254  }
255 }
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:67
Revision\DELETED_RESTRICTED
const DELETED_RESTRICTED
Definition: Revision.php:68
$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
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:189
ContextSource\getContext
getContext()
Get the RequestContext object.
Definition: ContextSource.php:40
Revision\DELETED_COMMENT
const DELETED_COMMENT
Definition: Revision.php:66
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
ApiBase\dieUsageMsg
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
$ret
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 & $ret
Definition: hooks.txt:1530
ApiRevisionDelete\getTokenSalt
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiRevisionDelete.php:237
$params
$params
Definition: styleTest.css.php:40
ApiRevisionDelete\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiRevisionDelete.php:175
$s
$s
Definition: mergeMessageFileList.php:156
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:132
$messages
$messages
Definition: LogTests.i18n.php:8
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiRevisionDelete
API interface to RevDel.
Definition: ApiRevisionDelete.php:32
RevisionDeleter\getTypes
static getTypes()
Lists the valid possible types for revision deletion.
Definition: RevisionDeleter.php:54
ApiRevisionDelete\getPossibleErrors
getPossibleErrors()
Returns a list of all possible errors returned by the module.
Definition: ApiRevisionDelete.php:223
wfMessage
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
RevisionDeleter\createList
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
Definition: RevisionDeleter.php:82
ApiRevisionDelete\getHelpUrls
getHelpUrls()
Definition: ApiRevisionDelete.php:252
ApiRevisionDelete\formatStatusMessages
formatStatusMessages( $messages)
Definition: ApiRevisionDelete.php:136
ApiRevisionDelete\extractStatusInfo
extractStatusInfo( $status)
Definition: ApiRevisionDelete.php:118
RevisionDeleter\getRevdelConstant
static getRevdelConstant( $typeName)
Get the revision deletion constant for the RevDel type.
Definition: RevisionDeleter.php:180
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
ApiBase\dieUsage
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
ApiRevisionDelete\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiRevisionDelete.php:219
$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
ApiRevisionDelete\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiRevisionDelete.php:241
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiRevisionDelete\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiRevisionDelete.php:171
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiRevisionDelete\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiRevisionDelete.php:167
ApiRevisionDelete\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiRevisionDelete.php:206
RevisionDeleter\suggestTarget
static suggestTarget( $typeName, $target, array $ids)
Suggest a target for the revision deletion.
Definition: RevisionDeleter.php:196
RevisionDeleter\getRestriction
static getRestriction( $typeName)
Get the user right required for the RevDel type.
Definition: RevisionDeleter.php:166
ApiRevisionDelete\needsToken
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiRevisionDelete.php:233
ApiRevisionDelete\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiRevisionDelete.php:34