diff options
Diffstat (limited to 'includes/User.php')
| -rw-r--r-- | includes/User.php | 1952 |
1 files changed, 1263 insertions, 689 deletions
diff --git a/includes/User.php b/includes/User.php index 0a3db4c0..12912e1c 100644 --- a/includes/User.php +++ b/includes/User.php @@ -124,6 +124,12 @@ class User { 'edit', 'editinterface', 'editprotected', + 'editmyoptions', + 'editmyprivateinfo', + 'editmyusercss', + 'editmyuserjs', + 'editmywatchlist', + 'editsemiprotected', 'editusercssjs', #deprecated 'editusercss', 'edituserjs', @@ -164,6 +170,8 @@ class User { 'upload_by_url', 'userrights', 'userrights-interwiki', + 'viewmyprivateinfo', + 'viewmywatchlist', 'writeapi', ); /** @@ -251,9 +259,9 @@ class User { } /** - * @return String + * @return string */ - function __toString(){ + function __toString() { return $this->getName(); } @@ -266,7 +274,7 @@ class User { } wfProfileIn( __METHOD__ ); - # Set it now to avoid infinite recursion in accessors + // Set it now to avoid infinite recursion in accessors $this->mLoadedItems = true; switch ( $this->mFrom ) { @@ -276,7 +284,7 @@ class User { case 'name': $this->mId = self::idFromName( $this->mName ); if ( !$this->mId ) { - # Nonexistent user placeholder object + // Nonexistent user placeholder object $this->loadDefaults( $this->mName ); } else { $this->loadFromId(); @@ -286,10 +294,14 @@ class User { $this->loadFromId(); break; case 'session': - $this->loadFromSession(); + if ( !$this->loadFromSession() ) { + // Loading from session failed. Load defaults. + $this->loadDefaults(); + } wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) ); break; default: + wfProfileOut( __METHOD__ ); throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" ); } wfProfileOut( __METHOD__ ); @@ -297,7 +309,7 @@ class User { /** * Load user table data, given mId has already been set. - * @return Bool false if the ID does not exist, true otherwise + * @return bool false if the ID does not exist, true otherwise */ public function loadFromId() { global $wgMemc; @@ -306,29 +318,32 @@ class User { return false; } - # Try cache + // Try cache $key = wfMemcKey( 'user', 'id', $this->mId ); $data = $wgMemc->get( $key ); if ( !is_array( $data ) || $data['mVersion'] < MW_USER_VERSION ) { - # Object is expired, load from DB + // Object is expired, load from DB $data = false; } if ( !$data ) { wfDebug( "User: cache miss for user {$this->mId}\n" ); - # Load from DB + // Load from DB if ( !$this->loadFromDatabase() ) { - # Can't load from ID, user is anonymous + // Can't load from ID, user is anonymous return false; } $this->saveToCache(); } else { wfDebug( "User: got user {$this->mId} from cache\n" ); - # Restore from cache + // Restore from cache foreach ( self::$mCacheVars as $name ) { $this->$name = $data[$name]; } } + + $this->mLoadedItems = true; + return true; } @@ -362,15 +377,15 @@ class User { * This is slightly less efficient than newFromId(), so use newFromId() if * you have both an ID and a name handy. * - * @param $name String Username, validated by Title::newFromText() - * @param $validate String|Bool Validate username. Takes the same parameters as - * User::getCanonicalName(), except that true is accepted as an alias - * for 'valid', for BC. + * @param string $name Username, validated by Title::newFromText() + * @param string|bool $validate Validate username. Takes the same parameters as + * User::getCanonicalName(), except that true is accepted as an alias + * for 'valid', for BC. * - * @return User object, or false if the username is invalid - * (e.g. if it contains illegal characters or is an IP address). If the - * username is not present in the database, the result will be a user object - * with a name, zero user ID and default settings. + * @return User|bool User object, or false if the username is invalid + * (e.g. if it contains illegal characters or is an IP address). If the + * username is not present in the database, the result will be a user object + * with a name, zero user ID and default settings. */ public static function newFromName( $name, $validate = 'valid' ) { if ( $validate === true ) { @@ -380,7 +395,7 @@ class User { if ( $name === false ) { return false; } else { - # Create unloaded user object + // Create unloaded user object $u = new User; $u->mName = $name; $u->mFrom = 'name'; @@ -392,7 +407,7 @@ class User { /** * Static factory method for creation from a given user ID. * - * @param $id Int Valid user ID + * @param int $id Valid user ID * @return User The corresponding User object */ public static function newFromId( $id ) { @@ -410,8 +425,8 @@ class User { * * If the code is invalid or has expired, returns NULL. * - * @param $code String Confirmation code - * @return User object, or null + * @param string $code Confirmation code + * @return User|null */ public static function newFromConfirmationCode( $code ) { $dbr = wfGetDB( DB_SLAVE ); @@ -419,7 +434,7 @@ class User { 'user_email_token' => md5( $code ), 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ), ) ); - if( $id !== false ) { + if ( $id !== false ) { return User::newFromId( $id ); } else { return null; @@ -430,8 +445,7 @@ 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. + * @param WebRequest $request Object to use; $wgRequest will be used if omitted. * @return User object */ public static function newFromSession( WebRequest $request = null ) { @@ -451,12 +465,13 @@ class User { * user_name and user_real_name are not provided because the whole row * will be loaded once more from the database when accessing them. * - * @param $row Array A row from the user table + * @param array $row A row from the user table + * @param array $data Further data to load into the object (see User::loadFromRow for valid keys) * @return User */ - public static function newFromRow( $row ) { + public static function newFromRow( $row, $data = null ) { $user = new User; - $user->loadFromRow( $row ); + $user->loadFromRow( $row, $data ); return $user; } @@ -464,8 +479,8 @@ class User { /** * Get the username corresponding to a given user ID - * @param $id Int User ID - * @return String|bool The corresponding username + * @param int $id User ID + * @return string|bool The corresponding username */ public static function whoIs( $id ) { return UserCache::singleton()->getProp( $id, 'name' ); @@ -474,8 +489,8 @@ class User { /** * Get the real name of a user given their user ID * - * @param $id Int User ID - * @return String|bool The corresponding user's real name + * @param int $id User ID + * @return string|bool The corresponding user's real name */ public static function whoIsReal( $id ) { return UserCache::singleton()->getProp( $id, 'real_name' ); @@ -483,13 +498,13 @@ class User { /** * Get database id given a user name - * @param $name String Username - * @return Int|Null The corresponding user's ID, or null if user is nonexistent + * @param string $name Username + * @return int|null The corresponding user's ID, or null if user is nonexistent */ public static function idFromName( $name ) { $nt = Title::makeTitleSafe( NS_USER, $name ); - if( is_null( $nt ) ) { - # Illegal name + if ( is_null( $nt ) ) { + // Illegal name return null; } @@ -535,23 +550,23 @@ class User { * addresses like this, if we allowed accounts like this to be created * new users could get the old edits of these anonymous users. * - * @param $name String to match - * @return Bool + * @param string $name Name to match + * @return bool */ 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); + return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name ) || IP::isIPv6( $name ); } /** * Is the input a valid username? * * Checks if the input is a valid username, we don't want an empty string, - * an IP address, anything that containins slashes (would mess up subpages), + * an IP address, anything that contains slashes (would mess up subpages), * is longer than the maximum allowed username size or doesn't begin with * a capital letter. * - * @param $name String to match - * @return Bool + * @param string $name Name to match + * @return bool */ public static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; @@ -566,11 +581,10 @@ 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 ); - if( is_null( $parsed ) + if ( is_null( $parsed ) || $parsed->getNamespace() || strcmp( $name, $parsed->getPrefixedText() ) ) { wfDebugLog( 'username', __METHOD__ . @@ -588,7 +602,7 @@ class User { '\x{3000}' . # ideographic space '\x{e000}-\x{f8ff}' . # private use ']/u'; - if( preg_match( $unicodeBlacklist, $name ) ) { + if ( preg_match( $unicodeBlacklist, $name ) ) { wfDebugLog( 'username', __METHOD__ . ": '$name' invalid due to blacklisted characters" ); return false; @@ -605,8 +619,8 @@ class User { * If an account already exists in this form, login will be blocked * by a failure to pass this function. * - * @param $name String to match - * @return Bool + * @param string $name Name to match + * @return bool */ public static function isUsableName( $name ) { global $wgReservedUsernames; @@ -642,8 +656,8 @@ class User { * Additional blacklisting may be added here rather than in * isValidUserName() to avoid disrupting existing accounts. * - * @param $name String to match - * @return Bool + * @param string $name to match + * @return bool */ public static function isCreatableName( $name ) { global $wgInvalidUsernameCharacters; @@ -651,15 +665,15 @@ class User { // Ensure that the username isn't longer than 235 bytes, so that // (at least for the builtin skins) user javascript and css files // will work. (bug 23080) - if( strlen( $name ) > 235 ) { + if ( strlen( $name ) > 235 ) { wfDebugLog( 'username', __METHOD__ . ": '$name' invalid due to length" ); return false; } // Preg yells if you try to give it an empty string - if( $wgInvalidUsernameCharacters !== '' ) { - if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) { + if ( $wgInvalidUsernameCharacters !== '' ) { + if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) { wfDebugLog( 'username', __METHOD__ . ": '$name' invalid due to wgInvalidUsernameCharacters" ); return false; @@ -672,8 +686,8 @@ class User { /** * Is the input a valid password for this user? * - * @param $password String Desired password - * @return Bool + * @param string $password Desired password + * @return bool */ public function isValidPassword( $password ) { //simple boolean wrapper for getPasswordValidity @@ -683,7 +697,7 @@ class User { /** * Given unvalidated password input, return error message on failure. * - * @param $password String Desired password + * @param string $password Desired password * @return mixed: true on success, string or array of error message on failure */ public function getPasswordValidity( $password ) { @@ -696,15 +710,16 @@ class User { $result = false; //init $result to false for the internal checks - if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) ) + if ( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) ) { return $result; + } if ( $result === false ) { - if( strlen( $password ) < $wgMinimalPasswordLength ) { + if ( strlen( $password ) < $wgMinimalPasswordLength ) { return 'passwordtooshort'; } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName ) ) { return 'password-name-match'; - } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) { + } elseif ( isset( $blockedLogins[$this->getName()] ) && $password == $blockedLogins[$this->getName()] ) { return 'password-login-forbidden'; } else { //it seems weird returning true here, but this is because of the @@ -713,7 +728,7 @@ class User { //a valid password. return true; } - } elseif( $result === true ) { + } elseif ( $result === true ) { return true; } else { return $result; //the isValidPassword hook set a string $result and returned true @@ -724,7 +739,7 @@ class User { * Does a string look like an e-mail address? * * This validates an email address using an HTML5 specification found at: - * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address + * http://www.whatwg.org/html/states-of-the-type-attribute.html#valid-e-mail-address * Which as of 2011-01-24 says: * * A valid e-mail address is a string that matches the ABNF production @@ -743,8 +758,8 @@ class User { * to be liberal enough for wide use. Some invalid addresses will still * pass validation here. * - * @param $addr String E-mail address - * @return Bool + * @param string $addr E-mail address + * @return bool * @deprecated since 1.18 call Sanitizer::isValidEmail() directly */ public static function isValidEmailAddr( $addr ) { @@ -755,35 +770,37 @@ class User { /** * Given unvalidated user input, return a canonical username, or false if * the username is invalid. - * @param $name String User input - * @param $validate String|Bool type of validation to use: + * @param string $name User input + * @param string|bool $validate type of validation to use: * - false No validation * - 'valid' Valid for batch processes * - 'usable' Valid for batch processes and login * - 'creatable' Valid for batch processes, login and account creation * + * @throws MWException * @return bool|string */ public static function getCanonicalName( $name, $validate = 'valid' ) { - # Force usernames to capital + // Force usernames to capital global $wgContLang; $name = $wgContLang->ucfirst( $name ); # Reject names containing '#'; these will be cleaned up # with title normalisation, but then it's too late to # check elsewhere - if( strpos( $name, '#' ) !== false ) + if ( strpos( $name, '#' ) !== false ) { return false; + } - # Clean up name according to title rules + // Clean up name according to title rules $t = ( $validate === 'valid' ) ? Title::newFromText( $name ) : Title::makeTitle( NS_USER, $name ); - # Check for invalid titles - if( is_null( $t ) ) { + // Check for invalid titles + if ( is_null( $t ) ) { return false; } - # Reject various classes of invalid names + // Reject various classes of invalid names global $wgAuth; $name = $wgAuth->getCanonicalName( $t->getText() ); @@ -813,45 +830,22 @@ class User { /** * Count the number of edits of a user - * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas * - * @param $uid Int User ID to check - * @return Int the user's edit count + * @param int $uid User ID to check + * @return int The user's edit count + * + * @deprecated since 1.21 in favour of User::getEditCount */ public static function edits( $uid ) { - wfProfileIn( __METHOD__ ); - $dbr = wfGetDB( DB_SLAVE ); - // check if the user_editcount field has been initialized - $field = $dbr->selectField( - 'user', 'user_editcount', - array( 'user_id' => $uid ), - __METHOD__ - ); - - if( $field === null ) { // it has not been initialized. do so. - $dbw = wfGetDB( DB_MASTER ); - $count = $dbr->selectField( - 'revision', 'count(*)', - array( 'rev_user' => $uid ), - __METHOD__ - ); - $dbw->update( - 'user', - array( 'user_editcount' => $count ), - array( 'user_id' => $uid ), - __METHOD__ - ); - } else { - $count = $field; - } - wfProfileOut( __METHOD__ ); - return $count; + wfDeprecated( __METHOD__, '1.21' ); + $user = self::newFromId( $uid ); + return $user->getEditCount(); } /** * Return a random password. * - * @return String new random password + * @return string New random password */ public static function randomPassword() { global $wgMinimalPasswordLength; @@ -871,7 +865,7 @@ class User { * @note This no longer clears uncached lazy-initialised properties; * the constructor does that instead. * - * @param $name string + * @param $name string|bool */ public function loadDefaults( $name = false ) { wfProfileIn( __METHOD__ ); @@ -886,10 +880,10 @@ class User { $this->mOptionsLoaded = false; $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' ); - if( $loggedOut !== null ) { + if ( $loggedOut !== null ) { $this->mTouched = wfTimestamp( TS_MW, $loggedOut ); } else { - $this->mTouched = '0'; # Allow any pages to be cached + $this->mTouched = '1'; # Allow any pages to be cached } $this->mToken = null; // Don't run cryptographic functions till we need a token @@ -907,14 +901,14 @@ class User { /** * Return whether an item has been loaded. * - * @param $item String: item to check. Current possibilities: + * @param string $item item to check. Current possibilities: * - id * - name * - realname - * @param $all String: 'all' to check if the whole object has been loaded + * @param string $all 'all' to check if the whole object has been loaded * or any other string to check if only the item is available (e.g. * for optimisation) - * @return Boolean + * @return boolean */ public function isItemLoaded( $item, $all = 'all' ) { return ( $this->mLoadedItems === true && $all === 'all' ) || @@ -924,36 +918,25 @@ class User { /** * Set that an item has been loaded * - * @param $item String + * @param string $item */ - private function setItemLoaded( $item ) { + protected function setItemLoaded( $item ) { if ( is_array( $this->mLoadedItems ) ) { $this->mLoadedItems[$item] = true; } } /** - * Load user data from the session or login cookie. If there are no valid - * credentials, initialises the user as an anonymous user. - * @return Bool True if the user is logged in, false otherwise. + * Load user data from the session or login cookie. + * @return bool True if the user is logged in, false otherwise. */ private function loadFromSession() { - global $wgExternalAuthType, $wgAutocreatePolicy; - $result = null; wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) ); if ( $result !== null ) { return $result; } - if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) { - $extUser = ExternalUser::newFromCookie(); - if ( $extUser ) { - # TODO: Automatically create the user here (or probably a bit - # lower down, in fact) - } - } - $request = $this->getRequest(); $cookieId = $request->getCookie( 'UserID' ); @@ -961,8 +944,7 @@ class User { if ( $cookieId !== null ) { $sId = intval( $cookieId ); - if( $sessId !== null && $cookieId != $sessId ) { - $this->loadDefaults(); // Possible collision! + if ( $sessId !== null && $cookieId != $sessId ) { wfDebugLog( 'loginSessions', "Session user ID ($sessId) and cookie user ID ($sId) don't match!" ); return false; @@ -971,7 +953,6 @@ class User { } elseif ( $sessId !== null && $sessId != 0 ) { $sId = $sessId; } else { - $this->loadDefaults(); return false; } @@ -981,33 +962,32 @@ class User { $sName = $request->getCookie( 'UserName' ); $request->setSessionData( 'wsUserName', $sName ); } else { - $this->loadDefaults(); return false; } $proposedUser = User::newFromId( $sId ); if ( !$proposedUser->isLoggedIn() ) { - # Not a valid ID - $this->loadDefaults(); + // Not a valid ID return false; } global $wgBlockDisablesLogin; - if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) { - # User blocked and we've disabled blocked user logins - $this->loadDefaults(); + if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) { + // User blocked and we've disabled blocked user logins return false; } if ( $request->getSessionData( 'wsToken' ) ) { - $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ); + $passwordCorrect = ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) ); $from = 'session'; } elseif ( $request->getCookie( 'Token' ) ) { - $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' ); + # Get the token from DB/cache and clean it up to remove garbage padding. + # This deals with historical problems with bugs and the default column value. + $token = rtrim( $proposedUser->getToken( false ) ); // correct token + $passwordCorrect = ( strlen( $token ) && $token === $request->getCookie( 'Token' ) ); $from = 'cookie'; } else { - # No session or persistent login cookie - $this->loadDefaults(); + // No session or persistent login cookie return false; } @@ -1017,9 +997,8 @@ class User { wfDebug( "User: logged in from $from\n" ); return true; } else { - # Invalid credentials + // Invalid credentials wfDebug( "User: can't log in from $from, invalid credentials\n" ); - $this->loadDefaults(); return false; } } @@ -1028,14 +1007,14 @@ class User { * Load user and user_group data from the database. * $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 + * @return bool True if the user exists, false if the user is anonymous */ public function loadFromDatabase() { - # Paranoia + // Paranoia $this->mId = intval( $this->mId ); - /** Anonymous user */ - if( !$this->mId ) { + // Anonymous user + if ( !$this->mId ) { $this->loadDefaults(); return false; } @@ -1046,13 +1025,13 @@ class User { wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) ); if ( $s !== false ) { - # Initialise user table data + // Initialise user table data $this->loadFromRow( $s ); $this->mGroups = null; // deferred $this->getEditCount(); // revalidation for nulls return true; } else { - # Invalid user_id + // Invalid user_id $this->mId = 0; $this->loadDefaults(); return false; @@ -1062,9 +1041,13 @@ class User { /** * Initialize this object from a row from the user table. * - * @param $row Array Row from the user table to load. + * @param array $row Row from the user table to load. + * @param array $data Further user data to load into the object + * + * user_groups Array with groups out of the user_groups table + * user_properties Array with properties out of the user_properties table */ - public function loadFromRow( $row ) { + public function loadFromRow( $row, $data = null ) { $all = true; $this->mGroups = null; // deferred @@ -1122,6 +1105,15 @@ class User { if ( $all ) { $this->mLoadedItems = true; } + + if ( is_array( $data ) ) { + if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) { + $this->mGroups = $data['user_groups']; + } + if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) { + $this->loadOptions( $data['user_properties'] ); + } + } } /** @@ -1163,40 +1155,50 @@ class User { * 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) + * @param string $event 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; + global $wgAutopromoteOnceLogInRC, $wgAuth; $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 ); } + // update groups in external authentication database + $wgAuth->updateExternalDBGroups( $this, $toPromote ); + $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 ) ) - ); + $logEntry = new ManualLogEntry( 'rights', 'autopromote' ); + $logEntry->setPerformer( $this ); + $logEntry->setTarget( $this->getUserPage() ); + $logEntry->setParameters( array( + '4::oldgroups' => $oldGroups, + '5::newgroups' => $newGroups, + ) ); + $logid = $logEntry->insert(); + if ( $wgAutopromoteOnceLogInRC ) { + $logEntry->publish( $logid ); + } } } return $toPromote; } /** - * Clear various cached data stored in this object. - * @param $reloadFrom bool|String Reload user and user_groups table data from a + * Clear various cached data stored in this object. The cache of the user table + * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given. + * + * @param bool|string $reloadFrom Reload user and user_groups table data from a * given source. May be "name", "id", "defaults", "session", or false for * no reload. */ @@ -1208,7 +1210,10 @@ class User { $this->mRights = null; $this->mEffectiveGroups = null; $this->mImplicitGroups = null; + $this->mGroups = null; $this->mOptions = null; + $this->mOptionsLoaded = false; + $this->mEditCount = null; if ( $reloadFrom ) { $this->mLoadedItems = array(); @@ -1225,22 +1230,25 @@ class User { public static function getDefaultOptions() { global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin; + static $defOpt = null; + if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) { + // Disabling this for the unit tests, as 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 + return $defOpt; + } + $defOpt = $wgDefaultUserOptions; - # default language setting - $variant = $wgContLang->getDefaultVariant(); - $defOpt['variant'] = $variant; - $defOpt['language'] = $variant; - foreach( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) { - $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] ); + // Default language setting + $defOpt['language'] = $wgContLang->getCode(); + foreach ( LanguageConverter::$languagesWithVariants as $langCode ) { + $defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode; + } + foreach ( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) { + $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] ); } $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; @@ -1249,35 +1257,34 @@ class User { /** * Get a given default option value. * - * @param $opt String Name of option to retrieve - * @return String Default option value + * @param string $opt Name of option to retrieve + * @return string Default option value */ public static function getDefaultOption( $opt ) { $defOpts = self::getDefaultOptions(); - if( isset( $defOpts[$opt] ) ) { + if ( isset( $defOpts[$opt] ) ) { return $defOpts[$opt]; } else { return null; } } - /** * Get blocking information - * @param $bFromSlave Bool Whether to check the slave database first. To + * @param bool $bFromSlave 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. */ private function getBlockedStatus( $bFromSlave = true ) { - global $wgProxyWhitelist, $wgUser; + global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff; if ( -1 != $this->mBlockedby ) { return; } wfProfileIn( __METHOD__ ); - wfDebug( __METHOD__.": checking...\n" ); + wfDebug( __METHOD__ . ": checking...\n" ); // Initialize data... // Otherwise something ends up stomping on $this->mBlockedby when @@ -1295,14 +1302,14 @@ class User { $ip = null; } - # User/IP blocking + // User/IP blocking $block = Block::newFromTarget( $this, $ip, !$bFromSlave ); - # Proxy blocking + // Proxy blocking if ( !$block instanceof Block && $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) { - # Local list + // Local list if ( self::isLocallyBlockedProxy( $ip ) ) { $block = new Block; $block->setBlocker( wfMessage( 'proxyblocker' )->text() ); @@ -1316,6 +1323,25 @@ class User { } } + // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled + if ( !$block instanceof Block + && $wgApplyIpBlocksToXff + && $ip !== null + && !$this->isAllowed( 'proxyunbannable' ) + && !in_array( $ip, $wgProxyWhitelist ) + ) { + $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' ); + $xff = array_map( 'trim', explode( ',', $xff ) ); + $xff = array_diff( $xff, array( $ip ) ); + $xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave ); + $block = Block::chooseBlock( $xffblocks, $xff ); + if ( $block instanceof Block ) { + # Mangle the reason to alert the user that the block + # originated from matching the X-Forwarded-For header. + $block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text(); + } + } + if ( $block instanceof Block ) { wfDebug( __METHOD__ . ": Found block.\n" ); $this->mBlock = $block; @@ -1329,7 +1355,7 @@ class User { $this->mAllowUsertalk = false; } - # Extensions + // Extensions wfRunHooks( 'GetBlockedStatus', array( &$this ) ); wfProfileOut( __METHOD__ ); @@ -1338,19 +1364,21 @@ class User { /** * Whether the given IP is in a DNS blacklist. * - * @param $ip String IP to check - * @param $checkWhitelist Bool: whether to check the whitelist first - * @return Bool True if blacklisted. + * @param string $ip IP to check + * @param bool $checkWhitelist whether to check the whitelist first + * @return bool True if blacklisted. */ public function isDnsBlacklisted( $ip, $checkWhitelist = false ) { global $wgEnableSorbs, $wgEnableDnsBlacklist, $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist; - if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs ) + if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs ) { return false; + } - if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) + if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) { return false; + } $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl ); return $this->inDnsBlacklist( $ip, $urls ); @@ -1359,25 +1387,25 @@ class User { /** * Whether the given IP is in a given DNS blacklist. * - * @param $ip String IP to check - * @param $bases String|Array of Strings: URL of the DNS blacklist - * @return Bool True if blacklisted. + * @param string $ip IP to check + * @param string|array $bases of Strings: URL of the DNS blacklist + * @return bool True if blacklisted. */ public function inDnsBlacklist( $ip, $bases ) { wfProfileIn( __METHOD__ ); $found = false; // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170) - if( IP::isIPv4( $ip ) ) { - # Reverse IP, bug 21255 + if ( IP::isIPv4( $ip ) ) { + // Reverse IP, bug 21255 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) ); - foreach( (array)$bases as $base ) { - # Make hostname - # 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 + foreach ( (array)$bases as $base ) { + // Make hostname + // 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]}"; @@ -1386,10 +1414,10 @@ class User { $host = "$ipReversed.$base"; } - # Send query + // Send query $ipList = gethostbynamel( $host ); - if( $ipList ) { + if ( $ipList ) { wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" ); $found = true; break; @@ -1419,7 +1447,7 @@ class User { wfProfileIn( __METHOD__ ); if ( !is_array( $wgProxyList ) ) { - # Load from the specified file + // Load from the specified file $wgProxyList = array_map( 'trim', file( $wgProxyList ) ); } @@ -1428,7 +1456,7 @@ class User { } elseif ( array_search( $ip, $wgProxyList ) !== false ) { $ret = true; } elseif ( array_key_exists( $ip, $wgProxyList ) ) { - # Old-style flipped proxy list + // Old-style flipped proxy list $ret = true; } else { $ret = false; @@ -1440,17 +1468,17 @@ class User { /** * Is this user subject to rate limiting? * - * @return Bool True if rate limited + * @return bool True if rate limited */ public function isPingLimitable() { global $wgRateLimitsExcludedIPs; - if( in_array( $this->getRequest()->getIP(), $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. return false; } - return !$this->isAllowed('noratelimit'); + return !$this->isAllowed( 'noratelimit' ); } /** @@ -1460,24 +1488,26 @@ class User { * @note When using a shared cache like memcached, IP-address * last-hit counters will be shared across wikis. * - * @param $action String Action to enforce; 'edit' if unspecified - * @return Bool True if a rate limiter was tripped + * @param string $action Action to enforce; 'edit' if unspecified + * @param integer $incrBy Positive amount to increment counter by [defaults to 1] + * @return bool True if a rate limiter was tripped */ - public function pingLimiter( $action = 'edit' ) { - # Call the 'PingLimiter' hook + public function pingLimiter( $action = 'edit', $incrBy = 1 ) { + // Call the 'PingLimiter' hook $result = false; - if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) { + if ( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) { return $result; } global $wgRateLimits; - if( !isset( $wgRateLimits[$action] ) ) { + if ( !isset( $wgRateLimits[$action] ) ) { return false; } - # Some groups shouldn't trigger the ping limiter, ever - if( !$this->isPingLimitable() ) + // Some groups shouldn't trigger the ping limiter, ever + if ( !$this->isPingLimitable() ) { return false; + } global $wgMemc, $wgRateLimitLog; wfProfileIn( __METHOD__ ); @@ -1485,27 +1515,37 @@ class User { $limits = $wgRateLimits[$action]; $keys = array(); $id = $this->getId(); - $ip = $this->getRequest()->getIP(); $userLimit = false; - if( isset( $limits['anon'] ) && $id == 0 ) { + if ( isset( $limits['anon'] ) && $id == 0 ) { $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon']; } - if( isset( $limits['user'] ) && $id != 0 ) { + if ( isset( $limits['user'] ) && $id != 0 ) { $userLimit = $limits['user']; } - if( $this->isNewbie() ) { - if( isset( $limits['newbie'] ) && $id != 0 ) { + if ( $this->isNewbie() ) { + if ( isset( $limits['newbie'] ) && $id != 0 ) { $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie']; } - if( isset( $limits['ip'] ) ) { + if ( isset( $limits['ip'] ) ) { + $ip = $this->getRequest()->getIP(); $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip']; } - $matches = array(); - if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) { - $subnet = $matches[1]; - $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet']; + if ( isset( $limits['subnet'] ) ) { + $ip = $this->getRequest()->getIP(); + $matches = array(); + $subnet = false; + if ( IP::isIPv6( $ip ) ) { + $parts = IP::parseRange( "$ip/64" ); + $subnet = $parts[0]; + } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) { + // IPv4 + $subnet = $matches[1]; + } + if ( $subnet !== false ) { + $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet']; + } } } // Check for group-specific permissions @@ -1519,20 +1559,21 @@ class User { } // Set the user limit key if ( $userLimit !== false ) { - wfDebug( __METHOD__ . ": effective user limit: $userLimit\n" ); - $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit; + list( $max, $period ) = $userLimit; + wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" ); + $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit; } $triggered = false; - foreach( $keys as $key => $limit ) { + foreach ( $keys as $key => $limit ) { list( $max, $period ) = $limit; $summary = "(limit $max in {$period}s)"; $count = $wgMemc->get( $key ); // Already pinged? - if( $count ) { - if( $count >= $max ) { + if ( $count ) { + if ( $count >= $max ) { wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" ); - if( $wgRateLimitLog ) { + if ( $wgRateLimitLog ) { wfSuppressWarnings(); file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND ); wfRestoreWarnings(); @@ -1543,9 +1584,13 @@ class User { } } else { wfDebug( __METHOD__ . ": adding record for $key $summary\n" ); - $wgMemc->add( $key, 0, intval( $period ) ); // first ping + if ( $incrBy > 0 ) { + $wgMemc->add( $key, 0, intval( $period ) ); // first ping + } + } + if ( $incrBy > 0 ) { + $wgMemc->incr( $key, $incrBy ); } - $wgMemc->incr( $key ); } wfProfileOut( __METHOD__ ); @@ -1555,8 +1600,8 @@ class User { /** * Check if user is blocked * - * @param $bFromSlave Bool Whether to check the slave database instead of the master - * @return Bool True if blocked, false otherwise + * @param bool $bFromSlave Whether to check the slave database instead of the master + * @return bool True if blocked, false otherwise */ public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' ); @@ -1565,10 +1610,10 @@ class User { /** * 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 + * @param bool $bFromSlave Whether to check the slave database instead of the master * @return Block|null */ - public function getBlock( $bFromSlave = true ){ + public function getBlock( $bFromSlave = true ) { $this->getBlockedStatus( $bFromSlave ); return $this->mBlock instanceof Block ? $this->mBlock : null; } @@ -1576,9 +1621,9 @@ class User { /** * Check if user is blocked from editing a particular article * - * @param $title Title to check - * @param $bFromSlave Bool whether to check the slave database instead of the master - * @return Bool + * @param Title $title Title to check + * @param bool $bFromSlave whether to check the slave database instead of the master + * @return bool */ function isBlockedFrom( $title, $bFromSlave = false ) { global $wgBlockAllowsUTEdit; @@ -1586,7 +1631,7 @@ class User { $blocked = $this->isBlocked( $bFromSlave ); $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false ); - # If a user's name is suppressed, they cannot make edits anywhere + // If a user's name is suppressed, they cannot make edits anywhere if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName() && $title->getNamespace() == NS_USER_TALK ) { $blocked = false; @@ -1601,7 +1646,7 @@ class User { /** * If user is blocked, return the name of the user who placed the block - * @return String name of blocker + * @return string Name of blocker */ public function blockedBy() { $this->getBlockedStatus(); @@ -1610,7 +1655,7 @@ class User { /** * If user is blocked, return the specified reason for the block - * @return String Blocking reason + * @return string Blocking reason */ public function blockedFor() { $this->getBlockedStatus(); @@ -1619,7 +1664,7 @@ class User { /** * If user is blocked, return the ID for the block - * @return Int Block ID + * @return int Block ID */ public function getBlockId() { $this->getBlockedStatus(); @@ -1629,19 +1674,19 @@ class User { /** * Check if user is blocked on all wikis. * Do not use for actual edit permission checks! - * This is intented for quick UI checks. + * This is intended for quick UI checks. * - * @param $ip String IP address, uses current client if none given - * @return Bool True if blocked, false otherwise + * @param string $ip IP address, uses current client if none given + * @return bool True if blocked, false otherwise */ public function isBlockedGlobally( $ip = '' ) { - if( $this->mBlockedGlobally !== null ) { + if ( $this->mBlockedGlobally !== null ) { return $this->mBlockedGlobally; } // User is already an IP? - if( IP::isIPAddress( $this->getName() ) ) { + if ( IP::isIPAddress( $this->getName() ) ) { $ip = $this->getName(); - } elseif( !$ip ) { + } elseif ( !$ip ) { $ip = $this->getRequest()->getIP(); } $blocked = false; @@ -1653,13 +1698,14 @@ class User { /** * Check if user account is locked * - * @return Bool True if locked, false otherwise + * @return bool True if locked, false otherwise */ public function isLocked() { - if( $this->mLocked !== null ) { + if ( $this->mLocked !== null ) { return $this->mLocked; } global $wgAuth; + StubObject::unstub( $wgAuth ); $authUser = $wgAuth->getUserInstance( $this ); $this->mLocked = (bool)$authUser->isLocked(); return $this->mLocked; @@ -1668,15 +1714,16 @@ class User { /** * Check if user account is hidden * - * @return Bool True if hidden, false otherwise + * @return bool True if hidden, false otherwise */ public function isHidden() { - if( $this->mHideName !== null ) { + if ( $this->mHideName !== null ) { return $this->mHideName; } $this->getBlockedStatus(); - if( !$this->mHideName ) { + if ( !$this->mHideName ) { global $wgAuth; + StubObject::unstub( $wgAuth ); $authUser = $wgAuth->getUserInstance( $this ); $this->mHideName = (bool)$authUser->isHidden(); } @@ -1685,14 +1732,13 @@ class User { /** * Get the user's ID. - * @return Int The user's ID; 0 if the user is anonymous or nonexistent + * @return int The user's ID; 0 if the user is anonymous or nonexistent */ public function getId() { - if( $this->mId === null && $this->mName !== null - && User::isIP( $this->mName ) ) { + if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) { // Special case, we know the user is anonymous return 0; - } elseif( !$this->isItemLoaded( 'id' ) ) { + } elseif ( !$this->isItemLoaded( 'id' ) ) { // Don't load if this was initialized from an ID $this->load(); } @@ -1701,7 +1747,7 @@ class User { /** * Set the user and reload all fields according to a given ID - * @param $v Int User ID to reload + * @param int $v User ID to reload */ public function setId( $v ) { $this->mId = $v; @@ -1710,16 +1756,16 @@ class User { /** * Get the user name, or the IP of an anonymous user - * @return String User's name or IP address + * @return string User's name or IP address */ public function getName() { if ( $this->isItemLoaded( 'name', 'only' ) ) { - # Special case optimisation + // Special case optimisation return $this->mName; } else { $this->load(); if ( $this->mName === false ) { - # Clean up IPs + // Clean up IPs $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() ); } return $this->mName; @@ -1735,9 +1781,9 @@ class User { * address for an anonymous user to something other than the current * remote IP. * - * @note User::newFromName() has rougly the same function, when the named user + * @note User::newFromName() has roughly the same function, when the named user * does not exist. - * @param $str String New user name to set + * @param string $str New user name to set */ public function setName( $str ) { $this->load(); @@ -1746,7 +1792,7 @@ class User { /** * Get the user's name escaped by underscores. - * @return String Username escaped by underscores. + * @return string Username escaped by underscores. */ public function getTitleKey() { return str_replace( ' ', '_', $this->getName() ); @@ -1754,27 +1800,27 @@ class User { /** * Check if the user has new messages. - * @return Bool True if the user has new messages + * @return bool True if the user has new messages */ public function getNewtalk() { $this->load(); - # Load the newtalk status if it is unloaded (mNewtalk=-1) - if( $this->mNewtalk === -1 ) { + // Load the newtalk status if it is unloaded (mNewtalk=-1) + if ( $this->mNewtalk === -1 ) { $this->mNewtalk = false; # reset talk page status - # Check memcached separately for anons, who have no - # entire User object stored in there. - if( !$this->mId ) { + // Check memcached separately for anons, who have no + // entire User object stored in there. + if ( !$this->mId ) { global $wgDisableAnonTalk; - if( $wgDisableAnonTalk ) { + if ( $wgDisableAnonTalk ) { // Anon newtalk disabled by configuration. $this->mNewtalk = false; } else { global $wgMemc; $key = wfMemcKey( 'newtalk', 'ip', $this->getName() ); $newtalk = $wgMemc->get( $key ); - if( strval( $newtalk ) !== '' ) { + if ( strval( $newtalk ) !== '' ) { $this->mNewtalk = (bool)$newtalk; } else { // Since we are caching this, make sure it is up to date by getting it @@ -1792,14 +1838,23 @@ class User { } /** - * Return the talk page(s) this user has new messages on. - * @return Array of String page URLs + * Return the data needed to construct links for new talk page message + * alerts. If there are new messages, this will return an associative array + * with the following data: + * wiki: The database name of the wiki + * link: Root-relative link to the user's talk page + * rev: The last talk page revision that the user has seen or null. This + * is useful for building diff links. + * If there are no new messages, it returns an empty array. + * @note This function was designed to accomodate multiple talk pages, but + * currently only returns a single link and revision. + * @return Array */ public function getNewMessageLinks() { $talks = array(); - if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) { + if ( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) { return $talks; - } elseif( !$this->getNewtalk() ) { + } elseif ( !$this->getNewtalk() ) { return array(); } $utp = $this->getTalkPage(); @@ -1814,13 +1869,36 @@ class User { } /** + * Get the revision ID for the last talk page revision viewed by the talk + * page owner. + * @return int|null Revision ID or null + */ + public function getNewMessageRevisionId() { + $newMessageRevisionId = null; + $newMessageLinks = $this->getNewMessageLinks(); + if ( $newMessageLinks ) { + // Note: getNewMessageLinks() never returns more than a single link + // and it is always for the same wiki, but we double-check here in + // case that changes some time in the future. + if ( count( $newMessageLinks ) === 1 + && $newMessageLinks[0]['wiki'] === wfWikiID() + && $newMessageLinks[0]['rev'] + ) { + $newMessageRevision = $newMessageLinks[0]['rev']; + $newMessageRevisionId = $newMessageRevision->getId(); + } + } + return $newMessageRevisionId; + } + + /** * Internal uncached check for new messages * * @see getNewtalk() - * @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 - * @param $fromMaster Bool true to fetch from the master, false for a slave - * @return Bool True if the user has new messages + * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise + * @param string|int $id User's IP address for anonymous users, User ID otherwise + * @param bool $fromMaster true to fetch from the master, false for a slave + * @return bool True if the user has new messages */ protected function checkNewtalk( $field, $id, $fromMaster = false ) { if ( $fromMaster ) { @@ -1835,10 +1913,10 @@ class User { /** * Add or update the new messages flag - * @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 + * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise + * @param string|int $id User's IP address for anonymous users, User ID otherwise * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null. - * @return Bool True if successful, false otherwise + * @return bool True if successful, false otherwise */ protected function updateNewtalk( $field, $id, $curRev = null ) { // Get timestamp of the talk page revision prior to the current one @@ -1861,9 +1939,9 @@ class User { /** * Clear the new messages flag for the given 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 + * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise + * @param string|int $id User's IP address for anonymous users, User ID otherwise + * @return bool True if successful, false otherwise */ protected function deleteNewtalk( $field, $id ) { $dbw = wfGetDB( DB_MASTER ); @@ -1881,18 +1959,18 @@ class User { /** * Update the 'You have new messages!' status. - * @param $val Bool Whether the user has new messages + * @param bool $val Whether the user has new messages * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val. */ public function setNewtalk( $val, $curRev = null ) { - if( wfReadOnly() ) { + if ( wfReadOnly() ) { return; } $this->load(); $this->mNewtalk = $val; - if( $this->isAnon() ) { + if ( $this->isAnon() ) { $field = 'user_ip'; $id = $this->getName(); } else { @@ -1901,13 +1979,13 @@ class User { } global $wgMemc; - if( $val ) { + if ( $val ) { $changed = $this->updateNewtalk( $field, $id, $curRev ); } else { $changed = $this->deleteNewtalk( $field, $id ); } - if( $this->isAnon() ) { + if ( $this->isAnon() ) { // Anons have a separate memcached space, since // user records aren't kept for them. $key = wfMemcKey( 'newtalk', 'ip', $id ); @@ -1921,7 +1999,7 @@ class User { /** * Generate a current or new-future timestamp to be stored in the * user_touched field when we update things. - * @return String Timestamp in TS_MW format + * @return string Timestamp in TS_MW format */ private static function newTouchedTimestamp() { global $wgClockSkewFudge; @@ -1937,7 +2015,7 @@ class User { */ private function clearSharedCache() { $this->load(); - if( $this->mId ) { + if ( $this->mId ) { global $wgMemc; $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId ) ); } @@ -1949,36 +2027,37 @@ class User { * for reload on the next hit. */ public function invalidateCache() { - if( wfReadOnly() ) { + if ( wfReadOnly() ) { return; } $this->load(); - if( $this->mId ) { + if ( $this->mId ) { $this->mTouched = self::newTouchedTimestamp(); $dbw = wfGetDB( DB_MASTER ); - - // Prevent contention slams by checking user_touched first - $now = $dbw->timestamp( $this->mTouched ); - $needsPurge = $dbw->selectField( 'user', '1', - array( 'user_id' => $this->mId, 'user_touched < ' . $dbw->addQuotes( $now ) ) - ); - if ( $needsPurge ) { - $dbw->update( 'user', - array( 'user_touched' => $now ), - array( 'user_id' => $this->mId, 'user_touched < ' . $dbw->addQuotes( $now ) ), - __METHOD__ - ); - } - + $userid = $this->mId; + $touched = $this->mTouched; + $method = __METHOD__; + $dbw->onTransactionIdle( function() use ( $dbw, $userid, $touched, $method ) { + // Prevent contention slams by checking user_touched first + $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) ); + $needsPurge = $dbw->selectField( 'user', '1', + array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) ); + if ( $needsPurge ) { + $dbw->update( 'user', + array( 'user_touched' => $dbw->timestamp( $touched ) ), + array( 'user_id' => $userid, 'user_touched < ' . $encTouched ), + $method + ); + } + } ); $this->clearSharedCache(); } } /** * Validate the cache for this account. - * @param $timestamp String A timestamp in TS_MW format - * + * @param string $timestamp A timestamp in TS_MW format * @return bool */ public function validateCache( $timestamp ) { @@ -1988,7 +2067,7 @@ class User { /** * Get the user touched timestamp - * @return String timestamp + * @return string timestamp */ public function getTouched() { $this->load(); @@ -2006,7 +2085,7 @@ class User { * wipes it, so the account cannot be logged in until * a new password is set, for instance via e-mail. * - * @param $str String New password to set + * @param string $str New password to set * @throws PasswordError on failure * * @return bool @@ -2014,12 +2093,12 @@ class User { public function setPassword( $str ) { global $wgAuth; - if( $str !== null ) { - if( !$wgAuth->allowPasswordChange() ) { + if ( $str !== null ) { + if ( !$wgAuth->allowPasswordChange() ) { throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() ); } - if( !$this->isValidPassword( $str ) ) { + if ( !$this->isValidPassword( $str ) ) { global $wgMinimalPasswordLength; $valid = $this->getPasswordValidity( $str ); if ( is_array( $valid ) ) { @@ -2033,7 +2112,7 @@ class User { } } - if( !$wgAuth->setPassword( $this, $str ) ) { + if ( !$wgAuth->setPassword( $this, $str ) ) { throw new PasswordError( wfMessage( 'externaldberror' )->text() ); } @@ -2045,13 +2124,15 @@ class User { /** * Set the password and reset the random token unconditionally. * - * @param $str String New password to set + * @param string|null $str New password to set or null to set an invalid + * password hash meaning that the user will not be able to log in + * through the web interface. */ public function setInternalPassword( $str ) { $this->load(); $this->setToken(); - if( $str === null ) { + if ( $str === null ) { // Save an invalid hash... $this->mPassword = ''; } else { @@ -2063,8 +2144,8 @@ class User { /** * Get the user's current token. - * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility) - * @return String Token + * @param bool $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility) + * @return string Token */ public function getToken( $forceCreation = true ) { $this->load(); @@ -2078,7 +2159,7 @@ class User { * Set the random token (used for persistent authentication) * Called from loadDefaults() among other places. * - * @param $token String|bool If specified, set the token to this value + * @param string|bool $token If specified, set the token to this value */ public function setToken( $token = false ) { $this->load(); @@ -2092,8 +2173,8 @@ class User { /** * Set the password for a password reminder or new account email * - * @param $str String New password to set - * @param $throttle Bool If true, reset the throttle timestamp to the present + * @param string $str New password to set + * @param bool $throttle If true, reset the throttle timestamp to the present */ public function setNewpassword( $str, $throttle = true ) { $this->load(); @@ -2106,7 +2187,7 @@ class User { /** * Has password reminder email been sent within the last * $wgPasswordReminderResendTime hours? - * @return Bool + * @return bool */ public function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; @@ -2120,7 +2201,7 @@ class User { /** * Get the user's e-mail address - * @return String User's email address + * @return string User's email address */ public function getEmail() { $this->load(); @@ -2130,7 +2211,7 @@ class User { /** * Get the timestamp of the user's e-mail authentication - * @return String TS_MW timestamp + * @return string TS_MW timestamp */ public function getEmailAuthenticationTimestamp() { $this->load(); @@ -2140,11 +2221,11 @@ class User { /** * Set the user's e-mail address - * @param $str String New e-mail address + * @param string $str New e-mail address */ public function setEmail( $str ) { $this->load(); - if( $str == $this->mEmail ) { + if ( $str == $this->mEmail ) { return; } $this->mEmail = $str; @@ -2156,7 +2237,7 @@ class User { * Set the user's e-mail address and a confirmation mail if needed. * * @since 1.20 - * @param $str String New e-mail address + * @param string $str New e-mail address * @return Status */ public function setEmailWithConfirmation( $str ) { @@ -2174,11 +2255,11 @@ class User { $this->setEmail( $str ); if ( $str !== '' && $wgEmailAuthentication ) { - # Send a confirmation request to the new address if needed + // Send a confirmation request to the new address if needed $type = $oldaddr != '' ? 'changed' : 'set'; $result = $this->sendConfirmationMail( $type ); if ( $result->isGood() ) { - # Say the the caller that a confirmation mail has been sent + // Say the the caller that a confirmation mail has been sent $result->value = 'eauth'; } } else { @@ -2190,7 +2271,7 @@ class User { /** * Get the user's real name - * @return String User's real name + * @return string User's real name */ public function getRealName() { if ( !$this->isItemLoaded( 'realname' ) ) { @@ -2202,7 +2283,7 @@ class User { /** * Set the user's real name - * @param $str String New real name + * @param string $str New real name */ public function setRealName( $str ) { $this->load(); @@ -2212,10 +2293,10 @@ class User { /** * Get the user's current setting for a given option. * - * @param $oname String The option to check - * @param $defaultOverride String A default value returned if the option does not exist - * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs - * @return String User's current value for the option + * @param string $oname The option to check + * @param string $defaultOverride A default value returned if the option does not exist + * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs + * @return string User's current value for the option * @see getBoolOption() * @see getIntOption() */ @@ -2223,19 +2304,12 @@ class User { global $wgHiddenPrefs; $this->loadOptions(); - if ( is_null( $this->mOptions ) ) { - if($defaultOverride != '') { - return $defaultOverride; - } - $this->mOptions = User::getDefaultOptions(); - } - # We want 'disabled' preferences to always behave as the default value for # users, even if they have set the option explicitly in their settings (ie they # set it, and then it was disabled removing their ability to change it). But # we don't want to erase the preferences in the database in case the preference # is re-enabled again. So don't touch $mOptions, just override the returned value - if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){ + if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) { return self::getDefaultOption( $oname ); } @@ -2261,9 +2335,9 @@ class User { # set it, and then it was disabled removing their ability to change it). But # we don't want to erase the preferences in the database in case the preference # is re-enabled again. So don't touch $mOptions, just override the returned value - foreach( $wgHiddenPrefs as $pref ){ + foreach ( $wgHiddenPrefs as $pref ) { $default = self::getDefaultOption( $pref ); - if( $default !== null ){ + if ( $default !== null ) { $options[$pref] = $default; } } @@ -2274,8 +2348,8 @@ class User { /** * Get the user's current setting for a given option, as a boolean value. * - * @param $oname String The option to check - * @return Bool User's current value for the option + * @param string $oname The option to check + * @return bool User's current value for the option * @see getOption() */ public function getBoolOption( $oname ) { @@ -2283,16 +2357,16 @@ class User { } /** - * Get the user's current setting for a given option, as a boolean value. + * Get the user's current setting for a given option, as an integer value. * - * @param $oname String The option to check - * @param $defaultOverride Int A default value returned if the option does not exist - * @return Int User's current value for the option + * @param string $oname The option to check + * @param int $defaultOverride A default value returned if the option does not exist + * @return int User's current value for the option * @see getOption() */ - public function getIntOption( $oname, $defaultOverride=0 ) { + public function getIntOption( $oname, $defaultOverride = 0 ) { $val = $this->getOption( $oname ); - if( $val == '' ) { + if ( $val == '' ) { $val = $defaultOverride; } return intval( $val ); @@ -2301,37 +2375,222 @@ class User { /** * Set the given option for a user. * - * @param $oname String The option to set - * @param $val mixed New value to set + * @param string $oname The option to set + * @param mixed $val New value to set */ public function setOption( $oname, $val ) { - $this->load(); $this->loadOptions(); // Explicitly NULL values should refer to defaults - if( is_null( $val ) ) { - $defaultOption = self::getDefaultOption( $oname ); - if( !is_null( $defaultOption ) ) { - $val = $defaultOption; - } + if ( is_null( $val ) ) { + $val = self::getDefaultOption( $oname ); } $this->mOptions[$oname] = $val; } /** - * Reset all options to the site defaults + * Get a token stored in the preferences (like the watchlist one), + * resetting it if it's empty (and saving changes). + * + * @param string $oname The option name to retrieve the token from + * @return string|bool User's current value for the option, or false if this option is disabled. + * @see resetTokenFromOption() + * @see getOption() */ - public function resetOptions() { + public function getTokenFromOption( $oname ) { + global $wgHiddenPrefs; + if ( in_array( $oname, $wgHiddenPrefs ) ) { + return false; + } + + $token = $this->getOption( $oname ); + if ( !$token ) { + $token = $this->resetTokenFromOption( $oname ); + $this->saveSettings(); + } + return $token; + } + + /** + * Reset a token stored in the preferences (like the watchlist one). + * *Does not* save user's preferences (similarly to setOption()). + * + * @param string $oname The option name to reset the token in + * @return string|bool New token value, or false if this option is disabled. + * @see getTokenFromOption() + * @see setOption() + */ + public function resetTokenFromOption( $oname ) { + global $wgHiddenPrefs; + if ( in_array( $oname, $wgHiddenPrefs ) ) { + return false; + } + + $token = MWCryptRand::generateHex( 40 ); + $this->setOption( $oname, $token ); + return $token; + } + + /** + * Return a list of the types of user options currently returned by + * User::getOptionKinds(). + * + * Currently, the option kinds are: + * - 'registered' - preferences which are registered in core MediaWiki or + * by extensions using the UserGetDefaultOptions hook. + * - 'registered-multiselect' - as above, using the 'multiselect' type. + * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type. + * - 'userjs' - preferences with names starting with 'userjs-', intended to + * be used by user scripts. + * - 'unused' - preferences about which MediaWiki doesn't know anything. + * These are usually legacy options, removed in newer versions. + * + * The API (and possibly others) use this function to determine the possible + * option types for validation purposes, so make sure to update this when a + * new option kind is added. + * + * @see User::getOptionKinds + * @return array Option kinds + */ + public static function listOptionKinds() { + return array( + 'registered', + 'registered-multiselect', + 'registered-checkmatrix', + 'userjs', + 'unused' + ); + } + + /** + * Return an associative array mapping preferences keys to the kind of a preference they're + * used for. Different kinds are handled differently when setting or reading preferences. + * + * See User::listOptionKinds for the list of valid option types that can be provided. + * + * @see User::listOptionKinds + * @param $context IContextSource + * @param array $options assoc. array with options keys to check as keys. Defaults to $this->mOptions. + * @return array the key => kind mapping data + */ + public function getOptionKinds( IContextSource $context, $options = null ) { + $this->loadOptions(); + if ( $options === null ) { + $options = $this->mOptions; + } + + $prefs = Preferences::getPreferences( $this, $context ); + $mapping = array(); + + // Multiselect and checkmatrix options are stored in the database with + // one key per option, each having a boolean value. Extract those keys. + $multiselectOptions = array(); + foreach ( $prefs as $name => $info ) { + if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) || + ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) { + $opts = HTMLFormField::flattenOptions( $info['options'] ); + $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name; + + foreach ( $opts as $value ) { + $multiselectOptions["$prefix$value"] = true; + } + + unset( $prefs[$name] ); + } + } + $checkmatrixOptions = array(); + foreach ( $prefs as $name => $info ) { + if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) || + ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) { + $columns = HTMLFormField::flattenOptions( $info['columns'] ); + $rows = HTMLFormField::flattenOptions( $info['rows'] ); + $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name; + + foreach ( $columns as $column ) { + foreach ( $rows as $row ) { + $checkmatrixOptions["$prefix-$column-$row"] = true; + } + } + + unset( $prefs[$name] ); + } + } + + // $value is ignored + foreach ( $options as $key => $value ) { + if ( isset( $prefs[$key] ) ) { + $mapping[$key] = 'registered'; + } elseif ( isset( $multiselectOptions[$key] ) ) { + $mapping[$key] = 'registered-multiselect'; + } elseif ( isset( $checkmatrixOptions[$key] ) ) { + $mapping[$key] = 'registered-checkmatrix'; + } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) { + $mapping[$key] = 'userjs'; + } else { + $mapping[$key] = 'unused'; + } + } + + return $mapping; + } + + /** + * Reset certain (or all) options to the site defaults + * + * The optional parameter determines which kinds of preferences will be reset. + * Supported values are everything that can be reported by getOptionKinds() + * and 'all', which forces a reset of *all* preferences and overrides everything else. + * + * @param array|string $resetKinds which kinds of preferences to reset. Defaults to + * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ) + * for backwards-compatibility. + * @param $context IContextSource|null context source used when $resetKinds + * does not contain 'all', passed to getOptionKinds(). + * Defaults to RequestContext::getMain() when null. + */ + public function resetOptions( + $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ), + IContextSource $context = null + ) { $this->load(); + $defaultOptions = self::getDefaultOptions(); - $this->mOptions = self::getDefaultOptions(); + if ( !is_array( $resetKinds ) ) { + $resetKinds = array( $resetKinds ); + } + + if ( in_array( 'all', $resetKinds ) ) { + $newOptions = $defaultOptions; + } else { + if ( $context === null ) { + $context = RequestContext::getMain(); + } + + $optionKinds = $this->getOptionKinds( $context ); + $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() ); + $newOptions = array(); + + // Use default values for the options that should be deleted, and + // copy old values for the ones that shouldn't. + foreach ( $this->mOptions as $key => $value ) { + if ( in_array( $optionKinds[$key], $resetKinds ) ) { + if ( array_key_exists( $key, $defaultOptions ) ) { + $newOptions[$key] = $defaultOptions[$key]; + } + } else { + $newOptions[$key] = $value; + } + } + } + + $this->mOptions = $newOptions; $this->mOptionsLoaded = true; } /** * Get the user's preferred date format. - * @return String User's preferred date format + * @return string User's preferred date format */ public function getDatePreference() { // Important migration for old data rows @@ -2348,16 +2607,36 @@ class User { } /** + * Determine based on the wiki configuration and the user's options, + * whether this user must be over HTTPS no matter what. + * + * @return bool + */ + public function requiresHTTPS() { + global $wgSecureLogin; + if ( !$wgSecureLogin ) { + return false; + } else { + $https = $this->getBoolOption( 'prefershttps' ); + wfRunHooks( 'UserRequiresHTTPS', array( $this, &$https ) ); + if ( $https ) { + $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() ); + } + return $https; + } + } + + /** * Get the user preferred stub threshold * * @return int */ public function getStubThreshold() { global $wgMaxArticleSize; # Maximum article size, in Kb - $threshold = intval( $this->getOption( 'stubthreshold' ) ); + $threshold = $this->getIntOption( 'stubthreshold' ); if ( $threshold > $wgMaxArticleSize * 1024 ) { - # If they have set an impossible value, disable the preference - # so we can use the parser cache again. + // If they have set an impossible value, disable the preference + // so we can use the parser cache again. $threshold = 0; } return $threshold; @@ -2372,7 +2651,7 @@ class User { $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() ); wfRunHooks( 'UserGetRights', array( $this, &$this->mRights ) ); // Force reindexation of rights when a hook has unset one of them - $this->mRights = array_values( $this->mRights ); + $this->mRights = array_values( array_unique( $this->mRights ) ); } return $this->mRights; } @@ -2392,7 +2671,7 @@ class User { * Get the list of implicit group memberships this user has. * This includes all explicit groups, plus 'user' if logged in, * '*' for all accounts, and autopromoted groups - * @param $recache Bool Whether to avoid the cache + * @param bool $recache Whether to avoid the cache * @return Array of String internal group names */ public function getEffectiveGroups( $recache = false ) { @@ -2402,8 +2681,10 @@ class User { $this->getGroups(), // explicit groups $this->getAutomaticGroups( $recache ) // implicit groups ) ); - # Hook for additional groups + // Hook for additional groups wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) ); + // Force reindexation of groups when a hook has unset one of them + $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) ); wfProfileOut( __METHOD__ ); } return $this->mEffectiveGroups; @@ -2413,7 +2694,7 @@ class User { * 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 + * @param bool $recache Whether to avoid the cache * @return Array of String internal group names */ public function getAutomaticGroups( $recache = false ) { @@ -2429,8 +2710,8 @@ class User { ) ); } if ( $recache ) { - # Assure data consistency with rights/groups, - # as getEffectiveGroups() depends on this function + // Assure data consistency with rights/groups, + // as getEffectiveGroups() depends on this function $this->mEffectiveGroups = null; } wfProfileOut( __METHOD__ ); @@ -2448,14 +2729,14 @@ class User { * @return array Names of the groups the user has belonged to. */ public function getFormerGroups() { - if( is_null( $this->mFormerGroups ) ) { + 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 ) { + foreach ( $res as $row ) { $this->mFormerGroups[] = $row->ufg_group; } } @@ -2464,33 +2745,46 @@ class User { /** * Get the user's edit count. - * @return Int + * @return int, null for anonymous users */ public function getEditCount() { - if( $this->getId() ) { - if ( !isset( $this->mEditCount ) ) { - /* Populate the count, if it has not been populated yet */ - $this->mEditCount = User::edits( $this->mId ); - } - return $this->mEditCount; - } else { - /* nil */ + if ( !$this->getId() ) { return null; } + + if ( !isset( $this->mEditCount ) ) { + /* Populate the count, if it has not been populated yet */ + wfProfileIn( __METHOD__ ); + $dbr = wfGetDB( DB_SLAVE ); + // check if the user_editcount field has been initialized + $count = $dbr->selectField( + 'user', 'user_editcount', + array( 'user_id' => $this->mId ), + __METHOD__ + ); + + if ( $count === null ) { + // it has not been initialized. do so. + $count = $this->initEditCount(); + } + $this->mEditCount = $count; + wfProfileOut( __METHOD__ ); + } + return (int)$this->mEditCount; } /** * Add the user to the given group. * This takes immediate effect. - * @param $group String Name of the group to add + * @param string $group Name of the group to add */ public function addGroup( $group ) { - if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) { + if ( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) { $dbw = wfGetDB( DB_MASTER ); - if( $this->getId() ) { + if ( $this->getId() ) { $dbw->insert( 'user_groups', array( - 'ug_user' => $this->getID(), + 'ug_user' => $this->getID(), 'ug_group' => $group, ), __METHOD__, @@ -2499,7 +2793,14 @@ class User { } $this->loadGroups(); $this->mGroups[] = $group; - $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) ); + // In case loadGroups was not called before, we now have the right twice. + // Get rid of the duplicate. + $this->mGroups = array_unique( $this->mGroups ); + + // Refresh the groups caches, and clear the rights cache so it will be + // refreshed on the next call to $this->getRights(). + $this->getEffectiveGroups( true ); + $this->mRights = null; $this->invalidateCache(); } @@ -2507,21 +2808,21 @@ class User { /** * Remove the user from the given group. * This takes immediate effect. - * @param $group String Name of the group to remove + * @param string $group Name of the group to remove */ 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_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_user' => $this->getID(), 'ufg_group' => $group, ), __METHOD__, @@ -2529,14 +2830,18 @@ class User { } $this->loadGroups(); $this->mGroups = array_diff( $this->mGroups, array( $group ) ); - $this->mRights = User::getGroupPermissions( $this->getEffectiveGroups( true ) ); + + // Refresh the groups caches, and clear the rights cache so it will be + // refreshed on the next call to $this->getRights(). + $this->getEffectiveGroups( true ); + $this->mRights = null; $this->invalidateCache(); } /** * Get whether the user is logged in - * @return Bool + * @return bool */ public function isLoggedIn() { return $this->getID() != 0; @@ -2544,7 +2849,7 @@ class User { /** * Get whether the user is anonymous - * @return Bool + * @return bool */ public function isAnon() { return !$this->isLoggedIn(); @@ -2554,14 +2859,14 @@ class User { * Check if user is allowed to access a feature / make an action * * @internal param \String $varargs permissions to test - * @return Boolean: True if user is allowed to perform *any* of the given actions + * @return boolean: True if user is allowed to perform *any* of the given actions * * @return bool */ - public function isAllowedAny( /*...*/ ){ + public function isAllowedAny( /*...*/ ) { $permissions = func_get_args(); - foreach( $permissions as $permission ){ - if( $this->isAllowed( $permission ) ){ + foreach ( $permissions as $permission ) { + if ( $this->isAllowed( $permission ) ) { return true; } } @@ -2573,10 +2878,10 @@ class User { * @internal param $varargs string * @return bool True if the user is allowed to perform *all* of the given actions */ - public function isAllowedAll( /*...*/ ){ + public function isAllowedAll( /*...*/ ) { $permissions = func_get_args(); - foreach( $permissions as $permission ){ - if( !$this->isAllowed( $permission ) ){ + foreach ( $permissions as $permission ) { + if ( !$this->isAllowed( $permission ) ) { return false; } } @@ -2585,27 +2890,28 @@ class User { /** * Internal mechanics of testing a permission - * @param $action String + * @param string $action * @return bool */ public function isAllowed( $action = '' ) { if ( $action === '' ) { return true; // In the spirit of DWIM } - # Patrolling may not be enabled - if( $action === 'patrol' || $action === 'autopatrol' ) { + // Patrolling may not be enabled + if ( $action === 'patrol' || $action === 'autopatrol' ) { global $wgUseRCPatrol, $wgUseNPPatrol; - if( !$wgUseRCPatrol && !$wgUseNPPatrol ) + if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) { return false; + } } - # Use strict parameter to avoid matching numeric 0 accidentally inserted - # by misconfiguration: 0 == 'foo' + // Use strict parameter to avoid matching numeric 0 accidentally inserted + // by misconfiguration: 0 == 'foo' return in_array( $action, $this->getRights(), true ); } /** * Check whether to enable recent changes patrol features for this user - * @return Boolean: True or false + * @return boolean: True or false */ public function useRCPatrol() { global $wgUseRCPatrol; @@ -2614,11 +2920,14 @@ class User { /** * Check whether to enable new pages patrol features for this user - * @return Bool True or false + * @return bool True or false */ public function useNPPatrol() { global $wgUseRCPatrol, $wgUseNPPatrol; - return( ( $wgUseRCPatrol || $wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) ); + return ( + ( $wgUseRCPatrol || $wgUseNPPatrol ) + && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) + ); } /** @@ -2649,11 +2958,14 @@ class User { /** * Get a WatchedItem for this user and $title. * + * @since 1.22 $checkRights parameter added * @param $title Title + * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights. + * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS. * @return WatchedItem */ - public function getWatchedItem( $title ) { - $key = $title->getNamespace() . ':' . $title->getDBkey(); + public function getWatchedItem( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) { + $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey(); if ( isset( $this->mWatchedItems[$key] ) ) { return $this->mWatchedItems[$key]; @@ -2663,34 +2975,43 @@ class User { $this->mWatchedItems = array(); } - $this->mWatchedItems[$key] = WatchedItem::fromUserTitle( $this, $title ); + $this->mWatchedItems[$key] = WatchedItem::fromUserTitle( $this, $title, $checkRights ); return $this->mWatchedItems[$key]; } /** * Check the watched status of an article. + * @since 1.22 $checkRights parameter added * @param $title Title of the article to look at - * @return Bool + * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights. + * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS. + * @return bool */ - public function isWatched( $title ) { - return $this->getWatchedItem( $title )->isWatched(); + public function isWatched( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) { + return $this->getWatchedItem( $title, $checkRights )->isWatched(); } /** * Watch an article. + * @since 1.22 $checkRights parameter added * @param $title Title of the article to look at + * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights. + * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS. */ - public function addWatch( $title ) { - $this->getWatchedItem( $title )->addWatch(); + public function addWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) { + $this->getWatchedItem( $title, $checkRights )->addWatch(); $this->invalidateCache(); } /** * Stop watching an article. + * @since 1.22 $checkRights parameter added * @param $title Title of the article to look at + * @param $checkRights int Whether to check 'viewmywatchlist'/'editmywatchlist' rights. + * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS. */ - public function removeWatch( $title ) { - $this->getWatchedItem( $title )->removeWatch(); + public function removeWatch( $title, $checkRights = WatchedItem::CHECK_USER_RIGHTS ) { + $this->getWatchedItem( $title, $checkRights )->removeWatch(); $this->invalidateCache(); } @@ -2698,28 +3019,35 @@ class User { * 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. + * @note If the user doesn't have 'editmywatchlist', this will do nothing. * @param $title Title of the article to look at */ public function clearNotification( &$title ) { global $wgUseEnotif, $wgShowUpdatedMarker; - # Do nothing if the database is locked to writes - if( wfReadOnly() ) { + // Do nothing if the database is locked to writes + if ( wfReadOnly() ) { return; } - if( $title->getNamespace() == NS_USER_TALK && + // Do nothing if not allowed to edit the watchlist + if ( !$this->isAllowed( 'editmywatchlist' ) ) { + return; + } + + if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) { - if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) ) + if ( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) ) { return; + } $this->setNewtalk( false ); } - if( !$wgUseEnotif && !$wgShowUpdatedMarker ) { + if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) { return; } - if( $this->isAnon() ) { + if ( $this->isAnon() ) { // Nothing else to do... return; } @@ -2742,15 +3070,25 @@ 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. + * @note If the user doesn't have 'editmywatchlist', this will do nothing. */ public function clearAllNotifications() { + if ( wfReadOnly() ) { + return; + } + + // Do nothing if not allowed to edit the watchlist + if ( !$this->isAllowed( 'editmywatchlist' ) ) { + return; + } + global $wgUseEnotif, $wgShowUpdatedMarker; if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) { $this->setNewtalk( false ); return; } $id = $this->getId(); - if( $id != 0 ) { + if ( $id != 0 ) { $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'watchlist', array( /* SET */ @@ -2766,14 +3104,15 @@ class User { /** * Set this user's options from an encoded string - * @param $str String Encoded options to import + * @param string $str Encoded options to import * * @deprecated in 1.19 due to removal of user_options from the user table */ private function decodeOptions( $str ) { wfDeprecated( __METHOD__, '1.19' ); - if( !$str ) + if ( !$str ) { return; + } $this->mOptionsLoaded = true; $this->mOptionOverrides = array(); @@ -2794,21 +3133,32 @@ class User { /** * Set a cookie on the user's client. Wrapper for * WebResponse::setCookie - * @param $name String Name of the cookie to set - * @param $value String Value to set - * @param $exp Int Expiration time, as a UNIX time value; + * @param string $name Name of the cookie to set + * @param string $value Value to set + * @param int $exp Expiration time, as a UNIX time value; * if 0 or not specified, use the default $wgCookieExpiration + * @param bool $secure + * true: Force setting the secure attribute when setting the cookie + * false: Force NOT setting the secure attribute when setting the cookie + * null (default): Use the default ($wgCookieSecure) to set the secure attribute + * @param array $params Array of options sent passed to WebResponse::setcookie() */ - protected function setCookie( $name, $value, $exp = 0 ) { - $this->getRequest()->response()->setcookie( $name, $value, $exp ); + protected function setCookie( $name, $value, $exp = 0, $secure = null, $params = array() ) { + $params['secure'] = $secure; + $this->getRequest()->response()->setcookie( $name, $value, $exp, $params ); } /** * Clear a cookie on the user's client - * @param $name String Name of the cookie to clear + * @param string $name Name of the cookie to clear + * @param bool $secure + * true: Force setting the secure attribute when setting the cookie + * false: Force NOT setting the secure attribute when setting the cookie + * null (default): Use the default ($wgCookieSecure) to set the secure attribute + * @param array $params Array of options sent passed to WebResponse::setcookie() */ - protected function clearCookie( $name ) { - $this->setCookie( $name, '', time() - 86400 ); + protected function clearCookie( $name, $secure = null, $params = array() ) { + $this->setCookie( $name, '', time() - 86400, $secure, $params ); } /** @@ -2816,14 +3166,17 @@ class User { * * @param $request WebRequest object to use; $wgRequest will be used if null * is passed. + * @param bool $secure Whether to force secure/insecure cookies or use default */ - public function setCookies( $request = null ) { + public function setCookies( $request = null, $secure = null ) { if ( $request === null ) { $request = $this->getRequest(); } $this->load(); - if ( 0 == $this->mId ) return; + 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 @@ -2856,8 +3209,29 @@ class User { if ( $value === false ) { $this->clearCookie( $name ); } else { - $this->setCookie( $name, $value ); + $this->setCookie( $name, $value, 0, $secure ); + } + } + + /** + * If wpStickHTTPS was selected, also set an insecure cookie that + * will cause the site to redirect the user to HTTPS, if they access + * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same + * as the one set by centralauth (bug 53538). Also set it to session, or + * standard time setting, based on if rememberme was set. + */ + if ( $request->getCheck( 'wpStickHTTPS' ) || $this->requiresHTTPS() ) { + $time = null; + if ( ( 1 == $this->getOption( 'rememberpassword' ) ) ) { + $time = 0; // set to $wgCookieExpiration } + $this->setCookie( + 'forceHTTPS', + 'true', + $time, + false, + array( 'prefix' => '' ) // no prefix + ); } } @@ -2865,7 +3239,7 @@ class User { * Log this user out. */ public function logout() { - if( wfRunHooks( 'UserLogout', array( &$this ) ) ) { + if ( wfRunHooks( 'UserLogout', array( &$this ) ) ) { $this->doLogout(); } } @@ -2881,9 +3255,10 @@ class User { $this->clearCookie( 'UserID' ); $this->clearCookie( 'Token' ); + $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) ); - # Remember when user logged out, to prevent seeing cached pages - $this->setCookie( 'LoggedOut', wfTimestampNow(), time() + 86400 ); + // Remember when user logged out, to prevent seeing cached pages + $this->setCookie( 'LoggedOut', time(), time() + 86400 ); } /** @@ -2894,8 +3269,12 @@ class User { global $wgAuth; $this->load(); - if ( wfReadOnly() ) { return; } - if ( 0 == $this->mId ) { return; } + if ( wfReadOnly() ) { + return; + } + if ( 0 == $this->mId ) { + return; + } $this->mTouched = self::newTouchedTimestamp(); if ( !$wgAuth->allowSetLocalPassword() ) { @@ -2930,11 +3309,13 @@ class User { /** * If only this user's username is known, and it exists, return the user ID. - * @return Int + * @return int */ public function idForName() { $s = trim( $this->getName() ); - if ( $s === '' ) return 0; + if ( $s === '' ) { + return 0; + } $dbr = wfGetDB( DB_SLAVE ); $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__ ); @@ -2947,8 +3328,8 @@ class User { /** * Add a user to the database, return the user object * - * @param $name String Username to add - * @param $params Array of Strings Non-default parameters to save to the database as user_* fields: + * @param string $name Username to add + * @param array $params of Strings Non-default parameters to save to the database as user_* fields: * - password The user's password hash. Password logins will be disabled if this is omitted. * - newpassword Hash for a temporary password that has been mailed to the user * - email The user's email address @@ -2963,6 +3344,7 @@ class User { public static function createNew( $name, $params = array() ) { $user = new User; $user->load(); + $user->setToken(); // init token if ( isset( $params['options'] ) ) { $user->mOptions = $params['options'] + (array)$user->mOptions; unset( $params['options'] ); @@ -2997,14 +3379,41 @@ class User { } /** - * Add this existing user object to the database + * Add this existing user object to the database. If the user already + * exists, a fatal status object is returned, and the user object is + * initialised with the data from the database. + * + * Previously, this function generated a DB error due to a key conflict + * if the user already existed. Many extension callers use this function + * in code along the lines of: + * + * $user = User::newFromName( $name ); + * if ( !$user->isLoggedIn() ) { + * $user->addToDatabase(); + * } + * // do something with $user... + * + * However, this was vulnerable to a race condition (bug 16020). By + * initialising the user object if the user exists, we aim to support this + * calling sequence as far as possible. + * + * Note that if the user exists, this function will acquire a write lock, + * so it is still advisable to make the call conditional on isLoggedIn(), + * and to commit the transaction after calling. + * + * @throws MWException + * @return Status */ public function addToDatabase() { $this->load(); + if ( !$this->mToken ) { + $this->setToken(); // init token + } $this->mTouched = self::newTouchedTimestamp(); $dbw = wfGetDB( DB_MASTER ); + $inWrite = $dbw->writesOrCallbacksPending(); $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' ); $dbw->insert( 'user', array( @@ -3020,14 +3429,37 @@ class User { 'user_registration' => $dbw->timestamp( $this->mRegistration ), 'user_editcount' => 0, 'user_touched' => $dbw->timestamp( $this->mTouched ), - ), __METHOD__ + ), __METHOD__, + array( 'IGNORE' ) ); + if ( !$dbw->affectedRows() ) { + if ( !$inWrite ) { + // XXX: Get out of REPEATABLE-READ so the SELECT below works. + // Often this case happens early in views before any writes. + // This shows up at least with CentralAuth. + $dbw->commit( __METHOD__, 'flush' ); + } + $this->mId = $dbw->selectField( 'user', 'user_id', + array( 'user_name' => $this->mName ), __METHOD__ ); + $loaded = false; + if ( $this->mId ) { + if ( $this->loadFromDatabase() ) { + $loaded = true; + } + } + if ( !$loaded ) { + throw new MWException( __METHOD__ . ": hit a key conflict attempting " . + "to insert user '{$this->mName}' row, but it was not present in select!" ); + } + return Status::newFatal( 'userexists' ); + } $this->mId = $dbw->insertId(); // Clear instance cache other than user table data, which is already accurate $this->clearInstanceCache(); $this->saveOptions(); + return Status::newGood(); } /** @@ -3074,13 +3506,13 @@ class User { * settings. * * @deprecated since 1.17 use the ParserOptions object to get the relevant options - * @return String Page rendering hash + * @return string Page rendering hash */ public function getPageRenderingHash() { wfDeprecated( __METHOD__, '1.17' ); - global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang; - if( $this->mHash ){ + global $wgRenderHashAppend, $wgLang, $wgContLang; + if ( $this->mHash ) { return $this->mHash; } @@ -3088,11 +3520,8 @@ class User { // since it disables the parser cache, its value will always // be 0 when this function is called by parsercache. - $confstr = $this->getOption( 'math' ); + $confstr = $this->getOption( 'math' ); $confstr .= '!' . $this->getStubThreshold(); - if ( $wgUseDynamicDates ) { # This is wrong (bug 24714) - $confstr .= '!' . $this->getDatePreference(); - } $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ? '1' : '' ); $confstr .= '!' . $wgLang->getCode(); $confstr .= '!' . $this->getOption( 'thumbsize' ); @@ -3117,18 +3546,18 @@ class User { /** * Get whether the user is explicitly blocked from account creation. - * @return Bool|Block + * @return bool|Block */ public function isBlockedFromCreateAccount() { $this->getBlockedStatus(); - if( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ){ + if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) { return $this->mBlock; } # 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 - if( $this->mBlockedFromCreateAccount === false ){ + if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) { $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() ); } return $this->mBlockedFromCreateAccount instanceof Block && $this->mBlockedFromCreateAccount->prevents( 'createaccount' ) @@ -3138,7 +3567,7 @@ class User { /** * Get whether the user is blocked from using Special:Emailuser. - * @return Bool + * @return bool */ public function isBlockedFromEmailuser() { $this->getBlockedStatus(); @@ -3147,7 +3576,7 @@ class User { /** * Get whether the user is allowed to create an account. - * @return Bool + * @return bool */ function isAllowedToCreateAccount() { return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount(); @@ -3175,7 +3604,7 @@ class User { /** * Determine whether the user is a newbie. Newbies are either * anonymous IPs, or the most recently created accounts. - * @return Bool + * @return bool */ public function isNewbie() { return !$this->isAllowed( 'autoconfirmed' ); @@ -3183,8 +3612,8 @@ class User { /** * Check to see if the given clear-text password is one of the accepted passwords - * @param $password String: user password. - * @return Boolean: True if the given password is correct, otherwise False. + * @param string $password user password. + * @return boolean: True if the given password is correct, otherwise False. */ public function checkPassword( $password ) { global $wgAuth, $wgLegacyEncoding; @@ -3195,24 +3624,24 @@ class User { // to. Certain authentication plugins do NOT want to save // domain passwords in a mysql database, so we should // check this (in case $wgAuth->strict() is false). - if( !$this->isValidPassword( $password ) ) { + if ( !$this->isValidPassword( $password ) ) { return false; } - if( $wgAuth->authenticate( $this->getName(), $password ) ) { + if ( $wgAuth->authenticate( $this->getName(), $password ) ) { return true; - } elseif( $wgAuth->strict() ) { - /* Auth plugin doesn't allow local authentication */ + } elseif ( $wgAuth->strict() ) { + // Auth plugin doesn't allow local authentication return false; - } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) { - /* Auth plugin doesn't allow local authentication for this user name */ + } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) { + // Auth plugin doesn't allow local authentication for this user name return false; } if ( self::comparePasswords( $this->mPassword, $password, $this->mId ) ) { return true; } elseif ( $wgLegacyEncoding ) { - # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted - # Check for this with iconv + // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted + // Check for this with iconv $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password ); if ( $cp1252Password != $password && self::comparePasswords( $this->mPassword, $cp1252Password, $this->mId ) ) @@ -3229,13 +3658,13 @@ class User { * * @param $plaintext string * - * @return Boolean: True if matches, false otherwise + * @return boolean: True if matches, false otherwise */ public function checkTemporaryPassword( $plaintext ) { global $wgNewPasswordExpiry; $this->load(); - if( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) { + if ( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) { if ( is_null( $this->mNewpassTime ) ) { return true; } @@ -3250,9 +3679,9 @@ 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 string|array $salt 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 + * @return string The new edit token */ public function editToken( $salt = '', $request = null ) { wfDeprecated( __METHOD__, '1.19' ); @@ -3267,9 +3696,9 @@ class User { * * @since 1.19 * - * @param $salt String|Array of Strings Optional function-specific data for hashing + * @param string|array $salt 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 + * @return string The new edit token */ public function getEditToken( $salt = '', $request = null ) { if ( $request == null ) { @@ -3284,7 +3713,7 @@ class User { $token = MWCryptRand::generateHex( 32 ); $request->setSessionData( 'wsEditToken', $token ); } - if( is_array( $salt ) ) { + if ( is_array( $salt ) ) { $salt = implode( '|', $salt ); } return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX; @@ -3294,11 +3723,10 @@ class User { /** * Generate a looking random token for various uses. * - * @param $salt String Optional salt value - * @return String The new random token - * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness + * @return string The new random token + * @deprecated since 1.20: Use MWCryptRand for secure purposes or wfRandomString for pseudo-randomness */ - public static function generateToken( $salt = '' ) { + public static function generateToken() { return MWCryptRand::generateHex( 32 ); } @@ -3308,10 +3736,10 @@ class User { * user's own login session, not a form submission from a third-party * site. * - * @param $val String Input value to compare - * @param $salt String Optional function-specific data for hashing - * @param $request WebRequest object to use or null to use $wgRequest - * @return Boolean: Whether the token matches + * @param string $val Input value to compare + * @param string $salt Optional function-specific data for hashing + * @param WebRequest $request Object to use or null to use $wgRequest + * @return boolean: Whether the token matches */ public function matchEditToken( $val, $salt = '', $request = null ) { $sessionToken = $this->getEditToken( $salt, $request ); @@ -3325,10 +3753,10 @@ class User { * Check given value against the token value stored in the session, * ignoring the suffix. * - * @param $val String Input value to compare - * @param $salt String Optional function-specific data for hashing - * @param $request WebRequest object to use or null to use $wgRequest - * @return Boolean: Whether the token matches + * @param string $val Input value to compare + * @param string $salt Optional function-specific data for hashing + * @param WebRequest $request object to use or null to use $wgRequest + * @return boolean: Whether the token matches */ public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) { $sessionToken = $this->getEditToken( $salt, $request ); @@ -3339,7 +3767,7 @@ class User { * Generate a new e-mail confirmation token and send a confirmation/invalidation * mail to the user's given address. * - * @param $type String: message to send, either "created", "changed" or "set" + * @param string $type message to send, either "created", "changed" or "set" * @return Status object */ public function sendConfirmationMail( $type = 'created' ) { @@ -3355,6 +3783,7 @@ class User { } elseif ( $type === true ) { $message = 'confirmemail_body_changed'; } else { + // Messages: confirmemail_body_changed, confirmemail_body_set $message = 'confirmemail_body_' . $type; } @@ -3373,14 +3802,14 @@ class User { * Send an e-mail to this user's account. Does not check for * confirmed status or validity. * - * @param $subject String Message subject - * @param $body String Message body - * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used - * @param $replyto String Reply-To address + * @param string $subject Message subject + * @param string $body Message body + * @param string $from Optional From address; if unspecified, default $wgPasswordSender will be used + * @param string $replyto Reply-To address * @return Status */ public function sendMail( $subject, $body, $from = null, $replyto = null ) { - if( is_null( $from ) ) { + if ( is_null( $from ) ) { global $wgPasswordSender, $wgPasswordSenderName; $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName ); } else { @@ -3399,9 +3828,9 @@ class User { * this change to the database. * * @param &$expiration \mixed Accepts the expiration time - * @return String New token + * @return string New token */ - private function confirmationToken( &$expiration ) { + protected function confirmationToken( &$expiration ) { global $wgUserEmailConfirmationTokenExpiry; $now = time(); $expires = $now + $wgUserEmailConfirmationTokenExpiry; @@ -3415,20 +3844,20 @@ 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 + * Return a URL the user can use to confirm their email address. + * @param string $token Accepts the email confirmation token + * @return string New token URL */ - private function confirmationTokenUrl( $token ) { + protected function confirmationTokenUrl( $token ) { return $this->getTokenUrl( 'ConfirmEmail', $token ); } /** * 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 + * @param string $token Accepts the email confirmation token + * @return string New token URL */ - private function invalidationTokenUrl( $token ) { + protected function invalidationTokenUrl( $token ) { return $this->getTokenUrl( 'InvalidateEmail', $token ); } @@ -3442,14 +3871,14 @@ class User { * also sometimes can get corrupted in some browsers/mailers * (bug 6957 with Gmail and Internet Explorer). * - * @param $page String Special page - * @param $token String Token - * @return String Formatted URL + * @param string $page Special page + * @param string $token Token + * @return string Formatted URL */ protected function getTokenUrl( $page, $token ) { // Hack to bypass localization of 'Special:' $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" ); - return $title->getCanonicalUrl(); + return $title->getCanonicalURL(); } /** @@ -3460,8 +3889,12 @@ class User { * @return bool */ public function confirmEmail() { - $this->setEmailAuthenticationTimestamp( wfTimestampNow() ); - wfRunHooks( 'ConfirmEmailComplete', array( $this ) ); + // Check if it's already confirmed, so we don't touch the database + // and fire the ConfirmEmailComplete hook on redundant confirmations. + if ( !$this->isEmailConfirmed() ) { + $this->setEmailAuthenticationTimestamp( wfTimestampNow() ); + wfRunHooks( 'ConfirmEmailComplete', array( $this ) ); + } return true; } @@ -3483,7 +3916,7 @@ class User { /** * Set the e-mail authentication timestamp. - * @param $timestamp String TS_MW timestamp + * @param string $timestamp TS_MW timestamp */ function setEmailAuthenticationTimestamp( $timestamp ) { $this->load(); @@ -3494,11 +3927,11 @@ class User { /** * Is this user allowed to send e-mails within limits of current * site configuration? - * @return Bool + * @return bool */ public function canSendEmail() { global $wgEnableEmail, $wgEnableUserEmail; - if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) { + if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) { return false; } $canSend = $this->isEmailConfirmed(); @@ -3509,7 +3942,7 @@ class User { /** * Is this user allowed to receive e-mails within limits of current * site configuration? - * @return Bool + * @return bool */ public function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); @@ -3523,20 +3956,20 @@ class User { * confirmed their address by returning a code or using a password * sent to the address from the wiki. * - * @return Bool + * @return bool */ public function isEmailConfirmed() { global $wgEmailAuthentication; $this->load(); $confirmed = true; - if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) { - if( $this->isAnon() ) { + if ( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) { + if ( $this->isAnon() ) { return false; } - if( !Sanitizer::validateEmail( $this->mEmail ) ) { + if ( !Sanitizer::validateEmail( $this->mEmail ) ) { return false; } - if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) { + if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) { return false; } return true; @@ -3547,7 +3980,7 @@ class User { /** * Check whether there is an outstanding request for e-mail confirmation. - * @return Bool + * @return bool */ public function isEmailConfirmationPending() { global $wgEmailAuthentication; @@ -3560,8 +3993,9 @@ class User { /** * Get the timestamp of account creation. * - * @return String|Bool Timestamp of account creation, or false for - * non-existent/anonymous user accounts. + * @return string|bool|null Timestamp of account creation, false for + * non-existent/anonymous user accounts, or null if existing account + * but information is not in database. */ public function getRegistration() { if ( $this->isAnon() ) { @@ -3574,11 +4008,11 @@ class User { /** * Get the timestamp of the first edit * - * @return String|Bool Timestamp of first edit, or false for - * non-existent/anonymous user accounts. + * @return string|bool Timestamp of first edit, or false for + * non-existent/anonymous user accounts. */ public function getFirstEditTimestamp() { - if( $this->getId() == 0 ) { + if ( $this->getId() == 0 ) { return false; // anons } $dbr = wfGetDB( DB_SLAVE ); @@ -3587,7 +4021,7 @@ class User { __METHOD__, array( 'ORDER BY' => 'rev_timestamp ASC' ) ); - if( !$time ) { + if ( !$time ) { return false; // no edits } return wfTimestamp( TS_MW, $time ); @@ -3596,23 +4030,23 @@ class User { /** * Get the permissions associated with a given list of groups * - * @param $groups Array of Strings List of internal group names + * @param array $groups of Strings List of internal group names * @return Array of Strings List of permission key names for given groups combined */ public static function getGroupPermissions( $groups ) { global $wgGroupPermissions, $wgRevokePermissions; $rights = array(); // grant every granted permission first - foreach( $groups as $group ) { - if( isset( $wgGroupPermissions[$group] ) ) { + foreach ( $groups as $group ) { + if ( isset( $wgGroupPermissions[$group] ) ) { $rights = array_merge( $rights, // array_filter removes empty items array_keys( array_filter( $wgGroupPermissions[$group] ) ) ); } } // now revoke the revoked permissions - foreach( $groups as $group ) { - if( isset( $wgRevokePermissions[$group] ) ) { + foreach ( $groups as $group ) { + if ( isset( $wgRevokePermissions[$group] ) ) { $rights = array_diff( $rights, array_keys( array_filter( $wgRevokePermissions[$group] ) ) ); } @@ -3623,14 +4057,14 @@ class User { /** * Get all the groups who have a given permission * - * @param $role String Role to check + * @param string $role Role to check * @return Array of Strings List of internal group names with the given permission */ public static function getGroupsWithPermission( $role ) { global $wgGroupPermissions; $allowedGroups = array(); - foreach ( $wgGroupPermissions as $group => $rights ) { - if ( isset( $rights[$role] ) && $rights[$role] ) { + foreach ( array_keys( $wgGroupPermissions ) as $group ) { + if ( self::groupHasPermission( $group, $role ) ) { $allowedGroups[] = $group; } } @@ -3638,10 +4072,68 @@ class User { } /** + * Check, if the given group has the given permission + * + * If you're wanting to check whether all users have a permission, use + * User::isEveryoneAllowed() instead. That properly checks if it's revoked + * from anyone. + * + * @since 1.21 + * @param string $group Group to check + * @param string $role Role to check + * @return bool + */ + public static function groupHasPermission( $group, $role ) { + global $wgGroupPermissions, $wgRevokePermissions; + return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role] + && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] ); + } + + /** + * Check if all users have the given permission + * + * @since 1.22 + * @param string $right Right to check + * @return bool + */ + public static function isEveryoneAllowed( $right ) { + global $wgGroupPermissions, $wgRevokePermissions; + static $cache = array(); + + // Use the cached results, except in unit tests which rely on + // being able change the permission mid-request + if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) { + return $cache[$right]; + } + + if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) { + $cache[$right] = false; + return false; + } + + // If it's revoked anywhere, then everyone doesn't have it + foreach ( $wgRevokePermissions as $rights ) { + if ( isset( $rights[$right] ) && $rights[$right] ) { + $cache[$right] = false; + return false; + } + } + + // Allow extensions (e.g. OAuth) to say false + if ( !wfRunHooks( 'UserIsEveryoneAllowed', array( $right ) ) ) { + $cache[$right] = false; + return false; + } + + $cache[$right] = true; + return true; + } + + /** * Get the localized descriptive name for a group, if it exists * - * @param $group String Internal group name - * @return String Localized descriptive group name + * @param string $group Internal group name + * @return string Localized descriptive group name */ public static function getGroupName( $group ) { $msg = wfMessage( "group-$group" ); @@ -3651,9 +4143,9 @@ 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 + * @param string $group Internal group name + * @param string $username Username for gender (since 1.19) + * @return string Localized name for group member */ public static function getGroupMember( $group, $username = '#' ) { $msg = wfMessage( "group-$group-member", $username ); @@ -3705,15 +4197,16 @@ class User { /** * Get the title of a page describing a particular group * - * @param $group String Internal group name - * @return Title|Bool Title of the page if it exists, false otherwise + * @param string $group Internal group name + * @return Title|bool Title of the page if it exists, false otherwise */ public static function getGroupPage( $group ) { $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage(); - if( $msg->exists() ) { + if ( $msg->exists() ) { $title = Title::newFromText( $msg->text() ); - if( is_object( $title ) ) + if ( is_object( $title ) ) { return $title; + } } return false; } @@ -3722,16 +4215,16 @@ class User { * Create a link to the group in HTML, if available; * else return the group name. * - * @param $group String Internal name of the group - * @param $text String The text of the link - * @return String HTML link to the group + * @param string $group Internal name of the group + * @param string $text The text of the link + * @return string HTML link to the group */ public static function makeGroupLinkHTML( $group, $text = '' ) { - if( $text == '' ) { + if ( $text == '' ) { $text = self::getGroupName( $group ); } $title = self::getGroupPage( $group ); - if( $title ) { + if ( $title ) { return Linker::link( $title, htmlspecialchars( $text ) ); } else { return $text; @@ -3742,16 +4235,16 @@ class User { * Create a link to the group in Wikitext, if available; * else return the group name. * - * @param $group String Internal name of the group - * @param $text String The text of the link - * @return String Wikilink to the group + * @param string $group Internal name of the group + * @param string $text The text of the link + * @return string Wikilink to the group */ public static function makeGroupLinkWiki( $group, $text = '' ) { - if( $text == '' ) { + if ( $text == '' ) { $text = self::getGroupName( $group ); } $title = self::getGroupPage( $group ); - if( $title ) { + if ( $title ) { $page = $title->getPrefixedText(); return "[[$page|$text]]"; } else { @@ -3762,7 +4255,7 @@ class User { /** * Returns an array of the groups that a particular group can add/remove. * - * @param $group String: the group to check for whether it can add/remove + * @param string $group the group to check for whether it can add/remove * @return Array array( 'add' => array( addablegroups ), * 'remove' => array( removablegroups ), * 'add-self' => array( addablegroups to self), @@ -3772,53 +4265,53 @@ class User { global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf; $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() ); - if( empty( $wgAddGroups[$group] ) ) { + if ( empty( $wgAddGroups[$group] ) ) { // Don't add anything to $groups - } elseif( $wgAddGroups[$group] === true ) { + } elseif ( $wgAddGroups[$group] === true ) { // You get everything $groups['add'] = self::getAllGroups(); - } elseif( is_array( $wgAddGroups[$group] ) ) { + } elseif ( is_array( $wgAddGroups[$group] ) ) { $groups['add'] = $wgAddGroups[$group]; } // Same thing for remove - if( empty( $wgRemoveGroups[$group] ) ) { - } elseif( $wgRemoveGroups[$group] === true ) { + if ( empty( $wgRemoveGroups[$group] ) ) { + } elseif ( $wgRemoveGroups[$group] === true ) { $groups['remove'] = self::getAllGroups(); - } elseif( is_array( $wgRemoveGroups[$group] ) ) { + } elseif ( is_array( $wgRemoveGroups[$group] ) ) { $groups['remove'] = $wgRemoveGroups[$group]; } // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility - if( empty( $wgGroupsAddToSelf['user']) || $wgGroupsAddToSelf['user'] !== true ) { - foreach( $wgGroupsAddToSelf as $key => $value ) { - if( is_int( $key ) ) { + if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) { + foreach ( $wgGroupsAddToSelf as $key => $value ) { + if ( is_int( $key ) ) { $wgGroupsAddToSelf['user'][] = $value; } } } - if( empty( $wgGroupsRemoveFromSelf['user']) || $wgGroupsRemoveFromSelf['user'] !== true ) { - foreach( $wgGroupsRemoveFromSelf as $key => $value ) { - if( is_int( $key ) ) { + if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) { + foreach ( $wgGroupsRemoveFromSelf as $key => $value ) { + if ( is_int( $key ) ) { $wgGroupsRemoveFromSelf['user'][] = $value; } } } // Now figure out what groups the user can add to him/herself - if( empty( $wgGroupsAddToSelf[$group] ) ) { - } elseif( $wgGroupsAddToSelf[$group] === true ) { + if ( empty( $wgGroupsAddToSelf[$group] ) ) { + } elseif ( $wgGroupsAddToSelf[$group] === true ) { // No idea WHY this would be used, but it's there $groups['add-self'] = User::getAllGroups(); - } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) { + } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) { $groups['add-self'] = $wgGroupsAddToSelf[$group]; } - if( empty( $wgGroupsRemoveFromSelf[$group] ) ) { - } elseif( $wgGroupsRemoveFromSelf[$group] === true ) { + if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) { + } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) { $groups['remove-self'] = User::getAllGroups(); - } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) { + } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) { $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group]; } @@ -3833,7 +4326,7 @@ class User { * 'remove-self' => array( removable groups from self) ) */ public function changeableGroups() { - if( $this->isAllowed( 'userrights' ) ) { + if ( $this->isAllowed( 'userrights' ) ) { // This group gives the right to modify everything (reverse- // compatibility with old "userrights lets you change // everything") @@ -3856,11 +4349,11 @@ class User { ); $addergroups = $this->getEffectiveGroups(); - foreach( $addergroups as $addergroup ) { + foreach ( $addergroups as $addergroup ) { $groups = array_merge_recursive( $groups, $this->changeableByGroup( $addergroup ) ); - $groups['add'] = array_unique( $groups['add'] ); + $groups['add'] = array_unique( $groups['add'] ); $groups['remove'] = array_unique( $groups['remove'] ); $groups['add-self'] = array_unique( $groups['add-self'] ); $groups['remove-self'] = array_unique( $groups['remove-self'] ); @@ -3873,39 +4366,30 @@ class User { * Will have no effect for anonymous users. */ public function incEditCount() { - if( !$this->isAnon() ) { + if ( !$this->isAnon() ) { $dbw = wfGetDB( DB_MASTER ); - $dbw->update( 'user', + $dbw->update( + 'user', array( 'user_editcount=user_editcount+1' ), array( 'user_id' => $this->getId() ), - __METHOD__ ); + __METHOD__ + ); // Lazy initialization check... - if( $dbw->affectedRows() == 0 ) { - // Pull from a slave to be less cruel to servers - // Accuracy isn't the point anyway here - $dbr = wfGetDB( DB_SLAVE ); - $count = $dbr->selectField( 'revision', - 'COUNT(rev_user)', - array( 'rev_user' => $this->getId() ), - __METHOD__ ); - + if ( $dbw->affectedRows() == 0 ) { // Now here's a goddamn hack... - if( $dbr !== $dbw ) { + $dbr = wfGetDB( DB_SLAVE ); + if ( $dbr !== $dbw ) { // If we actually have a slave server, the count is // at least one behind because the current transaction // has not been committed and replicated. - $count++; + $this->initEditCount( 1 ); } else { // But if DB_SLAVE is selecting the master, then the // count we just read includes the revision that was // just added in the working transaction. + $this->initEditCount(); } - - $dbw->update( 'user', - array( 'user_editcount' => $count ), - array( 'user_id' => $this->getId() ), - __METHOD__ ); } } // edit count in user cache too @@ -3913,10 +4397,39 @@ class User { } /** + * Initialize user_editcount from data out of the revision table + * + * @param $add Integer Edits to add to the count from the revision table + * @return integer Number of edits + */ + protected function initEditCount( $add = 0 ) { + // Pull from a slave to be less cruel to servers + // Accuracy isn't the point anyway here + $dbr = wfGetDB( DB_SLAVE ); + $count = (int)$dbr->selectField( + 'revision', + 'COUNT(rev_user)', + array( 'rev_user' => $this->getId() ), + __METHOD__ + ); + $count = $count + $add; + + $dbw = wfGetDB( DB_MASTER ); + $dbw->update( + 'user', + array( 'user_editcount' => $count ), + array( 'user_id' => $this->getId() ), + __METHOD__ + ); + + return $count; + } + + /** * Get the description of a given right * - * @param $right String Right to query - * @return String Localized description of the right + * @param string $right Right to query + * @return string Localized description of the right */ public static function getRightDescription( $right ) { $key = "right-$right"; @@ -3927,9 +4440,9 @@ class User { /** * Make an old-style password hash * - * @param $password String Plain-text password - * @param $userId String User ID - * @return String Password hash + * @param string $password Plain-text password + * @param string $userId User ID + * @return string Password hash */ public static function oldCrypt( $password, $userId ) { global $wgPasswordSalt; @@ -3943,21 +4456,20 @@ class User { /** * Make a new-style password hash * - * @param $password String Plain-text password + * @param string $password Plain-text password * @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 + * If unspecified or false, will generate one automatically + * @return string Password hash */ public static function crypt( $password, $salt = false ) { global $wgPasswordSalt; $hash = ''; - if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) { + if ( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) { return $hash; } - if( $wgPasswordSalt ) { + if ( $wgPasswordSalt ) { if ( $salt === false ) { $salt = MWCryptRand::generateHex( 8 ); } @@ -3971,117 +4483,161 @@ class User { * Compare a password hash with a plain-text password. Requires the user * ID if there's a chance that the hash is an old-style hash. * - * @param $hash String Password hash - * @param $password String Plain-text password to compare - * @param $userId String|bool User ID for old-style password salt + * @param string $hash Password hash + * @param string $password Plain-text password to compare + * @param string|bool $userId User ID for old-style password salt * - * @return Boolean + * @return boolean */ public static function comparePasswords( $hash, $password, $userId = false ) { $type = substr( $hash, 0, 3 ); $result = false; - if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) { + if ( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) { return $result; } if ( $type == ':A:' ) { - # Unsalted + // Unsalted return md5( $password ) === substr( $hash, 3 ); } elseif ( $type == ':B:' ) { - # Salted + // Salted list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 ); - return md5( $salt.'-'.md5( $password ) ) === $realHash; + return md5( $salt . '-' . md5( $password ) ) === $realHash; } else { - # Old-style + // Old-style return self::oldCrypt( $password, $userId ) === $hash; } } /** - * Add a newuser log entry for this user. Before 1.19 the return value was always true. + * Add a newuser log entry for this user. + * Before 1.19 the return value was always true. + * + * @param string|bool $action account creation type. + * - String, one of the following values: + * - 'create' for an anonymous user creating an account for himself. + * This will force the action's performer to be the created user itself, + * no matter the value of $wgUser + * - 'create2' for a logged in user creating an account for someone else + * - 'byemail' when the created user will receive its password by e-mail + * - 'autocreate' when the user is automatically created (such as by CentralAuth). + * - Boolean means whether the account was created by e-mail (deprecated): + * - true will be converted to 'byemail' + * - false will be converted to 'create' if this object is the same as + * $wgUser and to 'create2' otherwise * - * @param $byEmail Boolean: account made by email? - * @param $reason String: user supplied reason + * @param string $reason user supplied reason * * @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; - if( empty( $wgNewUserLog ) ) { + public function addNewUserLogEntry( $action = false, $reason = '' ) { + global $wgUser, $wgNewUserLog; + if ( empty( $wgNewUserLog ) ) { return true; // disabled } - if( $this->getName() == $wgUser->getName() ) { - $action = 'create'; - } else { - $action = 'create2'; - if ( $byEmail ) { - if ( $reason === '' ) { - $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text(); - } else { - $reason = $wgContLang->commaList( array( - $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) ); - } + if ( $action === true ) { + $action = 'byemail'; + } elseif ( $action === false ) { + if ( $this->getName() == $wgUser->getName() ) { + $action = 'create'; + } else { + $action = 'create2'; } } - $log = new LogPage( 'newusers' ); - return (int)$log->addEntry( - $action, - $this->getUserPage(), - $reason, - array( $this->getId() ) - ); + + if ( $action === 'create' || $action === 'autocreate' ) { + $performer = $this; + } else { + $performer = $wgUser; + } + + $logEntry = new ManualLogEntry( 'newusers', $action ); + $logEntry->setPerformer( $performer ); + $logEntry->setTarget( $this->getUserPage() ); + $logEntry->setComment( $reason ); + $logEntry->setParameters( array( + '4::userid' => $this->getId(), + ) ); + $logid = $logEntry->insert(); + + if ( $action !== 'autocreate' ) { + $logEntry->publish( $logid ); + } + + return (int)$logid; } /** * Add an autocreate newuser log entry for this user * Used by things like CentralAuth and perhaps other authplugins. + * Consider calling addNewUserLogEntry() directly instead. * * @return bool */ public function addNewUserLogEntryAutoCreate() { - global $wgNewUserLog; - if( !$wgNewUserLog ) { - return true; // disabled - } - $log = new LogPage( 'newusers', false ); - $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this ); + $this->addNewUserLogEntry( 'autocreate' ); + return true; } /** - * @todo document + * Load the user options either from cache, the database or an array + * + * @param array $data Rows for the current user out of the user_properties table */ - protected function loadOptions() { + protected function loadOptions( $data = null ) { + global $wgContLang; + $this->load(); - if ( $this->mOptionsLoaded || !$this->getId() ) + + if ( $this->mOptionsLoaded ) { return; + } $this->mOptions = self::getDefaultOptions(); + if ( !$this->getId() ) { + // For unlogged-in users, load language/variant options from request. + // There's no need to do it for logged-in users: they can set preferences, + // and handling of page content is done by $pageLang->getPreferredVariant() and such, + // so don't override user's choice (especially when the user chooses site default). + $variant = $wgContLang->getDefaultVariant(); + $this->mOptions['variant'] = $variant; + $this->mOptions['language'] = $variant; + $this->mOptionsLoaded = true; + return; + } + // Maybe load from the object if ( !is_null( $this->mOptionOverrides ) ) { wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" ); - foreach( $this->mOptionOverrides as $key => $value ) { + foreach ( $this->mOptionOverrides as $key => $value ) { $this->mOptions[$key] = $value; } } else { - wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" ); - // Load from database - $dbr = wfGetDB( DB_SLAVE ); + if ( !is_array( $data ) ) { + wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" ); + // Load from database + $dbr = wfGetDB( DB_SLAVE ); - $res = $dbr->select( - 'user_properties', - array( 'up_property', 'up_value' ), - array( 'up_user' => $this->getId() ), - __METHOD__ - ); + $res = $dbr->select( + 'user_properties', + array( 'up_property', 'up_value' ), + array( 'up_user' => $this->getId() ), + __METHOD__ + ); - $this->mOptionOverrides = array(); - foreach ( $res as $row ) { - $this->mOptionOverrides[$row->up_property] = $row->up_value; - $this->mOptions[$row->up_property] = $row->up_value; + $this->mOptionOverrides = array(); + $data = array(); + foreach ( $res as $row ) { + $data[$row->up_property] = $row->up_value; + } + } + foreach ( $data as $property => $value ) { + $this->mOptionOverrides[$property] = $value; + $this->mOptions[$property] = $value; } } @@ -4094,8 +4650,6 @@ class User { * @todo document */ protected function saveOptions() { - global $wgAllowPrefChange; - $this->loadOptions(); // Not using getOptions(), to keep hidden preferences in database @@ -4103,15 +4657,14 @@ 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; } - $extuser = ExternalUser::newFromUser( $this ); $userId = $this->getId(); $insert_rows = array(); - foreach( $saveOptions as $key => $value ) { - # Don't bother storing default values + foreach ( $saveOptions as $key => $value ) { + // Don't bother storing default values $defaultOption = self::getDefaultOption( $key ); if ( ( is_null( $defaultOption ) && !( $value === false || is_null( $value ) ) ) || @@ -4122,21 +4675,21 @@ class User { 'up_value' => $value, ); } - if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) { - switch ( $wgAllowPrefChange[$key] ) { - case 'local': - case 'message': - break; - case 'semiglobal': - case 'global': - $extuser->setPref( $key, $value ); - } - } } $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__ ); - $dbw->insert( 'user_properties', $insert_rows, __METHOD__ ); + $hasRows = $dbw->selectField( 'user_properties', '1', + array( 'up_user' => $userId ), __METHOD__ ); + + if ( $hasRows ) { + // Only do this delete if there is something there. A very large portion of + // calls to this function are for setting 'rememberpassword' for new accounts. + // Doing this delete for new accounts with no rows in the table rougly causes + // gap locks on [max user ID,+infinity) which causes high contention since many + // updates will pile up on each other since they are for higher (newer) user IDs. + $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__ ); + } + $dbw->insert( 'user_properties', $insert_rows, __METHOD__, array( 'IGNORE' ) ); } /** @@ -4160,8 +4713,7 @@ class User { * * @return array Array of HTML attributes suitable for feeding to * Html::element(), directly or indirectly. (Don't feed to Xml::*()! - * That will potentially output invalid XHTML 1.0 Transitional, and will - * get confused by the boolean attribute syntax used.) + * That will get confused by the boolean attribute syntax used.) */ public static function passwordChangeInputAttribs() { global $wgMinimalPasswordLength; @@ -4221,4 +4773,26 @@ class User { 'user_editcount', ); } + + /** + * Factory function for fatal permission-denied errors + * + * @since 1.22 + * @param string $permission User right required + * @return Status + */ + static function newFatalPermissionDeniedStatus( $permission ) { + global $wgLang; + + $groups = array_map( + array( 'User', 'makeGroupLinkWiki' ), + User::getGroupsWithPermission( $permission ) + ); + + if ( $groups ) { + return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) ); + } else { + return Status::newFatal( 'badaccess-group0' ); + } + } } |