MediaWiki  master
SpecialBlock.php
Go to the documentation of this file.
1 <?php
27 
37  protected $target;
38 
40  protected $type;
41 
43  protected $previousTarget;
44 
46  protected $requestedHideUser;
47 
49  protected $alreadyBlocked;
50 
52  protected $preErrors = [];
53 
54  public function __construct() {
55  parent::__construct( 'Block', 'block' );
56  }
57 
58  public function doesWrites() {
59  return true;
60  }
61 
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 );
74  }
75  }
76 
82  public function requiresUnblock() {
83  return false;
84  }
85 
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 );
101  }
102 
103  list( $this->previousTarget, /*...*/ ) =
104  Block::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
105  $this->requestedHideUser = $request->getBool( 'wpHideUser' );
106  }
107 
113  protected function alterForm( HTMLForm $form ) {
114  $form->setHeaderText( '' );
115  $form->setSubmitDestructive();
116 
117  $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
118  $form->setSubmitTextMsg( $msg );
119 
120  $this->addHelpLink( 'Help:Blocking users' );
121 
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 );
125  if ( $s ) {
127  'div',
128  [ 'class' => 'error' ],
129  $s
130  ) );
131  }
132  }
133  }
134 
135  protected function getDisplayFormat() {
136  return 'ooui';
137  }
138 
143  protected function getFormFields() {
144  global $wgBlockAllowsUTEdit;
145 
146  $user = $this->getUser();
147 
148  $suggestedDurations = self::getSuggestedDurations();
149 
150  $conf = $this->getConfig();
151  $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
152 
153  $a = [];
154 
155  $a['Target'] = [
156  'type' => 'user',
157  'ipallowed' => true,
158  'iprange' => true,
159  'id' => 'mw-bi-target',
160  'size' => '45',
161  'autofocus' => true,
162  'required' => true,
163  'validation-callback' => [ __CLASS__, 'validateTargetField' ],
164  'section' => 'target',
165  ];
166 
167  $a['Editing'] = [
168  'type' => 'check',
169  'label-message' => 'block-prevent-edit',
170  'default' => true,
171  'section' => 'actions',
172  'disabled' => $enablePartialBlocks ? false : true,
173  ];
174 
175  if ( $enablePartialBlocks ) {
176  $a['EditingRestriction'] = [
177  'type' => 'radio',
178  'cssclass' => 'mw-block-editing-restriction',
179  'options' => [
180  $this->msg( 'ipb-sitewide' )->escaped() => 'sitewide',
181  $this->msg( 'ipb-partial' )->escaped() => 'partial',
182  ],
183  'section' => 'actions',
184  ];
185  $a['PageRestrictions'] = [
186  'type' => 'titlesmultiselect',
187  'label' => $this->msg( 'ipb-pages-label' )->text(),
188  'exists' => true,
189  'max' => 10,
190  'cssclass' => 'mw-block-restriction',
191  'showMissing' => false,
192  'input' => [
193  'autocomplete' => false
194  ],
195  'section' => 'actions',
196  ];
197  $a['NamespaceRestrictions'] = [
198  'type' => 'namespacesmultiselect',
199  'label' => $this->msg( 'ipb-namespaces-label' )->text(),
200  'exists' => true,
201  'cssclass' => 'mw-block-restriction',
202  'input' => [
203  'autocomplete' => false
204  ],
205  'section' => 'actions',
206  ];
207  }
208 
209  $a['CreateAccount'] = [
210  'type' => 'check',
211  'label-message' => 'ipbcreateaccount',
212  'default' => true,
213  'section' => 'actions',
214  ];
215 
216  if ( self::canBlockEmail( $user ) ) {
217  $a['DisableEmail'] = [
218  'type' => 'check',
219  'label-message' => 'ipbemailban',
220  'section' => 'actions',
221  ];
222  }
223 
224  if ( $wgBlockAllowsUTEdit ) {
225  $a['DisableUTEdit'] = [
226  'type' => 'check',
227  'label-message' => 'ipb-disableusertalk',
228  'default' => false,
229  'section' => 'actions',
230  ];
231  }
232 
233  $a['Expiry'] = [
234  'type' => 'expiry',
235  'required' => true,
236  'options' => $suggestedDurations,
237  'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
238  'section' => 'expiry',
239  ];
240 
241  $a['Reason'] = [
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.
247  'maxlength-unit' => 'codepoints',
248  'options-message' => 'ipbreason-dropdown',
249  'section' => 'reason',
250  ];
251 
252  $a['AutoBlock'] = [
253  'type' => 'check',
254  'label-message' => 'ipbenableautoblock',
255  'default' => true,
256  'section' => 'options',
257  ];
258 
259  # Allow some users to hide name from block log, blocklist and listusers
260  if ( $user->isAllowed( 'hideuser' ) ) {
261  $a['HideUser'] = [
262  'type' => 'check',
263  'label-message' => 'ipbhidename',
264  'cssclass' => 'mw-block-hideuser',
265  'section' => 'options',
266  ];
267  }
268 
269  # Watchlist their user page? (Only if user is logged in)
270  if ( $user->isLoggedIn() ) {
271  $a['Watch'] = [
272  'type' => 'check',
273  'label-message' => 'ipbwatchuser',
274  'section' => 'options',
275  ];
276  }
277 
278  $a['HardBlock'] = [
279  'type' => 'check',
280  'label-message' => 'ipb-hardblock',
281  'default' => false,
282  'section' => 'options',
283  ];
284 
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'] = [
288  'type' => 'hidden',
289  'default' => false,
290  ];
291 
292  # We'll turn this into a checkbox if we need to
293  $a['Confirm'] = [
294  'type' => 'hidden',
295  'default' => '',
296  'label-message' => 'ipb-confirm',
297  'cssclass' => 'mw-block-confirm',
298  ];
299 
300  $this->maybeAlterFormDefaults( $a );
301 
302  // Allow extensions to add more fields
303  Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
304 
305  return $a;
306  }
307 
315  protected function maybeAlterFormDefaults( &$fields ) {
316  # This will be overwritten by request data
317  $fields['Target']['default'] = (string)$this->target;
318 
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 );
324  }
325  }
326 
327  # This won't be
328  $fields['PreviousTarget']['default'] = (string)$this->target;
329 
330  $block = Block::newFromTarget( $this->target );
331 
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
335  ) {
336  $fields['HardBlock']['default'] = $block->isHardblock();
337  $fields['CreateAccount']['default'] = $block->prevents( 'createaccount' );
338  $fields['AutoBlock']['default'] = $block->isAutoblocking();
339 
340  if ( isset( $fields['DisableEmail'] ) ) {
341  $fields['DisableEmail']['default'] = $block->prevents( 'sendemail' );
342  }
343 
344  if ( isset( $fields['HideUser'] ) ) {
345  $fields['HideUser']['default'] = $block->mHideName;
346  }
347 
348  if ( isset( $fields['DisableUTEdit'] ) ) {
349  $fields['DisableUTEdit']['default'] = $block->prevents( 'editownusertalk' );
350  }
351 
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;
356  } else {
357  $fields['Reason']['default'] = '';
358  }
359 
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';
364  } else {
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;
369  }
370 
371  if ( $block->mExpiry == 'infinity' ) {
372  $fields['Expiry']['default'] = 'infinite';
373  } else {
374  $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->mExpiry );
375  }
376 
377  $this->alreadyBlocked = true;
378  $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
379  }
380 
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' ];
386  }
387 
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' ];
393  }
394 
395  if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
396  if ( $block instanceof Block && !$block->isSitewide() ) {
397  $fields['EditingRestriction']['default'] = 'partial';
398  } else {
399  $fields['EditingRestriction']['default'] = 'sitewide';
400  }
401 
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();
410  }
411  break;
412  case NamespaceRestriction::TYPE:
413  $namespaceRestrictions[] = $restriction->getValue();
414  break;
415  }
416  }
417 
418  if (
419  !$block->isSitewide() &&
420  empty( $pageRestrictions ) &&
421  empty( $namespaceRestrictions )
422  ) {
423  $fields['Editing']['default'] = false;
424  }
425 
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 );
431  }
432  }
433  }
434 
439  protected function preText() {
440  $this->getOutput()->addModuleStyles( [
441  'mediawiki.widgets.TagMultiselectWidget.styles',
442  'mediawiki.special',
443  ] );
444  $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
445 
446  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
447  $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
448 
449  $otherBlockMessages = [];
450  if ( $this->target !== null ) {
451  $targetName = $this->target;
452  if ( $this->target instanceof User ) {
453  $targetName = $this->target->getName();
454  }
455  # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
456  Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
457 
458  if ( count( $otherBlockMessages ) ) {
460  'h2',
461  [],
462  $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
463  ) . "\n";
464 
465  $list = '';
466 
467  foreach ( $otherBlockMessages as $link ) {
468  $list .= Html::rawElement( 'li', [], $link ) . "\n";
469  }
470 
471  $s .= Html::rawElement(
472  'ul',
473  [ 'class' => 'mw-blockip-alreadyblocked' ],
474  $list
475  ) . "\n";
476 
477  $text .= $s;
478  }
479  }
480 
481  return $text;
482  }
483 
488  protected function postText() {
489  $links = [];
490 
491  $this->getOutput()->addModuleStyles( 'mediawiki.special' );
492 
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(
498  $contribsPage,
499  $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
500  );
501  }
502 
503  # Link to unblock the specified user, or to a blank unblock form
504  if ( $this->target instanceof User ) {
505  $message = $this->msg(
506  'ipb-unblock-addr',
507  wfEscapeWikiText( $this->target->getName() )
508  )->parse();
509  $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
510  } else {
511  $message = $this->msg( 'ipb-unblock' )->parse();
512  $list = SpecialPage::getTitleFor( 'Unblock' );
513  }
514  $links[] = $linkRenderer->makeKnownLink(
515  $list,
516  new HtmlArmor( $message )
517  );
518 
519  # Link to the block list
520  $links[] = $linkRenderer->makeKnownLink(
521  SpecialPage::getTitleFor( 'BlockList' ),
522  $this->msg( 'ipb-blocklist' )->text()
523  );
524 
525  $user = $this->getUser();
526 
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(),
532  [],
533  [ 'action' => 'edit' ]
534  );
535  }
536 
537  $text = Html::rawElement(
538  'p',
539  [ 'class' => 'mw-ipb-conveniencelinks' ],
540  $this->getLanguage()->pipeList( $links )
541  );
542 
543  $userTitle = self::getTargetUserTitle( $this->target );
544  if ( $userTitle ) {
545  # Get relevant extracts from the block and suppression logs, if possible
546  $out = '';
547 
549  $out,
550  'block',
551  $userTitle,
552  '',
553  [
554  'lim' => 10,
555  'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
556  'showIfEmpty' => false
557  ]
558  );
559  $text .= $out;
560 
561  # Add suppression block entries if allowed
562  if ( $user->isAllowed( 'suppressionlog' ) ) {
564  $out,
565  'suppress',
566  $userTitle,
567  '',
568  [
569  'lim' => 10,
570  'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
571  'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
572  'showIfEmpty' => false
573  ]
574  );
575 
576  $text .= $out;
577  }
578  }
579 
580  return $text;
581  }
582 
589  protected static function getTargetUserTitle( $target ) {
590  if ( $target instanceof User ) {
591  return $target->getUserPage();
592  } elseif ( IP::isIPAddress( $target ) ) {
594  }
595 
596  return null;
597  }
598 
607  public static function getTargetAndType( $par, WebRequest $request = null ) {
608  $i = 0;
609  $target = null;
610 
611  while ( true ) {
612  switch ( $i++ ) {
613  case 0:
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 );
620  }
621  break;
622  case 1:
623  $target = $par;
624  break;
625  case 2:
626  if ( $request instanceof WebRequest ) {
627  $target = $request->getText( 'ip', null );
628  }
629  break;
630  case 3:
631  # B/C @since 1.18
632  if ( $request instanceof WebRequest ) {
633  $target = $request->getText( 'wpBlockAddress', null );
634  }
635  break;
636  case 4:
637  break 2;
638  }
639 
641 
642  if ( $type !== null ) {
643  return [ $target, $type ];
644  }
645  }
646 
647  return [ null, null ];
648  }
649 
658  public static function validateTargetField( $value, $alldata, $form ) {
659  $status = self::validateTarget( $value, $form->getUser() );
660  if ( !$status->isOK() ) {
661  $errors = $status->getErrorsArray();
662 
663  return $form->msg( ...$errors[0] );
664  } else {
665  return true;
666  }
667  }
668 
677  public static function validateTarget( $value, User $user ) {
678  global $wgBlockCIDRLimit;
679 
681  list( $target, $type ) = self::getTargetAndType( $value );
683 
684  if ( $type == Block::TYPE_USER ) {
685  if ( $target->isAnon() ) {
686  $status->fatal(
687  'nosuchusershort',
689  );
690  }
691 
692  $unblockStatus = self::checkUnblockSelf( $target, $user );
693  if ( $unblockStatus !== true ) {
694  $status->fatal( 'badaccess', $unblockStatus );
695  }
696  } elseif ( $type == Block::TYPE_RANGE ) {
697  list( $ip, $range ) = explode( '/', $target, 2 );
698 
699  if (
700  ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
701  ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
702  ) {
703  // Range block effectively disabled
704  $status->fatal( 'range_block_disabled' );
705  }
706 
707  if (
708  ( IP::isIPv4( $ip ) && $range > 32 ) ||
709  ( IP::isIPv6( $ip ) && $range > 128 )
710  ) {
711  // Dodgy range
712  $status->fatal( 'ip_range_invalid' );
713  }
714 
715  if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
716  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
717  }
718 
719  if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
720  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
721  }
722  } elseif ( $type == Block::TYPE_IP ) {
723  # All is well
724  } else {
725  $status->fatal( 'badipaddress' );
726  }
727 
728  return $status;
729  }
730 
738  public static function processForm( array $data, IContextSource $context ) {
740 
741  $performer = $context->getUser();
742  $enablePartialBlocks = $context->getConfig()->get( 'EnablePartialBlocks' );
743  $isPartialBlock = $enablePartialBlocks &&
744  isset( $data['EditingRestriction'] ) &&
745  $data['EditingRestriction'] === 'partial';
746 
747  // Handled by field validator callback
748  // self::validateTargetField( $data['Target'] );
749 
750  # This might have been a hidden field or a checkbox, so interesting data
751  # can come from it
752  $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
753 
755  list( $target, $type ) = self::getTargetAndType( $data['Target'] );
756  if ( $type == Block::TYPE_USER ) {
757  $user = $target;
758  $target = $user->getName();
759  $userId = $user->getId();
760 
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'] )
770  ) {
771  return [ 'ipb-blockingself', 'ipb-confirmaction' ];
772  }
773  } elseif ( $type == Block::TYPE_RANGE ) {
774  $user = null;
775  $userId = 0;
776  } elseif ( $type == Block::TYPE_IP ) {
777  $user = null;
778  $target = $target->getName();
779  $userId = 0;
780  } else {
781  # This should have been caught in the form field validation
782  return [ 'badipaddress' ];
783  }
784 
785  $expiryTime = self::parseExpiryInput( $data['Expiry'] );
786 
787  if (
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
793  !$expiryTime
794  ) {
795  return [ 'ipb_expiry_invalid' ];
796  }
797 
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' ];
802  }
803 
804  if ( !isset( $data['DisableEmail'] ) ) {
805  $data['DisableEmail'] = false;
806  }
807 
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;
812  }
813 
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' ];
821  }
822 
823  if ( $isPartialBlock ) {
824  return [ 'ipb_hide_partial' ];
825  }
826 
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'] ) ) {
831  # Bad expiry.
832  return [ 'ipb_expiry_temp' ];
833  } elseif ( $wgHideUserContribLimit !== false
834  && $user->getEditCount() > $wgHideUserContribLimit
835  ) {
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' ];
842  }
843  }
844 
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'];
857 
858  if ( $isPartialBlock ) {
859  $block->isSitewide( false );
860  }
861 
862  $reason = [ 'hookaborted' ];
863  if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
864  return $reason;
865  }
866 
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 );
877  return $restriction;
878  }, explode( "\n", $data['PageRestrictions'] ) );
879  }
880  if ( $data['NamespaceRestrictions'] !== '' ) {
881  $namespaceRestrictions = array_map( function ( $id ) {
882  return new NamespaceRestriction( 0, $id );
883  }, explode( "\n", $data['NamespaceRestrictions'] ) );
884  }
885 
886  $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
887  $block->setRestrictions( $restrictions );
888  }
889 
890  $priorBlock = null;
891  # Try to insert block. Is there a conflicting block?
892  $status = $block->insert();
893  if ( !$status ) {
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 );
898 
899  # Special case for API - T34434
900  $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
901 
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...
906  } else {
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() ] ];
912  }
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' ];
917  }
918 
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;
928 
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() );
933 
934  // Set the block id of the restrictions.
935  $currentBlock->setRestrictions(
936  BlockRestriction::setBlockId( $currentBlock->getId(), $restrictions )
937  );
938  }
939 
940  $status = $currentBlock->update();
941  // TODO handle failure
942 
943  $logaction = 'reblock';
944 
945  # Unset _deleted fields if requested
946  if ( $currentBlock->mHideName && !$data['HideUser'] ) {
948  }
949 
950  # If hiding/unhiding a name, this should go in the private logs
951  if ( (bool)$currentBlock->mHideName ) {
952  $data['HideUser'] = true;
953  }
954 
955  $block = $currentBlock;
956  }
957  } else {
958  $logaction = 'block';
959  }
960 
961  Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
962 
963  # Set *_deleted fields if requested
964  if ( $data['HideUser'] ) {
966  }
967 
968  # Can't watch a rangeblock
969  if ( $type != Block::TYPE_RANGE && $data['Watch'] ) {
972  $performer,
974  );
975  }
976 
977  # Block constructor sanitizes certain block options on insert
978  $data['BlockEmail'] = $block->prevents( 'sendemail' );
979  $data['AutoBlock'] = $block->isAutoblocking();
980 
981  # Prepare log parameters
982  $logParams = [];
983  $logParams['5::duration'] = $data['Expiry'];
984  $logParams['6::flags'] = self::blockLogFlags( $data, $type );
985  $logParams['sitewide'] = $block->isSitewide();
986 
987  if ( $enablePartialBlocks && !$block->isSitewide() ) {
988  if ( $data['PageRestrictions'] !== '' ) {
989  $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
990  }
991 
992  if ( $data['NamespaceRestrictions'] !== '' ) {
993  $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
994  }
995  }
996 
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();
1007 
1008  if ( !empty( $data['Tags'] ) ) {
1009  $logEntry->setTags( $data['Tags'] );
1010  }
1011 
1012  $logEntry->publish( $logId );
1013 
1014  return true;
1015  }
1016 
1027  public static function getSuggestedDurations( Language $lang = null, $includeOther = true ) {
1028  $a = [];
1029  $msg = $lang === null
1030  ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
1031  : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1032 
1033  if ( $msg == '-' ) {
1034  return [];
1035  }
1036 
1037  foreach ( explode( ',', $msg ) as $option ) {
1038  if ( strpos( $option, ':' ) === false ) {
1039  $option = "$option:$option";
1040  }
1041 
1042  list( $show, $value ) = explode( ':', $option );
1043  $a[$show] = $value;
1044  }
1045 
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';
1050  }
1051 
1052  return $a;
1053  }
1054 
1066  public static function parseExpiryInput( $expiry ) {
1067  if ( wfIsInfinity( $expiry ) ) {
1068  return 'infinity';
1069  }
1070 
1071  $expiry = strtotime( $expiry );
1072 
1073  if ( $expiry < 0 || $expiry === false ) {
1074  return false;
1075  }
1076 
1077  return wfTimestamp( TS_MW, $expiry );
1078  }
1079 
1085  public static function canBlockEmail( $user ) {
1087 
1088  return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1089  }
1090 
1105  public static function checkUnblockSelf( $target, User $performer ) {
1106  if ( is_int( $target ) ) {
1108  } elseif ( is_string( $target ) ) {
1110  }
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' ) ) {
1115  return true;
1116  # User blocked themselves and is now trying to reverse it
1117  } elseif ( $performer->blockedBy() === $performer->getName() ) {
1118  return true;
1119  } else {
1120  return 'ipbnounblockself';
1121  }
1122  } elseif (
1123  $target instanceof User &&
1124  $performer->getBlock() instanceof Block &&
1125  $performer->getBlock()->getBy() &&
1126  $performer->getBlock()->getBy() === $target->getId()
1127  ) {
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
1132  // in a stalemate.
1133  return true;
1134 
1135  } else {
1136  # User is trying to block/unblock someone else
1137  return 'ipbblocked';
1138  }
1139  } else {
1140  return true;
1141  }
1142  }
1143 
1151  protected static function blockLogFlags( array $data, $type ) {
1152  $config = RequestContext::getMain()->getConfig();
1153 
1154  $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1155 
1156  $flags = [];
1157 
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';
1163  }
1164 
1165  if ( $data['CreateAccount'] ) {
1166  // For grepping: message block-log-flags-nocreate
1167  $flags[] = 'nocreate';
1168  }
1169 
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';
1174  }
1175 
1176  if ( $data['DisableEmail'] ) {
1177  // For grepping: message block-log-flags-noemail
1178  $flags[] = 'noemail';
1179  }
1180 
1181  if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1182  // For grepping: message block-log-flags-nousertalk
1183  $flags[] = 'nousertalk';
1184  }
1185 
1186  if ( $data['HideUser'] ) {
1187  // For grepping: message block-log-flags-hiddenname
1188  $flags[] = 'hiddenname';
1189  }
1190 
1191  return implode( ',', $flags );
1192  }
1193 
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'] = '';
1207  }
1208  return self::processForm( $data, $form->getContext() );
1209  }
1210 
1215  public function onSuccess() {
1216  $out = $this->getOutput();
1217  $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1218  $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1219  }
1220 
1229  public function prefixSearchSubpages( $search, $limit, $offset ) {
1230  $user = User::newFromName( $search );
1231  if ( !$user ) {
1232  // No prefix suggestion for invalid user
1233  return [];
1234  }
1235  // Autocomplete subpage as user list - public to allow caching
1236  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1237  }
1238 
1239  protected function getGroupName() {
1240  return 'users';
1241  }
1242 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static getSuggestedDurations(Language $lang=null, $includeOther=true)
Get an array of suggested block durations from MediaWiki:Ipboptions.
A special page that allows users with &#39;block&#39; right to block users from editing pages and other actio...
static checkUnblockSelf( $target, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn&#39;t be able to ...
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
static processForm(array $data, IContextSource $context)
Given the form data, actually implement a block.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
static validateTarget( $value, User $user)
Validate a block target.
static validateTargetField( $value, $alldata, $form)
HTMLForm field validation-callback for Target field.
const TYPE_RANGE
Definition: Block.php:98
setTitle(\Title $title)
Set the title.
static canBlockEmail( $user)
Can we do an email block?
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgSysopEmailBans
Allow sysops to ban users from accessing Emailuser.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(!isset( $args[0])) $lang
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target&#39;s type, get an existing Block object if possible.
Definition: Block.php:1279
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1276
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
requiresUnblock()
We allow certain special cases where user is blocked.
blockedBy()
If user is blocked, return the name of the user who placed the block.
Definition: User.php:2346
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
$value
wfIsInfinity( $str)
Determine input string is represents as infinity.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
bool $requestedHideUser
Whether the previous submission of the form asked for HideUser.
const TYPE_IP
Definition: Block.php:97
static getTargetUserTitle( $target)
Get a user page target for things like logs.
isBlocked( $bFromReplica=true)
Check if user is blocked.
Definition: User.php:2277
getOutput()
Get the OutputPage being used for this instance.
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
preText()
Add header elements like block log entries, etc.
static numParam( $num)
Definition: Message.php:1049
Special page which uses an HTMLForm to handle processing.
static parseTarget( $target)
From an existing Block, get the target and the type of target.
Definition: Block.php:1501
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2487
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3042
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgBlockCIDRLimit
Limits on the possible sizes of range blocks.
getConfig()
Get the site configuration.
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1343
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
int $type
Block::TYPE_ constant.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException block
Definition: hooks.txt:2172
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
An error page which can definitely be safely rendered using the OutputPage.
isAnon()
Get whether the user is anonymous.
Definition: User.php:3840
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
postText()
Add footer elements to the form.
$wgHideUserContribLimit
The maximum number of edits a user can have and can still be hidden by users with the hideuser permis...
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:795
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1308
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
setParameter( $par)
Handle some magic here.
const IGNORE_USER_RIGHTS
Definition: User.php:77
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
getSkin()
Shortcut to get the skin being used for this instance.
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition: User.php:3895
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
bool $alreadyBlocked
static unsuppressUserName( $name, $userId, IDatabase $dbw=null)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
isSitewide( $x=null)
Indicates that the block is a sitewide block.
Definition: Block.php:1145
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
$wgEnableUserEmail
Set to true to enable user-to-user e-mail.
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
User string $previousTarget
The previous block target.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:573
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:545
getTitle( $subpage=false)
Get a self-referential title object.
$expiryTime
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
Definition: IP.php:88
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:608
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
getName()
Get the name of this Special Page.
getFormFields()
Get the HTMLForm descriptor array for the block form.
getBlock( $bFromReplica=true)
Get the block affecting the user, or null if the user is not blocked.
Definition: User.php:2287
getId()
Get the user&#39;s ID.
Definition: User.php:2460
static suppressUserName( $name, $userId, IDatabase $dbw=null)
static blockLogFlags(array $data, $type)
Return a comma-delimited list of "flags" to be passed to the log reader for this block, to provide more information in the logs.
getUser()
Shortcut to get the User executing this instance.
string $par
The sub-page of the special page.
checkExecutePermissions(User $user)
Checks that the user can unblock themselves if they are trying to do so.
getConfig()
Shortcut to get main config object.
getUserPage()
Get this user&#39;s personal page title.
Definition: User.php:4588
alterForm(HTMLForm $form)
Customizes the HTMLForm a bit.
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:99
static parseExpiryInput( $expiry)
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034"...
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2625
const TYPE_USER
Definition: Block.php:96
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1372
User string null $target
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo...
array $preErrors
$wgBlockAllowsUTEdit
Set this to true to allow blocked users to edit their own user talk page.
onSubmit(array $data, HTMLForm $form=null)
Process the form on POST submission.
maybeAlterFormDefaults(&$fields)
If the user has already been blocked with similar settings, load that block and change the defaults f...
getRequest()
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:584
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:773
Definition: Block.php:31
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2625
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1486
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280