Clean up spacing of doc comments
[lhc/web/wiklou.git] / includes / specials / SpecialBlock.php
1 <?php
2 /**
3 * Implements Special:Block
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup SpecialPage
22 */
23
24 use MediaWiki\Block\DatabaseBlock;
25 use MediaWiki\Block\Restriction\PageRestriction;
26 use MediaWiki\Block\Restriction\NamespaceRestriction;
27 use MediaWiki\MediaWikiServices;
28
29 /**
30 * A special page that allows users with 'block' right to block users from
31 * editing pages and other actions
32 *
33 * @ingroup SpecialPage
34 */
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)
38 */
39 protected $target;
40
41 /** @var int DatabaseBlock::TYPE_ constant */
42 protected $type;
43
44 /** @var User|string The previous block target */
45 protected $previousTarget;
46
47 /** @var bool Whether the previous submission of the form asked for HideUser */
48 protected $requestedHideUser;
49
50 /** @var bool */
51 protected $alreadyBlocked;
52
53 /** @var array */
54 protected $preErrors = [];
55
56 public function __construct() {
57 parent::__construct( 'Block', 'block' );
58 }
59
60 public function doesWrites() {
61 return true;
62 }
63
64 /**
65 * Checks that the user can unblock themselves if they are trying to do so
66 *
67 * @param User $user
68 * @throws ErrorPageError
69 */
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 );
76 }
77 }
78
79 /**
80 * We allow certain special cases where user is blocked
81 *
82 * @return bool
83 */
84 public function requiresUnblock() {
85 return false;
86 }
87
88 /**
89 * Handle some magic here
90 *
91 * @param string $par
92 */
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 );
103 }
104
105 list( $this->previousTarget, /*...*/ ) =
106 DatabaseBlock::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
107 $this->requestedHideUser = $request->getBool( 'wpHideUser' );
108 }
109
110 /**
111 * Customizes the HTMLForm a bit
112 *
113 * @param HTMLForm $form
114 */
115 protected function alterForm( HTMLForm $form ) {
116 $form->setHeaderText( '' );
117 $form->setSubmitDestructive();
118
119 $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
120 $form->setSubmitTextMsg( $msg );
121
122 $this->addHelpLink( 'Help:Blocking users' );
123
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 );
127 if ( $s ) {
128 $form->addHeaderText( Html::rawElement(
129 'div',
130 [ 'class' => 'error' ],
131 $s
132 ) );
133 }
134 }
135 }
136
137 protected function getDisplayFormat() {
138 return 'ooui';
139 }
140
141 /**
142 * Get the HTMLForm descriptor array for the block form
143 * @return array
144 */
145 protected function getFormFields() {
146 $conf = $this->getConfig();
147 $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
148 $blockAllowsUTEdit = $conf->get( 'BlockAllowsUTEdit' );
149
150 $this->getOutput()->enableOOUI();
151
152 $user = $this->getUser();
153
154 $suggestedDurations = self::getSuggestedDurations();
155
156 $a = [];
157
158 $a['Target'] = [
159 'type' => 'user',
160 'ipallowed' => true,
161 'iprange' => true,
162 'id' => 'mw-bi-target',
163 'size' => '45',
164 'autofocus' => true,
165 'required' => true,
166 'validation-callback' => [ __CLASS__, 'validateTargetField' ],
167 'section' => 'target',
168 ];
169
170 $a['Editing'] = [
171 'type' => 'check',
172 'label-message' => 'block-prevent-edit',
173 'default' => true,
174 'section' => 'actions',
175 'disabled' => $enablePartialBlocks ? false : true,
176 ];
177
178 if ( $enablePartialBlocks ) {
179 $a['EditingRestriction'] = [
180 'type' => 'radio',
181 'cssclass' => 'mw-block-editing-restriction',
182 'options' => [
183 $this->msg( 'ipb-sitewide' )->escaped() .
184 new \OOUI\LabelWidget( [
185 'classes' => [ 'oo-ui-inline-help' ],
186 'label' => $this->msg( 'ipb-sitewide-help' )->text(),
187 ] ) => 'sitewide',
188 $this->msg( 'ipb-partial' )->escaped() .
189 new \OOUI\LabelWidget( [
190 'classes' => [ 'oo-ui-inline-help' ],
191 'label' => $this->msg( 'ipb-partial-help' )->text(),
192 ] ) => 'partial',
193 ],
194 'section' => 'actions',
195 ];
196 $a['PageRestrictions'] = [
197 'type' => 'titlesmultiselect',
198 'label' => $this->msg( 'ipb-pages-label' )->text(),
199 'exists' => true,
200 'max' => 10,
201 'cssclass' => 'mw-block-restriction',
202 'showMissing' => false,
203 'excludeDynamicNamespaces' => true,
204 'input' => [
205 'autocomplete' => false
206 ],
207 'section' => 'actions',
208 ];
209 $a['NamespaceRestrictions'] = [
210 'type' => 'namespacesmultiselect',
211 'label' => $this->msg( 'ipb-namespaces-label' )->text(),
212 'exists' => true,
213 'cssclass' => 'mw-block-restriction',
214 'input' => [
215 'autocomplete' => false
216 ],
217 'section' => 'actions',
218 ];
219 }
220
221 $a['CreateAccount'] = [
222 'type' => 'check',
223 'label-message' => 'ipbcreateaccount',
224 'default' => true,
225 'section' => 'actions',
226 ];
227
228 if ( self::canBlockEmail( $user ) ) {
229 $a['DisableEmail'] = [
230 'type' => 'check',
231 'label-message' => 'ipbemailban',
232 'section' => 'actions',
233 ];
234 }
235
236 if ( $blockAllowsUTEdit ) {
237 $a['DisableUTEdit'] = [
238 'type' => 'check',
239 'label-message' => 'ipb-disableusertalk',
240 'default' => false,
241 'section' => 'actions',
242 ];
243 }
244
245 $a['Expiry'] = [
246 'type' => 'expiry',
247 'required' => true,
248 'options' => $suggestedDurations,
249 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
250 'section' => 'expiry',
251 ];
252
253 $a['Reason'] = [
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',
262 ];
263
264 $a['AutoBlock'] = [
265 'type' => 'check',
266 'label-message' => 'ipbenableautoblock',
267 'default' => true,
268 'section' => 'options',
269 ];
270
271 # Allow some users to hide name from block log, blocklist and listusers
272 if ( $user->isAllowed( 'hideuser' ) ) {
273 $a['HideUser'] = [
274 'type' => 'check',
275 'label-message' => 'ipbhidename',
276 'cssclass' => 'mw-block-hideuser',
277 'section' => 'options',
278 ];
279 }
280
281 # Watchlist their user page? (Only if user is logged in)
282 if ( $user->isLoggedIn() ) {
283 $a['Watch'] = [
284 'type' => 'check',
285 'label-message' => 'ipbwatchuser',
286 'section' => 'options',
287 ];
288 }
289
290 $a['HardBlock'] = [
291 'type' => 'check',
292 'label-message' => 'ipb-hardblock',
293 'default' => false,
294 'section' => 'options',
295 ];
296
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'] = [
300 'type' => 'hidden',
301 'default' => false,
302 ];
303
304 # We'll turn this into a checkbox if we need to
305 $a['Confirm'] = [
306 'type' => 'hidden',
307 'default' => '',
308 'label-message' => 'ipb-confirm',
309 'cssclass' => 'mw-block-confirm',
310 ];
311
312 $this->maybeAlterFormDefaults( $a );
313
314 // Allow extensions to add more fields
315 Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
316
317 return $a;
318 }
319
320 /**
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
324 */
325 protected function maybeAlterFormDefaults( &$fields ) {
326 # This will be overwritten by request data
327 $fields['Target']['default'] = (string)$this->target;
328
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 );
334 }
335 }
336
337 # This won't be
338 $fields['PreviousTarget']['default'] = (string)$this->target;
339
340 $block = DatabaseBlock::newFromTarget( $this->target );
341
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 )
347 ) {
348 $fields['HardBlock']['default'] = $block->isHardblock();
349 $fields['CreateAccount']['default'] = $block->isCreateAccountBlocked();
350 $fields['AutoBlock']['default'] = $block->isAutoblocking();
351
352 if ( isset( $fields['DisableEmail'] ) ) {
353 $fields['DisableEmail']['default'] = $block->isEmailBlocked();
354 }
355
356 if ( isset( $fields['HideUser'] ) ) {
357 $fields['HideUser']['default'] = $block->getHideName();
358 }
359
360 if ( isset( $fields['DisableUTEdit'] ) ) {
361 $fields['DisableUTEdit']['default'] = !$block->isUsertalkEditAllowed();
362 }
363
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();
368 } else {
369 $fields['Reason']['default'] = '';
370 }
371
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';
376 } else {
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;
381 }
382
383 if ( $block->getExpiry() == 'infinity' ) {
384 $fields['Expiry']['default'] = 'infinite';
385 } else {
386 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->getExpiry() );
387 }
388
389 $this->alreadyBlocked = true;
390 $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
391 }
392
393 if ( $this->alreadyBlocked || $this->getRequest()->wasPosted()
394 || $this->getRequest()->getCheck( 'wpCreateAccount' )
395 ) {
396 $this->getOutput()->addJsConfigVars( 'wgCreateAccountDirty', true );
397 }
398
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' ];
404 }
405
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' ];
411 }
412
413 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
414 if ( $block instanceof DatabaseBlock && !$block->isSitewide() ) {
415 $fields['EditingRestriction']['default'] = 'partial';
416 } else {
417 $fields['EditingRestriction']['default'] = 'sitewide';
418 }
419
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();
428 }
429 break;
430 case NamespaceRestriction::TYPE:
431 $namespaceRestrictions[] = $restriction->getValue();
432 break;
433 }
434 }
435
436 if (
437 !$block->isSitewide() &&
438 empty( $pageRestrictions ) &&
439 empty( $namespaceRestrictions )
440 ) {
441 $fields['Editing']['default'] = false;
442 }
443
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 );
449 }
450 }
451 }
452
453 /**
454 * Add header elements like block log entries, etc.
455 * @return string
456 */
457 protected function preText() {
458 $this->getOutput()->addModuleStyles( [
459 'mediawiki.widgets.TagMultiselectWidget.styles',
460 'mediawiki.special',
461 ] );
462 $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
463
464 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
465 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
466
467 $otherBlockMessages = [];
468 if ( $this->target !== null ) {
469 $targetName = $this->target;
470 if ( $this->target instanceof User ) {
471 $targetName = $this->target->getName();
472 }
473 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
474 Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
475
476 if ( count( $otherBlockMessages ) ) {
477 $s = Html::rawElement(
478 'h2',
479 [],
480 $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
481 ) . "\n";
482
483 $list = '';
484
485 foreach ( $otherBlockMessages as $link ) {
486 $list .= Html::rawElement( 'li', [], $link ) . "\n";
487 }
488
489 $s .= Html::rawElement(
490 'ul',
491 [ 'class' => 'mw-blockip-alreadyblocked' ],
492 $list
493 ) . "\n";
494
495 $text .= $s;
496 }
497 }
498
499 return $text;
500 }
501
502 /**
503 * Add footer elements to the form
504 * @return string
505 */
506 protected function postText() {
507 $links = [];
508
509 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
510
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(
516 $contribsPage,
517 $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
518 );
519 }
520
521 # Link to unblock the specified user, or to a blank unblock form
522 if ( $this->target instanceof User ) {
523 $message = $this->msg(
524 'ipb-unblock-addr',
525 wfEscapeWikiText( $this->target->getName() )
526 )->parse();
527 $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
528 } else {
529 $message = $this->msg( 'ipb-unblock' )->parse();
530 $list = SpecialPage::getTitleFor( 'Unblock' );
531 }
532 $links[] = $linkRenderer->makeKnownLink(
533 $list,
534 new HtmlArmor( $message )
535 );
536
537 # Link to the block list
538 $links[] = $linkRenderer->makeKnownLink(
539 SpecialPage::getTitleFor( 'BlockList' ),
540 $this->msg( 'ipb-blocklist' )->text()
541 );
542
543 $user = $this->getUser();
544
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(),
550 [],
551 [ 'action' => 'edit' ]
552 );
553 }
554
555 $text = Html::rawElement(
556 'p',
557 [ 'class' => 'mw-ipb-conveniencelinks' ],
558 $this->getLanguage()->pipeList( $links )
559 );
560
561 $userTitle = self::getTargetUserTitle( $this->target );
562 if ( $userTitle ) {
563 # Get relevant extracts from the block and suppression logs, if possible
564 $out = '';
565
566 LogEventsList::showLogExtract(
567 $out,
568 'block',
569 $userTitle,
570 '',
571 [
572 'lim' => 10,
573 'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
574 'showIfEmpty' => false
575 ]
576 );
577 $text .= $out;
578
579 # Add suppression block entries if allowed
580 if ( $user->isAllowed( 'suppressionlog' ) ) {
581 LogEventsList::showLogExtract(
582 $out,
583 'suppress',
584 $userTitle,
585 '',
586 [
587 'lim' => 10,
588 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
589 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
590 'showIfEmpty' => false
591 ]
592 );
593
594 $text .= $out;
595 }
596 }
597
598 return $text;
599 }
600
601 /**
602 * Get a user page target for things like logs.
603 * This handles account and IP range targets.
604 * @param User|string $target
605 * @return Title|null
606 */
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 );
612 }
613
614 return null;
615 }
616
617 /**
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
621 * the HTMLForm
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}
625 */
626 public static function getTargetAndType( $par, WebRequest $request = null ) {
627 $i = 0;
628 $target = null;
629
630 while ( true ) {
631 switch ( $i++ ) {
632 case 0:
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 );
639 }
640 break;
641 case 1:
642 $target = $par;
643 break;
644 case 2:
645 if ( $request instanceof WebRequest ) {
646 $target = $request->getText( 'ip', null );
647 }
648 break;
649 case 3:
650 # B/C @since 1.18
651 if ( $request instanceof WebRequest ) {
652 $target = $request->getText( 'wpBlockAddress', null );
653 }
654 break;
655 case 4:
656 break 2;
657 }
658
659 list( $target, $type ) = DatabaseBlock::parseTarget( $target );
660
661 if ( $type !== null ) {
662 return [ $target, $type ];
663 }
664 }
665
666 return [ null, null ];
667 }
668
669 /**
670 * HTMLForm field validation-callback for Target field.
671 * @since 1.18
672 * @param string $value
673 * @param array $alldata
674 * @param HTMLForm $form
675 * @return Message
676 */
677 public static function validateTargetField( $value, $alldata, $form ) {
678 $status = self::validateTarget( $value, $form->getUser() );
679 if ( !$status->isOK() ) {
680 $errors = $status->getErrorsArray();
681
682 return $form->msg( ...$errors[0] );
683 } else {
684 return true;
685 }
686 }
687
688 /**
689 * Validate a block target.
690 *
691 * @since 1.21
692 * @param string $value Block target to check
693 * @param User $user Performer of the block
694 * @return Status
695 */
696 public static function validateTarget( $value, User $user ) {
697 global $wgBlockCIDRLimit;
698
699 /** @var User $target */
700 list( $target, $type ) = self::getTargetAndType( $value );
701 $status = Status::newGood( $target );
702
703 if ( $type == DatabaseBlock::TYPE_USER ) {
704 if ( $target->isAnon() ) {
705 $status->fatal(
706 'nosuchusershort',
707 wfEscapeWikiText( $target->getName() )
708 );
709 }
710
711 $unblockStatus = self::checkUnblockSelf( $target, $user );
712 if ( $unblockStatus !== true ) {
713 $status->fatal( 'badaccess', $unblockStatus );
714 }
715 } elseif ( $type == DatabaseBlock::TYPE_RANGE ) {
716 list( $ip, $range ) = explode( '/', $target, 2 );
717
718 if (
719 ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
720 ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
721 ) {
722 // Range block effectively disabled
723 $status->fatal( 'range_block_disabled' );
724 }
725
726 if (
727 ( IP::isIPv4( $ip ) && $range > 32 ) ||
728 ( IP::isIPv6( $ip ) && $range > 128 )
729 ) {
730 // Dodgy range
731 $status->fatal( 'ip_range_invalid' );
732 }
733
734 if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
735 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
736 }
737
738 if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
739 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
740 }
741 } elseif ( $type == DatabaseBlock::TYPE_IP ) {
742 # All is well
743 } else {
744 $status->fatal( 'badipaddress' );
745 }
746
747 return $status;
748 }
749
750 /**
751 * Given the form data, actually implement a block. This is also called from ApiBlock.
752 *
753 * @param array $data
754 * @param IContextSource $context
755 * @return bool|array
756 */
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';
763
764 // Handled by field validator callback
765 // self::validateTargetField( $data['Target'] );
766
767 # This might have been a hidden field or a checkbox, so interesting data
768 # can come from it
769 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
770
771 /** @var User $target */
772 list( $target, $type ) = self::getTargetAndType( $data['Target'] );
773 if ( $type == DatabaseBlock::TYPE_USER ) {
774 $user = $target;
775 $target = $user->getName();
776 $userId = $user->getId();
777
778 # Give admins a heads-up before they go and block themselves. Much messier
779 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
780 # permission anyway, although the code does allow for it.
781 # Note: Important to use $target instead of $data['Target']
782 # since both $data['PreviousTarget'] and $target are normalized
783 # but $data['target'] gets overridden by (non-normalized) request variable
784 # from previous request.
785 if ( $target === $performer->getName() &&
786 ( $data['PreviousTarget'] !== $target || !$data['Confirm'] )
787 ) {
788 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
789 }
790 } elseif ( $type == DatabaseBlock::TYPE_RANGE ) {
791 $user = null;
792 $userId = 0;
793 } elseif ( $type == DatabaseBlock::TYPE_IP ) {
794 $user = null;
795 $target = $target->getName();
796 $userId = 0;
797 } else {
798 # This should have been caught in the form field validation
799 return [ 'badipaddress' ];
800 }
801
802 $expiryTime = self::parseExpiryInput( $data['Expiry'] );
803
804 if (
805 // an expiry time is needed
806 ( strlen( $data['Expiry'] ) == 0 ) ||
807 // can't be a larger string as 50 (it should be a time format in any way)
808 ( strlen( $data['Expiry'] ) > 50 ) ||
809 // check, if the time could be parsed
810 !$expiryTime
811 ) {
812 return [ 'ipb_expiry_invalid' ];
813 }
814
815 // an expiry time should be in the future, not in the
816 // past (wouldn't make any sense) - bug T123069
817 if ( $expiryTime < wfTimestampNow() ) {
818 return [ 'ipb_expiry_old' ];
819 }
820
821 if ( !isset( $data['DisableEmail'] ) ) {
822 $data['DisableEmail'] = false;
823 }
824
825 # If the user has done the form 'properly', they won't even have been given the
826 # option to suppress-block unless they have the 'hideuser' permission
827 if ( !isset( $data['HideUser'] ) ) {
828 $data['HideUser'] = false;
829 }
830
831 if ( $data['HideUser'] ) {
832 if ( !$performer->isAllowed( 'hideuser' ) ) {
833 # this codepath is unreachable except by a malicious user spoofing forms,
834 # or by race conditions (user has hideuser and block rights, loads block form,
835 # and loses hideuser rights before submission); so need to fail completely
836 # rather than just silently disable hiding
837 return [ 'badaccess-group0' ];
838 }
839
840 if ( $isPartialBlock ) {
841 return [ 'ipb_hide_partial' ];
842 }
843
844 # Recheck params here...
845 $hideUserContribLimit = $context->getConfig()->get( 'HideUserContribLimit' );
846 if ( $type != DatabaseBlock::TYPE_USER ) {
847 $data['HideUser'] = false; # IP users should not be hidden
848 } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
849 # Bad expiry.
850 return [ 'ipb_expiry_temp' ];
851 } elseif ( $hideUserContribLimit !== false
852 && $user->getEditCount() > $hideUserContribLimit
853 ) {
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( $hideUserContribLimit ) ] ];
858 } elseif ( !$data['Confirm'] ) {
859 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
860 }
861 }
862
863 $blockAllowsUTEdit = $context->getConfig()->get( 'BlockAllowsUTEdit' );
864 $userTalkEditAllowed = !$blockAllowsUTEdit || !$data['DisableUTEdit'];
865 if ( !$userTalkEditAllowed &&
866 $isPartialBlock &&
867 !in_array( NS_USER_TALK, explode( "\n", $data['NamespaceRestrictions'] ) )
868 ) {
869 return [ 'ipb-prevent-user-talk-edit' ];
870 }
871
872 # Create block object.
873 $block = new DatabaseBlock();
874 $block->setTarget( $target );
875 $block->setBlocker( $performer );
876 $block->setReason( $data['Reason'][0] );
877 $block->setExpiry( $expiryTime );
878 $block->isCreateAccountBlocked( $data['CreateAccount'] );
879 $block->isUsertalkEditAllowed( $userTalkEditAllowed );
880 $block->isEmailBlocked( $data['DisableEmail'] );
881 $block->isHardblock( $data['HardBlock'] );
882 $block->isAutoblocking( $data['AutoBlock'] );
883 $block->setHideName( $data['HideUser'] );
884
885 if ( $isPartialBlock ) {
886 $block->isSitewide( false );
887 }
888
889 $reason = [ 'hookaborted' ];
890 if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
891 return $reason;
892 }
893
894 $pageRestrictions = [];
895 $namespaceRestrictions = [];
896 if ( $enablePartialBlocks ) {
897 if ( $data['PageRestrictions'] !== '' ) {
898 $pageRestrictions = array_map( function ( $text ) {
899 $title = Title::newFromText( $text );
900 // Use the link cache since the title has already been loaded when
901 // the field was validated.
902 $restriction = new PageRestriction( 0, $title->getArticleID() );
903 $restriction->setTitle( $title );
904 return $restriction;
905 }, explode( "\n", $data['PageRestrictions'] ) );
906 }
907 if ( $data['NamespaceRestrictions'] !== '' ) {
908 $namespaceRestrictions = array_map( function ( $id ) {
909 return new NamespaceRestriction( 0, $id );
910 }, explode( "\n", $data['NamespaceRestrictions'] ) );
911 }
912
913 $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
914 $block->setRestrictions( $restrictions );
915 }
916
917 $priorBlock = null;
918 # Try to insert block. Is there a conflicting block?
919 $status = $block->insert();
920 if ( !$status ) {
921 # Indicates whether the user is confirming the block and is aware of
922 # the conflict (did not change the block target in the meantime)
923 $blockNotConfirmed = !$data['Confirm'] || ( array_key_exists( 'PreviousTarget', $data )
924 && $data['PreviousTarget'] !== $target );
925
926 # Special case for API - T34434
927 $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
928
929 # Show form unless the user is already aware of this...
930 if ( $blockNotConfirmed || $reblockNotAllowed ) {
931 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
932 # Otherwise, try to update the block...
933 } else {
934 # This returns direct blocks before autoblocks/rangeblocks, since we should
935 # be sure the user is blocked by now it should work for our purposes
936 $currentBlock = DatabaseBlock::newFromTarget( $target );
937 if ( $block->equals( $currentBlock ) ) {
938 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
939 }
940 # If the name was hidden and the blocking user cannot hide
941 # names, then don't allow any block changes...
942 if ( $currentBlock->getHideName() && !$performer->isAllowed( 'hideuser' ) ) {
943 return [ 'cant-see-hidden-user' ];
944 }
945
946 $priorBlock = clone $currentBlock;
947 $currentBlock->isHardblock( $block->isHardblock() );
948 $currentBlock->isCreateAccountBlocked( $block->isCreateAccountBlocked() );
949 $currentBlock->setExpiry( $block->getExpiry() );
950 $currentBlock->isAutoblocking( $block->isAutoblocking() );
951 $currentBlock->setHideName( $block->getHideName() );
952 $currentBlock->isEmailBlocked( $block->isEmailBlocked() );
953 $currentBlock->isUsertalkEditAllowed( $block->isUsertalkEditAllowed() );
954 $currentBlock->setReason( $block->getReason() );
955
956 if ( $enablePartialBlocks ) {
957 // Maintain the sitewide status. If partial blocks is not enabled,
958 // saving the block will result in a sitewide block.
959 $currentBlock->isSitewide( $block->isSitewide() );
960
961 // Set the block id of the restrictions.
962 $blockRestrictionStore = MediaWikiServices::getInstance()->getBlockRestrictionStore();
963 $currentBlock->setRestrictions(
964 $blockRestrictionStore->setBlockId( $currentBlock->getId(), $restrictions )
965 );
966 }
967
968 $status = $currentBlock->update();
969 // TODO handle failure
970
971 $logaction = 'reblock';
972
973 # Unset _deleted fields if requested
974 if ( $currentBlock->getHideName() && !$data['HideUser'] ) {
975 RevisionDeleteUser::unsuppressUserName( $target, $userId );
976 }
977
978 # If hiding/unhiding a name, this should go in the private logs
979 if ( (bool)$currentBlock->getHideName() ) {
980 $data['HideUser'] = true;
981 }
982
983 $block = $currentBlock;
984 }
985 } else {
986 $logaction = 'block';
987 }
988
989 Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
990
991 # Set *_deleted fields if requested
992 if ( $data['HideUser'] ) {
993 RevisionDeleteUser::suppressUserName( $target, $userId );
994 }
995
996 # Can't watch a rangeblock
997 if ( $type != DatabaseBlock::TYPE_RANGE && $data['Watch'] ) {
998 WatchAction::doWatch(
999 Title::makeTitle( NS_USER, $target ),
1000 $performer,
1001 User::IGNORE_USER_RIGHTS
1002 );
1003 }
1004
1005 # DatabaseBlock constructor sanitizes certain block options on insert
1006 $data['BlockEmail'] = $block->isEmailBlocked();
1007 $data['AutoBlock'] = $block->isAutoblocking();
1008
1009 # Prepare log parameters
1010 $logParams = [];
1011 $logParams['5::duration'] = $data['Expiry'];
1012 $logParams['6::flags'] = self::blockLogFlags( $data, $type );
1013 $logParams['sitewide'] = $block->isSitewide();
1014
1015 if ( $enablePartialBlocks && !$block->isSitewide() ) {
1016 if ( $data['PageRestrictions'] !== '' ) {
1017 $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
1018 }
1019
1020 if ( $data['NamespaceRestrictions'] !== '' ) {
1021 $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
1022 }
1023 }
1024
1025 # Make log entry, if the name is hidden, put it in the suppression log
1026 $log_type = $data['HideUser'] ? 'suppress' : 'block';
1027 $logEntry = new ManualLogEntry( $log_type, $logaction );
1028 $logEntry->setTarget( Title::makeTitle( NS_USER, $target ) );
1029 $logEntry->setComment( $data['Reason'][0] );
1030 $logEntry->setPerformer( $performer );
1031 $logEntry->setParameters( $logParams );
1032 # Relate log ID to block ID (T27763)
1033 $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
1034 $logId = $logEntry->insert();
1035
1036 if ( !empty( $data['Tags'] ) ) {
1037 $logEntry->setTags( $data['Tags'] );
1038 }
1039
1040 $logEntry->publish( $logId );
1041
1042 return true;
1043 }
1044
1045 /**
1046 * Get an array of suggested block durations from MediaWiki:Ipboptions
1047 * @todo FIXME: This uses a rather odd syntax for the options, should it be converted
1048 * to the standard "**<duration>|<displayname>" format?
1049 * @param Language|null $lang The language to get the durations in, or null to use
1050 * the wiki's content language
1051 * @param bool $includeOther Whether to include the 'other' option in the list of
1052 * suggestions
1053 * @return array
1054 */
1055 public static function getSuggestedDurations( Language $lang = null, $includeOther = true ) {
1056 $a = [];
1057 $msg = $lang === null
1058 ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
1059 : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1060
1061 if ( $msg == '-' ) {
1062 return [];
1063 }
1064
1065 foreach ( explode( ',', $msg ) as $option ) {
1066 if ( strpos( $option, ':' ) === false ) {
1067 $option = "$option:$option";
1068 }
1069
1070 list( $show, $value ) = explode( ':', $option );
1071 $a[$show] = $value;
1072 }
1073
1074 if ( $a && $includeOther ) {
1075 // if options exist, add other to the end instead of the begining (which
1076 // is what happens by default).
1077 $a[ wfMessage( 'ipbother' )->text() ] = 'other';
1078 }
1079
1080 return $a;
1081 }
1082
1083 /**
1084 * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
1085 * ("24 May 2034", etc), into an absolute timestamp we can put into the database.
1086 *
1087 * @todo strtotime() only accepts English strings. This means the expiry input
1088 * can only be specified in English.
1089 * @see https://www.php.net/manual/en/function.strtotime.php
1090 *
1091 * @param string $expiry Whatever was typed into the form
1092 * @return string|bool Timestamp or 'infinity' or false on error.
1093 */
1094 public static function parseExpiryInput( $expiry ) {
1095 if ( wfIsInfinity( $expiry ) ) {
1096 return 'infinity';
1097 }
1098
1099 $expiry = strtotime( $expiry );
1100
1101 if ( $expiry < 0 || $expiry === false ) {
1102 return false;
1103 }
1104
1105 return wfTimestamp( TS_MW, $expiry );
1106 }
1107
1108 /**
1109 * Can we do an email block?
1110 * @param User $user The sysop wanting to make a block
1111 * @return bool
1112 */
1113 public static function canBlockEmail( $user ) {
1114 global $wgEnableUserEmail, $wgSysopEmailBans;
1115
1116 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1117 }
1118
1119 /**
1120 * T17810: blocked admins should not be able to block/unblock
1121 * others, and probably shouldn't be able to unblock themselves
1122 * either.
1123 *
1124 * Exception: Users can block the user who blocked them, to reduce
1125 * advantage of a malicious account blocking all admins (T150826)
1126 *
1127 * @param User|int|string|null $target Target to block or unblock; could be a User object,
1128 * or a user ID or username, or null when the target is not known yet (e.g. when
1129 * displaying Special:Block)
1130 * @param User $performer User doing the request
1131 * @return bool|string True or error message key
1132 */
1133 public static function checkUnblockSelf( $target, User $performer ) {
1134 if ( is_int( $target ) ) {
1135 $target = User::newFromId( $target );
1136 } elseif ( is_string( $target ) ) {
1137 $target = User::newFromName( $target );
1138 }
1139 if ( $performer->getBlock() ) {
1140 if ( $target instanceof User && $target->getId() == $performer->getId() ) {
1141 # User is trying to unblock themselves
1142 if ( $performer->isAllowed( 'unblockself' ) ) {
1143 return true;
1144 # User blocked themselves and is now trying to reverse it
1145 } elseif ( $performer->blockedBy() === $performer->getName() ) {
1146 return true;
1147 } else {
1148 return 'ipbnounblockself';
1149 }
1150 } elseif (
1151 $target instanceof User &&
1152 $performer->getBlock() instanceof DatabaseBlock &&
1153 $performer->getBlock()->getBy() &&
1154 $performer->getBlock()->getBy() === $target->getId()
1155 ) {
1156 // Allow users to block the user that blocked them.
1157 // This is to prevent a situation where a malicious user
1158 // blocks all other users. This way, the non-malicious
1159 // user can block the malicious user back, resulting
1160 // in a stalemate.
1161 return true;
1162
1163 } else {
1164 # User is trying to block/unblock someone else
1165 return 'ipbblocked';
1166 }
1167 } else {
1168 return true;
1169 }
1170 }
1171
1172 /**
1173 * Return a comma-delimited list of "flags" to be passed to the log
1174 * reader for this block, to provide more information in the logs
1175 * @param array $data From HTMLForm data
1176 * @param int $type DatabaseBlock::TYPE_ constant (USER, RANGE, or IP)
1177 * @return string
1178 */
1179 protected static function blockLogFlags( array $data, $type ) {
1180 $config = RequestContext::getMain()->getConfig();
1181
1182 $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1183
1184 $flags = [];
1185
1186 # when blocking a user the option 'anononly' is not available/has no effect
1187 # -> do not write this into log
1188 if ( !$data['HardBlock'] && $type != DatabaseBlock::TYPE_USER ) {
1189 // For grepping: message block-log-flags-anononly
1190 $flags[] = 'anononly';
1191 }
1192
1193 if ( $data['CreateAccount'] ) {
1194 // For grepping: message block-log-flags-nocreate
1195 $flags[] = 'nocreate';
1196 }
1197
1198 # Same as anononly, this is not displayed when blocking an IP address
1199 if ( !$data['AutoBlock'] && $type == DatabaseBlock::TYPE_USER ) {
1200 // For grepping: message block-log-flags-noautoblock
1201 $flags[] = 'noautoblock';
1202 }
1203
1204 if ( $data['DisableEmail'] ) {
1205 // For grepping: message block-log-flags-noemail
1206 $flags[] = 'noemail';
1207 }
1208
1209 if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1210 // For grepping: message block-log-flags-nousertalk
1211 $flags[] = 'nousertalk';
1212 }
1213
1214 if ( $data['HideUser'] ) {
1215 // For grepping: message block-log-flags-hiddenname
1216 $flags[] = 'hiddenname';
1217 }
1218
1219 return implode( ',', $flags );
1220 }
1221
1222 /**
1223 * Process the form on POST submission.
1224 * @param array $data
1225 * @param HTMLForm|null $form
1226 * @return bool|array True for success, false for didn't-try, array of errors on failure
1227 */
1228 public function onSubmit( array $data, HTMLForm $form = null ) {
1229 // If "Editing" checkbox is unchecked, the block must be a partial block affecting
1230 // actions other than editing, and there must be no restrictions.
1231 if ( isset( $data['Editing'] ) && $data['Editing'] === false ) {
1232 $data['EditingRestriction'] = 'partial';
1233 $data['PageRestrictions'] = '';
1234 $data['NamespaceRestrictions'] = '';
1235 }
1236 return self::processForm( $data, $form->getContext() );
1237 }
1238
1239 /**
1240 * Do something exciting on successful processing of the form, most likely to show a
1241 * confirmation message
1242 */
1243 public function onSuccess() {
1244 $out = $this->getOutput();
1245 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1246 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1247 }
1248
1249 /**
1250 * Return an array of subpages beginning with $search that this special page will accept.
1251 *
1252 * @param string $search Prefix to search for
1253 * @param int $limit Maximum number of results to return (usually 10)
1254 * @param int $offset Number of results to skip (usually 0)
1255 * @return string[] Matching subpages
1256 */
1257 public function prefixSearchSubpages( $search, $limit, $offset ) {
1258 $user = User::newFromName( $search );
1259 if ( !$user ) {
1260 // No prefix suggestion for invalid user
1261 return [];
1262 }
1263 // Autocomplete subpage as user list - public to allow caching
1264 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1265 }
1266
1267 protected function getGroupName() {
1268 return 'users';
1269 }
1270 }