MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
26 class ApiTag extends ApiBase {
28  public function execute() {
29  $params = $this->extractRequestParams();
30  $user = $this->getUser();
32  // make sure the user is allowed
33  if ( !$user->isAllowed( 'changetags' ) ) {
34  $this->dieUsage( "You don't have permission to add or remove change tags from individual edits",
35  'permissiondenied' );
36  }
38  if ( $user->isBlocked() ) {
39  $this->dieBlocked( $user->getBlock() );
40  }
42  // validate and process each revid, rcid and logid
43  $this->requireAtLeastOneParameter( $params, 'revid', 'rcid', 'logid' );
44  $ret = [];
45  if ( $params['revid'] ) {
46  foreach ( $params['revid'] as $id ) {
47  $ret[] = $this->processIndividual( 'revid', $params, $id );
48  }
49  }
50  if ( $params['rcid'] ) {
51  foreach ( $params['rcid'] as $id ) {
52  $ret[] = $this->processIndividual( 'rcid', $params, $id );
53  }
54  }
55  if ( $params['logid'] ) {
56  foreach ( $params['logid'] as $id ) {
57  $ret[] = $this->processIndividual( 'logid', $params, $id );
58  }
59  }
62  $this->getResult()->addValue( null, $this->getModuleName(), $ret );
63  }
65  protected static function validateLogId( $logid ) {
66  $dbr = wfGetDB( DB_REPLICA );
67  $result = $dbr->selectField( 'logging', 'log_id', [ 'log_id' => $logid ],
68  __METHOD__ );
69  return (bool)$result;
70  }
72  protected function processIndividual( $type, $params, $id ) {
73  $idResult = [ $type => $id ];
75  // validate the ID
76  $valid = false;
77  switch ( $type ) {
78  case 'rcid':
79  $valid = RecentChange::newFromId( $id );
80  break;
81  case 'revid':
82  $valid = Revision::newFromId( $id );
83  break;
84  case 'logid':
85  $valid = self::validateLogId( $id );
86  break;
87  }
89  if ( !$valid ) {
90  $idResult['status'] = 'error';
91  $idResult += $this->parseMsg( [ "nosuch$type", $id ] );
92  return $idResult;
93  }
96  $params['remove'],
97  ( $type === 'rcid' ? $id : null ),
98  ( $type === 'revid' ? $id : null ),
99  ( $type === 'logid' ? $id : null ),
100  null,
101  $params['reason'],
102  $this->getUser() );
104  if ( !$status->isOK() ) {
105  if ( $status->hasMessage( 'actionthrottledtext' ) ) {
106  $idResult['status'] = 'skipped';
107  } else {
108  $idResult['status'] = 'failure';
109  $idResult['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status, 'error' );
110  }
111  } else {
112  $idResult['status'] = 'success';
113  if ( is_null( $status->value->logId ) ) {
114  $idResult['noop'] = '';
115  } else {
116  $idResult['actionlogid'] = $status->value->logId;
117  $idResult['added'] = $status->value->addedTags;
118  ApiResult::setIndexedTagName( $idResult['added'], 't' );
119  $idResult['removed'] = $status->value->removedTags;
120  ApiResult::setIndexedTagName( $idResult['removed'], 't' );
121  }
122  }
123  return $idResult;
124  }
126  public function mustBePosted() {
127  return true;
128  }
130  public function isWriteMode() {
131  return true;
132  }
134  public function getAllowedParams() {
135  return [
136  'rcid' => [
137  ApiBase::PARAM_TYPE => 'integer',
138  ApiBase::PARAM_ISMULTI => true,
139  ],
140  'revid' => [
141  ApiBase::PARAM_TYPE => 'integer',
142  ApiBase::PARAM_ISMULTI => true,
143  ],
144  'logid' => [
145  ApiBase::PARAM_TYPE => 'integer',
146  ApiBase::PARAM_ISMULTI => true,
147  ],
148  'add' => [
149  ApiBase::PARAM_TYPE => 'tags',
150  ApiBase::PARAM_ISMULTI => true,
151  ],
152  'remove' => [
153  ApiBase::PARAM_TYPE => 'string',
154  ApiBase::PARAM_ISMULTI => true,
155  ],
156  'reason' => [
157  ApiBase::PARAM_DFLT => '',
158  ],
159  ];
160  }
162  public function needsToken() {
163  return 'csrf';
164  }
166  protected function getExamplesMessages() {
167  return [
168  'action=tag&revid=123&add=vandalism&token=123ABC'
169  => 'apihelp-tag-example-rev',
170  'action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC'
171  => 'apihelp-tag-example-log',
172  ];
173  }
175  public function getHelpUrls() {
176  return '';
177  }
178 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Definition: ApiTag.php:130
Get the error formatter.
Definition: ApiBase.php:598
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
Get the result object.
Definition: ApiBase.php:584
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:1936
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
Definition: ApiTag.php:28
static newFromId($rcid)
Obtain the recent change with a given rc_id value.
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
Definition: ApiTag.php:162
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.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.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:1934
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
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
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 local account $user
Definition: hooks.txt:242
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
Definition: Revision.php:110
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:35
Definition: ApiTag.php:134
processIndividual($type, $params, $id)
Definition: ApiTag.php:72
static validateLogId($logid)
Definition: ApiTag.php:65
requireAtLeastOneParameter($params, $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:770
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
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:1585
Definition: ApiTag.php:175
dieBlocked(Block $block)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1602
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
Definition: defines.php:22
Return the error message related to a certain array.
Definition: ApiBase.php:2253
Definition: ApiTag.php:166
Get the User object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static updateTagsWithChecks($tagsToAdd, $tagsToRemove, $rc_id, $rev_id, $log_id, $params, $reason, User $user)
Adds and/or removes tags to/from a given change, checking whether it is allowed first, and adding a log entry afterwards.
Definition: ChangeTags.php:526
Definition: ApiTag.php:126