125 'createAccount' =>
false,
126 'enableAutoblock' =>
false,
128 'blockEmail' =>
false,
129 'allowUsertalk' =>
false,
131 'systemBlock' =>
null,
134 if ( func_num_args() > 1 || !is_array(
$options ) ) {
136 array_slice( array_keys( $defaults ), 0, func_num_args() ),
139 wfDeprecated( __METHOD__ .
' with multiple arguments',
'1.26' );
146 if ( $this->target instanceof
User &&
$options[
'user'] ) {
147 # Needed for foreign users
148 $this->forcedTargetID =
$options[
'user'];
159 $this->mReason =
$options[
'reason'];
164 $this->mAuto = (bool)
$options[
'auto'];
165 $this->mHideName = (bool)
$options[
'hideName'];
169 # Prevention measures
170 $this->
prevents(
'sendemail', (
bool)$options[
'blockEmail'] );
171 $this->
prevents(
'editownusertalk', !$options[
'allowUsertalk'] );
172 $this->
prevents(
'createaccount', (
bool)$options[
'createAccount'] );
174 $this->mFromMaster =
false;
175 $this->systemBlockType =
$options[
'systemBlock'];
188 $blockQuery[
'tables'],
189 $blockQuery[
'fields'],
216 throw new BadMethodCallException(
217 'Cannot use ' . __METHOD__
218 .
' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
228 'ipb_by_actor' =>
'NULL',
232 'ipb_create_account',
233 'ipb_enable_autoblock',
237 'ipb_allow_usertalk',
238 'ipb_parent_block_id',
239 ] + CommentStore::getStore()->getFields(
'ipb_reason' );
252 $commentQuery = CommentStore::getStore()->getJoin(
'ipb_reason' );
253 $actorQuery = ActorMigration::newMigration()->getJoin(
'ipb_by' );
255 'tables' => [
'ipblocks' ] + $commentQuery[
'tables'] + $actorQuery[
'tables'],
262 'ipb_create_account',
263 'ipb_enable_autoblock',
267 'ipb_allow_usertalk',
268 'ipb_parent_block_id',
269 ] + $commentQuery[
'fields'] + $actorQuery[
'fields'],
270 'joins' => $commentQuery[
'joins'] + $actorQuery[
'joins'],
284 (
string)$this->target == (
string)$block->target
285 && $this->type == $block->type
286 && $this->mAuto == $block->mAuto
288 && $this->prevents(
'createaccount' ) == $block->
prevents(
'createaccount' )
289 && $this->mExpiry == $block->mExpiry
291 && $this->mHideName == $block->mHideName
293 && $this->prevents(
'editownusertalk' ) == $block->
prevents(
'editownusertalk' )
294 && $this->mReason == $block->mReason
308 protected function newLoad( $vagueTarget =
null ) {
311 if ( $this->
type !==
null ) {
313 'ipb_address' => [ (
string)$this->target ],
316 $conds = [
'ipb_address' => [] ];
319 # Be aware that the != '' check is explicit, since empty values will be
320 # passed by some callers (T31116)
321 if ( $vagueTarget !=
'' ) {
325 # Slightly weird, but who are we to argue?
332 $conds = $db->makeList( $conds,
LIST_OR );
339 $conds = $db->makeList( $conds,
LIST_OR );
343 throw new MWException(
"Tried to load block with invalid type" );
349 $blockQuery[
'tables'], $blockQuery[
'fields'], $conds, __METHOD__, [], $blockQuery[
'joins']
352 # This result could contain a block on the user, a block on the IP, and a russian-doll
353 # set of rangeblocks. We want to choose the most specific one, so keep a leader board.
356 # Lower will be better
357 $bestBlockScore = 100;
359 # This is begging for $this = $bestBlock, but that's not allowed in PHP :(
360 $bestBlockPreventsEdit =
null;
362 foreach (
$res as $row ) {
365 # Don't use expired blocks
366 if ( $block->isExpired() ) {
370 # Don't use anon only blocks on users
371 if ( $this->
type == self::TYPE_USER && !$block->isHardblock() ) {
375 if ( $block->getType() == self::TYPE_RANGE ) {
376 # This is the number of bits that are allowed to vary in the block, give
377 # or take some floating point errors
378 $end = Wikimedia\base_convert( $block->getRangeEnd(), 16, 10 );
379 $start = Wikimedia\base_convert( $block->getRangeStart(), 16, 10 );
380 $size = log( $end - $start + 1, 2 );
382 # This has the nice property that a /32 block is ranked equally with a
383 # single-IP block, which is exactly what it is...
384 $score = self::TYPE_RANGE - 1 + ( $size / 128 );
387 $score = $block->getType();
390 if ( $score < $bestBlockScore ) {
391 $bestBlockScore = $score;
393 $bestBlockPreventsEdit = $block->prevents(
'edit' );
397 if ( $bestRow !==
null ) {
399 $this->
prevents(
'edit', $bestBlockPreventsEdit );
413 if ( $end ===
null ) {
416 # Per T16634, we want to include relevant active rangeblocks; for
417 # rangeblocks, we want to include larger ranges which enclose the given
418 # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
419 # so we can improve performance by filtering on a LIKE clause
422 $like =
$dbr->buildLike( $chunk,
$dbr->anyString() );
424 # Fairly hard to make a malicious SQL statement out of hex characters,
425 # but stranger things have happened...
426 $safeStart =
$dbr->addQuotes( $start );
427 $safeEnd =
$dbr->addQuotes( $end );
429 return $dbr->makeList(
431 "ipb_range_start $like",
432 "ipb_range_start <= $safeStart",
433 "ipb_range_end >= $safeEnd",
447 if ( substr( $hex, 0, 3 ) ==
'v6-' ) {
448 return 'v6-' . substr( substr( $hex, 3 ), 0, floor(
$wgBlockCIDRLimit[
'IPv6'] / 4 ) );
462 $row->ipb_by, $row->ipb_by_text, $row->ipb_by_actor ??
null
465 $this->mTimestamp =
wfTimestamp( TS_MW, $row->ipb_timestamp );
466 $this->mAuto = $row->ipb_auto;
467 $this->mHideName = $row->ipb_deleted;
468 $this->mId = (int)$row->ipb_id;
469 $this->mParentBlockId = $row->ipb_parent_block_id;
473 $this->mExpiry = $db->decodeExpiry( $row->ipb_expiry );
474 $this->mReason = CommentStore::getStore()
476 ->getCommentLegacy( $db,
'ipb_reason', $row )->text;
481 $this->
prevents(
'createaccount', $row->ipb_create_account );
482 $this->
prevents(
'sendemail', $row->ipb_block_email );
483 $this->
prevents(
'editownusertalk', !$row->ipb_allow_usertalk );
503 public function delete() {
508 if ( !$this->
getId() ) {
509 throw new MWException(
"Block::delete() requires that the mId member be filled\n" );
513 $dbw->delete(
'ipblocks', [
'ipb_parent_block_id' => $this->
getId() ], __METHOD__ );
514 $dbw->delete(
'ipblocks', [
'ipb_id' => $this->
getId() ], __METHOD__ );
516 return $dbw->affectedRows() > 0;
531 throw new MWException(
'Cannot insert a system block into the database' );
534 throw new MWException(
'Cannot insert a block without a blocker set' );
537 wfDebug(
"Block::insert; timestamp {$this->mTimestamp}\n" );
539 if ( $dbw ===
null ) {
547 $dbw->insert(
'ipblocks', $row, __METHOD__, [
'IGNORE' ] );
548 $affected = $dbw->affectedRows();
549 $this->mId = $dbw->insertId();
551 # Don't collide with expired blocks.
552 # Do this after trying to insert to avoid locking.
554 # T96428: The ipb_address index uses a prefix on a field, so
555 # use a standard SELECT + DELETE to avoid annoying gap locks.
556 $ids = $dbw->selectFieldValues(
'ipblocks',
559 'ipb_address' => $row[
'ipb_address'],
560 'ipb_user' => $row[
'ipb_user'],
561 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() )
566 $dbw->delete(
'ipblocks', [
'ipb_id' => $ids ], __METHOD__ );
567 $dbw->insert(
'ipblocks', $row, __METHOD__, [
'IGNORE' ] );
568 $affected = $dbw->affectedRows();
569 $this->mId = $dbw->insertId();
576 if ( $wgBlockDisablesLogin && $this->target instanceof
User ) {
578 $this->target->setToken();
579 $this->target->saveSettings();
582 return [
'id' =>
$this->mId,
'autoIds' => $auto_ipd_ids ];
596 wfDebug(
"Block::update; timestamp {$this->mTimestamp}\n" );
599 $dbw->startAtomic( __METHOD__ );
604 [
'ipb_id' => $this->
getId() ],
608 $affected = $dbw->affectedRows();
615 [
'ipb_parent_block_id' => $this->
getId() ],
622 [
'ipb_parent_block_id' => $this->
getId() ],
627 $dbw->endAtomic( __METHOD__ );
631 return [
'id' =>
$this->mId,
'autoIds' => $auto_ipd_ids ];
645 if ( $this->forcedTargetID ) {
648 $uid = $this->target instanceof
User ? $this->target->
getId() : 0;
652 'ipb_address' => (
string)$this->target,
654 'ipb_timestamp' => $dbw->
timestamp( $this->mTimestamp ),
657 'ipb_create_account' => $this->
prevents(
'createaccount' ),
659 'ipb_expiry' => $expiry,
662 'ipb_deleted' => intval( $this->mHideName ),
663 'ipb_block_email' => $this->
prevents(
'sendemail' ),
664 'ipb_allow_usertalk' => !$this->
prevents(
'editownusertalk' ),
666 ] + CommentStore::getStore()->insert( $dbw,
'ipb_reason', $this->mReason )
667 + ActorMigration::newMigration()->getInsertValues( $dbw,
'ipb_by', $this->
getBlocker() );
678 'ipb_create_account' => $this->
prevents(
'createaccount' ),
679 'ipb_deleted' => (int)$this->mHideName,
680 'ipb_allow_usertalk' => !$this->
prevents(
'editownusertalk' ),
681 ] + CommentStore::getStore()->insert( $dbw,
'ipb_reason', $this->mReason )
682 + ActorMigration::newMigration()->getInsertValues( $dbw,
'ipb_by', $this->
getBlocker() );
693 # If autoblock is enabled, autoblock the LAST IP(s) used
697 $continue = Hooks::run(
698 'PerformRetroactiveAutoblock', [ $this, &$blockIds ] );
728 $rcQuery = ActorMigration::newMigration()->getWhere(
$dbr,
'rc_user',
$target,
false );
730 $options = [
'ORDER BY' =>
'rc_timestamp DESC' ];
736 [
'recentchanges' ] + $rcQuery[
'tables'],
744 if ( !
$res->numRows() ) {
745 # No results, don't autoblock anything
746 wfDebug(
"No IP found to retroactively autoblock\n" );
748 foreach (
$res as $row ) {
769 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
771 $cache->makeKey(
'ip-autoblock',
'whitelist' ),
776 return explode(
"\n",
777 wfMessage(
'autoblock_whitelist' )->inContentLanguage()->
plain() );
781 wfDebug(
"Checking the autoblock whitelist..\n" );
785 if ( substr(
$line, 0, 1 ) !==
'*' ) {
789 $wlEntry = substr(
$line, 1 );
790 $wlEntry = trim( $wlEntry );
792 wfDebug(
"Checking $ip against $wlEntry..." );
794 # Is the IP in this range?
795 if ( IP::isInRange( $ip, $wlEntry ) ) {
796 wfDebug(
" IP $ip matches $wlEntry, not autoblocking\n" );
813 # If autoblocks are disabled, go away.
818 # Don't autoblock for system blocks
820 throw new MWException(
'Cannot autoblock from a system block' );
823 # Check for presence on the autoblock whitelist.
824 if ( self::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
830 # Allow hooks to cancel the autoblock.
831 if ( !Hooks::run(
'AbortAutoblock', [ $autoblockIP, &$block ] ) ) {
832 wfDebug(
"Autoblock aborted by hook.\n" );
836 # It's okay to autoblock. Go ahead and insert/update the block...
838 # Do not add a *new* block if the IP is already blocked.
841 # Check if the block is an autoblock and would exceed the user block
842 # if renewed. If so, do nothing, otherwise prolong the block time...
843 if ( $ipblock->mAuto &&
844 $this->mExpiry > self::getAutoblockExpiry( $ipblock->mTimestamp )
846 # Reset block timestamp to now and its expiry to
847 # $wgAutoblockExpiry in the future
848 $ipblock->updateTimestamp();
853 # Make a new block object with the desired properties.
854 $autoblock =
new Block;
855 wfDebug(
"Autoblocking {$this->getTarget()}@" . $autoblockIP .
"\n" );
856 $autoblock->setTarget( $autoblockIP );
857 $autoblock->setBlocker( $this->
getBlocker() );
859 ->inContentLanguage()->plain();
861 $autoblock->mTimestamp = $timestamp;
862 $autoblock->mAuto = 1;
863 $autoblock->prevents(
'createaccount', $this->
prevents(
'createaccount' ) );
864 # Continue suppressing the name if needed
866 $autoblock->prevents(
'editownusertalk', $this->
prevents(
'editownusertalk' ) );
869 if ( $this->mExpiry ==
'infinity' ) {
870 # Original block was indefinite, start an autoblock now
873 # If the user is already blocked with an expiry date, we don't
874 # want to pile on top of that.
875 $autoblock->mExpiry = min( $this->mExpiry, self::getAutoblockExpiry( $timestamp ) );
878 # Insert the block...
879 $status = $autoblock->insert();
891 wfDebug(
"Block::deleteIfExpired() -- deleting\n" );
895 wfDebug(
"Block::deleteIfExpired() -- not expired\n" );
908 wfDebug(
"Block::isExpired() checking current " . $timestamp .
" vs $this->mExpiry\n" );
910 if ( !$this->mExpiry ) {
929 if ( $this->mAuto ) {
934 $dbw->update(
'ipblocks',
936 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp ),
937 'ipb_expiry' => $dbw->timestamp( $this->mExpiry ),
940 'ipb_id' => $this->getId(),
953 switch ( $this->
type ) {
957 return IP::toHex( $this->target );
959 list( $start, ) = IP::parseRange( $this->target );
962 throw new MWException(
"Block with invalid type" );
972 switch ( $this->
type ) {
976 return IP::toHex( $this->target );
978 list( , $end ) = IP::parseRange( $this->target );
981 throw new MWException(
"Block with invalid type" );
1033 return wfSetVar( $this->mFromMaster, $x );
1044 # You can't *not* hardblock a user
1045 return $this->
getType() == self::TYPE_USER
1057 # You can't put an autoblock on an IP or range as we don't have any history to
1058 # look over to get more IPs from
1059 return $this->
getType() == self::TYPE_USER
1074 switch ( $action ) {
1076 # For now... <evil laugh>
1079 case 'createaccount':
1085 case 'editownusertalk':
1107 if ( $this->mAuto ) {
1108 return Html::rawElement(
1110 [
'class' =>
'mw-autoblockid' ],
1114 return htmlspecialchars( $this->
getTarget() );
1148 $dbw->
delete(
'ipblocks', [
'ipb_id' => $ids ],
$fname );
1174 public static function newFromTarget( $specificTarget, $vagueTarget =
null, $fromMaster =
false ) {
1176 if (
$type == self::TYPE_ID ||
$type == self::TYPE_AUTO ) {
1179 } elseif (
$target ===
null && $vagueTarget ==
'' ) {
1180 # We're not going to find anything useful here
1181 # Be aware that the == '' check is explicit, since empty values will be
1182 # passed by some callers (T31116)
1185 } elseif ( in_array(
1187 [ self::TYPE_USER, self::TYPE_IP, self::TYPE_RANGE,
null ] )
1189 $block =
new Block();
1190 $block->fromMaster( $fromMaster );
1192 if (
$type !==
null ) {
1196 if ( $block->newLoad( $vagueTarget ) ) {
1214 if ( !count( $ipChain ) ) {
1219 $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
1220 foreach ( array_unique( $ipChain )
as $ipaddr ) {
1221 # Discard invalid IP addresses. Since XFF can be spoofed and we do not
1222 # necessarily trust the header given to us, make sure that we are only
1223 # checking for blocks on well-formatted IP addresses (IPv4 and IPv6).
1224 # Do not treat private IP spaces as special as it may be desirable for wikis
1225 # to block those IP ranges in order to stop misbehaving proxies that spoof XFF.
1226 if ( !IP::isValid( $ipaddr ) ) {
1229 # Don't check trusted IPs (includes local squids which will be in every request)
1230 if ( $proxyLookup->isTrustedProxy( $ipaddr ) ) {
1233 # Check both the original IP (to check against single blocks), as well as build
1234 # the clause to check for rangeblocks for the given IP.
1235 $conds[
'ipb_address'][] = $ipaddr;
1239 if ( !count( $conds ) ) {
1243 if ( $fromMaster ) {
1248 $conds = $db->makeList( $conds,
LIST_OR );
1250 $conds = [ $conds,
'ipb_anon_only' => 0 ];
1253 $rows = $db->select(
1254 $blockQuery[
'tables'],
1255 array_merge( [
'ipb_range_start',
'ipb_range_end' ], $blockQuery[
'fields'] ),
1259 $blockQuery[
'joins']
1265 if ( !$block->isExpired() ) {
1295 if ( !count( $blocks ) ) {
1297 } elseif ( count( $blocks ) == 1 ) {
1303 usort( $blocks,
function (
Block $a,
Block $b ) {
1306 return strcmp( $bWeight, $aWeight );
1309 $blocksListExact = [
1311 'disable_create' =>
false,
1315 $blocksListRange = [
1317 'disable_create' =>
false,
1321 $ipChain = array_reverse( $ipChain );
1324 foreach ( $blocks
as $block ) {
1327 if ( !$block->isHardblock() && $blocksListExact[
'hard'] ) {
1329 } elseif ( !$block->prevents(
'createaccount' ) && $blocksListExact[
'disable_create'] ) {
1333 foreach ( $ipChain
as $checkip ) {
1334 $checkipHex = IP::toHex( $checkip );
1335 if ( (
string)$block->getTarget() === $checkip ) {
1336 if ( $block->isHardblock() ) {
1337 $blocksListExact[
'hard'] = $blocksListExact[
'hard'] ?: $block;
1338 } elseif ( $block->prevents(
'createaccount' ) ) {
1339 $blocksListExact[
'disable_create'] = $blocksListExact[
'disable_create'] ?: $block;
1340 } elseif ( $block->mAuto ) {
1341 $blocksListExact[
'auto'] = $blocksListExact[
'auto'] ?: $block;
1343 $blocksListExact[
'other'] = $blocksListExact[
'other'] ?: $block;
1347 } elseif ( array_filter( $blocksListExact ) == []
1348 && $block->getRangeStart() <= $checkipHex
1349 && $block->getRangeEnd() >= $checkipHex
1351 if ( $block->isHardblock() ) {
1352 $blocksListRange[
'hard'] = $blocksListRange[
'hard'] ?: $block;
1353 } elseif ( $block->prevents(
'createaccount' ) ) {
1354 $blocksListRange[
'disable_create'] = $blocksListRange[
'disable_create'] ?: $block;
1355 } elseif ( $block->mAuto ) {
1356 $blocksListRange[
'auto'] = $blocksListRange[
'auto'] ?: $block;
1358 $blocksListRange[
'other'] = $blocksListRange[
'other'] ?: $block;
1365 if ( array_filter( $blocksListExact ) == [] ) {
1366 $blocksList = &$blocksListRange;
1368 $blocksList = &$blocksListExact;
1371 $chosenBlock =
null;
1372 if ( $blocksList[
'hard'] ) {
1373 $chosenBlock = $blocksList[
'hard'];
1374 } elseif ( $blocksList[
'disable_create'] ) {
1375 $chosenBlock = $blocksList[
'disable_create'];
1376 } elseif ( $blocksList[
'other'] ) {
1377 $chosenBlock = $blocksList[
'other'];
1378 } elseif ( $blocksList[
'auto'] ) {
1379 $chosenBlock = $blocksList[
'auto'];
1381 throw new MWException(
"Proxy block found, but couldn't be classified." );
1384 return $chosenBlock;
1397 # We may have been through this before
1404 } elseif (
$target ===
null ) {
1405 return [
null, null ];
1410 if ( IP::isValid(
$target ) ) {
1411 # We can still create a User if it's an IP address, but we need to turn
1412 # off validation checking (which would exclude IP addresses)
1418 } elseif ( IP::isValidRange(
$target ) ) {
1419 # Can't create a User from an IP range
1423 # Consider the possibility that this is not a username at all
1424 # but actually an old subpage (T31797)
1425 if ( strpos(
$target,
'/' ) !==
false ) {
1426 # An old subpage, drill down to the user behind it
1431 if ( $userObj instanceof
User ) {
1432 # Note that since numbers are valid usernames, a $target of "12345" will be
1433 # considered a User. If you want to pass a block ID, prepend a hash "#12345",
1434 # since hash characters are not valid in usernames or titles generally.
1437 } elseif ( preg_match(
'/^#\d+$/',
$target ) ) {
1438 # Autoblock reference in the form "#12345"
1443 return [
null, null ];
1508 if ( is_string(
$user ) ) {
1513 throw new InvalidArgumentException(
1514 'Blocker must be a local user or a name that cannot be a local user'
1518 $this->blocker =
$user;
1540 $expiryValue = DateTime::createFromFormat(
'YmdHis',
$expiryTime )->format(
'U' );
1541 $cookieOptions = [
'httpOnly' =>
false ];
1543 $response->
setCookie(
'BlockID', $cookieValue, $expiryValue, $cookieOptions );
1554 $response->clearCookie(
'BlockID', [
'httpOnly' =>
false ] );
1567 $config = RequestContext::getMain()->getConfig();
1568 $id = $this->
getId();
1569 $secretKey = $config->get(
'SecretKey' );
1570 if ( !$secretKey ) {
1575 $cookieValue = $id .
'!' . $hmac;
1576 return $cookieValue;
1591 $bangPos = strpos( $cookieValue,
'!' );
1592 $id = ( $bangPos ===
false ) ? $cookieValue : substr( $cookieValue, 0, $bangPos );
1594 $config = RequestContext::getMain()->getConfig();
1595 $secretKey = $config->get(
'SecretKey' );
1596 if ( !$secretKey ) {
1600 $storedHmac = substr( $cookieValue, $bangPos + 1 );
1602 if ( $calculatedHmac === $storedHmac ) {
1620 $link =
"[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
1626 if ( $reason ==
'' ) {
1627 $reason =
$context->msg(
'blockednoreason' )->text();
1639 ?
'systemblockedtext'
1640 : ( $this->mAuto ?
'autoblockedtext' :
'blockedtext' ),
1646 $lang->formatExpiry( $this->mExpiry ),
1648 $lang->userTimeAndDate( $this->mTimestamp,
$context->getUser() ),
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgAutoblockExpiry
Number of seconds before autoblock entries expire.
$wgBlockCIDRLimit
Limits on the possible sizes of range blocks.
$wgPutIPinRC
Log IP addresses in the recentchanges table; can be accessed only by extensions (e....
$wgBlockDisablesLogin
If true, blocked users will not be allowed to login.
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Deferrable Update for closure/callback updates that should use auto-commit mode.
int $forcedTargetID
Hack for foreign blocking (CentralAuth)
static selectFields()
Return the list of ipblocks fields that should be selected to create a new block.
setCookie(WebResponse $response)
Set the 'BlockID' cookie to this block's ID and expiry time.
getPermissionsError(IContextSource $context)
Get the key and parameters for the corresponding error message.
static clearCookie(WebResponse $response)
Unset the 'BlockID' cookie.
insert( $dbw=null)
Insert a block into the block table.
static getRangeCond( $start, $end=null)
Get a set of SQL conditions which will select rangeblocks encompassing a given range.
newLoad( $vagueTarget=null)
Load a block from the database which affects the already-set $this->target: 1) A block directly on th...
update()
Update a block in the DB with new parameters.
prevents( $action, $x=null)
Get/set whether the Block prevents a given action.
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new block object.
static newFromRow( $row)
Create a new Block object from a database row.
getDatabaseArray(IDatabase $dbw)
Get an array suitable for passing to $dbw->insert() or $dbw->update()
isHardblock( $x=null)
Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range)
isValid()
Is the block address valid (i.e.
setBlocker( $user)
Set the user who implemented (or will implement) this block.
getRedactedName()
Get the block name, but with autoblocked IPs hidden as per standard privacy policy.
isExpired()
Has the block expired?
static newFromID( $id)
Load a blocked user from their block id.
static getAutoblockExpiry( $timestamp)
Get a timestamp of the expiry for autoblocks.
static getBlocksForIPList(array $ipChain, $isAnon, $fromMaster=false)
Get all blocks that match any IP from an array of IP addresses.
getRangeEnd()
Get the IP address at the end of the range in Hex form.
getAutoblockUpdateArray(IDatabase $dbw)
static getIpFragment( $hex)
Get the component of an IP address which is certain to be the same between an IP address and a rangeb...
static parseTarget( $target)
From an existing Block, get the target and the type of target.
string null $systemBlockType
static chooseBlock(array $blocks, array $ipChain)
From a list of multiple blocks, find the most exact and strongest Block.
getSystemBlockType()
Get the system block type, if any.
initFromRow( $row)
Given a database row from the ipblocks table, initialize member variables.
static isWhitelistedFromAutoblocks( $ip)
Checks whether a given IP is on the autoblock whitelist.
getType()
Get the type of target for this particular block.
__construct( $options=[])
Create a new block with specified parameters on a user, IP or IP range.
getBy()
Get the user id of the blocking sysop.
setTarget( $target)
Set the target for this block, and update $this->type accordingly.
updateTimestamp()
Update the timestamp on autoblocks.
fromMaster( $x=null)
Get/set a flag determining whether the master is used for reads.
doAutoblock( $autoblockIP)
Autoblocks the given IP, referring to this Block.
deleteIfExpired()
Check if a block has expired.
doRetroactiveAutoblock()
Retroactively autoblocks the last IP used by the user (if it is a user) blocked by this Block.
static getIdFromCookieValue( $cookieValue)
Get the stored ID from the 'BlockID' cookie.
getTargetAndType()
Get the target and target type for this particular Block.
getTarget()
Get the target for this particular Block.
static purgeExpired()
Purge expired blocks from the ipblocks table.
getRangeStart()
Get the IP address at the start of the range in Hex form.
getCookieValue()
Get the BlockID cookie's value for this block.
getByName()
Get the username of the blocking sysop.
equals(Block $block)
Check if two blocks are effectively equal.
static defaultRetroactiveAutoblock(Block $block, array &$blockIds)
Retroactively autoblocks the last IP used by the user (if it is a user) blocked by this Block.
getBlocker()
Get the user who implemented this block.
static newFromTarget( $specificTarget, $vagueTarget=null, $fromMaster=false)
Given a target and the target's type, get an existing Block object if possible.
int $type
Block::TYPE_ constant.
static hmac( $data, $key, $raw=true)
Generate an acceptably unstable one-way-hmac of some text making use of the best hash algorithm that ...
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.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
isAllowed( $action='')
Internal mechanics of testing a permission.
getId()
Get the user's ID.
static newFromAnyId( $userId, $userName, $actorId)
Static factory method for creation from an ID, name, and/or actor ID.
static newFromId( $id)
Static factory method for creation from a given user ID.
static isUsableName( $name)
Usernames which fail to pass this function will be blocked from user login and new account registrati...
getUserPage()
Get this user's personal page title.
Allow programs to request this object from WebRequest::response() and handle all outputting (or lack ...
setCookie( $name, $value, $expire=0, $options=[])
Set the browser cookie.
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 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 SCHEMA_COMPAT_READ_NEW
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 $rows
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
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
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 & $options
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
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 true
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<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
usually copyright or history_copyright This message must be in HTML not wikitext & $link
this hook is for auditing only $response
processing should stop and the error should be shown to the user * false
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
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 function
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.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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