* Documented the constructor
[lhc/web/wiklou.git] / includes / Block.php
index e5df262..f97cabc 100644 (file)
@@ -1,19 +1,30 @@
 <?php
-# Blocks and bans object
-#
-#TODO: This could be used everywhere, but it isn't.
-#
-# 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
+/**
+ * Blocks and bans object
+ * @package MediaWiki
+ */
 
-# Globals used: $wgBlockCache, $wgAutoblockExpiry
+/**
+ * Some globals
+ */
+define ( 'EB_KEEP_EXPIRED', 1 );
+define ( 'EB_FOR_UPDATE', 2 );
 
+/**
+ * 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
+ *
+ * @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;
+       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate;
        
        function Block( $address = '', $user = '', $by = 0, $reason = '', 
                $timestamp = '' , $auto = 0, $expiry = '' ) 
@@ -22,10 +33,15 @@ class Block
                $this->mUser = $user;
                $this->mBy = $by;
                $this->mReason = $reason;
-               $this->mTimestamp = $timestamp;
+               $this->mTimestamp = wfTimestamp(TS_MW,$timestamp);
                $this->mAuto = $auto;
-               $this->mExpiry = $expiry;
-
+               if( empty( $expiry ) ) {
+                       $this->mExpiry = $expiry;
+               } else {
+                       $this->mExpiry = wfTimestamp( TS_MW, $expiry );
+               }
+               
+               $this->mForUpdate = false;
                $this->initialiseRange();
        }
        
@@ -42,34 +58,51 @@ class Block
                $mUser = $mBy = 0;
        }
 
-       # Get a ban from the DB, with either the given address or the given username
-       function load( $address = "", $user = 0, $killExpired = true ) 
+       /**
+        * Get a ban from the DB, with either the given address or the given username
+        */
+       function load( $address = '', $user = 0, $killExpired = true ) 
        {
-               global $wgLoadBalancer;
-                $fname = 'Block::load';
+               global $wgDBmysql4 ;
+               $fname = 'Block::load';
+               wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
+
                $ret = false;
                $killed = false;
-               
-               if ( 0 == $user && $address=="" ) {
-                       $sql = "SELECT * from ipblocks";
+               if ( $this->forUpdate() ) {
+                       $db =& wfGetDB( DB_MASTER );
+                       $options = 'FOR UPDATE';
+               } else {
+                       $db =& wfGetDB( DB_SLAVE );
+                       $options = '';
+               }
+               $ipblocks = $db->tableName( 'ipblocks' );
+
+               if ( 0 == $user && $address=='' ) {
+                       $sql = "SELECT * from $ipblocks $options";
                } elseif ($address=="") {
-                       $sql = "SELECT * FROM ipblocks WHERE ipb_user={$user}";
+                       $sql = "SELECT * FROM $ipblocks WHERE ipb_user={$user} $options";
                } elseif ($user=="") {
-                       $sql = "SELECT * FROM ipblocks WHERE ipb_address='" . wfStrencode( $address ) . "'";
+                       $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
+                       # 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}";
                } else {
-                       $sql = "SELECT * FROM ipblocks WHERE (ipb_address='" . wfStrencode( $address ) . 
-                               "' OR ipb_user={$user})";
+                       # If there are options, a UNION can not be used, use one
+                       # SELECT instead. Will do a full table scan.
+                       $sql = "SELECT * FROM $ipblocks WHERE (ipb_address='" . $db->strencode( $address ) . 
+                               "' OR ipb_user={$user}) $options";
                }
 
-               $wgLoadBalancer->force(-1);
-                $res = wfQuery( $sql, DB_READ, $fname );
-               $wgLoadBalancer->force(0);
-                if ( 0 == wfNumRows( $res ) ) {
+               $res = $db->query( $sql, $fname );
+               if ( 0 == $db->numRows( $res ) ) {
                        # User is not blocked
                        $this->clear();
                } else {
                        # Get first block
-                       $row = wfFetchObject( $res );
+                       $row = $db->fetchObject( $res );
                        $this->initFromRow( $row );
 
                        if ( $killExpired ) {
@@ -77,7 +110,7 @@ class Block
                                do {
                                        $killed = $this->deleteIfExpired();
                                        if ( $killed ) {
-                                               $row = wfFetchObject( $res );
+                                               $row = $db->fetchObject( $res );
                                                if ( $row ) {
                                                        $this->initFromRow( $row );
                                                }
@@ -95,7 +128,7 @@ class Block
                                $ret = true;
                        }
                }
-               wfFreeResult( $res );
+               $db->freeResult( $res );
                return $ret;
        }
        
@@ -103,12 +136,14 @@ class Block
        {
                $this->mAddress = $row->ipb_address;
                $this->mReason = $row->ipb_reason;
-               $this->mTimestamp = $row->ipb_timestamp;
+               $this->mTimestamp = wfTimestamp(TS_MW,$row->ipb_timestamp);
                $this->mUser = $row->ipb_user;
                $this->mBy = $row->ipb_by;
                $this->mAuto = $row->ipb_auto;
                $this->mId = $row->ipb_id;
-               $this->mExpiry = $row->ipb_expiry;
+               $this->mExpiry = $row->ipb_expiry ?
+                       wfTimestamp(TS_MW,$row->ipb_expiry) :
+                       $row->ipb_expiry;
 
                $this->initialiseRange();
        }       
@@ -129,16 +164,28 @@ class Block
                }
        }
        
-       # Callback with a Block object for every block
-       /*static*/ function enumBlocks( $callback, $tag, $killExpired = true ) 
+       /**
+        * Callback with a Block object for every block
+        */
+       /*static*/ function enumBlocks( $callback, $tag, $flags = 0 ) 
        {
-               $sql = 'SELECT * FROM ipblocks ORDER BY ipb_timestamp DESC';
-               $res = wfQuery( $sql, DB_READ, 'Block::enumBans' );
                $block = new Block();
+               if ( $flags & EB_FOR_UPDATE ) {
+                       $db =& wfGetDB( DB_MASTER );
+                       $options = 'FOR UPDATE';
+                       $block->forUpdate( true );
+               } else {
+                       $db =& wfGetDB( DB_SLAVE );
+                       $options = '';
+               }       
+               $ipblocks = $db->tableName( 'ipblocks' );
+               
+               $sql = "SELECT * FROM $ipblocks ORDER BY ipb_timestamp DESC $options";
+               $res = $db->query( $sql, 'Block::enumBans' );
 
-               while ( $row = wfFetchObject( $res ) ) {
+               while ( $row = $db->fetchObject( $res ) ) {
                        $block->initFromRow( $row );
-                       if ( $killExpired ) {
+                       if ( !( $flags & EB_KEEP_EXPIRED ) ) {
                                if ( !$block->deleteIfExpired() ) {
                                        $callback( $block, $tag );
                                }
@@ -152,24 +199,37 @@ class Block
        function delete() 
        {
                $fname = 'Block::delete';
-               if ( $this->mAddress == "" ) {
-                       $sql = "DELETE FROM ipblocks WHERE ipb_id={$this->mId}";
-               } else {
-                       $sql = "DELETE FROM ipblocks WHERE ipb_address='" .
-                               wfStrencode( $this->mAddress ) . "'";
+               if (wfReadOnly()) {
+                       return;
                }
-               wfQuery( $sql, DB_WRITE, 'Block::delete' );
+               $dbw =& wfGetDB( DB_MASTER );
 
+               if ( $this->mAddress == '' ) {
+                       $condition = array( 'ipb_id' => $this->mId );
+               } else {
+                       $condition = array( 'ipb_address' => $this->mAddress );
+               }
+               $dbw->delete( 'ipblocks', $condition, $fname );
                $this->clearCache();
        }
 
        function insert() 
        {
-               $sql = 'INSERT INTO ipblocks ' .
-                 '(ipb_address, ipb_user, ipb_by, ipb_reason, ipb_timestamp, ipb_auto, ipb_expiry )' . 
-                 "VALUES ('" . wfStrencode( $this->mAddress ) . "', {$this->mUser}, {$this->mBy}, '" . 
-                 wfStrencode( $this->mReason ) . "','{$this->mTimestamp}', {$this->mAuto}, '{$this->mExpiry}')";
-               wfQuery( $sql, DB_WRITE, 'Block::insert' );
+               wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
+               $dbw =& wfGetDB( DB_MASTER );
+               $dbw->insert( 'ipblocks',
+                       array(
+                               'ipb_address' => $this->mAddress,
+                               'ipb_user' => $this->mUser,
+                               'ipb_by' => $this->mBy,
+                               'ipb_reason' => $this->mReason,
+                               'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
+                               'ipb_auto' => $this->mAuto,
+                               'ipb_expiry' => $this->mExpiry ?
+                                       $dbw->timestamp($this->mExpiry) :
+                                       $this->mExpiry,
+                       ), 'Block::insert' 
+               );
 
                $this->clearCache();
        }
@@ -177,15 +237,18 @@ class Block
        function deleteIfExpired() 
        {
                if ( $this->isExpired() ) {
+                       wfDebug( "Block::deleteIfExpired() -- deleting\n" );
                        $this->delete();
                        return true;
                } else {
+                       wfDebug( "Block::deleteIfExpired() -- not expired\n" );
                        return false;
                }
        }
 
        function isExpired() 
        {       
+               wfDebug( "Block::isExpired() checking current " . wfTimestampNow() . " vs $this->mExpiry\n" );
                if ( !$this->mExpiry ) {
                        return false;
                } else {
@@ -201,13 +264,18 @@ class Block
        function updateTimestamp() 
        {
                if ( $this->mAuto ) {
-                       $this->mTimestamp = wfTimestampNow();
+                       $this->mTimestamp = wfTimestamp();
                        $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
 
-                       wfQuery( 'UPDATE ipblocks SET ' .
-                               "ipb_timestamp='" . $this->mTimestamp . "', " .
-                               "ipb_expiry='" . $this->mExpiry . "' " .
-                               "WHERE ipb_address='" . wfStrencode( $this->mAddress ) . "'", DB_WRITE, 'Block::updateTimestamp' );
+                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw->update( 'ipblocks', 
+                               array( /* SET */ 
+                                       'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
+                                       'ipb_expiry' => $dbw->timestamp($this->mExpiry),
+                               ), array( /* WHERE */
+                                       'ipb_address' => $this->mAddress
+                               ), 'Block::updateTimestamp' 
+                       );
                        
                        $this->clearCache();
                }
@@ -217,7 +285,7 @@ class Block
        {
                global $wgBlockCache;
                if ( is_object( $wgBlockCache ) ) {
-                       $wgBlockCache->clear();
+                       $wgBlockCache->loadFromDB();
                }
        }
        
@@ -231,10 +299,14 @@ class Block
                return $this->mNetworkBits;
        }
 
+       function forUpdate( $x = NULL ) {
+               return wfSetVar( $this->mForUpdate, $x );
+       }
+
        /* static */ function getAutoblockExpiry( $timestamp )
        {
                global $wgAutoblockExpiry;
-               return wfUnix2Timestamp( wfTimestamp2Unix( $timestamp ) + $wgAutoblockExpiry );
+               return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
        }
 
        /* static */ function normaliseRange( $range )