* @subpackage Parser
[lhc/web/wiklou.git] / includes / Block.php
index 823fb5a..f97cabc 100644 (file)
@@ -1,18 +1,26 @@
 <?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
-
-# Globals used: $wgBlockCache, $wgAutoblockExpiry
+/**
+ * Blocks and bans object
+ * @package MediaWiki
+ */
 
+/**
+ * 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;
@@ -25,9 +33,13 @@ 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();
@@ -46,10 +58,14 @@ class Block
                $mUser = $mBy = 0;
        }
 
-       # Get a ban from the DB, with either the given address or the given username
+       /**
+        * Get a ban from the DB, with either the given address or the given username
+        */
        function load( $address = '', $user = 0, $killExpired = true ) 
        {
+               global $wgDBmysql4 ;
                $fname = 'Block::load';
+               wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
 
                $ret = false;
                $killed = false;
@@ -68,7 +84,14 @@ class Block
                        $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
+                       # 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 {
+                       # 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";
                }
@@ -113,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();
        }       
@@ -139,7 +164,9 @@ class Block
                }
        }
        
-       # Callback with a Block object for every block
+       /**
+        * Callback with a Block object for every block
+        */
        /*static*/ function enumBlocks( $callback, $tag, $flags = 0 ) 
        {
                $block = new Block();
@@ -172,6 +199,9 @@ class Block
        function delete() 
        {
                $fname = 'Block::delete';
+               if (wfReadOnly()) {
+                       return;
+               }
                $dbw =& wfGetDB( DB_MASTER );
 
                if ( $this->mAddress == '' ) {
@@ -185,16 +215,19 @@ class Block
 
        function insert() 
        {
+               wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
                $dbw =& wfGetDB( DB_MASTER );
-               $dbw->insertArray( 'ipblocks',
+               $dbw->insert( 'ipblocks',
                        array(
                                'ipb_address' => $this->mAddress,
                                'ipb_user' => $this->mUser,
                                'ipb_by' => $this->mBy,
                                'ipb_reason' => $this->mReason,
-                               'ipb_timestamp' => $this->mTimestamp,
+                               'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
                                'ipb_auto' => $this->mAuto,
-                               'ipb_expiry' => $this->mExpiry,
+                               'ipb_expiry' => $this->mExpiry ?
+                                       $dbw->timestamp($this->mExpiry) :
+                                       $this->mExpiry,
                        ), 'Block::insert' 
                );
 
@@ -204,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 {
@@ -228,14 +264,14 @@ class Block
        function updateTimestamp() 
        {
                if ( $this->mAuto ) {
-                       $this->mTimestamp = wfTimestampNow();
+                       $this->mTimestamp = wfTimestamp();
                        $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
 
                        $dbw =& wfGetDB( DB_MASTER );
-                       $dbw->updateArray( 'ipblocks', 
+                       $dbw->update( 'ipblocks', 
                                array( /* SET */ 
-                                       'ipb_timestamp' => $this->mTimestamp,
-                                       'ipb_expiry' => $this->mExpiry,
+                                       'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
+                                       'ipb_expiry' => $dbw->timestamp($this->mExpiry),
                                ), array( /* WHERE */
                                        'ipb_address' => $this->mAddress
                                ), 'Block::updateTimestamp' 
@@ -270,7 +306,7 @@ class Block
        /* static */ function getAutoblockExpiry( $timestamp )
        {
                global $wgAutoblockExpiry;
-               return wfUnix2Timestamp( wfTimestamp2Unix( $timestamp ) + $wgAutoblockExpiry );
+               return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
        }
 
        /* static */ function normaliseRange( $range )