Set values from query params (bug 12750)
[lhc/web/wiklou.git] / includes / Block.php
index 5645ed3..30991c5 100644 (file)
@@ -1,5 +1,6 @@
 <?php
 /**
+ * @file
  * Blocks and bans object
  */
 
 class Block
 {
        /* public*/ var $mAddress, $mUser, $mBy, $mReason, $mTimestamp, $mAuto, $mId, $mExpiry,
-                           $mRangeStart, $mRangeEnd, $mAnonOnly, $mEnableAutoblock;
-       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate, $mFromMaster, $mByName;
-       
+                               $mRangeStart, $mRangeEnd, $mAnonOnly, $mEnableAutoblock, $mHideName,
+                               $mBlockEmail, $mByName, $mAngryAutoblock;
+       /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate, $mFromMaster;
+
        const EB_KEEP_EXPIRED = 1;
        const EB_FOR_UPDATE = 2;
        const EB_RANGE_ONLY = 4;
 
        function __construct( $address = '', $user = 0, $by = 0, $reason = '',
-               $timestamp = '' , $auto = 0, $expiry = '', $anonOnly = 0, $createAccount = 0, $enableAutoblock = 0 )
+               $timestamp = '' , $auto = 0, $expiry = '', $anonOnly = 0, $createAccount = 0, $enableAutoblock = 0,
+               $hideName = 0, $blockEmail = 0 )
        {
                $this->mId = 0;
+               # Expand valid IPv6 addresses
+               $address = IP::sanitizeIP( $address );
                $this->mAddress = $address;
                $this->mUser = $user;
                $this->mBy = $by;
@@ -36,10 +41,12 @@ class Block
                $this->mCreateAccount = $createAccount;
                $this->mExpiry = self::decodeExpiry( $expiry );
                $this->mEnableAutoblock = $enableAutoblock;
-
+               $this->mHideName = $hideName;
+               $this->mBlockEmail = $blockEmail;
                $this->mForUpdate = false;
                $this->mFromMaster = false;
                $this->mByName = false;
+               $this->mAngryAutoblock = false;
                $this->initialiseRange();
        }
 
@@ -54,10 +61,10 @@ class Block
                }
        }
 
