* Documented the constructor
[lhc/web/wiklou.git] / includes / Block.php
index faffc64..f97cabc 100644 (file)
-<?
-# Blocks and bans object
+<?php
+/**
+ * Blocks and bans object
+ * @package MediaWiki
+ */
 
-#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.
-
-# To use delete(), you only need to fill $mAddress
+/**
+ * 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
 {
-       var $mAddress, $mUser, $mBy, $mReason, $mTimestamp;
+       /* public*/ var $mAddress, $mUser, $mBy, $mReason, $mTimestamp, $mAuto, $mId, $mExpiry;
+       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate;
        
-       function Block( $address = "", $user = "", $by = 0, $reason = "", $timestamp = "" ) 
+       function Block( $address = '', $user = '', $by = 0, $reason = '', 
+               $timestamp = '' , $auto = 0, $expiry = '' ) 
        {
                $this->mAddress = $address;
                $this->mUser = $user;
                $this->mBy = $by;
                $this->mReason = $reason;
-               $this->mTimestamp = $timestamp;
+               $this->mTimestamp = wfTimestamp(TS_MW,$timestamp);
+               $this->mAuto = $auto;
+               if( empty( $expiry ) ) {
+                       $this->mExpiry = $expiry;
+               } else {
+                       $this->mExpiry = wfTimestamp( TS_MW, $expiry );
+               }
+               
+               $this->mForUpdate = false;
+               $this->initialiseRange();
        }
-
+       
        /*static*/ function newFromDB( $address, $user = 0, $killExpired = true ) 
        {
                $ban = new Block();
                $ban->load( $address, $user, $killExpired );
                return $ban;
        }
-               
-       function clear()
+       
+       function clear() 
        {
-               $mAddress = $mReason = $mTimestamp = "";
+               $mAddress = $mReason = $mTimestamp = '';
                $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 ) 
        {
-               $fname = "Block::load";
+               global $wgDBmysql4 ;
+               $fname = 'Block::load';
+               wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
+
                $ret = false;
                $killed = false;
-               
-               if ( 0 == $user ) {
-                       $sql = "SELECT * FROM ipblocks WHERE ipb_address='$address'";
+               if ( $this->forUpdate() ) {
+                       $db =& wfGetDB( DB_MASTER );
+                       $options = 'FOR UPDATE';
                } else {
-                       $sql = "SELECT * FROM ipblocks WHERE (ipb_address='$address' OR ipb_user={$user})";
+                       $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} $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";
                }
-               
 
-               $res = wfQuery( $sql, $fname );
-               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 ) {
-
                                # If requested, delete expired rows
                                do {
                                        $killed = $this->deleteIfExpired();
-                                       $row = wfFetchObject( $res );
+                                       if ( $killed ) {
+                                               $row = $db->fetchObject( $res );
+                                               if ( $row ) {
+                                                       $this->initFromRow( $row );
+                                               }
+                                       }
                                } while ( $killed && $row );
                                
                                # If there were any left after the killing finished, return true
-                               if ( $row == false ) {
+                               if ( !$row ) {
                                        $ret = false;
                                        $this->clear();
                                } else {
@@ -76,7 +128,7 @@ class Block
                                $ret = true;
                        }
                }
-               wfFreeResult( $res );
+               $db->freeResult( $res );
                return $ret;
        }
        
@@ -84,21 +136,56 @@ 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 ?
+                       wfTimestamp(TS_MW,$row->ipb_expiry) :
+                       $row->ipb_expiry;
+
+               $this->initialiseRange();
        }       
 
