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) */
40 /** @var int DatabaseBlock::TYPE_ constant */
43 /** @var User|string The previous block target */
44 protected $previousTarget;
46 /** @var bool Whether the previous submission of the form asked for HideUser */
47 protected $requestedHideUser;
50 protected $alreadyBlocked;
53 protected $preErrors = [];
55 public function __construct() {
56 parent
::__construct( 'Block', 'block' );
59 public function doesWrites() {
64 * Checks that the user can unblock themselves if they are trying to do so
67 * @throws ErrorPageError
69 protected function checkExecutePermissions( User
$user ) {
70 parent
::checkExecutePermissions( $user );
71 # T17810: blocked admins should have limited access here
72 $status = self
::checkUnblockSelf( $this->target
, $user );
73 if ( $status !== true ) {
74 throw new ErrorPageError( 'badaccess', $status );
79 * We allow certain special cases where user is blocked
83 public function requiresUnblock() {
88 * Handle some magic here
92 protected function setParameter( $par ) {
93 # Extract variables from the request. Try not to get into a situation where we
94 # need to extract *every* variable from the form just for processing here, but
95 # there are legitimate uses for some variables
96 $request = $this->getRequest();
97 list( $this->target
, $this->type
) = self
::getTargetAndType( $par, $request );
98 if ( $this->target
instanceof User
) {
99 # Set the 'relevant user' in the skin, so it displays links like Contributions,
100 # User logs, UserRights, etc.
101 $this->getSkin()->setRelevantUser( $this->target
);
104 list( $this->previousTarget
, /*...*/ ) =
105 DatabaseBlock
::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
106 $this->requestedHideUser
= $request->getBool( 'wpHideUser' );
110 * Customizes the HTMLForm a bit
112 * @param HTMLForm $form
114 protected function alterForm( HTMLForm
$form ) {
115 $form->setHeaderText( '' );
116 $form->setSubmitDestructive();
118 $msg = $this->alreadyBlocked ?
'ipb-change-block' : 'ipbsubmit';
119 $form->setSubmitTextMsg( $msg );
121 $this->addHelpLink( 'Help:Blocking users' );
123 # Don't need to do anything if the form has been posted
124 if ( !$this->getRequest()->wasPosted() && $this->preErrors
) {
125 $s = $form->formatErrors( $this->preErrors
);
127 $form->addHeaderText( Html
::rawElement(
129 [ 'class' => 'error' ],
136 protected function getDisplayFormat() {
141 * Get the HTMLForm descriptor array for the block form
144 protected function getFormFields() {
145 $conf = $this->getConfig();
146 $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
147 $blockAllowsUTEdit = $conf->get( 'BlockAllowsUTEdit' );
149 $this->getOutput()->enableOOUI();
151 $user = $this->getUser();
153 $suggestedDurations = self
::getSuggestedDurations();
161 'id' => 'mw-bi-target',
165 'validation-callback' => [ __CLASS__
, 'validateTargetField' ],
166 'section' => 'target',
171 'label-message' => 'block-prevent-edit',
173 'section' => 'actions',
174 'disabled' => $enablePartialBlocks ?
false : true,
177 if ( $enablePartialBlocks ) {
178 $a['EditingRestriction'] = [
180 'cssclass' => 'mw-block-editing-restriction',
182 $this->msg( 'ipb-sitewide' )->escaped() .
183 new \OOUI\
LabelWidget( [
184 'classes' => [ 'oo-ui-inline-help' ],
185 'label' => $this->msg( 'ipb-sitewide-help' )->text(),
187 $this->msg( 'ipb-partial' )->escaped() .
188 new \OOUI\
LabelWidget( [
189 'classes' => [ 'oo-ui-inline-help' ],
190 'label' => $this->msg( 'ipb-partial-help' )->text(),
193 'section' => 'actions',
195 $a['PageRestrictions'] = [
196 'type' => 'titlesmultiselect',
197 'label' => $this->msg( 'ipb-pages-label' )->text(),
200 'cssclass' => 'mw-block-restriction',
201 'showMissing' => false,
202 'excludeDynamicNamespaces' => true,
204 'autocomplete' => false
206 'section' => 'actions',
208 $a['NamespaceRestrictions'] = [
209 'type' => 'namespacesmultiselect',
210 'label' => $this->msg( 'ipb-namespaces-label' )->text(),
212 'cssclass' => 'mw-block-restriction',
214 'autocomplete' => false
216 'section' => 'actions',
220 $a['CreateAccount'] = [
222 'label-message' => 'ipbcreateaccount',
224 'section' => 'actions',
227 if ( self
::canBlockEmail( $user ) ) {
228 $a['DisableEmail'] = [
230 'label-message' => 'ipbemailban',
231 'section' => 'actions',
235 if ( $blockAllowsUTEdit ) {
236 $a['DisableUTEdit'] = [
238 'label-message' => 'ipb-disableusertalk',
240 'section' => 'actions',
247 'options' => $suggestedDurations,
248 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
249 'section' => 'expiry',
253 'type' => 'selectandother',
254 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
255 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
256 // Unicode codepoints.
257 'maxlength' => CommentStore
::COMMENT_CHARACTER_LIMIT
,
258 'maxlength-unit' => 'codepoints',
259 'options-message' => 'ipbreason-dropdown',
260 'section' => 'reason',
265 'label-message' => 'ipbenableautoblock',
267 'section' => 'options',
270 # Allow some users to hide name from block log, blocklist and listusers
271 if ( $user->isAllowed( 'hideuser' ) ) {
274 'label-message' => 'ipbhidename',
275 'cssclass' => 'mw-block-hideuser',
276 'section' => 'options',
280 # Watchlist their user page? (Only if user is logged in)
281 if ( $user->isLoggedIn() ) {
284 'label-message' => 'ipbwatchuser',
285 'section' => 'options',
291 'label-message' => 'ipb-hardblock',
293 'section' => 'options',
296 # This is basically a copy of the Target field, but the user can't change it, so we
297 # can see if the warnings we maybe showed to the user before still apply
298 $a['PreviousTarget'] = [
303 # We'll turn this into a checkbox if we need to
307 'label-message' => 'ipb-confirm',
308 'cssclass' => 'mw-block-confirm',
311 $this->maybeAlterFormDefaults( $a );
313 // Allow extensions to add more fields
314 Hooks
::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
320 * If the user has already been blocked with similar settings, load that block
321 * and change the defaults for the form fields to match the existing settings.
322 * @param array &$fields HTMLForm descriptor array
324 protected function maybeAlterFormDefaults( &$fields ) {
325 # This will be overwritten by request data
326 $fields['Target']['default'] = (string)$this->target
;
328 if ( $this->target
) {
329 $status = self
::validateTarget( $this->target
, $this->getUser() );
330 if ( !$status->isOK() ) {
331 $errors = $status->getErrorsArray();
332 $this->preErrors
= array_merge( $this->preErrors
, $errors );
337 $fields['PreviousTarget']['default'] = (string)$this->target
;
339 $block = DatabaseBlock
::newFromTarget( $this->target
);
341 // Populate fields if there is a block that is not an autoblock; if it is a range
342 // block, only populate the fields if the range is the same as $this->target
343 if ( $block instanceof DatabaseBlock
&& $block->getType() !== DatabaseBlock
::TYPE_AUTO
344 && ( $this->type
!= DatabaseBlock
::TYPE_RANGE
345 ||
$block->getTarget() == $this->target
)
347 $fields['HardBlock']['default'] = $block->isHardblock();
348 $fields['CreateAccount']['default'] = $block->isCreateAccountBlocked();
349 $fields['AutoBlock']['default'] = $block->isAutoblocking();
351 if ( isset( $fields['DisableEmail'] ) ) {
352 $fields['DisableEmail']['default'] = $block->isEmailBlocked();
355 if ( isset( $fields['HideUser'] ) ) {
356 $fields['HideUser']['default'] = $block->getHideName();
359 if ( isset( $fields['DisableUTEdit'] ) ) {
360 $fields['DisableUTEdit']['default'] = !$block->isUsertalkEditAllowed();
363 // If the username was hidden (ipb_deleted == 1), don't show the reason
364 // unless this user also has rights to hideuser: T37839
365 if ( !$block->getHideName() ||
$this->getUser()->isAllowed( 'hideuser' ) ) {
366 $fields['Reason']['default'] = $block->getReason();
368 $fields['Reason']['default'] = '';
371 if ( $this->getRequest()->wasPosted() ) {
372 # Ok, so we got a POST submission asking us to reblock a user. So show the
373 # confirm checkbox; the user will only see it if they haven't previously
374 $fields['Confirm']['type'] = 'check';
376 # We got a target, but it wasn't a POST request, so the user must have gone
377 # to a link like [[Special:Block/User]]. We don't need to show the checkbox
378 # as long as they go ahead and block *that* user
379 $fields['Confirm']['default'] = 1;
382 if ( $block->getExpiry() == 'infinity' ) {
383 $fields['Expiry']['default'] = 'infinite';
385 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822
, $block->getExpiry() );
388 $this->alreadyBlocked
= true;
389 $this->preErrors
[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
392 if ( $this->alreadyBlocked ||
$this->getRequest()->wasPosted()
393 ||
$this->getRequest()->getCheck( 'wpCreateAccount' )
395 $this->getOutput()->addJsConfigVars( 'wgCreateAccountDirty', true );
398 # We always need confirmation to do HideUser
399 if ( $this->requestedHideUser
) {
400 $fields['Confirm']['type'] = 'check';
401 unset( $fields['Confirm']['default'] );
402 $this->preErrors
[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
405 # Or if the user is trying to block themselves
406 if ( (string)$this->target
=== $this->getUser()->getName() ) {
407 $fields['Confirm']['type'] = 'check';
408 unset( $fields['Confirm']['default'] );
409 $this->preErrors
[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
412 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
413 if ( $block instanceof DatabaseBlock
&& !$block->isSitewide() ) {
414 $fields['EditingRestriction']['default'] = 'partial';
416 $fields['EditingRestriction']['default'] = 'sitewide';
419 if ( $block instanceof DatabaseBlock
) {
420 $pageRestrictions = [];
421 $namespaceRestrictions = [];
422 foreach ( $block->getRestrictions() as $restriction ) {
423 switch ( $restriction->getType() ) {
424 case PageRestriction
::TYPE
:
425 if ( $restriction->getTitle() ) {
426 $pageRestrictions[] = $restriction->getTitle()->getPrefixedText();
429 case NamespaceRestriction
::TYPE
:
430 $namespaceRestrictions[] = $restriction->getValue();
436 !$block->isSitewide() &&
437 empty( $pageRestrictions ) &&
438 empty( $namespaceRestrictions )
440 $fields['Editing']['default'] = false;
443 // Sort the restrictions so they are in alphabetical order.
444 sort( $pageRestrictions );
445 $fields['PageRestrictions']['default'] = implode( "\n", $pageRestrictions );
446 sort( $namespaceRestrictions );
447 $fields['NamespaceRestrictions']['default'] = implode( "\n", $namespaceRestrictions );
453 * Add header elements like block log entries, etc.
456 protected function preText() {
457 $this->getOutput()->addModuleStyles( [
458 'mediawiki.widgets.TagMultiselectWidget.styles',
461 $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
463 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
464 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
466 $otherBlockMessages = [];
467 if ( $this->target
!== null ) {
468 $targetName = $this->target
;
469 if ( $this->target
instanceof User
) {
470 $targetName = $this->target
->getName();
472 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
473 Hooks
::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
475 if ( count( $otherBlockMessages ) ) {
476 $s = Html
::rawElement(
479 $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
484 foreach ( $otherBlockMessages as $link ) {
485 $list .= Html
::rawElement( 'li', [], $link ) . "\n";
488 $s .= Html
::rawElement(
490 [ 'class' => 'mw-blockip-alreadyblocked' ],
502 * Add footer elements to the form
505 protected function postText() {
508 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
510 $linkRenderer = $this->getLinkRenderer();
511 # Link to the user's contributions, if applicable
512 if ( $this->target
instanceof User
) {
513 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $this->target
->getName() );
514 $links[] = $linkRenderer->makeLink(
516 $this->msg( 'ipb-blocklist-contribs', $this->target
->getName() )->text()
520 # Link to unblock the specified user, or to a blank unblock form
521 if ( $this->target
instanceof User
) {
522 $message = $this->msg(
524 wfEscapeWikiText( $this->target
->getName() )
526 $list = SpecialPage
::getTitleFor( 'Unblock', $this->target
->getName() );
528 $message = $this->msg( 'ipb-unblock' )->parse();
529 $list = SpecialPage
::getTitleFor( 'Unblock' );
531 $links[] = $linkRenderer->makeKnownLink(
533 new HtmlArmor( $message )
536 # Link to the block list
537 $links[] = $linkRenderer->makeKnownLink(
538 SpecialPage
::getTitleFor( 'BlockList' ),
539 $this->msg( 'ipb-blocklist' )->text()
542 $user = $this->getUser();
544 # Link to edit the block dropdown reasons, if applicable
545 if ( $user->isAllowed( 'editinterface' ) ) {
546 $links[] = $linkRenderer->makeKnownLink(
547 $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
548 $this->msg( 'ipb-edit-dropdown' )->text(),
550 [ 'action' => 'edit' ]
554 $text = Html
::rawElement(
556 [ 'class' => 'mw-ipb-conveniencelinks' ],
557 $this->getLanguage()->pipeList( $links )
560 $userTitle = self
::getTargetUserTitle( $this->target
);
562 # Get relevant extracts from the block and suppression logs, if possible
565 LogEventsList
::showLogExtract(
572 'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
573 'showIfEmpty' => false
578 # Add suppression block entries if allowed
579 if ( $user->isAllowed( 'suppressionlog' ) ) {
580 LogEventsList
::showLogExtract(
587 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
588 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
589 'showIfEmpty' => false
601 * Get a user page target for things like logs.
602 * This handles account and IP range targets.
603 * @param User|string $target
606 protected static function getTargetUserTitle( $target ) {
607 if ( $target instanceof User
) {
608 return $target->getUserPage();
609 } elseif ( IP
::isIPAddress( $target ) ) {
610 return Title
::makeTitleSafe( NS_USER
, $target );
617 * Determine the target of the block, and the type of target
618 * @todo Should be in DatabaseBlock.php?
619 * @param string $par Subpage parameter passed to setup, or data value from
621 * @param WebRequest|null $request Optionally try and get data from a request too
622 * @return array [ User|string|null, DatabaseBlock::TYPE_ constant|null ]
623 * @phan-return array{0:User|string|null,1:int|null}
625 public static function getTargetAndType( $par, WebRequest
$request = null ) {
632 # The HTMLForm will check wpTarget first and only if it doesn't get
633 # a value use the default, which will be generated from the options
634 # below; so this has to have a higher precedence here than $par, or
635 # we could end up with different values in $this->target and the HTMLForm!
636 if ( $request instanceof WebRequest
) {
637 $target = $request->getText( 'wpTarget', null );
644 if ( $request instanceof WebRequest
) {
645 $target = $request->getText( 'ip', null );
650 if ( $request instanceof WebRequest
) {
651 $target = $request->getText( 'wpBlockAddress', null );
658 list( $target, $type ) = DatabaseBlock
::parseTarget( $target );
660 if ( $type !== null ) {
661 return [ $target, $type ];
665 return [ null, null ];
669 * HTMLForm field validation-callback for Target field.
671 * @param string $value
672 * @param array $alldata
673 * @param HTMLForm $form
676 public static function validateTargetField( $value, $alldata, $form ) {
677 $status = self
::validateTarget( $value, $form->getUser() );
678 if ( !$status->isOK() ) {
679 $errors = $status->getErrorsArray();
681 return $form->msg( ...$errors[0] );
688 * Validate a block target.
691 * @param string $value Block target to check
692 * @param User $user Performer of the block
695 public static function validateTarget( $value, User
$user ) {
696 global $wgBlockCIDRLimit;
698 /** @var User $target */
699 list( $target, $type ) = self
::getTargetAndType( $value );
700 $status = Status
::newGood( $target );
702 if ( $type == DatabaseBlock
::TYPE_USER
) {
703 if ( $target->isAnon() ) {
706 wfEscapeWikiText( $target->getName() )
710 $unblockStatus = self
::checkUnblockSelf( $target, $user );
711 if ( $unblockStatus !== true ) {
712 $status->fatal( 'badaccess', $unblockStatus );
714 } elseif ( $type == DatabaseBlock
::TYPE_RANGE
) {
715 list( $ip, $range ) = explode( '/', $target, 2 );
718 ( IP
::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
719 ( IP
::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
721 // Range block effectively disabled
722 $status->fatal( 'range_block_disabled' );
726 ( IP
::isIPv4( $ip ) && $range > 32 ) ||
727 ( IP
::isIPv6( $ip ) && $range > 128 )
730 $status->fatal( 'ip_range_invalid' );
733 if ( IP
::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
734 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
737 if ( IP
::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
738 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
740 } elseif ( $type == DatabaseBlock
::TYPE_IP
) {
743 $status->fatal( 'badipaddress' );
750 * Given the form data, actually implement a block. This is also called from ApiBlock.
753 * @param IContextSource $context
756 public static function processForm( array $data, IContextSource
$context ) {
757 global $wgBlockAllowsUTEdit, $wgHideUserContribLimit;
759 $performer = $context->getUser();
760 $enablePartialBlocks = $context->getConfig()->get( 'EnablePartialBlocks' );
761 $isPartialBlock = $enablePartialBlocks &&
762 isset( $data['EditingRestriction'] ) &&
763 $data['EditingRestriction'] === 'partial';
765 // Handled by field validator callback
766 // self::validateTargetField( $data['Target'] );
768 # This might have been a hidden field or a checkbox, so interesting data
770 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
772 /** @var User $target */
773 list( $target, $type ) = self
::getTargetAndType( $data['Target'] );
774 if ( $type == DatabaseBlock
::TYPE_USER
) {
776 $target = $user->getName();
777 $userId = $user->getId();
779 # Give admins a heads-up before they go and block themselves. Much messier
780 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
781 # permission anyway, although the code does allow for it.
782 # Note: Important to use $target instead of $data['Target']
783 # since both $data['PreviousTarget'] and $target are normalized
784 # but $data['target'] gets overridden by (non-normalized) request variable
785 # from previous request.
786 if ( $target === $performer->getName() &&
787 ( $data['PreviousTarget'] !== $target ||
!$data['Confirm'] )
789 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
791 } elseif ( $type == DatabaseBlock
::TYPE_RANGE
) {
794 } elseif ( $type == DatabaseBlock
::TYPE_IP
) {
796 $target = $target->getName();
799 # This should have been caught in the form field validation
800 return [ 'badipaddress' ];
803 $expiryTime = self
::parseExpiryInput( $data['Expiry'] );
806 // an expiry time is needed
807 ( strlen( $data['Expiry'] ) == 0 ) ||
808 // can't be a larger string as 50 (it should be a time format in any way)
809 ( strlen( $data['Expiry'] ) > 50 ) ||
810 // check, if the time could be parsed
813 return [ 'ipb_expiry_invalid' ];
816 // an expiry time should be in the future, not in the
817 // past (wouldn't make any sense) - bug T123069
818 if ( $expiryTime < wfTimestampNow() ) {
819 return [ 'ipb_expiry_old' ];
822 if ( !isset( $data['DisableEmail'] ) ) {
823 $data['DisableEmail'] = false;
826 # If the user has done the form 'properly', they won't even have been given the
827 # option to suppress-block unless they have the 'hideuser' permission
828 if ( !isset( $data['HideUser'] ) ) {
829 $data['HideUser'] = false;
832 if ( $data['HideUser'] ) {
833 if ( !$performer->isAllowed( 'hideuser' ) ) {
834 # this codepath is unreachable except by a malicious user spoofing forms,
835 # or by race conditions (user has hideuser and block rights, loads block form,
836 # and loses hideuser rights before submission); so need to fail completely
837 # rather than just silently disable hiding
838 return [ 'badaccess-group0' ];
841 if ( $isPartialBlock ) {
842 return [ 'ipb_hide_partial' ];
845 # Recheck params here...
846 if ( $type != DatabaseBlock
::TYPE_USER
) {
847 $data['HideUser'] = false; # IP users should not be hidden
848 } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
850 return [ 'ipb_expiry_temp' ];
851 } elseif ( $wgHideUserContribLimit !== false
852 && $user->getEditCount() > $wgHideUserContribLimit
854 # Typically, the user should have a handful of edits.
855 # Disallow hiding users with many edits for performance.
856 return [ [ 'ipb_hide_invalid',
857 Message
::numParam( $wgHideUserContribLimit ) ] ];
858 } elseif ( !$data['Confirm'] ) {
859 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
863 # Create block object.
864 $block = new DatabaseBlock();
865 $block->setTarget( $target );
866 $block->setBlocker( $performer );
867 $block->setReason( $data['Reason'][0] );
868 $block->setExpiry( $expiryTime );
869 $block->isCreateAccountBlocked( $data['CreateAccount'] );
870 $block->isUsertalkEditAllowed( !$wgBlockAllowsUTEdit ||
!$data['DisableUTEdit'] );
871 $block->isEmailBlocked( $data['DisableEmail'] );
872 $block->isHardblock( $data['HardBlock'] );
873 $block->isAutoblocking( $data['AutoBlock'] );
874 $block->setHideName( $data['HideUser'] );
876 if ( $isPartialBlock ) {
877 $block->isSitewide( false );
880 $reason = [ 'hookaborted' ];
881 if ( !Hooks
::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
885 $pageRestrictions = [];
886 $namespaceRestrictions = [];
887 if ( $enablePartialBlocks ) {
888 if ( $data['PageRestrictions'] !== '' ) {
889 $pageRestrictions = array_map( function ( $text ) {
890 $title = Title
::newFromText( $text );
891 // Use the link cache since the title has already been loaded when
892 // the field was validated.
893 $restriction = new PageRestriction( 0, $title->getArticleID() );
894 $restriction->setTitle( $title );
896 }, explode( "\n", $data['PageRestrictions'] ) );
898 if ( $data['NamespaceRestrictions'] !== '' ) {
899 $namespaceRestrictions = array_map( function ( $id ) {
900 return new NamespaceRestriction( 0, $id );
901 }, explode( "\n", $data['NamespaceRestrictions'] ) );
904 $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
905 $block->setRestrictions( $restrictions );
909 # Try to insert block. Is there a conflicting block?
910 $status = $block->insert();
912 # Indicates whether the user is confirming the block and is aware of
913 # the conflict (did not change the block target in the meantime)
914 $blockNotConfirmed = !$data['Confirm'] ||
( array_key_exists( 'PreviousTarget', $data )
915 && $data['PreviousTarget'] !== $target );
917 # Special case for API - T34434
918 $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
920 # Show form unless the user is already aware of this...
921 if ( $blockNotConfirmed ||
$reblockNotAllowed ) {
922 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
923 # Otherwise, try to update the block...
925 # This returns direct blocks before autoblocks/rangeblocks, since we should
926 # be sure the user is blocked by now it should work for our purposes
927 $currentBlock = DatabaseBlock
::newFromTarget( $target );
928 if ( $block->equals( $currentBlock ) ) {
929 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
931 # If the name was hidden and the blocking user cannot hide
932 # names, then don't allow any block changes...
933 if ( $currentBlock->getHideName() && !$performer->isAllowed( 'hideuser' ) ) {
934 return [ 'cant-see-hidden-user' ];
937 $priorBlock = clone $currentBlock;
938 $currentBlock->isHardblock( $block->isHardblock() );
939 $currentBlock->isCreateAccountBlocked( $block->isCreateAccountBlocked() );
940 $currentBlock->setExpiry( $block->getExpiry() );
941 $currentBlock->isAutoblocking( $block->isAutoblocking() );
942 $currentBlock->setHideName( $block->getHideName() );
943 $currentBlock->isEmailBlocked( $block->isEmailBlocked() );
944 $currentBlock->isUsertalkEditAllowed( $block->isUsertalkEditAllowed() );
945 $currentBlock->setReason( $block->getReason() );
947 if ( $enablePartialBlocks ) {
948 // Maintain the sitewide status. If partial blocks is not enabled,
949 // saving the block will result in a sitewide block.
950 $currentBlock->isSitewide( $block->isSitewide() );
952 // Set the block id of the restrictions.
953 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
954 $currentBlock->setRestrictions(
955 $blockRestrictionStore->setBlockId( $currentBlock->getId(), $restrictions )
959 $status = $currentBlock->update();
960 // TODO handle failure
962 $logaction = 'reblock';
964 # Unset _deleted fields if requested
965 if ( $currentBlock->getHideName() && !$data['HideUser'] ) {
966 RevisionDeleteUser
::unsuppressUserName( $target, $userId );
969 # If hiding/unhiding a name, this should go in the private logs
970 if ( (bool)$currentBlock->getHideName() ) {
971 $data['HideUser'] = true;
974 $block = $currentBlock;
977 $logaction = 'block';
980 Hooks
::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
982 # Set *_deleted fields if requested
983 if ( $data['HideUser'] ) {
984 RevisionDeleteUser
::suppressUserName( $target, $userId );
987 # Can't watch a rangeblock
988 if ( $type != DatabaseBlock
::TYPE_RANGE
&& $data['Watch'] ) {
989 WatchAction
::doWatch(
990 Title
::makeTitle( NS_USER
, $target ),
992 User
::IGNORE_USER_RIGHTS
996 # DatabaseBlock constructor sanitizes certain block options on insert
997 $data['BlockEmail'] = $block->isEmailBlocked();
998 $data['AutoBlock'] = $block->isAutoblocking();
1000 # Prepare log parameters
1002 $logParams['5::duration'] = $data['Expiry'];
1003 $logParams['6::flags'] = self
::blockLogFlags( $data, $type );
1004 $logParams['sitewide'] = $block->isSitewide();
1006 if ( $enablePartialBlocks && !$block->isSitewide() ) {
1007 if ( $data['PageRestrictions'] !== '' ) {
1008 $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
1011 if ( $data['NamespaceRestrictions'] !== '' ) {
1012 $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
1016 # Make log entry, if the name is hidden, put it in the suppression log
1017 $log_type = $data['HideUser'] ?
'suppress' : 'block';
1018 $logEntry = new ManualLogEntry( $log_type, $logaction );
1019 $logEntry->setTarget( Title
::makeTitle( NS_USER
, $target ) );
1020 $logEntry->setComment( $data['Reason'][0] );
1021 $logEntry->setPerformer( $performer );
1022 $logEntry->setParameters( $logParams );
1023 # Relate log ID to block ID (T27763)
1024 $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
1025 $logId = $logEntry->insert();
1027 if ( !empty( $data['Tags'] ) ) {
1028 $logEntry->setTags( $data['Tags'] );
1031 $logEntry->publish( $logId );
1037 * Get an array of suggested block durations from MediaWiki:Ipboptions
1038 * @todo FIXME: This uses a rather odd syntax for the options, should it be converted
1039 * to the standard "**<duration>|<displayname>" format?
1040 * @param Language|null $lang The language to get the durations in, or null to use
1041 * the wiki's content language
1042 * @param bool $includeOther Whether to include the 'other' option in the list of
1046 public static function getSuggestedDurations( Language
$lang = null, $includeOther = true ) {
1048 $msg = $lang === null
1049 ?
wfMessage( 'ipboptions' )->inContentLanguage()->text()
1050 : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1052 if ( $msg == '-' ) {
1056 foreach ( explode( ',', $msg ) as $option ) {
1057 if ( strpos( $option, ':' ) === false ) {
1058 $option = "$option:$option";
1061 list( $show, $value ) = explode( ':', $option );
1065 if ( $a && $includeOther ) {
1066 // if options exist, add other to the end instead of the begining (which
1067 // is what happens by default).
1068 $a[ wfMessage( 'ipbother' )->text() ] = 'other';
1075 * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
1076 * ("24 May 2034", etc), into an absolute timestamp we can put into the database.
1078 * @todo strtotime() only accepts English strings. This means the expiry input
1079 * can only be specified in English.
1080 * @see https://www.php.net/manual/en/function.strtotime.php
1082 * @param string $expiry Whatever was typed into the form
1083 * @return string|bool Timestamp or 'infinity' or false on error.
1085 public static function parseExpiryInput( $expiry ) {
1086 if ( wfIsInfinity( $expiry ) ) {
1090 $expiry = strtotime( $expiry );
1092 if ( $expiry < 0 ||
$expiry === false ) {
1096 return wfTimestamp( TS_MW
, $expiry );
1100 * Can we do an email block?
1101 * @param User $user The sysop wanting to make a block
1104 public static function canBlockEmail( $user ) {
1105 global $wgEnableUserEmail, $wgSysopEmailBans;
1107 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1111 * T17810: blocked admins should not be able to block/unblock
1112 * others, and probably shouldn't be able to unblock themselves
1115 * Exception: Users can block the user who blocked them, to reduce
1116 * advantage of a malicious account blocking all admins (T150826)
1118 * @param User|int|string|null $target Target to block or unblock; could be a User object,
1119 * or a user ID or username, or null when the target is not known yet (e.g. when
1120 * displaying Special:Block)
1121 * @param User $performer User doing the request
1122 * @return bool|string True or error message key
1124 public static function checkUnblockSelf( $target, User
$performer ) {
1125 if ( is_int( $target ) ) {
1126 $target = User
::newFromId( $target );
1127 } elseif ( is_string( $target ) ) {
1128 $target = User
::newFromName( $target );
1130 if ( $performer->getBlock() ) {
1131 if ( $target instanceof User
&& $target->getId() == $performer->getId() ) {
1132 # User is trying to unblock themselves
1133 // @TODO Ensure that the block does not apply to the `unblockself`
1135 if ( $performer->isAllowed( 'unblockself' ) ) {
1137 # User blocked themselves and is now trying to reverse it
1138 } elseif ( $performer->blockedBy() === $performer->getName() ) {
1141 return 'ipbnounblockself';
1144 $target instanceof User
&&
1145 $performer->getBlock() instanceof DatabaseBlock
&&
1146 $performer->getBlock()->getBy() &&
1147 $performer->getBlock()->getBy() === $target->getId()
1149 // Allow users to block the user that blocked them.
1150 // This is to prevent a situation where a malicious user
1151 // blocks all other users. This way, the non-malicious
1152 // user can block the malicious user back, resulting
1157 # User is trying to block/unblock someone else
1158 return 'ipbblocked';
1166 * Return a comma-delimited list of "flags" to be passed to the log
1167 * reader for this block, to provide more information in the logs
1168 * @param array $data From HTMLForm data
1169 * @param int $type DatabaseBlock::TYPE_ constant (USER, RANGE, or IP)
1172 protected static function blockLogFlags( array $data, $type ) {
1173 $config = RequestContext
::getMain()->getConfig();
1175 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1179 # when blocking a user the option 'anononly' is not available/has no effect
1180 # -> do not write this into log
1181 if ( !$data['HardBlock'] && $type != DatabaseBlock
::TYPE_USER
) {
1182 // For grepping: message block-log-flags-anononly
1183 $flags[] = 'anononly';
1186 if ( $data['CreateAccount'] ) {
1187 // For grepping: message block-log-flags-nocreate
1188 $flags[] = 'nocreate';
1191 # Same as anononly, this is not displayed when blocking an IP address
1192 if ( !$data['AutoBlock'] && $type == DatabaseBlock
::TYPE_USER
) {
1193 // For grepping: message block-log-flags-noautoblock
1194 $flags[] = 'noautoblock';
1197 if ( $data['DisableEmail'] ) {
1198 // For grepping: message block-log-flags-noemail
1199 $flags[] = 'noemail';
1202 if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1203 // For grepping: message block-log-flags-nousertalk
1204 $flags[] = 'nousertalk';
1207 if ( $data['HideUser'] ) {
1208 // For grepping: message block-log-flags-hiddenname
1209 $flags[] = 'hiddenname';
1212 return implode( ',', $flags );
1216 * Process the form on POST submission.
1217 * @param array $data
1218 * @param HTMLForm|null $form
1219 * @return bool|array True for success, false for didn't-try, array of errors on failure
1221 public function onSubmit( array $data, HTMLForm
$form = null ) {
1222 // If "Editing" checkbox is unchecked, the block must be a partial block affecting
1223 // actions other than editing, and there must be no restrictions.
1224 if ( isset( $data['Editing'] ) && $data['Editing'] === false ) {
1225 $data['EditingRestriction'] = 'partial';
1226 $data['PageRestrictions'] = '';
1227 $data['NamespaceRestrictions'] = '';
1229 return self
::processForm( $data, $form->getContext() );
1233 * Do something exciting on successful processing of the form, most likely to show a
1234 * confirmation message
1236 public function onSuccess() {
1237 $out = $this->getOutput();
1238 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1239 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target
) );
1243 * Return an array of subpages beginning with $search that this special page will accept.
1245 * @param string $search Prefix to search for
1246 * @param int $limit Maximum number of results to return (usually 10)
1247 * @param int $offset Number of results to skip (usually 0)
1248 * @return string[] Matching subpages
1250 public function prefixSearchSubpages( $search, $limit, $offset ) {
1251 $user = User
::newFromName( $search );
1253 // No prefix suggestion for invalid user
1256 // Autocomplete subpage as user list - public to allow caching
1257 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
1260 protected function getGroupName() {