MediaWiki  REL1_31
SpecialBlock.php
Go to the documentation of this file.
1 <?php
33  protected $target;
34 
36  protected $type;
37 
39  protected $previousTarget;
40 
42  protected $requestedHideUser;
43 
45  protected $alreadyBlocked;
46 
48  protected $preErrors = [];
49 
50  public function __construct() {
51  parent::__construct( 'Block', 'block' );
52  }
53 
54  public function doesWrites() {
55  return true;
56  }
57 
64  protected function checkExecutePermissions( User $user ) {
65  parent::checkExecutePermissions( $user );
66 
67  # T17810: blocked admins should have limited access here
68  $status = self::checkUnblockSelf( $this->target, $user );
69  if ( $status !== true ) {
70  throw new ErrorPageError( 'badaccess', $status );
71  }
72  }
73 
79  protected function setParameter( $par ) {
80  # Extract variables from the request. Try not to get into a situation where we
81  # need to extract *every* variable from the form just for processing here, but
82  # there are legitimate uses for some variables
83  $request = $this->getRequest();
84  list( $this->target, $this->type ) = self::getTargetAndType( $par, $request );
85  if ( $this->target instanceof User ) {
86  # Set the 'relevant user' in the skin, so it displays links like Contributions,
87  # User logs, UserRights, etc.
88  $this->getSkin()->setRelevantUser( $this->target );
89  }
90 
91  list( $this->previousTarget, /*...*/ ) =
92  Block::parseTarget( $request->getVal( 'wpPreviousTarget' ) );
93  $this->requestedHideUser = $request->getBool( 'wpHideUser' );
94  }
95 
101  protected function alterForm( HTMLForm $form ) {
102  $form->setHeaderText( '' );
103  $form->setSubmitDestructive();
104 
105  $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
106  $form->setSubmitTextMsg( $msg );
107 
108  $this->addHelpLink( 'Help:Blocking users' );
109 
110  # Don't need to do anything if the form has been posted
111  if ( !$this->getRequest()->wasPosted() && $this->preErrors ) {
112  $s = $form->formatErrors( $this->preErrors );
113  if ( $s ) {
115  'div',
116  [ 'class' => 'error' ],
117  $s
118  ) );
119  }
120  }
121  }
122 
123  protected function getDisplayFormat() {
124  return 'ooui';
125  }
126 
131  protected function getFormFields() {
133 
134  $user = $this->getUser();
135 
136  $suggestedDurations = self::getSuggestedDurations();
137 
138  $conf = $this->getConfig();
139  $oldCommentSchema = $conf->get( 'CommentTableSchemaMigrationStage' ) === MIGRATION_OLD;
140 
141  $a = [
142  'Target' => [
143  'type' => 'user',
144  'ipallowed' => true,
145  'iprange' => true,
146  'label-message' => 'ipaddressorusername',
147  'id' => 'mw-bi-target',
148  'size' => '45',
149  'autofocus' => true,
150  'required' => true,
151  'validation-callback' => [ __CLASS__, 'validateTargetField' ],
152  ],
153  'Expiry' => [
154  'type' => !count( $suggestedDurations ) ? 'text' : 'selectorother',
155  'label-message' => 'ipbexpiry',
156  'required' => true,
157  'options' => $suggestedDurations,
158  'other' => $this->msg( 'ipbother' )->text(),
159  'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
160  ],
161  'Reason' => [
162  'type' => 'selectandother',
163  // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
164  // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
165  // Unicode codepoints (or 255 UTF-8 bytes for old schema).
166  'maxlength' => $oldCommentSchema ? 255 : CommentStore::COMMENT_CHARACTER_LIMIT,
167  'maxlength-unit' => 'codepoints',
168  'label-message' => 'ipbreason',
169  'options-message' => 'ipbreason-dropdown',
170  ],
171  'CreateAccount' => [
172  'type' => 'check',
173  'label-message' => 'ipbcreateaccount',
174  'default' => true,
175  ],
176  ];
177 
178  if ( self::canBlockEmail( $user ) ) {
179  $a['DisableEmail'] = [
180  'type' => 'check',
181  'label-message' => 'ipbemailban',
182  ];
183  }
184 
185  if ( $wgBlockAllowsUTEdit ) {
186  $a['DisableUTEdit'] = [
187  'type' => 'check',
188  'label-message' => 'ipb-disableusertalk',
189  'default' => false,
190  ];
191  }
192 
193  $a['AutoBlock'] = [
194  'type' => 'check',
195  'label-message' => 'ipbenableautoblock',
196  'default' => true,
197  ];
198 
199  # Allow some users to hide name from block log, blocklist and listusers
200  if ( $user->isAllowed( 'hideuser' ) ) {
201  $a['HideUser'] = [
202  'type' => 'check',
203  'label-message' => 'ipbhidename',
204  'cssclass' => 'mw-block-hideuser',
205  ];
206  }
207 
208  # Watchlist their user page? (Only if user is logged in)
209  if ( $user->isLoggedIn() ) {
210  $a['Watch'] = [
211  'type' => 'check',
212  'label-message' => 'ipbwatchuser',
213  ];
214  }
215 
216  $a['HardBlock'] = [
217  'type' => 'check',
218  'label-message' => 'ipb-hardblock',
219  'default' => false,
220  ];
221 
222  # This is basically a copy of the Target field, but the user can't change it, so we
223  # can see if the warnings we maybe showed to the user before still apply
224  $a['PreviousTarget'] = [
225  'type' => 'hidden',
226  'default' => false,
227  ];
228 
229  # We'll turn this into a checkbox if we need to
230  $a['Confirm'] = [
231  'type' => 'hidden',
232  'default' => '',
233  'label-message' => 'ipb-confirm',
234  'cssclass' => 'mw-block-confirm',
235  ];
236 
237  $this->maybeAlterFormDefaults( $a );
238 
239  // Allow extensions to add more fields
240  Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
241 
242  return $a;
243  }
244 
252  protected function maybeAlterFormDefaults( &$fields ) {
253  # This will be overwritten by request data
254  $fields['Target']['default'] = (string)$this->target;
255 
256  if ( $this->target ) {
257  $status = self::validateTarget( $this->target, $this->getUser() );
258  if ( !$status->isOK() ) {
259  $errors = $status->getErrorsArray();
260  $this->preErrors = array_merge( $this->preErrors, $errors );
261  }
262  }
263 
264  # This won't be
265  $fields['PreviousTarget']['default'] = (string)$this->target;
266 
267  $block = Block::newFromTarget( $this->target );
268 
269  if ( $block instanceof Block && !$block->mAuto # The block exists and isn't an autoblock
270  && ( $this->type != Block::TYPE_RANGE # The block isn't a rangeblock
271  || $block->getTarget() == $this->target ) # or if it is, the range is what we're about to block
272  ) {
273  $fields['HardBlock']['default'] = $block->isHardblock();
274  $fields['CreateAccount']['default'] = $block->prevents( 'createaccount' );
275  $fields['AutoBlock']['default'] = $block->isAutoblocking();
276 
277  if ( isset( $fields['DisableEmail'] ) ) {
278  $fields['DisableEmail']['default'] = $block->prevents( 'sendemail' );
279  }
280 
281  if ( isset( $fields['HideUser'] ) ) {
282  $fields['HideUser']['default'] = $block->mHideName;
283  }
284 
285  if ( isset( $fields['DisableUTEdit'] ) ) {
286  $fields['DisableUTEdit']['default'] = $block->prevents( 'editownusertalk' );
287  }
288 
289  // If the username was hidden (ipb_deleted == 1), don't show the reason
290  // unless this user also has rights to hideuser: T37839
291  if ( !$block->mHideName || $this->getUser()->isAllowed( 'hideuser' ) ) {
292  $fields['Reason']['default'] = $block->mReason;
293  } else {
294  $fields['Reason']['default'] = '';
295  }
296 
297  if ( $this->getRequest()->wasPosted() ) {
298  # Ok, so we got a POST submission asking us to reblock a user. So show the
299  # confirm checkbox; the user will only see it if they haven't previously
300  $fields['Confirm']['type'] = 'check';
301  } else {
302  # We got a target, but it wasn't a POST request, so the user must have gone
303  # to a link like [[Special:Block/User]]. We don't need to show the checkbox
304  # as long as they go ahead and block *that* user
305  $fields['Confirm']['default'] = 1;
306  }
307 
308  if ( $block->mExpiry == 'infinity' ) {
309  $fields['Expiry']['default'] = 'infinite';
310  } else {
311  $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->mExpiry );
312  }
313 
314  $this->alreadyBlocked = true;
315  $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
316  }
317 
318  # We always need confirmation to do HideUser
319  if ( $this->requestedHideUser ) {
320  $fields['Confirm']['type'] = 'check';
321  unset( $fields['Confirm']['default'] );
322  $this->preErrors[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
323  }
324 
325  # Or if the user is trying to block themselves
326  if ( (string)$this->target === $this->getUser()->getName() ) {
327  $fields['Confirm']['type'] = 'check';
328  unset( $fields['Confirm']['default'] );
329  $this->preErrors[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
330  }
331  }
332 
337  protected function preText() {
338  $this->getOutput()->addModules( [ 'mediawiki.special.block' ] );
339 
340  $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
341  $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
342 
343  $otherBlockMessages = [];
344  if ( $this->target !== null ) {
345  $targetName = $this->target;
346  if ( $this->target instanceof User ) {
347  $targetName = $this->target->getName();
348  }
349  # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
350  Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
351 
352  if ( count( $otherBlockMessages ) ) {
354  'h2',
355  [],
356  $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
357  ) . "\n";
358 
359  $list = '';
360 
361  foreach ( $otherBlockMessages as $link ) {
362  $list .= Html::rawElement( 'li', [], $link ) . "\n";
363  }
364 
365  $s .= Html::rawElement(
366  'ul',
367  [ 'class' => 'mw-blockip-alreadyblocked' ],
368  $list
369  ) . "\n";
370 
371  $text .= $s;
372  }
373  }
374 
375  return $text;
376  }
377 
382  protected function postText() {
383  $links = [];
384 
385  $this->getOutput()->addModuleStyles( 'mediawiki.special' );
386 
387  $linkRenderer = $this->getLinkRenderer();
388  # Link to the user's contributions, if applicable
389  if ( $this->target instanceof User ) {
390  $contribsPage = SpecialPage::getTitleFor( 'Contributions', $this->target->getName() );
391  $links[] = $linkRenderer->makeLink(
392  $contribsPage,
393  $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
394  );
395  }
396 
397  # Link to unblock the specified user, or to a blank unblock form
398  if ( $this->target instanceof User ) {
399  $message = $this->msg(
400  'ipb-unblock-addr',
401  wfEscapeWikiText( $this->target->getName() )
402  )->parse();
403  $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
404  } else {
405  $message = $this->msg( 'ipb-unblock' )->parse();
406  $list = SpecialPage::getTitleFor( 'Unblock' );
407  }
408  $links[] = $linkRenderer->makeKnownLink(
409  $list,
410  new HtmlArmor( $message )
411  );
412 
413  # Link to the block list
414  $links[] = $linkRenderer->makeKnownLink(
415  SpecialPage::getTitleFor( 'BlockList' ),
416  $this->msg( 'ipb-blocklist' )->text()
417  );
418 
419  $user = $this->getUser();
420 
421  # Link to edit the block dropdown reasons, if applicable
422  if ( $user->isAllowed( 'editinterface' ) ) {
423  $links[] = $linkRenderer->makeKnownLink(
424  $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
425  $this->msg( 'ipb-edit-dropdown' )->text(),
426  [],
427  [ 'action' => 'edit' ]
428  );
429  }
430 
431  $text = Html::rawElement(
432  'p',
433  [ 'class' => 'mw-ipb-conveniencelinks' ],
434  $this->getLanguage()->pipeList( $links )
435  );
436 
437  $userTitle = self::getTargetUserTitle( $this->target );
438  if ( $userTitle ) {
439  # Get relevant extracts from the block and suppression logs, if possible
440  $out = '';
441 
443  $out,
444  'block',
445  $userTitle,
446  '',
447  [
448  'lim' => 10,
449  'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
450  'showIfEmpty' => false
451  ]
452  );
453  $text .= $out;
454 
455  # Add suppression block entries if allowed
456  if ( $user->isAllowed( 'suppressionlog' ) ) {
458  $out,
459  'suppress',
460  $userTitle,
461  '',
462  [
463  'lim' => 10,
464  'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
465  'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
466  'showIfEmpty' => false
467  ]
468  );
469 
470  $text .= $out;
471  }
472  }
473 
474  return $text;
475  }
476 
483  protected static function getTargetUserTitle( $target ) {
484  if ( $target instanceof User ) {
485  return $target->getUserPage();
486  } elseif ( IP::isIPAddress( $target ) ) {
487  return Title::makeTitleSafe( NS_USER, $target );
488  }
489 
490  return null;
491  }
492 
501  public static function getTargetAndType( $par, WebRequest $request = null ) {
502  $i = 0;
503  $target = null;
504 
505  while ( true ) {
506  switch ( $i++ ) {
507  case 0:
508  # The HTMLForm will check wpTarget first and only if it doesn't get
509  # a value use the default, which will be generated from the options
510  # below; so this has to have a higher precedence here than $par, or
511  # we could end up with different values in $this->target and the HTMLForm!
512  if ( $request instanceof WebRequest ) {
513  $target = $request->getText( 'wpTarget', null );
514  }
515  break;
516  case 1:
517  $target = $par;
518  break;
519  case 2:
520  if ( $request instanceof WebRequest ) {
521  $target = $request->getText( 'ip', null );
522  }
523  break;
524  case 3:
525  # B/C @since 1.18
526  if ( $request instanceof WebRequest ) {
527  $target = $request->getText( 'wpBlockAddress', null );
528  }
529  break;
530  case 4:
531  break 2;
532  }
533 
534  list( $target, $type ) = Block::parseTarget( $target );
535 
536  if ( $type !== null ) {
537  return [ $target, $type ];
538  }
539  }
540 
541  return [ null, null ];
542  }
543 
552  public static function validateTargetField( $value, $alldata, $form ) {
553  $status = self::validateTarget( $value, $form->getUser() );
554  if ( !$status->isOK() ) {
555  $errors = $status->getErrorsArray();
556 
557  return call_user_func_array( [ $form, 'msg' ], $errors[0] );
558  } else {
559  return true;
560  }
561  }
562 
571  public static function validateTarget( $value, User $user ) {
573 
575  list( $target, $type ) = self::getTargetAndType( $value );
576  $status = Status::newGood( $target );
577 
578  if ( $type == Block::TYPE_USER ) {
579  if ( $target->isAnon() ) {
580  $status->fatal(
581  'nosuchusershort',
582  wfEscapeWikiText( $target->getName() )
583  );
584  }
585 
586  $unblockStatus = self::checkUnblockSelf( $target, $user );
587  if ( $unblockStatus !== true ) {
588  $status->fatal( 'badaccess', $unblockStatus );
589  }
590  } elseif ( $type == Block::TYPE_RANGE ) {
591  list( $ip, $range ) = explode( '/', $target, 2 );
592 
593  if (
594  ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
595  ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
596  ) {
597  // Range block effectively disabled
598  $status->fatal( 'range_block_disabled' );
599  }
600 
601  if (
602  ( IP::isIPv4( $ip ) && $range > 32 ) ||
603  ( IP::isIPv6( $ip ) && $range > 128 )
604  ) {
605  // Dodgy range
606  $status->fatal( 'ip_range_invalid' );
607  }
608 
609  if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
610  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
611  }
612 
613  if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
614  $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
615  }
616  } elseif ( $type == Block::TYPE_IP ) {
617  # All is well
618  } else {
619  $status->fatal( 'badipaddress' );
620  }
621 
622  return $status;
623  }
624 
632  public static function processForm( array $data, IContextSource $context ) {
634 
635  $performer = $context->getUser();
636 
637  // Handled by field validator callback
638  // self::validateTargetField( $data['Target'] );
639 
640  # This might have been a hidden field or a checkbox, so interesting data
641  # can come from it
642  $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
643 
645  list( $target, $type ) = self::getTargetAndType( $data['Target'] );
646  if ( $type == Block::TYPE_USER ) {
647  $user = $target;
648  $target = $user->getName();
649  $userId = $user->getId();
650 
651  # Give admins a heads-up before they go and block themselves. Much messier
652  # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
653  # permission anyway, although the code does allow for it.
654  # Note: Important to use $target instead of $data['Target']
655  # since both $data['PreviousTarget'] and $target are normalized
656  # but $data['target'] gets overridden by (non-normalized) request variable
657  # from previous request.
658  if ( $target === $performer->getName() &&
659  ( $data['PreviousTarget'] !== $target || !$data['Confirm'] )
660  ) {
661  return [ 'ipb-blockingself', 'ipb-confirmaction' ];
662  }
663  } elseif ( $type == Block::TYPE_RANGE ) {
664  $user = null;
665  $userId = 0;
666  } elseif ( $type == Block::TYPE_IP ) {
667  $user = null;
668  $target = $target->getName();
669  $userId = 0;
670  } else {
671  # This should have been caught in the form field validation
672  return [ 'badipaddress' ];
673  }
674 
675  $expiryTime = self::parseExpiryInput( $data['Expiry'] );
676 
677  if (
678  // an expiry time is needed
679  ( strlen( $data['Expiry'] ) == 0 ) ||
680  // can't be a larger string as 50 (it should be a time format in any way)
681  ( strlen( $data['Expiry'] ) > 50 ) ||
682  // check, if the time could be parsed
683  !$expiryTime
684  ) {
685  return [ 'ipb_expiry_invalid' ];
686  }
687 
688  // an expiry time should be in the future, not in the
689  // past (wouldn't make any sense) - bug T123069
690  if ( $expiryTime < wfTimestampNow() ) {
691  return [ 'ipb_expiry_old' ];
692  }
693 
694  if ( !isset( $data['DisableEmail'] ) ) {
695  $data['DisableEmail'] = false;
696  }
697 
698  # If the user has done the form 'properly', they won't even have been given the
699  # option to suppress-block unless they have the 'hideuser' permission
700  if ( !isset( $data['HideUser'] ) ) {
701  $data['HideUser'] = false;
702  }
703 
704  if ( $data['HideUser'] ) {
705  if ( !$performer->isAllowed( 'hideuser' ) ) {
706  # this codepath is unreachable except by a malicious user spoofing forms,
707  # or by race conditions (user has hideuser and block rights, loads block form,
708  # and loses hideuser rights before submission); so need to fail completely
709  # rather than just silently disable hiding
710  return [ 'badaccess-group0' ];
711  }
712 
713  # Recheck params here...
714  if ( $type != Block::TYPE_USER ) {
715  $data['HideUser'] = false; # IP users should not be hidden
716  } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
717  # Bad expiry.
718  return [ 'ipb_expiry_temp' ];
719  } elseif ( $wgHideUserContribLimit !== false
720  && $user->getEditCount() > $wgHideUserContribLimit
721  ) {
722  # Typically, the user should have a handful of edits.
723  # Disallow hiding users with many edits for performance.
724  return [ [ 'ipb_hide_invalid',
726  } elseif ( !$data['Confirm'] ) {
727  return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
728  }
729  }
730 
731  # Create block object.
732  $block = new Block();
733  $block->setTarget( $target );
734  $block->setBlocker( $performer );
735  $block->mReason = $data['Reason'][0];
736  $block->mExpiry = $expiryTime;
737  $block->prevents( 'createaccount', $data['CreateAccount'] );
738  $block->prevents( 'editownusertalk', ( !$wgBlockAllowsUTEdit || $data['DisableUTEdit'] ) );
739  $block->prevents( 'sendemail', $data['DisableEmail'] );
740  $block->isHardblock( $data['HardBlock'] );
741  $block->isAutoblocking( $data['AutoBlock'] );
742  $block->mHideName = $data['HideUser'];
743 
744  $reason = [ 'hookaborted' ];
745  if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
746  return $reason;
747  }
748 
749  $priorBlock = null;
750  # Try to insert block. Is there a conflicting block?
751  $status = $block->insert();
752  if ( !$status ) {
753  # Indicates whether the user is confirming the block and is aware of
754  # the conflict (did not change the block target in the meantime)
755  $blockNotConfirmed = !$data['Confirm'] || ( array_key_exists( 'PreviousTarget', $data )
756  && $data['PreviousTarget'] !== $target );
757 
758  # Special case for API - T34434
759  $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
760 
761  # Show form unless the user is already aware of this...
762  if ( $blockNotConfirmed || $reblockNotAllowed ) {
763  return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
764  # Otherwise, try to update the block...
765  } else {
766  # This returns direct blocks before autoblocks/rangeblocks, since we should
767  # be sure the user is blocked by now it should work for our purposes
768  $currentBlock = Block::newFromTarget( $target );
769  if ( $block->equals( $currentBlock ) ) {
770  return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
771  }
772  # If the name was hidden and the blocking user cannot hide
773  # names, then don't allow any block changes...
774  if ( $currentBlock->mHideName && !$performer->isAllowed( 'hideuser' ) ) {
775  return [ 'cant-see-hidden-user' ];
776  }
777 
778  $priorBlock = clone $currentBlock;
779  $currentBlock->isHardblock( $block->isHardblock() );
780  $currentBlock->prevents( 'createaccount', $block->prevents( 'createaccount' ) );
781  $currentBlock->mExpiry = $block->mExpiry;
782  $currentBlock->isAutoblocking( $block->isAutoblocking() );
783  $currentBlock->mHideName = $block->mHideName;
784  $currentBlock->prevents( 'sendemail', $block->prevents( 'sendemail' ) );
785  $currentBlock->prevents( 'editownusertalk', $block->prevents( 'editownusertalk' ) );
786  $currentBlock->mReason = $block->mReason;
787 
788  $status = $currentBlock->update();
789 
790  $logaction = 'reblock';
791 
792  # Unset _deleted fields if requested
793  if ( $currentBlock->mHideName && !$data['HideUser'] ) {
794  RevisionDeleteUser::unsuppressUserName( $target, $userId );
795  }
796 
797  # If hiding/unhiding a name, this should go in the private logs
798  if ( (bool)$currentBlock->mHideName ) {
799  $data['HideUser'] = true;
800  }
801  }
802  } else {
803  $logaction = 'block';
804  }
805 
806  Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
807 
808  # Set *_deleted fields if requested
809  if ( $data['HideUser'] ) {
810  RevisionDeleteUser::suppressUserName( $target, $userId );
811  }
812 
813  # Can't watch a rangeblock
814  if ( $type != Block::TYPE_RANGE && $data['Watch'] ) {
816  Title::makeTitle( NS_USER, $target ),
817  $performer,
819  );
820  }
821 
822  # Block constructor sanitizes certain block options on insert
823  $data['BlockEmail'] = $block->prevents( 'sendemail' );
824  $data['AutoBlock'] = $block->isAutoblocking();
825 
826  # Prepare log parameters
827  $logParams = [];
828  $logParams['5::duration'] = $data['Expiry'];
829  $logParams['6::flags'] = self::blockLogFlags( $data, $type );
830 
831  # Make log entry, if the name is hidden, put it in the suppression log
832  $log_type = $data['HideUser'] ? 'suppress' : 'block';
833  $logEntry = new ManualLogEntry( $log_type, $logaction );
834  $logEntry->setTarget( Title::makeTitle( NS_USER, $target ) );
835  $logEntry->setComment( $data['Reason'][0] );
836  $logEntry->setPerformer( $performer );
837  $logEntry->setParameters( $logParams );
838  # Relate log ID to block IDs (T27763)
839  $blockIds = array_merge( [ $status['id'] ], $status['autoIds'] );
840  $logEntry->setRelations( [ 'ipb_id' => $blockIds ] );
841  $logId = $logEntry->insert();
842 
843  if ( !empty( $data['Tags'] ) ) {
844  $logEntry->setTags( $data['Tags'] );
845  }
846 
847  $logEntry->publish( $logId );
848 
849  return true;
850  }
851 
860  public static function getSuggestedDurations( $lang = null ) {
861  $a = [];
862  $msg = $lang === null
863  ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
864  : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
865 
866  if ( $msg == '-' ) {
867  return [];
868  }
869 
870  foreach ( explode( ',', $msg ) as $option ) {
871  if ( strpos( $option, ':' ) === false ) {
872  $option = "$option:$option";
873  }
874 
875  list( $show, $value ) = explode( ':', $option );
876  $a[$show] = $value;
877  }
878 
879  return $a;
880  }
881 
888  public static function parseExpiryInput( $expiry ) {
889  if ( wfIsInfinity( $expiry ) ) {
890  $expiry = 'infinity';
891  } else {
892  $expiry = strtotime( $expiry );
893 
894  if ( $expiry < 0 || $expiry === false ) {
895  return false;
896  }
897 
898  $expiry = wfTimestamp( TS_MW, $expiry );
899  }
900 
901  return $expiry;
902  }
903 
909  public static function canBlockEmail( $user ) {
911 
912  return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
913  }
914 
923  public static function checkUnblockSelf( $user, User $performer ) {
924  if ( is_int( $user ) ) {
926  } elseif ( is_string( $user ) ) {
928  }
929 
930  if ( $performer->isBlocked() ) {
931  if ( $user instanceof User && $user->getId() == $performer->getId() ) {
932  # User is trying to unblock themselves
933  if ( $performer->isAllowed( 'unblockself' ) ) {
934  return true;
935  # User blocked themselves and is now trying to reverse it
936  } elseif ( $performer->blockedBy() === $performer->getName() ) {
937  return true;
938  } else {
939  return 'ipbnounblockself';
940  }
941  } else {
942  # User is trying to block/unblock someone else
943  return 'ipbblocked';
944  }
945  } else {
946  return true;
947  }
948  }
949 
957  protected static function blockLogFlags( array $data, $type ) {
959  $flags = [];
960 
961  # when blocking a user the option 'anononly' is not available/has no effect
962  # -> do not write this into log
963  if ( !$data['HardBlock'] && $type != Block::TYPE_USER ) {
964  // For grepping: message block-log-flags-anononly
965  $flags[] = 'anononly';
966  }
967 
968  if ( $data['CreateAccount'] ) {
969  // For grepping: message block-log-flags-nocreate
970  $flags[] = 'nocreate';
971  }
972 
973  # Same as anononly, this is not displayed when blocking an IP address
974  if ( !$data['AutoBlock'] && $type == Block::TYPE_USER ) {
975  // For grepping: message block-log-flags-noautoblock
976  $flags[] = 'noautoblock';
977  }
978 
979  if ( $data['DisableEmail'] ) {
980  // For grepping: message block-log-flags-noemail
981  $flags[] = 'noemail';
982  }
983 
984  if ( $wgBlockAllowsUTEdit && $data['DisableUTEdit'] ) {
985  // For grepping: message block-log-flags-nousertalk
986  $flags[] = 'nousertalk';
987  }
988 
989  if ( $data['HideUser'] ) {
990  // For grepping: message block-log-flags-hiddenname
991  $flags[] = 'hiddenname';
992  }
993 
994  return implode( ',', $flags );
995  }
996 
1003  public function onSubmit( array $data, HTMLForm $form = null ) {
1004  return self::processForm( $data, $form->getContext() );
1005  }
1006 
1011  public function onSuccess() {
1012  $out = $this->getOutput();
1013  $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1014  $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1015  }
1016 
1025  public function prefixSearchSubpages( $search, $limit, $offset ) {
1026  $user = User::newFromName( $search );
1027  if ( !$user ) {
1028  // No prefix suggestion for invalid user
1029  return [];
1030  }
1031  // Autocomplete subpage as user list - public to allow caching
1032  return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1033  }
1034 
1035  protected function getGroupName() {
1036  return 'users';
1037  }
1038 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
Message\numParam
static numParam( $num)
Definition: Message.php:1028
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
type
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 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:30
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
SpecialBlock\onSuccess
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Definition: SpecialBlock.php:1011
User\getId
getId()
Get the user's ID.
Definition: User.php:2457
$wgSysopEmailBans
$wgSysopEmailBans
Allow sysops to ban users from accessing Emailuser.
Definition: DefaultSettings.php:5007
SpecialBlock\$type
int $type
Block::TYPE_ constant.
Definition: SpecialBlock.php:36
wfMessage
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 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
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$wgBlockAllowsUTEdit
$wgBlockAllowsUTEdit
Set this to true to allow blocked users to edit their own user talk page.
Definition: DefaultSettings.php:5002
is
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
SpecialBlock\$preErrors
array $preErrors
Definition: SpecialBlock.php:48
HTMLForm\addHeaderText
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:761
Block\TYPE_IP
const TYPE_IP
Definition: Block.php:84
Block\TYPE_RANGE
const TYPE_RANGE
Definition: Block.php:85
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
SpecialBlock\$requestedHideUser
bool $requestedHideUser
Whether the previous submission of the form asked for HideUser.
Definition: SpecialBlock.php:42
SpecialBlock\processForm
static processForm(array $data, IContextSource $context)
Given the form data, actually implement a block.
Definition: SpecialBlock.php:632
string
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:181
SpecialBlock\preText
preText()
Add header elements like block log entries, etc.
Definition: SpecialBlock.php:337
SpecialBlock\canBlockEmail
static canBlockEmail( $user)
Can we do an email block?
Definition: SpecialBlock.php:909
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
HTMLForm\setHeaderText
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition: HTMLForm.php:783
HTMLForm\formatErrors
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
Definition: HTMLForm.php:1295
UserNamePrefixSearch\search
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
Definition: UserNamePrefixSearch.php:39
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
SpecialBlock\$target
User string null $target
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo...
Definition: SpecialBlock.php:33
SpecialBlock\$previousTarget
User string $previousTarget
The previous block target.
Definition: SpecialBlock.php:39
$wgEnableUserEmail
$wgEnableUserEmail
Set to true to enable user-to-user e-mail.
Definition: DefaultSettings.php:1626
IP
A collection of public static functions to play with IP address and IP ranges.
Definition: IP.php:67
SpecialBlock\onSubmit
onSubmit(array $data, HTMLForm $form=null)
Process the form on POST submission.
Definition: SpecialBlock.php:1003
Block\newFromTarget
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
Definition: Block.php:1173
FormSpecialPage
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
IP\isIPv6
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
Definition: IP.php:88
$s
$s
Definition: mergeMessageFileList.php:187
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:742
SpecialBlock\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialBlock.php:54
SpecialBlock\checkExecutePermissions
checkExecutePermissions(User $user)
Checks that the user can unblock themselves if they are trying to do so.
Definition: SpecialBlock.php:64
$linkRenderer
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:2056
SpecialPage\getName
getName()
Get the name of this Special Page.
Definition: SpecialPage.php:150
$wgHideUserContribLimit
$wgHideUserContribLimit
The maximum number of edits a user can have and can still be hidden by users with the hideuser permis...
Definition: DefaultSettings.php:5539
SpecialBlock\setParameter
setParameter( $par)
Handle some magic here.
Definition: SpecialBlock.php:79
RevisionDeleteUser\unsuppressUserName
static unsuppressUserName( $name, $userId, $dbw=null)
Definition: RevisionDeleteUser.php:205
php
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:37
SpecialBlock\postText
postText()
Add footer elements to the form.
Definition: SpecialBlock.php:382
WatchAction\doWatch
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
Definition: WatchAction.php:116
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
Block\parseTarget
static parseTarget( $target)
From an existing Block, get the target and the type of target.
Definition: Block.php:1395
SpecialBlock\maybeAlterFormDefaults
maybeAlterFormDefaults(&$fields)
If the user has already been blocked with similar settings, load that block and change the defaults f...
Definition: SpecialBlock.php:252
SpecialBlock\__construct
__construct()
Definition: SpecialBlock.php:50
SpecialBlock\alterForm
alterForm(HTMLForm $form)
Customizes the HTMLForm a bit.
Definition: SpecialBlock.php:101
SpecialBlock
A special page that allows users with 'block' right to block users from editing pages and other actio...
Definition: SpecialBlock.php:30
SpecialBlock\getTargetUserTitle
static getTargetUserTitle( $target)
Get a user page target for things like logs.
Definition: SpecialBlock.php:483
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
LogEventsList\showLogExtract
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Definition: LogEventsList.php:616
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2009
list
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
SpecialBlock\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialBlock.php:1025
MIGRATION_OLD
const MIGRATION_OLD
Definition: Defines.php:302
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
it
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
Definition: contenthandler.txt:104
$expiryTime
$expiryTime
Definition: opensearch_desc.php:42
$value
$value
Definition: styleTest.css.php:45
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
FormSpecialPage\$par
string $par
The sub-page of the special page.
Definition: FormSpecialPage.php:36
SpecialBlock\getSuggestedDurations
static getSuggestedDurations( $lang=null)
Get an array of suggested block durations from MediaWiki:Ipboptions.
Definition: SpecialBlock.php:860
wfIsInfinity
wfIsInfinity( $str)
Determine input string is represents as infinity.
Definition: GlobalFunctions.php:3321
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
and
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
SpecialBlock\getFormFields
getFormFields()
Get the HTMLForm descriptor array for the block form.
Definition: SpecialBlock.php:131
$status
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. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
User\blockedBy
blockedBy()
If user is blocked, return the name of the user who placed the block.
Definition: User.php:2343
HTMLForm\setSubmitDestructive
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
Definition: HTMLForm.php:1330
IP\isIPv4
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:99
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
Block\TYPE_USER
const TYPE_USER
Definition: Block.php:83
CommentStore\COMMENT_CHARACTER_LIMIT
const COMMENT_CHARACTER_LIMIT
Maximum length of a comment in UTF-8 characters.
Definition: CommentStore.php:37
HTMLForm\setSubmitTextMsg
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1356
block
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters block
Definition: hooks.txt:2198
$wgBlockCIDRLimit
$wgBlockCIDRLimit
Limits on the possible sizes of range blocks.
Definition: DefaultSettings.php:5023
SpecialBlock\validateTargetField
static validateTargetField( $value, $alldata, $form)
HTMLForm field validation-callback for Target field.
Definition: SpecialBlock.php:552
SpecialBlock\$alreadyBlocked
bool $alreadyBlocked
Definition: SpecialBlock.php:45
or
or
Definition: APACHE-LICENSE-2.0.txt:114
SpecialBlock\validateTarget
static validateTarget( $value, User $user)
Validate a block target.
Definition: SpecialBlock.php:571
as
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:22
Block
Definition: Block.php:27
SpecialBlock\getDisplayFormat
getDisplayFormat()
Get display format for the form.
Definition: SpecialBlock.php:123
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
SpecialBlock\parseExpiryInput
static parseExpiryInput( $expiry)
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034",...
Definition: SpecialBlock.php:888
SpecialBlock\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialBlock.php:1035
SpecialBlock\checkUnblockSelf
static checkUnblockSelf( $user, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to ...
Definition: SpecialBlock.php:923
NS_USER
const NS_USER
Definition: Defines.php:76
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:432
SpecialBlock\getTargetAndType
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
Definition: SpecialBlock.php:501
User\IGNORE_USER_RIGHTS
const IGNORE_USER_RIGHTS
Definition: User.php:90
$request
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:2806
SpecialBlock\blockLogFlags
static blockLogFlags(array $data, $type)
Return a comma-delimited list of "flags" to be passed to the log reader for this block,...
Definition: SpecialBlock.php:957
User\isBlocked
isBlocked( $bFromSlave=true)
Check if user is blocked.
Definition: User.php:2300
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
User\getName
getName()
Get the user name, or the IP of an anonymous user.
Definition: User.php:2482
$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:2811
IP\isIPAddress
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
RevisionDeleteUser\suppressUserName
static suppressUserName( $name, $userId, $dbw=null)
Definition: RevisionDeleteUser.php:201
User\isAllowed
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition: User.php:3841
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130
$type
$type
Definition: testCompression.php:48