]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blob - includes/specials/SpecialBlock.php
MediaWiki 1.30.2 renames
[autoinstallsdev/mediawiki.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 /**
25  * A special page that allows users with 'block' right to block users from
26  * editing pages and other actions
27  *
28  * @ingroup SpecialPage
29  */
30 class SpecialBlock extends FormSpecialPage {
31         /** @var User|string|null User to be blocked, as passed either by parameter (url?wpTarget=Foo)
32          * or as subpage (Special:Block/Foo) */
33         protected $target;
34
35         /** @var int Block::TYPE_ constant */
36         protected $type;
37
38         /** @var User|string The previous block target */
39         protected $previousTarget;
40
41         /** @var bool Whether the previous submission of the form asked for HideUser */
42         protected $requestedHideUser;
43
44         /** @var bool */
45         protected $alreadyBlocked;
46
47         /** @var array */
48         protected $preErrors = [];
49
50         public function __construct() {
51                 parent::__construct( 'Block', 'block' );
52         }
53
54         public function doesWrites() {
55                 return true;
56         }
57
58         /**
59          * Checks that the user can unblock themselves if they are trying to do so
60          *
61          * @param User $user
62          * @throws ErrorPageError
63          */
64         protected function checkExecutePermissions( User $user ) {
65                 parent::checkExecutePermissions( $user );
66
67                 # T17810: blocked admins should have limited access here
68                 $status = self::checkUnblockSelf( $this->target, $user );
69                 if ( $status !== true ) {
70                         throw new ErrorPageError( 'badaccess', $status );
71                 }
72         }
73
74         /**
75          * Handle some magic here
76          *
77          * @param string $par
78          */
79         protected function setParameter( $par ) {
80                 # Extract variables from the request.  Try not to get into a situation where we
81                 # need to extract *every* variable from the form just for processing here, but
82                 # there are legitimate uses for some variables
83                 $request = $this->getRequest();
84                 list( $this->target, $this->type ) = self::getTargetAndType( $par, $request );
85                 if ( $this->target instanceof User ) {
86                         # Set the 'relevant user' in the skin, so it displays links like Contributions,
87                         # User logs, UserRights, etc.
88                         $this->getSkin()->setRelevantUser( $this->target );
89                 }
90
91                 list( $this->previousTarget, /*...*/ ) =
92                         Block::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
93                 $this->requestedHideUser = $request->getBool( 'wpHideUser' );
94         }
95
96         /**
97          * Customizes the HTMLForm a bit
98          *
99          * @param HTMLForm $form
100          */
101         protected function alterForm( HTMLForm $form ) {
102                 $form->setWrapperLegendMsg( 'blockip-legend' );
103                 $form->setHeaderText( '' );
104                 $form->setSubmitDestructive();
105
106                 $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
107                 $form->setSubmitTextMsg( $msg );
108
109                 $this->addHelpLink( 'Help:Blocking users' );
110
111                 # Don't need to do anything if the form has been posted
112                 if ( !$this->getRequest()->wasPosted() && $this->preErrors ) {
113                         $s = $form->formatErrors( $this->preErrors );
114                         if ( $s ) {
115                                 $form->addHeaderText( Html::rawElement(
116                                         'div',
117                                         [ 'class' => 'error' ],
118                                         $s
119                                 ) );
120                         }
121                 }
122         }
123
124         /**
125          * Get the HTMLForm descriptor array for the block form
126          * @return array
127          */
128         protected function getFormFields() {
129                 global $wgBlockAllowsUTEdit;
130
131                 $user = $this->getUser();
132
133                 $suggestedDurations = self::getSuggestedDurations();
134
135                 $a = [
136                         'Target' => [
137                                 'type' => 'text',
138                                 'label-message' => 'ipaddressorusername',
139                                 'id' => 'mw-bi-target',
140                                 'size' => '45',
141                                 'autofocus' => true,
142                                 'required' => true,
143                                 'validation-callback' => [ __CLASS__, 'validateTargetField' ],
144                                 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
145                         ],
146                         'Expiry' => [
147                                 'type' => !count( $suggestedDurations ) ? 'text' : 'selectorother',
148                                 'label-message' => 'ipbexpiry',
149                                 'required' => true,
150                                 'options' => $suggestedDurations,
151                                 'other' => $this->msg( 'ipbother' )->text(),
152                                 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
153                         ],
154                         'Reason' => [
155                                 'type' => 'selectandother',
156                                 'maxlength' => 255,
157                                 'label-message' => 'ipbreason',
158                                 'options-message' => 'ipbreason-dropdown',
159                         ],
160                         'CreateAccount' => [
161                                 'type' => 'check',
162                                 'label-message' => 'ipbcreateaccount',
163                                 'default' => true,
164                         ],
165                 ];
166
167                 if ( self::canBlockEmail( $user ) ) {
168                         $a['DisableEmail'] = [
169                                 'type' => 'check',
170                                 'label-message' => 'ipbemailban',
171                         ];
172                 }
173
174                 if ( $wgBlockAllowsUTEdit ) {
175                         $a['DisableUTEdit'] = [
176                                 'type' => 'check',
177                                 'label-message' => 'ipb-disableusertalk',
178                                 'default' => false,
179                         ];
180                 }
181
182                 $a['AutoBlock'] = [
183                         'type' => 'check',
184                         'label-message' => 'ipbenableautoblock',
185                         'default' => true,
186                 ];
187
188                 # Allow some users to hide name from block log, blocklist and listusers
189                 if ( $user->isAllowed( 'hideuser' ) ) {
190                         $a['HideUser'] = [
191                                 'type' => 'check',
192                                 'label-message' => 'ipbhidename',
193                                 'cssclass' => 'mw-block-hideuser',
194                         ];
195                 }
196
197                 # Watchlist their user page? (Only if user is logged in)
198                 if ( $user->isLoggedIn() ) {
199                         $a['Watch'] = [
200                                 'type' => 'check',
201                                 'label-message' => 'ipbwatchuser',
202                         ];
203                 }
204
205                 $a['HardBlock'] = [
206                         'type' => 'check',
207                         'label-message' => 'ipb-hardblock',
208                         'default' => false,
209                 ];
210
211                 # This is basically a copy of the Target field, but the user can't change it, so we
212                 # can see if the warnings we maybe showed to the user before still apply
213                 $a['PreviousTarget'] = [
214                         'type' => 'hidden',
215                         'default' => false,
216                 ];
217
218                 # We'll turn this into a checkbox if we need to
219                 $a['Confirm'] = [
220                         'type' => 'hidden',
221                         'default' => '',
222                         'label-message' => 'ipb-confirm',
223                 ];
224
225                 $this->maybeAlterFormDefaults( $a );
226
227                 // Allow extensions to add more fields
228                 Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
229
230                 return $a;
231         }
232
233         /**
234          * If the user has already been blocked with similar settings, load that block
235          * and change the defaults for the form fields to match the existing settings.
236          * @param array &$fields HTMLForm descriptor array
237          * @return bool Whether fields were altered (that is, whether the target is
238          *     already blocked)
239          */
240         protected function maybeAlterFormDefaults( &$fields ) {
241                 # This will be overwritten by request data
242                 $fields['Target']['default'] = (string)$this->target;
243
244                 if ( $this->target ) {
245                         $status = self::validateTarget( $this->target, $this->getUser() );
246                         if ( !$status->isOK() ) {
247                                 $errors = $status->getErrorsArray();
248                                 $this->preErrors = array_merge( $this->preErrors, $errors );
249                         }
250                 }
251
252                 # This won't be
253                 $fields['PreviousTarget']['default'] = (string)$this->target;
254
255                 $block = Block::newFromTarget( $this->target );
256
257                 if ( $block instanceof Block && !$block->mAuto # The block exists and isn't an autoblock
258                         && ( $this->type != Block::TYPE_RANGE # The block isn't a rangeblock
259                                 || $block->getTarget() == $this->target ) # or if it is, the range is what we're about to block
260                 ) {
261                         $fields['HardBlock']['default'] = $block->isHardblock();
262                         $fields['CreateAccount']['default'] = $block->prevents( 'createaccount' );
263                         $fields['AutoBlock']['default'] = $block->isAutoblocking();
264
265                         if ( isset( $fields['DisableEmail'] ) ) {
266                                 $fields['DisableEmail']['default'] = $block->prevents( 'sendemail' );
267                         }
268
269                         if ( isset( $fields['HideUser'] ) ) {
270                                 $fields['HideUser']['default'] = $block->mHideName;
271                         }
272
273                         if ( isset( $fields['DisableUTEdit'] ) ) {
274                                 $fields['DisableUTEdit']['default'] = $block->prevents( 'editownusertalk' );
275                         }
276
277                         // If the username was hidden (ipb_deleted == 1), don't show the reason
278                         // unless this user also has rights to hideuser: T37839
279                         if ( !$block->mHideName || $this->getUser()->isAllowed( 'hideuser' ) ) {
280                                 $fields['Reason']['default'] = $block->mReason;
281                         } else {
282                                 $fields['Reason']['default'] = '';
283                         }
284
285                         if ( $this->getRequest()->wasPosted() ) {
286                                 # Ok, so we got a POST submission asking us to reblock a user.  So show the
287                                 # confirm checkbox; the user will only see it if they haven't previously
288                                 $fields['Confirm']['type'] = 'check';
289                         } else {
290                                 # We got a target, but it wasn't a POST request, so the user must have gone
291                                 # to a link like [[Special:Block/User]].  We don't need to show the checkbox
292                                 # as long as they go ahead and block *that* user
293                                 $fields['Confirm']['default'] = 1;
294                         }
295
296                         if ( $block->mExpiry == 'infinity' ) {
297                                 $fields['Expiry']['default'] = 'infinite';
298                         } else {
299                                 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->mExpiry );
300                         }
301
302                         $this->alreadyBlocked = true;
303                         $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
304                 }
305
306                 # We always need confirmation to do HideUser
307                 if ( $this->requestedHideUser ) {
308                         $fields['Confirm']['type'] = 'check';
309                         unset( $fields['Confirm']['default'] );
310                         $this->preErrors[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
311                 }
312
313                 # Or if the user is trying to block themselves
314                 if ( (string)$this->target === $this->getUser()->getName() ) {
315                         $fields['Confirm']['type'] = 'check';
316                         unset( $fields['Confirm']['default'] );
317                         $this->preErrors[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
318                 }
319         }
320
321         /**
322          * Add header elements like block log entries, etc.
323          * @return string
324          */
325         protected function preText() {
326                 $this->getOutput()->addModules( [ 'mediawiki.special.block', 'mediawiki.userSuggest' ] );
327
328                 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
329                 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
330
331                 $otherBlockMessages = [];
332                 if ( $this->target !== null ) {
333                         $targetName = $this->target;
334                         if ( $this->target instanceof User ) {
335                                 $targetName = $this->target->getName();
336                         }
337                         # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
338                         Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
339
340                         if ( count( $otherBlockMessages ) ) {
341                                 $s = Html::rawElement(
342                                         'h2',
343                                         [],
344                                         $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
345                                 ) . "\n";
346
347                                 $list = '';
348
349                                 foreach ( $otherBlockMessages as $link ) {
350                                         $list .= Html::rawElement( 'li', [], $link ) . "\n";
351                                 }
352
353                                 $s .= Html::rawElement(
354                                         'ul',
355                                         [ 'class' => 'mw-blockip-alreadyblocked' ],
356                                         $list
357                                 ) . "\n";
358
359                                 $text .= $s;
360                         }
361                 }
362
363                 return $text;
364         }
365
366         /**
367          * Add footer elements to the form
368          * @return string
369          */
370         protected function postText() {
371                 $links = [];
372
373                 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
374
375                 $linkRenderer = $this->getLinkRenderer();
376                 # Link to the user's contributions, if applicable
377                 if ( $this->target instanceof User ) {
378                         $contribsPage = SpecialPage::getTitleFor( 'Contributions', $this->target->getName() );
379                         $links[] = $linkRenderer->makeLink(
380                                 $contribsPage,
381                                 $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
382                         );
383                 }
384
385                 # Link to unblock the specified user, or to a blank unblock form
386                 if ( $this->target instanceof User ) {
387                         $message = $this->msg(
388                                 'ipb-unblock-addr',
389                                 wfEscapeWikiText( $this->target->getName() )
390                         )->parse();
391                         $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
392                 } else {
393                         $message = $this->msg( 'ipb-unblock' )->parse();
394                         $list = SpecialPage::getTitleFor( 'Unblock' );
395                 }
396                 $links[] = $linkRenderer->makeKnownLink(
397                         $list,
398                         new HtmlArmor( $message )
399                 );
400
401                 # Link to the block list
402                 $links[] = $linkRenderer->makeKnownLink(
403                         SpecialPage::getTitleFor( 'BlockList' ),
404                         $this->msg( 'ipb-blocklist' )->text()
405                 );
406
407                 $user = $this->getUser();
408
409                 # Link to edit the block dropdown reasons, if applicable
410                 if ( $user->isAllowed( 'editinterface' ) ) {
411                         $links[] = $linkRenderer->makeKnownLink(
412                                 $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
413                                 $this->msg( 'ipb-edit-dropdown' )->text(),
414                                 [],
415                                 [ 'action' => 'edit' ]
416                         );
417                 }
418
419                 $text = Html::rawElement(
420                         'p',
421                         [ 'class' => 'mw-ipb-conveniencelinks' ],
422                         $this->getLanguage()->pipeList( $links )
423                 );
424
425                 $userTitle = self::getTargetUserTitle( $this->target );
426                 if ( $userTitle ) {
427                         # Get relevant extracts from the block and suppression logs, if possible
428                         $out = '';
429
430                         LogEventsList::showLogExtract(
431                                 $out,
432                                 'block',
433                                 $userTitle,
434                                 '',
435                                 [
436                                         'lim' => 10,
437                                         'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
438                                         'showIfEmpty' => false
439                                 ]
440                         );
441                         $text .= $out;
442
443                         # Add suppression block entries if allowed
444                         if ( $user->isAllowed( 'suppressionlog' ) ) {
445                                 LogEventsList::showLogExtract(
446                                         $out,
447                                         'suppress',
448                                         $userTitle,
449                                         '',
450                                         [
451                                                 'lim' => 10,
452                                                 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
453                                                 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
454                                                 'showIfEmpty' => false
455                                         ]
456                                 );
457
458                                 $text .= $out;
459                         }
460                 }
461
462                 return $text;
463         }
464
465         /**
466          * Get a user page target for things like logs.
467          * This handles account and IP range targets.
468          * @param User|string $target
469          * @return Title|null
470          */
471         protected static function getTargetUserTitle( $target ) {
472                 if ( $target instanceof User ) {
473                         return $target->getUserPage();
474                 } elseif ( IP::isIPAddress( $target ) ) {
475                         return Title::makeTitleSafe( NS_USER, $target );
476                 }
477
478                 return null;
479         }
480
481         /**
482          * Determine the target of the block, and the type of target
483          * @todo Should be in Block.php?
484          * @param string $par Subpage parameter passed to setup, or data value from
485          *     the HTMLForm
486          * @param WebRequest $request Optionally try and get data from a request too
487          * @return array [ User|string|null, Block::TYPE_ constant|null ]
488          */
489         public static function getTargetAndType( $par, WebRequest $request = null ) {
490                 $i = 0;
491                 $target = null;
492
493                 while ( true ) {
494                         switch ( $i++ ) {
495                                 case 0:
496                                         # The HTMLForm will check wpTarget first and only if it doesn't get
497                                         # a value use the default, which will be generated from the options
498                                         # below; so this has to have a higher precedence here than $par, or
499                                         # we could end up with different values in $this->target and the HTMLForm!
500                                         if ( $request instanceof WebRequest ) {
501                                                 $target = $request->getText( 'wpTarget', null );
502                                         }
503                                         break;
504                                 case 1:
505                                         $target = $par;
506                                         break;
507                                 case 2:
508                                         if ( $request instanceof WebRequest ) {
509                                                 $target = $request->getText( 'ip', null );
510                                         }
511                                         break;
512                                 case 3:
513                                         # B/C @since 1.18
514                                         if ( $request instanceof WebRequest ) {
515                                                 $target = $request->getText( 'wpBlockAddress', null );
516                                         }
517                                         break;
518                                 case 4:
519                                         break 2;
520                         }
521
522                         list( $target, $type ) = Block::parseTarget( $target );
523
524                         if ( $type !== null ) {
525                                 return [ $target, $type ];
526                         }
527                 }
528
529                 return [ null, null ];
530         }
531
532         /**
533          * HTMLForm field validation-callback for Target field.
534          * @since 1.18
535          * @param string $value
536          * @param array $alldata
537          * @param HTMLForm $form
538          * @return Message
539          */
540         public static function validateTargetField( $value, $alldata, $form ) {
541                 $status = self::validateTarget( $value, $form->getUser() );
542                 if ( !$status->isOK() ) {
543                         $errors = $status->getErrorsArray();
544
545                         return call_user_func_array( [ $form, 'msg' ], $errors[0] );
546                 } else {
547                         return true;
548                 }
549         }
550
551         /**
552          * Validate a block target.
553          *
554          * @since 1.21
555          * @param string $value Block target to check
556          * @param User $user Performer of the block
557          * @return Status
558          */
559         public static function validateTarget( $value, User $user ) {
560                 global $wgBlockCIDRLimit;
561
562                 /** @var User $target */
563                 list( $target, $type ) = self::getTargetAndType( $value );
564                 $status = Status::newGood( $target );
565
566                 if ( $type == Block::TYPE_USER ) {
567                         if ( $target->isAnon() ) {
568                                 $status->fatal(
569                                         'nosuchusershort',
570                                         wfEscapeWikiText( $target->getName() )
571                                 );
572                         }
573
574                         $unblockStatus = self::checkUnblockSelf( $target, $user );
575                         if ( $unblockStatus !== true ) {
576                                 $status->fatal( 'badaccess', $unblockStatus );
577                         }
578                 } elseif ( $type == Block::TYPE_RANGE ) {
579                         list( $ip, $range ) = explode( '/', $target, 2 );
580
581                         if (
582                                 ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
583                                 ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
584                         ) {
585                                 // Range block effectively disabled
586                                 $status->fatal( 'range_block_disabled' );
587                         }
588
589                         if (
590                                 ( IP::isIPv4( $ip ) && $range > 32 ) ||
591                                 ( IP::isIPv6( $ip ) && $range > 128 )
592                         ) {
593                                 // Dodgy range
594                                 $status->fatal( 'ip_range_invalid' );
595                         }
596
597                         if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
598                                 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
599                         }
600
601                         if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
602                                 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
603                         }
604                 } elseif ( $type == Block::TYPE_IP ) {
605                         # All is well
606                 } else {
607                         $status->fatal( 'badipaddress' );
608                 }
609
610                 return $status;
611         }
612
613         /**
614          * Given the form data, actually implement a block. This is also called from ApiBlock.
615          *
616          * @param array $data
617          * @param IContextSource $context
618          * @return bool|string
619          */
620         public static function processForm( array $data, IContextSource $context ) {
621                 global $wgBlockAllowsUTEdit, $wgHideUserContribLimit;
622
623                 $performer = $context->getUser();
624
625                 // Handled by field validator callback
626                 // self::validateTargetField( $data['Target'] );
627
628                 # This might have been a hidden field or a checkbox, so interesting data
629                 # can come from it
630                 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
631
632                 /** @var User $target */
633                 list( $target, $type ) = self::getTargetAndType( $data['Target'] );
634                 if ( $type == Block::TYPE_USER ) {
635                         $user = $target;
636                         $target = $user->getName();
637                         $userId = $user->getId();
638
639                         # Give admins a heads-up before they go and block themselves.  Much messier
640                         # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
641                         # permission anyway, although the code does allow for it.
642                         # Note: Important to use $target instead of $data['Target']
643                         # since both $data['PreviousTarget'] and $target are normalized
644                         # but $data['target'] gets overridden by (non-normalized) request variable
645                         # from previous request.
646                         if ( $target === $performer->getName() &&
647                                 ( $data['PreviousTarget'] !== $target || !$data['Confirm'] )
648                         ) {
649                                 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
650                         }
651                 } elseif ( $type == Block::TYPE_RANGE ) {
652                         $user = null;
653                         $userId = 0;
654                 } elseif ( $type == Block::TYPE_IP ) {
655                         $user = null;
656                         $target = $target->getName();
657                         $userId = 0;
658                 } else {
659                         # This should have been caught in the form field validation
660                         return [ 'badipaddress' ];
661                 }
662
663                 $expiryTime = self::parseExpiryInput( $data['Expiry'] );
664
665                 if (
666                         // an expiry time is needed
667                         ( strlen( $data['Expiry'] ) == 0 ) ||
668                         // can't be a larger string as 50 (it should be a time format in any way)
669                         ( strlen( $data['Expiry'] ) > 50 ) ||
670                         // check, if the time could be parsed
671                         !$expiryTime
672                 ) {
673                         return [ 'ipb_expiry_invalid' ];
674                 }
675
676                 // an expiry time should be in the future, not in the
677                 // past (wouldn't make any sense) - bug T123069
678                 if ( $expiryTime < wfTimestampNow() ) {
679                         return [ 'ipb_expiry_old' ];
680                 }
681
682                 if ( !isset( $data['DisableEmail'] ) ) {
683                         $data['DisableEmail'] = false;
684                 }
685
686                 # If the user has done the form 'properly', they won't even have been given the
687                 # option to suppress-block unless they have the 'hideuser' permission
688                 if ( !isset( $data['HideUser'] ) ) {
689                         $data['HideUser'] = false;
690                 }
691
692                 if ( $data['HideUser'] ) {
693                         if ( !$performer->isAllowed( 'hideuser' ) ) {
694                                 # this codepath is unreachable except by a malicious user spoofing forms,
695                                 # or by race conditions (user has hideuser and block rights, loads block form,
696                                 # and loses hideuser rights before submission); so need to fail completely
697                                 # rather than just silently disable hiding
698                                 return [ 'badaccess-group0' ];
699                         }
700
701                         # Recheck params here...
702                         if ( $type != Block::TYPE_USER ) {
703                                 $data['HideUser'] = false; # IP users should not be hidden
704                         } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
705                                 # Bad expiry.
706                                 return [ 'ipb_expiry_temp' ];
707                         } elseif ( $wgHideUserContribLimit !== false
708                                 && $user->getEditCount() > $wgHideUserContribLimit
709                         ) {
710                                 # Typically, the user should have a handful of edits.
711                                 # Disallow hiding users with many edits for performance.
712                                 return [ [ 'ipb_hide_invalid',
713                                         Message::numParam( $wgHideUserContribLimit ) ] ];
714                         } elseif ( !$data['Confirm'] ) {
715                                 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
716                         }
717                 }
718
719                 # Create block object.
720                 $block = new Block();
721                 $block->setTarget( $target );
722                 $block->setBlocker( $performer );
723                 $block->mReason = $data['Reason'][0];
724                 $block->mExpiry = $expiryTime;
725                 $block->prevents( 'createaccount', $data['CreateAccount'] );
726                 $block->prevents( 'editownusertalk', ( !$wgBlockAllowsUTEdit || $data['DisableUTEdit'] ) );
727                 $block->prevents( 'sendemail', $data['DisableEmail'] );
728                 $block->isHardblock( $data['HardBlock'] );
729                 $block->isAutoblocking( $data['AutoBlock'] );
730                 $block->mHideName = $data['HideUser'];
731
732                 $reason = [ 'hookaborted' ];
733                 if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
734                         return $reason;
735                 }
736
737                 $priorBlock = null;
738                 # Try to insert block. Is there a conflicting block?
739                 $status = $block->insert();
740                 if ( !$status ) {
741                         # Indicates whether the user is confirming the block and is aware of
742                         # the conflict (did not change the block target in the meantime)
743                         $blockNotConfirmed = !$data['Confirm'] || ( array_key_exists( 'PreviousTarget', $data )
744                                 && $data['PreviousTarget'] !== $target );
745
746                         # Special case for API - T34434
747                         $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
748
749                         # Show form unless the user is already aware of this...
750                         if ( $blockNotConfirmed || $reblockNotAllowed ) {
751                                 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
752                                 # Otherwise, try to update the block...
753                         } else {
754                                 # This returns direct blocks before autoblocks/rangeblocks, since we should
755                                 # be sure the user is blocked by now it should work for our purposes
756                                 $currentBlock = Block::newFromTarget( $target );
757                                 if ( $block->equals( $currentBlock ) ) {
758                                         return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
759                                 }
760                                 # If the name was hidden and the blocking user cannot hide
761                                 # names, then don't allow any block changes...
762                                 if ( $currentBlock->mHideName && !$performer->isAllowed( 'hideuser' ) ) {
763                                         return [ 'cant-see-hidden-user' ];
764                                 }
765
766                                 $priorBlock = clone $currentBlock;
767                                 $currentBlock->isHardblock( $block->isHardblock() );
768                                 $currentBlock->prevents( 'createaccount', $block->prevents( 'createaccount' ) );
769                                 $currentBlock->mExpiry = $block->mExpiry;
770                                 $currentBlock->isAutoblocking( $block->isAutoblocking() );
771                                 $currentBlock->mHideName = $block->mHideName;
772                                 $currentBlock->prevents( 'sendemail', $block->prevents( 'sendemail' ) );
773                                 $currentBlock->prevents( 'editownusertalk', $block->prevents( 'editownusertalk' ) );
774                                 $currentBlock->mReason = $block->mReason;
775
776                                 $status = $currentBlock->update();
777
778                                 $logaction = 'reblock';
779
780                                 # Unset _deleted fields if requested
781                                 if ( $currentBlock->mHideName && !$data['HideUser'] ) {
782                                         RevisionDeleteUser::unsuppressUserName( $target, $userId );
783                                 }
784
785                                 # If hiding/unhiding a name, this should go in the private logs
786                                 if ( (bool)$currentBlock->mHideName ) {
787                                         $data['HideUser'] = true;
788                                 }
789                         }
790                 } else {
791                         $logaction = 'block';
792                 }
793
794                 Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
795
796                 # Set *_deleted fields if requested
797                 if ( $data['HideUser'] ) {
798                         RevisionDeleteUser::suppressUserName( $target, $userId );
799                 }
800
801                 # Can't watch a rangeblock
802                 if ( $type != Block::TYPE_RANGE && $data['Watch'] ) {
803                         WatchAction::doWatch(
804                                 Title::makeTitle( NS_USER, $target ),
805                                 $performer,
806                                 User::IGNORE_USER_RIGHTS
807                         );
808                 }
809
810                 # Block constructor sanitizes certain block options on insert
811                 $data['BlockEmail'] = $block->prevents( 'sendemail' );
812                 $data['AutoBlock'] = $block->isAutoblocking();
813
814                 # Prepare log parameters
815                 $logParams = [];
816                 $logParams['5::duration'] = $data['Expiry'];
817                 $logParams['6::flags'] = self::blockLogFlags( $data, $type );
818
819                 # Make log entry, if the name is hidden, put it in the suppression log
820                 $log_type = $data['HideUser'] ? 'suppress' : 'block';
821                 $logEntry = new ManualLogEntry( $log_type, $logaction );
822                 $logEntry->setTarget( Title::makeTitle( NS_USER, $target ) );
823                 $logEntry->setComment( $data['Reason'][0] );
824                 $logEntry->setPerformer( $performer );
825                 $logEntry->setParameters( $logParams );
826                 # Relate log ID to block IDs (T27763)
827                 $blockIds = array_merge( [ $status['id'] ], $status['autoIds'] );
828                 $logEntry->setRelations( [ 'ipb_id' => $blockIds ] );
829                 $logId = $logEntry->insert();
830
831                 if ( !empty( $data['Tags'] ) ) {
832                         $logEntry->setTags( $data['Tags'] );
833                 }
834
835                 $logEntry->publish( $logId );
836
837                 return true;
838         }
839
840         /**
841          * Get an array of suggested block durations from MediaWiki:Ipboptions
842          * @todo FIXME: This uses a rather odd syntax for the options, should it be converted
843          *     to the standard "**<duration>|<displayname>" format?
844          * @param Language|null $lang The language to get the durations in, or null to use
845          *     the wiki's content language
846          * @return array
847          */
848         public static function getSuggestedDurations( $lang = null ) {
849                 $a = [];
850                 $msg = $lang === null
851                         ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
852                         : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
853
854                 if ( $msg == '-' ) {
855                         return [];
856                 }
857
858                 foreach ( explode( ',', $msg ) as $option ) {
859                         if ( strpos( $option, ':' ) === false ) {
860                                 $option = "$option:$option";
861                         }
862
863                         list( $show, $value ) = explode( ':', $option );
864                         $a[$show] = $value;
865                 }
866
867                 return $a;
868         }
869
870         /**
871          * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
872          * ("24 May 2034", etc), into an absolute timestamp we can put into the database.
873          * @param string $expiry Whatever was typed into the form
874          * @return string Timestamp or 'infinity'
875          */
876         public static function parseExpiryInput( $expiry ) {
877                 if ( wfIsInfinity( $expiry ) ) {
878                         $expiry = 'infinity';
879                 } else {
880                         $expiry = strtotime( $expiry );
881
882                         if ( $expiry < 0 || $expiry === false ) {
883                                 return false;
884                         }
885
886                         $expiry = wfTimestamp( TS_MW, $expiry );
887                 }
888
889                 return $expiry;
890         }
891
892         /**
893          * Can we do an email block?
894          * @param User $user The sysop wanting to make a block
895          * @return bool
896          */
897         public static function canBlockEmail( $user ) {
898                 global $wgEnableUserEmail, $wgSysopEmailBans;
899
900                 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
901         }
902
903         /**
904          * T17810: blocked admins should not be able to block/unblock
905          * others, and probably shouldn't be able to unblock themselves
906          * either.
907          * @param User|int|string $user
908          * @param User $performer User doing the request
909          * @return bool|string True or error message key
910          */
911         public static function checkUnblockSelf( $user, User $performer ) {
912                 if ( is_int( $user ) ) {
913                         $user = User::newFromId( $user );
914                 } elseif ( is_string( $user ) ) {
915                         $user = User::newFromName( $user );
916                 }
917
918                 if ( $performer->isBlocked() ) {
919                         if ( $user instanceof User && $user->getId() == $performer->getId() ) {
920                                 # User is trying to unblock themselves
921                                 if ( $performer->isAllowed( 'unblockself' ) ) {
922                                         return true;
923                                         # User blocked themselves and is now trying to reverse it
924                                 } elseif ( $performer->blockedBy() === $performer->getName() ) {
925                                         return true;
926                                 } else {
927                                         return 'ipbnounblockself';
928                                 }
929                         } else {
930                                 # User is trying to block/unblock someone else
931                                 return 'ipbblocked';
932                         }
933                 } else {
934                         return true;
935                 }
936         }
937
938         /**
939          * Return a comma-delimited list of "flags" to be passed to the log
940          * reader for this block, to provide more information in the logs
941          * @param array $data From HTMLForm data
942          * @param int $type Block::TYPE_ constant (USER, RANGE, or IP)
943          * @return string
944          */
945         protected static function blockLogFlags( array $data, $type ) {
946                 global $wgBlockAllowsUTEdit;
947                 $flags = [];
948
949                 # when blocking a user the option 'anononly' is not available/has no effect
950                 # -> do not write this into log
951                 if ( !$data['HardBlock'] && $type != Block::TYPE_USER ) {
952                         // For grepping: message block-log-flags-anononly
953                         $flags[] = 'anononly';
954                 }
955
956                 if ( $data['CreateAccount'] ) {
957                         // For grepping: message block-log-flags-nocreate
958                         $flags[] = 'nocreate';
959                 }
960
961                 # Same as anononly, this is not displayed when blocking an IP address
962                 if ( !$data['AutoBlock'] && $type == Block::TYPE_USER ) {
963                         // For grepping: message block-log-flags-noautoblock
964                         $flags[] = 'noautoblock';
965                 }
966
967                 if ( $data['DisableEmail'] ) {
968                         // For grepping: message block-log-flags-noemail
969                         $flags[] = 'noemail';
970                 }
971
972                 if ( $wgBlockAllowsUTEdit && $data['DisableUTEdit'] ) {
973                         // For grepping: message block-log-flags-nousertalk
974                         $flags[] = 'nousertalk';
975                 }
976
977                 if ( $data['HideUser'] ) {
978                         // For grepping: message block-log-flags-hiddenname
979                         $flags[] = 'hiddenname';
980                 }
981
982                 return implode( ',', $flags );
983         }
984
985         /**
986          * Process the form on POST submission.
987          * @param array $data
988          * @param HTMLForm $form
989          * @return bool|array True for success, false for didn't-try, array of errors on failure
990          */
991         public function onSubmit( array $data, HTMLForm $form = null ) {
992                 return self::processForm( $data, $form->getContext() );
993         }
994
995         /**
996          * Do something exciting on successful processing of the form, most likely to show a
997          * confirmation message
998          */
999         public function onSuccess() {
1000                 $out = $this->getOutput();
1001                 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1002                 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1003         }
1004
1005         /**
1006          * Return an array of subpages beginning with $search that this special page will accept.
1007          *
1008          * @param string $search Prefix to search for
1009          * @param int $limit Maximum number of results to return (usually 10)
1010          * @param int $offset Number of results to skip (usually 0)
1011          * @return string[] Matching subpages
1012          */
1013         public function prefixSearchSubpages( $search, $limit, $offset ) {
1014                 $user = User::newFromName( $search );
1015                 if ( !$user ) {
1016                         // No prefix suggestion for invalid user
1017                         return [];
1018                 }
1019                 // Autocomplete subpage as user list - public to allow caching
1020                 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1021         }
1022
1023         protected function getGroupName() {
1024                 return 'users';
1025         }
1026 }