MediaWiki  master
SpecialUnblock.php
Go to the documentation of this file.
1 <?php
29 class SpecialUnblock extends SpecialPage {
30 
31  protected $target;
32  protected $type;
33  protected $block;
34 
35  public function __construct() {
36  parent::__construct( 'Unblock', 'block' );
37  }
38 
39  public function doesWrites() {
40  return true;
41  }
42 
43  public function execute( $par ) {
44  $this->checkPermissions();
45  $this->checkReadOnly();
46 
47  list( $this->target, $this->type ) = SpecialBlock::getTargetAndType( $par, $this->getRequest() );
48  $this->block = Block::newFromTarget( $this->target );
49  if ( $this->target instanceof User ) {
50  # Set the 'relevant user' in the skin, so it displays links like Contributions,
51  # User logs, UserRights, etc.
52  $this->getSkin()->setRelevantUser( $this->target );
53  }
54 
55  $this->setHeaders();
56  $this->outputHeader();
57 
58  $out = $this->getOutput();
59  $out->setPageTitle( $this->msg( 'unblockip' ) );
60  $out->addModules( [ 'mediawiki.userSuggest' ] );
61 
62  $form = HTMLForm::factory( 'ooui', $this->getFields(), $this->getContext() );
63  $form->setWrapperLegendMsg( 'unblockip' );
64  $form->setSubmitCallback( [ __CLASS__, 'processUIUnblock' ] );
65  $form->setSubmitTextMsg( 'ipusubmit' );
66  $form->addPreText( $this->msg( 'unblockiptext' )->parseAsBlock() );
67 
68  if ( $form->show() ) {
69  switch ( $this->type ) {
70  case Block::TYPE_IP:
71  $out->addWikiMsg( 'unblocked-ip', wfEscapeWikiText( $this->target ) );
72  break;
73  case Block::TYPE_USER:
74  $out->addWikiMsg( 'unblocked', wfEscapeWikiText( $this->target ) );
75  break;
76  case Block::TYPE_RANGE:
77  $out->addWikiMsg( 'unblocked-range', wfEscapeWikiText( $this->target ) );
78  break;
79  case Block::TYPE_ID:
80  case Block::TYPE_AUTO:
81  $out->addWikiMsg( 'unblocked-id', wfEscapeWikiText( $this->target ) );
82  break;
83  }
84  }
85  }
86 
87  protected function getFields() {
88  $fields = [
89  'Target' => [
90  'type' => 'text',
91  'label-message' => 'ipaddressorusername',
92  'autofocus' => true,
93  'size' => '45',
94  'required' => true,
95  'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
96  ],
97  'Name' => [
98  'type' => 'info',
99  'label-message' => 'ipaddressorusername',
100  ],
101  'Reason' => [
102  'type' => 'text',
103  'label-message' => 'ipbreason',
104  ]
105  ];
106 
107  if ( $this->block instanceof Block ) {
108  list( $target, $type ) = $this->block->getTargetAndType();
109 
110  # Autoblocks are logged as "autoblock #123 because the IP was recently used by
111  # User:Foo, and we've just got any block, auto or not, that applies to a target
112  # the user has specified. Someone could be fishing to connect IPs to autoblocks,
113  # so don't show any distinction between unblocked IPs and autoblocked IPs
114  if ( $type == Block::TYPE_AUTO && $this->type == Block::TYPE_IP ) {
115  $fields['Target']['default'] = $this->target;
116  unset( $fields['Name'] );
117  } else {
118  $fields['Target']['default'] = $target;
119  $fields['Target']['type'] = 'hidden';
120  switch ( $type ) {
121  case Block::TYPE_IP:
122  $fields['Name']['default'] = $this->getLinkRenderer()->makeKnownLink(
123  SpecialPage::getTitleFor( 'Contributions', $target->getName() ),
124  $target->getName()
125  );
126  $fields['Name']['raw'] = true;
127  break;
128  case Block::TYPE_USER:
129  $fields['Name']['default'] = $this->getLinkRenderer()->makeLink(
130  $target->getUserPage(),
131  $target->getName()
132  );
133  $fields['Name']['raw'] = true;
134  break;
135 
136  case Block::TYPE_RANGE:
137  $fields['Name']['default'] = $target;
138  break;
139 
140  case Block::TYPE_AUTO:
141  $fields['Name']['default'] = $this->block->getRedactedName();
142  $fields['Name']['raw'] = true;
143  # Don't expose the real target of the autoblock
144  $fields['Target']['default'] = "#{$this->target}";
145  break;
146  }
147  // target is hidden, so the reason is the first element
148  $fields['Target']['autofocus'] = false;
149  $fields['Reason']['autofocus'] = true;
150  }
151  } else {
152  $fields['Target']['default'] = $this->target;
153  unset( $fields['Name'] );
154  }
155 
156  return $fields;
157  }
158 
165  public static function processUIUnblock( array $data, HTMLForm $form ) {
166  return self::processUnblock( $data, $form->getContext() );
167  }
168 
180  public static function processUnblock( array $data, IContextSource $context ) {
181  $performer = $context->getUser();
182  $target = $data['Target'];
183  $block = Block::newFromTarget( $data['Target'] );
184 
185  if ( !$block instanceof Block ) {
186  return [ [ 'ipb_cant_unblock', $target ] ];
187  }
188 
189  # T17810: blocked admins should have limited access here. This
190  # won't allow sysops to remove autoblocks on themselves, but they
191  # should have ipblock-exempt anyway
193  if ( $status !== true ) {
194  throw new ErrorPageError( 'badaccess', $status );
195  }
196 
197  # If the specified IP is a single address, and the block is a range block, don't
198  # unblock the whole range.
200  if ( $block->getType() == Block::TYPE_RANGE && $type == Block::TYPE_IP ) {
201  $range = $block->getTarget();
202 
203  return [ [ 'ipb_blocked_as_range', $target, $range ] ];
204  }
205 
206  # If the name was hidden and the blocking user cannot hide
207  # names, then don't allow any block removals...
208  if ( !$performer->isAllowed( 'hideuser' ) && $block->mHideName ) {
209  return [ 'unblock-hideuser' ];
210  }
211 
212  $reason = [ 'hookaborted' ];
213  if ( !Hooks::run( 'UnblockUser', [ &$block, &$performer, &$reason ] ) ) {
214  return $reason;
215  }
216 
217  # Delete block
218  if ( !$block->delete() ) {
219  return [ [ 'ipb_cant_unblock', htmlspecialchars( $block->getTarget() ) ] ];
220  }
221 
222  Hooks::run( 'UnblockUserComplete', [ $block, $performer ] );
223 
224  # Unset _deleted fields as needed
225  if ( $block->mHideName ) {
226  # Something is deeply FUBAR if this is not a User object, but who knows?
227  $id = $block->getTarget() instanceof User
228  ? $block->getTarget()->getId()
229  : User::idFromName( $block->getTarget() );
230 
231  RevisionDeleteUser::unsuppressUserName( $block->getTarget(), $id );
232  }
233 
234  # Redact the name (IP address) for autoblocks
235  if ( $block->getType() == Block::TYPE_AUTO ) {
236  $page = Title::makeTitle( NS_USER, '#' . $block->getId() );
237  } else {
238  $page = $block->getTarget() instanceof User
239  ? $block->getTarget()->getUserPage()
240  : Title::makeTitle( NS_USER, $block->getTarget() );
241  }
242 
243  # Make log entry
244  $logEntry = new ManualLogEntry( 'block', 'unblock' );
245  $logEntry->setTarget( $page );
246  $logEntry->setComment( $data['Reason'] );
247  $logEntry->setPerformer( $performer );
248  if ( isset( $data['Tags'] ) ) {
249  $logEntry->setTags( $data['Tags'] );
250  }
251  $logId = $logEntry->insert();
252  $logEntry->publish( $logId );
253 
254  return true;
255  }
256 
265  public function prefixSearchSubpages( $search, $limit, $offset ) {
266  $user = User::newFromName( $search );
267  if ( !$user ) {
268  // No prefix suggestion for invalid user
269  return [];
270  }
271  // Autocomplete subpage as user list - public to allow caching
272  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
273  }
274 
275  protected function getGroupName() {
276  return 'users';
277  }
278 }
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))
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.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:785
getContext()
Gets the context this SpecialPage is executed in.
const TYPE_RANGE
Definition: Block.php:93
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target&#39;s type, get an existing Block object if possible.
Definition: Block.php:1264
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:1277
const TYPE_IP
Definition: Block.php:92
static idFromName( $name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:904
getOutput()
Get the OutputPage being used for this instance.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:284
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:47
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:2173
An error page which can definitely be safely rendered using the OutputPage.
static unsuppressUserName( $name, $userId, $dbw=null)
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
static checkUnblockSelf( $user, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn&#39;t be able to ...
getContext()
Get the base IContextSource object.
getSkin()
Shortcut to get the skin being used for this instance.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
const TYPE_ID
Definition: Block.php:95
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:82
const TYPE_AUTO
Definition: Block.php:94
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:545
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:2626
const TYPE_USER
Definition: Block.php:91
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
getRequest()
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
checkReadOnly()
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.
Definition: Block.php:29
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:1487
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200