3 * Blocks and bans object
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 /* public*/ var $mReason, $mTimestamp, $mAuto, $mExpiry, $mHideName, $mAngryAutoblock;
36 /// @var Block::TYPE_ constant. Can only be USER, IP or RANGE internally
43 protected $isHardblock = true;
46 protected $isAutoblocking = true;
57 * @todo FIXME: Don't know what the best format to have for this constructor is, but fourteen
58 * optional parameters certainly isn't it.
60 function __construct( $address = '', $user = 0, $by = 0, $reason = '',
61 $timestamp = 0, $auto = 0, $expiry = '', $anonOnly = 0, $createAccount = 0, $enableAutoblock = 0,
62 $hideName = 0, $blockEmail = 0, $allowUsertalk = 0 )
64 if( $timestamp === 0 ){
65 $timestamp = wfTimestampNow();
68 if( count( func_get_args() ) > 0 ){
70 # wfDeprecated( __METHOD__ . " with arguments" );
73 $this->setTarget( $address );
74 $this->setBlocker( User
::newFromID( $by ) );
75 $this->mReason
= $reason;
76 $this->mTimestamp
= wfTimestamp( TS_MW
, $timestamp );
78 $this->isHardblock( !$anonOnly );
79 $this->prevents( 'createaccount', $createAccount );
80 $this->mExpiry
= $expiry;
81 $this->isAutoblocking( $enableAutoblock );
82 $this->mHideName
= $hideName;
83 $this->prevents( 'sendemail', $blockEmail );
84 $this->prevents( 'editownusertalk', !$allowUsertalk );
86 $this->mFromMaster
= false;
87 $this->mAngryAutoblock
= false;
91 * Load a block from the database, using either the IP address or
92 * user ID. Tries the user ID first, and if that doesn't work, tries
95 * @param $address String: IP address of user/anon
96 * @param $user Integer: user id of user
97 * @return Block Object
98 * @deprecated since 1.18
100 public static function newFromDB( $address, $user = 0 ) {
101 return self
::newFromTarget( User
::whoIs( $user ), $address );
105 * Load a blocked user from their block id.
107 * @param $id Integer: Block id to search for
108 * @return Block object or null
110 public static function newFromID( $id ) {
111 $dbr = wfGetDB( DB_SLAVE
);
112 $res = $dbr->selectRow(
115 array( 'ipb_id' => $id ),
119 return Block
::newFromRow( $res );
126 * Check if two blocks are effectively equal. Doesn't check irrelevant things like
127 * the blocking user or the block timestamp, only things which affect the blocked user *
129 * @param $block Block
133 public function equals( Block
$block ) {
135 (string)$this->target
== (string)$block->target
136 && $this->type
== $block->type
137 && $this->mAuto
== $block->mAuto
138 && $this->isHardblock() == $block->isHardblock()
139 && $this->prevents( 'createaccount' ) == $block->prevents( 'createaccount' )
140 && $this->mExpiry
== $block->mExpiry
141 && $this->isAutoblocking() == $block->isAutoblocking()
142 && $this->mHideName
== $block->mHideName
143 && $this->prevents( 'sendemail' ) == $block->prevents( 'sendemail' )
144 && $this->prevents( 'editownusertalk' ) == $block->prevents( 'editownusertalk' )
145 && $this->mReason
== $block->mReason
150 * Clear all member variables in the current object. Does not clear
151 * the block from the DB.
152 * @deprecated since 1.18
154 public function clear() {
159 * Get a block from the DB, with either the given address or the given username
161 * @param $address string The IP address of the user, or blank to skip IP blocks
162 * @param $user int The user ID, or zero for anonymous users
163 * @return Boolean: the user is blocked from editing
164 * @deprecated since 1.18
166 public function load( $address = '', $user = 0 ) {
167 wfDeprecated( __METHOD__
);
169 $username = User
::whoIs( $user );
170 $block = self
::newFromTarget( $username, $address );
172 $block = self
::newFromTarget( null, $address );
175 if( $block instanceof Block
){
176 # This is mildly evil, but hey, it's B/C :D
177 foreach( $block as $variable => $value ){
178 $this->$variable = $value;
187 * Load a block from the database which affects the already-set $this->target:
188 * 1) A block directly on the given user or IP
189 * 2) A rangeblock encompasing the given IP (smallest first)
190 * 3) An autoblock on the given IP
191 * @param $vagueTarget User|String also search for blocks affecting this target. Doesn't
192 * make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.
193 * @return Bool whether a relevant block was found
195 protected function newLoad( $vagueTarget = null ) {
196 $db = wfGetDB( $this->mFromMaster ? DB_MASTER
: DB_SLAVE
);
198 if( $this->type
!== null ){
200 'ipb_address' => array( (string)$this->target
),
203 $conds = array( 'ipb_address' => array() );
206 # Be aware that the != '' check is explicit, since empty values will be passed by some callers.
207 if( $vagueTarget != ''){
208 list( $target, $type ) = self
::parseTarget( $vagueTarget );
210 case self
::TYPE_USER
:
211 # Slightly wierd, but who are we to argue?
212 $conds['ipb_address'][] = (string)$target;
216 $conds['ipb_address'][] = (string)$target;
217 $conds[] = self
::getRangeCond( IP
::toHex( $target ) );
218 $conds = $db->makeList( $conds, LIST_OR
);
221 case self
::TYPE_RANGE
:
222 list( $start, $end ) = IP
::parseRange( $target );
223 $conds['ipb_address'][] = (string)$target;
224 $conds[] = self
::getRangeCond( $start, $end );
225 $conds = $db->makeList( $conds, LIST_OR
);
229 throw new MWException( "Tried to load block with invalid type" );
233 $res = $db->select( 'ipblocks', '*', $conds, __METHOD__
);
235 # This result could contain a block on the user, a block on the IP, and a russian-doll
236 # set of rangeblocks. We want to choose the most specific one, so keep a leader board.
239 # Lower will be better
240 $bestBlockScore = 100;
242 # This is begging for $this = $bestBlock, but that's not allowed in PHP :(
243 $bestBlockPreventsEdit = null;
245 foreach( $res as $row ){
246 $block = Block
::newFromRow( $row );
248 # Don't use expired blocks
249 if( $block->deleteIfExpired() ){
253 # Don't use anon only blocks on users
254 if( $this->type
== self
::TYPE_USER
&& !$block->isHardblock() ){
258 if( $block->getType() == self
::TYPE_RANGE
){
259 # This is the number of bits that are allowed to vary in the block, give
260 # or take some floating point errors
261 $end = wfBaseconvert( $block->getRangeEnd(), 16, 10 );
262 $start = wfBaseconvert( $block->getRangeStart(), 16, 10 );
263 $size = log( $end - $start +
1, 2 );
265 # This has the nice property that a /32 block is ranked equally with a
266 # single-IP block, which is exactly what it is...
267 $score = self
::TYPE_RANGE
- 1 +
( $size / 128 );
270 $score = $block->getType();
273 if( $score < $bestBlockScore ){
274 $bestBlockScore = $score;
276 $bestBlockPreventsEdit = $block->prevents( 'edit' );
280 if( $bestRow !== null ){
281 $this->initFromRow( $bestRow );
282 $this->prevents( 'edit', $bestBlockPreventsEdit );
290 * Get a set of SQL conditions which will select rangeblocks encompasing a given range
291 * @param $start String Hexadecimal IP representation
292 * @param $end String Hexadecimal IP represenation, or null to use $start = $end
295 public static function getRangeCond( $start, $end = null ) {
296 if ( $end === null ) {
299 # Per bug 14634, we want to include relevant active rangeblocks; for
300 # rangeblocks, we want to include larger ranges which enclose the given
301 # range. We know that all blocks must be smaller than $wgBlockCIDRLimit,
302 # so we can improve performance by filtering on a LIKE clause
303 $chunk = self
::getIpFragment( $start );
304 $dbr = wfGetDB( DB_SLAVE
);
305 $like = $dbr->buildLike( $chunk, $dbr->anyString() );
307 # Fairly hard to make a malicious SQL statement out of hex characters,
308 # but stranger things have happened...
309 $safeStart = $dbr->addQuotes( $start );
310 $safeEnd = $dbr->addQuotes( $end );
312 return $dbr->makeList(
314 "ipb_range_start $like",
315 "ipb_range_start <= $safeStart",
316 "ipb_range_end >= $safeEnd",
323 * Get the component of an IP address which is certain to be the same between an IP
324 * address and a rangeblock containing that IP address.
325 * @param $hex String Hexadecimal IP representation
328 protected static function getIpFragment( $hex ) {
329 global $wgBlockCIDRLimit;
330 if ( substr( $hex, 0, 3 ) == 'v6-' ) {
331 return 'v6-' . substr( substr( $hex, 3 ), 0, floor( $wgBlockCIDRLimit['IPv6'] / 4 ) );
333 return substr( $hex, 0, floor( $wgBlockCIDRLimit['IPv4'] / 4 ) );
338 * Given a database row from the ipblocks table, initialize
340 * @param $row ResultWrapper: a row from the ipblocks table
342 protected function initFromRow( $row ) {
343 $this->setTarget( $row->ipb_address
);
344 $this->setBlocker( User
::newFromId( $row->ipb_by
) );
346 $this->mReason
= $row->ipb_reason
;
347 $this->mTimestamp
= wfTimestamp( TS_MW
, $row->ipb_timestamp
);
348 $this->mAuto
= $row->ipb_auto
;
349 $this->mHideName
= $row->ipb_deleted
;
350 $this->mId
= $row->ipb_id
;
351 $this->mExpiry
= $row->ipb_expiry
;
353 $this->isHardblock( !$row->ipb_anon_only
);
354 $this->isAutoblocking( $row->ipb_enable_autoblock
);
356 $this->prevents( 'createaccount', $row->ipb_create_account
);
357 $this->prevents( 'sendemail', $row->ipb_block_email
);
358 $this->prevents( 'editownusertalk', !$row->ipb_allow_usertalk
);
362 * Create a new Block object from a database row
363 * @param $row ResultWrapper row from the ipblocks table
366 public static function newFromRow( $row ){
368 $block->initFromRow( $row );
373 * Delete the row from the IP blocks table.
377 public function delete() {
378 if ( wfReadOnly() ) {
382 if ( !$this->getId() ) {
383 throw new MWException( "Block::delete() requires that the mId member be filled\n" );
386 $dbw = wfGetDB( DB_MASTER
);
387 $dbw->delete( 'ipblocks', array( 'ipb_id' => $this->getId() ), __METHOD__
);
389 return $dbw->affectedRows() > 0;
393 * Insert a block into the block table. Will fail if there is a conflicting
394 * block (same name and options) already in the database.
396 * @param $dbw DatabaseBase if you have one available
397 * @return mixed: false on failure, assoc array on success:
398 * ('id' => block ID, 'autoIds' => array of autoblock IDs)
400 public function insert( $dbw = null ) {
401 wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
403 if ( $dbw === null ) {
404 $dbw = wfGetDB( DB_MASTER
);
407 # Don't collide with expired blocks
408 Block
::purgeExpired();
410 $ipb_id = $dbw->nextSequenceValue( 'ipblocks_ipb_id_seq' );
413 $this->getDatabaseArray(),
417 $affected = $dbw->affectedRows();
418 $this->mId
= $dbw->insertId();
421 $auto_ipd_ids = $this->doRetroactiveAutoblock();
422 return array( 'id' => $this->mId
, 'autoIds' => $auto_ipd_ids );
429 * Update a block in the DB with new parameters.
430 * The ID field needs to be loaded first.
432 * @return Int number of affected rows, which should probably be 1 or something's
435 public function update() {
436 wfDebug( "Block::update; timestamp {$this->mTimestamp}\n" );
437 $dbw = wfGetDB( DB_MASTER
);
441 $this->getDatabaseArray( $dbw ),
442 array( 'ipb_id' => $this->getId() ),
446 return $dbw->affectedRows();
450 * Get an array suitable for passing to $dbw->insert() or $dbw->update()
451 * @param $db DatabaseBase
454 protected function getDatabaseArray( $db = null ){
456 $db = wfGetDB( DB_SLAVE
);
458 $this->mExpiry
= $db->encodeExpiry( $this->mExpiry
);
461 'ipb_address' => (string)$this->target
,
462 'ipb_user' => $this->target
instanceof User ?
$this->target
->getID() : 0,
463 'ipb_by' => $this->getBlocker()->getId(),
464 'ipb_by_text' => $this->getBlocker()->getName(),
465 'ipb_reason' => $this->mReason
,
466 'ipb_timestamp' => $db->timestamp( $this->mTimestamp
),
467 'ipb_auto' => $this->mAuto
,
468 'ipb_anon_only' => !$this->isHardblock(),
469 'ipb_create_account' => $this->prevents( 'createaccount' ),
470 'ipb_enable_autoblock' => $this->isAutoblocking(),
471 'ipb_expiry' => $this->mExpiry
,
472 'ipb_range_start' => $this->getRangeStart(),
473 'ipb_range_end' => $this->getRangeEnd(),
474 'ipb_deleted' => intval( $this->mHideName
), // typecast required for SQLite
475 'ipb_block_email' => $this->prevents( 'sendemail' ),
476 'ipb_allow_usertalk' => !$this->prevents( 'editownusertalk' )
483 * Retroactively autoblocks the last IP used by the user (if it is a user)
484 * blocked by this Block.
486 * @return Array: block IDs of retroactive autoblocks made
488 protected function doRetroactiveAutoblock() {
491 $dbr = wfGetDB( DB_SLAVE
);
492 # If autoblock is enabled, autoblock the LAST IP used
493 # - stolen shamelessly from CheckUser_body.php
495 if ( $this->isAutoblocking() && $this->getType() == self
::TYPE_USER
) {
496 wfDebug( "Doing retroactive autoblocks for " . $this->getTarget() . "\n" );
498 $options = array( 'ORDER BY' => 'rc_timestamp DESC' );
499 $conds = array( 'rc_user_text' => (string)$this->getTarget() );
501 if ( $this->mAngryAutoblock
) {
502 // Block any IP used in the last 7 days. Up to five IPs.
503 $conds[] = 'rc_timestamp < ' .
504 $dbr->addQuotes( $dbr->timestamp( time() - ( 7 * 86400 ) ) );
505 $options['LIMIT'] = 5;
507 // Just the last IP used.
508 $options['LIMIT'] = 1;
511 $res = $dbr->select( 'recentchanges', array( 'rc_ip' ), $conds,
512 __METHOD__
, $options );
514 if ( !$dbr->numRows( $res ) ) {
515 # No results, don't autoblock anything
516 wfDebug( "No IP found to retroactively autoblock\n" );
518 foreach ( $res as $row ) {
520 $id = $this->doAutoblock( $row->rc_ip
);
521 if ( $id ) $blockIds[] = $id;
530 * Checks whether a given IP is on the autoblock whitelist.
531 * TODO: this probably belongs somewhere else, but not sure where...
533 * @param $ip String: The IP to check
536 public static function isWhitelistedFromAutoblocks( $ip ) {
539 // Try to get the autoblock_whitelist from the cache, as it's faster
540 // than getting the msg raw and explode()'ing it.
541 $key = wfMemcKey( 'ipb', 'autoblock', 'whitelist' );
542 $lines = $wgMemc->get( $key );
544 $lines = explode( "\n", wfMsgForContentNoTrans( 'autoblock_whitelist' ) );
545 $wgMemc->set( $key, $lines, 3600 * 24 );
548 wfDebug( "Checking the autoblock whitelist..\n" );
550 foreach ( $lines as $line ) {
552 if ( substr( $line, 0, 1 ) !== '*' ) {
556 $wlEntry = substr( $line, 1 );
557 $wlEntry = trim( $wlEntry );
559 wfDebug( "Checking $ip against $wlEntry..." );
561 # Is the IP in this range?
562 if ( IP
::isInRange( $ip, $wlEntry ) ) {
563 wfDebug( " IP $ip matches $wlEntry, not autoblocking\n" );
566 wfDebug( " No match\n" );
574 * Autoblocks the given IP, referring to this Block.
576 * @param $autoblockIP String: the IP to autoblock.
577 * @return mixed: block ID if an autoblock was inserted, false if not.
579 public function doAutoblock( $autoblockIP ) {
580 # If autoblocks are disabled, go away.
581 if ( !$this->isAutoblocking() ) {
585 # Check for presence on the autoblock whitelist.
586 if ( self
::isWhitelistedFromAutoblocks( $autoblockIP ) ) {
590 # Allow hooks to cancel the autoblock.
591 if ( !wfRunHooks( 'AbortAutoblock', array( $autoblockIP, &$this ) ) ) {
592 wfDebug( "Autoblock aborted by hook.\n" );
596 # It's okay to autoblock. Go ahead and insert/update the block...
598 # Do not add a *new* block if the IP is already blocked.
599 $ipblock = Block
::newFromTarget( $autoblockIP );
601 # Check if the block is an autoblock and would exceed the user block
602 # if renewed. If so, do nothing, otherwise prolong the block time...
603 if ( $ipblock->mAuto
&& // @TODO: why not compare $ipblock->mExpiry?
604 $this->mExpiry
> Block
::getAutoblockExpiry( $ipblock->mTimestamp
)
606 # Reset block timestamp to now and its expiry to
607 # $wgAutoblockExpiry in the future
608 $ipblock->updateTimestamp();
613 # Make a new block object with the desired properties.
614 $autoblock = new Block
;
615 wfDebug( "Autoblocking {$this->getTarget()}@" . $autoblockIP . "\n" );
616 $autoblock->setTarget( $autoblockIP );
617 $autoblock->setBlocker( $this->getBlocker() );
618 $autoblock->mReason
= wfMsgForContent( 'autoblocker', $this->getTarget(), $this->mReason
);
619 $timestamp = wfTimestampNow();
620 $autoblock->mTimestamp
= $timestamp;
621 $autoblock->mAuto
= 1;
622 $autoblock->prevents( 'createaccount', $this->prevents( 'createaccount' ) );
623 # Continue suppressing the name if needed
624 $autoblock->mHideName
= $this->mHideName
;
625 $autoblock->prevents( 'editownusertalk', $this->prevents( 'editownusertalk' ) );
627 $dbr = wfGetDB( DB_SLAVE
);
628 if ( $this->mExpiry
== $dbr->getInfinity() ) {
629 # Original block was indefinite, start an autoblock now
630 $autoblock->mExpiry
= Block
::getAutoblockExpiry( $timestamp );
632 # If the user is already blocked with an expiry date, we don't
633 # want to pile on top of that.
634 $autoblock->mExpiry
= min( $this->mExpiry
, Block
::getAutoblockExpiry( $timestamp ) );
637 # Insert the block...
638 $status = $autoblock->insert();
645 * Check if a block has expired. Delete it if it is.
648 public function deleteIfExpired() {
649 wfProfileIn( __METHOD__
);
651 if ( $this->isExpired() ) {
652 wfDebug( "Block::deleteIfExpired() -- deleting\n" );
656 wfDebug( "Block::deleteIfExpired() -- not expired\n" );
660 wfProfileOut( __METHOD__
);
665 * Has the block expired?
668 public function isExpired() {
669 $timestamp = wfTimestampNow();
670 wfDebug( "Block::isExpired() checking current " . $timestamp . " vs $this->mExpiry\n" );
672 if ( !$this->mExpiry
) {
675 return $timestamp > $this->mExpiry
;
680 * Is the block address valid (i.e. not a null string?)
683 public function isValid() {
684 return $this->getTarget() != null;
688 * Update the timestamp on autoblocks.
690 public function updateTimestamp() {
691 if ( $this->mAuto
) {
692 $this->mTimestamp
= wfTimestamp();
693 $this->mExpiry
= Block
::getAutoblockExpiry( $this->mTimestamp
);
695 $dbw = wfGetDB( DB_MASTER
);
696 $dbw->update( 'ipblocks',
698 'ipb_timestamp' => $dbw->timestamp( $this->mTimestamp
),
699 'ipb_expiry' => $dbw->timestamp( $this->mExpiry
),
702 'ipb_address' => (string)$this->getTarget()
710 * Get the IP address at the start of the range in Hex form
711 * @return String IP in Hex form
713 public function getRangeStart() {
714 switch( $this->type
) {
715 case self
::TYPE_USER
:
718 return IP
::toHex( $this->target
);
719 case self
::TYPE_RANGE
:
720 list( $start, /*...*/ ) = IP
::parseRange( $this->target
);
722 default: throw new MWException( "Block with invalid type" );
727 * Get the IP address at the start of the range in Hex form
728 * @return String IP in Hex form
730 public function getRangeEnd() {
731 switch( $this->type
) {
732 case self
::TYPE_USER
:
735 return IP
::toHex( $this->target
);
736 case self
::TYPE_RANGE
:
737 list( /*...*/, $end ) = IP
::parseRange( $this->target
);
739 default: throw new MWException( "Block with invalid type" );
744 * Get the user id of the blocking sysop
748 public function getBy() {
749 return $this->getBlocker() instanceof User
750 ?
$this->getBlocker()->getId()
755 * Get the username of the blocking sysop
759 public function getByName() {
760 return $this->getBlocker() instanceof User
761 ?
$this->getBlocker()->getName()
769 public function getId() {
774 * Get/set the SELECT ... FOR UPDATE flag
775 * @deprecated since 1.18
779 public function forUpdate( $x = null ) {
784 * Get/set a flag determining whether the master is used for reads
789 public function fromMaster( $x = null ) {
790 return wfSetVar( $this->mFromMaster
, $x );
794 * Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range
798 public function isHardblock( $x = null ) {
799 wfSetVar( $this->isHardblock
, $x );
801 # You can't *not* hardblock a user
802 return $this->getType() == self
::TYPE_USER
804 : $this->isHardblock
;
807 public function isAutoblocking( $x = null ) {
808 wfSetVar( $this->isAutoblocking
, $x );
810 # You can't put an autoblock on an IP or range as we don't have any history to
811 # look over to get more IPs from
812 return $this->getType() == self
::TYPE_USER
813 ?
$this->isAutoblocking
818 * Get/set whether the Block prevents a given action
819 * @param $action String
823 public function prevents( $action, $x = null ) {
826 # For now... <evil laugh>
829 case 'createaccount':
830 return wfSetVar( $this->mCreateAccount
, $x );
833 return wfSetVar( $this->mBlockEmail
, $x );
835 case 'editownusertalk':
836 return wfSetVar( $this->mDisableUsertalk
, $x );
844 * Get the block name, but with autoblocked IPs hidden as per standard privacy policy
845 * @return String, text is escaped
847 public function getRedactedName() {
848 if ( $this->mAuto
) {
849 return Html
::rawElement(
851 array( 'class' => 'mw-autoblockid' ),
852 wfMessage( 'autoblockid', $this->mId
)
855 return htmlspecialchars( $this->getTarget() );
860 * Encode expiry for DB
862 * @param $expiry String: timestamp for expiry, or
863 * @param $db Database object
865 * @deprecated since 1.18; use $dbw->encodeExpiry() instead
867 public static function encodeExpiry( $expiry, $db ) {
868 return $db->encodeExpiry( $expiry );
872 * Decode expiry which has come from the DB
874 * @param $expiry String: Database expiry format
875 * @param $timestampType Int Requested timestamp format
877 * @deprecated since 1.18; use $wgLang->decodeExpiry() instead
879 public static function decodeExpiry( $expiry, $timestampType = TS_MW
) {
881 return $wgContLang->formatExpiry( $expiry, $timestampType );
885 * Get a timestamp of the expiry for autoblocks
887 * @param $timestamp String|Int
890 public static function getAutoblockExpiry( $timestamp ) {
891 global $wgAutoblockExpiry;
893 return wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $timestamp ) +
$wgAutoblockExpiry );
897 * Gets rid of uneeded numbers in quad-dotted/octet IP strings
898 * For example, 127.111.113.151/24 -> 127.111.113.0/24
899 * @param $range String: IP address to normalize
901 * @deprecated since 1.18, call IP::sanitizeRange() directly
903 public static function normaliseRange( $range ) {
904 return IP
::sanitizeRange( $range );
908 * Purge expired blocks from the ipblocks table
910 public static function purgeExpired() {
911 $dbw = wfGetDB( DB_MASTER
);
912 $dbw->delete( 'ipblocks', array( 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), __METHOD__
);
916 * Get a value to insert into expiry field of the database when infinite expiry
918 * @deprecated since 1.18, call $dbr->getInfinity() directly
921 public static function infinity() {
922 return wfGetDB( DB_SLAVE
)->getInfinity();
926 * Convert a DB-encoded expiry into a real string that humans can read.
928 * @param $encoded_expiry String: Database encoded expiry time
929 * @return Html-escaped String
930 * @deprecated since 1.18; use $wgLang->formatExpiry() instead
932 public static function formatExpiry( $encoded_expiry ) {
936 if ( is_null( $msg ) ) {
938 $keys = array( 'infiniteblock', 'expiringblock' );
940 foreach ( $keys as $key ) {
941 $msg[$key] = wfMsgHtml( $key );
945 $expiry = $wgContLang->formatExpiry( $encoded_expiry, TS_MW
);
946 if ( $expiry == wfGetDB( DB_SLAVE
)->getInfinity() ) {
947 $expirystr = $msg['infiniteblock'];
950 $expiredatestr = htmlspecialchars( $wgLang->date( $expiry, true ) );
951 $expiretimestr = htmlspecialchars( $wgLang->time( $expiry, true ) );
952 $expirystr = wfMsgReplaceArgs( $msg['expiringblock'], array( $expiredatestr, $expiretimestr ) );
959 * Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute
960 * ("24 May 2034"), into an absolute timestamp we can put into the database.
961 * @param $expiry String: whatever was typed into the form
962 * @return String: timestamp or "infinity" string for th DB implementation
963 * @deprecated since 1.18 moved to SpecialBlock::parseExpiryInput()
965 public static function parseExpiryInput( $expiry ) {
966 wfDeprecated( __METHOD__
);
967 return SpecialBlock
::parseExpiryInput( $expiry );
971 * Given a target and the target's type, get an existing Block object if possible.
972 * @param $specificTarget String|User|Int a block target, which may be one of several types:
973 * * A user to block, in which case $target will be a User
974 * * An IP to block, in which case $target will be a User generated by using
975 * User::newFromName( $ip, false ) to turn off name validation
976 * * An IP range, in which case $target will be a String "123.123.123.123/18" etc
977 * * The ID of an existing block, in the format "#12345" (since pure numbers are valid
979 * Calling this with a user, IP address or range will not select autoblocks, and will
980 * only select a block where the targets match exactly (so looking for blocks on
981 * 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
982 * @param $vagueTarget String|User|Int as above, but we will search for *any* block which
983 * affects that target (so for an IP address, get ranges containing that IP; and also
984 * get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
985 * @param $fromMaster Bool whether to use the DB_MASTER database
986 * @return Block|null (null if no relevant block could be found). The target and type
987 * of the returned Block will refer to the actual block which was found, which might
988 * not be the same as the target you gave if you used $vagueTarget!
990 public static function newFromTarget( $specificTarget, $vagueTarget = null, $fromMaster = false ) {
992 list( $target, $type ) = self
::parseTarget( $specificTarget );
993 if( $type == Block
::TYPE_ID ||
$type == Block
::TYPE_AUTO
){
994 return Block
::newFromID( $target );
996 } elseif( $target === null && $vagueTarget == '' ){
997 # We're not going to find anything useful here
998 # Be aware that the == '' check is explicit, since empty values will be
999 # passed by some callers (bug 29116)
1002 } elseif( in_array( $type, array( Block
::TYPE_USER
, Block
::TYPE_IP
, Block
::TYPE_RANGE
, null ) ) ) {
1003 $block = new Block();
1004 $block->fromMaster( $fromMaster );
1006 if( $type !== null ){
1007 $block->setTarget( $target );
1010 if( $block->newLoad( $vagueTarget ) ){
1021 * From an existing Block, get the target and the type of target. Note that it is
1022 * always safe to treat the target as a string; for User objects this will return
1023 * User::__toString() which in turn gives User::getName().
1025 * @param $target String|Int|User
1026 * @return array( User|String, Block::TYPE_ constant )
1028 public static function parseTarget( $target ) {
1029 $target = trim( $target );
1031 # We may have been through this before
1032 if( $target instanceof User
){
1033 if( IP
::isValid( $target->getName() ) ){
1034 return array( $target, self
::TYPE_IP
);
1036 return array( $target, self
::TYPE_USER
);
1038 } elseif( $target === null ){
1039 return array( null, null );
1042 $userObj = User
::newFromName( $target );
1043 if ( $userObj instanceof User
) {
1044 # Note that since numbers are valid usernames, a $target of "12345" will be
1045 # considered a User. If you want to pass a block ID, prepend a hash "#12345",
1046 # since hash characters are not valid in usernames or titles generally.
1047 return array( $userObj, Block
::TYPE_USER
);
1049 } elseif ( IP
::isValid( $target ) ) {
1050 # We can still create a User if it's an IP address, but we need to turn
1051 # off validation checking (which would exclude IP addresses)
1053 User
::newFromName( IP
::sanitizeIP( $target ), false ),
1057 } elseif ( IP
::isValidBlock( $target ) ) {
1058 # Can't create a User from an IP range
1059 return array( IP
::sanitizeRange( $target ), Block
::TYPE_RANGE
);
1061 } elseif ( preg_match( '/^#\d+$/', $target ) ) {
1062 # Autoblock reference in the form "#12345"
1063 return array( substr( $target, 1 ), Block
::TYPE_AUTO
);
1067 return array( null, null );
1072 * Get the type of target for this particular block
1073 * @return Block::TYPE_ constant, will never be TYPE_ID
1075 public function getType() {
1082 * Get the target and target type for this particular Block. Note that for autoblocks,
1083 * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1084 * in this situation.
1085 * @return array( User|String, Block::TYPE_ constant )
1086 * @todo FIXME: This should be an integral part of the Block member variables
1088 public function getTargetAndType() {
1089 return array( $this->getTarget(), $this->getType() );
1093 * Get the target for this particular Block. Note that for autoblocks,
1094 * this returns the unredacted name; frontend functions need to call $block->getRedactedName()
1095 * in this situation.
1096 * @return User|String
1098 public function getTarget() {
1099 return $this->target
;
1103 * Set the target for this block, and update $this->type accordingly
1104 * @param $target Mixed
1106 public function setTarget( $target ){
1107 list( $this->target
, $this->type
) = self
::parseTarget( $target );
1111 * Get the user who implemented this block
1114 public function getBlocker(){
1115 return $this->blocker
;
1119 * Set the user who implemented (or will implement) this block
1122 public function setBlocker( User
$user ){
1123 $this->blocker
= $user;