Kill some trailing whitespace
[lhc/web/wiklou.git] / includes / User.php
index 7001ddb..8cdad6c 100644 (file)
@@ -2,14 +2,13 @@
 /**
  * See user.txt
  *
- * @package MediaWiki
  */
 
 # Number of characters in user_token field
 define( 'USER_TOKEN_LENGTH', 32 );
 
 # Serialized record version
-define( 'MW_USER_VERSION', 4 );
+define( 'MW_USER_VERSION', 5 );
 
 # Some punctuation to prevent editing from broken text-mangling proxies.
 # FIXME: this is embedded unescaped into HTML attributes in various
@@ -25,7 +24,6 @@ class PasswordError extends MWException {
 
 /**
  *
- * @package MediaWiki
  */
 class User {
 
@@ -50,6 +48,7 @@ class User {
                'editwidth',
                'watchcreations',
                'watchdefault',
+               'watchmoves',
                'watchdeletion',
                'minordefault',
                'previewontop',
@@ -65,11 +64,12 @@ class User {
                'externaldiff',
                'showjumplinks',
                'uselivepreview',
-               'autopatrol',
                'forceeditsummary',
                'watchlisthideown',
                'watchlisthidebots',
+               'watchlisthideminor',
                'ccmeonemails',
+               'diffonly',
        );
 
        /**
@@ -93,7 +93,7 @@ class User {
                'mEmailToken',
                'mEmailTokenExpires',
                'mRegistration',
-               
+               'mEditCount',
                # user_group table
                'mGroups',
        );
@@ -187,7 +187,6 @@ class User {
                # Try cache
                $key = wfMemcKey( 'user', 'id', $this->mId );
                $data = $wgMemc->get( $key );
-               
                if ( !is_array( $data ) || $data['mVersion'] < MW_USER_VERSION ) {
                        # Object is expired, load from DB
                        $data = false;
@@ -269,7 +268,7 @@ class User {
         * @static
         */
        static function newFromConfirmationCode( $code ) {
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $id = $dbr->selectField( 'user', 'user_id', array(
                        'user_email_token' => md5( $code ),
                        'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
@@ -301,7 +300,7 @@ class User {
         * @static
         */
        static function whoIs( $id ) {
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
        }
 
@@ -312,7 +311,7 @@ class User {
         * @static
         */
        static function whoIsReal( $id ) {
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), 'User::whoIsReal' );
        }
 
@@ -328,7 +327,7 @@ class User {
                        # Illegal name
                        return null;
                }
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__ );
 
                if ( $s === false ) {
@@ -351,14 +350,12 @@ class User {
         * addresses like this, if we allowed accounts like this to be created
         * new users could get the old edits of these anonymous users.
         *
-        * @bug 3631
-        *
         * @static
         * @param string $name Nickname of a user
         * @return bool
         */
        static function isIP( $name ) {
-               return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name);
+               return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || User::isIPv6($name);
                /*return preg_match("/^
                        (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
                        (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
@@ -367,6 +364,27 @@ class User {
                $/x", $name);*/
        }
 
+       /**
+        * Check if $name is an IPv6 IP.
+        */
+       static function isIPv6($name) {
+               /* 
+                * if it has any non-valid characters, it can't be a valid IPv6  
+                * address.
+                */
+               if (preg_match("/[^:a-fA-F0-9]/", $name))
+                       return false;
+
+               $parts = explode(":", $name);
+               if (count($parts) < 3)
+                       return false;
+               foreach ($parts as $part) {
+                       if (!preg_match("/^[0-9a-fA-F]{0,4}$/", $part))
+                               return false;
+               }
+               return true;
+       }
+
        /**
         * Is the input a valid username?
         *
@@ -465,7 +483,11 @@ class User {
         */
        static function isValidPassword( $password ) {
                global $wgMinimalPasswordLength;
-               return strlen( $password ) >= $wgMinimalPasswordLength;
+
+               $result = null;
+               if( !wfRunHooks( 'isValidPassword', array( $password, &$result ) ) ) return $result;
+               if ($result === false) return false; 
+               return (strlen( $password ) >= $wgMinimalPasswordLength);
        }
 
        /**
@@ -475,8 +497,7 @@ class User {
         * rejected valid addresses. Actually just check if there is '@' somewhere
         * in the given address.
         *
-        * @todo Check for RFC 2822 compilance
-        * @bug 959
+        * @todo Check for RFC 2822 compilance (bug 959)
         *
         * @param string $addr email address
         * @static
@@ -540,22 +561,45 @@ class User {
        /**
         * Count the number of edits of a user
         *
+        * It should not be static and some day should be merged as proper member function / deprecated -- domas
+        * 
         * @param int $uid The user ID to check
         * @return int
         * @static
         */
        static function edits( $uid ) {
-               $dbr =& wfGetDB( DB_SLAVE );
-               return $dbr->selectField(
-                       'revision', 'count(*)',
-                       array( 'rev_user' => $uid ),
+               wfProfileIn( __METHOD__ );
+               $dbr = wfGetDB( DB_SLAVE );
+               // check if the user_editcount field has been initialized
+               $field = $dbr->selectField(
+                       'user', 'user_editcount',
+                       array( 'user_id' => $uid ),
                        __METHOD__
                );
+
+               if( $field === null ) { // it has not been initialized. do so.
+                       $dbw = wfGetDb( DB_MASTER );
+                       $count = $dbr->selectField(
+                               'revision', 'count(*)',
+                               array( 'rev_user' => $uid ),
+                               __METHOD__
+                       );
+                       $dbw->update(
+                               'user',
+                               array( 'user_editcount' => $count ),
+                               array( 'user_id' => $uid ),
+                               __METHOD__
+                       );
+               } else {
+                       $count = $field;
+               }
+               wfProfileOut( __METHOD__ );
+               return $count;
        }
 
        /**
         * Return a random password. Sourced from mt_rand, so it's not particularly secure.
-        * @todo: hash random numbers to improve security, like generateToken()
+        * @todo hash random numbers to improve security, like generateToken()
         *
         * @return string
         * @static
@@ -698,7 +742,7 @@ class User {
                        return false;
                }
 
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_MASTER );
                $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId ), __METHOD__ );
 
                if ( $s !== false ) {
@@ -716,6 +760,8 @@ class User {
                        $this->mEmailToken = $s->user_email_token;
                        $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $s->user_email_token_expires );
                        $this->mRegistration = wfTimestampOrNull( TS_MW, $s->user_registration );
+                       $this->mEditCount = $s->user_editcount; 
+                       $this->getEditCount(); // revalidation for nulls
 
                        # Load group data
                        $res = $dbr->select( 'user_groups',
@@ -759,12 +805,12 @@ class User {
        /**
         * Combine the language default options with any site-specific options
         * and add the default language variants.
-        *
+        * Not really private cause it's called by Language class
         * @return array
         * @static
         * @private
         */
-       function getDefaultOptions() {
+       static function getDefaultOptions() {
                global $wgNamespacesToBeSearchedDefault;
                /**
                 * Site defaults will override the global/language defaults
@@ -832,9 +878,15 @@ class User {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__.": checking...\n" );
 
-               $this->mBlockedby = 0;
+               $this->mBlockedby = 0; 
+               $this->mHideName = 0;
                $ip = wfGetIP();
 
+               if ($this->isAllowed( 'ipblock-exempt' ) ) {
+                       # Exempt from all types of IP-block
+                       $ip = '';
+               }
+
                # User/IP blocking
                $this->mBlock = new Block();
                $this->mBlock->fromMaster( !$bFromSlave );
@@ -842,6 +894,7 @@ class User {
                        wfDebug( __METHOD__.": Found block.\n" );
                        $this->mBlockedby = $this->mBlock->mBy;
                        $this->mBlockreason = $this->mBlock->mReason;
+                       $this->mHideName = $this->mBlock->mHideName;
                        if ( $this->isLoggedIn() ) {
                                $this->spreadBlock();
                        }
@@ -910,6 +963,16 @@ class User {
                return $found;
        }
 
+       /**
+        * Is this user subject to rate limiting?
+        *
+        * @return bool
+        */
+       public function isPingLimitable() {
+               global $wgRateLimitsExcludedGroups;
+               return array_intersect($this->getEffectiveGroups(), $wgRateLimitsExcludedGroups) != array();
+       }
+
        /**
         * Primitive rate limits: enforce maximum actions per time period
         * to put a brake on flooding.
@@ -921,17 +984,22 @@ class User {
         * @public
         */
        function pingLimiter( $action='edit' ) {
+
+               # Call the 'PingLimiter' hook
+               $result = false;
+               if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
+                       return $result;
+               }
+
                global $wgRateLimits, $wgRateLimitsExcludedGroups;
                if( !isset( $wgRateLimits[$action] ) ) {
                        return false;
                }
-               
+
                # Some groups shouldn't trigger the ping limiter, ever
-               foreach( $this->getGroups() as $group ) {
-                       if( array_search( $group, $wgRateLimitsExcludedGroups ) !== false )
-                               return false;
-               }
-               
+               if( !$this->isPingLimitable() )
+                       return false;
+
                global $wgMemc, $wgRateLimitLog;
                wfProfileIn( __METHOD__ );
 
@@ -1005,14 +1073,13 @@ class User {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__.": enter\n" );
 
-               if ( $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
-                 $title->getNamespace() == NS_USER_TALK )
-               {
+               wfDebug( __METHOD__.": asking isBlocked()\n" );
+               $blocked = $this->isBlocked( $bFromSlave );
+               # If a user's name is suppressed, they cannot make edits anywhere
+               if ( !$this->mHideName && $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
+                 $title->getNamespace() == NS_USER_TALK ) {
                        $blocked = false;
                        wfDebug( __METHOD__.": self-talk page, ignoring any blocks\n" );
-               } else {
-                       wfDebug( __METHOD__.": asking isBlocked()\n" );
-                       $blocked = $this->isBlocked( $bFromSlave );
                }
                wfProfileOut( __METHOD__ );
                return $blocked;
@@ -1065,7 +1132,8 @@ class User {
                        if ( $this->mName === false ) {
                                $this->mName = wfGetIP();
                        }
-                       return $this->mName;
+                       # Clean up IPs
+                       return IP::sanitizeIP($this->mName);
                }
        }
 
@@ -1108,11 +1176,11 @@ class User {
                                global $wgMemc;
                                $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
                                $newtalk = $wgMemc->get( $key );
-                               if( is_integer( $newtalk ) ) {
+                               if( $newtalk != "" ) {
                                        $this->mNewtalk = (bool)$newtalk;
                                } else {
                                        $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
-                                       $wgMemc->set( $key, $this->mNewtalk, time() ); // + 1800 );
+                                       $wgMemc->set( $key, (int)$this->mNewtalk, time() + 1800 );
                                }
                        } else {
                                $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
@@ -1149,7 +1217,7 @@ class User {
         * @private
         */
        function checkNewtalk( $field, $id ) {
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $ok = $dbr->selectField( 'user_newtalk', $field,
                        array( $field => $id ), __METHOD__ );
                return $ok !== false;
@@ -1166,7 +1234,7 @@ class User {
                        wfDebug( __METHOD__." already set ($field, $id), ignoring\n" );
                        return false;
                }
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->insert( 'user_newtalk',
                        array( $field => $id ),
                        __METHOD__,
@@ -1186,7 +1254,7 @@ class User {
                        wfDebug( __METHOD__.": already gone ($field, $id), ignoring\n" );
                        return false;
                }
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'user_newtalk',
                        array( $field => $id ),
                        __METHOD__ );
@@ -1271,7 +1339,7 @@ class User {
                if( $this->mId ) {
                        $this->mTouched = self::newTouchedTimestamp();
                        
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'user',
                                array( 'user_touched' => $dbw->timestamp( $this->mTouched ) ),
                                array( 'user_id' => $this->mId ),
@@ -1325,11 +1393,23 @@ class User {
                                        $wgMinimalPasswordLength ) );
                        }
                }
-               
+
                if( !$wgAuth->setPassword( $this, $str ) ) {
                        throw new PasswordError( wfMsg( 'externaldberror' ) );
                }
                
+               $this->setInternalPassword( $str );
+
+               return true;
+       }
+
+       /**
+        * Set the password and reset the random token no matter
+        * what.
+        *
+        * @param string $str
+        */
+       function setInternalPassword( $str ) {
                $this->load();
                $this->setToken();
                
@@ -1341,10 +1421,7 @@ class User {
                }
                $this->mNewpassword = '';
                $this->mNewpassTime = null;
-               
-               return true;
        }
-
        /**
         * Set the random token (used for persistent authentication)
         * Called from loadDefaults() among other places.
@@ -1533,12 +1610,12 @@ class User {
                        if( $this->mId ) {
                                $this->mEffectiveGroups[] = 'user';
                                
-                               global $wgAutoConfirmAge;
+                               global $wgAutoConfirmAge, $wgAutoConfirmCount;
+
                                $accountAge = time() - wfTimestampOrNull( TS_UNIX, $this->mRegistration );
-                               if( $accountAge >= $wgAutoConfirmAge ) {
+                               if( $accountAge >= $wgAutoConfirmAge && $this->getEditCount() >= $wgAutoConfirmCount ) {
                                        $this->mEffectiveGroups[] = 'autoconfirmed';
                                }
-                               
                                # Implicit group for users whose email addresses are confirmed
                                global $wgEmailAuthentication;
                                if( self::isValidEmailAddr( $this->mEmail ) ) {
@@ -1553,22 +1630,38 @@ class User {
                }
                return $this->mEffectiveGroups;
        }
-
+       
+       /* Return the edit count for the user. This is where User::edits should have been */
+       function getEditCount() {
+               if ($this->mId) {
+                       if ( !isset( $this->mEditCount ) ) {
+                               /* Populate the count, if it has not been populated yet */
+                               $this->mEditCount = User::edits($this->mId);
+                       } 
+                       return $this->mEditCount;
+               } else {
+                       /* nil */
+                       return null;
+               }
+       }
+       
        /**
         * Add the user to the given group.
         * This takes immediate effect.
-        * @string $group
+        * @param string $group
         */
        function addGroup( $group ) {
                $this->load();
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbw->insert( 'user_groups',
-                       array(
-                               'ug_user'  => $this->getID(),
-                               'ug_group' => $group,
-                       ),
-                       'User::addGroup',
-                       array( 'IGNORE' ) );
+               $dbw = wfGetDB( DB_MASTER );
+               if( $this->getId() ) {
+                       $dbw->insert( 'user_groups',
+                               array(
+                                       'ug_user'  => $this->getID(),
+                                       'ug_group' => $group,
+                               ),
+                               'User::addGroup',
+                               array( 'IGNORE' ) );
+               }
 
                $this->mGroups[] = $group;
                $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) );
@@ -1579,11 +1672,11 @@ class User {
        /**
         * Remove the user from the given group.
         * This takes immediate effect.
-        * @string $group
+        * @param string $group
         */
        function removeGroup( $group ) {
                $this->load();
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->delete( 'user_groups',
                        array(
                                'ug_user'  => $this->getID(),
@@ -1697,6 +1790,11 @@ class User {
        function clearNotification( &$title ) {
                global $wgUser, $wgUseEnotif;
 
+               # Do nothing if the database is locked to writes
+               if( wfReadOnly() ) {
+                       return;
+               }
+
                if ($title->getNamespace() == NS_USER_TALK &&
                        $title->getText() == $this->getName() ) {
                        if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
@@ -1730,7 +1828,7 @@ class User {
                // If the page is watched by the user (or may be watched), update the timestamp on any
                // any matching rows
                if ( $watched ) {
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'watchlist',
                                        array( /* SET */
                                                'wl_notificationtimestamp' => NULL
@@ -1761,7 +1859,7 @@ class User {
                }
                if( $currentUser != 0 )  {
 
-                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'watchlist',
                                array( /* SET */
                                        'wl_notificationtimestamp' => NULL
@@ -1845,7 +1943,7 @@ class User {
 
        /**
         * Save object settings into database
-        * @fixme Only rarely do all these fields need to be set!
+        * @todo Only rarely do all these fields need to be set!
         */
        function saveSettings() {
                $this->load();
@@ -1854,7 +1952,7 @@ class User {
                
                $this->mTouched = self::newTouchedTimestamp();
 
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'user',
                        array( /* SET */
                                'user_name' => $this->mName,
@@ -1882,7 +1980,7 @@ class User {
                $s = trim( $this->getName() );
                if ( 0 == strcmp( '', $s ) ) return 0;
 
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ );
                if ( $id === false ) {
                        $id = 0;
@@ -1913,7 +2011,7 @@ class User {
                        $user->mOptions = $params['options'] + $user->mOptions;
                        unset( $params['options'] );
                }
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
                $fields = array(
                        'user_id' => $seqVal,
@@ -1927,6 +2025,7 @@ class User {
                        'user_options' => $user->encodeOptions(),
                        'user_token' => $user->mToken,
                        'user_registration' => $dbw->timestamp( $user->mRegistration ),
+                       'user_editcount' => 0,
                );
                foreach ( $params as $name => $value ) {
                        $fields["user_$name"] = $value;
@@ -1945,7 +2044,7 @@ class User {
         */
        function addToDatabase() {
                $this->load();
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
                $dbw->insert( 'user',
                        array(
@@ -1960,6 +2059,7 @@ class User {
                                'user_options' => $this->encodeOptions(),
                                'user_token' => $this->mToken,
                                'user_registration' => $dbw->timestamp( $this->mRegistration ),
+                               'user_editcount' => 0,
                        ), __METHOD__
                );
                $this->mId = $dbw->insertId();
@@ -2002,7 +2102,7 @@ class User {
         * @return string
         */
        function getPageRenderingHash() {
-               global $wgContLang, $wgUseDynamicDates;
+               global $wgContLang, $wgUseDynamicDates, $wgLang;
                if( $this->mHash ){
                        return $this->mHash;
                }
@@ -2016,7 +2116,7 @@ class User {
                        $confstr .= '!' . $this->getDatePreference();
                }
                $confstr .= '!' . ($this->getOption( 'numberheadings' ) ? '1' : '');
-               $confstr .= '!' . $this->getOption( 'language' );
+               $confstr .= '!' . $wgLang->getCode();
                $confstr .= '!' . $this->getOption( 'thumbsize' );
                // add in language specific options, if any
                $extra = $wgContLang->getExtraHashOptions();
@@ -2074,7 +2174,7 @@ class User {
                if ( isset( $res ) )
                        return $res;
                else {
-                       $dbr =& wfGetDB( DB_SLAVE );
+                       $dbr = wfGetDB( DB_SLAVE );
                        return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
                }
        }
@@ -2250,7 +2350,7 @@ class User {
                $token = $this->generateToken( $this->mId . $this->mEmail . $expires );
                $hash = md5( $token );
 
-               $dbw =& wfGetDB( DB_MASTER );
+               $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'user',
                        array( 'user_email_token'         => $hash,
                               'user_email_token_expires' => $dbw->timestamp( $expires ) ),
@@ -2433,7 +2533,7 @@ class User {
                if( $title ) {
                        global $wgUser;
                        $sk = $wgUser->getSkin();
-                       return $sk->makeLinkObj( $title, $text );
+                       return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
                } else {
                        return $text;
                }
@@ -2499,6 +2599,8 @@ class User {
                                        __METHOD__ );
                        }
                }
+               // edit count in user cache too
+               $this->invalidateCache();
        }
 }