51 parent::__construct(
'Block',
'block' );
65 parent::checkExecutePermissions(
$user );
67 # bug 15810: 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' );
106 $msg = $this->alreadyBlocked ?
'ipb-change-block' :
'ipbsubmit';
111 # Don't need to do anything if the form has been posted
112 if ( !$this->
getRequest()->wasPosted() && $this->preErrors ) {
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';
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' );
375 # Link to the user's contributions, if applicable
376 if ( $this->target instanceof
User ) {
380 $this->msg(
'ipb-blocklist-contribs', $this->target->getName() )->escaped()
384 # Link to unblock the specified user, or to a blank unblock form
385 if ( $this->target instanceof
User ) {
386 $message = $this->msg(
392 $message = $this->msg(
'ipb-unblock' )->parse();
397 # Link to the block list
400 $this->msg(
'ipb-blocklist' )->escaped()
403 $user = $this->getUser();
405 # Link to edit the block dropdown reasons, if applicable
406 if (
$user->isAllowed(
'editinterface' ) ) {
408 $this->msg(
'ipbreason-dropdown' )->inContentLanguage()->getTitle(),
409 $this->msg(
'ipb-edit-dropdown' )->escaped(),
411 [
'action' =>
'edit' ]
415 $text = Html::rawElement(
417 [
'class' =>
'mw-ipb-conveniencelinks' ],
418 $this->getLanguage()->pipeList( $links )
421 $userTitle = self::getTargetUserTitle( $this->target );
423 # Get relevant extracts from the block and suppression logs, if possible
433 'msgKey' => [
'blocklog-showlog', $userTitle->getText() ],
434 'showIfEmpty' =>
false
439 # Add suppression block entries if allowed
440 if (
$user->isAllowed(
'suppressionlog' ) ) {
448 'conds' => [
'log_action' => [
'block',
'reblock',
'unblock' ] ],
449 'msgKey' => [
'blocklog-showsuppresslog', $userTitle->getText() ],
450 'showIfEmpty' =>
false
468 if ( $target instanceof
User ) {
469 return $target->getUserPage();
471 return Title::makeTitleSafe(
NS_USER, $target );
492 # The HTMLForm will check wpTarget first and only if it doesn't get
493 # a value use the default, which will be generated from the options
494 # below; so this has to have a higher precedence here than $par, or
495 # we could end up with different values in $this->target and the HTMLForm!
497 $target =
$request->getText(
'wpTarget',
null );
505 $target =
$request->getText(
'ip',
null );
511 $target =
$request->getText(
'wpBlockAddress',
null );
520 if (
$type !==
null ) {
521 return [ $target,
$type ];
525 return [
null, null ];
539 $errors =
$status->getErrorsArray();
541 return call_user_func_array( [ $form,
'msg' ], $errors[0] );
560 $status = Status::newGood( $target );
563 if ( $target->isAnon() ) {
570 $unblockStatus = self::checkUnblockSelf( $target,
$user );
571 if ( $unblockStatus !==
true ) {
572 $status->fatal(
'badaccess', $unblockStatus );
575 list( $ip, $range ) = explode(
'/', $target, 2 );
582 $status->fatal(
'range_block_disabled' );
590 $status->fatal(
'ip_range_invalid' );
603 $status->fatal(
'badipaddress' );
624 # This might have been a hidden field or a checkbox, so interesting data
626 $data[
'Confirm'] = !in_array( $data[
'Confirm'], [
'',
'0',
null,
false ],
true );
629 list( $target,
$type ) = self::getTargetAndType( $data[
'Target'] );
632 $target =
$user->getName();
633 $userId =
$user->getId();
635 # Give admins a heads-up before they go and block themselves. Much messier
636 # to do this for IPs, but it's pretty unlikely they'd ever get the 'block'
637 # permission anyway, although the code does allow for it.
638 # Note: Important to use $target instead of $data['Target']
639 # since both $data['PreviousTarget'] and $target are normalized
640 # but $data['target'] gets overridden by (non-normalized) request variable
641 # from previous request.
642 if ( $target === $performer->getName() &&
643 ( $data[
'PreviousTarget'] !== $target || !$data[
'Confirm'] )
645 return [
'ipb-blockingself',
'ipb-confirmaction' ];
652 $target = $target->getName();
655 # This should have been caught in the form field validation
656 return [
'badipaddress' ];
659 $expiryTime = self::parseExpiryInput( $data[
'Expiry'] );
663 ( strlen( $data[
'Expiry'] ) == 0 ) ||
665 ( strlen( $data[
'Expiry'] ) > 50 ) ||
669 return [
'ipb_expiry_invalid' ];
675 return [
'ipb_expiry_old' ];
678 if ( !isset( $data[
'DisableEmail'] ) ) {
679 $data[
'DisableEmail'] =
false;
682 # If the user has done the form 'properly', they won't even have been given the
683 # option to suppress-block unless they have the 'hideuser' permission
684 if ( !isset( $data[
'HideUser'] ) ) {
685 $data[
'HideUser'] =
false;
688 if ( $data[
'HideUser'] ) {
689 if ( !$performer->isAllowed(
'hideuser' ) ) {
690 # this codepath is unreachable except by a malicious user spoofing forms,
691 # or by race conditions (user has hideuser and block rights, loads block form,
692 # and loses hideuser rights before submission); so need to fail completely
693 # rather than just silently disable hiding
694 return [
'badaccess-group0' ];
697 # Recheck params here...
699 $data[
'HideUser'] =
false; #
IP users should
not be hidden
702 return [
'ipb_expiry_temp' ];
706 # Typically, the user should have a handful of edits.
707 # Disallow hiding users with many edits for performance.
708 return [ [
'ipb_hide_invalid',
710 } elseif ( !$data[
'Confirm'] ) {
711 return [
'ipb-confirmhideuser',
'ipb-confirmaction' ];
715 # Create block object.
716 $block =
new Block();
717 $block->setTarget( $target );
718 $block->setBlocker( $performer );
719 # Truncate reason for whole multibyte characters
720 $block->mReason =
$wgContLang->truncate( $data[
'Reason'][0], 255 );
722 $block->prevents(
'createaccount', $data[
'CreateAccount'] );
724 $block->prevents(
'sendemail', $data[
'DisableEmail'] );
725 $block->isHardblock( $data[
'HardBlock'] );
726 $block->isAutoblocking( $data[
'AutoBlock'] );
727 $block->mHideName = $data[
'HideUser'];
729 $reason = [
'hookaborted' ];
730 if ( !Hooks::run(
'BlockIp', [ &$block, &$performer, &$reason ] ) ) {
735 # Try to insert block. Is there a conflicting block?
738 # Indicates whether the user is confirming the block and is aware of
739 # the conflict (did not change the block target in the meantime)
740 $blockNotConfirmed = !$data[
'Confirm'] || ( array_key_exists(
'PreviousTarget', $data )
741 && $data[
'PreviousTarget'] !== $target );
743 # Special case for API - bug 32434
744 $reblockNotAllowed = ( array_key_exists(
'Reblock', $data ) && !$data[
'Reblock'] );
746 # Show form unless the user is already aware of this...
747 if ( $blockNotConfirmed || $reblockNotAllowed ) {
748 return [ [
'ipb_already_blocked', $block->getTarget() ] ];
749 # Otherwise, try to update the block...
751 # This returns direct blocks before autoblocks/rangeblocks, since we should
752 # be sure the user is blocked by now it should work for our purposes
754 if ( $block->equals( $currentBlock ) ) {
755 return [ [
'ipb_already_blocked', $block->getTarget() ] ];
757 # If the name was hidden and the blocking user cannot hide
758 # names, then don't allow any block changes...
759 if ( $currentBlock->mHideName && !$performer->isAllowed(
'hideuser' ) ) {
760 return [
'cant-see-hidden-user' ];
763 $priorBlock = clone $currentBlock;
764 $currentBlock->isHardblock( $block->isHardblock() );
765 $currentBlock->prevents(
'createaccount', $block->prevents(
'createaccount' ) );
766 $currentBlock->mExpiry = $block->mExpiry;
767 $currentBlock->isAutoblocking( $block->isAutoblocking() );
768 $currentBlock->mHideName = $block->mHideName;
769 $currentBlock->prevents(
'sendemail', $block->prevents(
'sendemail' ) );
770 $currentBlock->prevents(
'editownusertalk', $block->prevents(
'editownusertalk' ) );
771 $currentBlock->mReason = $block->mReason;
773 $status = $currentBlock->update();
775 $logaction =
'reblock';
777 # Unset _deleted fields if requested
778 if ( $currentBlock->mHideName && !$data[
'HideUser'] ) {
782 # If hiding/unhiding a name, this should go in the private logs
783 if ( (
bool)$currentBlock->mHideName ) {
784 $data[
'HideUser'] =
true;
788 $logaction =
'block';
791 Hooks::run(
'BlockIpComplete', [ $block, $performer, $priorBlock ] );
793 # Set *_deleted fields if requested
794 if ( $data[
'HideUser'] ) {
798 # Can't watch a rangeblock
801 Title::makeTitle(
NS_USER, $target ),
803 User::IGNORE_USER_RIGHTS
807 # Block constructor sanitizes certain block options on insert
808 $data[
'BlockEmail'] = $block->prevents(
'sendemail' );
809 $data[
'AutoBlock'] = $block->isAutoblocking();
811 # Prepare log parameters
813 $logParams[
'5::duration'] = $data[
'Expiry'];
814 $logParams[
'6::flags'] = self::blockLogFlags( $data,
$type );
816 # Make log entry, if the name is hidden, put it in the suppression log
817 $log_type = $data[
'HideUser'] ?
'suppress' :
'block';
819 $logEntry->setTarget( Title::makeTitle(
NS_USER, $target ) );
820 $logEntry->setComment( $data[
'Reason'][0] );
821 $logEntry->setPerformer( $performer );
822 $logEntry->setParameters( $logParams );
823 # Relate log ID to block IDs (bug 25763)
825 $logEntry->setRelations( [
'ipb_id' => $blockIds ] );
826 $logId = $logEntry->insert();
827 $logEntry->publish( $logId );
843 $msg =
$lang ===
null
844 ?
wfMessage(
'ipboptions' )->inContentLanguage()->text()
851 foreach ( explode(
',', $msg )
as $option ) {
852 if ( strpos( $option,
':' ) ===
false ) {
853 $option =
"$option:$option";
856 list( $show,
$value ) = explode(
':', $option );
871 $expiry =
'infinity';
873 $expiry = strtotime( $expiry );
875 if ( $expiry < 0 || $expiry ===
false ) {
905 if ( is_int(
$user ) ) {
907 } elseif ( is_string(
$user ) ) {
913 # User is trying to unblock themselves
914 if ( $performer->
isAllowed(
'unblockself' ) ) {
916 # User blocked themselves and is now trying to reverse it
920 return 'ipbnounblockself';
923 # User is trying to block/unblock someone else
942 # when blocking a user the option 'anononly' is not available/has no effect
943 # -> do not write this into log
949 if ( $data[
'CreateAccount'] ) {
954 # Same as anononly, this is not displayed when blocking an IP address
960 if ( $data[
'DisableEmail'] ) {
970 if ( $data[
'HideUser'] ) {
975 return implode(
',',
$flags );
985 return self::processForm( $data, $form->getContext() );
993 $out = $this->getOutput();
994 $out->setPageTitle( $this->msg(
'blockipsuccesssub' ) );
1007 $user = User::newFromName( $search );
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.
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
getUser()
Get the User object.
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.
A collection of public static functions to play with IP address and IP blocks.
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
static link( $target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
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)
bug 15810: blocked admins should not be able to block/unblock others, and probably shouldn't be able ...
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,...
getRequest()
Get the WebRequest being used for this instance.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
msg()
Wrapper around wfMessage that sets the current context.
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...
=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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
when a variable name is used in a it is silently declared as a new local masking the global
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
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
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
namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable(). 'NewDifferenceEngine' do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
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
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 RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor' $rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
error also a ContextSource you ll probably need to make sure the header is varied on $request
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive $limit
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
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
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
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.