X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FUser.php;h=b5867d1d6245b23187ca280545e465366c26cd15;hb=70f677dbecf54e226560467f9258602a15bb1772;hp=f7d7880cfc38a24ccf42a2b8e6258d852911813f;hpb=047a74e175d83043bd47599d90892a60de4570e9;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/User.php b/includes/User.php index f7d7880cfc..b5867d1d62 100644 --- a/includes/User.php +++ b/includes/User.php @@ -5,19 +5,19 @@ */ /** - * \type{\int} Number of characters in user_token field. + * \int Number of characters in user_token field. * @ingroup Constants */ define( 'USER_TOKEN_LENGTH', 32 ); /** - * \type{\int} Serialized record version. + * \int Serialized record version. * @ingroup Constants */ -define( 'MW_USER_VERSION', 6 ); +define( 'MW_USER_VERSION', 8 ); /** - * \type{\string} Some punctuation to prevent editing from broken text-mangling proxies. + * \string Some punctuation to prevent editing from broken text-mangling proxies. * @ingroup Constants */ define( 'EDIT_TOKEN_SUFFIX', '+\\' ); @@ -43,8 +43,8 @@ class PasswordError extends MWException { class User { /** - * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user - * preferences that are displayed by Special:Preferences as checkboxes. + * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user + * preferences that are displayed by Special:Preferences as checkboxes. * This list can be extended via the UserToggles hook or by * $wgContLang::getExtraUserToggles(). * @showinitializer @@ -62,7 +62,6 @@ class User { 'editsectiononrightclick', 'showtoc', 'rememberpassword', - 'editwidth', 'watchcreations', 'watchdefault', 'watchmoves', @@ -91,11 +90,12 @@ class User { 'diffonly', 'showhiddencats', 'noconvertlink', + 'norollbackdiff', ); /** - * \type{\arrayof{\string}} List of member variables which are saved to the - * shared cache (memcached). Any operation which changes the + * \type{\arrayof{\string}} List of member variables which are saved to the + * shared cache (memcached). Any operation which changes the * corresponding database fields must call a cache-clearing function. * @showinitializer */ @@ -108,7 +108,6 @@ class User { 'mNewpassword', 'mNewpassTime', 'mEmail', - 'mOptions', 'mTouched', 'mToken', 'mEmailAuthenticated', @@ -118,11 +117,13 @@ class User { 'mEditCount', // user_group table 'mGroups', + // user_properties table + 'mOptionOverrides', ); /** * \type{\arrayof{\string}} Core rights. - * Each of these should have a corresponding message of the form + * Each of these should have a corresponding message of the form * "right-$right". * @showinitializer */ @@ -140,17 +141,24 @@ class User { 'createtalk', 'delete', 'deletedhistory', + 'deletedtext', + 'deleterevision', 'edit', 'editinterface', 'editusercssjs', + 'hideuser', 'import', 'importupload', 'ipblock-exempt', 'markbotedits', 'minoredit', 'move', + 'movefile', + 'move-rootuserpages', + 'move-subpages', 'nominornewtalk', 'noratelimit', + 'override-export-depth', 'patrol', 'protect', 'proxyunbannable', @@ -159,34 +167,39 @@ class User { 'reupload', 'reupload-shared', 'rollback', + 'sendemail', 'siteadmin', + 'suppressionlog', 'suppressredirect', + 'suppressrevision', 'trackback', 'undelete', 'unwatchedpages', 'upload', 'upload_by_url', 'userrights', + 'userrights-interwiki', + 'writeapi', ); /** - * \type{\string} Cached results of getAllRights() + * \string Cached results of getAllRights() */ static $mAllRights = false; /** @name Cache variables */ //@{ var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime, - $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated, - $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups; + $mEmail, $mTouched, $mToken, $mEmailAuthenticated, + $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides; //@} /** - * \type{\bool} Whether the cache variables have been loaded. + * \bool Whether the cache variables have been loaded. */ - var $mDataLoaded; + var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded; /** - * \type{\string} Initialization data source if mDataLoaded==false. May be one of: + * \string Initialization data source if mDataLoaded==false. May be one of: * - 'defaults' anonymous user initialised from class defaults * - 'name' initialise from mName * - 'id' initialise from mId @@ -199,13 +212,16 @@ class User { /** @name Lazy-initialized variables, invalidated with clearInstanceCache */ //@{ var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights, - $mBlockreason, $mBlock, $mEffectiveGroups; + $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally, + $mLocked, $mHideName, $mOptions; //@} + static $idCacheByName = array(); + /** * Lightweight constructor for an anonymous user. * Use the User::newFrom* factory functions for other kinds of users. - * + * * @see newFromName() * @see newFromId() * @see newFromConfirmationCode() @@ -246,6 +262,7 @@ class User { break; case 'session': $this->loadFromSession(); + wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) ); break; default: throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" ); @@ -255,7 +272,7 @@ class User { /** * Load user table data, given mId has already been set. - * @return \type{\bool} false if the ID does not exist, true otherwise + * @return \bool false if the ID does not exist, true otherwise * @private */ function loadFromId() { @@ -297,6 +314,7 @@ class User { function saveToCache() { $this->load(); $this->loadGroups(); + $this->loadOptions(); if ( $this->isAnon() ) { // Anonymous users are uncached return; @@ -310,8 +328,8 @@ class User { global $wgMemc; $wgMemc->set( $key, $data ); } - - + + /** @name newFrom*() static factory methods */ //@{ @@ -321,13 +339,14 @@ class User { * This is slightly less efficient than newFromId(), so use newFromId() if * you have both an ID and a name handy. * - * @param $name \type{\string} Username, validated by Title::newFromText() - * @param $validate \type{\mixed} Validate username. Takes the same parameters as + * @param $name \string Username, validated by Title::newFromText() + * @param $validate \mixed Validate username. Takes the same parameters as * User::getCanonicalName(), except that true is accepted as an alias * for 'valid', for BC. * - * @return \type{User} The User object, or null if the username is invalid. If the - * username is not present in the database, the result will be a user object + * @return \type{User} The User object, or false if the username is invalid + * (e.g. if it contains illegal characters or is an IP address). If the + * username is not present in the database, the result will be a user object * with a name, zero user ID and default settings. */ static function newFromName( $name, $validate = 'valid' ) { @@ -336,7 +355,7 @@ class User { } $name = self::getCanonicalName( $name, $validate ); if ( $name === false ) { - return null; + return false; } else { # Create unloaded user object $u = new User; @@ -349,7 +368,7 @@ class User { /** * Static factory method for creation from a given user ID. * - * @param $id \type{\int} Valid user ID + * @param $id \int Valid user ID * @return \type{User} The corresponding User object */ static function newFromId( $id ) { @@ -366,7 +385,7 @@ class User { * * If the code is invalid or has expired, returns NULL. * - * @param $code \type{\string} Confirmation code + * @param $code \string Confirmation code * @return \type{User} */ static function newFromConfirmationCode( $code ) { @@ -405,25 +424,25 @@ class User { $user->loadFromRow( $row ); return $user; } - + //@} - + /** * Get the username corresponding to a given user ID - * @param $id \type{\int} %User ID - * @return \type{\string} The corresponding username + * @param $id \int User ID + * @return \string The corresponding username */ static function whoIs( $id ) { $dbr = wfGetDB( DB_SLAVE ); - return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' ); + return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__ ); } /** * Get the real name of a user given their user ID * - * @param $id \type{\int} %User ID - * @return \type{\string} The corresponding user's real name + * @param $id \int User ID + * @return \string The corresponding user's real name */ static function whoIsReal( $id ) { $dbr = wfGetDB( DB_SLAVE ); @@ -432,24 +451,36 @@ class User { /** * Get database id given a user name - * @param $name \type{\string} Username - * @return \twotypes{\int,\null} The corresponding user's ID, or null if user is nonexistent - * @static + * @param $name \string Username + * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent */ static function idFromName( $name ) { - $nt = Title::newFromText( $name ); + $nt = Title::makeTitleSafe( NS_USER, $name ); if( is_null( $nt ) ) { # Illegal name return null; } + + if ( isset( self::$idCacheByName[$name] ) ) { + return self::$idCacheByName[$name]; + } + $dbr = wfGetDB( DB_SLAVE ); $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__ ); if ( $s === false ) { - return 0; + $result = null; } else { - return $s->user_id; + $result = $s->user_id; + } + + self::$idCacheByName[$name] = $result; + + if ( count( self::$idCacheByName ) > 1000 ) { + self::$idCacheByName = array(); } + + return $result; } /** @@ -465,8 +496,8 @@ 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 \type{\string} String to match - * @return \type{\bool} True or false + * @param $name \string String to match + * @return \bool True or false */ static function isIP( $name ) { return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name); @@ -480,8 +511,8 @@ class User { * is longer than the maximum allowed username size or doesn't begin with * a capital letter. * - * @param $name \type{\string} String to match - * @return \type{\bool} True or false + * @param $name \string String to match + * @return \bool True or false */ static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; @@ -534,8 +565,8 @@ class User { * If an account already exists in this form, login will be blocked * by a failure to pass this function. * - * @param $name \type{\string} String to match - * @return \type{\bool} True or false + * @param $name \string String to match + * @return \bool True or false */ static function isUsableName( $name ) { global $wgReservedUsernames; @@ -568,39 +599,75 @@ class User { * either by batch processes or by user accounts which have * already been created. * - * Additional character blacklisting may be added here - * rather than in isValidUserName() to avoid disrupting - * existing accounts. + * Additional blacklisting may be added here rather than in + * isValidUserName() to avoid disrupting existing accounts. * - * @param $name \type{\string} String to match - * @return \type{\bool} True or false + * @param $name \string String to match + * @return \bool True or false */ static function isCreatableName( $name ) { - return - self::isUsableName( $name ) && + global $wgInvalidUsernameCharacters; + + // Ensure that the username isn't longer than 235 bytes, so that + // (at least for the builtin skins) user javascript and css files + // will work. (bug 23080) + if( strlen( $name ) > 235 ) { + wfDebugLog( 'username', __METHOD__ . + ": '$name' invalid due to length" ); + return false; + } - // Registration-time character blacklisting... - strpos( $name, '@' ) === false; + if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) { + wfDebugLog( 'username', __METHOD__ . + ": '$name' invalid due to wgInvalidUsernameCharacters" ); + return false; + } + + return self::isUsableName( $name ); } /** * Is the input a valid password for this user? * - * @param $password \type{\string} Desired password - * @return \type{\bool} True or false + * @param $password String Desired password + * @return bool True or false */ function isValidPassword( $password ) { + //simple boolean wrapper for getPasswordValidity + return $this->getPasswordValidity( $password ) === true; + } + + /** + * Given unvalidated password input, return error message on failure. + * + * @param $password String Desired password + * @return mixed: true on success, string of error message on failure + */ + function getPasswordValidity( $password ) { global $wgMinimalPasswordLength, $wgContLang; - $result = null; + $result = false; //init $result to false for the internal checks + if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) ) return $result; - if( $result === false ) - return false; - // Password needs to be long enough, and can't be the same as the username - return strlen( $password ) >= $wgMinimalPasswordLength - && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName ); + if ( $result === false ) { + if( strlen( $password ) < $wgMinimalPasswordLength ) { + return 'passwordtooshort'; + } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName ) ) { + return 'password-name-match'; + } else { + //it seems weird returning true here, but this is because of the + //initialization of $result to false above. If the hook is never run or it + //doesn't modify $result, then we will likely get down into this if with + //a valid password. + return true; + } + } elseif( $result === true ) { + return true; + } else { + return $result; //the isValidPassword hook set a string $result and returned true + } } /** @@ -612,8 +679,8 @@ class User { * * @todo Check for RFC 2822 compilance (bug 959) * - * @param $addr \type{\string} E-mail address - * @return \type{\bool} True or false + * @param $addr \string E-mail address + * @return \bool True or false */ public static function isValidEmailAddr( $addr ) { $result = null; @@ -627,8 +694,8 @@ class User { /** * Given unvalidated user input, return a canonical username, or false if * the username is invalid. - * @param $name \type{\string} User input - * @param $validate \twotypes{\string,\bool} Type of validation to use: + * @param $name \string User input + * @param $validate \types{\string,\bool} Type of validation to use: * - false No validation * - 'valid' Valid for batch processes * - 'usable' Valid for batch processes and login @@ -646,7 +713,7 @@ class User { return false; # Clean up name according to title rules - $t = ($validate === 'valid') ? + $t = ( $validate === 'valid' ) ? Title::newFromText( $name ) : Title::makeTitle( NS_USER, $name ); # Check for invalid titles if( is_null( $t ) ) { @@ -677,7 +744,7 @@ class User { } break; default: - throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__ ); + throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__ ); } return $name; } @@ -686,8 +753,8 @@ 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 \type{\int} %User ID to check - * @return \type{\int} The user's edit count + * @param $uid \int User ID to check + * @return \int The user's edit count */ static function edits( $uid ) { wfProfileIn( __METHOD__ ); @@ -723,7 +790,7 @@ class User { * Return a random password. Sourced from mt_rand, so it's not particularly secure. * @todo hash random numbers to improve security, like generateToken() * - * @return \type{\string} New random password + * @return \string New random password */ static function randomPassword() { global $wgMinimalPasswordLength; @@ -731,18 +798,18 @@ class User { $l = strlen( $pwchars ) - 1; $pwlength = max( 7, $wgMinimalPasswordLength ); - $digit = mt_rand(0, $pwlength - 1); + $digit = mt_rand( 0, $pwlength - 1 ); $np = ''; for ( $i = 0; $i < $pwlength; $i++ ) { - $np .= $i == $digit ? chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)}; + $np .= $i == $digit ? chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) }; } return $np; } /** - * Set cached properties to default. + * Set cached properties to default. * - * @note This no longer clears uncached lazy-initialised properties; + * @note This no longer clears uncached lazy-initialised properties; * the constructor does that instead. * @private */ @@ -757,7 +824,8 @@ class User { $this->mPassword = $this->mNewpassword = ''; $this->mNewpassTime = null; $this->mEmail = ''; - $this->mOptions = null; # Defer init + $this->mOptionOverrides = null; + $this->mOptionsLoaded = false; if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) { $this->mTouched = wfTimestamp( TS_MW, $_COOKIE[$wgCookiePrefix.'LoggedOut'] ); @@ -788,10 +856,10 @@ class User { /** * Load user data from the session or login cookie. If there are no valid * credentials, initialises the user as an anonymous user. - * @return \type{\bool} True if the user is logged in, false otherwise. + * @return \bool True if the user is logged in, false otherwise. */ private function loadFromSession() { - global $wgMemc, $wgCookiePrefix; + global $wgMemc, $wgCookiePrefix, $wgExternalAuthType, $wgAutocreatePolicy; $result = null; wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) ); @@ -799,20 +867,35 @@ class User { return $result; } - if ( isset( $_SESSION['wsUserID'] ) ) { - if ( 0 != $_SESSION['wsUserID'] ) { + if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) { + $extUser = ExternalUser::newFromCookie(); + if ( $extUser ) { + # TODO: Automatically create the user here (or probably a bit + # lower down, in fact) + } + } + + if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) { + $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] ); + if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) { + $this->loadDefaults(); // Possible collision! + wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and + cookie user ID ($sId) don't match!" ); + return false; + } + $_SESSION['wsUserID'] = $sId; + } else if ( isset( $_SESSION['wsUserID'] ) ) { + if ( $_SESSION['wsUserID'] != 0 ) { $sId = $_SESSION['wsUserID']; } else { $this->loadDefaults(); return false; } - } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) { - $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] ); - $_SESSION['wsUserID'] = $sId; } else { $this->loadDefaults(); return false; } + if ( isset( $_SESSION['wsUserName'] ) ) { $sName = $_SESSION['wsUserName']; } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) { @@ -830,6 +913,13 @@ class User { return false; } + global $wgBlockDisablesLogin; + if( $wgBlockDisablesLogin && $this->isBlocked() ) { + # User blocked and we've disabled blocked user logins + $this->loadDefaults(); + return false; + } + if ( isset( $_SESSION['wsToken'] ) ) { $passwordCorrect = $_SESSION['wsToken'] == $this->mToken; $from = 'session'; @@ -858,7 +948,7 @@ class User { * Load user and user_group data from the database. * $this::mId must be set, this is how the user is identified. * - * @return \type{\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 * @private */ function loadFromDatabase() { @@ -874,6 +964,8 @@ class User { $dbr = wfGetDB( DB_MASTER ); $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId ), __METHOD__ ); + wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) ); + if ( $s !== false ) { # Initialise user table data $this->loadFromRow( $s ); @@ -897,7 +989,7 @@ class User { $this->mDataLoaded = true; if ( isset( $row->user_id ) ) { - $this->mId = $row->user_id; + $this->mId = intval( $row->user_id ); } $this->mName = $row->user_name; $this->mRealName = $row->user_real_name; @@ -912,7 +1004,7 @@ class User { $this->mEmailToken = $row->user_email_token; $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires ); $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration ); - $this->mEditCount = $row->user_editcount; + $this->mEditCount = $row->user_editcount; } /** @@ -935,7 +1027,7 @@ class User { /** * Clear various cached data stored in this object. - * @param $reloadFrom \type{\string} Reload user and user_groups table data from a + * @param $reloadFrom \string Reload user and user_groups table data from a * given source. May be "name", "id", "defaults", "session", or false for * no reload. */ @@ -947,6 +1039,7 @@ class User { $this->mSkin = null; $this->mRights = null; $this->mEffectiveGroups = null; + $this->mOptions = null; if ( $reloadFrom ) { $this->mDataLoaded = false; @@ -965,7 +1058,7 @@ class User { /** * Site defaults will override the global/language defaults */ - global $wgDefaultUserOptions, $wgContLang; + global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin; $defOpt = $wgDefaultUserOptions + $wgContLang->getDefaultUserOptionOverrides(); /** @@ -974,25 +1067,26 @@ class User { $variant = $wgContLang->getPreferredVariant( false ); $defOpt['variant'] = $variant; $defOpt['language'] = $variant; - - foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) { - $defOpt['searchNs'.$nsnum] = $val; + foreach( SearchEngine::searchableNamespaces() as $nsnum => $nsname ) { + $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] ); } + $defOpt['skin'] = $wgDefaultSkin; + return $defOpt; } /** * Get a given default option value. * - * @param $opt \type{\string} Name of option to retrieve - * @return \type{\string} Default option value + * @param $opt \string Name of option to retrieve + * @return \string Default option value */ public static function getDefaultOption( $opt ) { $defOpts = self::getDefaultOptions(); if( isset( $defOpts[$opt] ) ) { return $defOpts[$opt]; } else { - return ''; + return null; } } @@ -1001,9 +1095,14 @@ class User { * @return \type{\arrayof{\string}} Array of user toggle names */ static function getToggles() { - global $wgContLang; + global $wgContLang, $wgUseRCPatrol; $extraToggles = array(); wfRunHooks( 'UserToggles', array( &$extraToggles ) ); + if( $wgUseRCPatrol ) { + $extraToggles[] = 'hidepatrolled'; + $extraToggles[] = 'newpageshidepatrolled'; + $extraToggles[] = 'watchlisthidepatrolled'; + } return array_merge( self::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() ); } @@ -1011,13 +1110,13 @@ class User { /** * Get blocking information * @private - * @param $bFromSlave \type{\bool} Whether to check the slave database first. To + * @param $bFromSlave \bool Whether to check the slave database first. To * improve performance, non-critical checks are done * against slaves. Check when actually saving should be * done against master. */ function getBlockedStatus( $bFromSlave = true ) { - global $wgEnableSorbs, $wgProxyWhitelist; + global $wgProxyWhitelist, $wgUser; if ( -1 != $this->mBlockedby ) { wfDebug( "User::getBlockedStatus: already loaded.\n" ); @@ -1033,13 +1132,27 @@ class User { // due to -1 !== 0. Probably session-related... Nothing should be // overwriting mBlockedby, surely? $this->load(); - + $this->mBlockedby = 0; $this->mHideName = 0; $this->mAllowUsertalk = 0; - $ip = wfGetIP(); - if ($this->isAllowed( 'ipblock-exempt' ) ) { + # Check if we are looking at an IP or a logged-in user + if ( $this->isIP( $this->getName() ) ) { + $ip = $this->getName(); + } else { + # Check if we are looking at the current user + # If we don't, and the user is logged in, we don't know about + # his IP / autoblock status, so ignore autoblock of current user's IP + if ( $this->getID() != $wgUser->getID() ) { + $ip = ''; + } else { + # Get IP of current user + $ip = wfGetIP(); + } + } + + if ( $this->isAllowed( 'ipblock-exempt' ) ) { # Exempt from all types of IP-block $ip = ''; } @@ -1048,22 +1161,24 @@ class User { $this->mBlock = new Block(); $this->mBlock->fromMaster( !$bFromSlave ); if ( $this->mBlock->load( $ip , $this->mId ) ) { - wfDebug( __METHOD__.": Found block.\n" ); + wfDebug( __METHOD__ . ": Found block.\n" ); $this->mBlockedby = $this->mBlock->mBy; + if( $this->mBlockedby == 0 ) + $this->mBlockedby = $this->mBlock->mByName; $this->mBlockreason = $this->mBlock->mReason; $this->mHideName = $this->mBlock->mHideName; $this->mAllowUsertalk = $this->mBlock->mAllowUsertalk; - if ( $this->isLoggedIn() ) { + if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) { $this->spreadBlock(); } } else { - // Bug 13611: don't remove mBlock here, to allow account creation blocks to - // apply to users. Note that the existence of $this->mBlock is not used to + // Bug 13611: don't remove mBlock here, to allow account creation blocks to + // apply to users. Note that the existence of $this->mBlock is not used to // check for edit blocks, $this->mBlockedby is instead. } # Proxy blocking - if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) { + if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) { # Local list if ( wfIsLocallyBlockedProxy( $ip ) ) { $this->mBlockedby = wfMsg( 'proxyblocker' ); @@ -1071,8 +1186,8 @@ class User { } # DNSBL - if ( !$this->mBlockedby && $wgEnableSorbs && !$this->getID() ) { - if ( $this->inSorbsBlacklist( $ip ) ) { + if ( !$this->mBlockedby && !$this->getID() ) { + if ( $this->isDnsBlacklisted( $ip ) ) { $this->mBlockedby = wfMsg( 'sorbs' ); $this->mBlockreason = wfMsg( 'sorbsreason' ); } @@ -1086,43 +1201,57 @@ class User { } /** - * Whether the given IP is in the SORBS blacklist. + * Whether the given IP is in a DNS blacklist. * - * @param $ip \type{\string} IP to check - * @return \type{\bool} True if blacklisted + * @param $ip \string IP to check + * @param $checkWhitelist Boolean: whether to check the whitelist first + * @return \bool True if blacklisted. */ - function inSorbsBlacklist( $ip ) { - global $wgEnableSorbs, $wgSorbsUrl; + function isDnsBlacklisted( $ip, $checkWhitelist = false ) { + global $wgEnableSorbs, $wgEnableDnsBlacklist, + $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist; - return $wgEnableSorbs && - $this->inDnsBlacklist( $ip, $wgSorbsUrl ); + if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs ) + return false; + + if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) + return false; + + $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl ); + return $this->inDnsBlacklist( $ip, $urls ); } /** * Whether the given IP is in a given DNS blacklist. * - * @param $ip \type{\string} IP to check - * @param $base \type{\string} URL of the DNS blacklist - * @return \type{\bool} True if blacklisted + * @param $ip \string IP to check + * @param $bases \string or Array of Strings: URL of the DNS blacklist + * @return \bool True if blacklisted. */ - function inDnsBlacklist( $ip, $base ) { + function inDnsBlacklist( $ip, $bases ) { wfProfileIn( __METHOD__ ); $found = false; $host = ''; // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170) - if( IP::isIPv4($ip) ) { - # Make hostname - $host = "$ip.$base"; + if( IP::isIPv4( $ip ) ) { + # Reverse IP, bug 21255 + $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) ); - # Send query - $ipList = gethostbynamel( $host ); + foreach( (array)$bases as $base ) { + # Make hostname + $host = "$ipReversed.$base"; - if( $ipList ) { - wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" ); - $found = true; - } else { - wfDebug( "Requested $host, not found in $base.\n" ); + # Send query + $ipList = gethostbynamel( $host ); + + if( $ipList ) { + wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" ); + $found = true; + break; + } else { + wfDebug( "Requested $host, not found in $base.\n" ); + } } } @@ -1133,14 +1262,21 @@ class User { /** * Is this user subject to rate limiting? * - * @return \type{\bool} True if rate limited + * @return \bool True if rate limited */ public function isPingLimitable() { global $wgRateLimitsExcludedGroups; + global $wgRateLimitsExcludedIPs; if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) { // Deprecated, but kept for backwards-compatibility config return false; } + if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) { + // No other good way currently to disable rate limits + // for specific IPs. :P + // But this is a crappy hack and should die. + return false; + } return !$this->isAllowed('noratelimit'); } @@ -1151,11 +1287,10 @@ class User { * @note When using a shared cache like memcached, IP-address * last-hit counters will be shared across wikis. * - * @param $action \type{\string} Action to enforce; 'edit' if unspecified - * @return \type{\bool} True if a rate limiter was tripped + * @param $action \string Action to enforce; 'edit' if unspecified + * @return \bool True if a rate limiter was tripped */ - function pingLimiter( $action='edit' ) { - + function pingLimiter( $action = 'edit' ) { # Call the 'PingLimiter' hook $result = false; if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) { @@ -1211,7 +1346,7 @@ class User { } // Set the user limit key if ( $userLimit !== false ) { - wfDebug( __METHOD__.": effective user limit: $userLimit\n" ); + wfDebug( __METHOD__ . ": effective user limit: $userLimit\n" ); $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit; } @@ -1220,19 +1355,20 @@ class User { list( $max, $period ) = $limit; $summary = "(limit $max in {$period}s)"; $count = $wgMemc->get( $key ); + // Already pinged? if( $count ) { if( $count > $max ) { - wfDebug( __METHOD__.": tripped! $key at $count $summary\n" ); + wfDebug( __METHOD__ . ": tripped! $key at $count $summary\n" ); if( $wgRateLimitLog ) { @error_log( wfTimestamp( TS_MW ) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog ); } $triggered = true; } else { - wfDebug( __METHOD__.": ok. $key at $count $summary\n" ); + wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" ); } } else { - wfDebug( __METHOD__.": adding record for $key $summary\n" ); - $wgMemc->add( $key, 1, intval( $period ) ); + wfDebug( __METHOD__ . ": adding record for $key $summary\n" ); + $wgMemc->add( $key, 0, intval( $period ) ); // first ping } $wgMemc->incr( $key ); } @@ -1243,9 +1379,9 @@ class User { /** * Check if user is blocked - * - * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master - * @return \type{\bool} True if blocked, false otherwise + * + * @param $bFromSlave \bool Whether to check the slave database instead of the master + * @return \bool True if blocked, false otherwise */ function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site wfDebug( "User::isBlocked: enter\n" ); @@ -1255,31 +1391,35 @@ class User { /** * Check if user is blocked from editing a particular article - * - * @param $title \type{\string} Title to check - * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master - * @return \type{\bool} True if blocked, false otherwise + * + * @param $title \string Title to check + * @param $bFromSlave \bool Whether to check the slave database instead of the master + * @return \bool True if blocked, false otherwise */ function isBlockedFrom( $title, $bFromSlave = false ) { global $wgBlockAllowsUTEdit; wfProfileIn( __METHOD__ ); - wfDebug( __METHOD__.": enter\n" ); + wfDebug( __METHOD__ . ": enter\n" ); - wfDebug( __METHOD__.": asking isBlocked()\n" ); + wfDebug( __METHOD__ . ": asking isBlocked()\n" ); $blocked = $this->isBlocked( $bFromSlave ); + $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false ); # If a user's name is suppressed, they cannot make edits anywhere - if ( !$this->mHideName && $this->mAllowUsertalk && $title->getText() === $this->getName() && + if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName() && $title->getNamespace() == NS_USER_TALK ) { $blocked = false; - wfDebug( __METHOD__.": self-talk page, ignoring any blocks\n" ); + wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" ); } + + wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) ); + wfProfileOut( __METHOD__ ); return $blocked; } /** * If user is blocked, return the name of the user who placed the block - * @return \type{\string} name of blocker + * @return \string name of blocker */ function blockedBy() { $this->getBlockedStatus(); @@ -1288,16 +1428,82 @@ class User { /** * If user is blocked, return the specified reason for the block - * @return \type{\string} Blocking reason + * @return \string Blocking reason */ function blockedFor() { $this->getBlockedStatus(); return $this->mBlockreason; } + /** + * If user is blocked, return the ID for the block + * @return \int Block ID + */ + function getBlockId() { + $this->getBlockedStatus(); + return ( $this->mBlock ? $this->mBlock->mId : false ); + } + + /** + * Check if user is blocked on all wikis. + * Do not use for actual edit permission checks! + * This is intented for quick UI checks. + * + * @param $ip \type{\string} IP address, uses current client if none given + * @return \type{\bool} True if blocked, false otherwise + */ + function isBlockedGlobally( $ip = '' ) { + if( $this->mBlockedGlobally !== null ) { + return $this->mBlockedGlobally; + } + // User is already an IP? + if( IP::isIPAddress( $this->getName() ) ) { + $ip = $this->getName(); + } else if( !$ip ) { + $ip = wfGetIP(); + } + $blocked = false; + wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) ); + $this->mBlockedGlobally = (bool)$blocked; + return $this->mBlockedGlobally; + } + + /** + * Check if user account is locked + * + * @return \type{\bool} True if locked, false otherwise + */ + function isLocked() { + if( $this->mLocked !== null ) { + return $this->mLocked; + } + global $wgAuth; + $authUser = $wgAuth->getUserInstance( $this ); + $this->mLocked = (bool)$authUser->isLocked(); + return $this->mLocked; + } + + /** + * Check if user account is hidden + * + * @return \type{\bool} True if hidden, false otherwise + */ + function isHidden() { + if( $this->mHideName !== null ) { + return $this->mHideName; + } + $this->getBlockedStatus(); + if( !$this->mHideName ) { + global $wgAuth; + $authUser = $wgAuth->getUserInstance( $this ); + $this->mHideName = (bool)$authUser->isHidden(); + } + return $this->mHideName; + } + /** * Get the user's ID. - * @return \type{\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 */ function getId() { if( $this->mId === null and $this->mName !== null @@ -1313,7 +1519,7 @@ class User { /** * Set the user and reload all fields according to a given ID - * @param $v \type{\int} %User ID to reload + * @param $v \int User ID to reload */ function setId( $v ) { $this->mId = $v; @@ -1322,7 +1528,7 @@ class User { /** * Get the user name, or the IP of an anonymous user - * @return \type{\string} User's name or IP address + * @return \string User's name or IP address */ function getName() { if ( !$this->mDataLoaded && $this->mFrom == 'name' ) { @@ -1349,7 +1555,7 @@ class User { * * @note User::newFromName() has rougly the same function, when the named user * does not exist. - * @param $str \type{\string} New user name to set + * @param $str \string New user name to set */ function setName( $str ) { $this->load(); @@ -1358,7 +1564,7 @@ class User { /** * Get the user's name escaped by underscores. - * @return \type{\string} Username escaped by underscores + * @return \string Username escaped by underscores. */ function getTitleKey() { return str_replace( ' ', '_', $this->getName() ); @@ -1366,7 +1572,7 @@ class User { /** * Check if the user has new messages. - * @return \type{\bool} True if the user has new messages + * @return \bool True if the user has new messages */ function getNewtalk() { $this->load(); @@ -1403,25 +1609,24 @@ class User { */ function getNewMessageLinks() { $talks = array(); - if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks))) + if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) return $talks; - if (!$this->getNewtalk()) + if( !$this->getNewtalk() ) return array(); $up = $this->getUserPage(); $utp = $up->getTalkPage(); - return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL())); + return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) ); } - /** * Internal uncached check for new messages * * @see getNewtalk() - * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise - * @param $fromMaster \type{\bool} true to fetch from the master, false for a slave - * @return \type{\bool} True if the user has new messages + * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise + * @param $fromMaster \bool true to fetch from the master, false for a slave + * @return \bool True if the user has new messages * @private */ function checkNewtalk( $field, $id, $fromMaster = false ) { @@ -1437,9 +1642,9 @@ class User { /** * Add or update the new messages flag - * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \twotypes{string,\int} User's IP address for anonymous users, %User ID otherwise - * @return \type{\bool} True if successful, false otherwise + * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise + * @return \bool True if successful, false otherwise * @private */ function updateNewtalk( $field, $id ) { @@ -1449,19 +1654,19 @@ class User { __METHOD__, 'IGNORE' ); if ( $dbw->affectedRows() ) { - wfDebug( __METHOD__.": set on ($field, $id)\n" ); + wfDebug( __METHOD__ . ": set on ($field, $id)\n" ); return true; } else { - wfDebug( __METHOD__." already set ($field, $id)\n" ); + wfDebug( __METHOD__ . " already set ($field, $id)\n" ); return false; } } /** * Clear the new messages flag for the given user - * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise - * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise - * @return \type{\bool} True if successful, false otherwise + * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise + * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise + * @return \bool True if successful, false otherwise * @private */ function deleteNewtalk( $field, $id ) { @@ -1470,17 +1675,17 @@ class User { array( $field => $id ), __METHOD__ ); if ( $dbw->affectedRows() ) { - wfDebug( __METHOD__.": killed on ($field, $id)\n" ); + wfDebug( __METHOD__ . ": killed on ($field, $id)\n" ); return true; } else { - wfDebug( __METHOD__.": already gone ($field, $id)\n" ); + wfDebug( __METHOD__ . ": already gone ($field, $id)\n" ); return false; } } /** * Update the 'You have new messages!' status. - * @param $val \type{\bool} Whether the user has new messages + * @param $val \bool Whether the user has new messages */ function setNewtalk( $val ) { if( wfReadOnly() ) { @@ -1519,7 +1724,7 @@ class User { /** * Generate a current or new-future timestamp to be stored in the * user_touched field when we update things. - * @return \type{\string} Timestamp in TS_MW format + * @return \string Timestamp in TS_MW format */ private static function newTouchedTimestamp() { global $wgClockSkewFudge; @@ -1534,6 +1739,7 @@ class User { * Called implicitly from invalidateCache() and saveSettings(). */ private function clearSharedCache() { + $this->load(); if( $this->mId ) { global $wgMemc; $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId ) ); @@ -1546,6 +1752,9 @@ class User { * for reload on the next hit. */ function invalidateCache() { + if( wfReadOnly() ) { + return; + } $this->load(); if( $this->mId ) { $this->mTouched = self::newTouchedTimestamp(); @@ -1562,11 +1771,11 @@ class User { /** * Validate the cache for this account. - * @param $timestamp \type{\string} A timestamp in TS_MW format + * @param $timestamp \string A timestamp in TS_MW format */ function validateCache( $timestamp ) { $this->load(); - return ($timestamp >= $this->mTouched); + return ( $timestamp >= $this->mTouched ); } /** @@ -1588,7 +1797,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 \type{\string} New password to set + * @param $str \string New password to set * @throws PasswordError on failure */ function setPassword( $str ) { @@ -1600,10 +1809,11 @@ class User { } if( !$this->isValidPassword( $str ) ) { - global $wgMinimalPasswordLength; - throw new PasswordError( wfMsgExt( 'passwordtooshort', array( 'parsemag' ), + global $wgMinimalPasswordLength; + $valid = $this->getPasswordValidity( $str ); + throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ), $wgMinimalPasswordLength ) ); - } + } } if( !$wgAuth->setPassword( $this, $str ) ) { @@ -1618,7 +1828,7 @@ class User { /** * Set the password and reset the random token unconditionally. * - * @param $str \type{\string} New password to set + * @param $str \string New password to set */ function setInternalPassword( $str ) { $this->load(); @@ -1633,21 +1843,21 @@ class User { $this->mNewpassword = ''; $this->mNewpassTime = null; } - + /** * Get the user's current token. - * @return \type{\string} Token + * @return \string Token */ function getToken() { $this->load(); return $this->mToken; } - + /** * Set the random token (used for persistent authentication) * Called from loadDefaults() among other places. * - * @param $token \type{\string} If specified, set the token to this value + * @param $token \string If specified, set the token to this value * @private */ function setToken( $token = false ) { @@ -1666,11 +1876,11 @@ class User { $this->mToken = $token; } } - + /** * Set the cookie password * - * @param $str \type{\string} New cookie password + * @param $str \string New cookie password * @private */ function setCookiePassword( $str ) { @@ -1681,8 +1891,8 @@ class User { /** * Set the password for a password reminder or new account email * - * @param $str \type{\string} New password to set - * @param $throttle \type{\bool} If true, reset the throttle timestamp to the present + * @param $str \string New password to set + * @param $throttle \bool If true, reset the throttle timestamp to the present */ function setNewpassword( $str, $throttle = true ) { $this->load(); @@ -1693,9 +1903,9 @@ class User { } /** - * Has password reminder email been sent within the last + * Has password reminder email been sent within the last * $wgPasswordReminderResendTime hours? - * @return \type{\bool} True or false + * @return \bool True or false */ function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; @@ -1709,7 +1919,7 @@ class User { /** * Get the user's e-mail address - * @return \type{\string} User's e-mail address + * @return \string User's email address */ function getEmail() { $this->load(); @@ -1719,7 +1929,7 @@ class User { /** * Get the timestamp of the user's e-mail authentication - * @return \type{\string} TS_MW timestamp + * @return \string TS_MW timestamp */ function getEmailAuthenticationTimestamp() { $this->load(); @@ -1729,7 +1939,7 @@ class User { /** * Set the user's e-mail address - * @param $str \type{\string} New e-mail address + * @param $str \string New e-mail address */ function setEmail( $str ) { $this->load(); @@ -1739,7 +1949,7 @@ class User { /** * Get the user's real name - * @return \type{\string} User's real name + * @return \string User's real name */ function getRealName() { $this->load(); @@ -1748,7 +1958,7 @@ class User { /** * Set the user's real name - * @param $str \type{\string} New real name + * @param $str \string New real name */ function setRealName( $str ) { $this->load(); @@ -1758,14 +1968,14 @@ class User { /** * Get the user's current setting for a given option. * - * @param $oname \type{\string} The option to check - * @param $defaultOverride \type{\string} A default value returned if the option does not exist - * @return \type{\string} User's current value for the option + * @param $oname \string The option to check + * @param $defaultOverride \string A default value returned if the option does not exist + * @return \string User's current value for the option * @see getBoolOption() * @see getIntOption() */ - function getOption( $oname, $defaultOverride = '' ) { - $this->load(); + function getOption( $oname, $defaultOverride = null ) { + $this->loadOptions(); if ( is_null( $this->mOptions ) ) { if($defaultOverride != '') { @@ -1775,30 +1985,40 @@ class User { } if ( array_key_exists( $oname, $this->mOptions ) ) { - return trim( $this->mOptions[$oname] ); + return $this->mOptions[$oname]; } else { return $defaultOverride; } } - + + /** + * Get all user's options + * + * @return array + */ + public function getOptions() { + $this->loadOptions(); + return $this->mOptions; + } + /** * Get the user's current setting for a given option, as a boolean value. * - * @param $oname \type{\string} The option to check - * @return \type{\bool} User's current value for the option + * @param $oname \string The option to check + * @return \bool User's current value for the option * @see getOption() */ function getBoolOption( $oname ) { return (bool)$this->getOption( $oname ); } - + /** * Get the user's current setting for a given option, as a boolean value. * - * @param $oname \type{\string} The option to check - * @param $defaultOverride \type{\int} A default value returned if the option does not exist - * @return \type{\int} User's current value for the option + * @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 * @see getOption() */ function getIntOption( $oname, $defaultOverride=0 ) { @@ -1812,36 +2032,37 @@ class User { /** * Set the given option for a user. * - * @param $oname \type{\string} The option to set - * @param $val \type{\mixed} New value to set + * @param $oname \string The option to set + * @param $val \mixed New value to set */ function setOption( $oname, $val ) { $this->load(); - if ( is_null( $this->mOptions ) ) { - $this->mOptions = User::getDefaultOptions(); - } + $this->loadOptions(); + if ( $oname == 'skin' ) { # Clear cached skin, so the new one displays immediately in Special:Preferences unset( $this->mSkin ); } - // Filter out any newlines that may have passed through input validation. - // Newlines are used to separate items in the options blob. - if( $val ) { - $val = str_replace( "\r\n", "\n", $val ); - $val = str_replace( "\r", "\n", $val ); - $val = str_replace( "\n", " ", $val ); - } + // Explicitly NULL values should refer to defaults global $wgDefaultUserOptions; - if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) { + if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) { $val = $wgDefaultUserOptions[$oname]; } + $this->mOptions[$oname] = $val; } + /** + * Reset all options to the site defaults + */ + function resetOptions() { + $this->mOptions = User::getDefaultOptions(); + } + /** * Get the user's preferred date format. - * @return \type{\string} User's preferred date format + * @return \string User's preferred date format */ function getDatePreference() { // Important migration for old data rows @@ -1885,12 +2106,12 @@ 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 \type{\bool} Whether to avoid the cache + * @param $recache \bool Whether to avoid the cache * @return \type{\arrayof{\string}} Array of internal group names */ function getEffectiveGroups( $recache = false ) { if ( $recache || is_null( $this->mEffectiveGroups ) ) { + wfProfileIn( __METHOD__ ); $this->mEffectiveGroups = $this->getGroups(); $this->mEffectiveGroups[] = '*'; if( $this->getId() ) { @@ -1904,19 +2125,20 @@ class User { # Hook for additional groups wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups ) ); } + wfProfileOut( __METHOD__ ); } return $this->mEffectiveGroups; } /** * Get the user's edit count. - * @return \type{\int} User's edit count + * @return \int User'e edit count */ function getEditCount() { - if ($this->mId) { + if( $this->getId() ) { if ( !isset( $this->mEditCount ) ) { /* Populate the count, if it has not been populated yet */ - $this->mEditCount = User::edits($this->mId); + $this->mEditCount = User::edits( $this->mId ); } return $this->mEditCount; } else { @@ -1928,7 +2150,7 @@ class User { /** * Add the user to the given group. * This takes immediate effect. - * @param $group \type{\string} Name of the group to add + * @param $group \string Name of the group to add */ function addGroup( $group ) { $dbw = wfGetDB( DB_MASTER ); @@ -1938,7 +2160,7 @@ class User { 'ug_user' => $this->getID(), 'ug_group' => $group, ), - 'User::addGroup', + __METHOD__, array( 'IGNORE' ) ); } @@ -1952,7 +2174,7 @@ class User { /** * Remove the user from the given group. * This takes immediate effect. - * @param $group \type{\string} Name of the group to remove + * @param $group \string Name of the group to remove */ function removeGroup( $group ) { $this->load(); @@ -1961,8 +2183,7 @@ class User { array( 'ug_user' => $this->getID(), 'ug_group' => $group, - ), - 'User::removeGroup' ); + ), __METHOD__ ); $this->loadGroups(); $this->mGroups = array_diff( $this->mGroups, array( $group ) ); @@ -1971,10 +2192,9 @@ class User { $this->invalidateCache(); } - /** * Get whether the user is logged in - * @return \type{\bool} True or false + * @return \bool True or false */ function isLoggedIn() { return $this->getID() != 0; @@ -1982,7 +2202,7 @@ class User { /** * Get whether the user is anonymous - * @return \type{\bool} True or false + * @return \bool True or false */ function isAnon() { return !$this->isLoggedIn(); @@ -1990,7 +2210,7 @@ class User { /** * Get whether the user is a bot - * @return \type{\bool} True or false + * @return \bool True or false * @deprecated */ function isBot() { @@ -2000,61 +2220,80 @@ class User { /** * Check if user is allowed to access a feature / make an action - * @param $action \type{\string} action to be checked - * @return \type{\bool} True if action is allowed, else false + * @param $action \string action to be checked + * @return \bool True if action is allowed, else false */ - function isAllowed($action='') { + function isAllowed( $action = '' ) { if ( $action === '' ) - // In the spirit of DWIM - return true; - - # Use strict parameter to avoid matching numeric 0 accidentally inserted + return true; // In the spirit of DWIM + # Patrolling may not be enabled + if( $action === 'patrol' || $action === 'autopatrol' ) { + global $wgUseRCPatrol, $wgUseNPPatrol; + if( !$wgUseRCPatrol && !$wgUseNPPatrol ) + return false; + } + # 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 \type{\bool} True or false - */ + * Check whether to enable recent changes patrol features for this user + * @return \bool True or false + */ public function useRCPatrol() { global $wgUseRCPatrol; - return( $wgUseRCPatrol && ($this->isAllowed('patrol') || $this->isAllowed('patrolmarks')) ); + return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) || $this->isAllowed( 'patrolmarks' ) ) ); } /** - * Check whether to enable new pages patrol features for this user - * @return \type{\bool} True or false - */ + * Check whether to enable new pages patrol features for this user + * @return \bool True or false + */ public function useNPPatrol() { global $wgUseRCPatrol, $wgUseNPPatrol; - return( ($wgUseRCPatrol || $wgUseNPPatrol) && ($this->isAllowed('patrol') || $this->isAllowed('patrolmarks')) ); + return( ( $wgUseRCPatrol || $wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) || $this->isAllowed( 'patrolmarks' ) ) ); } /** - * Get the current skin, loading it if required - * @return \type{Skin} Current skin + * Get the current skin, loading it if required, and setting a title + * @param $t Title: the title to use in the skin + * @return Skin The current skin * @todo FIXME : need to check the old failback system [AV] */ - function &getSkin() { - global $wgRequest; - if ( ! isset( $this->mSkin ) ) { + function &getSkin( $t = null ) { + if ( !isset( $this->mSkin ) ) { wfProfileIn( __METHOD__ ); - # get the user skin - $userSkin = $this->getOption( 'skin' ); - $userSkin = $wgRequest->getVal('useskin', $userSkin); + global $wgHiddenPrefs; + if( !in_array( 'skin', $wgHiddenPrefs ) ) { + # get the user skin + global $wgRequest; + $userSkin = $this->getOption( 'skin' ); + $userSkin = $wgRequest->getVal( 'useskin', $userSkin ); + } else { + # if we're not allowing users to override, then use the default + global $wgDefaultSkin; + $userSkin = $wgDefaultSkin; + } $this->mSkin =& Skin::newFromKey( $userSkin ); wfProfileOut( __METHOD__ ); } + if( $t || !$this->mSkin->getTitle() ) { + if ( !$t ) { + global $wgOut; + $t = $wgOut->getTitle(); + } + $this->mSkin->setTitle( $t ); + } return $this->mSkin; } /** * Check the watched status of an article. * @param $title \type{Title} Title of the article to look at - * @return \type{\bool} True if article is watched + * @return \bool True if article is watched */ function isWatched( $title ) { $wl = WatchedItem::fromUserTitle( $this, $title ); @@ -2095,9 +2334,9 @@ class User { return; } - if ($title->getNamespace() == NS_USER_TALK && + if( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) { - if (!wfRunHooks('UserClearNewTalkNotification', array(&$this))) + if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) ) return; $this->setNewtalk( false ); } @@ -2115,8 +2354,8 @@ class User { // The query to find out if it is watched is cached both in memcached and per-invocation, // and when it does have to be executed, it can be on a slave // If this is the user's newtalk page, we always update the timestamp - if ($title->getNamespace() == NS_USER_TALK && - $title->getText() == $wgUser->getName()) + if( $title->getNamespace() == NS_USER_TALK && + $title->getText() == $wgUser->getName() ) { $watched = true; } elseif ( $this->getId() == $wgUser->getId() ) { @@ -2131,7 +2370,7 @@ class User { $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'watchlist', array( /* SET */ - 'wl_notificationtimestamp' => NULL + 'wl_notificationtimestamp' => null ), array( /* WHERE */ 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace(), @@ -2146,7 +2385,7 @@ class User { * If e-notif e-mails are on, they will receive notification mails on * the next change of any watched page. * - * @param $currentUser \type{\int} %User ID + * @param $currentUser \int User ID */ function clearAllNotifications( $currentUser ) { global $wgUseEnotif, $wgShowUpdatedMarker; @@ -2158,7 +2397,7 @@ class User { $dbw = wfGetDB( DB_MASTER ); $dbw->update( 'watchlist', array( /* SET */ - 'wl_notificationtimestamp' => NULL + 'wl_notificationtimestamp' => null ), array( /* WHERE */ 'wl_user' => $currentUser ), __METHOD__ @@ -2168,52 +2407,45 @@ class User { } } - /** - * Encode this user's options as a string - * @return \type{\string} Encoded options - * @private - */ - function encodeOptions() { - $this->load(); - if ( is_null( $this->mOptions ) ) { - $this->mOptions = User::getDefaultOptions(); - } - $a = array(); - foreach ( $this->mOptions as $oname => $oval ) { - array_push( $a, $oname.'='.$oval ); - } - $s = implode( "\n", $a ); - return $s; - } - /** * Set this user's options from an encoded string - * @param $str \type{\string} Encoded options to import + * @param $str \string Encoded options to import * @private */ function decodeOptions( $str ) { + if( !$str ) + return; + + $this->mOptionsLoaded = true; + $this->mOptionOverrides = array(); + $this->mOptions = array(); $a = explode( "\n", $str ); foreach ( $a as $s ) { $m = array(); if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) { $this->mOptions[$m[1]] = $m[2]; + $this->mOptionOverrides[$m[1]] = $m[2]; } } } - + /** - * Set a cookie on the user's client. Wrapper for + * 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; + * if 0 or not specified, use the default $wgCookieExpiration */ - protected function setCookie( $name, $value, $exp=0 ) { + protected function setCookie( $name, $value, $exp = 0 ) { global $wgRequest; $wgRequest->response()->setcookie( $name, $value, $exp ); } - + /** * Clear a cookie on the user's client - * @param $name \type{\string} Name of the cookie to clear + * @param $name \string Name of the cookie to clear */ protected function clearCookie( $name ) { $this->setCookie( $name, '', time() - 86400 ); @@ -2225,7 +2457,7 @@ class User { function setCookies() { $this->load(); if ( 0 == $this->mId ) return; - $session = array( + $session = array( 'wsUserID' => $this->mId, 'wsToken' => $this->mToken, 'wsUserName' => $this->getName() @@ -2239,9 +2471,12 @@ class User { } else { $cookies['Token'] = false; } - + wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) ); - $_SESSION = $session + $_SESSION; + #check for null, since the hook could cause a null value + if ( !is_null( $session ) && isset( $_SESSION ) ){ + $_SESSION = $session + $_SESSION; + } foreach ( $cookies as $name => $value ) { if ( $value === false ) { $this->clearCookie( $name ); @@ -2255,8 +2490,7 @@ class User { * Log this user out. */ function logout() { - global $wgUser; - if( wfRunHooks( 'UserLogout', array(&$this) ) ) { + if( wfRunHooks( 'UserLogout', array( &$this ) ) ) { $this->doLogout(); } } @@ -2299,8 +2533,8 @@ class User { 'user_real_name' => $this->mRealName, 'user_email' => $this->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ), - 'user_options' => $this->encodeOptions(), - 'user_touched' => $dbw->timestamp($this->mTouched), + 'user_options' => '', + 'user_touched' => $dbw->timestamp( $this->mTouched ), 'user_token' => $this->mToken, 'user_email_token' => $this->mEmailToken, 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ), @@ -2308,8 +2542,12 @@ class User { 'user_id' => $this->mId ), __METHOD__ ); + + $this->saveOptions(); + wfRunHooks( 'UserSaveSettings', array( $this ) ); $this->clearSharedCache(); + $this->getUserPage()->invalidateCache(); } /** @@ -2330,7 +2568,7 @@ class User { /** * Add a user to the database, return the user object * - * @param $name \type{\string} Username to add + * @param $name \string Username to add * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database: * - password The user's password. Password logins will be disabled if this is omitted. * - newpassword A temporary password mailed to the user @@ -2347,7 +2585,7 @@ class User { $user = new User; $user->load(); if ( isset( $params['options'] ) ) { - $user->mOptions = $params['options'] + $user->mOptions; + $user->mOptions = $params['options'] + (array)$user->mOptions; unset( $params['options'] ); } $dbw = wfGetDB( DB_MASTER ); @@ -2361,7 +2599,7 @@ class User { 'user_email' => $user->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ), 'user_real_name' => $user->mRealName, - 'user_options' => $user->encodeOptions(), + 'user_options' => '', 'user_token' => $user->mToken, 'user_registration' => $dbw->timestamp( $user->mRegistration ), 'user_editcount' => 0, @@ -2395,7 +2633,7 @@ class User { 'user_email' => $this->mEmail, 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ), 'user_real_name' => $this->mRealName, - 'user_options' => $this->encodeOptions(), + 'user_options' => '', 'user_token' => $this->mToken, 'user_registration' => $dbw->timestamp( $this->mRegistration ), 'user_editcount' => 0, @@ -2405,6 +2643,8 @@ class User { // Clear instance cache other than user table data, which is already accurate $this->clearInstanceCache(); + + $this->saveOptions(); } /** @@ -2412,7 +2652,7 @@ class User { * they've successfully logged in from. */ function spreadBlock() { - wfDebug( __METHOD__."()\n" ); + wfDebug( __METHOD__ . "()\n" ); $this->load(); if ( $this->mId == 0 ) { return; @@ -2423,22 +2663,21 @@ class User { return; } - $userblock->doAutoblock( wfGetIp() ); - + $userblock->doAutoblock( wfGetIP() ); } /** * Generate a string which will be different for any combination of * user options which would produce different parser output. * This will be used as part of the hash key for the parser cache, - * so users will the same options can share the same cached data + * so users with the same options can share the same cached data * safely. * * Extensions which require it should install 'PageRenderingHash' hook, * which will give them a chance to modify this key based on their own * settings. * - * @return \type{\string} Page rendering hash + * @return \string Page rendering hash */ function getPageRenderingHash() { global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang; @@ -2454,7 +2693,7 @@ class User { if ( $wgUseDynamicDates ) { $confstr .= '!' . $this->getDatePreference(); } - $confstr .= '!' . ($this->getOption( 'numberheadings' ) ? '1' : ''); + $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ? '1' : '' ); $confstr .= '!' . $wgLang->getCode(); $confstr .= '!' . $this->getOption( 'thumbsize' ); // add in language specific options, if any @@ -2475,7 +2714,7 @@ class User { /** * Get whether the user is explicitly blocked from account creation. - * @return \type{\bool} True if blocked + * @return \bool True if blocked */ function isBlockedFromCreateAccount() { $this->getBlockedStatus(); @@ -2484,7 +2723,7 @@ class User { /** * Get whether the user is blocked from using Special:Emailuser. - * @return \type{\bool} True if blocked + * @return \bool True if blocked */ function isBlockedFromEmailuser() { $this->getBlockedStatus(); @@ -2493,7 +2732,7 @@ class User { /** * Get whether the user is allowed to create an account. - * @return \type{\bool} True if allowed + * @return \bool True if allowed */ function isAllowedToCreateAccount() { return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount(); @@ -2527,7 +2766,7 @@ class User { /** * Get the maximum valid user ID. - * @return \type{\int} %User ID + * @return \int User ID * @static */ function getMaxID() { @@ -2537,49 +2776,23 @@ class User { return $res; else { $dbr = wfGetDB( DB_SLAVE ); - return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' ); + return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__ ); } } /** * Determine whether the user is a newbie. Newbies are either * anonymous IPs, or the most recently created accounts. - * @return \type{\bool} True if the user is a newbie + * @return \bool True if the user is a newbie */ function isNewbie() { return !$this->isAllowed( 'autoconfirmed' ); } - - /** - * Is the user active? We check to see if they've made at least - * X number of edits in the last Y days. - * - * @return \type{\bool} True if the user is active, false if not. - */ - public function isActiveEditor() { - global $wgActiveUserEditCount, $wgActiveUserDays; - $dbr = wfGetDB( DB_SLAVE ); - - // Stolen without shame from RC - $cutoff_unixtime = time() - ( $wgActiveUserDays * 86400 ); - $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime % 86400 ); - $oldTime = $dbr->addQuotes( $dbr->timestamp( $cutoff_unixtime ) ); - - $res = $dbr->select( 'revision', '1', - array( 'rev_user_text' => $this->getName(), "rev_timestamp > $oldTime"), - __METHOD__, - array('LIMIT' => $wgActiveUserEditCount ) ); - - $count = $dbr->numRows($res); - $dbr->freeResult($res); - - return $count == $wgActiveUserEditCount; - } /** * Check to see if the given clear-text password is one of the accepted passwords - * @param $password \type{\string} user password. - * @return \type{\bool} True if the given password is correct, otherwise False. + * @param $password \string user password. + * @return \bool True if the given password is correct, otherwise False. */ function checkPassword( $password ) { global $wgAuth; @@ -2619,10 +2832,17 @@ class User { /** * Check if the given clear-text password matches the temporary password * sent by e-mail for password reset operations. - * @return \type{\bool} True if matches, false otherwise + * @return \bool True if matches, false otherwise */ function checkTemporaryPassword( $plaintext ) { - return self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ); + global $wgNewPasswordExpiry; + if( self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ) ) { + $this->load(); + $expiry = wfTimestamp( TS_UNIX, $this->mNewpassTime ) + $wgNewPasswordExpiry; + return ( time() < $expiry ); + } else { + return false; + } } /** @@ -2631,15 +2851,15 @@ class User { * login credentials aren't being hijacked with a foreign form * submission. * - * @param $salt \twotypes{\string,\arrayof{\string}} Optional function-specific data for hashing - * @return \type{\string} The new edit token + * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing + * @return \string The new edit token */ function editToken( $salt = '' ) { if ( $this->isAnon() ) { return EDIT_TOKEN_SUFFIX; } else { if( !isset( $_SESSION['wsEditToken'] ) ) { - $token = $this->generateToken(); + $token = self::generateToken(); $_SESSION['wsEditToken'] = $token; } else { $token = $_SESSION['wsEditToken']; @@ -2654,10 +2874,10 @@ class User { /** * Generate a looking random token for various uses. * - * @param $salt \type{\string} Optional salt value - * @return \type{\string} The new random token + * @param $salt \string Optional salt value + * @return \string The new random token */ - function generateToken( $salt = '' ) { + public static function generateToken( $salt = '' ) { $token = dechex( mt_rand() ) . dechex( mt_rand() ); return md5( $token . $salt ); } @@ -2668,9 +2888,9 @@ class User { * user's own login session, not a form submission from a third-party * site. * - * @param $val \type{\string} Input value to compare - * @param $salt \type{\string} Optional function-specific data for hashing - * @return \type{\bool} Whether the token matches + * @param $val \string Input value to compare + * @param $salt \string Optional function-specific data for hashing + * @return \bool Whether the token matches */ function matchEditToken( $val, $salt = '' ) { $sessionToken = $this->editToken( $salt ); @@ -2684,9 +2904,9 @@ class User { * Check given value against the token value stored in the session, * ignoring the suffix. * - * @param $val \type{\string} Input value to compare - * @param $salt \type{\string} Optional function-specific data for hashing - * @return \type{\bool} Whether the token matches + * @param $val \string Input value to compare + * @param $salt \string Optional function-specific data for hashing + * @return \bool Whether the token matches */ function matchEditTokenNoSuffix( $val, $salt = '' ) { $sessionToken = $this->editToken( $salt ); @@ -2697,34 +2917,38 @@ class User { * Generate a new e-mail confirmation token and send a confirmation/invalidation * mail to the user's given address. * - * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure. + * @param $changed Boolean: whether the adress changed + * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure. */ - function sendConfirmationMail() { + function sendConfirmationMail( $changed = false ) { global $wgLang; $expiration = null; // gets passed-by-ref and defined in next line. $token = $this->confirmationToken( $expiration ); $url = $this->confirmationTokenUrl( $token ); $invalidateURL = $this->invalidationTokenUrl( $token ); $this->saveSettings(); - + + $message = $changed ? 'confirmemail_body_changed' : 'confirmemail_body'; return $this->sendMail( wfMsg( 'confirmemail_subject' ), - wfMsg( 'confirmemail_body', + wfMsg( $message, wfGetIP(), $this->getName(), $url, $wgLang->timeanddate( $expiration, false ), - $invalidateURL ) ); + $invalidateURL, + $wgLang->date( $expiration, false ), + $wgLang->time( $expiration, false ) ) ); } /** * Send an e-mail to this user's account. Does not check for * confirmed status or validity. * - * @param $subject \type{\string} Message subject - * @param $body \type{\string} Message body - * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used - * @param $replyto \type{\string} Reply-to address - * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure + * @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 + * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure */ function sendMail( $subject, $body, $from = null, $replyto = null ) { if( is_null( $from ) ) { @@ -2744,15 +2968,15 @@ class User { * @note Call saveSettings() after calling this function to commit * this change to the database. * - * @param[out] &$expiration \type{\mixed} Accepts the expiration time - * @return \type{\string} New token + * @param[out] &$expiration \mixed Accepts the expiration time + * @return \string New token * @private */ function confirmationToken( &$expiration ) { $now = time(); $expires = $now + 7 * 24 * 60 * 60; $expiration = wfTimestamp( TS_MW, $expires ); - $token = $this->generateToken( $this->mId . $this->mEmail . $expires ); + $token = self::generateToken( $this->mId . $this->mEmail . $expires ); $hash = md5( $token ); $this->load(); $this->mEmailToken = $hash; @@ -2762,24 +2986,24 @@ class User { /** * Return a URL the user can use to confirm their email address. - * @param $token \type{\string} Accepts the email confirmation token - * @return \type{\string} New token URL + * @param $token \string Accepts the email confirmation token + * @return \string New token URL * @private */ function confirmationTokenUrl( $token ) { return $this->getTokenUrl( 'ConfirmEmail', $token ); } + /** * Return a URL the user can use to invalidate their email address. - * - * @param $token \type{\string} Accepts the email confirmation token - * @return \type{\string} New token URL + * @param $token \string Accepts the email confirmation token + * @return \string New token URL * @private */ function invalidationTokenUrl( $token ) { return $this->getTokenUrl( 'Invalidateemail', $token ); } - + /** * Internal function to format the e-mail validation/invalidation URLs. * This uses $wgArticlePath directly as a quickie hack to use the @@ -2790,9 +3014,9 @@ class User { * also sometimes can get corrupted in some browsers/mailers * (bug 6957 with Gmail and Internet Explorer). * - * @param $page \type{\string} Special page - * @param $token \type{\string} Token - * @return \type{\string} Formatted URL + * @param $page \string Special page + * @param $token \string Token + * @return \string Formatted URL */ protected function getTokenUrl( $page, $token ) { global $wgArticlePath; @@ -2810,6 +3034,7 @@ class User { */ function confirmEmail() { $this->setEmailAuthenticationTimestamp( wfTimestampNow() ); + wfRunHooks( 'ConfirmEmailComplete', array( $this ) ); return true; } @@ -2824,12 +3049,13 @@ class User { $this->mEmailToken = null; $this->mEmailTokenExpires = null; $this->setEmailAuthenticationTimestamp( null ); + wfRunHooks( 'InvalidateEmailComplete', array( $this ) ); return true; } /** * Set the e-mail authentication timestamp. - * @param $timestamp \type{\string} TS_MW timestamp + * @param $timestamp \string TS_MW timestamp */ function setEmailAuthenticationTimestamp( $timestamp ) { $this->load(); @@ -2840,9 +3066,13 @@ class User { /** * Is this user allowed to send e-mails within limits of current * site configuration? - * @return \type{\bool} True if allowed + * @return \bool True if allowed */ function canSendEmail() { + global $wgEnableEmail, $wgEnableUserEmail; + if( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) { + return false; + } $canSend = $this->isEmailConfirmed(); wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) ); return $canSend; @@ -2851,7 +3081,7 @@ class User { /** * Is this user allowed to receive e-mails within limits of current * site configuration? - * @return \type{\bool} True if allowed + * @return \bool True if allowed */ function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); @@ -2865,7 +3095,7 @@ class User { * confirmed their address by returning a code or using a password * sent to the address from the wiki. * - * @return \type{\bool} True if confirmed + * @return \bool True if confirmed */ function isEmailConfirmed() { global $wgEmailAuthentication; @@ -2886,7 +3116,7 @@ class User { /** * Check whether there is an outstanding request for e-mail confirmation. - * @return \type{\bool} True if pending + * @return \bool True if pending */ function isEmailConfirmationPending() { global $wgEmailAuthentication; @@ -2899,15 +3129,33 @@ class User { /** * Get the timestamp of account creation. * - * @return \twotypes{\string,\bool} string Timestamp of account creation, or false for + * @return \types{\string,\bool} string Timestamp of account creation, or false for * non-existent/anonymous user accounts. */ public function getRegistration() { - return $this->mId > 0 + return $this->getId() > 0 ? $this->mRegistration : false; } + /** + * Get the timestamp of the first edit + * + * @return \types{\string,\bool} string Timestamp of first edit, or false for + * non-existent/anonymous user accounts. + */ + public function getFirstEditTimestamp() { + if( $this->getId() == 0 ) return false; // anons + $dbr = wfGetDB( DB_SLAVE ); + $time = $dbr->selectField( 'revision', 'rev_timestamp', + array( 'rev_user' => $this->getId() ), + __METHOD__, + array( 'ORDER BY' => 'rev_timestamp ASC' ) + ); + if( !$time ) return false; // no edits + return wfTimestamp( TS_MW, $time ); + } + /** * Get the permissions associated with a given list of groups * @@ -2915,21 +3163,30 @@ class User { * @return \type{\arrayof{\string}} List of permission key names for given groups combined */ static function getGroupPermissions( $groups ) { - global $wgGroupPermissions; + global $wgGroupPermissions, $wgRevokePermissions; $rights = array(); + // grant every granted permission first foreach( $groups as $group ) { if( isset( $wgGroupPermissions[$group] ) ) { $rights = array_merge( $rights, + // array_filter removes empty items array_keys( array_filter( $wgGroupPermissions[$group] ) ) ); } } - return $rights; + // now revoke the revoked permissions + foreach( $groups as $group ) { + if( isset( $wgRevokePermissions[$group] ) ) { + $rights = array_diff( $rights, + array_keys( array_filter( $wgRevokePermissions[$group] ) ) ); + } + } + return array_unique( $rights ); } - + /** * Get all the groups who have a given permission - * - * @param $role \type{\string} Role to check + * + * @param $role \string Role to check * @return \type{\arrayof{\string}} List of internal group names with the given permission */ static function getGroupsWithPermission( $role ) { @@ -2946,8 +3203,8 @@ class User { /** * Get the localized descriptive name for a group, if it exists * - * @param $group \type{\string} Internal group name - * @return \type{\string} Localized descriptive group name + * @param $group \string Internal group name + * @return \string Localized descriptive group name */ static function getGroupName( $group ) { global $wgMessageCache; @@ -2962,8 +3219,8 @@ class User { /** * Get the localized descriptive name for a member of a group, if it exists * - * @param $group \type{\string} Internal group name - * @return \type{\string} Localized name for group member + * @param $group \string Internal group name + * @return \string Localized name for group member */ static function getGroupMember( $group ) { global $wgMessageCache; @@ -2982,9 +3239,9 @@ class User { * @return \type{\arrayof{\string}} Array of internal group names */ static function getAllGroups() { - global $wgGroupPermissions; + global $wgGroupPermissions, $wgRevokePermissions; return array_diff( - array_keys( $wgGroupPermissions ), + array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ), self::getImplicitGroups() ); } @@ -3020,8 +3277,8 @@ class User { /** * Get the title of a page describing a particular group * - * @param $group \type{\string} Internal group name - * @return \twotypes{Title,\bool} Title of the page if it exists, false otherwise + * @param $group \string Internal group name + * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise */ static function getGroupPage( $group ) { global $wgMessageCache; @@ -3036,12 +3293,12 @@ class User { } /** - * Create a link to the group in HTML, if available; + * Create a link to the group in HTML, if available; * else return the group name. * - * @param $group \type{\string} Internal name of the group - * @param $text \type{\string} The text of the link - * @return \type{\string} HTML link to the group + * @param $group \string Internal name of the group + * @param $text \string The text of the link + * @return \string HTML link to the group */ static function makeGroupLinkHTML( $group, $text = '' ) { if( $text == '' ) { @@ -3051,19 +3308,19 @@ class User { if( $title ) { global $wgUser; $sk = $wgUser->getSkin(); - return $sk->makeLinkObj( $title, htmlspecialchars( $text ) ); + return $sk->link( $title, htmlspecialchars( $text ) ); } else { return $text; } } /** - * Create a link to the group in Wikitext, if available; + * Create a link to the group in Wikitext, if available; * else return the group name. * - * @param $group \type{\string} Internal name of the group - * @param $text \type{\string} The text of the link - * @return \type{\string} Wikilink to the group + * @param $group \string Internal name of the group + * @param $text \string The text of the link + * @return \string Wikilink to the group */ static function makeGroupLinkWiki( $group, $text = '' ) { if( $text == '' ) { @@ -3078,6 +3335,115 @@ 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 + * @return Array array( 'add' => array( addablegroups ), + * 'remove' => array( removablegroups ), + * 'add-self' => array( addablegroups to self), + * 'remove-self' => array( removable groups from self) ) + */ + static function changeableByGroup( $group ) { + global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf; + + $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() ); + if( empty( $wgAddGroups[$group] ) ) { + // Don't add anything to $groups + } elseif( $wgAddGroups[$group] === true ) { + // You get everything + $groups['add'] = self::getAllGroups(); + } elseif( is_array( $wgAddGroups[$group] ) ) { + $groups['add'] = $wgAddGroups[$group]; + } + + // Same thing for remove + if( empty( $wgRemoveGroups[$group] ) ) { + } elseif( $wgRemoveGroups[$group] === true ) { + $groups['remove'] = self::getAllGroups(); + } 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 ) ) { + $wgGroupsAddToSelf['user'][] = $value; + } + } + } + + 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 ) { + // No idea WHY this would be used, but it's there + $groups['add-self'] = User::getAllGroups(); + } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) { + $groups['add-self'] = $wgGroupsAddToSelf[$group]; + } + + if( empty( $wgGroupsRemoveFromSelf[$group] ) ) { + } elseif( $wgGroupsRemoveFromSelf[$group] === true ) { + $groups['remove-self'] = User::getAllGroups(); + } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) { + $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group]; + } + + return $groups; + } + + /** + * Returns an array of groups that this user can add and remove + * @return Array array( 'add' => array( addablegroups ), + * 'remove' => array( removablegroups ), + * 'add-self' => array( addablegroups to self), + * 'remove-self' => array( removable groups from self) ) + */ + function changeableGroups() { + if( $this->isAllowed( 'userrights' ) ) { + // This group gives the right to modify everything (reverse- + // compatibility with old "userrights lets you change + // everything") + // Using array_merge to make the groups reindexed + $all = array_merge( User::getAllGroups() ); + return array( + 'add' => $all, + 'remove' => $all, + 'add-self' => array(), + 'remove-self' => array() + ); + } + + // Okay, it's not so simple, we will have to go through the arrays + $groups = array( + 'add' => array(), + 'remove' => array(), + 'add-self' => array(), + 'remove-self' => array() + ); + $addergroups = $this->getEffectiveGroups(); + + foreach( $addergroups as $addergroup ) { + $groups = array_merge_recursive( + $groups, $this->changeableByGroup( $addergroup ) + ); + $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'] ); + } + return $groups; + } + /** * Increment the user's edit-count field. * Will have no effect for anonymous users. @@ -3121,12 +3487,12 @@ class User { // edit count in user cache too $this->invalidateCache(); } - + /** * Get the description of a given right * - * @param $right \type{\string} Right to query - * @return \type{\string} Localized description of the right + * @param $right \string Right to query + * @return \string Localized description of the right */ static function getRightDescription( $right ) { global $wgMessageCache; @@ -3141,9 +3507,9 @@ class User { /** * Make an old-style password hash * - * @param $password \type{\string} Plain-text password - * @param $userId \type{\string} %User ID - * @return \type{\string} Password hash + * @param $password \string Plain-text password + * @param $userId \string User ID + * @return \string Password hash */ static function oldCrypt( $password, $userId ) { global $wgPasswordSalt; @@ -3157,21 +3523,26 @@ class User { /** * Make a new-style password hash * - * @param $password \type{\string} Plain-text password - * @param $salt \type{\string} Optional salt, may be random or the user ID. + * @param $password \string Plain-text password + * @param $salt \string Optional salt, may be random or the user ID. * If unspecified or false, will generate one automatically - * @return \type{\string} Password hash + * @return \string Password hash */ static function crypt( $password, $salt = false ) { global $wgPasswordSalt; - if($wgPasswordSalt) { + $hash = ''; + if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) { + return $hash; + } + + if( $wgPasswordSalt ) { if ( $salt === false ) { $salt = substr( wfGenerateToken(), 0, 8 ); } return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) ); } else { - return ':A:' . md5( $password); + return ':A:' . md5( $password ); } } @@ -3179,14 +3550,20 @@ 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 \type{\string} Password hash - * @param $password \type{\string} Plain-text password to compare - * @param $userId \type{\string} %User ID for old-style password salt - * @return \type{\bool} True if matches, false otherwise + * @param $hash \string Password hash + * @param $password \string Plain-text password to compare + * @param $userId \string User ID for old-style password salt + * @return \bool */ static function comparePasswords( $hash, $password, $userId = false ) { $m = false; $type = substr( $hash, 0, 3 ); + + $result = false; + if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) { + return $result; + } + if ( $type == ':A:' ) { # Unsalted return md5( $password ) === substr( $hash, 3 ); @@ -3199,26 +3576,33 @@ class User { return self::oldCrypt( $password, $userId ) === $hash; } } - + /** * Add a newuser log entry for this user - * @param bool $byEmail, account made by email? + * @param $byEmail Boolean: account made by email? */ public function addNewUserLogEntry( $byEmail = false ) { - global $wgUser, $wgContLang, $wgNewUserLog; - if( empty($wgNewUserLog) ) { + global $wgUser, $wgNewUserLog; + if( empty( $wgNewUserLog ) ) { return true; // disabled } - $talk = $wgContLang->getFormattedNsText( NS_TALK ); + if( $this->getName() == $wgUser->getName() ) { $action = 'create'; $message = ''; } else { $action = 'create2'; - $message = $byEmail ? wfMsgForContent( 'newuserlog-byemail' ) : ''; + $message = $byEmail + ? wfMsgForContent( 'newuserlog-byemail' ) + : ''; } $log = new LogPage( 'newusers' ); - $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) ); + $log->addEntry( + $action, + $this->getUserPage(), + $message, + array( $this->getId() ) + ); return true; } @@ -3227,8 +3611,8 @@ class User { * Used by things like CentralAuth and perhaps other authplugins. */ public function addNewUserLogEntryAutoCreate() { - global $wgNewUserLog; - if( empty($wgNewUserLog) ) { + global $wgNewUserLog, $wgLogAutocreatedAccounts; + if( !$wgNewUserLog || !$wgLogAutocreatedAccounts ) { return true; // disabled } $log = new LogPage( 'newusers', false ); @@ -3236,4 +3620,221 @@ class User { return true; } + protected function loadOptions() { + $this->load(); + if ( $this->mOptionsLoaded || !$this->getId() ) + return; + + $this->mOptions = self::getDefaultOptions(); + + // Maybe load from the object + if ( !is_null( $this->mOptionOverrides ) ) { + wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" ); + foreach( $this->mOptionOverrides as $key => $value ) { + $this->mOptions[$key] = $value; + } + } else { + wfDebug( "Loading options for user " . $this->getId() . " from database.\n" ); + // Load from database + $dbr = wfGetDB( DB_SLAVE ); + + $res = $dbr->select( + 'user_properties', + '*', + array( 'up_user' => $this->getId() ), + __METHOD__ + ); + + while( $row = $dbr->fetchObject( $res ) ) { + $this->mOptionOverrides[$row->up_property] = $row->up_value; + $this->mOptions[$row->up_property] = $row->up_value; + } + } + + $this->mOptionsLoaded = true; + + wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions ) ); + } + + protected function saveOptions() { + global $wgAllowPrefChange; + + $extuser = ExternalUser::newFromUser( $this ); + + $this->loadOptions(); + $dbw = wfGetDB( DB_MASTER ); + + $insert_rows = array(); + + $saveOptions = $this->mOptions; + + // Allow hooks to abort, for instance to save to a global profile. + // Reset options to default state before saving. + if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) + return; + + foreach( $saveOptions as $key => $value ) { + # Don't bother storing default values + if ( ( is_null( self::getDefaultOption( $key ) ) && + !( $value === false || is_null($value) ) ) || + $value != self::getDefaultOption( $key ) ) { + $insert_rows[] = array( + 'up_user' => $this->getId(), + 'up_property' => $key, + '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->begin(); + $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__ ); + $dbw->insert( 'user_properties', $insert_rows, __METHOD__ ); + $dbw->commit(); + } + + /** + * Provide an array of HTML5 attributes to put on an input element + * intended for the user to enter a new password. This may include + * required, title, and/or pattern, depending on $wgMinimalPasswordLength. + * + * Do *not* use this when asking the user to enter his current password! + * Regardless of configuration, users may have invalid passwords for whatever + * reason (e.g., they were set before requirements were tightened up). + * Only use it when asking for a new password, like on account creation or + * ResetPass. + * + * Obviously, you still need to do server-side checking. + * + * @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.) + */ + public static function passwordChangeInputAttribs() { + global $wgMinimalPasswordLength; + + if ( $wgMinimalPasswordLength == 0 ) { + return array(); + } + + # Note that the pattern requirement will always be satisfied if the + # input is empty, so we need required in all cases. + $ret = array( 'required' ); + + # We can't actually do this right now, because Opera 9.6 will print out + # the entered password visibly in its error message! When other + # browsers add support for this attribute, or Opera fixes its support, + # we can add support with a version check to avoid doing this on Opera + # versions where it will be a problem. Reported to Opera as + # DSK-262266, but they don't have a public bug tracker for us to follow. + /* + if ( $wgMinimalPasswordLength > 1 ) { + $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}'; + $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag', + $wgMinimalPasswordLength ); + } + */ + + return $ret; + } + + /** + * Format the user message using a hook, a template, or, failing these, a static format. + * @param $subject String the subject of the message + * @param $text String the content of the message + * @param $signature String the signature, if provided. + */ + static protected function formatUserMessage( $subject, $text, $signature ) { + if ( wfRunHooks( 'FormatUserMessage', + array( $subject, &$text, $signature ) ) ) { + + $signature = empty($signature) ? "~~~~~" : "{$signature} ~~~~~"; + + $template = Title::newFromText( wfMsgForContent( 'usermessage-template' ) ); + if ( !$template + || $template->getNamespace() !== NS_TEMPLATE + || !$template->exists() ) { + $text = "== $subject ==\n\n$text\n\n-- $signature"; + } else { + $text = '{{'. $template->getText() + . " | subject=$subject | body=$text | signature=$signature }}"; + } + } + + return $text; + } + + /** + * Leave a user a message + * @param $subject String the subject of the message + * @param $text String the message to leave + * @param $signature String Text to leave in the signature + * @param $summary String the summary for this change, defaults to + * "Leave system message." + * @param $article Article The article to update, defaults to the + * user's talk page. + * @param $editor User The user leaving the message, defaults to + * "{{MediaWiki:usermessage-editor}}" + * @param $flags Int default edit flags + * + * @return boolean true if it was successful + */ + public function leaveUserMessage( $subject, $text, $signature = "", + $summary = null, $editor = null, $flags = 0 ) { + if ( !isset( $summary ) ) { + $summary = wfMsgForContent( 'usermessage-summary' ); + } + + if ( !isset( $editor ) ) { + $editor = User::newFromName( wfMsgForContent( 'usermessage-editor' ) ); + if ( !$editor->isLoggedIn() ) { + $editor->addToDatabase(); + } + } + + $article = new Article( $this->getTalkPage() ); + wfRunHooks( 'SetupUserMessageArticle', + array( $this, &$article, $subject, $text, $signature, $summary, $editor ) ); + + + $text = self::formatUserMessage( $subject, $text, $signature ); + $flags = $article->checkFlags( $flags ); + + if ( $flags & EDIT_UPDATE ) { + $text .= $article->getContent(); + } + + $dbw = wfGetDB( DB_MASTER ); + $dbw->begin(); + + try { + $status = $article->doEdit( $text, $summary, $flags, false, $editor ); + } catch ( DBQueryError $e ) { + $status = Status::newFatal("DB Error"); + } + + if ( $status->isGood() ) { + // Set newtalk with the right user ID + $this->setNewtalk( true ); + wfRunHooks( 'AfterUserMessage', + array( $this, $article, $summary, $text, $signature, $summary, $editor ) ); + $dbw->commit(); + } else { + // The article was concurrently created + wfDebug( __METHOD__ . ": Error ".$status->getWikiText() ); + $dbw->rollback(); + } + + return $status->isGood(); + } }