Special:Userrights didn't recognize user as self if person didn't capitalize
[lhc/web/wiklou.git] / includes / User.php
index 2c4592f..275800f 100644 (file)
@@ -44,7 +44,7 @@ class User {
 
        /**
         * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
-         * preferences that are displayed by Special:Preferences as checkboxes.
+        * preferences that are displayed by Special:Preferences as checkboxes.
         * This list can be extended via the UserToggles hook or by
         * $wgContLang::getExtraUserToggles().
         * @showinitializer
@@ -62,7 +62,6 @@ class User {
                'editsectiononrightclick',
                'showtoc',
                'rememberpassword',
-               'editwidth',
                'watchcreations',
                'watchdefault',
                'watchmoves',
@@ -216,7 +215,7 @@ class User {
                $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
                $mLocked, $mHideName, $mOptions;
        //@}
-       
+
        static $idCacheByName = array();
 
        /**
@@ -345,7 +344,8 @@ class User {
         *    User::getCanonicalName(), except that true is accepted as an alias
         *    for 'valid', for BC.
         *
-        * @return \type{User} The User object, or null if the username is invalid. If the
+        * @return \type{User} The User object, or false if the username is invalid 
+        *    (e.g. if it contains illegal characters or is an IP address). If the
         *    username is not present in the database, the result will be a user object
         *    with a name, zero user ID and default settings.
         */
@@ -355,7 +355,7 @@ class User {
                }
                $name = self::getCanonicalName( $name, $validate );
                if ( $name === false ) {
-                       return null;
+                       return false;
                } else {
                        # Create unloaded user object
                        $u = new User;
@@ -435,7 +435,7 @@ class User {
         */
        static function whoIs( $id ) {
                $dbr = wfGetDB( DB_SLAVE );
-               return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
+               return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__ );
        }
 
        /**
@@ -599,41 +599,74 @@ class User {
         * either by batch processes or by user accounts which have
         * already been created.
         *
-        * Additional character blacklisting may be added here
-        * rather than in isValidUserName() to avoid disrupting
-        * existing accounts.
+        * Additional blacklisting may be added here rather than in 
+        * isValidUserName() to avoid disrupting existing accounts.
         *
         * @param $name \string String to match
         * @return \bool True or false
         */
        static function isCreatableName( $name ) {
                global $wgInvalidUsernameCharacters;
-               return
-                       self::isUsableName( $name ) &&
 
-                       // Registration-time character blacklisting...
-                       !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
+               // Ensure that the username isn't longer than 235 bytes, so that
+               // (at least for the builtin skins) user javascript and css files
+               // will work. (bug 23080)
+               if( strlen( $name ) > 235 ) {
+                       wfDebugLog( 'username', __METHOD__ .
+                               ": '$name' invalid due to length" );
+                       return false;
+               }
+
+               if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
+                       wfDebugLog( 'username', __METHOD__ .
+                               ": '$name' invalid due to wgInvalidUsernameCharacters" );
+                       return false;
+               }
+
+               return self::isUsableName( $name );
        }
 
        /**
         * Is the input a valid password for this user?
         *
         * @param $password String Desired password
-        * @return mixed: true on success, string of error message on failure
+        * @return bool True or false
         */
        function isValidPassword( $password ) {
+               //simple boolean wrapper for getPasswordValidity
+               return $this->getPasswordValidity( $password ) === true;
+       }
+
+       /**
+        * Given unvalidated password input, return error message on failure.
+        *
+        * @param $password String Desired password
+        * @return mixed: true on success, string of error message on failure
+        */
+       function getPasswordValidity( $password ) {
                global $wgMinimalPasswordLength, $wgContLang;
 
+               $result = false; //init $result to false for the internal checks
+
                if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
                        return $result;
 
-               // Password needs to be long enough
-               if( strlen( $password ) < $wgMinimalPasswordLength ) {
-                       return 'passwordtooshort';
-               } elseif( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName ) ) {
-                       return 'password-name-match';
-               } else {
+               if ( $result === false ) {
+                       if( strlen( $password ) < $wgMinimalPasswordLength ) {
+                               return 'passwordtooshort';
+                       } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName ) ) {
+                               return 'password-name-match';
+                       } else {
+                               //it seems weird returning true here, but this is because of the
+                               //initialization of $result to false above. If the hook is never run or it
+                               //doesn't modify $result, then we will likely get down into this if with
+                               //a valid password.
+                               return true;
+                       }
+               } elseif( $result === true ) {
                        return true;
+               } else {
+                       return $result; //the isValidPassword hook set a string $result and returned true
                }
        }
 
