X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FUser.php;h=47e2462b7e4ff78b99ba2908633338956279a382;hb=95300b2e5554ee6ee7fff11f890b1dac96b42c27;hp=308b6e3b39fd9015856ad9fb3243d7f9eb631d5f;hpb=9a9c22ea07c5bb8cff11082118e9fb30be9efb93;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/User.php b/includes/User.php index 308b6e3b39..47e2462b7e 100644 --- a/includes/User.php +++ b/includes/User.php @@ -1,6 +1,22 @@ clearInstanceCache( 'defaults' ); } + /** + * @return String + */ function __toString(){ return $this->getName(); } @@ -213,7 +243,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; } @@ -251,9 +281,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(); @@ -289,7 +318,7 @@ class User { /** * Save user data to the shared cache */ - function saveToCache() { + public function saveToCache() { $this->load(); $this->loadGroups(); $this->loadOptions(); @@ -307,7 +336,6 @@ class User { $wgMemc->set( $key, $data ); } - /** @name newFrom*() static factory methods */ //@{ @@ -327,7 +355,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'; } @@ -350,7 +378,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'; @@ -368,7 +396,7 @@ class User { * @param $code String Confirmation code * @return User */ - 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 ), @@ -385,11 +413,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. * + * @param $request WebRequest object to use; $wgRequest will be used if + * ommited. * @return User */ - static function newFromSession() { + public static function newFromSession( WebRequest $request = null ) { $user = new User; $user->mFrom = 'session'; + $user->mRequest = $request; return $user; } @@ -406,7 +437,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; @@ -414,7 +445,6 @@ class User { //@} - /** * Get the username corresponding to a given user ID * @param $id Int User ID @@ -431,7 +461,7 @@ class User { * @param $id Int User ID * @return String 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__ ); } @@ -441,7 +471,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 @@ -493,7 +523,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); } @@ -508,7 +538,7 @@ class User { * @param $name String to match * @return Bool */ - static function isValidUserName( $name ) { + public static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; if ( $name == '' @@ -562,7 +592,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 ) ) { @@ -599,7 +629,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 @@ -629,7 +659,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; } @@ -640,7 +670,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( @@ -714,8 +744,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 ); @@ -769,7 +801,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 @@ -805,7 +837,7 @@ class User { * * @return String new random password */ - static function randomPassword() { + public static function randomPassword() { global $wgMinimalPasswordLength; $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz'; $l = strlen( $pwchars ) - 1; @@ -824,13 +856,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 = ''; @@ -840,8 +871,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 } @@ -892,7 +924,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 ) ); @@ -908,8 +940,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 ); @@ -919,42 +953,43 @@ class User { cookie user ID ($sId) don't match!" ); return false; } - $wgRequest->setSessionData( 'wsUserID', $sId ); - } else if ( $sessId !== null && $sessId != 0 ) { + $request->setSessionData( 'wsUserID', $sId ); + } elseif ( $sessId !== null && $sessId != 0 ) { $sId = $sessId; } else { $this->loadDefaults(); return false; } - if ( $wgRequest->getSessionData( 'wsUserName' ) !== null ) { - $sName = $wgRequest->getSessionData( 'wsUserName' ); - } else if ( $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; } - $this->mId = $sId; - if ( !$this->loadFromId() ) { - # Not a valid ID, loadFromId has switched the object to anon for us + $proposedUser = User::newFromId( $sId ); + if ( !$proposedUser->isLoggedIn() ) { + # Not a valid ID + $this->loadDefaults(); return false; } global $wgBlockDisablesLogin; - if( $wgBlockDisablesLogin && $this->isBlocked() ) { + if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) { # User blocked and we've disabled blocked user logins $this->loadDefaults(); return false; } - if ( $wgRequest->getSessionData( 'wsToken' ) !== null ) { - $passwordCorrect = $this->mToken == $wgRequest->getSessionData( 'wsToken' ); + if ( $request->getSessionData( 'wsToken' ) !== null ) { + $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' ); $from = 'session'; - } else if ( $wgRequest->getCookie( 'Token' ) !== null ) { - $passwordCorrect = $this->mToken == $wgRequest->getCookie( 'Token' ); + } elseif ( $request->getCookie( 'Token' ) !== null ) { + $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' ); $from = 'cookie'; } else { # No session or persistent login cookie @@ -962,8 +997,9 @@ class User { return false; } - if ( ( $sName == $this->mName ) && $passwordCorrect ) { - $wgRequest->setSessionData( 'wsToken', $this->mToken ); + if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) { + $this->loadFromUserObject( $proposedUser ); + $request->setSessionData( 'wsToken', $this->mToken ); wfDebug( "User: logged in from $from\n" ); return true; } else { @@ -979,9 +1015,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 ); @@ -1015,7 +1050,7 @@ class User { * * @param $row Array Row from the user table to load. */ - function loadFromRow( $row ) { + public function loadFromRow( $row ) { $all = true; if ( isset( $row->user_name ) ) { @@ -1026,7 +1061,7 @@ class User { $all = false; } - if ( isset( $row->user_name ) ) { + if ( isset( $row->user_real_name ) ) { $this->mRealName = $row->user_real_name; $this->setItemLoaded( 'realname' ); } else { @@ -1063,11 +1098,24 @@ class User { } } + /** + * Load the data for this user object from another user object. + * + * @param $user User + */ + protected function loadFromUserObject( $user ) { + $user->load(); + $user->loadGroups(); + $user->loadOptions(); + foreach ( self::$mCacheVars as $var ) { + $this->$var = $user->$var; + } + } + /** * 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', @@ -1081,20 +1129,58 @@ 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 + 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 ) { @@ -1109,17 +1195,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,13 +1229,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 ) { @@ -1189,7 +1268,7 @@ 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' ); @@ -1199,9 +1278,9 @@ class User { } # Proxy blocking - if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) { + if ( $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) { # Local list - if ( wfIsLocallyBlockedProxy( $ip ) ) { + if ( self::isLocallyBlockedProxy( $ip ) ) { $this->mBlockedby = wfMsg( 'proxyblocker' ); $this->mBlockreason = wfMsg( 'proxyblockreason' ); } @@ -1228,7 +1307,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; @@ -1249,18 +1328,28 @@ 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; - // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170) + // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170) if( IP::isIPv4( $ip ) ) { # Reverse IP, bug 21255 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) ); 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 ); @@ -1279,18 +1368,47 @@ class User { return $found; } + /** + * Check if an IP address is in the local proxy list + * + * @param $ip string + * + * @return bool + */ + public static function isLocallyBlockedProxy( $ip ) { + global $wgProxyList; + + if ( !$wgProxyList ) { + return false; + } + wfProfileIn( __METHOD__ ); + + if ( !is_array( $wgProxyList ) ) { + # Load from the specified file + $wgProxyList = array_map( 'trim', file( $wgProxyList ) ); + } + + if ( !is_array( $wgProxyList ) ) { + $ret = false; + } elseif ( array_search( $ip, $wgProxyList ) !== false ) { + $ret = true; + } elseif ( array_key_exists( $ip, $wgProxyList ) ) { + # Old-style flipped proxy list + $ret = true; + } else { + $ret = false; + } + wfProfileOut( __METHOD__ ); + return $ret; + } + /** * Is this user subject to rate limiting? * * @return Bool True if rate limited */ public function isPingLimitable() { - global $wgRateLimitsExcludedGroups; global $wgRateLimitsExcludedIPs; - if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) { - // Deprecated, but kept for backwards-compatibility config - return false; - } if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) { // No other good way currently to disable rate limits // for specific IPs. :P @@ -1310,7 +1428,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 ) ) ) { @@ -1380,7 +1498,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 { @@ -1403,9 +1523,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; } /** @@ -1438,7 +1568,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; } @@ -1447,7 +1577,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; } @@ -1456,7 +1586,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 ); } @@ -1469,14 +1599,14 @@ 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; } // User is already an IP? if( IP::isIPAddress( $this->getName() ) ) { $ip = $this->getName(); - } else if( !$ip ) { + } elseif( !$ip ) { $ip = wfGetIP(); } $blocked = false; @@ -1490,7 +1620,7 @@ class User { * * @return Bool True if locked, false otherwise */ - function isLocked() { + public function isLocked() { if( $this->mLocked !== null ) { return $this->mLocked; } @@ -1505,7 +1635,7 @@ class User { * * @return Bool True if hidden, false otherwise */ - function isHidden() { + public function isHidden() { if( $this->mHideName !== null ) { return $this->mHideName; } @@ -1522,7 +1652,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 @@ -1538,7 +1668,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' ); } @@ -1547,7 +1677,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; @@ -1574,7 +1704,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; } @@ -1583,7 +1713,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() ); } @@ -1591,7 +1721,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) @@ -1624,7 +1754,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; @@ -1644,9 +1774,8 @@ class User { * @param $id String|Int User's IP address for anonymous users, User ID otherwise * @param $fromMaster Bool true to fetch from the master, false for a slave * @return Bool True if the user has new messages - * @private */ - function checkNewtalk( $field, $id, $fromMaster = false ) { + protected function checkNewtalk( $field, $id, $fromMaster = false ) { if ( $fromMaster ) { $db = wfGetDB( DB_MASTER ); } else { @@ -1662,9 +1791,8 @@ class User { * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise * @param $id String|Int User's IP address for anonymous users, User ID otherwise * @return Bool True if successful, false otherwise - * @private */ - function updateNewtalk( $field, $id ) { + protected function updateNewtalk( $field, $id ) { $dbw = wfGetDB( DB_MASTER ); $dbw->insert( 'user_newtalk', array( $field => $id ), @@ -1684,9 +1812,8 @@ class User { * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise * @param $id String|Int User's IP address for anonymous users, User ID otherwise * @return Bool True if successful, false otherwise - * @private */ - function deleteNewtalk( $field, $id ) { + protected function deleteNewtalk( $field, $id ) { $dbw = wfGetDB( DB_MASTER ); $dbw->delete( 'user_newtalk', array( $field => $id ), @@ -1704,7 +1831,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; } @@ -1734,7 +1861,7 @@ class User { $wgMemc->set( $key, $val ? 1 : 0, 1800 ); } if ( $changed ) { - $this->invalidateCache( true ); + $this->invalidateCache(); } } @@ -1767,15 +1894,13 @@ class User { * Immediately touch the user data cache for this account. * Updates user_touched field, and removes account data from memcached * for reload on the next hit. - * - * @param $doDatabaseUpdate bool Do you really need to update the database? Really? */ - function invalidateCache( $doDatabaseUpdate = false ) { + public function invalidateCache() { if( wfReadOnly() ) { return; } $this->load(); - if( $this->mId && $doDatabaseUpdate ) { + if( $this->mId ) { $this->mTouched = self::newTouchedTimestamp(); $dbw = wfGetDB( DB_MASTER ); @@ -1791,8 +1916,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 ); } @@ -1801,7 +1928,7 @@ class User { * Get the user touched timestamp * @return String timestamp */ - function getTouched() { + public function getTouched() { $this->load(); return $this->mTouched; } @@ -1819,8 +1946,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 ) { @@ -1856,7 +1985,7 @@ class User { * * @param $str String New password to set */ - function setInternalPassword( $str ) { + public function setInternalPassword( $str ) { $this->load(); $this->setToken(); @@ -1874,7 +2003,7 @@ class User { * Get the user's current token. * @return String Token */ - function getToken() { + public function getToken() { $this->load(); return $this->mToken; } @@ -1883,10 +2012,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 ) { @@ -1907,9 +2035,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 ); } @@ -1920,7 +2047,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 ) { @@ -1933,7 +2060,7 @@ class User { * $wgPasswordReminderResendTime hours? * @return Bool */ - function isPasswordReminderThrottled() { + public function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; $this->load(); if ( !$this->mNewpassTime || !$wgPasswordReminderResendTime ) { @@ -1947,7 +2074,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; @@ -1957,7 +2084,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; @@ -1967,7 +2094,7 @@ 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(); $this->mEmail = $str; wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail ) ); @@ -1977,7 +2104,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(); } @@ -1989,7 +2116,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; } @@ -2004,7 +2131,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(); @@ -2063,11 +2190,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. * @@ -2076,7 +2202,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; @@ -2090,15 +2216,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] ) ) { @@ -2111,7 +2232,7 @@ class User { /** * Reset all options to the site defaults */ - function resetOptions() { + public function resetOptions() { $this->mOptions = self::getDefaultOptions(); } @@ -2119,7 +2240,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; @@ -2135,8 +2256,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 ) { @@ -2149,16 +2272,29 @@ class User { /** * Get the permissions this user has. + * @param $ns int If numeric, get permissions for this namespace * @return Array of String permission names */ - function getRights() { + public function getRights( $ns = null ) { + $key = is_null( $ns ) ? '*' : intval( $ns ); + if ( is_null( $this->mRights ) ) { - $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() ); - wfRunHooks( 'UserGetRights', array( $this, &$this->mRights ) ); + $this->mRights = array(); + } + + if ( !isset( $this->mRights[$key] ) ) { + $this->mRights[$key] = self::getGroupPermissions( $this->getEffectiveGroups(), $ns ); + wfRunHooks( 'UserGetRights', array( $this, &$this->mRights[$key], $ns ) ); // Force reindexation of rights when a hook has unset one of them - $this->mRights = array_values( $this->mRights ); + $this->mRights[$key] = array_values( $this->mRights[$key] ); + } + if ( is_null( $ns ) ) { + return $this->mRights[$key]; + } else { + // Merge non namespace specific rights + return array_merge( $this->mRights[$key], $this->getRights() ); } - return $this->mRights; + } /** @@ -2166,7 +2302,7 @@ class User { * The implicit * and user groups are not included. * @return Array of String internal group names */ - function getGroups() { + public function getGroups() { $this->load(); return $this->mGroups; } @@ -2178,32 +2314,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; + } - $this->mEffectiveGroups = array_unique( array_merge( - $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->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 */ @@ -2221,8 +2403,8 @@ class User { * This takes immediate effect. * @param $group String Name of the group to add */ - function addGroup( $group ) { - if( wfRunHooks( 'UserAddGroup', array( &$this, &$group ) ) ) { + public function addGroup( $group ) { + if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) { $dbw = wfGetDB( DB_MASTER ); if( $this->getId() ) { $dbw->insert( 'user_groups', @@ -2236,9 +2418,9 @@ class User { } $this->loadGroups(); $this->mGroups[] = $group; - $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) ); + $this->mRights = null; - $this->invalidateCache( true ); + $this->invalidateCache(); } /** @@ -2246,28 +2428,36 @@ 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 ) ) ) { + if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) { $dbw = wfGetDB( DB_MASTER ); $dbw->delete( 'user_groups', array( '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 ) ); - $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) ); + $this->mRights = null; - $this->invalidateCache( true ); + $this->invalidateCache(); } /** * Get whether the user is logged in * @return Bool */ - function isLoggedIn() { + public function isLoggedIn() { return $this->getID() != 0; } @@ -2275,14 +2465,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(); @@ -2295,7 +2488,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( /*...*/ ){ @@ -2311,9 +2505,10 @@ class User { /** * Internal mechanics of testing a permission * @param $action String + * @param $ns int|null Namespace optional * @return bool */ - public function isAllowed( $action = '' ) { + public function isAllowed( $action = '', $ns = null ) { if ( $action === '' ) { return true; // In the spirit of DWIM } @@ -2325,7 +2520,7 @@ class User { } # Use strict parameter to avoid matching numeric 0 accidentally inserted # by misconfiguration: 0 == 'foo' - return in_array( $action, $this->getRights(), true ); + return in_array( $action, $this->getRights( $ns ), true ); } /** @@ -2346,13 +2541,27 @@ 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 Use ->getSkin() in the most relevant outputting context you have + * @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() { return RequestContext::getMain()->getSkin(); } @@ -2361,7 +2570,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(); } @@ -2370,7 +2579,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(); @@ -2380,7 +2589,7 @@ 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(); @@ -2392,8 +2601,8 @@ class User { * 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() ) { @@ -2421,13 +2630,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 @@ -2450,22 +2657,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 @@ -2476,9 +2682,8 @@ class User { /** * Set this user's options from an encoded string * @param $str String Encoded options to import - * @private */ - function decodeOptions( $str ) { + public function decodeOptions( $str ) { if( !$str ) return; @@ -2507,8 +2712,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 ); } /** @@ -2525,10 +2729,9 @@ 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(); @@ -2565,7 +2768,7 @@ class User { /** * Log this user out. */ - function logout() { + public function logout() { if( wfRunHooks( 'UserLogout', array( &$this ) ) ) { $this->doLogout(); } @@ -2573,15 +2776,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' ); @@ -2594,7 +2794,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; } @@ -2632,7 +2832,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; @@ -2660,7 +2860,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'] ) ) { @@ -2699,7 +2899,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' ); @@ -2731,7 +2931,7 @@ class User { * If this (non-anonymous) user is blocked, block any IP address * they've successfully logged in from. */ - function spreadBlock() { + public function spreadBlock() { wfDebug( __METHOD__ . "()\n" ); $this->load(); if ( $this->mId == 0 ) { @@ -2760,7 +2960,7 @@ 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() { global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang; if( $this->mHash ){ return $this->mHash; @@ -2802,7 +3002,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; @@ -2811,12 +3011,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, wfGetIP() ); } - return $accBlock instanceof Block && $accBlock->prevents( 'createaccount' ) - ? $accBlock + return $this->mBlockedFromCreateAccount instanceof Block && $this->mBlockedFromCreateAccount->prevents( 'createaccount' ) + ? $this->mBlockedFromCreateAccount : false; } @@ -2824,7 +3023,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' ); } @@ -2842,7 +3041,7 @@ class User { * * @return Title: User's personal page title */ - function getUserPage() { + public function getUserPage() { return Title::makeTitle( NS_USER, $this->getName() ); } @@ -2851,33 +3050,17 @@ class User { * * @return Title: User's talk page title */ - function getTalkPage() { + public function getTalkPage() { $title = $this->getUserPage(); return $title->getTalkPage(); } - /** - * Get the maximum valid user ID. - * @return Integer: User ID - * @static - */ - function getMaxID() { - static $res; // cache - - if ( isset( $res ) ) { - return $res; - } else { - $dbr = wfGetDB( DB_SLAVE ); - return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__ ); - } - } - /** * Determine whether the user is a newbie. Newbies are either * anonymous IPs, or the most recently created accounts. * @return Bool */ - function isNewbie() { + public function isNewbie() { return !$this->isAllowed( 'autoconfirmed' ); } @@ -2886,7 +3069,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(); @@ -2926,9 +3109,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(); @@ -2953,10 +3139,9 @@ class User { * @param $request WebRequest object to use or null to use $wgRequest * @return String The new edit token */ - function editToken( $salt = '', $request = null ) { + public function editToken( $salt = '', $request = null ) { if ( $request == null ) { - global $wgRequest; - $request = $wgRequest; + $request = $this->getRequest(); } if ( $this->isAnon() ) { @@ -2996,7 +3181,7 @@ 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 ) { + public function matchEditToken( $val, $salt = '', $request = null ) { $sessionToken = $this->editToken( $salt, $request ); if ( $val != $sessionToken ) { wfDebug( "User::matchEditToken: broken session data\n" ); @@ -3013,7 +3198,7 @@ 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 ) { + public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) { $sessionToken = $this->editToken( $salt, $request ); return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 ); } @@ -3025,7 +3210,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 ); @@ -3062,7 +3247,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 ); @@ -3081,11 +3266,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; @@ -3102,9 +3286,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 ); } @@ -3112,9 +3295,8 @@ 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 ); } @@ -3138,15 +3320,19 @@ class User { str_replace( '$1', "Special:$page/$token", - $wgArticlePath ) ); + $wgArticlePath ), + PROTO_HTTP + ); } /** * 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; @@ -3157,6 +3343,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(); @@ -3182,7 +3369,7 @@ class User { * site configuration? * @return Bool */ - function canSendEmail() { + public function canSendEmail() { global $wgEnableEmail, $wgEnableUserEmail; if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) { return false; @@ -3197,7 +3384,7 @@ class User { * site configuration? * @return Bool */ - function canReceiveEmail() { + public function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); } @@ -3211,17 +3398,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; @@ -3232,7 +3422,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() && @@ -3280,40 +3470,70 @@ class User { * Get the permissions associated with a given list of groups * * @param $groups Array of Strings List of internal group names + * @param $ns int + * * @return Array of Strings List of permission key names for given groups combined */ - static function getGroupPermissions( $groups ) { + public static function getGroupPermissions( $groups, $ns = null ) { global $wgGroupPermissions, $wgRevokePermissions; $rights = array(); - // grant every granted permission first + + // Grant every granted permission first foreach( $groups as $group ) { if( isset( $wgGroupPermissions[$group] ) ) { - $rights = array_merge( $rights, - // array_filter removes empty items - array_keys( array_filter( $wgGroupPermissions[$group] ) ) ); + $rights = array_merge( $rights, self::extractRights( + $wgGroupPermissions[$group], $ns ) ); } } - // now revoke the revoked permissions + + // Revoke the revoked permissions foreach( $groups as $group ) { if( isset( $wgRevokePermissions[$group] ) ) { - $rights = array_diff( $rights, - array_keys( array_filter( $wgRevokePermissions[$group] ) ) ); + $rights = array_diff( $rights, self::extractRights( + $wgRevokePermissions[$group], $ns ) ); } } return array_unique( $rights ); } + /** + * Helper for User::getGroupPermissions + * @param $list array + * @param $ns int + * @return array + */ + private static function extractRights( $list, $ns ) { + $rights = array(); + foreach( $list as $right => $value ) { + if ( is_array( $value ) ) { + # This is a list of namespaces where the permission applies + if ( !is_null( $ns ) && !empty( $value[$ns] ) ) { + $rights[] = $right; + } + } else { + # This is a boolean indicating that the permission applies + if ( $value ) { + $rights[] = $right; + } + } + } + return $rights; + } + /** * Get all the groups who have a given permission * * @param $role String Role to check + * @param $ns int + * + * * @return Array of Strings List of internal group names with the given permission */ - static function getGroupsWithPermission( $role ) { + public static function getGroupsWithPermission( $role, $ns = null ) { global $wgGroupPermissions; $allowedGroups = array(); foreach ( $wgGroupPermissions as $group => $rights ) { - if ( isset( $rights[$role] ) && $rights[$role] ) { + if ( in_array( $role, self::getGroupPermissions( array( $group ), $ns ), true ) ) { $allowedGroups[] = $group; } } @@ -3326,7 +3546,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(); } @@ -3337,7 +3557,7 @@ class User { * @param $group String Internal group name * @return String Localized name for group member */ - static function getGroupMember( $group ) { + public static function getGroupMember( $group ) { $msg = wfMessage( "group-$group-member" ); return $msg->isBlank() ? $group : $msg->text(); } @@ -3348,7 +3568,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 ) ), @@ -3360,7 +3580,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 ) ) { @@ -3390,7 +3610,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() ); @@ -3408,15 +3628,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; } @@ -3430,7 +3648,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 ); } @@ -3452,7 +3670,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() ); @@ -3516,7 +3734,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 @@ -3556,7 +3774,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', @@ -3602,12 +3820,10 @@ 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"; - $name = wfMsg( $key ); - return $name == '' || wfEmptyMsg( $key ) - ? $right - : $name; + $msg = wfMessage( $key ); + return $msg->isBlank() ? $right : $msg->text(); } /** @@ -3617,7 +3833,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 ) ); @@ -3630,11 +3846,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 = ''; @@ -3658,10 +3875,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; @@ -3687,6 +3905,8 @@ class User { * * @param $byEmail Boolean: account made by email? * @param $reason String: user supplied reason + * + * @return true */ public function addNewUserLogEntry( $byEmail = false, $reason = '' ) { global $wgUser, $wgContLang, $wgNewUserLog; @@ -3720,6 +3940,8 @@ class User { /** * Add an autocreate newuser log entry for this user * Used by things like CentralAuth and perhaps other authplugins. + * + * @return true */ public function addNewUserLogEntryAutoCreate() { global $wgNewUserLog; @@ -3731,6 +3953,9 @@ class User { return true; } + /** + * @todo document + */ protected function loadOptions() { $this->load(); if ( $this->mOptionsLoaded || !$this->getId() ) @@ -3767,6 +3992,9 @@ class User { wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) ); } + /** + * @todo document + */ protected function saveOptions() { global $wgAllowPrefChange; @@ -3781,8 +4009,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 @@ -3830,7 +4059,7 @@ class User { * actually just returns array() unconditionally at the moment. May as * well keep it around for when the browser bugs get fixed, though. * - * FIXME : This does not belong here; put it in Html or Linker or somewhere + * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere * * @return array Array of HTML attributes suitable for feeding to * Html::element(), directly or indirectly. (Don't feed to Xml::*()! @@ -3847,7 +4076,7 @@ class User { # Note that the pattern requirement will always be satisfied if the # input is empty, so we need required in all cases. # - # FIXME (bug 23769): This needs to not claim the password is required + # @todo FIXME: Bug 23769: This needs to not claim the password is required # if e-mail confirmation is being used. Since HTML5 input validation # is b0rked anyway in some browsers, just return nothing. When it's # re-enabled, fix this code to not output required for e-mail