MediaWiki REL1_30
SpecialBlock.php
Go to the documentation of this file.
1<?php
33 protected $target;
34
36 protected $type;
37
39 protected $previousTarget;
40
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->setWrapperLegendMsg( 'blockip-legend' );
103 $form->setHeaderText( '' );
104 $form->setSubmitDestructive();
105
106 $msg = $this->alreadyBlocked ? 'ipb-change-block' : 'ipbsubmit';
107 $form->setSubmitTextMsg( $msg );
108
109 $this->addHelpLink( 'Help:Blocking users' );
110
111 # Don't need to do anything if the form has been posted
112 if ( !$this->getRequest()->wasPosted() && $this->preErrors ) {
113 $s = $form->formatErrors( $this->preErrors );
114 if ( $s ) {
115 $form->addHeaderText( Html::rawElement(
116 'div',
117 [ 'class' => 'error' ],
118 $s
119 ) );
120 }
121 }
122 }
123
128 protected function getFormFields() {
130
131 $user = $this->getUser();
132
133 $suggestedDurations = self::getSuggestedDurations();
134
135 $a = [
136 'Target' => [
137 'type' => 'text',
138 'label-message' => 'ipaddressorusername',
139 'id' => 'mw-bi-target',
140 'size' => '45',
141 'autofocus' => true,
142 'required' => true,
143 'validation-callback' => [ __CLASS__, 'validateTargetField' ],
144 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
145 ],
146 'Expiry' => [
147 'type' => !count( $suggestedDurations ) ? 'text' : 'selectorother',
148 'label-message' => 'ipbexpiry',
149 'required' => true,
150 'options' => $suggestedDurations,
151 'other' => $this->msg( 'ipbother' )->text(),
152 'default' => $this->msg( 'ipb-default-expiry' )->inContentLanguage()->text(),
153 ],
154 'Reason' => [
155 'type' => 'selectandother',
156 'maxlength' => 255,
157 'label-message' => 'ipbreason',
158 'options-message' => 'ipbreason-dropdown',
159 ],
160 'CreateAccount' => [
161 'type' => 'check',
162 'label-message' => 'ipbcreateaccount',
163 'default' => true,
164 ],
165 ];
166
167 if ( self::canBlockEmail( $user ) ) {
168 $a['DisableEmail'] = [
169 'type' => 'check',
170 'label-message' => 'ipbemailban',
171 ];
172 }
173
174 if ( $wgBlockAllowsUTEdit ) {
175 $a['DisableUTEdit'] = [
176 'type' => 'check',
177 'label-message' => 'ipb-disableusertalk',
178 'default' => false,
179 ];
180 }
181
182 $a['AutoBlock'] = [
183 'type' => 'check',
184 'label-message' => 'ipbenableautoblock',
185 'default' => true,
186 ];
187
188 # Allow some users to hide name from block log, blocklist and listusers
189 if ( $user->isAllowed( 'hideuser' ) ) {
190 $a['HideUser'] = [
191 'type' => 'check',
192 'label-message' => 'ipbhidename',
193 'cssclass' => 'mw-block-hideuser',
194 ];
195 }
196
197 # Watchlist their user page? (Only if user is logged in)
198 if ( $user->isLoggedIn() ) {
199 $a['Watch'] = [
200 'type' => 'check',
201 'label-message' => 'ipbwatchuser',
202 ];
203 }
204
205 $a['HardBlock'] = [
206 'type' => 'check',
207 'label-message' => 'ipb-hardblock',
208 'default' => false,
209 ];
210
211 # This is basically a copy of the Target field, but the user can't change it, so we
212 # can see if the warnings we maybe showed to the user before still apply
213 $a['PreviousTarget'] = [
214 'type' => 'hidden',
215 'default' => false,
216 ];
217
218 # We'll turn this into a checkbox if we need to
219 $a['Confirm'] = [
220 'type' => 'hidden',
221 'default' => '',
222 'label-message' => 'ipb-confirm',
223 ];
224
225 $this->maybeAlterFormDefaults( $a );
226
227 // Allow extensions to add more fields
228 Hooks::run( 'SpecialBlockModifyFormFields', [ $this, &$a ] );
229
230 return $a;
231 }
232
240 protected function maybeAlterFormDefaults( &$fields ) {
241 # This will be overwritten by request data
242 $fields['Target']['default'] = (string)$this->target;
243
244 if ( $this->target ) {
245 $status = self::validateTarget( $this->target, $this->getUser() );
246 if ( !$status->isOK() ) {
247 $errors = $status->getErrorsArray();
248 $this->preErrors = array_merge( $this->preErrors, $errors );
249 }
250 }
251
252 # This won't be
253 $fields['PreviousTarget']['default'] = (string)$this->target;
254
255 $block = Block::newFromTarget( $this->target );
256
257 if ( $block instanceof Block && !$block->mAuto # The block exists and isn't an autoblock
258 && ( $this->type != Block::TYPE_RANGE # The block isn't a rangeblock
259 || $block->getTarget() == $this->target ) # or if it is, the range is what we're about to block
260 ) {
261 $fields['HardBlock']['default'] = $block->isHardblock();
262 $fields['CreateAccount']['default'] = $block->prevents( 'createaccount' );
263 $fields['AutoBlock']['default'] = $block->isAutoblocking();
264
265 if ( isset( $fields['DisableEmail'] ) ) {
266 $fields['DisableEmail']['default'] = $block->prevents( 'sendemail' );
267 }
268
269 if ( isset( $fields['HideUser'] ) ) {
270 $fields['HideUser']['default'] = $block->mHideName;
271 }
272
273 if ( isset( $fields['DisableUTEdit'] ) ) {
274 $fields['DisableUTEdit']['default'] = $block->prevents( 'editownusertalk' );
275 }
276
277 // If the username was hidden (ipb_deleted == 1), don't show the reason
278 // unless this user also has rights to hideuser: T37839
279 if ( !$block->mHideName || $this->getUser()->isAllowed( 'hideuser' ) ) {
280 $fields['Reason']['default'] = $block->mReason;
281 } else {
282 $fields['Reason']['default'] = '';
283 }
284
285 if ( $this->getRequest()->wasPosted() ) {
286 # Ok, so we got a POST submission asking us to reblock a user. So show the
287 # confirm checkbox; the user will only see it if they haven't previously
288 $fields['Confirm']['type'] = 'check';
289 } else {
290 # We got a target, but it wasn't a POST request, so the user must have gone
291 # to a link like [[Special:Block/User]]. We don't need to show the checkbox
292 # as long as they go ahead and block *that* user
293 $fields['Confirm']['default'] = 1;
294 }
295
296 if ( $block->mExpiry == 'infinity' ) {
297 $fields['Expiry']['default'] = 'infinite';
298 } else {
299 $fields['Expiry']['default'] = wfTimestamp( TS_RFC2822, $block->mExpiry );
300 }
301
302 $this->alreadyBlocked = true;
303 $this->preErrors[] = [ 'ipb-needreblock', wfEscapeWikiText( (string)$block->getTarget() ) ];
304 }
305
306 # We always need confirmation to do HideUser
307 if ( $this->requestedHideUser ) {
308 $fields['Confirm']['type'] = 'check';
309 unset( $fields['Confirm']['default'] );
310 $this->preErrors[] = [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
311 }
312
313 # Or if the user is trying to block themselves
314 if ( (string)$this->target === $this->getUser()->getName() ) {
315 $fields['Confirm']['type'] = 'check';
316 unset( $fields['Confirm']['default'] );
317 $this->preErrors[] = [ 'ipb-blockingself', 'ipb-confirmaction' ];
318 }
319 }
320
325 protected function preText() {
326 $this->getOutput()->addModules( [ 'mediawiki.special.block', 'mediawiki.userSuggest' ] );
327
328 $blockCIDRLimit = $this->getConfig()->get( 'BlockCIDRLimit' );
329 $text = $this->msg( 'blockiptext', $blockCIDRLimit['IPv4'], $blockCIDRLimit['IPv6'] )->parse();
330
331 $otherBlockMessages = [];
332 if ( $this->target !== null ) {
333 $targetName = $this->target;
334 if ( $this->target instanceof User ) {
335 $targetName = $this->target->getName();
336 }
337 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
338 Hooks::run( 'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
339
340 if ( count( $otherBlockMessages ) ) {
341 $s = Html::rawElement(
342 'h2',
343 [],
344 $this->msg( 'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
345 ) . "\n";
346
347 $list = '';
348
349 foreach ( $otherBlockMessages as $link ) {
350 $list .= Html::rawElement( 'li', [], $link ) . "\n";
351 }
352
353 $s .= Html::rawElement(
354 'ul',
355 [ 'class' => 'mw-blockip-alreadyblocked' ],
356 $list
357 ) . "\n";
358
359 $text .= $s;
360 }
361 }
362
363 return $text;
364 }
365
370 protected function postText() {
371 $links = [];
372
373 $this->getOutput()->addModuleStyles( 'mediawiki.special' );
374
375 $linkRenderer = $this->getLinkRenderer();
376 # Link to the user's contributions, if applicable
377 if ( $this->target instanceof User ) {
378 $contribsPage = SpecialPage::getTitleFor( 'Contributions', $this->target->getName() );
379 $links[] = $linkRenderer->makeLink(
380 $contribsPage,
381 $this->msg( 'ipb-blocklist-contribs', $this->target->getName() )->text()
382 );
383 }
384
385 # Link to unblock the specified user, or to a blank unblock form
386 if ( $this->target instanceof User ) {
387 $message = $this->msg(
388 'ipb-unblock-addr',
389 wfEscapeWikiText( $this->target->getName() )
390 )->parse();
391 $list = SpecialPage::getTitleFor( 'Unblock', $this->target->getName() );
392 } else {
393 $message = $this->msg( 'ipb-unblock' )->parse();
394 $list = SpecialPage::getTitleFor( 'Unblock' );
395 }
396 $links[] = $linkRenderer->makeKnownLink(
397 $list,
398 new HtmlArmor( $message )
399 );
400
401 # Link to the block list
402 $links[] = $linkRenderer->makeKnownLink(
403 SpecialPage::getTitleFor( 'BlockList' ),
404 $this->msg( 'ipb-blocklist' )->text()
405 );
406
407 $user = $this->getUser();
408
409 # Link to edit the block dropdown reasons, if applicable
410 if ( $user->isAllowed( 'editinterface' ) ) {
411 $links[] = $linkRenderer->makeKnownLink(
412 $this->msg( 'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
413 $this->msg( 'ipb-edit-dropdown' )->text(),
414 [],
415 [ 'action' => 'edit' ]
416 );
417 }
418
419 $text = Html::rawElement(
420 'p',
421 [ 'class' => 'mw-ipb-conveniencelinks' ],
422 $this->getLanguage()->pipeList( $links )
423 );
424
425 $userTitle = self::getTargetUserTitle( $this->target );
426 if ( $userTitle ) {
427 # Get relevant extracts from the block and suppression logs, if possible
428 $out = '';
429
431 $out,
432 'block',
433 $userTitle,
434 '',
435 [
436 'lim' => 10,
437 'msgKey' => [ 'blocklog-showlog', $userTitle->getText() ],
438 'showIfEmpty' => false
439 ]
440 );
441 $text .= $out;
442
443 # Add suppression block entries if allowed
444 if ( $user->isAllowed( 'suppressionlog' ) ) {
446 $out,
447 'suppress',
448 $userTitle,
449 '',
450 [
451 'lim' => 10,
452 'conds' => [ 'log_action' => [ 'block', 'reblock', 'unblock' ] ],
453 'msgKey' => [ 'blocklog-showsuppresslog', $userTitle->getText() ],
454 'showIfEmpty' => false
455 ]
456 );
457
458 $text .= $out;
459 }
460 }
461
462 return $text;
463 }
464
471 protected static function getTargetUserTitle( $target ) {
472 if ( $target instanceof User ) {
473 return $target->getUserPage();
474 } elseif ( IP::isIPAddress( $target ) ) {
475 return Title::makeTitleSafe( NS_USER, $target );
476 }
477
478 return null;
479 }
480
489 public static function getTargetAndType( $par, WebRequest $request = null ) {
490 $i = 0;
491 $target = null;
492
493 while ( true ) {
494 switch ( $i++ ) {
495 case 0:
496 # The HTMLForm will check wpTarget first and only if it doesn't get
497 # a value use the default, which will be generated from the options
498 # below; so this has to have a higher precedence here than $par, or
499 # we could end up with different values in $this->target and the HTMLForm!
500 if ( $request instanceof WebRequest ) {
501 $target = $request->getText( 'wpTarget', null );
502 }
503 break;
504 case 1:
505 $target = $par;
506 break;
507 case 2:
508 if ( $request instanceof WebRequest ) {
509 $target = $request->getText( 'ip', null );
510 }
511 break;
512 case 3:
513 # B/C @since 1.18
514 if ( $request instanceof WebRequest ) {
515 $target = $request->getText( 'wpBlockAddress', null );
516 }
517 break;
518 case 4:
519 break 2;
520 }
521
522 list( $target, $type ) = Block::parseTarget( $target );
523
524 if ( $type !== null ) {
525 return [ $target, $type ];
526 }
527 }
528
529 return [ null, null ];
530 }
531
540 public static function validateTargetField( $value, $alldata, $form ) {
541 $status = self::validateTarget( $value, $form->getUser() );
542 if ( !$status->isOK() ) {
543 $errors = $status->getErrorsArray();
544
545 return call_user_func_array( [ $form, 'msg' ], $errors[0] );
546 } else {
547 return true;
548 }
549 }
550
559 public static function validateTarget( $value, User $user ) {
561
563 list( $target, $type ) = self::getTargetAndType( $value );
564 $status = Status::newGood( $target );
565
566 if ( $type == Block::TYPE_USER ) {
567 if ( $target->isAnon() ) {
568 $status->fatal(
569 'nosuchusershort',
570 wfEscapeWikiText( $target->getName() )
571 );
572 }
573
574 $unblockStatus = self::checkUnblockSelf( $target, $user );
575 if ( $unblockStatus !== true ) {
576 $status->fatal( 'badaccess', $unblockStatus );
577 }
578 } elseif ( $type == Block::TYPE_RANGE ) {
579 list( $ip, $range ) = explode( '/', $target, 2 );
580
581 if (
582 ( IP::isIPv4( $ip ) && $wgBlockCIDRLimit['IPv4'] == 32 ) ||
583 ( IP::isIPv6( $ip ) && $wgBlockCIDRLimit['IPv6'] == 128 )
584 ) {
585 // Range block effectively disabled
586 $status->fatal( 'range_block_disabled' );
587 }
588
589 if (
590 ( IP::isIPv4( $ip ) && $range > 32 ) ||
591 ( IP::isIPv6( $ip ) && $range > 128 )
592 ) {
593 // Dodgy range
594 $status->fatal( 'ip_range_invalid' );
595 }
596
597 if ( IP::isIPv4( $ip ) && $range < $wgBlockCIDRLimit['IPv4'] ) {
598 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv4'] );
599 }
600
601 if ( IP::isIPv6( $ip ) && $range < $wgBlockCIDRLimit['IPv6'] ) {
602 $status->fatal( 'ip_range_toolarge', $wgBlockCIDRLimit['IPv6'] );
603 }
604 } elseif ( $type == Block::TYPE_IP ) {
605 # All is well
606 } else {
607 $status->fatal( 'badipaddress' );
608 }
609
610 return $status;
611 }
612
620 public static function processForm( array $data, IContextSource $context ) {
622
623 $performer = $context->getUser();
624
625 // Handled by field validator callback
626 // self::validateTargetField( $data['Target'] );
627
628 # This might have been a hidden field or a checkbox, so interesting data
629 # can come from it
630 $data['Confirm'] = !in_array( $data['Confirm'], [ '', '0', null, false ], true );
631
633 list( $target, $type ) = self::getTargetAndType( $data['Target'] );
634 if ( $type == Block::TYPE_USER ) {
635 $user = $target;
636 $target = $user->getName();
637 $userId = $user->getId();
638
639 # Give admins a heads-up before they go and block themselves. Much messier
640 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
641 # permission anyway, although the code does allow for it.
642 # Note: Important to use $target instead of $data['Target']
643 # since both $data['PreviousTarget'] and $target are normalized
644 # but $data['target'] gets overridden by (non-normalized) request variable
645 # from previous request.
646 if ( $target === $performer->getName() &&
647 ( $data['PreviousTarget'] !== $target || !$data['Confirm'] )
648 ) {
649 return [ 'ipb-blockingself', 'ipb-confirmaction' ];
650 }
651 } elseif ( $type == Block::TYPE_RANGE ) {
652 $user = null;
653 $userId = 0;
654 } elseif ( $type == Block::TYPE_IP ) {
655 $user = null;
656 $target = $target->getName();
657 $userId = 0;
658 } else {
659 # This should have been caught in the form field validation
660 return [ 'badipaddress' ];
661 }
662
663 $expiryTime = self::parseExpiryInput( $data['Expiry'] );
664
665 if (
666 // an expiry time is needed
667 ( strlen( $data['Expiry'] ) == 0 ) ||
668 // can't be a larger string as 50 (it should be a time format in any way)
669 ( strlen( $data['Expiry'] ) > 50 ) ||
670 // check, if the time could be parsed
672 ) {
673 return [ 'ipb_expiry_invalid' ];
674 }
675
676 // an expiry time should be in the future, not in the
677 // past (wouldn't make any sense) - bug T123069
678 if ( $expiryTime < wfTimestampNow() ) {
679 return [ 'ipb_expiry_old' ];
680 }
681
682 if ( !isset( $data['DisableEmail'] ) ) {
683 $data['DisableEmail'] = false;
684 }
685
686 # If the user has done the form 'properly', they won't even have been given the
687 # option to suppress-block unless they have the 'hideuser' permission
688 if ( !isset( $data['HideUser'] ) ) {
689 $data['HideUser'] = false;
690 }
691
692 if ( $data['HideUser'] ) {
693 if ( !$performer->isAllowed( 'hideuser' ) ) {
694 # this codepath is unreachable except by a malicious user spoofing forms,
695 # or by race conditions (user has hideuser and block rights, loads block form,
696 # and loses hideuser rights before submission); so need to fail completely
697 # rather than just silently disable hiding
698 return [ 'badaccess-group0' ];
699 }
700
701 # Recheck params here...
702 if ( $type != Block::TYPE_USER ) {
703 $data['HideUser'] = false; # IP users should not be hidden
704 } elseif ( !wfIsInfinity( $data['Expiry'] ) ) {
705 # Bad expiry.
706 return [ 'ipb_expiry_temp' ];
707 } elseif ( $wgHideUserContribLimit !== false
708 && $user->getEditCount() > $wgHideUserContribLimit
709 ) {
710 # Typically, the user should have a handful of edits.
711 # Disallow hiding users with many edits for performance.
712 return [ [ 'ipb_hide_invalid',
713 Message::numParam( $wgHideUserContribLimit ) ] ];
714 } elseif ( !$data['Confirm'] ) {
715 return [ 'ipb-confirmhideuser', 'ipb-confirmaction' ];
716 }
717 }
718
719 # Create block object.
720 $block = new Block();
721 $block->setTarget( $target );
722 $block->setBlocker( $performer );
723 $block->mReason = $data['Reason'][0];
724 $block->mExpiry = $expiryTime;
725 $block->prevents( 'createaccount', $data['CreateAccount'] );
726 $block->prevents( 'editownusertalk', ( !$wgBlockAllowsUTEdit || $data['DisableUTEdit'] ) );
727 $block->prevents( 'sendemail', $data['DisableEmail'] );
728 $block->isHardblock( $data['HardBlock'] );
729 $block->isAutoblocking( $data['AutoBlock'] );
730 $block->mHideName = $data['HideUser'];
731
732 $reason = [ 'hookaborted' ];
733 if ( !Hooks::run( 'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
734 return $reason;
735 }
736
737 $priorBlock = null;
738 # Try to insert block. Is there a conflicting block?
739 $status = $block->insert();
740 if ( !$status ) {
741 # Indicates whether the user is confirming the block and is aware of
742 # the conflict (did not change the block target in the meantime)
743 $blockNotConfirmed = !$data['Confirm'] || ( array_key_exists( 'PreviousTarget', $data )
744 && $data['PreviousTarget'] !== $target );
745
746 # Special case for API - T34434
747 $reblockNotAllowed = ( array_key_exists( 'Reblock', $data ) && !$data['Reblock'] );
748
749 # Show form unless the user is already aware of this...
750 if ( $blockNotConfirmed || $reblockNotAllowed ) {
751 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
752 # Otherwise, try to update the block...
753 } else {
754 # This returns direct blocks before autoblocks/rangeblocks, since we should
755 # be sure the user is blocked by now it should work for our purposes
756 $currentBlock = Block::newFromTarget( $target );
757 if ( $block->equals( $currentBlock ) ) {
758 return [ [ 'ipb_already_blocked', $block->getTarget() ] ];
759 }
760 # If the name was hidden and the blocking user cannot hide
761 # names, then don't allow any block changes...
762 if ( $currentBlock->mHideName && !$performer->isAllowed( 'hideuser' ) ) {
763 return [ 'cant-see-hidden-user' ];
764 }
765
766 $priorBlock = clone $currentBlock;
767 $currentBlock->isHardblock( $block->isHardblock() );
768 $currentBlock->prevents( 'createaccount', $block->prevents( 'createaccount' ) );
769 $currentBlock->mExpiry = $block->mExpiry;
770 $currentBlock->isAutoblocking( $block->isAutoblocking() );
771 $currentBlock->mHideName = $block->mHideName;
772 $currentBlock->prevents( 'sendemail', $block->prevents( 'sendemail' ) );
773 $currentBlock->prevents( 'editownusertalk', $block->prevents( 'editownusertalk' ) );
774 $currentBlock->mReason = $block->mReason;
775
776 $status = $currentBlock->update();
777
778 $logaction = 'reblock';
779
780 # Unset _deleted fields if requested
781 if ( $currentBlock->mHideName && !$data['HideUser'] ) {
782 RevisionDeleteUser::unsuppressUserName( $target, $userId );
783 }
784
785 # If hiding/unhiding a name, this should go in the private logs
786 if ( (bool)$currentBlock->mHideName ) {
787 $data['HideUser'] = true;
788 }
789 }
790 } else {
791 $logaction = 'block';
792 }
793
794 Hooks::run( 'BlockIpComplete', [ $block, $performer, $priorBlock ] );
795
796 # Set *_deleted fields if requested
797 if ( $data['HideUser'] ) {
798 RevisionDeleteUser::suppressUserName( $target, $userId );
799 }
800
801 # Can't watch a rangeblock
802 if ( $type != Block::TYPE_RANGE && $data['Watch'] ) {
804 Title::makeTitle( NS_USER, $target ),
805 $performer,
806 User::IGNORE_USER_RIGHTS
807 );
808 }
809
810 # Block constructor sanitizes certain block options on insert
811 $data['BlockEmail'] = $block->prevents( 'sendemail' );
812 $data['AutoBlock'] = $block->isAutoblocking();
813
814 # Prepare log parameters
815 $logParams = [];
816 $logParams['5::duration'] = $data['Expiry'];
817 $logParams['6::flags'] = self::blockLogFlags( $data, $type );
818
819 # Make log entry, if the name is hidden, put it in the suppression log
820 $log_type = $data['HideUser'] ? 'suppress' : 'block';
821 $logEntry = new ManualLogEntry( $log_type, $logaction );
822 $logEntry->setTarget( Title::makeTitle( NS_USER, $target ) );
823 $logEntry->setComment( $data['Reason'][0] );
824 $logEntry->setPerformer( $performer );
825 $logEntry->setParameters( $logParams );
826 # Relate log ID to block IDs (T27763)
827 $blockIds = array_merge( [ $status['id'] ], $status['autoIds'] );
828 $logEntry->setRelations( [ 'ipb_id' => $blockIds ] );
829 $logId = $logEntry->insert();
830
831 if ( !empty( $data['Tags'] ) ) {
832 $logEntry->setTags( $data['Tags'] );
833 }
834
835 $logEntry->publish( $logId );
836
837 return true;
838 }
839
848 public static function getSuggestedDurations( $lang = null ) {
849 $a = [];
850 $msg = $lang === null
851 ? wfMessage( 'ipboptions' )->inContentLanguage()->text()
852 : wfMessage( 'ipboptions' )->inLanguage( $lang )->text();
853
854 if ( $msg == '-' ) {
855 return [];
856 }
857
858 foreach ( explode( ',', $msg ) as $option ) {
859 if ( strpos( $option, ':' ) === false ) {
860 $option = "$option:$option";
861 }
862
863 list( $show, $value ) = explode( ':', $option );
864 $a[$show] = $value;
865 }
866
867 return $a;
868 }
869
876 public static function parseExpiryInput( $expiry ) {
877 if ( wfIsInfinity( $expiry ) ) {
878 $expiry = 'infinity';
879 } else {
880 $expiry = strtotime( $expiry );
881
882 if ( $expiry < 0 || $expiry === false ) {
883 return false;
884 }
885
886 $expiry = wfTimestamp( TS_MW, $expiry );
887 }
888
889 return $expiry;
890 }
891
897 public static function canBlockEmail( $user ) {
899
900 return ( $wgEnableUserEmail && $wgSysopEmailBans && $user->isAllowed( 'blockemail' ) );
901 }
902
911 public static function checkUnblockSelf( $user, User $performer ) {
912 if ( is_int( $user ) ) {
913 $user = User::newFromId( $user );
914 } elseif ( is_string( $user ) ) {
915 $user = User::newFromName( $user );
916 }
917
918 if ( $performer->isBlocked() ) {
919 if ( $user instanceof User && $user->getId() == $performer->getId() ) {
920 # User is trying to unblock themselves
921 if ( $performer->isAllowed( 'unblockself' ) ) {
922 return true;
923 # User blocked themselves and is now trying to reverse it
924 } elseif ( $performer->blockedBy() === $performer->getName() ) {
925 return true;
926 } else {
927 return 'ipbnounblockself';
928 }
929 } else {
930 # User is trying to block/unblock someone else
931 return 'ipbblocked';
932 }
933 } else {
934 return true;
935 }
936 }
937
945 protected static function blockLogFlags( array $data, $type ) {
947 $flags = [];
948
949 # when blocking a user the option 'anononly' is not available/has no effect
950 # -> do not write this into log
951 if ( !$data['HardBlock'] && $type != Block::TYPE_USER ) {
952 // For grepping: message block-log-flags-anononly
953 $flags[] = 'anononly';
954 }
955
956 if ( $data['CreateAccount'] ) {
957 // For grepping: message block-log-flags-nocreate
958 $flags[] = 'nocreate';
959 }
960
961 # Same as anononly, this is not displayed when blocking an IP address
962 if ( !$data['AutoBlock'] && $type == Block::TYPE_USER ) {
963 // For grepping: message block-log-flags-noautoblock
964 $flags[] = 'noautoblock';
965 }
966
967 if ( $data['DisableEmail'] ) {
968 // For grepping: message block-log-flags-noemail
969 $flags[] = 'noemail';
970 }
971
972 if ( $wgBlockAllowsUTEdit && $data['DisableUTEdit'] ) {
973 // For grepping: message block-log-flags-nousertalk
974 $flags[] = 'nousertalk';
975 }
976
977 if ( $data['HideUser'] ) {
978 // For grepping: message block-log-flags-hiddenname
979 $flags[] = 'hiddenname';
980 }
981
982 return implode( ',', $flags );
983 }
984
991 public function onSubmit( array $data, HTMLForm $form = null ) {
992 return self::processForm( $data, $form->getContext() );
993 }
994
999 public function onSuccess() {
1000 $out = $this->getOutput();
1001 $out->setPageTitle( $this->msg( 'blockipsuccesssub' ) );
1002 $out->addWikiMsg( 'blockipsuccesstext', wfEscapeWikiText( $this->target ) );
1003 }
1004
1013 public function prefixSearchSubpages( $search, $limit, $offset ) {
1014 $user = User::newFromName( $search );
1015 if ( !$user ) {
1016 // No prefix suggestion for invalid user
1017 return [];
1018 }
1019 // Autocomplete subpage as user list - public to allow caching
1020 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
1021 }
1022
1023 protected function getGroupName() {
1024 return 'users';
1025 }
1026}
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
$wgBlockCIDRLimit
Limits on the possible sizes of range blocks.
$wgEnableUserEmail
Set to true to enable user-to-user e-mail.
$wgBlockAllowsUTEdit
Set this to true to allow blocked users to edit their own user talk page.
$wgHideUserContribLimit
The maximum number of edits a user can have and can still be hidden by users with the hideuser permis...
$wgSysopEmailBans
Allow sysops to ban users from accessing Emailuser.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfIsInfinity( $str)
Determine input string is represents as infinity.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
static parseTarget( $target)
From an existing Block, get the target and the type of target.
Definition Block.php:1334
const TYPE_RANGE
Definition Block.php:85
const TYPE_USER
Definition Block.php:83
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:1112
const TYPE_IP
Definition Block.php:84
An error page which can definitely be safely rendered using the OutputPage.
Special page which uses an HTMLForm to handle processing.
string $par
The sub-page of the special page.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:128
setHeaderText( $msg, $section=null)
Set header text, inside the form.
Definition HTMLForm.php:792
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
setWrapperLegendMsg( $msg)
Prompt the whole form to be wrapped in a "<fieldset>", with this message as its "<legend>" element.
formatErrors( $errors)
Format a stack of error messages into a single HTML string.
setSubmitDestructive()
Identify that the submit button in the form has a destructive action.
addHeaderText( $msg, $section=null)
Add HTML to the header, inside the form.
Definition HTMLForm.php:770
Marks HTML that shouldn't be escaped.
Definition HtmlArmor.php:28
A collection of public static functions to play with IP address and IP ranges.
Definition IP.php:67
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Class for creating log entries manually, to inject them into the database.
Definition LogEntry.php:400
static suppressUserName( $name, $userId, $dbw=null)
static unsuppressUserName( $name, $userId, $dbw=null)
A special page that allows users with 'block' right to block users from editing pages and other actio...
int $type
Block::TYPE_ constant.
static getSuggestedDurations( $lang=null)
Get an array of suggested block durations from MediaWiki:Ipboptions.
preText()
Add header elements like block log entries, etc.
static processForm(array $data, IContextSource $context)
Given the form data, actually implement a block.
onSuccess()
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
static validateTarget( $value, User $user)
Validate a block target.
static parseExpiryInput( $expiry)
Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034",...
static getTargetAndType( $par, WebRequest $request=null)
Determine the target of the block, and the type of target.
static validateTargetField( $value, $alldata, $form)
HTMLForm field validation-callback for Target field.
bool $requestedHideUser
Whether the previous submission of the form asked for HideUser.
maybeAlterFormDefaults(&$fields)
If the user has already been blocked with similar settings, load that block and change the defaults f...
getFormFields()
Get the HTMLForm descriptor array for the block form.
postText()
Add footer elements to the form.
setParameter( $par)
Handle some magic here.
User string $previousTarget
The previous block target.
checkExecutePermissions(User $user)
Checks that the user can unblock themselves if they are trying to do so.
alterForm(HTMLForm $form)
Customizes the HTMLForm a bit.
static getTargetUserTitle( $target)
Get a user page target for things like logs.
User string null $target
User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo...
static checkUnblockSelf( $user, User $performer)
T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to ...
doesWrites()
Indicates whether this special page may perform database writes.
onSubmit(array $data, HTMLForm $form=null)
Process the form on POST submission.
static blockLogFlags(array $data, $type)
Return a comma-delimited list of "flags" to be passed to the log reader for this block,...
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
static canBlockEmail( $user)
Can we do an email block?
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
getName()
Get the name of this Special Page.
getUser()
Shortcut to get the User executing this instance.
getSkin()
Shortcut to get the skin being used for this instance.
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,...
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
static search( $audience, $search, $limit, $offset=0)
Do a prefix search of user names and return a list of matching user names.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
getName()
Get the user name, or the IP of an anonymous user.
Definition User.php:2249
isBlocked( $bFromSlave=true)
Check if user is blocked.
Definition User.php:2067
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition User.php:3565
getId()
Get the user's ID.
Definition User.php:2224
blockedBy()
If user is blocked, return the name of the user who placed the block.
Definition User.php:2110
static doWatch(Title $title, User $user, $checkRights=User::CHECK_USER_RIGHTS)
Watch a page.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
=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
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
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
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
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
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
const NS_USER
Definition Defines.php:67
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). '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:1245
the array() calling protocol came about after MediaWiki 1.4rc1.
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:2168
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:2775
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
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:2780
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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2805
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:862
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
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:2026
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 local account $user
Definition hooks.txt:247
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
Interface for objects which can provide a MediaWiki context on request.
$expiryTime
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:36
if(!isset( $args[0])) $lang