51 parent::__construct(
'Block',
'block' );
65 parent::checkExecutePermissions( $user );
67 # T17810: blocked admins should have limited access here
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
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 );
91 list( $this->previousTarget, ) =
93 $this->requestedHideUser =
$request->getBool(
'wpHideUser' );
102 $form->setWrapperLegendMsg(
'blockip-legend' );
103 $form->setHeaderText(
'' );
104 $form->setSubmitDestructive();
106 $msg = $this->alreadyBlocked ?
'ipb-change-block' :
'ipbsubmit';
107 $form->setSubmitTextMsg( $msg );
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 );
115 $form->addHeaderText( Html::rawElement(
117 [
'class' =>
'error' ],
138 'label-message' =>
'ipaddressorusername',
139 'id' =>
'mw-bi-target',
143 'validation-callback' => [ __CLASS__,
'validateTargetField' ],
144 'cssclass' =>
'mw-autocomplete-user',
147 'type' => !count( $suggestedDurations ) ?
'text' :
'selectorother',
148 'label-message' =>
'ipbexpiry',
150 'options' => $suggestedDurations,
151 'other' => $this->
msg(
'ipbother' )->text(),
152 'default' => $this->
msg(
'ipb-default-expiry' )->inContentLanguage()->text(),
155 'type' =>
'selectandother',
157 'label-message' =>
'ipbreason',
158 'options-message' =>
'ipbreason-dropdown',
162 'label-message' =>
'ipbcreateaccount',
167 if ( self::canBlockEmail( $user ) ) {
168 $a[
'DisableEmail'] = [
170 'label-message' =>
'ipbemailban',
175 $a[
'DisableUTEdit'] = [
177 'label-message' =>
'ipb-disableusertalk',
184 'label-message' =>
'ipbenableautoblock',
188 # Allow some users to hide name from block log, blocklist and listusers
189 if ( $user->isAllowed(
'hideuser' ) ) {
192 'label-message' =>
'ipbhidename',
193 'cssclass' =>
'mw-block-hideuser',
197 # Watchlist their user page? (Only if user is logged in)
198 if ( $user->isLoggedIn() ) {
201 'label-message' =>
'ipbwatchuser',
207 'label-message' =>
'ipb-hardblock',
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'] = [
218 # We'll turn this into a checkbox if we need to
222 'label-message' =>
'ipb-confirm',
228 Hooks::run(
'SpecialBlockModifyFormFields', [ $this, &$a ] );
241 # This will be overwritten by request data
242 $fields[
'Target'][
'default'] = (
string)$this->target;
244 if ( $this->target ) {
247 $errors =
$status->getErrorsArray();
248 $this->preErrors = array_merge( $this->preErrors, $errors );
253 $fields[
'PreviousTarget'][
'default'] = (
string)$this->target;
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
261 $fields['HardBlock
']['default'] = $block->isHardblock();
262 $fields['CreateAccount
']['default'] = $block->prevents( 'createaccount
' );
263 $fields['AutoBlock
']['default'] = $block->isAutoblocking();
265 if ( isset( $fields['DisableEmail
'] ) ) {
266 $fields['DisableEmail
']['default'] = $block->prevents( 'sendemail
' );
269 if ( isset( $fields['HideUser
'] ) ) {
270 $fields['HideUser
']['default'] = $block->mHideName;
273 if ( isset( $fields['DisableUTEdit
'] ) ) {
274 $fields['DisableUTEdit
']['default'] = $block->prevents( 'editownusertalk
' );
277 // If the username was hidden (ipb_deleted == 1), don't show the reason
279 if ( !$block->mHideName || $this->getUser()->isAllowed(
'hideuser' ) ) {
280 $fields[
'Reason'][
'default'] = $block->mReason;
282 $fields[
'Reason'][
'default'] =
'';
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';
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;
296 if ( $block->mExpiry ==
'infinity' ) {
297 $fields[
'Expiry'][
'default'] =
'infinite';
299 $fields[
'Expiry'][
'default'] =
wfTimestamp( TS_RFC2822, $block->mExpiry );
302 $this->alreadyBlocked =
true;
303 $this->preErrors[] = [
'ipb-needreblock',
wfEscapeWikiText( (
string)$block->getTarget() ) ];
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' ];
313 # Or if the user is trying to block themselves
315 $fields[
'Confirm'][
'type'] =
'check';
316 unset( $fields[
'Confirm'][
'default'] );
317 $this->preErrors[] = [
'ipb-blockingself',
'ipb-confirmaction' ];
326 $this->getOutput()->addModules( [
'mediawiki.special.block',
'mediawiki.userSuggest' ] );
328 $blockCIDRLimit = $this->getConfig()->get(
'BlockCIDRLimit' );
329 $text = $this->msg(
'blockiptext', $blockCIDRLimit[
'IPv4'], $blockCIDRLimit[
'IPv6'] )->parse();
331 $otherBlockMessages = [];
332 if ( $this->target !==
null ) {
333 $targetName = $this->target;
334 if ( $this->target instanceof
User ) {
335 $targetName = $this->target->getName();
337 # Get other blocks, i.e. from GlobalBlocking or TorBlock extension
338 Hooks::run(
'OtherBlockLogLink', [ &$otherBlockMessages, $targetName ] );
340 if ( count( $otherBlockMessages ) ) {
341 $s = Html::rawElement(
344 $this->msg(
'ipb-otherblocks-header', count( $otherBlockMessages ) )->parse()
349 foreach ( $otherBlockMessages as
$link ) {
350 $list .= Html::rawElement(
'li', [],
$link ) .
"\n";
353 $s .= Html::rawElement(
355 [
'class' =>
'mw-blockip-alreadyblocked' ],
373 $this->getOutput()->addModuleStyles(
'mediawiki.special' );
376 # Link to the user's contributions, if applicable
377 if ( $this->target instanceof
User ) {
381 $this->msg(
'ipb-blocklist-contribs', $this->target->getName() )->text()
385 # Link to unblock the specified user, or to a blank unblock form
386 if ( $this->target instanceof
User ) {
387 $message = $this->msg(
393 $message = $this->msg(
'ipb-unblock' )->parse();
401 # Link to the block list
404 $this->msg(
'ipb-blocklist' )->
text()
407 $user = $this->getUser();
409 # Link to edit the block dropdown reasons, if applicable
410 if ( $user->isAllowed(
'editinterface' ) ) {
412 $this->msg(
'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
413 $this->msg(
'ipb-edit-dropdown' )->
text(),
415 [
'action' =>
'edit' ]
419 $text = Html::rawElement(
421 [
'class' =>
'mw-ipb-conveniencelinks' ],
422 $this->getLanguage()->pipeList( $links )
425 $userTitle = self::getTargetUserTitle( $this->target );
427 # Get relevant extracts from the block and suppression logs, if possible
437 'msgKey' => [
'blocklog-showlog', $userTitle->getText() ],
438 'showIfEmpty' =>
false
443 # Add suppression block entries if allowed
444 if ( $user->isAllowed(
'suppressionlog' ) ) {
452 'conds' => [
'log_action' => [
'block',
'reblock',
'unblock' ] ],
453 'msgKey' => [
'blocklog-showsuppresslog', $userTitle->getText() ],
454 'showIfEmpty' =>
false
472 if ( $target instanceof
User ) {
473 return $target->getUserPage();
474 } elseif ( IP::isIPAddress( $target ) ) {
475 return Title::makeTitleSafe( NS_USER, $target );
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!
501 $target =
$request->getText(
'wpTarget',
null );
509 $target =
$request->getText(
'ip',
null );
515 $target =
$request->getText(
'wpBlockAddress',
null );
524 if (
$type !==
null ) {
525 return [ $target,
$type ];
529 return [
null, null ];
543 $errors =
$status->getErrorsArray();
545 return call_user_func_array( [ $form,
'msg' ], $errors[0] );
564 $status = Status::newGood( $target );
567 if ( $target->isAnon() ) {
574 $unblockStatus = self::checkUnblockSelf( $target, $user );
575 if ( $unblockStatus !==
true ) {
576 $status->fatal(
'badaccess', $unblockStatus );
579 list( $ip, $range ) = explode(
'/', $target, 2 );
586 $status->fatal(
'range_block_disabled' );
590 ( IP::isIPv4( $ip ) && $range > 32 ) ||
591 ( IP::isIPv6( $ip ) && $range > 128 )
594 $status->fatal(
'ip_range_invalid' );
607 $status->fatal(
'badipaddress' );
628 # This might have been a hidden field or a checkbox, so interesting data
630 $data[
'Confirm'] = !in_array( $data[
'Confirm'], [
'',
'0',
null,
false ],
true );
633 list( $target,
$type ) = self::getTargetAndType( $data[
'Target'] );
636 $target = $user->getName();
637 $userId = $user->getId();
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'] )
649 return [
'ipb-blockingself',
'ipb-confirmaction' ];
656 $target = $target->getName();
659 # This should have been caught in the form field validation
660 return [
'badipaddress' ];
663 $expiryTime = self::parseExpiryInput( $data[
'Expiry'] );
667 ( strlen( $data[
'Expiry'] ) == 0 ) ||
669 ( strlen( $data[
'Expiry'] ) > 50 ) ||
673 return [
'ipb_expiry_invalid' ];
679 return [
'ipb_expiry_old' ];
682 if ( !isset( $data[
'DisableEmail'] ) ) {
683 $data[
'DisableEmail'] =
false;
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;
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' ];
701 # Recheck params here...
703 $data[
'HideUser'] =
false; #
IP users should not be hidden
706 return [
'ipb_expiry_temp' ];
710 # Typically, the user should have a handful of edits.
711 # Disallow hiding users with many edits for performance.
712 return [ [
'ipb_hide_invalid',
714 } elseif ( !$data[
'Confirm'] ) {
715 return [
'ipb-confirmhideuser',
'ipb-confirmaction' ];
719 # Create block object.
720 $block =
new Block();
721 $block->setTarget( $target );
722 $block->setBlocker( $performer );
723 $block->mReason = $data[
'Reason'][0];
725 $block->prevents(
'createaccount', $data[
'CreateAccount'] );
727 $block->prevents(
'sendemail', $data[
'DisableEmail'] );
728 $block->isHardblock( $data[
'HardBlock'] );
729 $block->isAutoblocking( $data[
'AutoBlock'] );
730 $block->mHideName = $data[
'HideUser'];
732 $reason = [
'hookaborted' ];
733 if ( !Hooks::run(
'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
738 # Try to insert block. Is there a conflicting block?
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 );
746 # Special case for API - T34434
747 $reblockNotAllowed = ( array_key_exists(
'Reblock', $data ) && !$data[
'Reblock'] );
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...
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
757 if ( $block->equals( $currentBlock ) ) {
758 return [ [
'ipb_already_blocked', $block->getTarget() ] ];
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' ];
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;
776 $status = $currentBlock->update();
778 $logaction =
'reblock';
780 # Unset _deleted fields if requested
781 if ( $currentBlock->mHideName && !$data[
'HideUser'] ) {
785 # If hiding/unhiding a name, this should go in the private logs
786 if ( (
bool)$currentBlock->mHideName ) {
787 $data[
'HideUser'] =
true;
791 $logaction =
'block';
794 Hooks::run(
'BlockIpComplete', [ $block, $performer, $priorBlock ] );
796 # Set *_deleted fields if requested
797 if ( $data[
'HideUser'] ) {
801 # Can't watch a rangeblock
804 Title::makeTitle( NS_USER, $target ),
806 User::IGNORE_USER_RIGHTS
810 # Block constructor sanitizes certain block options on insert
811 $data[
'BlockEmail'] = $block->prevents(
'sendemail' );
812 $data[
'AutoBlock'] = $block->isAutoblocking();
814 # Prepare log parameters
816 $logParams[
'5::duration'] = $data[
'Expiry'];
817 $logParams[
'6::flags'] = self::blockLogFlags( $data,
$type );
819 # Make log entry, if the name is hidden, put it in the suppression log
820 $log_type = $data[
'HideUser'] ?
'suppress' :
'block';
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)
828 $logEntry->setRelations( [
'ipb_id' => $blockIds ] );
829 $logId = $logEntry->insert();
831 if ( !empty( $data[
'Tags'] ) ) {
832 $logEntry->setTags( $data[
'Tags'] );
835 $logEntry->publish( $logId );
850 $msg =
$lang ===
null
851 ?
wfMessage(
'ipboptions' )->inContentLanguage()->text()
858 foreach ( explode(
',', $msg ) as $option ) {
859 if ( strpos( $option,
':' ) ===
false ) {
860 $option =
"$option:$option";
863 list( $show,
$value ) = explode(
':', $option );
878 $expiry =
'infinity';
880 $expiry = strtotime( $expiry );
882 if ( $expiry < 0 || $expiry ===
false ) {
912 if ( is_int( $user ) ) {
913 $user = User::newFromId( $user );
914 } elseif ( is_string( $user ) ) {
915 $user = User::newFromName( $user );
919 if ( $user instanceof
User && $user->
getId() == $performer->
getId() ) {
920 # User is trying to unblock themselves
921 if ( $performer->
isAllowed(
'unblockself' ) ) {
923 # User blocked themselves and is now trying to reverse it
927 return 'ipbnounblockself';
930 # User is trying to block/unblock someone else
949 # when blocking a user the option 'anononly' is not available/has no effect
950 # -> do not write this into log
956 if ( $data[
'CreateAccount'] ) {
961 # Same as anononly, this is not displayed when blocking an IP address
967 if ( $data[
'DisableEmail'] ) {
977 if ( $data[
'HideUser'] ) {
982 return implode(
',',
$flags );
992 return self::processForm( $data, $form->getContext() );
1000 $out = $this->getOutput();
1001 $out->setPageTitle( $this->msg(
'blockipsuccesssub' ) );
1014 $user = User::newFromName( $search );
$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.
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
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.
Marks HTML that shouldn't be escaped.
A collection of public static functions to play with IP address and IP ranges.
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.
Class for creating log entries manually, to inject them into the database.
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,...
getName()
Get the user name, or the IP of an anonymous user.
isBlocked( $bFromSlave=true)
Check if user is blocked.
isAllowed( $action='')
Internal mechanics of testing a permission.
getId()
Get the user's ID.
blockedBy()
If user is blocked, return the name of the user who placed the block.
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...
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
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
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
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
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
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
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 "<div ...>$1</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
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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
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
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
Interface for objects which can provide a MediaWiki context on request.
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
if(!isset( $args[0])) $lang