MediaWiki  master
SpecialBlock.php
Go to the documentation of this file.
1 <?php
28 
39  protected $target;
40 
42  protected $type;
43 
45  protected $previousTarget;
46 
48  protected $requestedHideUser;
49 
51  protected $alreadyBlocked;
52 
54  protected $preErrors = [];
55 
56  public function __construct() {
57  parent::__construct( 'Block', 'block' );
58  }
59 
60  public function doesWrites() {
61  return true;
62  }
63 
70  protected function checkExecutePermissions( User $user ) {
71  parent::checkExecutePermissions( $user );
72  # T17810: blocked admins should have limited access here
73  $status = self::checkUnblockSelf( $this->target, $user );
74  if ( $status !== true ) {
75  throw new ErrorPageError( 'badaccess', $status );
76  }
77  }
78 
84  public function requiresUnblock() {
85  return false;
86  }
87 
93  protected function setParameter( $par ) {
94  # Extract variables from the request. Try not to get into a situation where we
95  # need to extract *every* variable from the form just for processing here, but
96  # there are legitimate uses for some variables
97  $request = $this->getRequest();
98  list( $this->target, $this->type ) = self::getTargetAndType( $par, $request );
99  if ( $this->target instanceof User ) {
100  # Set the 'relevant user' in the skin, so it displays links like Contributions,
101  # User logs, UserRights, etc.
102  $this->getSkin()->setRelevantUser( $this->target );
103  }
104 
105  list( $this->previousTarget, /*...*/ ) =
106  DatabaseBlock::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
107  $this->requestedHideUser = $request->getBool( 'wpHideUser' );
108  }
109 
115  protected function alterForm( HTMLForm $form ) {
116  $form->setHeaderText( '' );
117  $form->setSubmitDestructive();
118 
119  $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
120  $form->setSubmitTextMsg( $msg );
121 
122  $this->addHelpLink( 'Help:Blocking users' );
123 
124  # Don't need to do anything if the form has been posted
125  if ( !$this->getRequest()->wasPosted() && $this->preErrors ) {
126  $s = $form->formatErrors( $this->preErrors );
127  if ( $s ) {
129  'div',
130  [ 'class' => 'error' ],
131  $s
132  ) );
133  }
134  }
135  }
136 
137  protected function getDisplayFormat() {
138  return 'ooui';
139  }
140 
145  protected function getFormFields() {
146  $conf = $this->getConfig();
147  $enablePartialBlocks = $conf->get( 'EnablePartialBlocks' );
148  $blockAllowsUTEdit = $conf->get( 'BlockAllowsUTEdit' );
149 
150  $this->getOutput()->enableOOUI();
151 
152  $user = $this->getUser();
153 
154  $suggestedDurations = self::getSuggestedDurations();
155 
156  $a = [];
157 
158  $a['Target'] = [
159  'type' => 'user',
160  'ipallowed' => true,
161  'iprange' => true,
162  'id' => 'mw-bi-target',
163  'size' => '45',
164  'autofocus' => true,
165  'required' => true,
166  'validation-callback' => [ __CLASS__, 'validateTargetField' ],
167  'section' => 'target',
168  ];
169 
170  $a['Editing'] = [
171  'type' => 'check',
172  'label-message' => 'block-prevent-edit',
173  'default' => true,
174  'section' => 'actions',
175  'disabled' => $enablePartialBlocks ? false : true,
176  ];
177 
178  if ( $enablePartialBlocks ) {
179  $a['EditingRestriction'] = [
180  'type' => 'radio',
181  'cssclass' => 'mw-block-editing-restriction',
182  'options' => [
183  $this->msg( 'ipb-sitewide' )->escaped() .
184  new \OOUI\LabelWidget( [
185  'classes' => [ 'oo-ui-inline-help' ],
186  'label' => $this->msg( 'ipb-sitewide-help' )->text(),
187  ] ) => 'sitewide',
188  $this->msg( 'ipb-partial' )->escaped() .
189  new \OOUI\LabelWidget( [
190  'classes' => [ 'oo-ui-inline-help' ],
191  'label' => $this->msg( 'ipb-partial-help' )->text(),
192  ] ) => 'partial',
193  ],
194  'section' => 'actions',
195  ];
196  $a['PageRestrictions'] = [
197  'type' => 'titlesmultiselect',
198  'label' => $this->msg( 'ipb-pages-label' )->text(),
199  'exists' => true,
200  'max' => 10,
201  'cssclass' => 'mw-block-restriction',
202  'showMissing' => false,
203  'excludeDynamicNamespaces' => true,
204  'input' => [
205  'autocomplete' => false
206  ],
207  'section' => 'actions',
208  ];
209  $a['NamespaceRestrictions'] = [
210  'type' => 'namespacesmultiselect',
211  'label' => $this->msg( 'ipb-namespaces-label' )->text(),
212  'exists' => true,
213  'cssclass' => 'mw-block-restriction',
214  'input' => [
215  'autocomplete' => false
216  ],
217  'section' => 'actions',
218  ];
219  }
220 
221  $a['CreateAccount'] = [
222  'type' => 'check',
223  'label-message' => 'ipbcreateaccount',
224  'default' => true,
225  'section' => 'actions',
226  ];
227 
228  if ( self::canBlockEmail( $user ) ) {
229  $a['DisableEmail'] = [
230  'type' => 'check',
231  'label-message' => 'ipbemailban',
232  'section' => 'actions',
233  ];
234  }
235 
236  if ( $blockAllowsUTEdit ) {
237  $a['DisableUTEdit'] = [
238  'type' => 'check',
239  'label-message' => 'ipb-disableusertalk',
240  'default' => false,
241  'section' => 'actions',
242  ];
243  }
244 
245  $a['Expiry'] = [
246  'type' => 'expiry',
247  'required' => true,
248  'options' => $suggestedDurations,
249  'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
250  'section' => 'expiry',
251  ];
252 
253  $a['Reason'] = [
254  'type' => 'selectandother',
255  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
256  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
257  // Unicode codepoints.
259  'maxlength-unit' => 'codepoints',
260  'options-message' => 'ipbreason-dropdown',
261  'section' => 'reason',
262  ];
263 
264  $a['AutoBlock'] = [
265  'type' => 'check',
266  'label-message' => 'ipbenableautoblock',
267  'default' => true,
268  'section' => 'options',
269  ];
270 
271  # Allow some users to hide name from block log, blocklist and listusers
272  if ( $user->isAllowed( 'hideuser' ) ) {
273  $a['HideUser'] = [
274  'type' => 'check',
275  'label-message' => 'ipbhidename',
276  'cssclass' => 'mw-block-hideuser',
277  'section' => 'options',
278  ];
279  }
280 
281  # Watchlist their user page? (Only if user is logged in)
282  if ( $user->isLoggedIn() ) {
283  $a['Watch'] = [
284  'type' => 'check',
285  'label-message' => 'ipbwatchuser',
286  'section' => 'options',
287  ];
288  }
289 
290  $a['HardBlock'] = [
291  'type' => 'check',
292  'label-message' => 'ipb-hardblock',
293  'default' => false,
294  'section' => 'options',
295  ];
296 
297  # This is basically a copy of the Target field, but the user can't change it, so we
298  # can see if the warnings we maybe showed to the user before still apply
299  $a['PreviousTarget'] = [
300  'type' => 'hidden',
301  'default' => false,
302  ];
303 
304  # We'll turn this into a checkbox if we need to
305  $a['Confirm'] = [
306  'type' => 'hidden',
307  'default' => '',
308  'label-message' => 'ipb-confirm',
309  'cssclass' => 'mw-block-confirm',
310  ];
311 
312  $this->maybeAlterFormDefaults( $a );
313 
314  // Allow extensions to add more fields
315  Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
316 
317  return $a;
318  }
319 
325  protected function maybeAlterFormDefaults( &$fields ) {
326  # This will be overwritten by request data
327  $fields['Target']['default'] = (string)$this->target;
328 
329  if ( $this->target ) {
330  $status = self::validateTarget( $this->target, $this->getUser() );
331  if ( !$status->isOK() ) {
332  $errors = $status->getErrorsArray();
333  $this->preErrors = array_merge( $this->preErrors, $errors );
334  }
335  }
336 
337  # This won't be
338  $fields['PreviousTarget']['default'] = (string)$this->target;
339 
340  $block = DatabaseBlock::newFromTarget( $this->target );
341 
342  // Populate fields if there is a block that is not an autoblock; if it is a range
343  // block, only populate the fields if the range is the same as $this->target
344  if ( $block instanceof DatabaseBlock && $block->getType() !== DatabaseBlock::TYPE_AUTO
345  && ( $this->type != DatabaseBlock::TYPE_RANGE
346  || $block->getTarget() == $this->target )
347  ) {
348  $fields['HardBlock']['default'] = $block->isHardblock();
349  $fields['CreateAccount']['default'] = $block->isCreateAccountBlocked();
350  $fields['AutoBlock']['default'] = $block->isAutoblocking();
351 
352  if ( isset( $fields['DisableEmail'] ) ) {
353  $fields['DisableEmail']['default'] = $block->isEmailBlocked();
354  }
355 
356  if ( isset( $fields['HideUser'] ) ) {
357  $fields['HideUser']['default'] = $block->getHideName();
358  }
359 
360  if ( isset( $fields['DisableUTEdit'] ) ) {
361  $fields['DisableUTEdit']['default'] = !$block->isUsertalkEditAllowed();
362  }
363 
364  // If the username was hidden (ipb_deleted == 1), don't show the reason
365  // unless this user also has rights to hideuser: T37839
366  if ( !$block->getHideName() || $this->getUser()->isAllowed( 'hideuser' ) ) {
367  $fields['Reason']['default'] = $block->getReason();
368  } else {
369  $fields['Reason']['default'] = '';
370  }
371 
372  if ( $this->getRequest()->wasPosted() ) {
373  # Ok, so we got a POST submission asking us to reblock a user. So show the
374  # confirm checkbox; the user will only see it if they haven't previously
375  $fields['Confirm']['type'] = 'check';
376  } else {
377  # We got a target, but it wasn't a POST request, so the user must have gone
378  # to a link like [[Special:Block/User]]. We don't need to show the checkbox
379  # as long as they go ahead and block *that* user
380  $fields['Confirm']['default'] = 1;
381  }
382 
383  if ( $block->getExpiry() == 'infinity' ) {
384  $fields['Expiry']['default'] = 'infinite';
385  } else {
386  $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->getExpiry() );
387  }
388 
389  $this->alreadyBlocked = true;
390  $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
391  }
392 
393  if ( $this->alreadyBlocked || $this->getRequest()->wasPosted()
394  || $this->getRequest()->getCheck( 'wpCreateAccount' )
395  ) {
396  $this->getOutput()->addJsConfigVars( 'wgCreateAccountDirty', true );
397  }
398 
399  # We always need confirmation to do HideUser
400  if ( $this->requestedHideUser ) {
401  $fields['Confirm']['type'] = 'check';
402  unset( $fields['Confirm']['default'] );
403  $this->preErrors[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
404  }
405 
406  # Or if the user is trying to block themselves
407  if ( (string)$this->target === $this->getUser()->getName() ) {
408  $fields['Confirm']['type'] = 'check';
409  unset( $fields['Confirm']['default'] );
410  $this->preErrors[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
411  }
412 
413  if ( $this->getConfig()->get( 'EnablePartialBlocks' ) ) {
414  if ( $block instanceof DatabaseBlock && !$block->isSitewide() ) {
415  $fields['EditingRestriction']['default'] = 'partial';
416  } else {
417  $fields['EditingRestriction']['default'] = 'sitewide';
418  }
419 
420  if ( $block instanceof DatabaseBlock ) {
421  $pageRestrictions = [];
422  $namespaceRestrictions = [];
423  foreach ( $block->getRestrictions() as $restriction ) {
424  switch ( $restriction->getType() ) {
425  case PageRestriction::TYPE:
426  if ( $restriction->getTitle() ) {
427  $pageRestrictions[] = $restriction->getTitle()->getPrefixedText();
428  }
429  break;
430  case NamespaceRestriction::TYPE:
431  $namespaceRestrictions[] = $restriction->getValue();
432  break;
433  }
434  }
435 
436  if (
437  !$block->isSitewide() &&
438  empty( $pageRestrictions ) &&
439  empty( $namespaceRestrictions )
440  ) {
441  $fields['Editing']['default'] = false;
442  }
443 
444  // Sort the restrictions so they are in alphabetical order.
445  sort( $pageRestrictions );
446  $fields['PageRestrictions']['default'] = implode( "\n", $pageRestrictions );
447  sort( $namespaceRestrictions );
448  $fields['NamespaceRestrictions']['default'] = implode( "\n", $namespaceRestrictions );
449  }
450  }
451  }
452 
457  protected function preText() {
458  $this->getOutput()->addModuleStyles( [
459  'mediawiki.widgets.TagMultiselectWidget.styles',
460  'mediawiki.special',
461  ] );
462  $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
463 
464  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
465  $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
466 
467  $otherBlockMessages = [];
468  if ( $this->target !== null ) {
469  $targetName = $this->target;
470  if ( $this->target instanceof User ) {
471  $targetName = $this->target->getName();
472  }
473  # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
474  Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
475 
476  if ( count( $otherBlockMessages ) ) {
478  'h2',
479  [],
480  $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
481  ) . "\n";
482 
483  $list = '';
484 
485  foreach ( $otherBlockMessages as $link ) {
486  $list .= Html::rawElement( 'li', [], $link ) . "\n";
487  }
488 
489  $s .= Html::rawElement(
490  'ul',
491  [ 'class' => 'mw-blockip-alreadyblocked' ],
492  $list
493  ) . "\n";
494 
495  $text .= $s;
496  }
497  }
498 
499  return $text;
500  }
501 
506  protected function postText() {
507  $links = [];
508 
509  $this->getOutput()->addModuleStyles( 'mediawiki.special' );
510 
511  $linkRenderer = $this->getLinkRenderer();
512  # Link to the user's contributions, if applicable
513  if ( $this->target instanceof User ) {
514  $contribsPage = SpecialPage::getTitleFor( 'Contributions', $this->target->getName() );
515  $links[] = $linkRenderer->makeLink(
516  $contribsPage,
517  $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
518  );
519  }
520 
521  # Link to unblock the specified user, or to a blank unblock form
522  if ( $this->target instanceof User ) {
523  $message = $this->msg(
524  'ipb-unblock-addr',
525  wfEscapeWikiText( $this->target->getName() )
526  )->parse();
527  $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
528  } else {
529  $message = $this->msg( 'ipb-unblock' )->parse();
530  $list = SpecialPage::getTitleFor( 'Unblock' );
531  }
532  $links[] = $linkRenderer->makeKnownLink(
533  $list,
534  new HtmlArmor( $message )
535  );
536 
537  # Link to the block list
538  $links[] = $linkRenderer->makeKnownLink(
539  SpecialPage::getTitleFor( 'BlockList' ),
540  $this->msg( 'ipb-blocklist' )->text()
541  );
542 
543  $user = $this->getUser();
544 
545  # Link to edit the block dropdown reasons, if applicable
546  if ( $user->isAllowed( 'editinterface' ) ) {
547  $links[] = $linkRenderer->makeKnownLink(
548  $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
549  $this->msg( 'ipb-edit-dropdown' )->text(),
550  [],
551  [ 'action' => 'edit' ]
552  );
553  }
554 
555  $text = Html::rawElement(
556  'p',
557  [ 'class' => 'mw-ipb-conveniencelinks' ],
558  $this->getLanguage()->pipeList( $links )
559  );
560 
561  $userTitle = self::getTargetUserTitle( $this->target );
562  if ( $userTitle ) {
563  # Get relevant extracts from the block and suppression logs, if possible
564  $out = '';
565 
567  $out,
568  'block',
569  $userTitle,
570  '',
571  [
572  'lim' => 10,
573  'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
574  'showIfEmpty' => false
575  ]
576  );
577  $text .= $out;
578 
579  # Add suppression block entries if allowed
580  if ( $user->isAllowed( 'suppressionlog' ) ) {
582  $out,
583  'suppress',
584  $userTitle,
585  '',
586  [
587  'lim' => 10,
588  'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
589  'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
590  'showIfEmpty' => false
591  ]
592  );
593 
594  $text .= $out;
595  }
596  }
597 
598  return $text;
599  }
600 
607  protected static function getTargetUserTitle( $target ) {
608  if ( $target instanceof User ) {
609  return $target->getUserPage();
610  } elseif ( IP::isIPAddress( $target ) ) {
612  }
613 
614  return null;
615  }
616 
626  public static function getTargetAndType( $par, WebRequest $request = null ) {
627  $i = 0;
628  $target = null;
629 
630  while ( true ) {
631  switch ( $i++ ) {
632  case 0:
633  # The HTMLForm will check wpTarget first and only if it doesn't get
634  # a value use the default, which will be generated from the options
635  # below; so this has to have a higher precedence here than $par, or
636  # we could end up with different values in $this->target and the HTMLForm!
637  if ( $request instanceof WebRequest ) {
638  $target = $request->getText( 'wpTarget', null );
639  }
640  break;
641  case 1:
642  $target = $par;
643  break;
644  case 2:
645  if ( $request instanceof WebRequest ) {
646  $target = $request->getText( 'ip', null );
647  }
648  break;
649  case 3:
650  # B/C @since 1.18
651  if ( $request instanceof WebRequest ) {
652  $target = $request->getText( 'wpBlockAddress', null );
653  }
654  break;
655  case 4:
656  break 2;
657  }
658 
659  list( $target, $type ) = DatabaseBlock::parseTarget( $target );
660 
661  if ( $type !== null ) {
662  return [ $target, $type ];
663  }
664  }
665 
666  return [ null, null ];
667  }
668 
677  public static function validateTargetField( $value, $alldata, $form ) {
678  $status = self::validateTarget( $value, $form->getUser() );
679  if ( !$status->isOK() ) {
680  $errors = $status->getErrorsArray();
681 
682  return $form->msg( ...$errors[0] );
683  } else {
684  return true;
685  }
686  }
687 
696  public static function validateTarget( $value, User $user ) {
697  global $wgBlockCIDRLimit;
698 
700  list( $target, $type ) = self::getTargetAndType( $value );
702 
703  if ( $type == DatabaseBlock::TYPE_USER ) {
704  if ( $target->isAnon() ) {
705  $status->fatal(
706  'nosuchusershort',
708  );
709  }
710 
711  $unblockStatus = self::checkUnblockSelf( $target, $user );
712  if ( $unblockStatus !== true ) {
713  $status->fatal( 'badaccess', $unblockStatus );
714  }
715  } elseif ( $type == DatabaseBlock::TYPE_RANGE ) {
716  list( $ip, $range ) = explode( '/', $target, 2 );
717 
718  if (
719  ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
720  ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
721  ) {
722  // Range block effectively disabled
723  $status->fatal( 'range_block_disabled' );
724  }
725 
726  if (
727  ( IP::isIPv4( $ip ) && $range > 32 ) ||
728  ( IP::isIPv6( $ip ) && $range > 128 )
729  ) {
730  // Dodgy range
731  $status->fatal( 'ip_range_invalid' );
732  }
733 
734  if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
735  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
736  }
737 
738  if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
739  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
740  }
741  } elseif ( $type == DatabaseBlock::TYPE_IP ) {
742  # All is well
743  } else {
744  $status->fatal( 'badipaddress' );
745  }
746 
747  return $status;
748  }
749 
757  public static function processForm( array $data, IContextSource $context ) {
758  $performer = $context->getUser();
759  $enablePartialBlocks = $context->getConfig()->get( 'EnablePartialBlocks' );
760  $isPartialBlock = $enablePartialBlocks &&
761  isset( $data['EditingRestriction'] ) &&
762  $data['EditingRestriction'] === 'partial';
763 
764  # This might have been a hidden field or a checkbox, so interesting data
765  # can come from it
766  $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
767 
769  list( $target, $type ) = self::getTargetAndType( $data['Target'] );
770  if ( $type == DatabaseBlock::TYPE_USER ) {
771  $user = $target;
772  $target = $user->getName();
773  $userId = $user->getId();
774 
775  # Give admins a heads-up before they go and block themselves. Much messier
776  # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
777  # permission anyway, although the code does allow for it.
778  # Note: Important to use $target instead of $data['Target']
779  # since both $data['PreviousTarget'] and $target are normalized
780  # but $data['target'] gets overridden by (non-normalized) request variable
781  # from previous request.
782  if ( $target === $performer->getName() &&
783  ( $data['PreviousTarget'] !== $target || !$data['Confirm'] )
784  ) {
785  return [ 'ipb-blockingself', 'ipb-confirmaction' ];
786  }
787  } elseif ( $type == DatabaseBlock::TYPE_RANGE ) {
788  $user = null;
789  $userId = 0;
790  } elseif ( $type == DatabaseBlock::TYPE_IP ) {
791  $user = null;
792  $target = $target->getName();
793  $userId = 0;
794  } else {
795  # This should have been caught in the form field validation
796  return [ 'badipaddress' ];
797  }
798 
799  $expiryTime = self::parseExpiryInput( $data['Expiry'] );
800 
801  if (
802  // an expiry time is needed
803  ( strlen( $data['Expiry'] ) == 0 ) ||
804  // can't be a larger string as 50 (it should be a time format in any way)
805  ( strlen( $data['Expiry'] ) > 50 ) ||
806  // check, if the time could be parsed
807  !$expiryTime
808  ) {
809  return [ 'ipb_expiry_invalid' ];
810  }
811 
812  // an expiry time should be in the future, not in the
813  // past (wouldn't make any sense) - bug T123069
814  if ( $expiryTime < wfTimestampNow() ) {
815  return [ 'ipb_expiry_old' ];
816  }
817 
818  if ( !isset( $data['DisableEmail'] ) ) {
819  $data['DisableEmail'] = false;
820  }
821 
822  # If the user has done the form 'properly', they won't even have been given the
823  # option to suppress-block unless they have the 'hideuser' permission
824  if ( !isset( $data['HideUser'] ) ) {
825  $data['HideUser'] = false;
826  }
827 
828  if ( $data['HideUser'] ) {
829  if ( !$performer->isAllowed( 'hideuser' ) ) {
830  # this codepath is unreachable except by a malicious user spoofing forms,
831  # or by race conditions (user has hideuser and block rights, loads block form,
832  # and loses hideuser rights before submission); so need to fail completely
833  # rather than just silently disable hiding
834  return [ 'badaccess-group0' ];
835  }
836 
837  if ( $isPartialBlock ) {
838  return [ 'ipb_hide_partial' ];
839  }
840 
841  # Recheck params here...
842  $hideUserContribLimit = $context->getConfig()->get( 'HideUserContribLimit' );
843  if ( $type != DatabaseBlock::TYPE_USER ) {
844  $data['HideUser'] = false; # IP users should not be hidden
845  } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
846  # Bad expiry.
847  return [ 'ipb_expiry_temp' ];
848  } elseif ( $hideUserContribLimit !== false
849  && $user->getEditCount() > $hideUserContribLimit
850  ) {
851  # Typically, the user should have a handful of edits.
852  # Disallow hiding users with many edits for performance.
853  return [ [ 'ipb_hide_invalid',
854  Message::numParam( $hideUserContribLimit ) ] ];
855  } elseif ( !$data['Confirm'] ) {
856  return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
857  }
858  }
859 
860  $blockAllowsUTEdit = $context->getConfig()->get( 'BlockAllowsUTEdit' );
861  $userTalkEditAllowed = !$blockAllowsUTEdit || !$data['DisableUTEdit'];
862  if ( !$userTalkEditAllowed &&
863  $isPartialBlock &&
864  !in_array( NS_USER_TALK, explode( "\n", $data['NamespaceRestrictions'] ) )
865  ) {
866  return [ 'ipb-prevent-user-talk-edit' ];
867  }
868 
869  # Create block object.
870  $block = new DatabaseBlock();
871  $block->setTarget( $target );
872  $block->setBlocker( $performer );
873  $block->setReason( $data['Reason'][0] );
874  $block->setExpiry( $expiryTime );
875  $block->isCreateAccountBlocked( $data['CreateAccount'] );
876  $block->isUsertalkEditAllowed( $userTalkEditAllowed );
877  $block->isEmailBlocked( $data['DisableEmail'] );
878  $block->isHardblock( $data['HardBlock'] );
879  $block->isAutoblocking( $data['AutoBlock'] );
880  $block->setHideName( $data['HideUser'] );
881 
882  if ( $isPartialBlock ) {
883  $block->isSitewide( false );
884  }
885 
886  $reason = [ 'hookaborted' ];
887  if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
888  return $reason;
889  }
890 
891  $pageRestrictions = [];
892  $namespaceRestrictions = [];
893  if ( $enablePartialBlocks ) {
894  if ( $data['PageRestrictions'] !== '' ) {
895  $pageRestrictions = array_map( function ( $text ) {
896  $title = Title::newFromText( $text );
897  // Use the link cache since the title has already been loaded when
898  // the field was validated.
899  $restriction = new PageRestriction( 0, $title->getArticleID() );
900  $restriction->setTitle( $title );
901  return $restriction;
902  }, explode( "\n", $data['PageRestrictions'] ) );
903  }
904  if ( $data['NamespaceRestrictions'] !== '' ) {
905  $namespaceRestrictions = array_map( function ( $id ) {
906  return new NamespaceRestriction( 0, $id );
907  }, explode( "\n", $data['NamespaceRestrictions'] ) );
908  }
909 
910  $restrictions = ( array_merge( $pageRestrictions, $namespaceRestrictions ) );
911  $block->setRestrictions( $restrictions );
912  }
913 
914  $priorBlock = null;
915  # Try to insert block. Is there a conflicting block?
916  $status = $block->insert();
917  if ( !$status ) {
918  # Indicates whether the user is confirming the block and is aware of
919  # the conflict (did not change the block target in the meantime)
920  $blockNotConfirmed = !$data['Confirm'] || ( array_key_exists( 'PreviousTarget', $data )
921  && $data['PreviousTarget'] !== $target );
922 
923  # Special case for API - T34434
924  $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
925 
926  # Show form unless the user is already aware of this...
927  if ( $blockNotConfirmed || $reblockNotAllowed ) {
928  return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
929  # Otherwise, try to update the block...
930  } else {
931  # This returns direct blocks before autoblocks/rangeblocks, since we should
932  # be sure the user is blocked by now it should work for our purposes
933  $currentBlock = DatabaseBlock::newFromTarget( $target );
934  if ( $block->equals( $currentBlock ) ) {
935  return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
936  }
937  # If the name was hidden and the blocking user cannot hide
938  # names, then don't allow any block changes...
939  if ( $currentBlock->getHideName() && !$performer->isAllowed( 'hideuser' ) ) {
940  return [ 'cant-see-hidden-user' ];
941  }
942 
943  $priorBlock = clone $currentBlock;
944  $currentBlock->isHardblock( $block->isHardblock() );
945  $currentBlock->isCreateAccountBlocked( $block->isCreateAccountBlocked() );
946  $currentBlock->setExpiry( $block->getExpiry() );
947  $currentBlock->isAutoblocking( $block->isAutoblocking() );
948  $currentBlock->setHideName( $block->getHideName() );
949  $currentBlock->isEmailBlocked( $block->isEmailBlocked() );
950  $currentBlock->isUsertalkEditAllowed( $block->isUsertalkEditAllowed() );
951  $currentBlock->setReason( $block->getReason() );
952 
953  if ( $enablePartialBlocks ) {
954  // Maintain the sitewide status. If partial blocks is not enabled,
955  // saving the block will result in a sitewide block.
956  $currentBlock->isSitewide( $block->isSitewide() );
957 
958  // Set the block id of the restrictions.
959  $blockRestrictionStore = MediaWikiServices::getInstance()->getBlockRestrictionStore();
960  $currentBlock->setRestrictions(
961  $blockRestrictionStore->setBlockId( $currentBlock->getId(), $restrictions )
962  );
963  }
964 
965  $status = $currentBlock->update();
966  // TODO handle failure
967 
968  $logaction = 'reblock';
969 
970  # Unset _deleted fields if requested
971  if ( $currentBlock->getHideName() && !$data['HideUser'] ) {
973  }
974 
975  # If hiding/unhiding a name, this should go in the private logs
976  if ( (bool)$currentBlock->getHideName() ) {
977  $data['HideUser'] = true;
978  }
979 
980  $block = $currentBlock;
981  }
982  } else {
983  $logaction = 'block';
984  }
985 
986  Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
987 
988  # Set *_deleted fields if requested
989  if ( $data['HideUser'] ) {
991  }
992 
993  # Can't watch a rangeblock
994  if ( $type != DatabaseBlock::TYPE_RANGE && $data['Watch'] ) {
997  $performer,
999  );
1000  }
1001 
1002  # DatabaseBlock constructor sanitizes certain block options on insert
1003  $data['BlockEmail'] = $block->isEmailBlocked();
1004  $data['AutoBlock'] = $block->isAutoblocking();
1005 
1006  # Prepare log parameters
1007  $logParams = [];
1008  $logParams['5::duration'] = $data['Expiry'];
1009  $logParams['6::flags'] = self::blockLogFlags( $data, $type );
1010  $logParams['sitewide'] = $block->isSitewide();
1011 
1012  if ( $enablePartialBlocks && !$block->isSitewide() ) {
1013  if ( $data['PageRestrictions'] !== '' ) {
1014  $logParams['7::restrictions']['pages'] = explode( "\n", $data['PageRestrictions'] );
1015  }
1016 
1017  if ( $data['NamespaceRestrictions'] !== '' ) {
1018  $logParams['7::restrictions']['namespaces'] = explode( "\n", $data['NamespaceRestrictions'] );
1019  }
1020  }
1021 
1022  # Make log entry, if the name is hidden, put it in the suppression log
1023  $log_type = $data['HideUser'] ? 'suppress' : 'block';
1024  $logEntry = new ManualLogEntry( $log_type, $logaction );
1025  $logEntry->setTarget( Title::makeTitle( NS_USER, $target ) );
1026  $logEntry->setComment( $data['Reason'][0] );
1027  $logEntry->setPerformer( $performer );
1028  $logEntry->setParameters( $logParams );
1029  # Relate log ID to block ID (T27763)
1030  $logEntry->setRelations( [ 'ipb_id' => $block->getId() ] );
1031  $logId = $logEntry->insert();
1032 
1033  if ( !empty( $data['Tags'] ) ) {
1034  $logEntry->setTags( $data['Tags'] );
1035  }
1036 
1037  $logEntry->publish( $logId );
1038 
1039  return true;
1040  }
1041 
1052  public static function getSuggestedDurations( Language $lang = null, $includeOther = true ) {
1053  $a = [];
1054  $msg = $lang === null
1055  ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
1056  : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
1057 
1058  if ( $msg == '-' ) {
1059  return [];
1060  }
1061 
1062  foreach ( explode( ',', $msg ) as $option ) {
1063  if ( strpos( $option, ':' ) === false ) {
1064  $option = "$option:$option";
1065  }
1066 
1067  list( $show, $value ) = explode( ':', $option );
1068  $a[$show] = $value;
1069  }
1070 
1071  if ( $a && $includeOther ) {
1072  // if options exist, add other to the end instead of the begining (which
1073  // is what happens by default).
1074  $a[ wfMessage( 'ipbother' )->text() ] = 'other';
1075  }
1076 
1077  return $a;
1078  }
1079 
1091  public static function parseExpiryInput( $expiry ) {
1092  if ( wfIsInfinity( $expiry ) ) {
1093  return 'infinity';
1094  }
1095 
1096  $expiry = strtotime( $expiry );
1097 
1098  if ( $expiry < 0 || $expiry === false ) {
1099  return false;
1100  }
1101 
1102  return wfTimestamp( TS_MW, $expiry );
1103  }
1104 
1110  public static function canBlockEmail( $user ) {
1112 
1113  return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
1114  }
1115 
1130  public static function checkUnblockSelf( $target, User $performer ) {
1131  if ( is_int( $target ) ) {
1133  } elseif ( is_string( $target ) ) {
1135  }
1136  if ( $performer->getBlock() ) {
1137  if ( $target instanceof User && $target->getId() == $performer->getId() ) {
1138  # User is trying to unblock themselves
1139  if ( $performer->isAllowed( 'unblockself' ) ) {
1140  return true;
1141  # User blocked themselves and is now trying to reverse it
1142  } elseif ( $performer->blockedBy() === $performer->getName() ) {
1143  return true;
1144  } else {
1145  return 'ipbnounblockself';
1146  }
1147  } elseif (
1148  $target instanceof User &&
1149  $performer->getBlock() instanceof DatabaseBlock &&
1150  $performer->getBlock()->getBy() &&
1151  $performer->getBlock()->getBy() === $target->getId()
1152  ) {
1153  // Allow users to block the user that blocked them.
1154  // This is to prevent a situation where a malicious user
1155  // blocks all other users. This way, the non-malicious
1156  // user can block the malicious user back, resulting
1157  // in a stalemate.
1158  return true;
1159 
1160  } else {
1161  # User is trying to block/unblock someone else
1162  return 'ipbblocked';
1163  }
1164  } else {
1165  return true;
1166  }
1167  }
1168 
1176  protected static function blockLogFlags( array $data, $type ) {
1177  $config = RequestContext::getMain()->getConfig();
1178 
1179  $blockAllowsUTEdit = $config->get( 'BlockAllowsUTEdit' );
1180 
1181  $flags = [];
1182 
1183  # when blocking a user the option 'anononly' is not available/has no effect
1184  # -> do not write this into log
1185  if ( !$data['HardBlock'] && $type != DatabaseBlock::TYPE_USER ) {
1186  // For grepping: message block-log-flags-anononly
1187  $flags[] = 'anononly';
1188  }
1189 
1190  if ( $data['CreateAccount'] ) {
1191  // For grepping: message block-log-flags-nocreate
1192  $flags[] = 'nocreate';
1193  }
1194 
1195  # Same as anononly, this is not displayed when blocking an IP address
1196  if ( !$data['AutoBlock'] && $type == DatabaseBlock::TYPE_USER ) {
1197  // For grepping: message block-log-flags-noautoblock
1198  $flags[] = 'noautoblock';
1199  }
1200 
1201  if ( $data['DisableEmail'] ) {
1202  // For grepping: message block-log-flags-noemail
1203  $flags[] = 'noemail';
1204  }
1205 
1206  if ( $blockAllowsUTEdit && $data['DisableUTEdit'] ) {
1207  // For grepping: message block-log-flags-nousertalk
1208  $flags[] = 'nousertalk';
1209  }
1210 
1211  if ( $data['HideUser'] ) {
1212  // For grepping: message block-log-flags-hiddenname
1213  $flags[] = 'hiddenname';
1214  }
1215 
1216  return implode( ',', $flags );
1217  }
1218 
1225  public function onSubmit( array $data, HTMLForm $form = null ) {
1226  // If "Editing" checkbox is unchecked, the block must be a partial block affecting
1227  // actions other than editing, and there must be no restrictions.
1228  if ( isset( $data['Editing'] ) && $data['Editing'] === false ) {
1229  $data['EditingRestriction'] = 'partial';
1230  $data['PageRestrictions'] = '';
1231  $data['NamespaceRestrictions'] = '';
1232  }
1233  return self::processForm( $data, $form->getContext() );
1234  }
1235 
1240  public function onSuccess() {
1241  $out = $this->getOutput();
1242  $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1243  $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1244  }
1245 
1254  public function prefixSearchSubpages( $search, $limit, $offset ) {
1255  $user = User::newFromName( $search );
1256  if ( !$user ) {
1257  // No prefix suggestion for invalid user
1258  return [];
1259  }
1260  // Autocomplete subpage as user list - public to allow caching
1261  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1262  }
1263 
1264  protected function getGroupName() {
1265  return 'users';
1266  }
1267 }
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.
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 rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
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:2114
getBlock( $fromReplica=true)
Get the block affecting the user, or null if the user is not blocked.
Definition: User.php:2089
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.
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 MediaWikiServices
Definition: injection.txt:23
static getTargetUserTitle( $target)
Get a user page target for things like logs.
getOutput()
Get the OutputPage being used for this instance.
A DatabaseBlock (unlike a SystemBlock) is stored in the database, may give rise to autoblocks and may...
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:1051
Special page which uses an HTMLForm to handle processing.
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:2251
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3039
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
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 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:767
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 '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:1244
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:1370
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
DatabaseBlock::TYPE_ constant.
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:3582
isSitewide( $x=null)
Indicates that the block is a sitewide block.
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.
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:823
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1335
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
setParameter( $par)
Handle some magic here.
const IGNORE_USER_RIGHTS
Definition: User.php:83
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:3642
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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
$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:83
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:620
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
$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
string null $par
The sub-page of the special page.
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:559
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
getName()
Get the name of this Special Page.
getFormFields()
Get the HTMLForm descriptor array for the block form.
getId()
Get the user&#39;s ID.
Definition: User.php:2224
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.
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:4331
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:2621
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1384
User string null $target
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo...
array $preErrors
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:535
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:801
const NS_USER_TALK
Definition: Defines.php:63
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:2621
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
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:67
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322