MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
29 class ApiUserrights extends ApiBase {
31  private $mUser = null;
37  protected function getUserRightsPage() {
38  return new UserrightsPage;
39  }
45  protected function getAllGroups() {
46  return User::getAllGroups();
47  }
49  public function execute() {
50  $pUser = $this->getUser();
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  }
58  $params = $this->extractRequestParams();
60  // Figure out expiry times from the input
61  // $params['expiry'] may not be set in subclasses
62  if ( isset( $params['expiry'] ) ) {
63  $expiry = (array)$params['expiry'];
64  } else {
65  $expiry = [ 'infinity' ];
66  }
67  if ( count( $expiry ) !== count( $params['add'] ) ) {
68  if ( count( $expiry ) === 1 ) {
69  $expiry = array_fill( 0, count( $params['add'] ), $expiry[0] );
70  } else {
71  $this->dieWithError( [
72  'apierror-toofewexpiries',
73  count( $expiry ),
74  count( $params['add'] )
75  ] );
76  }
77  }
79  // Validate the expiries
80  $groupExpiries = [];
81  foreach ( $expiry as $index => $expiryValue ) {
82  $group = $params['add'][$index];
83  $groupExpiries[$group] = UserrightsPage::expiryToTimestamp( $expiryValue );
85  if ( $groupExpiries[$group] === false ) {
86  $this->dieWithError( [ 'apierror-invalidexpiry', wfEscapeWikiText( $expiryValue ) ] );
87  }
89  // not allowed to have things expiring in the past
90  if ( $groupExpiries[$group] && $groupExpiries[$group] < wfTimestampNow() ) {
91  $this->dieWithError( [ 'apierror-pastexpiry', wfEscapeWikiText( $expiryValue ) ] );
92  }
93  }
95  $user = $this->getUrUser( $params );
97  $tags = $params['tags'];
99  // Check if user can add tags
100  if ( !is_null( $tags ) ) {
101  $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $pUser );
102  if ( !$ableToTag->isOK() ) {
103  $this->dieStatus( $ableToTag );
104  }
105  }
107  $form = $this->getUserRightsPage();
108  $form->setContext( $this->getContext() );
109  $r['user'] = $user->getName();
110  $r['userid'] = $user->getId();
111  list( $r['added'], $r['removed'] ) = $form->doSaveUserGroups(
112  $user, (array)$params['add'], (array)$params['remove'],
113  $params['reason'], $tags, $groupExpiries
114  );
116  $result = $this->getResult();
117  ApiResult::setIndexedTagName( $r['added'], 'group' );
118  ApiResult::setIndexedTagName( $r['removed'], 'group' );
119  $result->addValue( null, $this->getModuleName(), $r );
120  }
126  private function getUrUser( array $params ) {
127  if ( $this->mUser !== null ) {
128  return $this->mUser;
129  }
131  $this->requireOnlyOneParameter( $params, 'user', 'userid' );
133  $user = isset( $params['user'] ) ? $params['user'] : '#' . $params['userid'];
135  $form = $this->getUserRightsPage();
136  $form->setContext( $this->getContext() );
137  $status = $form->fetchUser( $user );
138  if ( !$status->isOK() ) {
139  $this->dieStatus( $status );
140  }
142  $this->mUser = $status->value;
144  return $status->value;
145  }
147  public function mustBePosted() {
148  return true;
149  }
151  public function isWriteMode() {
152  return true;
153  }
155  public function getAllowedParams() {
156  $a = [
157  'user' => [
158  ApiBase::PARAM_TYPE => 'user',
159  ],
160  'userid' => [
161  ApiBase::PARAM_TYPE => 'integer',
162  ],
163  'add' => [
164  ApiBase::PARAM_TYPE => $this->getAllGroups(),
166  ],
167  'expiry' => [
168  ApiBase::PARAM_ISMULTI => true,
170  ApiBase::PARAM_DFLT => 'infinite',
171  ],
172  'remove' => [
173  ApiBase::PARAM_TYPE => $this->getAllGroups(),
175  ],
176  'reason' => [
177  ApiBase::PARAM_DFLT => ''
178  ],
179  'token' => [
180  // Standard definition automatically inserted
181  ApiBase::PARAM_HELP_MSG_APPEND => [ 'api-help-param-token-webui' ],
182  ],
183  'tags' => [
184  ApiBase::PARAM_TYPE => 'tags',
186  ],
187  ];
188  if ( !$this->getUserRightsPage()->canProcessExpiries() ) {
189  unset( $a['expiry'] );
190  }
191  return $a;
192  }
194  public function needsToken() {
195  return 'userrights';
196  }
198  protected function getWebUITokenSalt( array $params ) {
199  return $this->getUrUser( $params )->getName();
200  }
202  protected function getExamplesMessages() {
203  $a = [
204  'action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
205  => 'apihelp-userrights-example-user',
206  'action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC'
207  => 'apihelp-userrights-example-userid',
208  ];
209  if ( $this->getUserRightsPage()->canProcessExpiries() ) {
210  $a['action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC']
211  = 'apihelp-userrights-example-expiry';
212  }
213  return $a;
214  }
216  public function getHelpUrls() {
217  return '';
218  }
219 }
Get the base IContextSource object.
Definition: ContextSource.php:41
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1796
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:Array with elements of the form "language:title" in the order that they will be output. & $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:1954
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
Get the result object.
Definition: ApiBase.php:610
Definition: ApiUserrights.php:31
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
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:246
Indicates whether this module must be called with a POST request.
Definition: ApiUserrights.php:147
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiUserrights.php:155
Definition: styleTest.css.php:40
Returns the token type this module requires in order to execute.
Definition: ApiUserrights.php:194
(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?
Definition: ApiBase.php:106
Get the User object.
Definition: ContextSource.php:133
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:135
Returns usage examples for this module.
Definition: ApiUserrights.php:202
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
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:41
dieBlocked(Block $block)
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die wit...
Definition: ApiBase.php:1836
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiUserrights.php:49
static expiryToTimestamp( $expiry)
Converts a user group membership expiry string into a timestamp.
Definition: SpecialUserrights.php:230
Special page to allow managing user group membership.
Definition: SpecialUserrights.php:29
getWebUITokenSalt(array $params)
Fetch the salt used in the Web UI corresponding to this module.
Definition: ApiUserrights.php:198
getUrUser(array $params)
Definition: ApiUserrights.php:126
Return links to more detailed help pages about the module.
Definition: ApiUserrights.php:216
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2023
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
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
Definition: ApiUserrights.php:29
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1657
static getAllGroups()
Return the set of defined explicit groups.
Definition: User.php:4860
requireOnlyOneParameter( $params, $required)
Die if none or more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:754
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:395
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:52
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
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:1861
Get the name of the module being executed by this instance.
Definition: ApiBase.php:490
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
Get all available groups.
Definition: ApiUserrights.php:45
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:1956
Indicates whether this module requires write mode.
Definition: ApiUserrights.php:151
Get a UserrightsPage object, or subclass.
Definition: ApiUserrights.php:37
the array() calling protocol came about after MediaWiki 1.4rc1.