MediaWiki REL1_32
ApiUserrights.php
Go to the documentation of this file.
1<?php
2
29class ApiUserrights extends ApiBase {
30
31 private $mUser = null;
32
37 protected function getUserRightsPage() {
38 return new UserrightsPage;
39 }
40
45 protected function getAllGroups() {
46 return User::getAllGroups();
47 }
48
49 public function execute() {
50 $pUser = $this->getUser();
51
52 // Deny if the user is blocked and doesn't have the full 'userrights' permission.
53 // This matches what Special:UserRights does for the web UI.
54 if ( $pUser->isBlocked() && !$pUser->isAllowed( 'userrights' ) ) {
55 $this->dieBlocked( $pUser->getBlock() );
56 }
57
59
60 // Figure out expiry times from the input
61 // $params['expiry'] is not set in CentralAuth's ApiGlobalUserRights subclass
62 if ( isset( $params['expiry'] ) ) {
63 $expiry = (array)$params['expiry'];
64 } else {
65 $expiry = [ 'infinity' ];
66 }
67 $add = (array)$params['add'];
68 if ( !$add ) {
69 $expiry = [];
70 } elseif ( count( $expiry ) !== count( $add ) ) {
71 if ( count( $expiry ) === 1 ) {
72 $expiry = array_fill( 0, count( $add ), $expiry[0] );
73 } else {
74 $this->dieWithError( [
75 'apierror-toofewexpiries',
76 count( $expiry ),
77 count( $add )
78 ] );
79 }
80 }
81
82 // Validate the expiries
83 $groupExpiries = [];
84 foreach ( $expiry as $index => $expiryValue ) {
85 $group = $add[$index];
86 $groupExpiries[$group] = UserrightsPage::expiryToTimestamp( $expiryValue );
87
88 if ( $groupExpiries[$group] === false ) {
89 $this->dieWithError( [ 'apierror-invalidexpiry', wfEscapeWikiText( $expiryValue ) ] );
90 }
91
92 // not allowed to have things expiring in the past
93 if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
94 $this->dieWithError( [ 'apierror-pastexpiry', wfEscapeWikiText( $expiryValue ) ] );
95 }
96 }
97
98 $user = $this->getUrUser( $params );
99
100 $tags = $params['tags'];
101
102 // Check if user can add tags
103 if ( $tags !== null ) {
104 $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $pUser );
105 if ( !$ableToTag->isOK() ) {
106 $this->dieStatus( $ableToTag );
107 }
108 }
109
110 $form = $this->getUserRightsPage();
111 $form->setContext( $this->getContext() );
112 $r['user'] = $user->getName();
113 $r['userid'] = $user->getId();
114 list( $r['added'], $r['removed'] ) = $form->doSaveUserGroups(
115 // Don't pass null to doSaveUserGroups() for array params, cast to empty array
116 $user, (array)$add, (array)$params['remove'],
117 $params['reason'], (array)$tags, $groupExpiries
118 );
119
120 $result = $this->getResult();
121 ApiResult::setIndexedTagName( $r['added'], 'group' );
122 ApiResult::setIndexedTagName( $r['removed'], 'group' );
123 $result->addValue( null, $this->getModuleName(), $r );
124 }
125
130 private function getUrUser( array $params ) {
131 if ( $this->mUser !== null ) {
132 return $this->mUser;
133 }
134
135 $this->requireOnlyOneParameter( $params, 'user', 'userid' );
136
137 $user = $params['user'] ?? '#' . $params['userid'];
138
139 $form = $this->getUserRightsPage();
140 $form->setContext( $this->getContext() );
141 $status = $form->fetchUser( $user );
142 if ( !$status->isOK() ) {
143 $this->dieStatus( $status );
144 }
145
146 $this->mUser = $status->value;
147
148 return $status->value;
149 }
150
151 public function mustBePosted() {
152 return true;
153 }
154
155 public function isWriteMode() {
156 return true;
157 }
158
159 public function getAllowedParams() {
160 $a = [
161 'user' => [
162 ApiBase::PARAM_TYPE => 'user',
163 ],
164 'userid' => [
165 ApiBase::PARAM_TYPE => 'integer',
166 ],
167 'add' => [
170 ],
171 'expiry' => [
174 ApiBase::PARAM_DFLT => 'infinite',
175 ],
176 'remove' => [
179 ],
180 'reason' => [
182 ],
183 'token' => [
184 // Standard definition automatically inserted
185 ApiBase::PARAM_HELP_MSG_APPEND => [ 'api-help-param-token-webui' ],
186 ],
187 'tags' => [
188 ApiBase::PARAM_TYPE => 'tags',
190 ],
191 ];
192 // CentralAuth's ApiGlobalUserRights subclass can't handle expiries
193 if ( !$this->getUserRightsPage()->canProcessExpiries() ) {
194 unset( $a['expiry'] );
195 }
196 return $a;
197 }
198
199 public function needsToken() {
200 return 'userrights';
201 }
202
203 protected function getWebUITokenSalt( array $params ) {
204 return $this->getUrUser( $params )->getName();
205 }
206
207 protected function getExamplesMessages() {
208 $a = [
209 'action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
210 => 'apihelp-userrights-example-user',
211 'action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC'
212 => 'apihelp-userrights-example-userid',
213 ];
214 if ( $this->getUserRightsPage()->canProcessExpiries() ) {
215 $a['action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC']
216 = 'apihelp-userrights-example-expiry';
217 }
218 return $a;
219 }
220
221 public function getHelpUrls() {
222 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:User_group_membership';
223 }
224}
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:37
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition ApiBase.php:131
const PARAM_ALLOW_DUPLICATES
(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?
Definition ApiBase.php:102
getResult()
Get the result object.
Definition ApiBase.php:659
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:539
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:2052
dieBlocked(Block $block)
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die wit...
Definition ApiBase.php:2027
requireOnlyOneParameter( $params, $required)
Die if none or more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:901
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getHelpUrls()
Return links to more detailed help pages about the module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
mustBePosted()
Indicates whether this module must be called with a POST request.
getUrUser(array $params)
getUserRightsPage()
Get a UserrightsPage object, or subclass.
needsToken()
Returns the token type this module requires in order to execute.
getAllGroups()
Get all available groups.
isWriteMode()
Indicates whether this module requires write mode.
getExamplesMessages()
Returns usage examples for this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getWebUITokenSalt(array $params)
Fetch the salt used in the Web UI corresponding to this module.
getContext()
Get the base IContextSource object.
static getAllGroups()
Return the set of defined explicit groups.
Definition User.php:5107
Special page to allow managing user group membership.
static expiryToTimestamp( $expiry)
Converts a user group membership expiry string into a timestamp.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
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:2055
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1071
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params