Introduce 'FetchChangesList' hook; see docs/hooks.txt for more information
[lhc/web/wiklou.git] / includes / Block.php
index 84b2475..26fa444 100644 (file)
@@ -4,28 +4,26 @@
  * @package MediaWiki
  */
 
-/**
- * Some globals
- */
-define ( 'EB_KEEP_EXPIRED', 1 );
-define ( 'EB_FOR_UPDATE', 2 );
-define ( 'EB_RANGE_ONLY', 4 );
-
 /**
  * The block class
  * All the functions in this class assume the object is either explicitly
  * loaded or filled. It is not load-on-demand. There are no accessors.
  *
  * To use delete(), you only need to fill $mAddress
- * Globals used: $wgBlockCache, $wgAutoblockExpiry
+ * Globals used: $wgAutoblockExpiry, $wgAntiLockFlags
  *
  * @todo This could be used everywhere, but it isn't.
  * @package MediaWiki
  */
 class Block
 {
-       /* public*/ var $mAddress, $mUser, $mBy, $mReason, $mTimestamp, $mAuto, $mId, $mExpiry;
-       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate, $mByName;
+       /* public*/ var $mAddress, $mUser, $mBy, $mReason, $mTimestamp, $mAuto, $mId, $mExpiry,
+                           $mRangeStart, $mRangeEnd;
+       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate, $mFromMaster, $mByName;
+       
+       const EB_KEEP_EXPIRED = 1;
+       const EB_FOR_UPDATE = 2;
+       const EB_RANGE_ONLY = 4;
 
        function Block( $address = '', $user = '', $by = 0, $reason = '',
                $timestamp = '' , $auto = 0, $expiry = '' )
@@ -43,6 +41,7 @@ class Block
                }
 
                $this->mForUpdate = false;
+               $this->mFromMaster = false;
                $this->mByName = false;
                $this->initialiseRange();
        }
@@ -63,19 +62,14 @@ class Block
        }
 
        /**
-        * Get a ban from the DB, with either the given address or the given username
+        * Get the DB object and set the reference parameter to the query options
         */
