X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FUser.php;h=c56e2ffdeed6f1284efd395f55411f8ef6941fac;hb=14d2728ea69f972f1f981251708cbb0396e5f92c;hp=23938d614ad6506fde8dde22f53bede4eff94bd0;hpb=e663f9bce630dbe4d9c1a0767c751c1c92c91551;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/User.php b/includes/User.php index 23938d614a..c56e2ffdee 100644 --- a/includes/User.php +++ b/includes/User.php @@ -1,6 +1,22 @@ clearInstanceCache( 'defaults' ); } + /** + * @return String + */ function __toString(){ return $this->getName(); } @@ -218,7 +240,7 @@ class User { /** * Load the user table data for this object from the source given by mFrom. */ - function load() { + public function load() { if ( $this->mLoadedItems === true ) { return; } @@ -256,9 +278,8 @@ class User { /** * Load user table data, given mId has already been set. * @return Bool false if the ID does not exist, true otherwise - * @private */ - function loadFromId() { + public function loadFromId() { global $wgMemc; if ( $this->mId == 0 ) { $this->loadDefaults(); @@ -294,7 +315,7 @@ class User { /** * Save user data to the shared cache */ - function saveToCache() { + public function saveToCache() { $this->load(); $this->loadGroups(); $this->loadOptions(); @@ -312,7 +333,6 @@ class User { $wgMemc->set( $key, $data ); } - /** @name newFrom*() static factory methods */ //@{ @@ -332,7 +352,7 @@ class User { * username is not present in the database, the result will be a user object * with a name, zero user ID and default settings. */ - static function newFromName( $name, $validate = 'valid' ) { + public static function newFromName( $name, $validate = 'valid' ) { if ( $validate === true ) { $validate = 'valid'; } @@ -355,7 +375,7 @@ class User { * @param $id Int Valid user ID * @return User The corresponding User object */ - static function newFromId( $id ) { + public static function newFromId( $id ) { $u = new User; $u->mId = $id; $u->mFrom = 'id'; @@ -371,9 +391,9 @@ class User { * If the code is invalid or has expired, returns NULL. * * @param $code String Confirmation code - * @return User + * @return User object, or null */ - static function newFromConfirmationCode( $code ) { + public static function newFromConfirmationCode( $code ) { $dbr = wfGetDB( DB_SLAVE ); $id = $dbr->selectField( 'user', 'user_id', array( 'user_email_token' => md5( $code ), @@ -390,11 +410,14 @@ class User { * Create a new user object using data from session or cookies. If the * login credentials are invalid, the result is an anonymous user. * - * @return User + * @param $request WebRequest object to use; $wgRequest will be used if + * ommited. + * @return User object */ - static function newFromSession() { + public static function newFromSession( WebRequest $request = null ) { $user = new User; $user->mFrom = 'session'; + $user->mRequest = $request; return $user; } @@ -411,7 +434,7 @@ class User { * @param $row Array A row from the user table * @return User */ - static function newFromRow( $row ) { + public static function newFromRow( $row ) { $user = new User; $user->loadFromRow( $row ); return $user; @@ -419,13 +442,12 @@ class User { //@} - /** * Get the username corresponding to a given user ID * @param $id Int User ID - * @return String The corresponding username + * @return String|false The corresponding username */ - static function whoIs( $id ) { + public static function whoIs( $id ) { $dbr = wfGetDB( DB_SLAVE ); return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__ ); } @@ -434,9 +456,9 @@ class User { * Get the real name of a user given their user ID * * @param $id Int User ID - * @return String The corresponding user's real name + * @return String|false The corresponding user's real name */ - static function whoIsReal( $id ) { + public static function whoIsReal( $id ) { $dbr = wfGetDB( DB_SLAVE ); return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__ ); } @@ -446,7 +468,7 @@ class User { * @param $name String Username * @return Int|Null The corresponding user's ID, or null if user is nonexistent */ - static function idFromName( $name ) { + public static function idFromName( $name ) { $nt = Title::makeTitleSafe( NS_USER, $name ); if( is_null( $nt ) ) { # Illegal name @@ -498,7 +520,7 @@ class User { * @param $name String to match * @return Bool */ - static function isIP( $name ) { + public static function isIP( $name ) { return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name); } @@ -513,7 +535,7 @@ class User { * @param $name String to match * @return Bool */ - static function isValidUserName( $name ) { + public static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; if ( $name == '' @@ -526,6 +548,7 @@ class User { return false; } + // Ensure that the name can't be misresolved as a different title, // such as with extra namespace keys at the start. $parsed = Title::newFromText( $name ); @@ -567,7 +590,7 @@ class User { * @param $name String to match * @return Bool */ - static function isUsableName( $name ) { + public static function isUsableName( $name ) { global $wgReservedUsernames; // Must be a valid username, obviously ;) if ( !self::isValidUserName( $name ) ) { @@ -604,7 +627,7 @@ class User { * @param $name String to match * @return Bool */ - static function isCreatableName( $name ) { + public static function isCreatableName( $name ) { global $wgInvalidUsernameCharacters; // Ensure that the username isn't longer than 235 bytes, so that @@ -634,7 +657,7 @@ class User { * @param $password String Desired password * @return Bool */ - function isValidPassword( $password ) { + public function isValidPassword( $password ) { //simple boolean wrapper for getPasswordValidity return $this->getPasswordValidity( $password ) === true; } @@ -645,7 +668,7 @@ class User { * @param $password String Desired password * @return mixed: true on success, string or array of error message on failure */ - function getPasswordValidity( $password ) { + public function getPasswordValidity( $password ) { global $wgMinimalPasswordLength, $wgContLang; static $blockedLogins = array( @@ -707,6 +730,7 @@ class User { * @deprecated since 1.18 call Sanitizer::isValidEmail() directly */ public static function isValidEmailAddr( $addr ) { + wfDeprecated( __METHOD__, '1.18' ); return Sanitizer::validateEmail( $addr ); } @@ -719,8 +743,10 @@ class User { * - 'valid' Valid for batch processes * - 'usable' Valid for batch processes and login * - 'creatable' Valid for batch processes, login and account creation + * + * @return bool|string */ - static function getCanonicalName( $name, $validate = 'valid' ) { + public static function getCanonicalName( $name, $validate = 'valid' ) { # Force usernames to capital global $wgContLang; $name = $wgContLang->ucfirst( $name ); @@ -774,7 +800,7 @@ class User { * @param $uid Int User ID to check * @return Int the user's edit count */ - static function edits( $uid ) { + public static function edits( $uid ) { wfProfileIn( __METHOD__ ); $dbr = wfGetDB( DB_SLAVE ); // check if the user_editcount field has been initialized @@ -810,7 +836,7 @@ class User { * * @return String new random password */ - static function randomPassword() { + public static function randomPassword() { global $wgMinimalPasswordLength; $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz'; $l = strlen( $pwchars ) - 1; @@ -829,13 +855,12 @@ class User { * * @note This no longer clears uncached lazy-initialised properties; * the constructor does that instead. - * @private + * + * @param $name string */ - function loadDefaults( $name = false ) { + public function loadDefaults( $name = false ) { wfProfileIn( __METHOD__ ); - global $wgRequest; - $this->mId = 0; $this->mName = $name; $this->mRealName = ''; @@ -845,8 +870,9 @@ class User { $this->mOptionOverrides = null; $this->mOptionsLoaded = false; - if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) { - $this->mTouched = wfTimestamp( TS_MW, $wgRequest->getCookie( 'LoggedOut' ) ); + $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' ); + if( $loggedOut !== null ) { + $this->mTouched = wfTimestamp( TS_MW, $loggedOut ); } else { $this->mTouched = '0'; # Allow any pages to be cached } @@ -897,7 +923,7 @@ class User { * @return Bool True if the user is logged in, false otherwise. */ private function loadFromSession() { - global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy; + global $wgExternalAuthType, $wgAutocreatePolicy; $result = null; wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) ); @@ -913,8 +939,10 @@ class User { } } - $cookieId = $wgRequest->getCookie( 'UserID' ); - $sessId = $wgRequest->getSessionData( 'wsUserID' ); + $request = $this->getRequest(); + + $cookieId = $request->getCookie( 'UserID' ); + $sessId = $request->getSessionData( 'wsUserID' ); if ( $cookieId !== null ) { $sId = intval( $cookieId ); @@ -924,7 +952,7 @@ class User { cookie user ID ($sId) don't match!" ); return false; } - $wgRequest->setSessionData( 'wsUserID', $sId ); + $request->setSessionData( 'wsUserID', $sId ); } elseif ( $sessId !== null && $sessId != 0 ) { $sId = $sessId; } else { @@ -932,11 +960,11 @@ class User { return false; } - if ( $wgRequest->getSessionData( 'wsUserName' ) !== null ) { - $sName = $wgRequest->getSessionData( 'wsUserName' ); - } elseif ( $wgRequest->getCookie( 'UserName' ) !== null ) { - $sName = $wgRequest->getCookie( 'UserName' ); - $wgRequest->setSessionData( 'wsUserName', $sName ); + if ( $request->getSessionData( 'wsUserName' ) !== null ) { + $sName = $request->getSessionData( 'wsUserName' ); + } elseif ( $request->getCookie( 'UserName' ) !== null ) { + $sName = $request->getCookie( 'UserName' ); + $request->setSessionData( 'wsUserName', $sName ); } else { $this->loadDefaults(); return false; @@ -956,11 +984,11 @@ class User { return false; } - if ( $wgRequest->getSessionData( 'wsToken' ) !== null ) { - $passwordCorrect = $proposedUser->getToken() === $wgRequest->getSessionData( 'wsToken' ); + if ( $request->getSessionData( 'wsToken' ) !== null ) { + $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' ); $from = 'session'; - } elseif ( $wgRequest->getCookie( 'Token' ) !== null ) { - $passwordCorrect = $proposedUser->getToken() === $wgRequest->getCookie( 'Token' ); + } elseif ( $request->getCookie( 'Token' ) !== null ) { + $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' ); $from = 'cookie'; } else { # No session or persistent login cookie @@ -970,7 +998,7 @@ class User { if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) { $this->loadFromUserObject( $proposedUser ); - $wgRequest->setSessionData( 'wsToken', $this->mToken ); + $request->setSessionData( 'wsToken', $this->mToken ); wfDebug( "User: logged in from $from\n" ); return true; } else { @@ -986,9 +1014,8 @@ class User { * $this->mId must be set, this is how the user is identified. * * @return Bool True if the user exists, false if the user is anonymous - * @private */ - function loadFromDatabase() { + public function loadFromDatabase() { # Paranoia $this->mId = intval( $this->mId ); @@ -1022,9 +1049,11 @@ class User { * * @param $row Array Row from the user table to load. */ - function loadFromRow( $row ) { + public function loadFromRow( $row ) { $all = true; + $this->mGroups = null; // deferred + if ( isset( $row->user_name ) ) { $this->mName = $row->user_name; $this->mFrom = 'name'; @@ -1048,19 +1077,26 @@ class User { $all = false; } + if ( isset( $row->user_editcount ) ) { + $this->mEditCount = $row->user_editcount; + } else { + $all = false; + } + if ( isset( $row->user_password ) ) { $this->mPassword = $row->user_password; $this->mNewpassword = $row->user_newpassword; $this->mNewpassTime = wfTimestampOrNull( TS_MW, $row->user_newpass_time ); $this->mEmail = $row->user_email; - $this->decodeOptions( $row->user_options ); - $this->mTouched = wfTimestamp(TS_MW,$row->user_touched); + if ( isset( $row->user_options ) ) { + $this->decodeOptions( $row->user_options ); + } + $this->mTouched = wfTimestamp( TS_MW, $row->user_touched ); $this->mToken = $row->user_token; $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated ); $this->mEmailToken = $row->user_email_token; $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires ); $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration ); - $this->mEditCount = $row->user_editcount; } else { $all = false; } @@ -1086,9 +1122,8 @@ class User { /** * Load the groups from the database if they aren't already loaded. - * @private */ - function loadGroups() { + private function loadGroups() { if ( is_null( $this->mGroups ) ) { $dbr = wfGetDB( DB_MASTER ); $res = $dbr->select( 'user_groups', @@ -1102,20 +1137,59 @@ class User { } } + /** + * Add the user to the group if he/she meets given criteria. + * + * Contrary to autopromotion by \ref $wgAutopromote, the group will be + * possible to remove manually via Special:UserRights. In such case it + * will not be re-added automatically. The user will also not lose the + * group if they no longer meet the criteria. + * + * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria) + * + * @return array Array of groups the user has been promoted to. + * + * @see $wgAutopromoteOnce + */ + public function addAutopromoteOnceGroups( $event ) { + global $wgAutopromoteOnceLogInRC; + + $toPromote = array(); + if ( $this->getId() ) { + $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event ); + if ( count( $toPromote ) ) { + $oldGroups = $this->getGroups(); // previous groups + foreach ( $toPromote as $group ) { + $this->addGroup( $group ); + } + $newGroups = array_merge( $oldGroups, $toPromote ); // all groups + + $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ ); + $log->addEntry( 'autopromote', + $this->getUserPage(), + '', // no comment + // These group names are "list to texted"-ed in class LogPage. + array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) ) + ); + } + } + return $toPromote; + } + /** * Clear various cached data stored in this object. - * @param $reloadFrom String Reload user and user_groups table data from a + * @param $reloadFrom bool|String Reload user and user_groups table data from a * given source. May be "name", "id", "defaults", "session", or false for * no reload. */ - function clearInstanceCache( $reloadFrom = false ) { + public function clearInstanceCache( $reloadFrom = false ) { $this->mNewtalk = -1; $this->mDatePreference = null; $this->mBlockedby = -1; # Unset $this->mHash = false; - $this->mSkin = null; $this->mRights = null; $this->mEffectiveGroups = null; + $this->mImplicitGroups = null; $this->mOptions = null; if ( $reloadFrom ) { @@ -1130,17 +1204,11 @@ class User { * * @return Array of String options */ - static function getDefaultOptions() { - global $wgNamespacesToBeSearchedDefault; - /** - * Site defaults will override the global/language defaults - */ - global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin; - $defOpt = $wgDefaultUserOptions + $wgContLang->getDefaultUserOptionOverrides(); - - /** - * default language setting - */ + public static function getDefaultOptions() { + global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin; + + $defOpt = $wgDefaultUserOptions; + # default language setting $variant = $wgContLang->getDefaultVariant(); $defOpt['variant'] = $variant; $defOpt['language'] = $variant; @@ -1149,6 +1217,14 @@ class User { } $defOpt['skin'] = $wgDefaultSkin; + // FIXME: Ideally we'd cache the results of this function so the hook is only run once, + // but that breaks the parser tests because they rely on being able to change $wgContLang + // mid-request and see that change reflected in the return value of this function. + // Which is insane and would never happen during normal MW operation, but is also not + // likely to get fixed unless and until we context-ify everything. + // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275 + wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) ); + return $defOpt; } @@ -1170,13 +1246,12 @@ class User { /** * Get blocking information - * @private * @param $bFromSlave Bool Whether to check the slave database first. To * improve performance, non-critical checks are done * against slaves. Check when actually saving should be * done against master. */ - function getBlockedStatus( $bFromSlave = true ) { + private function getBlockedStatus( $bFromSlave = true ) { global $wgProxyWhitelist, $wgUser; if ( -1 != $this->mBlockedby ) { @@ -1201,7 +1276,7 @@ class User { # user is not immune to autoblocks/hardblocks, and they are the current user so we # know which IP address they're actually coming from if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) { - $ip = wfGetIP(); + $ip = $this->getRequest()->getIP(); } else { $ip = null; } @@ -1210,13 +1285,10 @@ class User { $this->mBlock = Block::newFromTarget( $this->getName(), $ip, !$bFromSlave ); if ( $this->mBlock instanceof Block ) { wfDebug( __METHOD__ . ": Found block.\n" ); - $this->mBlockedby = $this->mBlock->getBlocker()->getName(); + $this->mBlockedby = $this->mBlock->getByName(); $this->mBlockreason = $this->mBlock->mReason; $this->mHideName = $this->mBlock->mHideName; $this->mAllowUsertalk = !$this->mBlock->prevents( 'editownusertalk' ); - if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) { - $this->spreadBlock(); - } } # Proxy blocking @@ -1249,7 +1321,7 @@ class User { * @param $checkWhitelist Bool: whether to check the whitelist first * @return Bool True if blacklisted. */ - function isDnsBlacklisted( $ip, $checkWhitelist = false ) { + public function isDnsBlacklisted( $ip, $checkWhitelist = false ) { global $wgEnableSorbs, $wgEnableDnsBlacklist, $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist; @@ -1270,7 +1342,7 @@ class User { * @param $bases String|Array of Strings: URL of the DNS blacklist * @return Bool True if blacklisted. */ - function inDnsBlacklist( $ip, $bases ) { + public function inDnsBlacklist( $ip, $bases ) { wfProfileIn( __METHOD__ ); $found = false; @@ -1281,7 +1353,17 @@ class User { foreach( (array)$bases as $base ) { # Make hostname - $host = "$ipReversed.$base"; + # If we have an access key, use that too (ProjectHoneypot, etc.) + if( is_array( $base ) ) { + if( count( $base ) >= 2 ) { + # Access key is 1, base URL is 0 + $host = "{$base[1]}.$ipReversed.{$base[0]}"; + } else { + $host = "$ipReversed.{$base[0]}"; + } + } else { + $host = "$ipReversed.$base"; + } # Send query $ipList = gethostbynamel( $host ); @@ -1302,6 +1384,9 @@ class User { /** * Check if an IP address is in the local proxy list + * + * @param $ip string + * * @return bool */ public static function isLocallyBlockedProxy( $ip ) { @@ -1338,7 +1423,7 @@ class User { */ public function isPingLimitable() { global $wgRateLimitsExcludedIPs; - if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) { + if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) { // No other good way currently to disable rate limits // for specific IPs. :P // But this is a crappy hack and should die. @@ -1357,7 +1442,7 @@ class User { * @param $action String Action to enforce; 'edit' if unspecified * @return Bool True if a rate limiter was tripped */ - function pingLimiter( $action = 'edit' ) { + public function pingLimiter( $action = 'edit' ) { # Call the 'PingLimiter' hook $result = false; if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) { @@ -1379,7 +1464,7 @@ class User { $limits = $wgRateLimits[$action]; $keys = array(); $id = $this->getId(); - $ip = wfGetIP(); + $ip = $this->getRequest()->getIP(); $userLimit = false; if( isset( $limits['anon'] ) && $id == 0 ) { @@ -1427,7 +1512,9 @@ class User { if( $count > $max ) { wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" ); if( $wgRateLimitLog ) { - @file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND ); + wfSuppressWarnings(); + file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND ); + wfRestoreWarnings(); } $triggered = true; } else { @@ -1450,9 +1537,19 @@ class User { * @param $bFromSlave Bool Whether to check the slave database instead of the master * @return Bool True if blocked, false otherwise */ - function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site + public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site + return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' ); + } + + /** + * Get the block affecting the user, or null if the user is not blocked + * + * @param $bFromSlave Bool Whether to check the slave database instead of the master + * @return Block|null + */ + public function getBlock( $bFromSlave = true ){ $this->getBlockedStatus( $bFromSlave ); - return $this->mBlock instanceof Block && $this->mBlock->prevents( 'edit' ); + return $this->mBlock instanceof Block ? $this->mBlock : null; } /** @@ -1485,7 +1582,7 @@ class User { * If user is blocked, return the name of the user who placed the block * @return String name of blocker */ - function blockedBy() { + public function blockedBy() { $this->getBlockedStatus(); return $this->mBlockedby; } @@ -1494,7 +1591,7 @@ class User { * If user is blocked, return the specified reason for the block * @return String Blocking reason */ - function blockedFor() { + public function blockedFor() { $this->getBlockedStatus(); return $this->mBlockreason; } @@ -1503,7 +1600,7 @@ class User { * If user is blocked, return the ID for the block * @return Int Block ID */ - function getBlockId() { + public function getBlockId() { $this->getBlockedStatus(); return ( $this->mBlock ? $this->mBlock->getId() : false ); } @@ -1516,7 +1613,7 @@ class User { * @param $ip String IP address, uses current client if none given * @return Bool True if blocked, false otherwise */ - function isBlockedGlobally( $ip = '' ) { + public function isBlockedGlobally( $ip = '' ) { if( $this->mBlockedGlobally !== null ) { return $this->mBlockedGlobally; } @@ -1524,7 +1621,7 @@ class User { if( IP::isIPAddress( $this->getName() ) ) { $ip = $this->getName(); } elseif( !$ip ) { - $ip = wfGetIP(); + $ip = $this->getRequest()->getIP(); } $blocked = false; wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) ); @@ -1537,7 +1634,7 @@ class User { * * @return Bool True if locked, false otherwise */ - function isLocked() { + public function isLocked() { if( $this->mLocked !== null ) { return $this->mLocked; } @@ -1552,7 +1649,7 @@ class User { * * @return Bool True if hidden, false otherwise */ - function isHidden() { + public function isHidden() { if( $this->mHideName !== null ) { return $this->mHideName; } @@ -1569,7 +1666,7 @@ class User { * Get the user's ID. * @return Int The user's ID; 0 if the user is anonymous or nonexistent */ - function getId() { + public function getId() { if( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) { // Special case, we know the user is anonymous @@ -1585,7 +1682,7 @@ class User { * Set the user and reload all fields according to a given ID * @param $v Int User ID to reload */ - function setId( $v ) { + public function setId( $v ) { $this->mId = $v; $this->clearInstanceCache( 'id' ); } @@ -1594,7 +1691,7 @@ class User { * Get the user name, or the IP of an anonymous user * @return String User's name or IP address */ - function getName() { + public function getName() { if ( $this->isItemLoaded( 'name', 'only' ) ) { # Special case optimisation return $this->mName; @@ -1602,7 +1699,7 @@ class User { $this->load(); if ( $this->mName === false ) { # Clean up IPs - $this->mName = IP::sanitizeIP( wfGetIP() ); + $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() ); } return $this->mName; } @@ -1621,7 +1718,7 @@ class User { * does not exist. * @param $str String New user name to set */ - function setName( $str ) { + public function setName( $str ) { $this->load(); $this->mName = $str; } @@ -1630,7 +1727,7 @@ class User { * Get the user's name escaped by underscores. * @return String Username escaped by underscores. */ - function getTitleKey() { + public function getTitleKey() { return str_replace( ' ', '_', $this->getName() ); } @@ -1638,7 +1735,7 @@ class User { * Check if the user has new messages. * @return Bool True if the user has new messages */ - function getNewtalk() { + public function getNewtalk() { $this->load(); # Load the newtalk status if it is unloaded (mNewtalk=-1) @@ -1671,7 +1768,7 @@ class User { * Return the talk page(s) this user has new messages on. * @return Array of String page URLs */ - function getNewMessageLinks() { + public function getNewMessageLinks() { $talks = array(); if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) return $talks; @@ -1748,7 +1845,7 @@ class User { * Update the 'You have new messages!' status. * @param $val Bool Whether the user has new messages */ - function setNewtalk( $val ) { + public function setNewtalk( $val ) { if( wfReadOnly() ) { return; } @@ -1812,7 +1909,7 @@ class User { * Updates user_touched field, and removes account data from memcached * for reload on the next hit. */ - function invalidateCache() { + public function invalidateCache() { if( wfReadOnly() ) { return; } @@ -1833,8 +1930,10 @@ class User { /** * Validate the cache for this account. * @param $timestamp String A timestamp in TS_MW format + * + * @return bool */ - function validateCache( $timestamp ) { + public function validateCache( $timestamp ) { $this->load(); return ( $timestamp >= $this->mTouched ); } @@ -1843,7 +1942,7 @@ class User { * Get the user touched timestamp * @return String timestamp */ - function getTouched() { + public function getTouched() { $this->load(); return $this->mTouched; } @@ -1861,8 +1960,10 @@ class User { * * @param $str String New password to set * @throws PasswordError on failure + * + * @return bool */ - function setPassword( $str ) { + public function setPassword( $str ) { global $wgAuth; if( $str !== null ) { @@ -1898,7 +1999,7 @@ class User { * * @param $str String New password to set */ - function setInternalPassword( $str ) { + public function setInternalPassword( $str ) { $this->load(); $this->setToken(); @@ -1916,7 +2017,7 @@ class User { * Get the user's current token. * @return String Token */ - function getToken() { + public function getToken() { $this->load(); return $this->mToken; } @@ -1925,10 +2026,9 @@ class User { * Set the random token (used for persistent authentication) * Called from loadDefaults() among other places. * - * @param $token String If specified, set the token to this value - * @private + * @param $token String|bool If specified, set the token to this value */ - function setToken( $token = false ) { + public function setToken( $token = false ) { global $wgSecretKey, $wgProxyKey; $this->load(); if ( !$token ) { @@ -1949,9 +2049,8 @@ class User { * Set the cookie password * * @param $str String New cookie password - * @private */ - function setCookiePassword( $str ) { + private function setCookiePassword( $str ) { $this->load(); $this->mCookiePassword = md5( $str ); } @@ -1962,7 +2061,7 @@ class User { * @param $str String New password to set * @param $throttle Bool If true, reset the throttle timestamp to the present */ - function setNewpassword( $str, $throttle = true ) { + public function setNewpassword( $str, $throttle = true ) { $this->load(); $this->mNewpassword = self::crypt( $str ); if ( $throttle ) { @@ -1975,7 +2074,7 @@ class User { * $wgPasswordReminderResendTime hours? * @return Bool */ - function isPasswordReminderThrottled() { + public function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; $this->load(); if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) { @@ -1989,7 +2088,7 @@ class User { * Get the user's e-mail address * @return String User's email address */ - function getEmail() { + public function getEmail() { $this->load(); wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail ) ); return $this->mEmail; @@ -1999,7 +2098,7 @@ class User { * Get the timestamp of the user's e-mail authentication * @return String TS_MW timestamp */ - function getEmailAuthenticationTimestamp() { + public function getEmailAuthenticationTimestamp() { $this->load(); wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated ) ); return $this->mEmailAuthenticated; @@ -2009,9 +2108,13 @@ class User { * Set the user's e-mail address * @param $str String New e-mail address */ - function setEmail( $str ) { + public function setEmail( $str ) { $this->load(); + if( $str == $this->mEmail ) { + return; + } $this->mEmail = $str; + $this->invalidateEmail(); wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) ); } @@ -2019,7 +2122,7 @@ class User { * Get the user's real name * @return String User's real name */ - function getRealName() { + public function getRealName() { if ( !$this->isItemLoaded( 'realname' ) ) { $this->load(); } @@ -2031,7 +2134,7 @@ class User { * Set the user's real name * @param $str String New real name */ - function setRealName( $str ) { + public function setRealName( $str ) { $this->load(); $this->mRealName = $str; } @@ -2046,7 +2149,7 @@ class User { * @see getBoolOption() * @see getIntOption() */ - function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) { + public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) { global $wgHiddenPrefs; $this->loadOptions(); @@ -2105,11 +2208,10 @@ class User { * @return Bool User's current value for the option * @see getOption() */ - function getBoolOption( $oname ) { + public function getBoolOption( $oname ) { return (bool)$this->getOption( $oname ); } - /** * Get the user's current setting for a given option, as a boolean value. * @@ -2118,7 +2220,7 @@ class User { * @return Int User's current value for the option * @see getOption() */ - function getIntOption( $oname, $defaultOverride=0 ) { + public function getIntOption( $oname, $defaultOverride=0 ) { $val = $this->getOption( $oname ); if( $val == '' ) { $val = $defaultOverride; @@ -2132,15 +2234,10 @@ class User { * @param $oname String The option to set * @param $val mixed New value to set */ - function setOption( $oname, $val ) { + public function setOption( $oname, $val ) { $this->load(); $this->loadOptions(); - if ( $oname == 'skin' ) { - # Clear cached skin, so the new one displays immediately in Special:Preferences - $this->mSkin = null; - } - // Explicitly NULL values should refer to defaults global $wgDefaultUserOptions; if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) { @@ -2153,7 +2250,7 @@ class User { /** * Reset all options to the site defaults */ - function resetOptions() { + public function resetOptions() { $this->mOptions = self::getDefaultOptions(); } @@ -2161,7 +2258,7 @@ class User { * Get the user's preferred date format. * @return String User's preferred date format */ - function getDatePreference() { + public function getDatePreference() { // Important migration for old data rows if ( is_null( $this->mDatePreference ) ) { global $wgLang; @@ -2177,8 +2274,10 @@ class User { /** * Get the user preferred stub threshold + * + * @return int */ - function getStubThreshold() { + public function getStubThreshold() { global $wgMaxArticleSize; # Maximum article size, in Kb $threshold = intval( $this->getOption( 'stubthreshold' ) ); if ( $threshold > $wgMaxArticleSize * 1024 ) { @@ -2193,7 +2292,7 @@ class User { * Get the permissions this user has. * @return Array of String permission names */ - function getRights() { + public function getRights() { if ( is_null( $this->mRights ) ) { $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() ); wfRunHooks( 'UserGetRights', array( $this, &$this->mRights ) ); @@ -2208,8 +2307,9 @@ class User { * The implicit * and user groups are not included. * @return Array of String internal group names */ - function getGroups() { + public function getGroups() { $this->load(); + $this->loadGroups(); return $this->mGroups; } @@ -2220,32 +2320,78 @@ class User { * @param $recache Bool Whether to avoid the cache * @return Array of String internal group names */ - function getEffectiveGroups( $recache = false ) { + public function getEffectiveGroups( $recache = false ) { if ( $recache || is_null( $this->mEffectiveGroups ) ) { wfProfileIn( __METHOD__ ); - $this->mEffectiveGroups = $this->getGroups(); - $this->mEffectiveGroups[] = '*'; - if( $this->getId() ) { - $this->mEffectiveGroups[] = 'user'; + $this->mEffectiveGroups = array_unique( array_merge( + $this->getGroups(), // explicit groups + $this->getAutomaticGroups( $recache ) // implicit groups + ) ); + # Hook for additional groups + wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) ); + wfProfileOut( __METHOD__ ); + } + return $this->mEffectiveGroups; + } + + /** + * Get the list of implicit group memberships this user has. + * This includes 'user' if logged in, '*' for all accounts, + * and autopromoted groups + * @param $recache Bool Whether to avoid the cache + * @return Array of String internal group names + */ + public function getAutomaticGroups( $recache = false ) { + if ( $recache || is_null( $this->mImplicitGroups ) ) { + wfProfileIn( __METHOD__ ); + $this->mImplicitGroups = array( '*' ); + if ( $this->getId() ) { + $this->mImplicitGroups[] = 'user'; - $this->mEffectiveGroups = array_unique( array_merge( - $this->mEffectiveGroups, + $this->mImplicitGroups = array_unique( array_merge( + $this->mImplicitGroups, Autopromote::getAutopromoteGroups( $this ) ) ); - - # Hook for additional groups - wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) ); + } + if ( $recache ) { + # Assure data consistency with rights/groups, + # as getEffectiveGroups() depends on this function + $this->mEffectiveGroups = null; } wfProfileOut( __METHOD__ ); } - return $this->mEffectiveGroups; + return $this->mImplicitGroups; + } + + /** + * Returns the groups the user has belonged to. + * + * The user may still belong to the returned groups. Compare with getGroups(). + * + * The function will not return groups the user had belonged to before MW 1.17 + * + * @return array Names of the groups the user has belonged to. + */ + public function getFormerGroups() { + if( is_null( $this->mFormerGroups ) ) { + $dbr = wfGetDB( DB_MASTER ); + $res = $dbr->select( 'user_former_groups', + array( 'ufg_group' ), + array( 'ufg_user' => $this->mId ), + __METHOD__ ); + $this->mFormerGroups = array(); + foreach( $res as $row ) { + $this->mFormerGroups[] = $row->ufg_group; + } + } + return $this->mFormerGroups; } /** * Get the user's edit count. * @return Int */ - function getEditCount() { + public function getEditCount() { if( $this->getId() ) { if ( !isset( $this->mEditCount ) ) { /* Populate the count, if it has not been populated yet */ @@ -2263,7 +2409,7 @@ class User { * This takes immediate effect. * @param $group String Name of the group to add */ - function addGroup( $group ) { + public function addGroup( $group ) { if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) { $dbw = wfGetDB( DB_MASTER ); if( $this->getId() ) { @@ -2288,7 +2434,7 @@ class User { * This takes immediate effect. * @param $group String Name of the group to remove */ - function removeGroup( $group ) { + public function removeGroup( $group ) { $this->load(); if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) { $dbw = wfGetDB( DB_MASTER ); @@ -2297,6 +2443,14 @@ class User { 'ug_user' => $this->getID(), 'ug_group' => $group, ), __METHOD__ ); + // Remember that the user was in this group + $dbw->insert( 'user_former_groups', + array( + 'ufg_user' => $this->getID(), + 'ufg_group' => $group, + ), + __METHOD__, + array( 'IGNORE' ) ); } $this->loadGroups(); $this->mGroups = array_diff( $this->mGroups, array( $group ) ); @@ -2309,7 +2463,7 @@ class User { * Get whether the user is logged in * @return Bool */ - function isLoggedIn() { + public function isLoggedIn() { return $this->getID() != 0; } @@ -2317,14 +2471,17 @@ class User { * Get whether the user is anonymous * @return Bool */ - function isAnon() { + public function isAnon() { return !$this->isLoggedIn(); } /** * Check if user is allowed to access a feature / make an action - * @param varargs String permissions to test + * + * @internal param \String $varargs permissions to test * @return Boolean: True if user is allowed to perform *any* of the given actions + * + * @return bool */ public function isAllowedAny( /*...*/ ){ $permissions = func_get_args(); @@ -2337,7 +2494,8 @@ class User { } /** - * @param varargs String + * + * @internal param $varargs string * @return bool True if the user is allowed to perform *all* of the given actions */ public function isAllowedAll( /*...*/ ){ @@ -2388,13 +2546,28 @@ class User { return( ( $wgUseRCPatrol || $wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) ); } + /** + * Get the WebRequest object to use with this object + * + * @return WebRequest + */ + public function getRequest() { + if ( $this->mRequest ) { + return $this->mRequest; + } else { + global $wgRequest; + return $wgRequest; + } + } + /** * Get the current skin, loading it if required * @return Skin The current skin * @todo FIXME: Need to check the old failback system [AV] * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have */ - function getSkin() { + public function getSkin() { + wfDeprecated( __METHOD__, '1.18' ); return RequestContext::getMain()->getSkin(); } @@ -2403,7 +2576,7 @@ class User { * @param $title Title of the article to look at * @return Bool */ - function isWatched( $title ) { + public function isWatched( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); return $wl->isWatched(); } @@ -2412,7 +2585,7 @@ class User { * Watch an article. * @param $title Title of the article to look at */ - function addWatch( $title ) { + public function addWatch( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); $wl->addWatch(); $this->invalidateCache(); @@ -2422,20 +2595,28 @@ class User { * Stop watching an article. * @param $title Title of the article to look at */ - function removeWatch( $title ) { + public function removeWatch( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); $wl->removeWatch(); $this->invalidateCache(); } + /** + * Cleans up watchlist by removing invalid entries from it + */ + public function cleanupWatchlist() { + $dbw = wfGetDB( DB_MASTER ); + $dbw->delete( 'watchlist', array( 'wl_namespace < 0', 'wl_user' => $this->getId() ), __METHOD__ ); + } + /** * Clear the user's notification timestamp for the given title. * If e-notif e-mails are on, they will receive notification mails on * the next change of the page if it's watched etc. * @param $title Title of the article to look at */ - function clearNotification( &$title ) { - global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker; + public function clearNotification( &$title ) { + global $wgUseEnotif, $wgShowUpdatedMarker; # Do nothing if the database is locked to writes if( wfReadOnly() ) { @@ -2463,13 +2644,11 @@ class User { // and when it does have to be executed, it can be on a slave // If this is the user's newtalk page, we always update the timestamp if( $title->getNamespace() == NS_USER_TALK && - $title->getText() == $wgUser->getName() ) + $title->getText() == $this->getName() ) { $watched = true; - } elseif ( $this->getId() == $wgUser->getId() ) { - $watched = $title->userIsWatching(); } else { - $watched = true; + $watched = $this->isWatched( $title ); } // If the page is watched by the user (or may be watched), update the timestamp on any @@ -2492,22 +2671,21 @@ class User { * Resets all of the given user's page-change notification timestamps. * If e-notif e-mails are on, they will receive notification mails on * the next change of any watched page. - * - * @param $currentUser Int User ID */ - function clearAllNotifications( $currentUser ) { + public function clearAllNotifications() { global $wgUseEnotif, $wgShowUpdatedMarker; if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) { $this->setNewtalk( false ); return; } - if( $currentUser != 0 ) { + $id = $this->getId(); + if( $id != 0 ) { $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'watchlist', array( /* SET */ 'wl_notificationtimestamp' => null ), array( /* WHERE */ - 'wl_user' => $currentUser + 'wl_user' => $id ), __METHOD__ ); # We also need to clear here the "you have new message" notification for the own user_talk page @@ -2518,9 +2696,11 @@ class User { /** * Set this user's options from an encoded string * @param $str String Encoded options to import - * @private + * + * @deprecated in 1.19 due to removal of user_options from the user table */ - function decodeOptions( $str ) { + private function decodeOptions( $str ) { + wfDeprecated( __METHOD__, '1.19' ); if( !$str ) return; @@ -2549,8 +2729,7 @@ class User { * if 0 or not specified, use the default $wgCookieExpiration */ protected function setCookie( $name, $value, $exp = 0 ) { - global $wgRequest; - $wgRequest->response()->setcookie( $name, $value, $exp ); + $this->getRequest()->response()->setcookie( $name, $value, $exp ); } /** @@ -2567,14 +2746,21 @@ class User { * @param $request WebRequest object to use; $wgRequest will be used if null * is passed. */ - function setCookies( $request = null ) { + public function setCookies( $request = null ) { if ( $request === null ) { - global $wgRequest; - $request = $wgRequest; + $request = $this->getRequest(); } $this->load(); if ( 0 == $this->mId ) return; + if ( !$this->mToken ) { + // When token is empty or NULL generate a new one and then save it to the database + // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey + // Simply by setting every cell in the user_token column to NULL and letting them be + // regenerated as users log back into the wiki. + $this->setToken(); + $this->saveSettings(); + } $session = array( 'wsUserID' => $this->mId, 'wsToken' => $this->mToken, @@ -2607,7 +2793,7 @@ class User { /** * Log this user out. */ - function logout() { + public function logout() { if( wfRunHooks( 'UserLogout', array( &$this ) ) ) { $this->doLogout(); } @@ -2615,15 +2801,12 @@ class User { /** * Clear the user's cookies and session, and reset the instance cache. - * @private * @see logout() */ - function doLogout() { - global $wgRequest; - + public function doLogout() { $this->clearInstanceCache( 'defaults' ); - $wgRequest->setSessionData( 'wsUserID', 0 ); + $this->getRequest()->setSessionData( 'wsUserID', 0 ); $this->clearCookie( 'UserID' ); $this->clearCookie( 'Token' ); @@ -2636,7 +2819,7 @@ class User { * Save this user's settings into the database. * @todo Only rarely do all these fields need to be set! */ - function saveSettings() { + public function saveSettings() { $this->load(); if ( wfReadOnly() ) { return; } if ( 0 == $this->mId ) { return; } @@ -2653,7 +2836,6 @@ class User { 'user_real_name' => $this->mRealName, 'user_email' => $this->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ), - 'user_options' => '', 'user_touched' => $dbw->timestamp( $this->mTouched ), 'user_token' => $this->mToken, 'user_email_token' => $this->mEmailToken, @@ -2674,7 +2856,7 @@ class User { * If only this user's username is known, and it exists, return the user ID. * @return Int */ - function idForName() { + public function idForName() { $s = trim( $this->getName() ); if ( $s === '' ) return 0; @@ -2702,7 +2884,7 @@ class User { * * @return User object, or null if the username already exists */ - static function createNew( $name, $params = array() ) { + public static function createNew( $name, $params = array() ) { $user = new User; $user->load(); if ( isset( $params['options'] ) ) { @@ -2721,7 +2903,6 @@ class User { 'user_email' => $user->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ), 'user_real_name' => $user->mRealName, - 'user_options' => '', 'user_token' => $user->mToken, 'user_registration' => $dbw->timestamp( $user->mRegistration ), 'user_editcount' => 0, @@ -2741,7 +2922,7 @@ class User { /** * Add this existing user object to the database */ - function addToDatabase() { + public function addToDatabase() { $this->load(); $dbw = wfGetDB( DB_MASTER ); $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' ); @@ -2755,7 +2936,6 @@ class User { 'user_email' => $this->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ), 'user_real_name' => $this->mRealName, - 'user_options' => '', 'user_token' => $this->mToken, 'user_registration' => $dbw->timestamp( $this->mRegistration ), 'user_editcount' => 0, @@ -2770,22 +2950,35 @@ class User { } /** - * If this (non-anonymous) user is blocked, block any IP address - * they've successfully logged in from. + * If this user is logged-in and blocked, + * block any IP address they've successfully logged in from. + * @return bool A block was spread + */ + public function spreadAnyEditBlock() { + if ( $this->isLoggedIn() && $this->isBlocked() ) { + return $this->spreadBlock(); + } + return false; + } + + /** + * If this (non-anonymous) user is blocked, + * block the IP address they've successfully logged in from. + * @return bool A block was spread */ - function spreadBlock() { + protected function spreadBlock() { wfDebug( __METHOD__ . "()\n" ); $this->load(); if ( $this->mId == 0 ) { - return; + return false; } $userblock = Block::newFromTarget( $this->getName() ); if ( !$userblock ) { - return; + return false; } - $userblock->doAutoblock( wfGetIP() ); + return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() ); } /** @@ -2802,12 +2995,13 @@ class User { * @deprecated since 1.17 use the ParserOptions object to get the relevant options * @return String Page rendering hash */ - function getPageRenderingHash() { + public function getPageRenderingHash() { + wfDeprecated( __METHOD__, '1.17' ); + global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang; if( $this->mHash ){ return $this->mHash; } - wfDeprecated( __METHOD__ ); // stubthreshold is only included below for completeness, // since it disables the parser cache, its value will always @@ -2844,7 +3038,7 @@ class User { * Get whether the user is explicitly blocked from account creation. * @return Bool|Block */ - function isBlockedFromCreateAccount() { + public function isBlockedFromCreateAccount() { $this->getBlockedStatus(); if( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ){ return $this->mBlock; @@ -2853,12 +3047,11 @@ class User { # bug 13611: if the IP address the user is trying to create an account from is # blocked with createaccount disabled, prevent new account creation there even # when the user is logged in - static $accBlock = false; - if( $accBlock === false ){ - $accBlock = Block::newFromTarget( null, wfGetIP() ); + if( $this->mBlockedFromCreateAccount === false ){ + $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() ); } - return $accBlock instanceof Block && $accBlock->prevents( 'createaccount' ) - ? $accBlock + return $this->mBlockedFromCreateAccount instanceof Block && $this->mBlockedFromCreateAccount->prevents( 'createaccount' ) + ? $this->mBlockedFromCreateAccount : false; } @@ -2866,7 +3059,7 @@ class User { * Get whether the user is blocked from using Special:Emailuser. * @return Bool */ - function isBlockedFromEmailuser() { + public function isBlockedFromEmailuser() { $this->getBlockedStatus(); return $this->mBlock && $this->mBlock->prevents( 'sendemail' ); } @@ -2884,7 +3077,7 @@ class User { * * @return Title: User's personal page title */ - function getUserPage() { + public function getUserPage() { return Title::makeTitle( NS_USER, $this->getName() ); } @@ -2893,7 +3086,7 @@ class User { * * @return Title: User's talk page title */ - function getTalkPage() { + public function getTalkPage() { $title = $this->getUserPage(); return $title->getTalkPage(); } @@ -2903,7 +3096,7 @@ class User { * anonymous IPs, or the most recently created accounts. * @return Bool */ - function isNewbie() { + public function isNewbie() { return !$this->isAllowed( 'autoconfirmed' ); } @@ -2912,7 +3105,7 @@ class User { * @param $password String: user password. * @return Boolean: True if the given password is correct, otherwise False. */ - function checkPassword( $password ) { + public function checkPassword( $password ) { global $wgAuth, $wgLegacyEncoding; $this->load(); @@ -2952,9 +3145,12 @@ class User { /** * Check if the given clear-text password matches the temporary password * sent by e-mail for password reset operations. + * + * @param $plaintext string + * * @return Boolean: True if matches, false otherwise */ - function checkTemporaryPassword( $plaintext ) { + public function checkTemporaryPassword( $plaintext ) { global $wgNewPasswordExpiry; $this->load(); @@ -2969,20 +3165,34 @@ class User { } } + /** + * Alias for getEditToken. + * @deprecated since 1.19, use getEditToken instead. + * + * @param $salt String|Array of Strings Optional function-specific data for hashing + * @param $request WebRequest object to use or null to use $wgRequest + * @return String The new edit token + */ + public function editToken( $salt = '', $request = null ) { + wfDeprecated( __METHOD__, '1.19' ); + return $this->getEditToken( $salt, $request ); + } + /** * Initialize (if necessary) and return a session token value * which can be used in edit forms to show that the user's * login credentials aren't being hijacked with a foreign form * submission. * + * @since 1.19 + * * @param $salt String|Array of Strings Optional function-specific data for hashing * @param $request WebRequest object to use or null to use $wgRequest * @return String The new edit token */ - function editToken( $salt = '', $request = null ) { + public function getEditToken( $salt = '', $request = null ) { if ( $request == null ) { - global $wgRequest; - $request = $wgRequest; + $request = $this->getRequest(); } if ( $this->isAnon() ) { @@ -3022,8 +3232,8 @@ class User { * @param $request WebRequest object to use or null to use $wgRequest * @return Boolean: Whether the token matches */ - function matchEditToken( $val, $salt = '', $request = null ) { - $sessionToken = $this->editToken( $salt, $request ); + public function matchEditToken( $val, $salt = '', $request = null ) { + $sessionToken = $this->getEditToken( $salt, $request ); if ( $val != $sessionToken ) { wfDebug( "User::matchEditToken: broken session data\n" ); } @@ -3039,8 +3249,8 @@ class User { * @param $request WebRequest object to use or null to use $wgRequest * @return Boolean: Whether the token matches */ - function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) { - $sessionToken = $this->editToken( $salt, $request ); + public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) { + $sessionToken = $this->getEditToken( $salt, $request ); return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 ); } @@ -3051,7 +3261,7 @@ class User { * @param $type String: message to send, either "created", "changed" or "set" * @return Status object */ - function sendConfirmationMail( $type = 'created' ) { + public function sendConfirmationMail( $type = 'created' ) { global $wgLang; $expiration = null; // gets passed-by-ref and defined in next line. $token = $this->confirmationToken( $expiration ); @@ -3069,7 +3279,7 @@ class User { return $this->sendMail( wfMsg( 'confirmemail_subject' ), wfMsg( $message, - wfGetIP(), + $this->getRequest()->getIP(), $this->getName(), $url, $wgLang->timeanddate( $expiration, false ), @@ -3088,7 +3298,7 @@ class User { * @param $replyto String Reply-To address * @return Status */ - function sendMail( $subject, $body, $from = null, $replyto = null ) { + public function sendMail( $subject, $body, $from = null, $replyto = null ) { if( is_null( $from ) ) { global $wgPasswordSender, $wgPasswordSenderName; $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName ); @@ -3107,11 +3317,10 @@ class User { * @note Call saveSettings() after calling this function to commit * this change to the database. * - * @param[out] &$expiration \mixed Accepts the expiration time + * @param &$expiration \mixed Accepts the expiration time * @return String New token - * @private */ - function confirmationToken( &$expiration ) { + private function confirmationToken( &$expiration ) { global $wgUserEmailConfirmationTokenExpiry; $now = time(); $expires = $now + $wgUserEmailConfirmationTokenExpiry; @@ -3128,9 +3337,8 @@ class User { * Return a URL the user can use to confirm their email address. * @param $token String Accepts the email confirmation token * @return String New token URL - * @private */ - function confirmationTokenUrl( $token ) { + private function confirmationTokenUrl( $token ) { return $this->getTokenUrl( 'ConfirmEmail', $token ); } @@ -3138,15 +3346,14 @@ class User { * Return a URL the user can use to invalidate their email address. * @param $token String Accepts the email confirmation token * @return String New token URL - * @private */ - function invalidationTokenUrl( $token ) { + private function invalidationTokenUrl( $token ) { return $this->getTokenUrl( 'Invalidateemail', $token ); } /** * Internal function to format the e-mail validation/invalidation URLs. - * This uses $wgArticlePath directly as a quickie hack to use the + * This uses a quickie hack to use the * hardcoded English names of the Special: pages, for ASCII safety. * * @note Since these URLs get dropped directly into emails, using the @@ -3159,20 +3366,19 @@ class User { * @return String Formatted URL */ protected function getTokenUrl( $page, $token ) { - global $wgArticlePath; - return wfExpandUrl( - str_replace( - '$1', - "Special:$page/$token", - $wgArticlePath ) ); + // Hack to bypass localization of 'Special:' + $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" ); + return $title->getCanonicalUrl(); } /** * Mark the e-mail address confirmed. * * @note Call saveSettings() after calling this function to commit the change. + * + * @return true */ - function confirmEmail() { + public function confirmEmail() { $this->setEmailAuthenticationTimestamp( wfTimestampNow() ); wfRunHooks( 'ConfirmEmailComplete', array( $this ) ); return true; @@ -3183,6 +3389,7 @@ class User { * address if it was already confirmed. * * @note Call saveSettings() after calling this function to commit the change. + * @return true */ function invalidateEmail() { $this->load(); @@ -3208,7 +3415,7 @@ class User { * site configuration? * @return Bool */ - function canSendEmail() { + public function canSendEmail() { global $wgEnableEmail, $wgEnableUserEmail; if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) { return false; @@ -3223,7 +3430,7 @@ class User { * site configuration? * @return Bool */ - function canReceiveEmail() { + public function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); } @@ -3237,17 +3444,20 @@ class User { * * @return Bool */ - function isEmailConfirmed() { + public function isEmailConfirmed() { global $wgEmailAuthentication; $this->load(); $confirmed = true; if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) { - if( $this->isAnon() ) + if( $this->isAnon() ) { return false; - if( !self::isValidEmailAddr( $this->mEmail ) ) + } + if( !Sanitizer::validateEmail( $this->mEmail ) ) { return false; - if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) + } + if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) { return false; + } return true; } else { return $confirmed; @@ -3258,7 +3468,7 @@ class User { * Check whether there is an outstanding request for e-mail confirmation. * @return Bool */ - function isEmailConfirmationPending() { + public function isEmailConfirmationPending() { global $wgEmailAuthentication; return $wgEmailAuthentication && !$this->isEmailConfirmed() && @@ -3308,7 +3518,7 @@ class User { * @param $groups Array of Strings List of internal group names * @return Array of Strings List of permission key names for given groups combined */ - static function getGroupPermissions( $groups ) { + public static function getGroupPermissions( $groups ) { global $wgGroupPermissions, $wgRevokePermissions; $rights = array(); // grant every granted permission first @@ -3335,7 +3545,7 @@ class User { * @param $role String Role to check * @return Array of Strings List of internal group names with the given permission */ - static function getGroupsWithPermission( $role ) { + public static function getGroupsWithPermission( $role ) { global $wgGroupPermissions; $allowedGroups = array(); foreach ( $wgGroupPermissions as $group => $rights ) { @@ -3352,7 +3562,7 @@ class User { * @param $group String Internal group name * @return String Localized descriptive group name */ - static function getGroupName( $group ) { + public static function getGroupName( $group ) { $msg = wfMessage( "group-$group" ); return $msg->isBlank() ? $group : $msg->text(); } @@ -3361,10 +3571,11 @@ class User { * Get the localized descriptive name for a member of a group, if it exists * * @param $group String Internal group name + * @param $username String Username for gender (since 1.19) * @return String Localized name for group member */ - static function getGroupMember( $group ) { - $msg = wfMessage( "group-$group-member" ); + public static function getGroupMember( $group, $username = '#' ) { + $msg = wfMessage( "group-$group-member", $username ); return $msg->isBlank() ? $group : $msg->text(); } @@ -3374,7 +3585,7 @@ class User { * are not included, as they are defined automatically, not in the database. * @return Array of internal group names */ - static function getAllGroups() { + public static function getAllGroups() { global $wgGroupPermissions, $wgRevokePermissions; return array_diff( array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ), @@ -3386,7 +3597,7 @@ class User { * Get a list of all available permissions. * @return Array of permission names */ - static function getAllRights() { + public static function getAllRights() { if ( self::$mAllRights === false ) { global $wgAvailableRights; if ( count( $wgAvailableRights ) ) { @@ -3416,7 +3627,7 @@ class User { * @param $group String Internal group name * @return Title|Bool Title of the page if it exists, false otherwise */ - static function getGroupPage( $group ) { + public static function getGroupPage( $group ) { $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage(); if( $msg->exists() ) { $title = Title::newFromText( $msg->text() ); @@ -3434,15 +3645,13 @@ class User { * @param $text String The text of the link * @return String HTML link to the group */ - static function makeGroupLinkHTML( $group, $text = '' ) { + public static function makeGroupLinkHTML( $group, $text = '' ) { if( $text == '' ) { $text = self::getGroupName( $group ); } $title = self::getGroupPage( $group ); if( $title ) { - global $wgUser; - $sk = $wgUser->getSkin(); - return $sk->link( $title, htmlspecialchars( $text ) ); + return Linker::link( $title, htmlspecialchars( $text ) ); } else { return $text; } @@ -3456,7 +3665,7 @@ class User { * @param $text String The text of the link * @return String Wikilink to the group */ - static function makeGroupLinkWiki( $group, $text = '' ) { + public static function makeGroupLinkWiki( $group, $text = '' ) { if( $text == '' ) { $text = self::getGroupName( $group ); } @@ -3478,7 +3687,7 @@ class User { * 'add-self' => array( addablegroups to self), * 'remove-self' => array( removable groups from self) ) */ - static function changeableByGroup( $group ) { + public static function changeableByGroup( $group ) { global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf; $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() ); @@ -3542,7 +3751,7 @@ class User { * 'add-self' => array( addablegroups to self), * 'remove-self' => array( removable groups from self) ) */ - function changeableGroups() { + public function changeableGroups() { if( $this->isAllowed( 'userrights' ) ) { // This group gives the right to modify everything (reverse- // compatibility with old "userrights lets you change @@ -3582,7 +3791,7 @@ class User { * Increment the user's edit-count field. * Will have no effect for anonymous users. */ - function incEditCount() { + public function incEditCount() { if( !$this->isAnon() ) { $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'user', @@ -3628,7 +3837,7 @@ class User { * @param $right String Right to query * @return String Localized description of the right */ - static function getRightDescription( $right ) { + public static function getRightDescription( $right ) { $key = "right-$right"; $msg = wfMessage( $key ); return $msg->isBlank() ? $right : $msg->text(); @@ -3641,7 +3850,7 @@ class User { * @param $userId String User ID * @return String Password hash */ - static function oldCrypt( $password, $userId ) { + public static function oldCrypt( $password, $userId ) { global $wgPasswordSalt; if ( $wgPasswordSalt ) { return md5( $userId . '-' . md5( $password ) ); @@ -3654,11 +3863,12 @@ class User { * Make a new-style password hash * * @param $password String Plain-text password - * @param $salt String Optional salt, may be random or the user ID. + * @param bool|string $salt Optional salt, may be random or the user ID. + * If unspecified or false, will generate one automatically * @return String Password hash */ - static function crypt( $password, $salt = false ) { + public static function crypt( $password, $salt = false ) { global $wgPasswordSalt; $hash = ''; @@ -3682,10 +3892,11 @@ class User { * * @param $hash String Password hash * @param $password String Plain-text password to compare - * @param $userId String User ID for old-style password salt - * @return Boolean: + * @param $userId String|bool User ID for old-style password salt + * + * @return Boolean */ - static function comparePasswords( $hash, $password, $userId = false ) { + public static function comparePasswords( $hash, $password, $userId = false ) { $type = substr( $hash, 0, 3 ); $result = false; @@ -3707,12 +3918,12 @@ class User { } /** - * Add a newuser log entry for this user + * Add a newuser log entry for this user. Before 1.19 the return value was always true. * * @param $byEmail Boolean: account made by email? * @param $reason String: user supplied reason * - * @return true + * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure */ public function addNewUserLogEntry( $byEmail = false, $reason = '' ) { global $wgUser, $wgContLang, $wgNewUserLog; @@ -3734,13 +3945,12 @@ class User { } } $log = new LogPage( 'newusers' ); - $log->addEntry( + return (int)$log->addEntry( $action, $this->getUserPage(), $reason, array( $this->getId() ) ); - return true; } /** @@ -3759,6 +3969,9 @@ class User { return true; } + /** + * @todo document + */ protected function loadOptions() { $this->load(); if ( $this->mOptionsLoaded || !$this->getId() ) @@ -3784,6 +3997,7 @@ class User { __METHOD__ ); + $this->mOptionOverrides = array(); foreach ( $res as $row ) { $this->mOptionOverrides[$row->up_property] = $row->up_value; $this->mOptions[$row->up_property] = $row->up_value; @@ -3795,6 +4009,9 @@ class User { wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) ); } + /** + * @todo document + */ protected function saveOptions() { global $wgAllowPrefChange; @@ -3809,8 +4026,9 @@ class User { // 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 ) ) ) + if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) { return; + } foreach( $saveOptions as $key => $value ) { # Don't bother storing default values @@ -3835,10 +4053,8 @@ class User { } } - $dbw->begin(); $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__ ); $dbw->insert( 'user_properties', $insert_rows, __METHOD__ ); - $dbw->commit(); } /**