MediaWiki  1.33.0
Go to the documentation of this file.
1 <?php
29 class ApiBlock extends ApiBase {
37  public function execute() {
38  $this->checkUserRightsAny( 'block' );
40  $user = $this->getUser();
41  $params = $this->extractRequestParams();
43  $this->requireOnlyOneParameter( $params, 'user', 'userid' );
45  # T17810: blocked admins should have limited access here
46  if ( $user->isBlocked() ) {
48  if ( $status !== true ) {
49  $this->dieWithError(
50  $status,
51  null,
52  [ 'blockinfo' => ApiQueryUserInfo::getBlockInfo( $user->getBlock() ) ]
53  );
54  }
55  }
57  $editingRestriction = 'sitewide';
58  $pageRestrictions = '';
59  $namespaceRestrictions = '';
60  if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
61  if ( $params['partial'] ) {
62  $editingRestriction = 'partial';
63  }
65  $pageRestrictions = implode( "\n", (array)$params['pagerestrictions'] );
66  $namespaceRestrictions = implode( "\n", (array)$params['namespacerestrictions'] );
67  }
69  if ( $params['userid'] !== null ) {
70  $username = User::whoIs( $params['userid'] );
72  if ( $username === false ) {
73  $this->dieWithError( [ 'apierror-nosuchuserid', $params['userid'] ], 'nosuchuserid' );
74  } else {
75  $params['user'] = $username;
76  }
77  } else {
78  list( $target, $type ) = SpecialBlock::getTargetAndType( $params['user'] );
80  // T40633 - if the target is a user (not an IP address), but it
81  // doesn't exist or is unusable, error.
82  if ( $type === Block::TYPE_USER &&
83  ( $target->isAnon() /* doesn't exist */ || !User::isUsableName( $params['user'] ) )
84  ) {
85  $this->dieWithError( [ 'nosuchusershort', $params['user'] ], 'nosuchuser' );
86  }
87  }
89  if ( $params['tags'] ) {
91  if ( !$ableToTag->isOK() ) {
92  $this->dieStatus( $ableToTag );
93  }
94  }
96  if ( $params['hidename'] && !$user->isAllowed( 'hideuser' ) ) {
97  $this->dieWithError( 'apierror-canthide' );
98  }
99  if ( $params['noemail'] && !SpecialBlock::canBlockEmail( $user ) ) {
100  $this->dieWithError( 'apierror-cantblock-email' );
101  }
103  $data = [
104  'PreviousTarget' => $params['user'],
105  'Target' => $params['user'],
106  'Reason' => [
107  $params['reason'],
108  'other',
109  $params['reason']
110  ],
111  'Expiry' => $params['expiry'],
112  'HardBlock' => !$params['anononly'],
113  'CreateAccount' => $params['nocreate'],
114  'AutoBlock' => $params['autoblock'],
115  'DisableEmail' => $params['noemail'],
116  'HideUser' => $params['hidename'],
117  'DisableUTEdit' => !$params['allowusertalk'],
118  'Reblock' => $params['reblock'],
119  'Watch' => $params['watchuser'],
120  'Confirm' => true,
121  'Tags' => $params['tags'],
122  'EditingRestriction' => $editingRestriction,
123  'PageRestrictions' => $pageRestrictions,
124  'NamespaceRestrictions' => $namespaceRestrictions,
125  ];
128  if ( !$status->isOK() ) {
129  $this->dieStatus( $status );
130  }
132  $retval = SpecialBlock::processForm( $data, $this->getContext() );
133  if ( $retval !== true ) {
134  $this->dieStatus( $this->errorArrayToStatus( $retval ) );
135  }
137  list( $target, /*...*/ ) = SpecialBlock::getTargetAndType( $params['user'] );
138  $res['user'] = $params['user'];
139  $res['userID'] = $target instanceof User ? $target->getId() : 0;
141  $block = Block::newFromTarget( $target, null, true );
142  if ( $block instanceof Block ) {
143  $res['expiry'] = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
144  $res['id'] = $block->getId();
145  } else {
146  # should be unreachable
147  $res['expiry'] = ''; // @codeCoverageIgnore
148  $res['id'] = ''; // @codeCoverageIgnore
149  }
151  $res['reason'] = $params['reason'];
152  $res['anononly'] = $params['anononly'];
153  $res['nocreate'] = $params['nocreate'];
154  $res['autoblock'] = $params['autoblock'];
155  $res['noemail'] = $params['noemail'];
156  $res['hidename'] = $params['hidename'];
157  $res['allowusertalk'] = $params['allowusertalk'];
158  $res['watchuser'] = $params['watchuser'];
160  if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
161  $res['partial'] = $params['partial'];
162  $res['pagerestrictions'] = $params['pagerestrictions'];
163  $res['namespacerestrictions'] = $params['namespacerestrictions'];
164  }
166  $this->getResult()->addValue( null, $this->getModuleName(), $res );
167  }
169  public function mustBePosted() {
170  return true;
171  }
173  public function isWriteMode() {
174  return true;
175  }
177  public function getAllowedParams() {
178  $params = [
179  'user' => [
180  ApiBase::PARAM_TYPE => 'user',
181  ],
182  'userid' => [
183  ApiBase::PARAM_TYPE => 'integer',
184  ],
185  'expiry' => 'never',
186  'reason' => '',
187  'anononly' => false,
188  'nocreate' => false,
189  'autoblock' => false,
190  'noemail' => false,
191  'hidename' => false,
192  'allowusertalk' => false,
193  'reblock' => false,
194  'watchuser' => false,
195  'tags' => [
196  ApiBase::PARAM_TYPE => 'tags',
197  ApiBase::PARAM_ISMULTI => true,
198  ],
199  ];
201  if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
202  $params['partial'] = false;
203  $params['pagerestrictions'] = [
204  ApiBase::PARAM_ISMULTI => true,
207  ];
208  $params['namespacerestrictions'] = [
209  ApiBase::PARAM_ISMULTI => true,
210  ApiBase::PARAM_TYPE => 'namespace',
211  ];
212  }
214  return $params;
215  }
217  public function needsToken() {
218  return 'csrf';
219  }
221  protected function getExamplesMessages() {
222  // phpcs:disable Generic.Files.LineLength
223  return [
224  'action=block&user='
225  => 'apihelp-block-example-ip-simple',
226  'action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC'
227  => 'apihelp-block-example-user-complex',
228  ];
229  // phpcs:enable
230  }
232  public function getHelpUrls() {
233  return '';
234  }
235 }
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:1266
Definition: ContextSource.php:63
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
Get the base IContextSource object.
Definition: ContextSource.php:40
Get the user's ID.
Definition: User.php:2425
static checkUnblockSelf( $target, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to ...
Definition: SpecialBlock.php:1124
Returns usage examples for this module.
Definition: ApiBlock.php:221
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1990
static processForm(array $data, IContextSource $context)
Given the form data, actually implement a block.
Definition: SpecialBlock.php:756
static canBlockEmail( $user)
Can we do an email block?
Definition: SpecialBlock.php:1104
Indicates whether this module must be called with a POST request.
Definition: ApiBlock.php:169
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
Get the result object.
Definition: ApiBase.php:632
Indicates whether this module requires write mode.
Definition: ApiBlock.php:173
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2105
Definition: styleTest.css.php:44
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
Definition: Block.php:1403
(integer) Maximum number of values, for normal users.
Definition: ApiBase.php:208
Definition: database.txt:21
Definition: ContextSource.php:120
Returns the token type this module requires in order to execute.
Definition: ApiBlock.php:217
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:37
(integer) Maximum number of values, for users with the apihighimits right.
Definition: ApiBase.php:215
API module that facilitates the blocking of users.
Definition: ApiBlock.php:29
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:743
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("", 2))
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
static whoIs( $id)
Get the username corresponding to a given user ID.
Definition: User.php:885
Return links to more detailed help pages about the module.
Definition: ApiBlock.php:232
requireOnlyOneParameter( $params, $required)
Die if none or more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:875
Definition: Block.php:96
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:481
Blocks the user specified in the parameters for the given expiry, with the given reason,...
Definition: ApiBlock.php:37
static validateTarget( $value, User $user)
Validate a block target.
Definition: SpecialBlock.php:695
Definition: Block.php:31
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:2061
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:51
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1205
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
Definition: SpecialBlock.php:625
static isUsableName( $name)
Usernames which fail to pass this function will be blocked from user login and new account registrati...
Definition: User.php:1042
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiBlock.php:177
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:48
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:780
errorArrayToStatus(array $errors, User $user=null)
Turn an array of message keys or key+param arrays into a Status.
Definition: ApiBase.php:1801
static getBlockInfo(Block $block)
Get basic info about a given block.
Definition: ApiQueryUserInfo.php:65
Definition: testCompression.php:48