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