@@ -826,7 +859,7 @@ class User {
         * @return \bool True if the user is logged in, false otherwise.
         */
        private function loadFromSession() {
-               global $wgMemc, $wgCookiePrefix;
+               global $wgMemc, $wgCookiePrefix, $wgExternalAuthType, $wgAutocreatePolicy;
 
                $result = null;
                wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
@@ -834,6 +867,14 @@ class User {
                        return $result;
                }
 
+               if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
+                       $extUser = ExternalUser::newFromCookie();
+                       if ( $extUser ) {
+                               # TODO: Automatically create the user here (or probably a bit
+                               # lower down, in fact)
+                       }
+               }
+
                if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
                        $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
                        if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
@@ -872,6 +913,13 @@ class User {
                        return false;
                }
 
+               global $wgBlockDisablesLogin;
+               if( $wgBlockDisablesLogin && $this->isBlocked() ) {
+                       # User blocked and we've disabled blocked user logins
+                       $this->loadDefaults();
+                       return false;
+               }
+
                if ( isset( $_SESSION['wsToken'] ) ) {
                        $passwordCorrect = $_SESSION['wsToken'] == $this->mToken;
                        $from = 'session';
@@ -1023,7 +1071,7 @@ class User {
                        $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
                }
                $defOpt['skin'] = $wgDefaultSkin;
-               
+
                return $defOpt;
        }
 
@@ -1068,7 +1116,7 @@ class User {
         *                    done against master.
         */
        function getBlockedStatus( $bFromSlave = true ) {
-               global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
+               global $wgProxyWhitelist, $wgUser;
 
                if ( -1 != $this->mBlockedby ) {
                        wfDebug( "User::getBlockedStatus: already loaded.\n" );
@@ -1091,7 +1139,7 @@ class User {
 
                # Check if we are looking at an IP or a logged-in user
                if ( $this->isIP( $this->getName() ) ) {
-                       $ip = $this->getName(); 
+                       $ip = $this->getName();
                } else {
                        # Check if we are looking at the current user
                        # If we don't, and the user is logged in, we don't know about
@@ -1115,6 +1163,8 @@ class User {
                if ( $this->mBlock->load( $ip , $this->mId ) ) {
                        wfDebug( __METHOD__ . ": Found block.\n" );
                        $this->mBlockedby = $this->mBlock->mBy;
+                       if( $this->mBlockedby == 0 )
+                               $this->mBlockedby = $this->mBlock->mByName;
                        $this->mBlockreason = $this->mBlock->mReason;
                        $this->mHideName = $this->mBlock->mHideName;
                        $this->mAllowUsertalk = $this->mBlock->mAllowUsertalk;
@@ -1136,8 +1186,8 @@ class User {
                        }
 
                        # DNSBL
-                       if ( !$this->mBlockedby && $wgEnableSorbs && !$this->getID() ) {
-                               if ( $this->inSorbsBlacklist( $ip ) ) {
+                       if ( !$this->mBlockedby && !$this->getID() ) {
+                               if ( $this->isDnsBlacklisted( $ip ) ) {
                                        $this->mBlockedby = wfMsg( 'sorbs' );
                                        $this->mBlockreason = wfMsg( 'sorbsreason' );
                                }
@@ -1151,43 +1201,57 @@ class User {
        }
 
        /**
-        * Whether the given IP is in the SORBS blacklist.
+        * Whether the given IP is in a DNS blacklist.
         *
         * @param $ip \string IP to check
+        * @param $checkWhitelist Boolean: whether to check the whitelist first
         * @return \bool True if blacklisted.
         */
-       function inSorbsBlacklist( $ip ) {
-               global $wgEnableSorbs, $wgSorbsUrl;
+       function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
+               global $wgEnableSorbs, $wgEnableDnsBlacklist,
+                       $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
+
+               if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
+                       return false;
 
-               return $wgEnableSorbs &&
-                       $this->inDnsBlacklist( $ip, $wgSorbsUrl );
+               if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
+                       return false;
+
+               $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
+               return $this->inDnsBlacklist( $ip, $urls );
        }
 
        /**
         * Whether the given IP is in a given DNS blacklist.
         *
         * @param $ip \string IP to check
-        * @param $base \string URL of the DNS blacklist
+        * @param $bases \string or Array of Strings: URL of the DNS blacklist
         * @return \bool True if blacklisted.
         */
-       function inDnsBlacklist( $ip, $base ) {
+       function inDnsBlacklist( $ip, $bases ) {
                wfProfileIn( __METHOD__ );
 
                $found = false;
                $host = '';
                // FIXME: IPv6 ???  (http://bugs.php.net/bug.php?id=33170)
                if( IP::isIPv4( $ip ) ) {
-                       # Make hostname
-                       $host = "$ip.$base";
+                       # Reverse IP, bug 21255
+                       $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
 
-                       # Send query
-                       $ipList = gethostbynamel( $host );
+                       foreach( (array)$bases as $base ) {
+                               # Make hostname
+                               $host = "$ipReversed.$base";
 
-                       if( $ipList ) {
-                               wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
-                               $found = true;
-                       } else {
-                               wfDebug( "Requested $host, not found in $base.\n" );
+                               # Send query
+                               $ipList = gethostbynamel( $host );
+
+                               if( $ipList ) {
+                                       wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
+                                       $found = true;
+                                       break;
+                               } else {
+                                       wfDebug( "Requested $host, not found in $base.\n" );
+                               }
                        }
                }
 
@@ -1202,11 +1266,18 @@ class User {
         */
        public function isPingLimitable() {
                global $wgRateLimitsExcludedGroups;
+               global $wgRateLimitsExcludedIPs;
                if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
                        // Deprecated, but kept for backwards-compatibility config
                        return false;
                }
-               return !$this->isAllowed( 'noratelimit' );
+               if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
+                       // No other good way currently to disable rate limits
+                       // for specific IPs. :P
+                       // But this is a crappy hack and should die.
+                       return false;
+               }
+               return !$this->isAllowed('noratelimit');
        }
 
        /**
@@ -1284,6 +1355,7 @@ class User {
                        list( $max, $period ) = $limit;
                        $summary = "(limit $max in {$period}s)";
                        $count = $wgMemc->get( $key );
+                       // Already pinged?
                        if( $count ) {
                                if( $count > $max ) {
                                        wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" );
@@ -1296,7 +1368,7 @@ class User {
                                }
                        } else {
                                wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
-                               $wgMemc->add( $key, 1, intval( $period ) );
+                               $wgMemc->add( $key, 0, intval( $period ) ); // first ping
                        }
                        $wgMemc->incr( $key );
                }
@@ -1338,6 +1410,9 @@ class User {
                        $blocked = false;
                        wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
                }
+
+               wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
+
                wfProfileOut( __METHOD__ );
                return $blocked;
        }
@@ -1733,12 +1808,12 @@ class User {
                                throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
                        }
 
-                       $valid = $this->isValidPassword( $str );
-                       if( $valid !== true ) {
-                               global $wgMinimalPasswordLength;
+                       if( !$this->isValidPassword( $str ) ) {
+                               global $wgMinimalPasswordLength;
+                               $valid = $this->getPasswordValidity( $str );
                                throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
                                        $wgMinimalPasswordLength ) );
-                       }
+                       }
                }
 
                if( !$wgAuth->setPassword( $this, $str ) ) {
@@ -1916,6 +1991,16 @@ class User {
                }
        }
 
+       /**
+        * Get all user's options
+        *
+        * @return array
+        */
+       public function getOptions() {
+               $this->loadOptions();
+               return $this->mOptions;
+       }
+
        /**
         * Get the user's current setting for a given option, as a boolean value.
         *
@@ -2026,6 +2111,7 @@ class User {
         */
        function getEffectiveGroups( $recache = false ) {
                if ( $recache || is_null( $this->mEffectiveGroups ) ) {
+                       wfProfileIn( __METHOD__ );
                        $this->mEffectiveGroups = $this->getGroups();
                        $this->mEffectiveGroups[] = '*';
                        if( $this->getId() ) {
@@ -2039,6 +2125,7 @@ class User {
                                # Hook for additional groups
                                wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) );
                        }
+                       wfProfileOut( __METHOD__ );
                }
                return $this->mEffectiveGroups;
        }
@@ -2284,7 +2371,7 @@ class User {
                        $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'watchlist',
                                        array( /* SET */
-                                               'wl_notificationtimestamp' => NULL
+                                               'wl_notificationtimestamp' => null
                                        ), array( /* WHERE */
                                                'wl_title' => $title->getDBkey(),
                                                'wl_namespace' => $title->getNamespace(),
@@ -2311,7 +2398,7 @@ class User {
                        $dbw = wfGetDB( DB_MASTER );
                        $dbw->update( 'watchlist',
                                array( /* SET */
-                                       'wl_notificationtimestamp' => NULL
+                                       'wl_notificationtimestamp' => null
                                ), array( /* WHERE */
                                        'wl_user' => $currentUser
                                ), __METHOD__
@@ -2456,9 +2543,9 @@ class User {
                                'user_id' => $this->mId
                        ), __METHOD__
                );
-               
+
                $this->saveOptions();
-               
+
                wfRunHooks( 'UserSaveSettings', array( $this ) );
                $this->clearSharedCache();
                $this->getUserPage()->invalidateCache();
@@ -2557,7 +2644,7 @@ class User {
 
                // Clear instance cache other than user table data, which is already accurate
                $this->clearInstanceCache();
-               
+
                $this->saveOptions();
        }
 
@@ -2584,7 +2671,7 @@ class User {
         * Generate a string which will be different for any combination of
         * user options which would produce different parser output.
         * This will be used as part of the hash key for the parser cache,
-        * so users will the same options can share the same cached data
+        * so users with the same options can share the same cached data
         * safely.
         *
         * Extensions which require it should install 'PageRenderingHash' hook,
@@ -2717,7 +2804,7 @@ class User {
                // to. Certain authentication plugins do NOT want to save
                // domain passwords in a mysql database, so we should
                // check this (incase $wgAuth->strict() is false).
-               if( $this->isValidPassword( $password ) !== true ) {
+               if( !$this->isValidPassword( $password ) ) {
                        return false;
                }
 
@@ -2773,7 +2860,7 @@ class User {
                        return EDIT_TOKEN_SUFFIX;
                } else {
                        if( !isset( $_SESSION['wsEditToken'] ) ) {
-                               $token = $this->generateToken();
+                               $token = self::generateToken();
                                $_SESSION['wsEditToken'] = $token;
                        } else {
                                $token = $_SESSION['wsEditToken'];
@@ -2791,7 +2878,7 @@ class User {
         * @param $salt \string Optional salt value
         * @return \string The new random token
         */
-       function generateToken( $salt = '' ) {
+       public static function generateToken( $salt = '' ) {
                $token = dechex( mt_rand() ) . dechex( mt_rand() );
                return md5( $token . $salt );
        }
@@ -2831,9 +2918,10 @@ class User {
         * Generate a new e-mail confirmation token and send a confirmation/invalidation
         * mail to the user's given address.
         *
+        * @param $changed Boolean: whether the adress changed
         * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
         */
-       function sendConfirmationMail() {
+       function sendConfirmationMail( $changed = false ) {
                global $wgLang;
                $expiration = null; // gets passed-by-ref and defined in next line.
                $token = $this->confirmationToken( $expiration );
@@ -2841,8 +2929,9 @@ class User {
                $invalidateURL = $this->invalidationTokenUrl( $token );
                $this->saveSettings();
 
+               $message = $changed ? 'confirmemail_body_changed' : 'confirmemail_body';
                return $this->sendMail( wfMsg( 'confirmemail_subject' ),
-                       wfMsg( 'confirmemail_body',
+                       wfMsg( $message,
                                wfGetIP(),
                                $this->getName(),
                                $url,
@@ -2888,7 +2977,7 @@ class User {
                $now = time();
                $expires = $now + 7 * 24 * 60 * 60;
                $expiration = wfTimestamp( TS_MW, $expires );
-               $token = $this->generateToken( $this->mId . $this->mEmail . $expires );
+               $token = self::generateToken( $this->mId . $this->mEmail . $expires );
                $hash = md5( $token );
                $this->load();
                $this->mEmailToken = $hash;
@@ -2946,6 +3035,7 @@ class User {
         */
        function confirmEmail() {
                $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
+               wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
                return true;
        }
 
@@ -2960,6 +3050,7 @@ class User {
                $this->mEmailToken = null;
                $this->mEmailTokenExpires = null;
                $this->setEmailAuthenticationTimestamp( null );
+               wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
                return true;
        }
 
@@ -2979,8 +3070,8 @@ class User {
         * @return \bool True if allowed
         */
        function canSendEmail() {
-               global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
-               if( !$wgEnableEmail || !$wgEnableUserEmail || !$wgUser->isAllowed( 'sendemail' ) ) {
+               global $wgEnableEmail, $wgEnableUserEmail;
+               if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
                        return false;
                }
                $canSend = $this->isEmailConfirmed();
@@ -3492,18 +3583,18 @@ class User {
         * @param $byEmail Boolean: account made by email?
         */
        public function addNewUserLogEntry( $byEmail = false ) {
-               global $wgUser, $wgContLang, $wgNewUserLog;
+               global $wgUser, $wgNewUserLog;
                if( empty( $wgNewUserLog ) ) {
                        return true; // disabled
                }
-               $talk = $wgContLang->getFormattedNsText( NS_TALK );
+
                if( $this->getName() == $wgUser->getName() ) {
                        $action = 'create';
                        $message = '';
                } else {
                        $action = 'create2';
-                       $message = $byEmail 
-                               ? wfMsgForContent( 'newuserlog-byemail' ) 
+                       $message = $byEmail
+                               ? wfMsgForContent( 'newuserlog-byemail' )
                                : '';
                }
                $log = new LogPage( 'newusers' );
@@ -3521,8 +3612,8 @@ class User {
         * Used by things like CentralAuth and perhaps other authplugins.
         */
        public function addNewUserLogEntryAutoCreate() {
-               global $wgNewUserLog;
-               if( empty( $wgNewUserLog ) ) {
+               global $wgNewUserLog, $wgLogAutocreatedAccounts;
+               if( !$wgNewUserLog || !$wgLogAutocreatedAccounts ) {
                        return true; // disabled
                }
                $log = new LogPage( 'newusers', false );
@@ -3539,7 +3630,7 @@ class User {
 
                // Maybe load from the object
                if ( !is_null( $this->mOptionOverrides ) ) {
-                       wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" ); 
+                       wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
                        foreach( $this->mOptionOverrides as $key => $value ) {
                                $this->mOptions[$key] = $value;
                        }
@@ -3573,11 +3664,11 @@ class User {
 
                $this->loadOptions();
                $dbw = wfGetDB( DB_MASTER );
-               
+
                $insert_rows = array();
-               
+
                $saveOptions = $this->mOptions;
-               
+
                // Allow hooks to abort, for instance to save to a global profile.
                // Reset options to default state before saving.
                if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
@@ -3613,7 +3704,7 @@ class User {
        }
 
        /**
-        * Provide an array of HTML 5 attributes to put on an input element
+        * Provide an array of HTML5 attributes to put on an input element
         * intended for the user to enter a new password.  This may include
         * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
         *