-       function load( $address = '', $user = 0, $killExpired = true )
+       function &getDBOptions( &$options )
        {
-               global $wgDBmysql4, $wgAntiLockFlags;
-               $fname = 'Block::load';
-               wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
-
-               $ret = false;
-               $killed = false;
-               if ( $this->forUpdate() ) {
+               global $wgAntiLockFlags;
+               if ( $this->mForUpdate || $this->mFromMaster ) {
                        $db =& wfGetDB( DB_MASTER );
-                       if ( $wgAntiLockFlags & ALF_NO_BLOCK_LOCK ) {
+                       if ( !$this->mForUpdate || ($wgAntiLockFlags & ALF_NO_BLOCK_LOCK) ) {
                                $options = '';
                        } else {
                                $options = 'FOR UPDATE';
@@ -84,16 +78,34 @@ class Block
                        $db =& wfGetDB( DB_SLAVE );
                        $options = '';
                }
+               return $db;
+       }
+
+       /**
+        * Get a ban from the DB, with either the given address or the given username
+        */
+       function load( $address = '', $user = 0, $killExpired = true )
+       {
+               $fname = 'Block::load';
+               wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
+
+               $options = '';
+               $db =& $this->getDBOptions( $options );
+
+               $ret = false;
+               $killed = false;
                $ipblocks = $db->tableName( 'ipblocks' );
 
-               if ( 0 == $user && $address=='' ) {
-                       $sql = "SELECT * from $ipblocks $options";
-               } elseif ($address=="") {
+               if ( 0 == $user && $address == '' ) {
+                       # Invalid user specification, not blocked
+                       $this->clear();
+                       return false;
+               } elseif ( $address == '' ) {
                        $sql = "SELECT * FROM $ipblocks WHERE ipb_user={$user} $options";
-               } elseif ($user=="") {
-                       $sql = "SELECT * FROM $ipblocks WHERE ipb_address='" . $db->strencode( $address ) . "' $options";
-               } elseif ( $options=='' && $wgDBmysql4 ) {
-                       # If there are no optiones (e.g. FOR UPDATE), use a UNION
+               } elseif ( $user == '' ) {
+                       $sql = "SELECT * FROM $ipblocks WHERE ipb_address=" . $db->addQuotes( $address ) . " $options";
+               } elseif ( $options == '' ) {
+                       # If there are no options (e.g. FOR UPDATE), use a UNION
                        # so that the query can make efficient use of indices
                        $sql = "SELECT * FROM $ipblocks WHERE ipb_address='" . $db->strencode( $address ) .
                                "' UNION SELECT * FROM $ipblocks WHERE ipb_user={$user}";
@@ -105,10 +117,7 @@ class Block
                }
 
                $res = $db->query( $sql, $fname );
-               if ( 0 == $db->numRows( $res ) ) {
-                       # User is not blocked
-                       $this->clear();
-               } else {
+               if ( 0 != $db->numRows( $res ) ) {
                        # Get first block
                        $row = $db->fetchObject( $res );
                        $this->initFromRow( $row );
@@ -137,9 +146,72 @@ class Block
                        }
                }
                $db->freeResult( $res );
+
+               # No blocks found yet? Try looking for range blocks
+               if ( !$ret && $address != '' ) {
+                       $ret = $this->loadRange( $address, $killExpired );
+               }
+               if ( !$ret ) {
+                       $this->clear();
+               }
+
                return $ret;
        }
 
+       /**
+        * Search the database for any range blocks matching the given address, and
+        * load the row if one is found.
+        */
+       function loadRange( $address, $killExpired = true )
+       {
+               $fname = 'Block::loadRange';
+
+               $iaddr = wfIP2Hex( $address );
+               if ( $iaddr === false ) {
+                       # Invalid address
+                       return false;
+               }
+
+               # Only scan ranges which start in this /16, this improves search speed
+               # Blocks should not cross a /16 boundary.
+               $range = substr( $iaddr, 0, 4 );
+
+               $options = '';
+               $db =& $this->getDBOptions( $options );
+               $ipblocks = $db->tableName( 'ipblocks' );
+               $sql = "SELECT * FROM $ipblocks WHERE ipb_range_start LIKE '$range%' ".
+                       "AND ipb_range_start <= '$iaddr' AND ipb_range_end >= '$iaddr' $options";
+               $res = $db->query( $sql, $fname );
+               $row = $db->fetchObject( $res );
+
+               $success = false;
+               if ( $row ) {
+                       # Found a row, initialise this object
+                       $this->initFromRow( $row );
+
+                       # Is it expired?
+                       if ( !$killExpired || !$this->deleteIfExpired() ) {
+                               # No, return true
+                               $success = true;
+                       }
+               }
+
+               $db->freeResult( $res );
+               return $success;
+       }
+
+       /**
+        * Determine if a given integer IPv4 address is in a given CIDR network
+        */
+       function isAddressInRange( $addr, $range ) {
+               list( $network, $bits ) = wfParseCIDR( $range );
+               if ( $network !== false && $addr >> ( 32 - $bits ) == $network >> ( 32 - $bits ) ) {
+                       return true;
+               } else {
+                       return false;
+               }
+       }
+
        function initFromRow( $row )
        {
                $this->mAddress = $row->ipb_address;
@@ -157,23 +229,20 @@ class Block
                } else {
                        $this->mByName = false;
                }
-
-               $this->initialiseRange();
+               $this->mRangeStart = $row->ipb_range_start;
+               $this->mRangeEnd = $row->ipb_range_end;
        }
 
        function initialiseRange()
        {
+               $this->mRangeStart = '';
+               $this->mRangeEnd = '';
                if ( $this->mUser == 0 ) {
-                       $rangeParts = explode( '/', $this->mAddress );
-                       if ( count( $rangeParts ) == 2 ) {
-                               $this->mNetworkBits = $rangeParts[1];
-                       } else {
-                               $this->mNetworkBits = 32;
+                       list( $network, $bits ) = wfParseCIDR( $this->mAddress );
+                       if ( $network !== false ) {
+                               $this->mRangeStart = sprintf( '%08X', $network );
+                               $this->mRangeEnd = sprintf( '%08X', $network + (1 << (32 - $bits)) - 1 );
                        }
-                       $this->mIntegerAddr = ip2long( $rangeParts[0] );
-               } else {
-                       $this->mNetworkBits = false;
-                       $this->mIntegerAddr = false;
                }
        }
 
@@ -186,7 +255,7 @@ class Block
                global $wgAntiLockFlags;
 
                $block = new Block();
-               if ( $flags & EB_FOR_UPDATE ) {
+               if ( $flags & Block::EB_FOR_UPDATE ) {
                        $db =& wfGetDB( DB_MASTER );
                        if ( $wgAntiLockFlags & ALF_NO_BLOCK_LOCK ) {
                                $options = '';
@@ -198,31 +267,35 @@ class Block
                        $db =& wfGetDB( DB_SLAVE );
                        $options = '';
                }
-               if ( $flags & EB_RANGE_ONLY ) {
-                       $cond = " AND ipb_address LIKE '%/%'";
+               if ( $flags & Block::EB_RANGE_ONLY ) {
+                       $cond = " AND ipb_range_start <> ''";
                } else {
                        $cond = '';
                }
 
+               $now = wfTimestampNow();
+
                extract( $db->tableNames( 'ipblocks', 'user' ) );
 
-               $sql = "SELECT ipblocks.*,user_name FROM $ipblocks,$user " .
+               $sql = "SELECT $ipblocks.*,user_name FROM $ipblocks,$user " .
                        "WHERE user_id=ipb_by $cond ORDER BY ipb_timestamp DESC $options";
-               $res = $db->query( $sql, 'Block::enumBans' );
+               $res = $db->query( $sql, 'Block::enumBlocks' );
                $num_rows = $db->numRows( $res );
 
                while ( $row = $db->fetchObject( $res ) ) {
                        $block->initFromRow( $row );
-                       if ( ( $flags & EB_RANGE_ONLY ) && $block->getNetworkBits() == 32 ) {
+                       if ( ( $flags & Block::EB_RANGE_ONLY ) && $block->mRangeStart == '' ) {
                                continue;
                        }
 
-                       if ( !( $flags & EB_KEEP_EXPIRED ) ) {
-                               if ( !$block->deleteIfExpired() ) {
-                                       $callback( $block, $tag );
+                       if ( !( $flags & Block::EB_KEEP_EXPIRED ) ) {
+                               if ( $block->mExpiry && $now > $block->mExpiry ) {
+                                       $block->delete();
+                               } else {
+                                       call_user_func( $callback, $block, $tag );
                                }
                        } else {
-                               $callback( $block, $tag );
+                               call_user_func( $callback, $block, $tag );
                        }
                }
                wfFreeResult( $res );
@@ -242,8 +315,7 @@ class Block
                } else {
                        $condition = array( 'ipb_address' => $this->mAddress );
                }
-               $dbw->delete( 'ipblocks', $condition, $fname );
-               $this->clearCache();
+               return( $dbw->delete( 'ipblocks', $condition, $fname ) > 0 ? true : false );
        }
 
        function insert()
@@ -263,22 +335,26 @@ class Block
                                'ipb_expiry' => $this->mExpiry ?
                                        $dbw->timestamp($this->mExpiry) :
                                        $this->mExpiry,
+                               'ipb_range_start' => $this->mRangeStart,
+                               'ipb_range_end' => $this->mRangeEnd,
                        ), 'Block::insert'
                );
-
-               $this->clearCache();
        }
 
        function deleteIfExpired()
        {
+               $fname = 'Block::deleteIfExpired';
+               wfProfileIn( $fname );
                if ( $this->isExpired() ) {
                        wfDebug( "Block::deleteIfExpired() -- deleting\n" );
                        $this->delete();
-                       return true;
+                       $retVal = true;
                } else {
                        wfDebug( "Block::deleteIfExpired() -- not expired\n" );
-                       return false;
+                       $retVal = false;
                }
+               wfProfileOut( $fname );
+               return $retVal;
        }
 
        function isExpired()
@@ -311,19 +387,10 @@ class Block
                                        'ipb_address' => $this->mAddress
                                ), 'Block::updateTimestamp'
                        );
-
-                       $this->clearCache();
-               }
-       }
-
-       /* private */ function clearCache()
-       {
-               global $wgBlockCache;
-               if ( is_object( $wgBlockCache ) ) {
-                       $wgBlockCache->loadFromDB();
                }
        }
 
+       /*
        function getIntegerAddr()
        {
                return $this->mIntegerAddr;
@@ -332,7 +399,7 @@ class Block
        function getNetworkBits()
        {
                return $this->mNetworkBits;
-       }
+       }*/
 
        function getByName()
        {
@@ -346,6 +413,10 @@ class Block
                return wfSetVar( $this->mForUpdate, $x );
        }
 
+       function fromMaster( $x = NULL ) {
+               return wfSetVar( $this->mFromMaster, $x );
+       }
+
        /* static */ function getAutoblockExpiry( $timestamp )
        {
                global $wgAutoblockExpiry;
@@ -357,7 +428,7 @@ class Block
                $parts = explode( '/', $range );
                if ( count( $parts ) == 2 ) {
                        $shift = 32 - $parts[1];
-                       $ipint = ip2long( $parts[0] );
+                       $ipint = wfIP2Unsigned( $parts[0] );
                        $ipint = $ipint >> $shift << $shift;
                        $newip = long2ip( $ipint );
                        $range = "$newip/{$parts[1]}";