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\BlockRestriction
;
25 use MediaWiki\Block\Restriction\PageRestriction
;
26 use MediaWiki\Block\Restriction\NamespaceRestriction
;
29 * A special page that allows users with 'block' right to block users from
30 * editing pages and other actions
32 * @ingroup SpecialPage
34 class SpecialBlock
extends FormSpecialPage
{
35 /** @var User|string|null User to be blocked, as passed either by parameter (url?wpTarget=Foo)
36 * or as subpage (Special:Block/Foo) */
39 /** @var int Block::TYPE_ constant */
42 /** @var User|string The previous block target */
43 protected $previousTarget;
45 /** @var bool Whether the previous submission of the form asked for HideUser */
46 protected $requestedHideUser;
49 protected $alreadyBlocked;
52 protected $preErrors = [];
54 public function __construct() {
55 parent
::__construct( 'Block', 'block' );
58 public function doesWrites() {
63 * Checks that the user can unblock themselves if they are trying to do so
66 * @throws ErrorPageError
68 protected function checkExecutePermissions( User
$user ) {
69 parent
::checkExecutePermissions( $user );
70 # T17810: blocked admins should have limited access here
71 $status = self
::checkUnblockSelf( $this->target
, $user );
72 if ( $status !== true ) {
73 throw new ErrorPageError( 'badaccess', $status );
78 * We allow certain special cases where user is blocked
82 public function requiresUnblock() {
87 * Handle some magic here
91 protected function setParameter( $par ) {
92 # Extract variables from the request. Try not to get into a situation where we
93 # need to extract *every* variable from the form just for processing here, but
94 # there are legitimate uses for some variables
95 $request = $this->getRequest();
96 list( $this->target
, $this->type
) = self
::getTargetAndType( $par, $request );
97 if ( $this->target
instanceof User
) {
98 # Set the 'relevant user' in the skin, so it displays links like Contributions,
99 # User logs, UserRights, etc.
100 $this->getSkin()->setRelevantUser( $this->target
);
103 list( $this->previousTarget
, /*...*/ ) =
104 Block
::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
105 $this->requestedHideUser
= $request->getBool( 'wpHideUser' );
109 * Customizes the HTMLForm a bit
111 * @param HTMLForm $form
113 protected function alterForm( HTMLForm
$form ) {
114 $form->setHeaderText( '' );
115 $form->setSubmitDestructive();
117 $msg = $this->alreadyBlocked ?
'ipb-change-block' : 'ipbsubmit';
118 $form->setSubmitTextMsg( $msg );
120 $this->addHelpLink( 'Help:Blocking users' );
122 # Don't need to do anything if the form has been posted
123 if ( !$this->getRequest()->wasPosted() && $this->preErrors
) {
124 $s = $form->formatErrors( $this->preErrors
);
126 $form->addHeaderText( Html
::rawElement(
128 [ 'class' => 'error' ],
135 protected function getDisplayFormat() {
140 * Get the HTMLForm descriptor array for the block form
143 protected function getFormFields() {
144 global $wgBlockAllowsUTEdit;
146 $user = $this->getUser();
148 $suggestedDurations = self
::getSuggestedDurations();
150 $conf = $this->getConfig();
151 $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
159 'id' => 'mw-bi-target',
163 'validation-callback' => [ __CLASS__
, 'validateTargetField' ],
164 'section' => 'target',
169 'label-message' => 'block-prevent-edit',
171 'section' => 'actions',
172 'disabled' => $enablePartialBlocks ?
false : true,
175 if ( $enablePartialBlocks ) {
176 $a['EditingRestriction'] = [
178 'cssclass' => 'mw-block-editing-restriction',
180 $this->msg( 'ipb-sitewide' )->escaped() => 'sitewide',
181 $this->msg( 'ipb-partial' )->escaped() => 'partial',
183 'section' => 'actions',
185 $a['PageRestrictions'] = [
186 'type' => 'titlesmultiselect',
187 'label' => $this->msg( 'ipb-pages-label' )->text(),
190 'cssclass' => 'mw-block-restriction',
191 'showMissing' => false,
193 'autocomplete' => false
195 'section' => 'actions',
197 $a['NamespaceRestrictions'] = [
198 'type' => 'namespacesmultiselect',
199 'label' => $this->msg( 'ipb-namespaces-label' )->text(),
201 'cssclass' => 'mw-block-restriction',
203 'autocomplete' => false
205 'section' => 'actions',
209 $a['CreateAccount'] = [
211 'label-message' => 'ipbcreateaccount',
213 'section' => 'actions',
216 if ( self
::canBlockEmail( $user ) ) {
217 $a['DisableEmail'] = [
219 'label-message' => 'ipbemailban',
220 'section' => 'actions',
224 if ( $wgBlockAllowsUTEdit ) {
225 $a['DisableUTEdit'] = [
227 'label-message' => 'ipb-disableusertalk',
229 'section' => 'actions',
236 'options' => $suggestedDurations,
237 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
238 'section' => 'expiry',
242 'type' => 'selectandother',
243 // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
244 // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
245 // Unicode codepoints.
246 'maxlength' => CommentStore
::COMMENT_CHARACTER_LIMIT
,
247 'maxlength-unit' => 'codepoints',
248 'options-message' => 'ipbreason-dropdown',
249 'section' => 'reason',
254 'label-message' => 'ipbenableautoblock',
256 'section' => 'options',
259 # Allow some users to hide name from block log, blocklist and listusers
260 if ( $user->isAllowed( 'hideuser' ) ) {
263 'label-message' => 'ipbhidename',
264 'cssclass' => 'mw-block-hideuser',
265 'section' => 'options',
269 # Watchlist their user page? (Only if user is logged in)
270 if ( $user->isLoggedIn() ) {
273 'label-message' => 'ipbwatchuser',
274 'section' => 'options',
280 'label-message' => 'ipb-hardblock',
282 'section' => 'options',
285 # This is basically a copy of the Target field, but the user can't change it, so we
286 # can see if the warnings we maybe showed to the user before still apply
287 $a['PreviousTarget'] = [
292 # We'll turn this into a checkbox if we need to
296 'label-message' => 'ipb-confirm',
297 'cssclass' => 'mw-block-confirm',
300 $this->maybeAlterFormDefaults( $a );
302 // Allow extensions to add more fields
303 Hooks
::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
309 * If the user has already been blocked with similar settings, load that block
310 * and change the defaults for the form fields to match the existing settings.
311 * @param array &$fields HTMLForm descriptor array
312 * @return bool Whether fields were altered (that is, whether the target is
315 protected function maybeAlterFormDefaults( &$fields ) {
316 # This will be overwritten by request data
317 $fields['Target']['default'] = (string)$this->target
;
319 if ( $this->target
) {
320 $status = self
::validateTarget( $this->target
, $this->getUser() );
321 if ( !$status->isOK() ) {
322 $errors = $status->getErrorsArray();
323 $this->preErrors
= array_merge( $this->preErrors
, $errors );
328 $fields['PreviousTarget']['default'] = (string)$this->target
;
330 $block = Block
::newFromTarget( $this->target
);
332 if ( $block instanceof Block
&& !$block->mAuto
# The block exists and isn't an autoblock
333 && ( $this->type
!= Block
::TYPE_RANGE
# The block isn't a rangeblock
334 ||
$block->getTarget() == $this->target
) # or if it is, the range is what we're about to block
336 $fields['HardBlock']['default'] = $block->isHardblock();
337 $fields['CreateAccount']['default'] = $block->prevents( 'createaccount' );
338 $fields['AutoBlock']['default'] = $block->isAutoblocking();
340 if ( isset( $fields['DisableEmail'] ) ) {
341 $fields['DisableEmail']['default'] = $block->prevents( 'sendemail' );
344 if ( isset( $fields['HideUser'] ) ) {
345 $fields['HideUser']['default'] = $block->mHideName
;
348 if ( isset( $fields['DisableUTEdit'] ) ) {
349 $fields['DisableUTEdit']['default'] = $block->prevents( 'editownusertalk' );
352 // If the username was hidden (ipb_deleted == 1), don't show the reason
353 // unless this user also has rights to hideuser: T37839
354 if ( !$block->mHideName ||
$this->getUser()->isAllowed( 'hideuser' ) ) {
355 $fields['Reason']['default'] = $block->mReason
;
357 $fields['Reason']['default'] = '';
360 if ( $this->getRequest()->wasPosted() ) {
361 # Ok, so we got a POST submission asking us to reblock a user. So show the
362 # confirm checkbox; the user will only see it if they haven't previously
363 $fields['Confirm']['type'] = 'check';
365 # We got a target, but it wasn't a POST request, so the user must have gone
366 # to a link like [[Special:Block/User]]. We don't need to show the checkbox
367 # as long as they go ahead and block *that* user
368 $fields['Confirm']['default'] = 1;
371 if ( $block->mExpiry
== 'infinity' ) {
372 $fields['Expiry']['default'] = 'infinite';
374 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822
, $block->mExpiry
);
377 $this->alreadyBlocked
= true;
378 $this->preErrors
[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
381 # We always need confirmation to do HideUser
382 if ( $this->requestedHideUser
) {
383 $fields['Confirm']['type'] = 'check';
384 unset( $fields['Confirm']['default'] );
385 $this->preErrors
[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
388 # Or if the user is trying to block themselves
389 if ( (string)$this->target
=== $this->getUser()->getName() ) {
390 $fields['Confirm']['type'] = 'check';
391 unset( $fields['Confirm']['default'] );
392 $this->preErrors
[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
395 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
396 if ( $block instanceof Block
&& !$block->isSitewide() ) {
397 $fields['EditingRestriction']['default'] = 'partial';
399 $fields['EditingRestriction']['default'] = 'sitewide';
402 if ( $block instanceof Block
) {
403 $pageRestrictions = [];
404 $namespaceRestrictions = [];
405 foreach ( $block->getRestrictions() as $restriction ) {
406 switch ( $restriction->getType() ) {
407 case PageRestriction
::TYPE
:
408 if ( $restriction->getTitle() ) {
409 $pageRestrictions[] = $restriction->getTitle()->getPrefixedText();
412 case NamespaceRestriction
::TYPE
:
413 $namespaceRestrictions[] = $restriction->getValue();
419 !$block->isSitewide() &&
420 empty( $pageRestrictions ) &&
421 empty( $namespaceRestrictions )
423 $fields['Editing']['default'] = false;
426 // Sort the restrictions so they are in alphabetical order.
427 sort( $pageRestrictions );
428 $fields['PageRestrictions']['default'] = implode( "\n", $pageRestrictions );
429 sort( $namespaceRestrictions );
430 $fields['NamespaceRestrictions']['default'] = implode( "\n", $namespaceRestrictions );
436 * Add header elements like block log entries, etc.
439 protected function preText() {
440 $this->getOutput()->addModuleStyles( [
441 'mediawiki.widgets.TagMultiselectWidget.styles',
444 $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
446 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
447 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
449 $otherBlockMessages = [];
450 if ( $this->target
!== null ) {
451 $targetName = $this->target
;
452 if ( $this->target
instanceof User
) {
453 $targetName = $this->target
->getName();
455 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
456 Hooks
::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
458 if ( count( $otherBlockMessages ) ) {
459 $s = Html
::rawElement(
462 $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
467 foreach ( $otherBlockMessages as $link ) {
468 $list .= Html
::rawElement( 'li', [], $link ) . "\n";
471 $s .= Html
::rawElement(
473 [ 'class' => 'mw-blockip-alreadyblocked' ],
485 * Add footer elements to the form
488 protected function postText() {
491 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
493 $linkRenderer = $this->getLinkRenderer();
494 # Link to the user's contributions, if applicable
495 if ( $this->target
instanceof User
) {
496 $contribsPage = SpecialPage
::getTitleFor( 'Contributions', $this->target
->getName() );
497 $links[] = $linkRenderer->makeLink(
499 $this->msg( 'ipb-blocklist-contribs', $this->target
->getName() )->text()
503 # Link to unblock the specified user, or to a blank unblock form
504 if ( $this->target
instanceof User
) {
505 $message = $this->msg(
507 wfEscapeWikiText( $this->target
->getName() )
509 $list = SpecialPage
::getTitleFor( 'Unblock', $this->target
->getName() );
511 $message = $this->msg( 'ipb-unblock' )->parse();
512 $list = SpecialPage
::getTitleFor( 'Unblock' );
514 $links[] = $linkRenderer->makeKnownLink(
516 new HtmlArmor( $message )
519 # Link to the block list
520 $links[] = $linkRenderer->makeKnownLink(
521 SpecialPage
::getTitleFor( 'BlockList' ),
522 $this->msg( 'ipb-blocklist' )->text()
525 $user = $this->getUser();
527 # Link to edit the block dropdown reasons, if applicable
528 if ( $user->isAllowed( 'editinterface' ) ) {
529 $links[] = $linkRenderer->makeKnownLink(
530 $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
531 $this->msg( 'ipb-edit-dropdown' )->text(),
533 [ 'action' => 'edit' ]
537 $text = Html
::rawElement(
539 [ 'class' => 'mw-ipb-conveniencelinks' ],
540 $this->getLanguage()->pipeList( $links )
543 $userTitle = self
::getTargetUserTitle( $this->target
);
545 # Get relevant extracts from the block and suppression logs, if possible
548 LogEventsList
::showLogExtract(
555 'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
556 'showIfEmpty' => false
561 # Add suppression block entries if allowed
562 if ( $user->isAllowed( 'suppressionlog' ) ) {
563 LogEventsList
::showLogExtract(
570 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
571 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
572 'showIfEmpty' => false
584 * Get a user page target for things like logs.
585 * This handles account and IP range targets.
586 * @param User|string $target
589 protected static function getTargetUserTitle( $target ) {
590 if ( $target instanceof User
) {
591 return $target->getUserPage();
592 } elseif ( IP
::isIPAddress( $target ) ) {
593 return Title
::makeTitleSafe( NS_USER
, $target );
600 * Determine the target of the block, and the type of target
601 * @todo Should be in Block.php?
602 * @param string $par Subpage parameter passed to setup, or data value from
604 * @param WebRequest|null $request Optionally try and get data from a request too
605 * @return array [ User|string|null, Block::TYPE_ constant|null ]
607 public static function getTargetAndType( $par, WebRequest
$request = null ) {
614 # The HTMLForm will check wpTarget first and only if it doesn't get
615 # a value use the default, which will be generated from the options
616 # below; so this has to have a higher precedence here than $par, or
617 # we could end up with different values in $this->target and the HTMLForm!
618 if ( $request instanceof WebRequest
) {
619 $target = $request->getText( 'wpTarget', null );
626 if ( $request instanceof WebRequest
) {
627 $target = $request->getText( 'ip', null );
632 if ( $request instanceof WebRequest
) {
633 $target = $request->getText( 'wpBlockAddress', null );
640 list( $target, $type ) = Block
::parseTarget( $target );
642 if ( $type !== null ) {
643 return [ $target, $type ];
647 return [ null, null ];
651 * HTMLForm field validation-callback for Target field.
653 * @param string $value
654 * @param array $alldata
655 * @param HTMLForm $form
658 public static function validateTargetField( $value, $alldata, $form ) {
659 $status = self
::validateTarget( $value, $form->getUser() );
660 if ( !$status->isOK() ) {
661 $errors = $status->getErrorsArray();
663 return $form->msg( ...$errors[0] );
670 * Validate a block target.
673 * @param string $value Block target to check
674 * @param User $user Performer of the block
677 public static function validateTarget( $value, User
$user ) {
678 global $wgBlockCIDRLimit;
680 /** @var User $target */
681 list( $target, $type ) = self
::getTargetAndType( $value );
682 $status = Status
::newGood( $target );
684 if ( $type == Block
::TYPE_USER
) {
685 if ( $target->isAnon() ) {
688 wfEscapeWikiText( $target->getName() )
692 $unblockStatus = self
::checkUnblockSelf( $target, $user );
693 if ( $unblockStatus !== true ) {
694 $status->fatal( 'badaccess', $unblockStatus );
696 } elseif ( $type == Block
::TYPE_RANGE
) {
697 list( $ip, $range ) = explode( '/', $target, 2 );
700 ( IP
::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
701 ( IP
::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
703 // Range block effectively disabled
704 $status->fatal( 'range_block_disabled' );
708 ( IP
::isIPv4( $ip ) && $range > 32 ) ||
709 ( IP
::isIPv6( $ip ) && $range > 128 )
712 $status->fatal( 'ip_range_invalid' );
715 if ( IP
::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
716 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
719 if ( IP
::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
720 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
722 } elseif ( $type == Block
::TYPE_IP
) {
725 $status->fatal( 'badipaddress' );
732 * Given the form data, actually implement a block. This is also called from ApiBlock.
735 * @param IContextSource $context
736 * @return bool|string
738 public static function processForm( array $data, IContextSource
$context ) {
739 global $wgBlockAllowsUTEdit, $wgHideUserContribLimit;
741 $performer = $context->getUser();
742 $enablePartialBlocks = $context->getConfig()->get( 'EnablePartialBlocks' );
743 $isPartialBlock = $enablePartialBlocks &&
744 isset( $data['EditingRestriction'] ) &&
745 $data['EditingRestriction'] === 'partial';
747 // Handled by field validator callback
748 // self::validateTargetField( $data['Target'] );
750 # This might have been a hidden field or a checkbox, so interesting data
752 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
754 /** @var User $target */
755 list( $target, $type ) = self
::getTargetAndType( $data['Target'] );
756 if ( $type == Block
::TYPE_USER
) {
758 $target = $user->getName();
759 $userId = $user->getId();
761 # Give admins a heads-up before they go and block themselves. Much messier
762 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
763 # permission anyway, although the code does allow for it.
764 # Note: Important to use $target instead of $data['Target']
765 # since both $data['PreviousTarget'] and $target are normalized
766 # but $data['target'] gets overridden by (non-normalized) request variable
767 # from previous request.
768 if ( $target === $performer->getName() &&
769 ( $data['PreviousTarget'] !== $target ||
!$data['Confirm'] )
771 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
773 } elseif ( $type == Block
::TYPE_RANGE
) {
776 } elseif ( $type == Block
::TYPE_IP
) {
778 $target = $target->getName();
781 # This should have been caught in the form field validation
782 return [ 'badipaddress' ];
785 $expiryTime = self
::parseExpiryInput( $data['Expiry'] );
788 // an expiry time is needed
789 ( strlen( $data['Expiry'] ) == 0 ) ||
790 // can't be a larger string as 50 (it should be a time format in any way)
791 ( strlen( $data['Expiry'] ) > 50 ) ||
792 // check, if the time could be parsed
795 return [ 'ipb_expiry_invalid' ];
798 // an expiry time should be in the future, not in the
799 // past (wouldn't make any sense) - bug T123069
800 if ( $expiryTime < wfTimestampNow() ) {
801 return [ 'ipb_expiry_old' ];
804 if ( !isset( $data['DisableEmail'] ) ) {
805 $data['DisableEmail'] = false;
808 # If the user has done the form 'properly', they won't even have been given the
809 # option to suppress-block unless they have the 'hideuser' permission
810 if ( !isset( $data['HideUser'] ) ) {
811 $data['HideUser'] = false;
814 if ( $data['HideUser'] ) {
815 if ( !$performer->isAllowed( 'hideuser' ) ) {
816 # this codepath is unreachable except by a malicious user spoofing forms,
817 # or by race conditions (user has hideuser and block rights, loads block form,
818 # and loses hideuser rights before submission); so need to fail completely
819 # rather than just silently disable hiding
820 return [ 'badaccess-group0' ];
823 if ( $isPartialBlock ) {
824 return [ 'ipb_hide_partial' ];
827 # Recheck params here...
828 if ( $type != Block
::TYPE_USER
) {
829 $data['HideUser'] = false; # IP users should not be hidden
830 } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
832 return [ 'ipb_expiry_temp' ];
833 } elseif ( $wgHideUserContribLimit !== false
834 && $user->getEditCount() > $wgHideUserContribLimit
836 # Typically, the user should have a handful of edits.
837 # Disallow hiding users with many edits for performance.
838 return [ [ 'ipb_hide_invalid',
839 Message
::numParam( $wgHideUserContribLimit ) ] ];
840 } elseif ( !$data['Confirm'] ) {
841 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
845 # Create block object.
846 $block = new Block();
847 $block->setTarget( $target );
848 $block->setBlocker( $performer );
849 $block->mReason
= $data['Reason'][0];
850 $block->mExpiry
= $expiryTime;
851 $block->prevents( 'createaccount', $data['CreateAccount'] );
852 $block->prevents( 'editownusertalk', ( !$wgBlockAllowsUTEdit ||
$data['DisableUTEdit'] ) );
853 $block->prevents( 'sendemail', $data['DisableEmail'] );
854 $block->isHardblock( $data['HardBlock'] );
855 $block->isAutoblocking( $data['AutoBlock'] );
856 $block->mHideName
= $data['HideUser'];
858 if ( $isPartialBlock ) {
859 $block->isSitewide( false );
862 $reason = [ 'hookaborted' ];
863 if ( !Hooks
::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
867 $pageRestrictions = [];
868 $namespaceRestrictions = [];
869 if ( $enablePartialBlocks ) {
870 if ( $data['PageRestrictions'] !== '' ) {
871 $pageRestrictions = array_map( function ( $text ) {
872 $title = Title
::newFromText( $text );
873 // Use the link cache since the title has already been loaded when
874 // the field was validated.
875 $restriction = new PageRestriction( 0, $title->getArticleID() );
876 $restriction->setTitle( $title );
878 }, explode( "\n", $data['PageRestrictions'] ) );
880 if ( $data['NamespaceRestrictions'] !== '' ) {
881 $namespaceRestrictions = array_map( function ( $id ) {
882 return new NamespaceRestriction( 0, $id );
883 }, explode( "\n", $data['NamespaceRestrictions'] ) );
886 $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
887 $block->setRestrictions( $restrictions );
891 # Try to insert block. Is there a conflicting block?
892 $status = $block->insert();
894 # Indicates whether the user is confirming the block and is aware of
895 # the conflict (did not change the block target in the meantime)
896 $blockNotConfirmed = !$data['Confirm'] ||
( array_key_exists( 'PreviousTarget', $data )
897 && $data['PreviousTarget'] !== $target );
899 # Special case for API - T34434
900 $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
902 # Show form unless the user is already aware of this...
903 if ( $blockNotConfirmed ||
$reblockNotAllowed ) {
904 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
905 # Otherwise, try to update the block...
907 # This returns direct blocks before autoblocks/rangeblocks, since we should
908 # be sure the user is blocked by now it should work for our purposes
909 $currentBlock = Block
::newFromTarget( $target );
910 if ( $block->equals( $currentBlock ) ) {
911 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
913 # If the name was hidden and the blocking user cannot hide
914 # names, then don't allow any block changes...
915 if ( $currentBlock->mHideName
&& !$performer->isAllowed( 'hideuser' ) ) {
916 return [ 'cant-see-hidden-user' ];
919 $priorBlock = clone $currentBlock;
920 $currentBlock->isHardblock( $block->isHardblock() );
921 $currentBlock->prevents( 'createaccount', $block->prevents( 'createaccount' ) );
922 $currentBlock->mExpiry
= $block->mExpiry
;
923 $currentBlock->isAutoblocking( $block->isAutoblocking() );
924 $currentBlock->mHideName
= $block->mHideName
;
925 $currentBlock->prevents( 'sendemail', $block->prevents( 'sendemail' ) );
926 $currentBlock->prevents( 'editownusertalk', $block->prevents( 'editownusertalk' ) );
927 $currentBlock->mReason
= $block->mReason
;
929 if ( $enablePartialBlocks ) {
930 // Maintain the sitewide status. If partial blocks is not enabled,
931 // saving the block will result in a sitewide block.
932 $currentBlock->isSitewide( $block->isSitewide() );
934 // Set the block id of the restrictions.
935 $currentBlock->setRestrictions(
936 BlockRestriction
::setBlockId( $currentBlock->getId(), $restrictions )
940 $status = $currentBlock->update();
941 // TODO handle failure
943 $logaction = 'reblock';
945 # Unset _deleted fields if requested
946 if ( $currentBlock->mHideName
&& !$data['HideUser'] ) {
947 RevisionDeleteUser
::unsuppressUserName( $target, $userId );
950 # If hiding/unhiding a name, this should go in the private logs
951 if ( (bool)$currentBlock->mHideName
) {
952 $data['HideUser'] = true;
955 $block = $currentBlock;
958 $logaction = 'block';
961 Hooks
::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
963 # Set *_deleted fields if requested
964 if ( $data['HideUser'] ) {
965 RevisionDeleteUser
::suppressUserName( $target, $userId );
968 # Can't watch a rangeblock
969 if ( $type != Block
::TYPE_RANGE
&& $data['Watch'] ) {
970 WatchAction
::doWatch(
971 Title
::makeTitle( NS_USER
, $target ),
973 User
::IGNORE_USER_RIGHTS
977 # Block constructor sanitizes certain block options on insert
978 $data['BlockEmail'] = $block->prevents( 'sendemail' );
979 $data['AutoBlock'] = $block->isAutoblocking();
981 # Prepare log parameters
983 $logParams['5::duration'] = $data['Expiry'];
984 $logParams['6::flags'] = self
::blockLogFlags( $data, $type );
985 $logParams['sitewide'] = $block->isSitewide();
987 if ( $enablePartialBlocks && !$block->isSitewide() ) {
988 if ( $data['PageRestrictions'] !== '' ) {
989 $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
992 if ( $data['NamespaceRestrictions'] !== '' ) {
993 $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
997 # Make log entry, if the name is hidden, put it in the suppression log
998 $log_type = $data['HideUser'] ?
'suppress' : 'block';
999 $logEntry = new ManualLogEntry( $log_type, $logaction );
1000 $logEntry->setTarget( Title
::makeTitle( NS_USER
, $target ) );
1001 $logEntry->setComment( $data['Reason'][0] );
1002 $logEntry->setPerformer( $performer );
1003 $logEntry->setParameters( $logParams );
1004 # Relate log ID to block ID (T27763)
1005 $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
1006 $logId = $logEntry->insert();
1008 if ( !empty( $data['Tags'] ) ) {
1009 $logEntry->setTags( $data['Tags'] );
1012 $logEntry->publish( $logId );
1018 * Get an array of suggested block durations from MediaWiki:Ipboptions
1019 * @todo FIXME: This uses a rather odd syntax for the options, should it be converted
1020 * to the standard "**<duration>|<displayname>" format?
1021 * @param Language|null $lang The language to get the durations in, or null to use
1022 * the wiki's content language
1023 * @param bool $includeOther Whether to include the 'other' option in the list of
1027 public static function getSuggestedDurations( Language
$lang = null, $includeOther = true ) {
1029 $msg = $lang === null
1030 ?
wfMessage( 'ipboptions' )->inContentLanguage()->text()
1031 : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1033 if ( $msg == '-' ) {
1037 foreach ( explode( ',', $msg ) as $option ) {
1038 if ( strpos( $option, ':' ) === false ) {
1039 $option = "$option:$option";
1042 list( $show, $value ) = explode( ':', $option );
1046 if ( $a && $includeOther ) {
1047 // if options exist, add other to the end instead of the begining (which
1048 // is what happens by default).
1049 $a[ wfMessage( 'ipbother' )->text() ] = 'other';
1056 * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
1057 * ("24 May 2034", etc), into an absolute timestamp we can put into the database.
1059 * @todo strtotime() only accepts English strings. This means the expiry input
1060 * can only be specified in English.
1061 * @see https://secure.php.net/manual/en/function.strtotime.php
1063 * @param string $expiry Whatever was typed into the form
1064 * @return string|bool Timestamp or 'infinity' or false on error.
1066 public static function parseExpiryInput( $expiry ) {
1067 if ( wfIsInfinity( $expiry ) ) {
1071 $expiry = strtotime( $expiry );
1073 if ( $expiry < 0 ||
$expiry === false ) {
1077 return wfTimestamp( TS_MW
, $expiry );
1081 * Can we do an email block?
1082 * @param User $user The sysop wanting to make a block
1085 public static function canBlockEmail( $user ) {
1086 global $wgEnableUserEmail, $wgSysopEmailBans;
1088 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1092 * T17810: blocked admins should not be able to block/unblock
1093 * others, and probably shouldn't be able to unblock themselves
1096 * Exception: Users can block the user who blocked them, to reduce
1097 * advantage of a malicious account blocking all admins (T150826)
1099 * @param User|int|string|null $target Target to block or unblock; could be a User object,
1100 * or a user ID or username, or null when the target is not known yet (e.g. when
1101 * displaying Special:Block)
1102 * @param User $performer User doing the request
1103 * @return bool|string True or error message key
1105 public static function checkUnblockSelf( $target, User
$performer ) {
1106 if ( is_int( $target ) ) {
1107 $target = User
::newFromId( $target );
1108 } elseif ( is_string( $target ) ) {
1109 $target = User
::newFromName( $target );
1111 if ( $performer->isBlocked() ) {
1112 if ( $target instanceof User
&& $target->getId() == $performer->getId() ) {
1113 # User is trying to unblock themselves
1114 if ( $performer->isAllowed( 'unblockself' ) ) {
1116 # User blocked themselves and is now trying to reverse it
1117 } elseif ( $performer->blockedBy() === $performer->getName() ) {
1120 return 'ipbnounblockself';
1123 $target instanceof User
&&
1124 $performer->getBlock() instanceof Block
&&
1125 $performer->getBlock()->getBy() &&
1126 $performer->getBlock()->getBy() === $target->getId()
1128 // Allow users to block the user that blocked them.
1129 // This is to prevent a situation where a malicious user
1130 // blocks all other users. This way, the non-malicious
1131 // user can block the malicious user back, resulting
1136 # User is trying to block/unblock someone else
1137 return 'ipbblocked';
1145 * Return a comma-delimited list of "flags" to be passed to the log
1146 * reader for this block, to provide more information in the logs
1147 * @param array $data From HTMLForm data
1148 * @param int $type Block::TYPE_ constant (USER, RANGE, or IP)
1151 protected static function blockLogFlags( array $data, $type ) {
1152 $config = RequestContext
::getMain()->getConfig();
1154 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1158 # when blocking a user the option 'anononly' is not available/has no effect
1159 # -> do not write this into log
1160 if ( !$data['HardBlock'] && $type != Block
::TYPE_USER
) {
1161 // For grepping: message block-log-flags-anononly
1162 $flags[] = 'anononly';
1165 if ( $data['CreateAccount'] ) {
1166 // For grepping: message block-log-flags-nocreate
1167 $flags[] = 'nocreate';
1170 # Same as anononly, this is not displayed when blocking an IP address
1171 if ( !$data['AutoBlock'] && $type == Block
::TYPE_USER
) {
1172 // For grepping: message block-log-flags-noautoblock
1173 $flags[] = 'noautoblock';
1176 if ( $data['DisableEmail'] ) {
1177 // For grepping: message block-log-flags-noemail
1178 $flags[] = 'noemail';
1181 if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1182 // For grepping: message block-log-flags-nousertalk
1183 $flags[] = 'nousertalk';
1186 if ( $data['HideUser'] ) {
1187 // For grepping: message block-log-flags-hiddenname
1188 $flags[] = 'hiddenname';
1191 return implode( ',', $flags );
1195 * Process the form on POST submission.
1196 * @param array $data
1197 * @param HTMLForm|null $form
1198 * @return bool|array True for success, false for didn't-try, array of errors on failure
1200 public function onSubmit( array $data, HTMLForm
$form = null ) {
1201 // If "Editing" checkbox is unchecked, the block must be a partial block affecting
1202 // actions other than editing, and there must be no restrictions.
1203 if ( isset( $data['Editing'] ) && $data['Editing'] === false ) {
1204 $data['EditingRestriction'] = 'partial';
1205 $data['PageRestrictions'] = '';
1206 $data['NamespaceRestrictions'] = '';
1208 return self
::processForm( $data, $form->getContext() );
1212 * Do something exciting on successful processing of the form, most likely to show a
1213 * confirmation message
1215 public function onSuccess() {
1216 $out = $this->getOutput();
1217 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1218 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target
) );
1222 * Return an array of subpages beginning with $search that this special page will accept.
1224 * @param string $search Prefix to search for
1225 * @param int $limit Maximum number of results to return (usually 10)
1226 * @param int $offset Number of results to skip (usually 0)
1227 * @return string[] Matching subpages
1229 public function prefixSearchSubpages( $search, $limit, $offset ) {
1230 $user = User
::newFromName( $search );
1232 // No prefix suggestion for invalid user
1235 // Autocomplete subpage as user list - public to allow caching
1236 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
1239 protected function getGroupName() {