-       # Callback with a Block object for every block
-       /*static*/ function enumBlocks( $callback, $tag, $killExpired = true )
+       function initialiseRange()
+       {
+               if ( $this->mUser == 0 ) {
+                       $rangeParts = explode( '/', $this->mAddress );
+                       if ( count( $rangeParts ) == 2 ) {
+                               $this->mNetworkBits = $rangeParts[1];
+                       } else {
+                               $this->mNetworkBits = 32;
+                       }
+                       $this->mIntegerAddr = ip2long( $rangeParts[0] );
+               } else {
+                       $this->mNetworkBits = false;
+                       $this->mIntegerAddr = false;
+               }
+       }
+       
+       /**
+        * Callback with a Block object for every block
+        */
+       /*static*/ function enumBlocks( $callback, $tag, $flags = 0 ) 
        {
-               $sql = "SELECT * FROM ipblocks ORDER BY ipb_timestamp";
-               $res = wfQuery( $sql, "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 );
                                }
@@ -109,60 +196,131 @@ class Block
                wfFreeResult( $res );
        }
 
-       function delete()
+       function delete() 
        {
-               wfQuery( "DELETE FROM ipblocks WHERE ipb_address='{$this->mAddress}'", 
-                       "Block::delete" );
+               $fname = 'Block::delete';
+               if (wfReadOnly()) {
+                       return;
+               }
+               $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()
+       function insert() 
        {
-               $sql = "INSERT INTO ipblocks (ipb_address, ipb_user, ipb_by, " .
-                 "ipb_reason, ipb_timestamp ) VALUES ('{$this->mAddress}', {$this->mUser}, " .
-                 "{$this->mBy}, '" . wfStrencode( $this->mReason ) . "','{$this->mTimestamp}')";
-               wfQuery( $sql, "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();
        }
 
-       function deleteIfExpired()
+       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()
-       {
-               global $wgIPBlockExpiration, $wgUserBlockExpiration;
-               
-               $period = $this->mUser ? $wgUserBlockExpiration : $wgIPBlockExpiration;
-               
-               # Period==0 means no expiry
-               if ( !$period ) { 
+       function isExpired() 
+       {       
+               wfDebug( "Block::isExpired() checking current " . wfTimestampNow() . " vs $this->mExpiry\n" );
+               if ( !$this->mExpiry ) {
                        return false;
-               }
-               $expiry = wfTimestamp2Unix( $this->mTimestamp ) + $period;
-               $now = wfTimestamp2Unix( wfTimestampNow() );
-               if ( $now > $expiry ) {
-                       return true;
                } else {
-                       return false;
+                       return wfTimestampNow() > $this->mExpiry;
                }
        }
 
        function isValid() 
        {
-               return $this->mAddress != "";
+               return $this->mAddress != '';
        }
+       
+       function updateTimestamp() 
+       {
+               if ( $this->mAuto ) {
+                       $this->mTimestamp = wfTimestamp();
+                       $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
 
+                       $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();
+               }
+       }
+
+       /* private */ function clearCache()
+       {
+               global $wgBlockCache;
+               if ( is_object( $wgBlockCache ) ) {
+                       $wgBlockCache->loadFromDB();
+               }
+       }
+       
+       function getIntegerAddr()
+       {
+               return $this->mIntegerAddr;
+       }
        
-       function updateTimestamp()
+       function getNetworkBits()
        {
-               $sql = "UPDATE ipblocks SET ipb_timestamp='" . wfTimestampNow() . "' WHERE ipb_address='{$this->mAddress}'";
-               wfQuery( "UPDATE ipblocks SET ipb_timestamp='" . wfTimestampNow() . 
-                       "' WHERE ipb_address='{$this->mAddress}'", "Block::updateTimestamp" );
+               return $this->mNetworkBits;
+       }
+
+       function forUpdate( $x = NULL ) {
+               return wfSetVar( $this->mForUpdate, $x );
        }
+
+       /* static */ function getAutoblockExpiry( $timestamp )
+       {
+               global $wgAutoblockExpiry;
+               return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
+       }
+
+       /* static */ function normaliseRange( $range )
+       {
+               $parts = explode( '/', $range );
+               if ( count( $parts ) == 2 ) {
+                       $shift = 32 - $parts[1];
+                       $ipint = ip2long( $parts[0] );
+                       $ipint = $ipint >> $shift << $shift;
+                       $newip = long2ip( $ipint );
+                       $range = "$newip/{$parts[1]}";
+               }
+               return $range;
+       }
+
 }
 ?>