MediaWiki  master
Go to the documentation of this file.
1 <?php
31 class SpecialUnblock extends SpecialPage {
33  protected $target;
34  protected $type;
35  protected $block;
37  public function __construct() {
38  parent::__construct( 'Unblock', 'block' );
39  }
41  public function doesWrites() {
42  return true;
43  }
45  public function execute( $par ) {
46  $this->checkPermissions();
47  $this->checkReadOnly();
49  list( $this->target, $this->type ) = SpecialBlock::getTargetAndType( $par, $this->getRequest() );
50  $this->block = DatabaseBlock::newFromTarget( $this->target );
51  if ( $this->target instanceof User ) {
52  # Set the 'relevant user' in the skin, so it displays links like Contributions,
53  # User logs, UserRights, etc.
54  $this->getSkin()->setRelevantUser( $this->target );
55  }
57  $this->setHeaders();
58  $this->outputHeader();
59  $this->addHelpLink( 'Help:Blocking users' );
61  $out = $this->getOutput();
62  $out->setPageTitle( $this->msg( 'unblockip' ) );
63  $out->addModules( [ 'mediawiki.userSuggest' ] );
65  $form = HTMLForm::factory( 'ooui', $this->getFields(), $this->getContext() );
66  $form->setWrapperLegendMsg( 'unblockip' );
67  $form->setSubmitCallback( [ __CLASS__, 'processUIUnblock' ] );
68  $form->setSubmitTextMsg( 'ipusubmit' );
69  $form->addPreText( $this->msg( 'unblockiptext' )->parseAsBlock() );
71  if ( $form->show() ) {
72  switch ( $this->type ) {
73  case DatabaseBlock::TYPE_IP:
74  $out->addWikiMsg( 'unblocked-ip', wfEscapeWikiText( $this->target ) );
75  break;
76  case DatabaseBlock::TYPE_USER:
77  $out->addWikiMsg( 'unblocked', wfEscapeWikiText( $this->target ) );
78  break;
79  case DatabaseBlock::TYPE_RANGE:
80  $out->addWikiMsg( 'unblocked-range', wfEscapeWikiText( $this->target ) );
81  break;
82  case DatabaseBlock::TYPE_ID:
83  case DatabaseBlock::TYPE_AUTO:
84  $out->addWikiMsg( 'unblocked-id', wfEscapeWikiText( $this->target ) );
85  break;
86  }
87  }
88  }
90  protected function getFields() {
91  $fields = [
92  'Target' => [
93  'type' => 'text',
94  'label-message' => 'ipaddressorusername',
95  'autofocus' => true,
96  'size' => '45',
97  'required' => true,
98  'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
99  ],
100  'Name' => [
101  'type' => 'info',
102  'label-message' => 'ipaddressorusername',
103  ],
104  'Reason' => [
105  'type' => 'text',
106  'label-message' => 'ipbreason',
107  ]
108  ];
110  if ( $this->block instanceof DatabaseBlock ) {
111  list( $target, $type ) = $this->block->getTargetAndType();
113  # Autoblocks are logged as "autoblock #123 because the IP was recently used by
114  # User:Foo, and we've just got any block, auto or not, that applies to a target
115  # the user has specified. Someone could be fishing to connect IPs to autoblocks,
116  # so don't show any distinction between unblocked IPs and autoblocked IPs
117  if ( $type == DatabaseBlock::TYPE_AUTO && $this->type == DatabaseBlock::TYPE_IP ) {
118  $fields['Target']['default'] = $this->target;
119  unset( $fields['Name'] );
120  } else {
121  $fields['Target']['default'] = $target;
122  $fields['Target']['type'] = 'hidden';
123  switch ( $type ) {
124  case DatabaseBlock::TYPE_IP:
125  $fields['Name']['default'] = $this->getLinkRenderer()->makeKnownLink(
126  SpecialPage::getTitleFor( 'Contributions', $target->getName() ),
127  $target->getName()
128  );
129  $fields['Name']['raw'] = true;
130  break;
131  case DatabaseBlock::TYPE_USER:
132  $fields['Name']['default'] = $this->getLinkRenderer()->makeLink(
133  $target->getUserPage(),
134  $target->getName()
135  );
136  $fields['Name']['raw'] = true;
137  break;
139  case DatabaseBlock::TYPE_RANGE:
140  $fields['Name']['default'] = $target;
141  break;
143  case DatabaseBlock::TYPE_AUTO:
144  $fields['Name']['default'] = $this->block->getRedactedName();
145  $fields['Name']['raw'] = true;
146  # Don't expose the real target of the autoblock
147  $fields['Target']['default'] = "#{$this->target}";
148  break;
149  }
150  // target is hidden, so the reason is the first element
151  $fields['Target']['autofocus'] = false;
152  $fields['Reason']['autofocus'] = true;
153  }
154  } else {
155  $fields['Target']['default'] = $this->target;
156  unset( $fields['Name'] );
157  }
159  return $fields;
160  }
168  public static function processUIUnblock( array $data, HTMLForm $form ) {
169  return self::processUnblock( $data, $form->getContext() );
170  }
183  public static function processUnblock( array $data, IContextSource $context ) {
184  $performer = $context->getUser();
185  $target = $data['Target'];
186  $block = DatabaseBlock::newFromTarget( $data['Target'] );
188  if ( !$block instanceof DatabaseBlock ) {
189  return [ [ 'ipb_cant_unblock', $target ] ];
190  }
192  # T17810: blocked admins should have limited access here. This
193  # won't allow sysops to remove autoblocks on themselves, but they
194  # should have ipblock-exempt anyway
196  if ( $status !== true ) {
197  throw new ErrorPageError( 'badaccess', $status );
198  }
200  # If the specified IP is a single address, and the block is a range block, don't
201  # unblock the whole range.
203  if ( $block->getType() == DatabaseBlock::TYPE_RANGE && $type == DatabaseBlock::TYPE_IP ) {
204  $range = $block->getTarget();
206  return [ [ 'ipb_blocked_as_range', $target, $range ] ];
207  }
209  # If the name was hidden and the blocking user cannot hide
210  # names, then don't allow any block removals...
211  if ( !$performer->isAllowed( 'hideuser' ) && $block->getHideName() ) {
212  return [ 'unblock-hideuser' ];
213  }
215  $reason = [ 'hookaborted' ];
216  if ( !Hooks::run( 'UnblockUser', [ &$block, &$performer, &$reason ] ) ) {
217  return $reason;
218  }
220  # Delete block
221  if ( !$block->delete() ) {
222  return [ [ 'ipb_cant_unblock', htmlspecialchars( $block->getTarget() ) ] ];
223  }
225  Hooks::run( 'UnblockUserComplete', [ $block, $performer ] );
227  # Unset _deleted fields as needed
228  if ( $block->getHideName() ) {
229  # Something is deeply FUBAR if this is not a User object, but who knows?
230  $id = $block->getTarget() instanceof User
231  ? $block->getTarget()->getId()
232  : User::idFromName( $block->getTarget() );
234  RevisionDeleteUser::unsuppressUserName( $block->getTarget(), $id );
235  }
237  # Redact the name (IP address) for autoblocks
238  if ( $block->getType() == DatabaseBlock::TYPE_AUTO ) {
239  $page = Title::makeTitle( NS_USER, '#' . $block->getId() );
240  } else {
241  $page = $block->getTarget() instanceof User
242  ? $block->getTarget()->getUserPage()
243  : Title::makeTitle( NS_USER, $block->getTarget() );
244  }
246  # Make log entry
247  $logEntry = new ManualLogEntry( 'block', 'unblock' );
248  $logEntry->setTarget( $page );
249  $logEntry->setComment( $data['Reason'] );
250  $logEntry->setPerformer( $performer );
251  if ( isset( $data['Tags'] ) ) {
252  $logEntry->setTags( $data['Tags'] );
253  }
254  $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
255  $logId = $logEntry->insert();
256  $logEntry->publish( $logId );
258  return true;
259  }
269  public function prefixSearchSubpages( $search, $limit, $offset ) {
270  $user = User::newFromName( $search );
271  if ( !$user ) {
272  // No prefix suggestion for invalid user
273  return [];
274  }
275  // Autocomplete subpage as user list - public to allow caching
276  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
277  }
279  protected function getGroupName() {
280  return 'users';
281  }
282 }
static checkUnblockSelf( $target, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn&#39;t be able to ...
static processUIUnblock(array $data, HTMLForm $form)
Submit callback for an HTMLForm object.
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
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
Gets the context this SpecialPage is executed in.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:864
Get the OutputPage being used for this instance.
A DatabaseBlock (unlike a SystemBlock) is stored in the database, may give rise to autoblocks and may...
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:767
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 '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:1244
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException block
Definition: hooks.txt:2147
An error page which can definitely be safely rendered using the OutputPage.
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
Get the base IContextSource object.
Shortcut to get the skin being used for this instance.
static unsuppressUserName( $name, $userId, IDatabase $dbw=null)
Sets headers - this should be called from the execute() method of all derived classes! ...
static processUnblock(array $data, IContextSource $context)
Process the form.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
A special page for unblocking users.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
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 document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
msg( $key)
Wrapper around wfMessage that sets the current context.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2621
Checks if userCanExecute, and if not throws a PermissionsError.
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:535
If the wiki is currently in readonly mode, throws a ReadOnlyError.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200