<?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
+ * $Id$
+ */
-# 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 = "" )
+ 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;
- $this->mExpiry = $expiry;
-
+ $this->mExpiry = wfTimestamp(TS_MW,$expiry);
+
+ $this->mForUpdate = false;
$this->initialiseRange();
}
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 )
+ function load( $address = '', $user = 0, $killExpired = true )
{
- $fname = "Block::load";
+ $fname = 'Block::load';
+
$ret = false;
$killed = false;
-
- if ( 0 == $user ) {
- $sql = "SELECT * FROM ipblocks WHERE ipb_address='" . wfStrencode( $address ) . "'";
+ if ( $this->forUpdate() ) {
+ $db =& wfGetDB( DB_MASTER );
+ $options = 'FOR UPDATE';
} else {
- $sql = "SELECT * FROM ipblocks WHERE (ipb_address='" . wfStrencode( $address ) .
- "' OR ipb_user={$user})";
+ $db =& wfGetDB( DB_SLAVE );
+ $options = '';
}
+ $ipblocks = $db->tableName( 'ipblocks' );
- $res = wfQuery( $sql, DB_READ, $fname );
- if ( 0 == wfNumRows( $res ) ) {
+ 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";
+ } else {
+ $sql = "SELECT * FROM $ipblocks WHERE (ipb_address='" . $db->strencode( $address ) .
+ "' OR ipb_user={$user}) $options";
+ }
+
+ $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 ) {
do {
$killed = $this->deleteIfExpired();
if ( $killed ) {
- $row = wfFetchObject( $res );
+ $row = $db->fetchObject( $res );
if ( $row ) {
$this->initFromRow( $row );
}
$ret = true;
}
}
- wfFreeResult( $res );
+ $db->freeResult( $res );
return $ret;
}
{
$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 = wfTimestamp(TS_MW,$row->ipb_expiry);
$this->initialiseRange();
}
function initialiseRange()
{
if ( $this->mUser == 0 ) {
- $rangeParts = explode( "/", $this->mAddress );
+ $rangeParts = explode( '/', $this->mAddress );
if ( count( $rangeParts ) == 2 ) {
$this->mNetworkBits = $rangeParts[1];
} else {
}
# Callback with a Block object for every block
- /*static*/ function enumBlocks( $callback, $tag, $killExpired = true )
+ /*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 );
}
function delete()
{
- $fname = "Block::delete";
- if ( $this->mAddress == "" ) {
- $sql = "DELETE FROM ipblocks WHERE ipb_id={$this->mId}";
+ $fname = 'Block::delete';
+ $dbw =& wfGetDB( DB_MASTER );
+
+ if ( $this->mAddress == '' ) {
+ $condition = array( 'ipb_id' => $this->mId );
} else {
- $sql = "DELETE FROM ipblocks WHERE ipb_address='" .
- wfStrencode( $this->mAddress ) . "'";
+ $condition = array( 'ipb_address' => $this->mAddress );
}
- wfQuery( $sql, DB_WRITE, "Block::delete" );
-
+ $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" );
+ $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' => $dbw->timestamp($this->mExpiry),
+ ), 'Block::insert'
+ );
$this->clearCache();
}
if ( !$this->mExpiry ) {
return false;
} else {
- return wfTimestampNow() > $this->mExpiry;
+ return wfTimestamp() > $this->mExpiry;
}
}
function isValid()
{
- return $this->mAddress != "";
+ return $this->mAddress != '';
}
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();
}
{
global $wgBlockCache;
if ( is_object( $wgBlockCache ) ) {
- $wgBlockCache->clear();
+ $wgBlockCache->loadFromDB();
}
}
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 )
{
- $parts = explode( "/", $range );
+ $parts = explode( '/', $range );
if ( count( $parts ) == 2 ) {
$shift = 32 - $parts[1];
$ipint = ip2long( $parts[0] );