-       static function newFromID( $id ) 
+       static function newFromID( $id )
        {
-               $dbr =& wfGetDB( DB_SLAVE );
-               $res = $dbr->resultObject( $dbr->select( 'ipblocks', '*', 
+               $dbr = wfGetDB( DB_SLAVE );
+               $res = $dbr->resultObject( $dbr->select( 'ipblocks', '*',
                        array( 'ipb_id' => $id ), __METHOD__ ) );
                $block = new Block;
                if ( $block->loadFromResult( $res ) ) {
@@ -70,9 +77,9 @@ class Block
        function clear()
        {
                $this->mAddress = $this->mReason = $this->mTimestamp = '';
-               $this->mId = $this->mAnonOnly = $this->mCreateAccount = 
-                       $this->mEnableAutoblock = $this->mAuto = $this->mUser = 
-                       $this->mBy = 0;
+               $this->mId = $this->mAnonOnly = $this->mCreateAccount =
+                       $this->mEnableAutoblock = $this->mAuto = $this->mUser =
+                       $this->mBy = $this->mHideName = $this->mBlockEmail = 0;
                $this->mByName = false;
        }
 
@@ -83,14 +90,14 @@ class Block
        {
                global $wgAntiLockFlags;
                if ( $this->mForUpdate || $this->mFromMaster ) {
-                       $db =& wfGetDB( DB_MASTER );
+                       $db = wfGetDB( DB_MASTER );
                        if ( !$this->mForUpdate || ($wgAntiLockFlags & ALF_NO_BLOCK_LOCK) ) {
                                $options = array();
                        } else {
                                $options = array( 'FOR UPDATE' );
                        }
                } else {
-                       $db =& wfGetDB( DB_SLAVE );
+                       $db = wfGetDB( DB_SLAVE );
                        $options = array();
                }
                return $db;
@@ -119,7 +126,7 @@ class Block
 
                # Try user block
                if ( $user ) {
-                       $res = $db->resultObject( $db->select( 'ipblocks', '*', array( 'ipb_user' => $user ), 
+                       $res = $db->resultObject( $db->select( 'ipblocks', '*', array( 'ipb_user' => $user ),
                                __METHOD__, $options ) );
                        if ( $this->loadFromResult( $res, $killExpired ) ) {
                                return true;
@@ -145,7 +152,7 @@ class Block
                }
 
                # Try range block
-               if ( $this->loadRange( $address, $killExpired, $user == 0 ) ) {
+               if ( $this->loadRange( $address, $killExpired, $user ) ) {
                        if ( $user && $this->mAnonOnly ) {
                                $this->clear();
                                return false;
@@ -165,7 +172,7 @@ class Block
                                return true;
                        }
                }
-               
+
                # Give up
                $this->clear();
                return false;
@@ -174,7 +181,8 @@ class Block
        /**
         * Fill in member variables from a result wrapper
         */
-       function loadFromResult( ResultWrapper $res, $killExpired = true ) {
+       function loadFromResult( ResultWrapper $res, $killExpired = true )
+       {
                $ret = false;
                if ( 0 != $res->numRows() ) {
                        # Get first block
@@ -209,7 +217,7 @@ class Block
         * Search the database for any range blocks matching the given address, and
         * load the row if one is found.
         */
-       function loadRange( $address, $killExpired = true )
+       function loadRange( $address, $killExpired = true, $user = 0 )
        {
                $iaddr = IP::toHex( $address );
                if ( $iaddr === false ) {
@@ -229,6 +237,10 @@ class Block
                        "ipb_range_end >= '$iaddr'"
                );
 
+               if ( $user ) {
+                       $conds['ipb_anon_only'] = 0;
+               }
+
                $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) );
                $success = $this->loadFromResult( $res, $killExpired );
                return $success;
@@ -253,12 +265,14 @@ class Block
                $this->mAnonOnly = $row->ipb_anon_only;
                $this->mCreateAccount = $row->ipb_create_account;
                $this->mEnableAutoblock = $row->ipb_enable_autoblock;
+               $this->mBlockEmail = $row->ipb_block_email;
+               $this->mHideName = $row->ipb_deleted;
                $this->mId = $row->ipb_id;
                $this->mExpiry = self::decodeExpiry( $row->ipb_expiry );
                if ( isset( $row->user_name ) ) {
                        $this->mByName = $row->user_name;
                } else {
-                       $this->mByName = false;
+                       $this->mByName = $row->ipb_by_text;
                }
                $this->mRangeStart = $row->ipb_range_start;
                $this->mRangeEnd = $row->ipb_range_end;
@@ -284,7 +298,7 @@ class Block
 
                $block = new Block();
                if ( $flags & Block::EB_FOR_UPDATE ) {
-                       $db =& wfGetDB( DB_MASTER );
+                       $db = wfGetDB( DB_MASTER );
                        if ( $wgAntiLockFlags & ALF_NO_BLOCK_LOCK ) {
                                $options = '';
                        } else {
@@ -292,7 +306,7 @@ class Block
                        }
                        $block->forUpdate( true );
                } else {
-                       $db =& wfGetDB( DB_SLAVE );
+                       $db = wfGetDB( DB_SLAVE );
                        $options = '';
                }
                if ( $flags & Block::EB_RANGE_ONLY ) {
@@ -339,20 +353,19 @@ class Block
                        throw new MWException( "Block::delete() now requires that the mId member be filled\n" );
                }
 
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'ipblocks', array( 'ipb_id' => $this->mId ), __METHOD__ );
                return $dbw->affectedRows() > 0;
        }
 
        /**
        * Insert a block into the block table.
-       *@return Whether or not the insertion was successful.
+       * @return Whether or not the insertion was successful.
        */
        function insert()
        {
                wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbw->begin();
+               $dbw = wfGetDB( DB_MASTER );
 
                # Unset ipb_anon_only for user blocks, makes no sense
                if ( $this->mUser ) {
@@ -362,6 +375,16 @@ class Block
                # Unset ipb_enable_autoblock for IP blocks, makes no sense
                if ( !$this->mUser ) {
                        $this->mEnableAutoblock = 0;
+                       $this->mBlockEmail = 0; //Same goes for email...
+               }
+
+               if( !$this->mByName ) {
+                       if( $this->mBy ) {
+                               $this->mByName = User::whoIs( $this->mBy );
+                       } else {
+                               global $wgUser;
+                               $this->mByName = $wgUser->getName();
+                       }
                }
 
                # Don't collide with expired blocks
@@ -374,6 +397,7 @@ class Block
                                'ipb_address' => $this->mAddress,
                                'ipb_user' => $this->mUser,
                                'ipb_by' => $this->mBy,
+                               'ipb_by_text' => $this->mByName,
                                'ipb_reason' => $this->mReason,
                                'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
                                'ipb_auto' => $this->mAuto,
@@ -383,10 +407,11 @@ class Block
                                'ipb_expiry' => self::encodeExpiry( $this->mExpiry, $dbw ),
                                'ipb_range_start' => $this->mRangeStart,
                                'ipb_range_end' => $this->mRangeEnd,
+                               'ipb_deleted'   => $this->mHideName,
+                               'ipb_block_email' => $this->mBlockEmail
                        ), 'Block::insert', array( 'IGNORE' )
                );
                $affected = $dbw->affectedRows();
-               $dbw->commit();
 
                if ($affected)
                        $this->doRetroactiveAutoblock();
@@ -406,42 +431,42 @@ class Block
 
                if ($this->mEnableAutoblock && $this->mUser) {
                        wfDebug("Doing retroactive autoblocks for " . $this->mAddress . "\n");
+                       
+                       $options = array( 'ORDER BY' => 'rc_timestamp DESC' );
+                       $conds = array( 'rc_user_text' => $this->mAddress );
+                       
+                       if ($this->mAngryAutoblock) {
+                               // Block any IP used in the last 7 days. Up to five IPs.
+                               $conds[] = 'rc_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( time() - (7*86400) ) );
+                               $options['LIMIT'] = 5;
+                       } else {
+                               // Just the last IP used.
+                               $options['LIMIT'] = 1;
+                       }
 
-                       $row = $dbr->selectRow( 'recentchanges', array( 'rc_ip' ), array( 'rc_user_text' => $this->mAddress ),
-                               __METHOD__ , array( 'ORDER BY' => 'rc_timestamp DESC' ) );
+                       $res = $dbr->select( 'recentchanges', array( 'rc_ip' ), $conds,
+                               __METHOD__ ,  $options);
 
-                       if ( !$row || !$row->rc_ip ) {
+                       if ( !$dbr->numRows( $res ) ) {
                                #No results, don't autoblock anything
                                wfDebug("No IP found to retroactively autoblock\n");
                        } else {
-                               #Limit is 1, so no loop needed.
-                               $retroblockip = $row->rc_ip;
-                               return $this->doAutoblock($retroblockip);
+                               while ( $row = $dbr->fetchObject( $res ) ) {
+                                       if ( $row->rc_ip )
+                                               $this->doAutoblock( $row->rc_ip );
+                               }
                        }
                }
        }
-
+       
        /**
-       * Autoblocks the given IP, referring to this Block.
-       * @param $autoblockip The IP to autoblock.
-       * @return bool Whether or not an autoblock was inserted.
-       */
-       function doAutoblock( $autoblockip ) {
-               # Check if this IP address is already blocked
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbw->begin();
-
-               # If autoblocks are disabled, go away.
-               if ( !$this->mEnableAutoblock ) {
-                       return;
-               }
-
-               # Check for presence on the autoblock whitelist
+        * Checks whether a given IP is on the autoblock whitelist.
+        * @param string $autoblockip The IP to check
+        */
+       function isWhitelistedFromAutoblocks( $ip ) {
                # TODO cache this?
                $lines = explode( "\n", wfMsgForContentNoTrans( 'autoblock_whitelist' ) );
 
-               $ip = $autoblockip;
-
                wfDebug("Checking the autoblock whitelist..\n");
 
                foreach( $lines as $line ) {
@@ -458,13 +483,37 @@ class Block
                        # Is the IP in this range?
                        if (IP::isInRange( $ip, $wlEntry )) {
                                wfDebug(" IP $ip matches $wlEntry, not autoblocking\n");
-                               #$autoblockip = null; # Don't autoblock a whitelisted IP.
-                               return; #This /SHOULD/ introduce a dummy block - but
-                                       # I don't know a safe way to do so. -werdna
+                               return true;
                        } else {
                                wfDebug( " No match\n" );
                        }
                }
+               
+               return false;
+       }
+
+       /**
+       * Autoblocks the given IP, referring to this Block.
+       * @param string $autoblockip The IP to autoblock.
+       * @param bool $justInserted The main block was just inserted
+       * @return bool Whether or not an autoblock was inserted.
+       */
+       function doAutoblock( $autoblockip, $justInserted = false ) {
+               # If autoblocks are disabled, go away.
+               if ( !$this->mEnableAutoblock ) {
+                       return;
+               }
+
+               # Check for presence on the autoblock whitelist
+               if (Block::isWhitelistedFromAutoblocks($autoblockip)) {
+                       return;
+               }
+               
+               ## Allow hooks to cancel the autoblock.
+               if (!wfRunHooks( 'AbortAutoblock', array( $autoblockip, &$this ) )) {
+                       wfDebug( "Autoblock aborted by hook." );
+                       return false;
+               }
 
                # It's okay to autoblock. Go ahead and create/insert the block.
 
@@ -478,7 +527,9 @@ class Block
                                return;
                        }
                        # Just update the timestamp
-                       $ipblock->updateTimestamp();
+                       if ( !$justInserted ) {
+                               $ipblock->updateTimestamp();
+                       }
                        return;
                } else {
                        $ipblock = new Block;
@@ -489,10 +540,13 @@ class Block
                $ipblock->mAddress = $autoblockip;
                $ipblock->mUser = 0;
                $ipblock->mBy = $this->mBy;
+               $ipblock->mByName = $this->mByName;
                $ipblock->mReason = wfMsgForContent( 'autoblocker', $this->mAddress, $this->mReason );
                $ipblock->mTimestamp = wfTimestampNow();
                $ipblock->mAuto = 1;
                $ipblock->mCreateAccount = $this->mCreateAccount;
+               # Continue suppressing the name if needed
+               $ipblock->mHideName = $this->mHideName;
 
                # If the user is already blocked with an expiry date, we don't
                # want to pile on top of that!
@@ -542,7 +596,7 @@ class Block
                        $this->mTimestamp = wfTimestamp();
                        $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
 
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'ipblocks',
                                array( /* SET */
                                        'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
@@ -577,9 +631,6 @@ class Block
         */
        function getByName()
        {
-               if ( $this->mByName === false ) {
-                       $this->mByName = User::whoIs( $this->mBy );
-               }
                return $this->mByName;
        }
 
@@ -598,7 +649,7 @@ class Block
                        return $this->mAddress;
                }
        }
-       
+
        /**
         * Encode expiry for DB
         */
@@ -610,58 +661,120 @@ class Block
                }
        }
 
-       /** 
+       /**
         * Decode expiry which has come from the DB
         */
-       static function decodeExpiry( $expiry ) {
+       static function decodeExpiry( $expiry, $timestampType = TS_MW ) {
                if ( $expiry == '' || $expiry == Block::infinity() ) {
                        return Block::infinity();
                } else {
-                       return wfTimestamp( TS_MW, $expiry );
+                       return wfTimestamp( $timestampType, $expiry );
                }
        }
-       
+
        static function getAutoblockExpiry( $timestamp )
        {
                global $wgAutoblockExpiry;
                return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
        }
 
-       static function normaliseRange( $range )
-       {
+       /**
+        * Gets rid of uneeded numbers in quad-dotted/octet IP strings
+        * For example, 127.111.113.151/24 -> 127.111.113.0/24
+        */
+       static function normaliseRange( $range ) {
                $parts = explode( '/', $range );
                if ( count( $parts ) == 2 ) {
-                       $shift = 32 - $parts[1];
-                       $ipint = IP::toUnsigned( $parts[0] );
-                       $ipint = $ipint >> $shift << $shift;
-                       $newip = long2ip( $ipint );
-                       $range = "$newip/{$parts[1]}";
+                       // IPv6
+                       if ( IP::isIPv6($range) && $parts[1] >= 64 && $parts[1] <= 128 ) {
+                               $bits = $parts[1];
+                               $ipint = IP::toUnsigned6( $parts[0] );
+                               # Native 32 bit functions WONT work here!!!
+                               # Convert to a padded binary number
+                               $network = wfBaseConvert( $ipint, 10, 2, 128 );
+                               # Truncate the last (128-$bits) bits and replace them with zeros
+                               $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT );
+                               # Convert back to an integer
+                               $network = wfBaseConvert( $network, 2, 10 );
+                               # Reform octet address
+                               $newip = IP::toOctet( $network );
+                               $range = "$newip/{$parts[1]}";
+                       } // IPv4
+                       else if ( IP::isIPv4($range) && $parts[1] >= 16 && $parts[1] <= 32 ) {
+                               $shift = 32 - $parts[1];
+                               $ipint = IP::toUnsigned( $parts[0] );
+                               $ipint = $ipint >> $shift << $shift;
+                               $newip = long2ip( $ipint );
+                               $range = "$newip/{$parts[1]}";
+                       }
                }
                return $range;
        }
 
-       /** 
+       /**
         * Purge expired blocks from the ipblocks table
         */
        static function purgeExpired() {
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'ipblocks', array( 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), __METHOD__ );
        }
 
        static function infinity() {
-               # This is a special keyword for timestamps in PostgreSQL, and 
-               # works with CHAR(14) as well because "i" sorts after all numbers.              
+               # This is a special keyword for timestamps in PostgreSQL, and
+               # works with CHAR(14) as well because "i" sorts after all numbers.
                return 'infinity';
 
                /*
                static $infinity;
                if ( !isset( $infinity ) ) {
-                       $dbr =& wfGetDB( DB_SLAVE );
+                       $dbr = wfGetDB( DB_SLAVE );
                        $infinity = $dbr->bigTimestamp();
                }
                return $infinity;
                 */
        }
+       
+       /**
+        * Convert a DB-encoded expiry into a real string that humans can read.
+        */
+       static function formatExpiry( $encoded_expiry ) {
+       
+               static $msg = null;
+               
+               if( is_null( $msg ) ) {
+                       $msg = array();
+                       $keys = array( 'infiniteblock', 'expiringblock' );
+                       foreach( $keys as $key ) {
+                               $msg[$key] = wfMsgHtml( $key );
+                       }
+               }
+               
+               $expiry = Block::decodeExpiry( $encoded_expiry );
+               if ($expiry == 'infinity') {
+                       $expirystr = $msg['infiniteblock'];
+               } else {
+                       global $wgLang;
+                       $expiretimestr = $wgLang->timeanddate( $expiry, true );
+                       $expirystr = wfMsgReplaceArgs( $msg['expiringblock'], array($expiretimestr) );
+               }
+
+               return $expirystr;
+       }
+       
+       /**
+        * Convert a typed-in expiry time into something we can put into the database.
+        */
+       static function parseExpiryInput( $expiry_input ) {
+               if ( $expiry_input == 'infinite' || $expiry_input == 'indefinite' ) {
+                       $expiry = 'infinity';
+               } else {
+                       $expiry = strtotime( $expiry_input );
+                       if ($expiry < 0 || $expiry === false) {
+                               return false;
+                       }
+               }
+               
+               return $expiry;
+       }
 
 }
-?>