3 * Implements Special:Block
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
24 use MediaWiki\Block\DatabaseBlock
;
25 use MediaWiki\Block\Restriction\PageRestriction
;
26 use MediaWiki\Block\Restriction\NamespaceRestriction
;
27 use MediaWiki\MediaWikiServices
;
30 * A special page that allows users with 'block' right to block users from
31 * editing pages and other actions
33 * @ingroup SpecialPage
35 class SpecialBlock
extends FormSpecialPage
{
36 /** @var User|string|null User to be blocked, as passed either by parameter (url?wpTarget=Foo)
37 * or as subpage (Special:Block/Foo)
41 /** @var int DatabaseBlock::TYPE_ constant */
44 /** @var User|string The previous block target */
45 protected $previousTarget;
47 /** @var bool Whether the previous submission of the form asked for HideUser */
48 protected $requestedHideUser;
51 protected $alreadyBlocked;
54 protected $preErrors = [];
56 public function __construct() {
57 parent
::__construct( 'Block', 'block' );
60 public function doesWrites() {
65 * Checks that the user can unblock themselves if they are trying to do so
68 * @throws ErrorPageError
70 protected function checkExecutePermissions( User
$user ) {
71 parent
::checkExecutePermissions( $user );
72 # T17810: blocked admins should have limited access here
73 $status = self
::checkUnblockSelf( $this->target
, $user );
74 if ( $status !== true ) {
75 throw new ErrorPageError( 'badaccess', $status );
80 * We allow certain special cases where user is blocked
84 public function requiresUnblock() {
89 * Handle some magic here
93 protected function setParameter( $par ) {
94 # Extract variables from the request. Try not to get into a situation where we
95 # need to extract *every* variable from the form just for processing here, but
96 # there are legitimate uses for some variables
97 $request = $this->getRequest();
98 list( $this->target
, $this->type
) = self
::getTargetAndType( $par, $request );
99 if ( $this->target
instanceof User
) {
100 # Set the 'relevant user' in the skin, so it displays links like Contributions,
101 # User logs, UserRights, etc.
102 $this->getSkin()->setRelevantUser( $this->target
);
105 list( $this->previousTarget
, /*...*/ ) =
106 DatabaseBlock
::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
107 $this->requestedHideUser
= $request->getBool( 'wpHideUser' );
111 * Customizes the HTMLForm a bit
113 * @param HTMLForm $form
115 protected function alterForm( HTMLForm
$form ) {
116 $form->setHeaderText( '' );
117 $form->setSubmitDestructive();
119 $msg = $this->alreadyBlocked ?
'ipb-change-block' : 'ipbsubmit';
120 $form->setSubmitTextMsg( $msg );
122 $this->addHelpLink( 'Help:Blocking users' );
124 # Don't need to do anything if the form has been posted
125 if ( !$this->getRequest()->wasPosted() && $this->preErrors
) {
126 $s = $form->formatErrors( $this->preErrors
);
128 $form->addHeaderText( Html
::rawElement(
130 [ 'class' => 'error' ],
137 protected function getDisplayFormat() {
142 * Get the HTMLForm descriptor array for the block form
145 protected function getFormFields() {
146 $conf = $this->getConfig();
147 $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
148 $blockAllowsUTEdit = $conf->get( 'BlockAllowsUTEdit' );
150 $this->getOutput()->enableOOUI();
152 $user = $this->getUser();
154 $suggestedDurations = self
::getSuggestedDurations();
162 'id' => 'mw-bi-target',
166 'validation-callback' => [ __CLASS__
, 'validateTargetField' ],
167 'section' => 'target',
172 'label-message' => 'block-prevent-edit',
174 'section' => 'actions',
175 'disabled' => $enablePartialBlocks ?
false : true,
178 if ( $enablePartialBlocks ) {
179 $a['EditingRestriction'] = [
181 'cssclass' => 'mw-block-editing-restriction',
183 $this->msg( 'ipb-sitewide' )->escaped() .
184 new \OOUI\
LabelWidget( [
185 'classes' => [ 'oo-ui-inline-help' ],
186 'label' => $this->msg( 'ipb-sitewide-help' )->text(),
188 $this->msg( 'ipb-partial' )->escaped() .
189 new \OOUI\
LabelWidget( [
190 'classes' => [ 'oo-ui-inline-help' ],
191 'label' => $this->msg( 'ipb-partial-help' )->text(),
194 'section' => 'actions',
196 $a['PageRestrictions'] = [
197 'type' => 'titlesmultiselect',
198 'label' => $this->msg( 'ipb-pages-label' )->text(),
201 'cssclass' => 'mw-block-restriction',
202 'showMissing' => false,
203 'excludeDynamicNamespaces' => true,
205 'autocomplete' => false
207 'section' => 'actions',
209 $a['NamespaceRestrictions'] = [
210 'type' => 'namespacesmultiselect',
211 'label' => $this->msg( 'ipb-namespaces-label' )->text(),
213 'cssclass' => 'mw-block-restriction',
215 'autocomplete' => false
217 'section' => 'actions',
221 $a['CreateAccount'] = [
223 'label-message' => 'ipbcreateaccount',
225 'section' => 'actions',
228 if ( self
::canBlockEmail( $user ) ) {
229 $a['DisableEmail'] = [
231 'label-message' => 'ipbemailban',
232 'section' => 'actions',
236 if ( $blockAllowsUTEdit ) {
237 $a['DisableUTEdit'] = [
239 'label-message' => 'ipb-disableusertalk',
241 'section' => 'actions',
248 'options' => $suggestedDurations,
249 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
250 'section' => 'expiry',
254 'type' => 'selectandother',
255 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
256 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
257 // Unicode codepoints.
258 'maxlength' => CommentStore
::COMMENT_CHARACTER_LIMIT
,
259 'maxlength-unit' => 'codepoints',
260 'options-message' => 'ipbreason-dropdown',
261 'section' => 'reason',
266 'label-message' => 'ipbenableautoblock',
268 'section' => 'options',
271 # Allow some users to hide name from block log, blocklist and listusers
272 if ( $user->isAllowed( 'hideuser' ) ) {
275 'label-message' => 'ipbhidename',
276 'cssclass' => 'mw-block-hideuser',
277 'section' => 'options',
281 # Watchlist their user page? (Only if user is logged in)
282 if ( $user->isLoggedIn() ) {
285 'label-message' => 'ipbwatchuser',
286 'section' => 'options',
292 'label-message' => 'ipb-hardblock',
294 'section' => 'options',
297 # This is basically a copy of the Target field, but the user can't change it, so we
298 # can see if the warnings we maybe showed to the user before still apply
299 $a['PreviousTarget'] = [
304 # We'll turn this into a checkbox if we need to
308 'label-message' => 'ipb-confirm',
309 'cssclass' => 'mw-block-confirm',
312 $this->maybeAlterFormDefaults( $a );
314 // Allow extensions to add more fields
315 Hooks
::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
321 * If the user has already been blocked with similar settings, load that block
322 * and change the defaults for the form fields to match the existing settings.
323 * @param array &$fields HTMLForm descriptor array
325 protected function maybeAlterFormDefaults( &$fields ) {
326 # This will be overwritten by request data
327 $fields['Target']['default'] = (string)$this->target
;
329 if ( $this->target
) {
330 $status = self
::validateTarget( $this->target
, $this->getUser() );
331 if ( !$status->isOK() ) {
332 $errors = $status->getErrorsArray();
333 $this->preErrors
= array_merge( $this->preErrors
, $errors );
338 $fields['PreviousTarget']['default'] = (string)$this->target
;
340 $block = DatabaseBlock
::newFromTarget( $this->target
);
342 // Populate fields if there is a block that is not an autoblock; if it is a range
343 // block, only populate the fields if the range is the same as $this->target
344 if ( $block instanceof DatabaseBlock
&& $block->getType() !== DatabaseBlock
::TYPE_AUTO
345 && ( $this->type
!= DatabaseBlock
::TYPE_RANGE
346 ||
$block->getTarget() == $this->target
)
348 $fields['HardBlock']['default'] = $block->isHardblock();
349 $fields['CreateAccount']['default'] = $block->isCreateAccountBlocked();
350 $fields['AutoBlock']['default'] = $block->isAutoblocking();
352 if ( isset( $fields['DisableEmail'] ) ) {
353 $fields['DisableEmail']['default'] = $block->isEmailBlocked();
356 if ( isset( $fields['HideUser'] ) ) {
357 $fields['HideUser']['default'] = $block->getHideName();
360 if ( isset( $fields['DisableUTEdit'] ) ) {
361 $fields['DisableUTEdit']['default'] = !$block->isUsertalkEditAllowed();
364 // If the username was hidden (ipb_deleted == 1), don't show the reason
365 // unless this user also has rights to hideuser: T37839
366 if ( !$block->getHideName() ||
$this->getUser()->isAllowed( 'hideuser' ) ) {
367 $fields['Reason']['default'] = $block->getReason();
369 $fields['Reason']['default'] = '';
372 if ( $this->getRequest()->wasPosted() ) {
373 # Ok, so we got a POST submission asking us to reblock a user. So show the
374 # confirm checkbox; the user will only see it if they haven't previously
375 $fields['Confirm']['type'] = 'check';
377 # We got a target, but it wasn't a POST request, so the user must have gone
378 # to a link like [[Special:Block/User]]. We don't need to show the checkbox
379 # as long as they go ahead and block *that* user
380 $fields['Confirm']['default'] = 1;
383 if ( $block->getExpiry() == 'infinity' ) {
384 $fields['Expiry']['default'] = 'infinite';
386 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822
, $block->getExpiry() );
389 $this->alreadyBlocked
= true;
390 $this->preErrors
[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
393 if ( $this->alreadyBlocked ||
$this->getRequest()->wasPosted()
394 ||
$this->getRequest()->getCheck( 'wpCreateAccount' )
396 $this->getOutput()->addJsConfigVars( 'wgCreateAccountDirty', true );
399 # We always need confirmation to do HideUser
400 if ( $this->requestedHideUser
) {
401 $fields['Confirm']['type'] = 'check';
402 unset( $fields['Confirm']['default'] );
403 $this->preErrors
[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
406 # Or if the user is trying to block themselves
407 if ( (string)$this->target
=== $this->getUser()->getName() ) {
408 $fields['Confirm']['type'] = 'check';
409 unset( $fields['Confirm']['default'] );
410 $this->preErrors
[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
413 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
414 if ( $block instanceof DatabaseBlock
&& !$block->isSitewide() ) {
415 $fields['EditingRestriction']['default'] = 'partial';
417 $fields['EditingRestriction']['default'] = 'sitewide';
420 if ( $block instanceof DatabaseBlock
) {
421 $pageRestrictions = [];
422 $namespaceRestrictions = [];
423 foreach ( $block->getRestrictions() as $restriction ) {
424 switch ( $restriction->getType() ) {
425 case PageRestriction
::TYPE
:
426 if ( $restriction->getTitle() ) {
427 $pageRestrictions[] = $restriction->getTitle()->getPrefixedText();
430 case NamespaceRestriction
::TYPE
:
431 $namespaceRestrictions[] = $restriction->getValue();
437 !$block->isSitewide() &&
438 empty( $pageRestrictions ) &&
439 empty( $namespaceRestrictions )
441 $fields['Editing']['default'] = false;
444 // Sort the restrictions so they are in alphabetical order.
445 sort( $pageRestrictions );
446 $fields['PageRestrictions']['default'] = implode( "\n", $pageRestrictions );
447 sort( $namespaceRestrictions );
448 $fields['NamespaceRestrictions']['default'] = implode( "\n", $namespaceRestrictions );
454 * Add header elements like block log entries, etc.
457 protected function preText() {
458 $this->getOutput()->addModuleStyles( [
459 'mediawiki.widgets.TagMultiselectWidget.styles',
462 $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
464 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
465 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
467 $otherBlockMessages = [];
468 if ( $this->target
!== null ) {
469 $targetName = $this->target
;
470 if ( $this->target
instanceof User
) {
471 $targetName = $this->target
->getName();
473 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
474 Hooks
::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
476 if ( count( $otherBlockMessages ) ) {
477 $s = Html
::rawElement(
480 $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
485 foreach ( $otherBlockMessages as $link ) {
486 $list .= Html
::rawElement( 'li', [], $link ) . "\n";
489 $s .= Html
::rawElement(
491 [ 'class' => 'mw-blockip-alreadyblocked' ],
503 * Add footer elements to the form
506 protected function postText() {
509 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
511 $linkRenderer = $this->getLinkRenderer();
512 # Link to the user's contributions, if applicable
513 if ( $this->target
instanceof User
) {
514 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $this->target
->getName() );
515 $links[] = $linkRenderer->makeLink(
517 $this->msg( 'ipb-blocklist-contribs', $this->target
->getName() )->text()
521 # Link to unblock the specified user, or to a blank unblock form
522 if ( $this->target
instanceof User
) {
523 $message = $this->msg(
525 wfEscapeWikiText( $this->target
->getName() )
527 $list = SpecialPage
::getTitleFor( 'Unblock', $this->target
->getName() );
529 $message = $this->msg( 'ipb-unblock' )->parse();
530 $list = SpecialPage
::getTitleFor( 'Unblock' );
532 $links[] = $linkRenderer->makeKnownLink(
534 new HtmlArmor( $message )
537 # Link to the block list
538 $links[] = $linkRenderer->makeKnownLink(
539 SpecialPage
::getTitleFor( 'BlockList' ),
540 $this->msg( 'ipb-blocklist' )->text()
543 $user = $this->getUser();
545 # Link to edit the block dropdown reasons, if applicable
546 if ( $user->isAllowed( 'editinterface' ) ) {
547 $links[] = $linkRenderer->makeKnownLink(
548 $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
549 $this->msg( 'ipb-edit-dropdown' )->text(),
551 [ 'action' => 'edit' ]
555 $text = Html
::rawElement(
557 [ 'class' => 'mw-ipb-conveniencelinks' ],
558 $this->getLanguage()->pipeList( $links )
561 $userTitle = self
::getTargetUserTitle( $this->target
);
563 # Get relevant extracts from the block and suppression logs, if possible
566 LogEventsList
::showLogExtract(
573 'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
574 'showIfEmpty' => false
579 # Add suppression block entries if allowed
580 if ( $user->isAllowed( 'suppressionlog' ) ) {
581 LogEventsList
::showLogExtract(
588 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
589 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
590 'showIfEmpty' => false
602 * Get a user page target for things like logs.
603 * This handles account and IP range targets.
604 * @param User|string $target
607 protected static function getTargetUserTitle( $target ) {
608 if ( $target instanceof User
) {
609 return $target->getUserPage();
610 } elseif ( IP
::isIPAddress( $target ) ) {
611 return Title
::makeTitleSafe( NS_USER
, $target );
618 * Determine the target of the block, and the type of target
619 * @todo Should be in DatabaseBlock.php?
620 * @param string $par Subpage parameter passed to setup, or data value from
622 * @param WebRequest|null $request Optionally try and get data from a request too
623 * @return array [ User|string|null, DatabaseBlock::TYPE_ constant|null ]
624 * @phan-return array{0:User|string|null,1:int|null}
626 public static function getTargetAndType( $par, WebRequest
$request = null ) {
633 # The HTMLForm will check wpTarget first and only if it doesn't get
634 # a value use the default, which will be generated from the options
635 # below; so this has to have a higher precedence here than $par, or
636 # we could end up with different values in $this->target and the HTMLForm!
637 if ( $request instanceof WebRequest
) {
638 $target = $request->getText( 'wpTarget', null );
645 if ( $request instanceof WebRequest
) {
646 $target = $request->getText( 'ip', null );
651 if ( $request instanceof WebRequest
) {
652 $target = $request->getText( 'wpBlockAddress', null );
659 list( $target, $type ) = DatabaseBlock
::parseTarget( $target );
661 if ( $type !== null ) {
662 return [ $target, $type ];
666 return [ null, null ];
670 * HTMLForm field validation-callback for Target field.
672 * @param string $value
673 * @param array $alldata
674 * @param HTMLForm $form
677 public static function validateTargetField( $value, $alldata, $form ) {
678 $status = self
::validateTarget( $value, $form->getUser() );
679 if ( !$status->isOK() ) {
680 $errors = $status->getErrorsArray();
682 return $form->msg( ...$errors[0] );
689 * Validate a block target.
692 * @param string $value Block target to check
693 * @param User $user Performer of the block
696 public static function validateTarget( $value, User
$user ) {
697 global $wgBlockCIDRLimit;
699 /** @var User $target */
700 list( $target, $type ) = self
::getTargetAndType( $value );
701 $status = Status
::newGood( $target );
703 if ( $type == DatabaseBlock
::TYPE_USER
) {
704 if ( $target->isAnon() ) {
707 wfEscapeWikiText( $target->getName() )
711 $unblockStatus = self
::checkUnblockSelf( $target, $user );
712 if ( $unblockStatus !== true ) {
713 $status->fatal( 'badaccess', $unblockStatus );
715 } elseif ( $type == DatabaseBlock
::TYPE_RANGE
) {
716 list( $ip, $range ) = explode( '/', $target, 2 );
719 ( IP
::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
720 ( IP
::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
722 // Range block effectively disabled
723 $status->fatal( 'range_block_disabled' );
727 ( IP
::isIPv4( $ip ) && $range > 32 ) ||
728 ( IP
::isIPv6( $ip ) && $range > 128 )
731 $status->fatal( 'ip_range_invalid' );
734 if ( IP
::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
735 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
738 if ( IP
::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
739 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
741 } elseif ( $type == DatabaseBlock
::TYPE_IP
) {
744 $status->fatal( 'badipaddress' );
751 * Given the form data, actually implement a block. This is also called from ApiBlock.
754 * @param IContextSource $context
757 public static function processForm( array $data, IContextSource
$context ) {
758 $performer = $context->getUser();
759 $enablePartialBlocks = $context->getConfig()->get( 'EnablePartialBlocks' );
760 $isPartialBlock = $enablePartialBlocks &&
761 isset( $data['EditingRestriction'] ) &&
762 $data['EditingRestriction'] === 'partial';
764 # This might have been a hidden field or a checkbox, so interesting data
766 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
768 /** @var User $target */
769 list( $target, $type ) = self
::getTargetAndType( $data['Target'] );
770 if ( $type == DatabaseBlock
::TYPE_USER
) {
772 $target = $user->getName();
773 $userId = $user->getId();
775 # Give admins a heads-up before they go and block themselves. Much messier
776 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
777 # permission anyway, although the code does allow for it.
778 # Note: Important to use $target instead of $data['Target']
779 # since both $data['PreviousTarget'] and $target are normalized
780 # but $data['target'] gets overridden by (non-normalized) request variable
781 # from previous request.
782 if ( $target === $performer->getName() &&
783 ( $data['PreviousTarget'] !== $target ||
!$data['Confirm'] )
785 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
787 } elseif ( $type == DatabaseBlock
::TYPE_RANGE
) {
790 } elseif ( $type == DatabaseBlock
::TYPE_IP
) {
792 $target = $target->getName();
795 # This should have been caught in the form field validation
796 return [ 'badipaddress' ];
799 $expiryTime = self
::parseExpiryInput( $data['Expiry'] );
802 // an expiry time is needed
803 ( strlen( $data['Expiry'] ) == 0 ) ||
804 // can't be a larger string as 50 (it should be a time format in any way)
805 ( strlen( $data['Expiry'] ) > 50 ) ||
806 // check, if the time could be parsed
809 return [ 'ipb_expiry_invalid' ];
812 // an expiry time should be in the future, not in the
813 // past (wouldn't make any sense) - bug T123069
814 if ( $expiryTime < wfTimestampNow() ) {
815 return [ 'ipb_expiry_old' ];
818 if ( !isset( $data['DisableEmail'] ) ) {
819 $data['DisableEmail'] = false;
822 # If the user has done the form 'properly', they won't even have been given the
823 # option to suppress-block unless they have the 'hideuser' permission
824 if ( !isset( $data['HideUser'] ) ) {
825 $data['HideUser'] = false;
828 if ( $data['HideUser'] ) {
829 if ( !$performer->isAllowed( 'hideuser' ) ) {
830 # this codepath is unreachable except by a malicious user spoofing forms,
831 # or by race conditions (user has hideuser and block rights, loads block form,
832 # and loses hideuser rights before submission); so need to fail completely
833 # rather than just silently disable hiding
834 return [ 'badaccess-group0' ];
837 if ( $isPartialBlock ) {
838 return [ 'ipb_hide_partial' ];
841 # Recheck params here...
842 $hideUserContribLimit = $context->getConfig()->get( 'HideUserContribLimit' );
843 if ( $type != DatabaseBlock
::TYPE_USER
) {
844 $data['HideUser'] = false; # IP users should not be hidden
845 } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
847 return [ 'ipb_expiry_temp' ];
848 } elseif ( $hideUserContribLimit !== false
849 && $user->getEditCount() > $hideUserContribLimit
851 # Typically, the user should have a handful of edits.
852 # Disallow hiding users with many edits for performance.
853 return [ [ 'ipb_hide_invalid',
854 Message
::numParam( $hideUserContribLimit ) ] ];
855 } elseif ( !$data['Confirm'] ) {
856 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
860 $blockAllowsUTEdit = $context->getConfig()->get( 'BlockAllowsUTEdit' );
861 $userTalkEditAllowed = !$blockAllowsUTEdit ||
!$data['DisableUTEdit'];
862 if ( !$userTalkEditAllowed &&
864 !in_array( NS_USER_TALK
, explode( "\n", $data['NamespaceRestrictions'] ) )
866 return [ 'ipb-prevent-user-talk-edit' ];
869 # Create block object.
870 $block = new DatabaseBlock();
871 $block->setTarget( $target );
872 $block->setBlocker( $performer );
873 $block->setReason( $data['Reason'][0] );
874 $block->setExpiry( $expiryTime );
875 $block->isCreateAccountBlocked( $data['CreateAccount'] );
876 $block->isUsertalkEditAllowed( $userTalkEditAllowed );
877 $block->isEmailBlocked( $data['DisableEmail'] );
878 $block->isHardblock( $data['HardBlock'] );
879 $block->isAutoblocking( $data['AutoBlock'] );
880 $block->setHideName( $data['HideUser'] );
882 if ( $isPartialBlock ) {
883 $block->isSitewide( false );
886 $reason = [ 'hookaborted' ];
887 if ( !Hooks
::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
891 $pageRestrictions = [];
892 $namespaceRestrictions = [];
893 if ( $enablePartialBlocks ) {
894 if ( $data['PageRestrictions'] !== '' ) {
895 $pageRestrictions = array_map( function ( $text ) {
896 $title = Title
::newFromText( $text );
897 // Use the link cache since the title has already been loaded when
898 // the field was validated.
899 $restriction = new PageRestriction( 0, $title->getArticleID() );
900 $restriction->setTitle( $title );
902 }, explode( "\n", $data['PageRestrictions'] ) );
904 if ( $data['NamespaceRestrictions'] !== '' ) {
905 $namespaceRestrictions = array_map( function ( $id ) {
906 return new NamespaceRestriction( 0, $id );
907 }, explode( "\n", $data['NamespaceRestrictions'] ) );
910 $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
911 $block->setRestrictions( $restrictions );
915 # Try to insert block. Is there a conflicting block?
916 $status = $block->insert();
918 # Indicates whether the user is confirming the block and is aware of
919 # the conflict (did not change the block target in the meantime)
920 $blockNotConfirmed = !$data['Confirm'] ||
( array_key_exists( 'PreviousTarget', $data )
921 && $data['PreviousTarget'] !== $target );
923 # Special case for API - T34434
924 $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
926 # Show form unless the user is already aware of this...
927 if ( $blockNotConfirmed ||
$reblockNotAllowed ) {
928 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
929 # Otherwise, try to update the block...
931 # This returns direct blocks before autoblocks/rangeblocks, since we should
932 # be sure the user is blocked by now it should work for our purposes
933 $currentBlock = DatabaseBlock
::newFromTarget( $target );
934 if ( $block->equals( $currentBlock ) ) {
935 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
937 # If the name was hidden and the blocking user cannot hide
938 # names, then don't allow any block changes...
939 if ( $currentBlock->getHideName() && !$performer->isAllowed( 'hideuser' ) ) {
940 return [ 'cant-see-hidden-user' ];
943 $priorBlock = clone $currentBlock;
944 $currentBlock->isHardblock( $block->isHardblock() );
945 $currentBlock->isCreateAccountBlocked( $block->isCreateAccountBlocked() );
946 $currentBlock->setExpiry( $block->getExpiry() );
947 $currentBlock->isAutoblocking( $block->isAutoblocking() );
948 $currentBlock->setHideName( $block->getHideName() );
949 $currentBlock->isEmailBlocked( $block->isEmailBlocked() );
950 $currentBlock->isUsertalkEditAllowed( $block->isUsertalkEditAllowed() );
951 $currentBlock->setReason( $block->getReason() );
953 if ( $enablePartialBlocks ) {
954 // Maintain the sitewide status. If partial blocks is not enabled,
955 // saving the block will result in a sitewide block.
956 $currentBlock->isSitewide( $block->isSitewide() );
958 // Set the block id of the restrictions.
959 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
960 $currentBlock->setRestrictions(
961 $blockRestrictionStore->setBlockId( $currentBlock->getId(), $restrictions )
965 $status = $currentBlock->update();
966 // TODO handle failure
968 $logaction = 'reblock';
970 # Unset _deleted fields if requested
971 if ( $currentBlock->getHideName() && !$data['HideUser'] ) {
972 RevisionDeleteUser
::unsuppressUserName( $target, $userId );
975 # If hiding/unhiding a name, this should go in the private logs
976 if ( (bool)$currentBlock->getHideName() ) {
977 $data['HideUser'] = true;
980 $block = $currentBlock;
983 $logaction = 'block';
986 Hooks
::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
988 # Set *_deleted fields if requested
989 if ( $data['HideUser'] ) {
990 RevisionDeleteUser
::suppressUserName( $target, $userId );
993 # Can't watch a rangeblock
994 if ( $type != DatabaseBlock
::TYPE_RANGE
&& $data['Watch'] ) {
995 WatchAction
::doWatch(
996 Title
::makeTitle( NS_USER
, $target ),
998 User
::IGNORE_USER_RIGHTS
1002 # DatabaseBlock constructor sanitizes certain block options on insert
1003 $data['BlockEmail'] = $block->isEmailBlocked();
1004 $data['AutoBlock'] = $block->isAutoblocking();
1006 # Prepare log parameters
1008 $logParams['5::duration'] = $data['Expiry'];
1009 $logParams['6::flags'] = self
::blockLogFlags( $data, $type );
1010 $logParams['sitewide'] = $block->isSitewide();
1012 if ( $enablePartialBlocks && !$block->isSitewide() ) {
1013 if ( $data['PageRestrictions'] !== '' ) {
1014 $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
1017 if ( $data['NamespaceRestrictions'] !== '' ) {
1018 $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
1022 # Make log entry, if the name is hidden, put it in the suppression log
1023 $log_type = $data['HideUser'] ?
'suppress' : 'block';
1024 $logEntry = new ManualLogEntry( $log_type, $logaction );
1025 $logEntry->setTarget( Title
::makeTitle( NS_USER
, $target ) );
1026 $logEntry->setComment( $data['Reason'][0] );
1027 $logEntry->setPerformer( $performer );
1028 $logEntry->setParameters( $logParams );
1029 # Relate log ID to block ID (T27763)
1030 $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
1031 $logId = $logEntry->insert();
1033 if ( !empty( $data['Tags'] ) ) {
1034 $logEntry->setTags( $data['Tags'] );
1037 $logEntry->publish( $logId );
1043 * Get an array of suggested block durations from MediaWiki:Ipboptions
1044 * @todo FIXME: This uses a rather odd syntax for the options, should it be converted
1045 * to the standard "**<duration>|<displayname>" format?
1046 * @param Language|null $lang The language to get the durations in, or null to use
1047 * the wiki's content language
1048 * @param bool $includeOther Whether to include the 'other' option in the list of
1052 public static function getSuggestedDurations( Language
$lang = null, $includeOther = true ) {
1054 $msg = $lang === null
1055 ?
wfMessage( 'ipboptions' )->inContentLanguage()->text()
1056 : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1058 if ( $msg == '-' ) {
1062 foreach ( explode( ',', $msg ) as $option ) {
1063 if ( strpos( $option, ':' ) === false ) {
1064 $option = "$option:$option";
1067 list( $show, $value ) = explode( ':', $option );
1071 if ( $a && $includeOther ) {
1072 // if options exist, add other to the end instead of the begining (which
1073 // is what happens by default).
1074 $a[ wfMessage( 'ipbother' )->text() ] = 'other';
1081 * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
1082 * ("24 May 2034", etc), into an absolute timestamp we can put into the database.
1084 * @todo strtotime() only accepts English strings. This means the expiry input
1085 * can only be specified in English.
1086 * @see https://www.php.net/manual/en/function.strtotime.php
1088 * @param string $expiry Whatever was typed into the form
1089 * @return string|bool Timestamp or 'infinity' or false on error.
1091 public static function parseExpiryInput( $expiry ) {
1092 if ( wfIsInfinity( $expiry ) ) {
1096 $expiry = strtotime( $expiry );
1098 if ( $expiry < 0 ||
$expiry === false ) {
1102 return wfTimestamp( TS_MW
, $expiry );
1106 * Can we do an email block?
1107 * @param User $user The sysop wanting to make a block
1110 public static function canBlockEmail( $user ) {
1111 global $wgEnableUserEmail, $wgSysopEmailBans;
1113 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1117 * T17810: blocked admins should not be able to block/unblock
1118 * others, and probably shouldn't be able to unblock themselves
1121 * Exception: Users can block the user who blocked them, to reduce
1122 * advantage of a malicious account blocking all admins (T150826)
1124 * @param User|int|string|null $target Target to block or unblock; could be a User object,
1125 * or a user ID or username, or null when the target is not known yet (e.g. when
1126 * displaying Special:Block)
1127 * @param User $performer User doing the request
1128 * @return bool|string True or error message key
1130 public static function checkUnblockSelf( $target, User
$performer ) {
1131 if ( is_int( $target ) ) {
1132 $target = User
::newFromId( $target );
1133 } elseif ( is_string( $target ) ) {
1134 $target = User
::newFromName( $target );
1136 if ( $performer->getBlock() ) {
1137 if ( $target instanceof User
&& $target->getId() == $performer->getId() ) {
1138 # User is trying to unblock themselves
1139 if ( $performer->isAllowed( 'unblockself' ) ) {
1141 # User blocked themselves and is now trying to reverse it
1142 } elseif ( $performer->blockedBy() === $performer->getName() ) {
1145 return 'ipbnounblockself';
1148 $target instanceof User
&&
1149 $performer->getBlock() instanceof DatabaseBlock
&&
1150 $performer->getBlock()->getBy() &&
1151 $performer->getBlock()->getBy() === $target->getId()
1153 // Allow users to block the user that blocked them.
1154 // This is to prevent a situation where a malicious user
1155 // blocks all other users. This way, the non-malicious
1156 // user can block the malicious user back, resulting
1161 # User is trying to block/unblock someone else
1162 return 'ipbblocked';
1170 * Return a comma-delimited list of "flags" to be passed to the log
1171 * reader for this block, to provide more information in the logs
1172 * @param array $data From HTMLForm data
1173 * @param int $type DatabaseBlock::TYPE_ constant (USER, RANGE, or IP)
1176 protected static function blockLogFlags( array $data, $type ) {
1177 $config = RequestContext
::getMain()->getConfig();
1179 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1183 # when blocking a user the option 'anononly' is not available/has no effect
1184 # -> do not write this into log
1185 if ( !$data['HardBlock'] && $type != DatabaseBlock
::TYPE_USER
) {
1186 // For grepping: message block-log-flags-anononly
1187 $flags[] = 'anononly';
1190 if ( $data['CreateAccount'] ) {
1191 // For grepping: message block-log-flags-nocreate
1192 $flags[] = 'nocreate';
1195 # Same as anononly, this is not displayed when blocking an IP address
1196 if ( !$data['AutoBlock'] && $type == DatabaseBlock
::TYPE_USER
) {
1197 // For grepping: message block-log-flags-noautoblock
1198 $flags[] = 'noautoblock';
1201 if ( $data['DisableEmail'] ) {
1202 // For grepping: message block-log-flags-noemail
1203 $flags[] = 'noemail';
1206 if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1207 // For grepping: message block-log-flags-nousertalk
1208 $flags[] = 'nousertalk';
1211 if ( $data['HideUser'] ) {
1212 // For grepping: message block-log-flags-hiddenname
1213 $flags[] = 'hiddenname';
1216 return implode( ',', $flags );
1220 * Process the form on POST submission.
1221 * @param array $data
1222 * @param HTMLForm|null $form
1223 * @return bool|array True for success, false for didn't-try, array of errors on failure
1225 public function onSubmit( array $data, HTMLForm
$form = null ) {
1226 // If "Editing" checkbox is unchecked, the block must be a partial block affecting
1227 // actions other than editing, and there must be no restrictions.
1228 if ( isset( $data['Editing'] ) && $data['Editing'] === false ) {
1229 $data['EditingRestriction'] = 'partial';
1230 $data['PageRestrictions'] = '';
1231 $data['NamespaceRestrictions'] = '';
1233 return self
::processForm( $data, $form->getContext() );
1237 * Do something exciting on successful processing of the form, most likely to show a
1238 * confirmation message
1240 public function onSuccess() {
1241 $out = $this->getOutput();
1242 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1243 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target
) );
1247 * Return an array of subpages beginning with $search that this special page will accept.
1249 * @param string $search Prefix to search for
1250 * @param int $limit Maximum number of results to return (usually 10)
1251 * @param int $offset Number of results to skip (usually 0)
1252 * @return string[] Matching subpages
1254 public function prefixSearchSubpages( $search, $limit, $offset ) {
1255 $user = User
::newFromName( $search );
1257 // No prefix suggestion for invalid user
1260 // Autocomplete subpage as user list - public to allow caching
1261 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
1264 protected function getGroupName() {