3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * String Some punctuation to prevent editing from broken text-mangling proxies.
27 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
30 * The User object encapsulates all of the user-specific settings (user_id,
31 * name, rights, password, email address, options, last login time). Client
32 * classes use the getXXX() functions to access these fields. These functions
33 * do all the work of determining whether the user is logged in,
34 * whether the requested option can be satisfied from cookies or
35 * whether a database query is needed. Most of the settings needed
36 * for rendering normal pages are set in the cookie to minimize use
39 class User
implements IDBAccessObject
{
41 * @const int Number of characters in user_token field.
43 const TOKEN_LENGTH
= 32;
46 * Global constant made accessible as class constants so that autoloader
49 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
52 * @const int Serialized record version.
57 * Maximum items in $mWatchedItems
59 const MAX_WATCHED_ITEMS_CACHE
= 100;
62 * Exclude user options that are set to their default value.
65 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
68 * @var PasswordFactory Lazily loaded factory object for passwords
70 private static $mPasswordFactory = null;
73 * Array of Strings List of member variables which are saved to the
74 * shared cache (memcached). Any operation which changes the
75 * corresponding database fields must call a cache-clearing function.
78 protected static $mCacheVars = array(
86 'mEmailAuthenticated',
93 // user_properties table
98 * Array of Strings Core rights.
99 * Each of these should have a corresponding message of the form
103 protected static $mCoreRights = array(
130 'editusercssjs', #deprecated
143 'move-categorypages',
144 'move-rootuserpages',
148 'override-export-depth',
172 'userrights-interwiki',
180 * String Cached results of getAllRights()
182 protected static $mAllRights = false;
184 /** @name Cache variables */
193 * @todo Make this actually private
199 * @todo Make this actually private
202 public $mNewpassword;
204 public $mNewpassTime;
207 /** @var string TS_MW timestamp from the DB */
209 /** @var string TS_MW timestamp from cache */
210 protected $mQuickTouched;
214 public $mEmailAuthenticated;
216 protected $mEmailToken;
218 protected $mEmailTokenExpires;
220 protected $mRegistration;
222 protected $mEditCount;
226 protected $mOptionOverrides;
228 protected $mPasswordExpires;
232 * Bool Whether the cache variables have been loaded.
235 public $mOptionsLoaded;
238 * Array with already loaded items or true if all items have been loaded.
240 protected $mLoadedItems = array();
244 * String Initialization data source if mLoadedItems!==true. May be one of:
245 * - 'defaults' anonymous user initialised from class defaults
246 * - 'name' initialise from mName
247 * - 'id' initialise from mId
248 * - 'session' log in from cookies or session if possible
250 * Use the User::newFrom*() family of functions to set this.
255 * Lazy-initialized variables, invalidated with clearInstanceCache
259 protected $mDatePreference;
267 protected $mBlockreason;
269 protected $mEffectiveGroups;
271 protected $mImplicitGroups;
273 protected $mFormerGroups;
275 protected $mBlockedGlobally;
292 protected $mAllowUsertalk;
295 private $mBlockedFromCreateAccount = false;
298 private $mWatchedItems = array();
300 /** @var integer User::READ_* constant bitfield used to load data */
301 protected $queryFlagsUsed = self
::READ_NORMAL
;
303 public static $idCacheByName = array();
306 * Lightweight constructor for an anonymous user.
307 * Use the User::newFrom* factory functions for other kinds of users.
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return $this->getName();
327 * Load the user table data for this object from the source given by mFrom.
329 * @param integer $flags User::READ_* constant bitfield
331 public function load( $flags = self
::READ_LATEST
) {
332 if ( $this->mLoadedItems
=== true ) {
336 // Set it now to avoid infinite recursion in accessors
337 $this->mLoadedItems
= true;
338 $this->queryFlagsUsed
= $flags;
340 switch ( $this->mFrom
) {
342 $this->loadDefaults();
345 // @TODO: this gets the ID from a slave, assuming renames
346 // are rare. This should be controllable and more consistent.
347 $this->mId
= self
::idFromName( $this->mName
);
349 // Nonexistent user placeholder object
350 $this->loadDefaults( $this->mName
);
352 $this->loadFromId( $flags );
356 $this->loadFromId( $flags );
359 if ( !$this->loadFromSession() ) {
360 // Loading from session failed. Load defaults.
361 $this->loadDefaults();
363 Hooks
::run( 'UserLoadAfterLoadFromSession', array( $this ) );
366 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
371 * Load user table data, given mId has already been set.
372 * @param integer $flags User::READ_* constant bitfield
373 * @return bool False if the ID does not exist, true otherwise
375 public function loadFromId( $flags = self
::READ_LATEST
) {
376 if ( $this->mId
== 0 ) {
377 $this->loadDefaults();
382 $cache = $this->loadFromCache();
384 wfDebug( "User: cache miss for user {$this->mId}\n" );
386 if ( !$this->loadFromDatabase( $flags ) ) {
387 // Can't load from ID, user is anonymous
390 if ( $flags & self
::READ_LATEST
) {
391 // Only save master data back to the cache to keep it consistent.
392 // @TODO: save it anyway and have callers specifiy $flags and have
393 // load() called as needed. That requires updating MANY callers...
394 $this->saveToCache();
398 $this->mLoadedItems
= true;
399 $this->queryFlagsUsed
= $flags;
405 * Load user data from shared cache, given mId has already been set.
407 * @return bool false if the ID does not exist or data is invalid, true otherwise
410 protected function loadFromCache() {
413 if ( $this->mId
== 0 ) {
414 $this->loadDefaults();
418 $key = wfMemcKey( 'user', 'id', $this->mId
);
419 $data = $wgMemc->get( $key );
420 if ( !is_array( $data ) ||
$data['mVersion'] < self
::VERSION
) {
425 wfDebug( "User: got user {$this->mId} from cache\n" );
427 // Restore from cache
428 foreach ( self
::$mCacheVars as $name ) {
429 $this->$name = $data[$name];
436 * Save user data to the shared cache
438 * This method should not be called outside the User class
440 public function saveToCache() {
445 $this->loadOptions();
447 if ( $this->isAnon() ) {
448 // Anonymous users are uncached
452 // The cache needs good consistency due to its high TTL, so the user
453 // should have been loaded from the master to avoid lag amplification.
454 if ( !( $this->queryFlagsUsed
& self
::READ_LATEST
) ) {
455 wfWarn( "Cannot save slave-loaded User object data to cache." );
460 foreach ( self
::$mCacheVars as $name ) {
461 $data[$name] = $this->$name;
463 $data['mVersion'] = self
::VERSION
;
464 $key = wfMemcKey( 'user', 'id', $this->mId
);
466 $wgMemc->set( $key, $data );
469 /** @name newFrom*() static factory methods */
473 * Static factory method for creation from username.
475 * This is slightly less efficient than newFromId(), so use newFromId() if
476 * you have both an ID and a name handy.
478 * @param string $name Username, validated by Title::newFromText()
479 * @param string|bool $validate Validate username. Takes the same parameters as
480 * User::getCanonicalName(), except that true is accepted as an alias
481 * for 'valid', for BC.
483 * @return User|bool User object, or false if the username is invalid
484 * (e.g. if it contains illegal characters or is an IP address). If the
485 * username is not present in the database, the result will be a user object
486 * with a name, zero user ID and default settings.
488 public static function newFromName( $name, $validate = 'valid' ) {
489 if ( $validate === true ) {
492 $name = self
::getCanonicalName( $name, $validate );
493 if ( $name === false ) {
496 // Create unloaded user object
500 $u->setItemLoaded( 'name' );
506 * Static factory method for creation from a given user ID.
508 * @param int $id Valid user ID
509 * @return User The corresponding User object
511 public static function newFromId( $id ) {
515 $u->setItemLoaded( 'id' );
520 * Factory method to fetch whichever user has a given email confirmation code.
521 * This code is generated when an account is created or its e-mail address
524 * If the code is invalid or has expired, returns NULL.
526 * @param string $code Confirmation code
529 public static function newFromConfirmationCode( $code ) {
530 $dbr = wfGetDB( DB_SLAVE
);
531 $id = $dbr->selectField( 'user', 'user_id', array(
532 'user_email_token' => md5( $code ),
533 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
535 if ( $id !== false ) {
536 return User
::newFromId( $id );
543 * Create a new user object using data from session or cookies. If the
544 * login credentials are invalid, the result is an anonymous user.
546 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
549 public static function newFromSession( WebRequest
$request = null ) {
551 $user->mFrom
= 'session';
552 $user->mRequest
= $request;
557 * Create a new user object from a user row.
558 * The row should have the following fields from the user table in it:
559 * - either user_name or user_id to load further data if needed (or both)
561 * - all other fields (email, password, etc.)
562 * It is useless to provide the remaining fields if either user_id,
563 * user_name and user_real_name are not provided because the whole row
564 * will be loaded once more from the database when accessing them.
566 * @param stdClass $row A row from the user table
567 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
570 public static function newFromRow( $row, $data = null ) {
572 $user->loadFromRow( $row, $data );
579 * Get the username corresponding to a given user ID
580 * @param int $id User ID
581 * @return string|bool The corresponding username
583 public static function whoIs( $id ) {
584 return UserCache
::singleton()->getProp( $id, 'name' );
588 * Get the real name of a user given their user ID
590 * @param int $id User ID
591 * @return string|bool The corresponding user's real name
593 public static function whoIsReal( $id ) {
594 return UserCache
::singleton()->getProp( $id, 'real_name' );
598 * Get database id given a user name
599 * @param string $name Username
600 * @return int|null The corresponding user's ID, or null if user is nonexistent
602 public static function idFromName( $name ) {
603 $nt = Title
::makeTitleSafe( NS_USER
, $name );
604 if ( is_null( $nt ) ) {
609 if ( isset( self
::$idCacheByName[$name] ) ) {
610 return self
::$idCacheByName[$name];
613 $dbr = wfGetDB( DB_SLAVE
);
614 $s = $dbr->selectRow(
617 array( 'user_name' => $nt->getText() ),
621 if ( $s === false ) {
624 $result = $s->user_id
;
627 self
::$idCacheByName[$name] = $result;
629 if ( count( self
::$idCacheByName ) > 1000 ) {
630 self
::$idCacheByName = array();
637 * Reset the cache used in idFromName(). For use in tests.
639 public static function resetIdByNameCache() {
640 self
::$idCacheByName = array();
644 * Does the string match an anonymous IPv4 address?
646 * This function exists for username validation, in order to reject
647 * usernames which are similar in form to IP addresses. Strings such
648 * as 300.300.300.300 will return true because it looks like an IP
649 * address, despite not being strictly valid.
651 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
652 * address because the usemod software would "cloak" anonymous IP
653 * addresses like this, if we allowed accounts like this to be created
654 * new users could get the old edits of these anonymous users.
656 * @param string $name Name to match
659 public static function isIP( $name ) {
660 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
661 || IP
::isIPv6( $name );
665 * Is the input a valid username?
667 * Checks if the input is a valid username, we don't want an empty string,
668 * an IP address, anything that contains slashes (would mess up subpages),
669 * is longer than the maximum allowed username size or doesn't begin with
672 * @param string $name Name to match
675 public static function isValidUserName( $name ) {
676 global $wgContLang, $wgMaxNameChars;
679 || User
::isIP( $name )
680 ||
strpos( $name, '/' ) !== false
681 ||
strlen( $name ) > $wgMaxNameChars
682 ||
$name != $wgContLang->ucfirst( $name )
684 wfDebugLog( 'username', __METHOD__
.
685 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
689 // Ensure that the name can't be misresolved as a different title,
690 // such as with extra namespace keys at the start.
691 $parsed = Title
::newFromText( $name );
692 if ( is_null( $parsed )
693 ||
$parsed->getNamespace()
694 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
695 wfDebugLog( 'username', __METHOD__
.
696 ": '$name' invalid due to ambiguous prefixes" );
700 // Check an additional blacklist of troublemaker characters.
701 // Should these be merged into the title char list?
702 $unicodeBlacklist = '/[' .
703 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
704 '\x{00a0}' . # non-breaking space
705 '\x{2000}-\x{200f}' . # various whitespace
706 '\x{2028}-\x{202f}' . # breaks and control chars
707 '\x{3000}' . # ideographic space
708 '\x{e000}-\x{f8ff}' . # private use
710 if ( preg_match( $unicodeBlacklist, $name ) ) {
711 wfDebugLog( 'username', __METHOD__
.
712 ": '$name' invalid due to blacklisted characters" );
720 * Usernames which fail to pass this function will be blocked
721 * from user login and new account registrations, but may be used
722 * internally by batch processes.
724 * If an account already exists in this form, login will be blocked
725 * by a failure to pass this function.
727 * @param string $name Name to match
730 public static function isUsableName( $name ) {
731 global $wgReservedUsernames;
732 // Must be a valid username, obviously ;)
733 if ( !self
::isValidUserName( $name ) ) {
737 static $reservedUsernames = false;
738 if ( !$reservedUsernames ) {
739 $reservedUsernames = $wgReservedUsernames;
740 Hooks
::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
743 // Certain names may be reserved for batch processes.
744 foreach ( $reservedUsernames as $reserved ) {
745 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
746 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
748 if ( $reserved == $name ) {
756 * Usernames which fail to pass this function will be blocked
757 * from new account registrations, but may be used internally
758 * either by batch processes or by user accounts which have
759 * already been created.
761 * Additional blacklisting may be added here rather than in
762 * isValidUserName() to avoid disrupting existing accounts.
764 * @param string $name String to match
767 public static function isCreatableName( $name ) {
768 global $wgInvalidUsernameCharacters;
770 // Ensure that the username isn't longer than 235 bytes, so that
771 // (at least for the builtin skins) user javascript and css files
772 // will work. (bug 23080)
773 if ( strlen( $name ) > 235 ) {
774 wfDebugLog( 'username', __METHOD__
.
775 ": '$name' invalid due to length" );
779 // Preg yells if you try to give it an empty string
780 if ( $wgInvalidUsernameCharacters !== '' ) {
781 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
782 wfDebugLog( 'username', __METHOD__
.
783 ": '$name' invalid due to wgInvalidUsernameCharacters" );
788 return self
::isUsableName( $name );
792 * Is the input a valid password for this user?
794 * @param string $password Desired password
797 public function isValidPassword( $password ) {
798 //simple boolean wrapper for getPasswordValidity
799 return $this->getPasswordValidity( $password ) === true;
804 * Given unvalidated password input, return error message on failure.
806 * @param string $password Desired password
807 * @return bool|string|array True on success, string or array of error message on failure
809 public function getPasswordValidity( $password ) {
810 $result = $this->checkPasswordValidity( $password );
811 if ( $result->isGood() ) {
815 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
816 $messages[] = $error['message'];
818 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
819 $messages[] = $warning['message'];
821 if ( count( $messages ) === 1 ) {
829 * Check if this is a valid password for this user
831 * Create a Status object based on the password's validity.
832 * The Status should be set to fatal if the user should not
833 * be allowed to log in, and should have any errors that
834 * would block changing the password.
836 * If the return value of this is not OK, the password
837 * should not be checked. If the return value is not Good,
838 * the password can be checked, but the user should not be
839 * able to set their password to this.
841 * @param string $password Desired password
845 public function checkPasswordValidity( $password ) {
846 global $wgMinimalPasswordLength, $wgMaximalPasswordLength, $wgContLang;
848 static $blockedLogins = array(
849 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
850 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
853 $status = Status
::newGood();
855 $result = false; //init $result to false for the internal checks
857 if ( !Hooks
::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
858 $status->error( $result );
862 if ( $result === false ) {
863 if ( strlen( $password ) < $wgMinimalPasswordLength ) {
864 $status->error( 'passwordtooshort', $wgMinimalPasswordLength );
866 } elseif ( strlen( $password ) > $wgMaximalPasswordLength ) {
867 // T64685: Password too long, might cause DoS attack
868 $status->fatal( 'passwordtoolong', $wgMaximalPasswordLength );
870 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
871 $status->error( 'password-name-match' );
873 } elseif ( isset( $blockedLogins[$this->getName()] )
874 && $password == $blockedLogins[$this->getName()]
876 $status->error( 'password-login-forbidden' );
879 //it seems weird returning a Good status here, but this is because of the
880 //initialization of $result to false above. If the hook is never run or it
881 //doesn't modify $result, then we will likely get down into this if with
885 } elseif ( $result === true ) {
888 $status->error( $result );
889 return $status; //the isValidPassword hook set a string $result and returned true
894 * Expire a user's password
896 * @param int $ts Optional timestamp to convert, default 0 for the current time
898 public function expirePassword( $ts = 0 ) {
899 $this->loadPasswords();
900 $timestamp = wfTimestamp( TS_MW
, $ts );
901 $this->mPasswordExpires
= $timestamp;
902 $this->saveSettings();
906 * Clear the password expiration for a user
908 * @param bool $load Ensure user object is loaded first
910 public function resetPasswordExpiration( $load = true ) {
911 global $wgPasswordExpirationDays;
916 if ( $wgPasswordExpirationDays ) {
917 $newExpire = wfTimestamp(
919 time() +
( $wgPasswordExpirationDays * 24 * 3600 )
922 // Give extensions a chance to force an expiration
923 Hooks
::run( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
924 $this->mPasswordExpires
= $newExpire;
928 * Check if the user's password is expired.
929 * TODO: Put this and password length into a PasswordPolicy object
931 * @return string|bool The expiration type, or false if not expired
932 * hard: A password change is required to login
933 * soft: Allow login, but encourage password change
934 * false: Password is not expired
936 public function getPasswordExpired() {
937 global $wgPasswordExpireGrace;
939 $now = wfTimestamp();
940 $expiration = $this->getPasswordExpireDate();
941 $expUnix = wfTimestamp( TS_UNIX
, $expiration );
942 if ( $expiration !== null && $expUnix < $now ) {
943 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';
949 * Get this user's password expiration date. Since this may be using
950 * the cached User object, we assume that whatever mechanism is setting
951 * the expiration date is also expiring the User cache.
953 * @return string|bool The datestamp of the expiration, or null if not set
955 public function getPasswordExpireDate() {
957 return $this->mPasswordExpires
;
961 * Given unvalidated user input, return a canonical username, or false if
962 * the username is invalid.
963 * @param string $name User input
964 * @param string|bool $validate Type of validation to use:
965 * - false No validation
966 * - 'valid' Valid for batch processes
967 * - 'usable' Valid for batch processes and login
968 * - 'creatable' Valid for batch processes, login and account creation
970 * @throws MWException
971 * @return bool|string
973 public static function getCanonicalName( $name, $validate = 'valid' ) {
974 // Force usernames to capital
976 $name = $wgContLang->ucfirst( $name );
978 # Reject names containing '#'; these will be cleaned up
979 # with title normalisation, but then it's too late to
981 if ( strpos( $name, '#' ) !== false ) {
985 // Clean up name according to title rules,
986 // but only when validation is requested (bug 12654)
987 $t = ( $validate !== false ) ?
988 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
989 // Check for invalid titles
990 if ( is_null( $t ) ) {
994 // Reject various classes of invalid names
996 $name = $wgAuth->getCanonicalName( $t->getText() );
998 switch ( $validate ) {
1002 if ( !User
::isValidUserName( $name ) ) {
1007 if ( !User
::isUsableName( $name ) ) {
1012 if ( !User
::isCreatableName( $name ) ) {
1017 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
1023 * Count the number of edits of a user
1025 * @param int $uid User ID to check
1026 * @return int The user's edit count
1028 * @deprecated since 1.21 in favour of User::getEditCount
1030 public static function edits( $uid ) {
1031 wfDeprecated( __METHOD__
, '1.21' );
1032 $user = self
::newFromId( $uid );
1033 return $user->getEditCount();
1037 * Return a random password.
1039 * @return string New random password
1041 public static function randomPassword() {
1042 global $wgMinimalPasswordLength;
1043 // Decide the final password length based on our min password length,
1044 // stopping at a minimum of 10 chars.
1045 $length = max( 10, $wgMinimalPasswordLength );
1046 // Multiply by 1.25 to get the number of hex characters we need
1047 $length = $length * 1.25;
1048 // Generate random hex chars
1049 $hex = MWCryptRand
::generateHex( $length );
1050 // Convert from base 16 to base 32 to get a proper password like string
1051 return wfBaseConvert( $hex, 16, 32 );
1055 * Set cached properties to default.
1057 * @note This no longer clears uncached lazy-initialised properties;
1058 * the constructor does that instead.
1060 * @param string|bool $name
1062 public function loadDefaults( $name = false ) {
1064 $passwordFactory = self
::getPasswordFactory();
1067 $this->mName
= $name;
1068 $this->mRealName
= '';
1069 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1070 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1071 $this->mNewpassTime
= null;
1073 $this->mOptionOverrides
= null;
1074 $this->mOptionsLoaded
= false;
1076 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1077 if ( $loggedOut !== null ) {
1078 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1080 $this->mTouched
= '1'; # Allow any pages to be cached
1083 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1084 $this->mEmailAuthenticated
= null;
1085 $this->mEmailToken
= '';
1086 $this->mEmailTokenExpires
= null;
1087 $this->mPasswordExpires
= null;
1088 $this->resetPasswordExpiration( false );
1089 $this->mRegistration
= wfTimestamp( TS_MW
);
1090 $this->mGroups
= array();
1092 Hooks
::run( 'UserLoadDefaults', array( $this, $name ) );
1096 * Return whether an item has been loaded.
1098 * @param string $item Item to check. Current possibilities:
1102 * @param string $all 'all' to check if the whole object has been loaded
1103 * or any other string to check if only the item is available (e.g.
1107 public function isItemLoaded( $item, $all = 'all' ) {
1108 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1109 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1113 * Set that an item has been loaded
1115 * @param string $item
1117 protected function setItemLoaded( $item ) {
1118 if ( is_array( $this->mLoadedItems
) ) {
1119 $this->mLoadedItems
[$item] = true;
1124 * Load user data from the session or login cookie.
1126 * @return bool True if the user is logged in, false otherwise.
1128 private function loadFromSession() {
1130 Hooks
::run( 'UserLoadFromSession', array( $this, &$result ) );
1131 if ( $result !== null ) {
1135 $request = $this->getRequest();
1137 $cookieId = $request->getCookie( 'UserID' );
1138 $sessId = $request->getSessionData( 'wsUserID' );
1140 if ( $cookieId !== null ) {
1141 $sId = intval( $cookieId );
1142 if ( $sessId !== null && $cookieId != $sessId ) {
1143 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1144 cookie user ID ($sId) don't match!" );
1147 $request->setSessionData( 'wsUserID', $sId );
1148 } elseif ( $sessId !== null && $sessId != 0 ) {
1154 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1155 $sName = $request->getSessionData( 'wsUserName' );
1156 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1157 $sName = $request->getCookie( 'UserName' );
1158 $request->setSessionData( 'wsUserName', $sName );
1163 $proposedUser = User
::newFromId( $sId );
1164 $proposedUser->load( self
::READ_LATEST
);
1165 if ( !$proposedUser->isLoggedIn() ) {
1170 global $wgBlockDisablesLogin;
1171 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1172 // User blocked and we've disabled blocked user logins
1176 if ( $request->getSessionData( 'wsToken' ) ) {
1178 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1180 } elseif ( $request->getCookie( 'Token' ) ) {
1181 # Get the token from DB/cache and clean it up to remove garbage padding.
1182 # This deals with historical problems with bugs and the default column value.
1183 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1184 // Make comparison in constant time (bug 61346)
1185 $passwordCorrect = strlen( $token )
1186 && hash_equals( $token, $request->getCookie( 'Token' ) );
1189 // No session or persistent login cookie
1193 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1194 $this->loadFromUserObject( $proposedUser );
1195 $request->setSessionData( 'wsToken', $this->mToken
);
1196 wfDebug( "User: logged in from $from\n" );
1199 // Invalid credentials
1200 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1206 * Load user and user_group data from the database.
1207 * $this->mId must be set, this is how the user is identified.
1209 * @param integer $flags User::READ_* constant bitfield
1210 * @return bool True if the user exists, false if the user is anonymous
1212 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1214 $this->mId
= intval( $this->mId
);
1217 if ( !$this->mId
) {
1218 $this->loadDefaults();
1222 $db = ( $flags & self
::READ_LATEST
)
1223 ?
wfGetDB( DB_MASTER
)
1224 : wfGetDB( DB_SLAVE
);
1226 $s = $db->selectRow(
1228 self
::selectFields(),
1229 array( 'user_id' => $this->mId
),
1231 ( $flags & self
::READ_LOCKING
== self
::READ_LOCKING
)
1232 ?
array( 'LOCK IN SHARE MODE' )
1236 $this->queryFlagsUsed
= $flags;
1237 Hooks
::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1239 if ( $s !== false ) {
1240 // Initialise user table data
1241 $this->loadFromRow( $s );
1242 $this->mGroups
= null; // deferred
1243 $this->getEditCount(); // revalidation for nulls
1248 $this->loadDefaults();
1254 * Initialize this object from a row from the user table.
1256 * @param stdClass $row Row from the user table to load.
1257 * @param array $data Further user data to load into the object
1259 * user_groups Array with groups out of the user_groups table
1260 * user_properties Array with properties out of the user_properties table
1262 protected function loadFromRow( $row, $data = null ) {
1264 $passwordFactory = self
::getPasswordFactory();
1266 $this->mGroups
= null; // deferred
1268 if ( isset( $row->user_name
) ) {
1269 $this->mName
= $row->user_name
;
1270 $this->mFrom
= 'name';
1271 $this->setItemLoaded( 'name' );
1276 if ( isset( $row->user_real_name
) ) {
1277 $this->mRealName
= $row->user_real_name
;
1278 $this->setItemLoaded( 'realname' );
1283 if ( isset( $row->user_id
) ) {
1284 $this->mId
= intval( $row->user_id
);
1285 $this->mFrom
= 'id';
1286 $this->setItemLoaded( 'id' );
1291 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1292 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1295 if ( isset( $row->user_editcount
) ) {
1296 $this->mEditCount
= $row->user_editcount
;
1301 if ( isset( $row->user_password
) ) {
1302 // Check for *really* old password hashes that don't even have a type
1303 // The old hash format was just an md5 hex hash, with no type information
1304 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password
) ) {
1305 $row->user_password
= ":A:{$this->mId}:{$row->user_password}";
1309 $this->mPassword
= $passwordFactory->newFromCiphertext( $row->user_password
);
1310 } catch ( PasswordError
$e ) {
1311 wfDebug( 'Invalid password hash found in database.' );
1312 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1316 $this->mNewpassword
= $passwordFactory->newFromCiphertext( $row->user_newpassword
);
1317 } catch ( PasswordError
$e ) {
1318 wfDebug( 'Invalid password hash found in database.' );
1319 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1322 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1323 $this->mPasswordExpires
= wfTimestampOrNull( TS_MW
, $row->user_password_expires
);
1326 if ( isset( $row->user_email
) ) {
1327 $this->mEmail
= $row->user_email
;
1328 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1329 $this->mToken
= $row->user_token
;
1330 if ( $this->mToken
== '' ) {
1331 $this->mToken
= null;
1333 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1334 $this->mEmailToken
= $row->user_email_token
;
1335 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1336 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1342 $this->mLoadedItems
= true;
1345 if ( is_array( $data ) ) {
1346 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1347 $this->mGroups
= $data['user_groups'];
1349 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1350 $this->loadOptions( $data['user_properties'] );
1356 * Load the data for this user object from another user object.
1360 protected function loadFromUserObject( $user ) {
1362 $user->loadGroups();
1363 $user->loadOptions();
1364 foreach ( self
::$mCacheVars as $var ) {
1365 $this->$var = $user->$var;
1370 * Load the groups from the database if they aren't already loaded.
1372 private function loadGroups() {
1373 if ( is_null( $this->mGroups
) ) {
1374 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1375 ?
wfGetDB( DB_MASTER
)
1376 : wfGetDB( DB_SLAVE
);
1377 $res = $dbr->select( 'user_groups',
1378 array( 'ug_group' ),
1379 array( 'ug_user' => $this->mId
),
1381 $this->mGroups
= array();
1382 foreach ( $res as $row ) {
1383 $this->mGroups
[] = $row->ug_group
;
1389 * Load the user's password hashes from the database
1391 * This is usually called in a scenario where the actual User object was
1392 * loaded from the cache, and then password comparison needs to be performed.
1393 * Password hashes are not stored in memcached.
1397 private function loadPasswords() {
1398 if ( $this->getId() !== 0 && ( $this->mPassword
=== null ||
$this->mNewpassword
=== null ) ) {
1399 $this->loadFromRow( wfGetDB( DB_MASTER
)->selectRow(
1401 array( 'user_password', 'user_newpassword', 'user_newpass_time', 'user_password_expires' ),
1402 array( 'user_id' => $this->getId() ),
1409 * Add the user to the group if he/she meets given criteria.
1411 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1412 * possible to remove manually via Special:UserRights. In such case it
1413 * will not be re-added automatically. The user will also not lose the
1414 * group if they no longer meet the criteria.
1416 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1418 * @return array Array of groups the user has been promoted to.
1420 * @see $wgAutopromoteOnce
1422 public function addAutopromoteOnceGroups( $event ) {
1423 global $wgAutopromoteOnceLogInRC, $wgAuth;
1425 $toPromote = array();
1426 if ( !wfReadOnly() && $this->getId() ) {
1427 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1428 if ( count( $toPromote ) ) {
1429 $oldGroups = $this->getGroups(); // previous groups
1431 foreach ( $toPromote as $group ) {
1432 $this->addGroup( $group );
1434 // update groups in external authentication database
1435 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1437 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1439 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1440 $logEntry->setPerformer( $this );
1441 $logEntry->setTarget( $this->getUserPage() );
1442 $logEntry->setParameters( array(
1443 '4::oldgroups' => $oldGroups,
1444 '5::newgroups' => $newGroups,
1446 $logid = $logEntry->insert();
1447 if ( $wgAutopromoteOnceLogInRC ) {
1448 $logEntry->publish( $logid );
1457 * Clear various cached data stored in this object. The cache of the user table
1458 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1460 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1461 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1463 public function clearInstanceCache( $reloadFrom = false ) {
1464 $this->mNewtalk
= -1;
1465 $this->mDatePreference
= null;
1466 $this->mBlockedby
= -1; # Unset
1467 $this->mHash
= false;
1468 $this->mRights
= null;
1469 $this->mEffectiveGroups
= null;
1470 $this->mImplicitGroups
= null;
1471 $this->mGroups
= null;
1472 $this->mOptions
= null;
1473 $this->mOptionsLoaded
= false;
1474 $this->mEditCount
= null;
1476 if ( $reloadFrom ) {
1477 $this->mLoadedItems
= array();
1478 $this->mFrom
= $reloadFrom;
1483 * Combine the language default options with any site-specific options
1484 * and add the default language variants.
1486 * @return array Array of String options
1488 public static function getDefaultOptions() {
1489 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1491 static $defOpt = null;
1492 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1493 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1494 // mid-request and see that change reflected in the return value of this function.
1495 // Which is insane and would never happen during normal MW operation
1499 $defOpt = $wgDefaultUserOptions;
1500 // Default language setting
1501 $defOpt['language'] = $wgContLang->getCode();
1502 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1503 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1505 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1506 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1508 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1510 Hooks
::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1516 * Get a given default option value.
1518 * @param string $opt Name of option to retrieve
1519 * @return string Default option value
1521 public static function getDefaultOption( $opt ) {
1522 $defOpts = self
::getDefaultOptions();
1523 if ( isset( $defOpts[$opt] ) ) {
1524 return $defOpts[$opt];
1531 * Get blocking information
1532 * @param bool $bFromSlave Whether to check the slave database first.
1533 * To improve performance, non-critical checks are done against slaves.
1534 * Check when actually saving should be done against master.
1536 private function getBlockedStatus( $bFromSlave = true ) {
1537 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1539 if ( -1 != $this->mBlockedby
) {
1543 wfDebug( __METHOD__
. ": checking...\n" );
1545 // Initialize data...
1546 // Otherwise something ends up stomping on $this->mBlockedby when
1547 // things get lazy-loaded later, causing false positive block hits
1548 // due to -1 !== 0. Probably session-related... Nothing should be
1549 // overwriting mBlockedby, surely?
1552 # We only need to worry about passing the IP address to the Block generator if the
1553 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1554 # know which IP address they're actually coming from
1555 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1556 $ip = $this->getRequest()->getIP();
1562 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1565 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1566 && !in_array( $ip, $wgProxyWhitelist )
1569 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1571 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1572 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1573 $block->setTarget( $ip );
1574 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1576 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1577 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1578 $block->setTarget( $ip );
1582 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1583 if ( !$block instanceof Block
1584 && $wgApplyIpBlocksToXff
1586 && !$this->isAllowed( 'proxyunbannable' )
1587 && !in_array( $ip, $wgProxyWhitelist )
1589 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1590 $xff = array_map( 'trim', explode( ',', $xff ) );
1591 $xff = array_diff( $xff, array( $ip ) );
1592 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1593 $block = Block
::chooseBlock( $xffblocks, $xff );
1594 if ( $block instanceof Block
) {
1595 # Mangle the reason to alert the user that the block
1596 # originated from matching the X-Forwarded-For header.
1597 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1601 if ( $block instanceof Block
) {
1602 wfDebug( __METHOD__
. ": Found block.\n" );
1603 $this->mBlock
= $block;
1604 $this->mBlockedby
= $block->getByName();
1605 $this->mBlockreason
= $block->mReason
;
1606 $this->mHideName
= $block->mHideName
;
1607 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1609 $this->mBlockedby
= '';
1610 $this->mHideName
= 0;
1611 $this->mAllowUsertalk
= false;
1615 Hooks
::run( 'GetBlockedStatus', array( &$this ) );
1620 * Whether the given IP is in a DNS blacklist.
1622 * @param string $ip IP to check
1623 * @param bool $checkWhitelist Whether to check the whitelist first
1624 * @return bool True if blacklisted.
1626 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1627 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1629 if ( !$wgEnableDnsBlacklist ) {
1633 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1637 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1641 * Whether the given IP is in a given DNS blacklist.
1643 * @param string $ip IP to check
1644 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1645 * @return bool True if blacklisted.
1647 public function inDnsBlacklist( $ip, $bases ) {
1650 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1651 if ( IP
::isIPv4( $ip ) ) {
1652 // Reverse IP, bug 21255
1653 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1655 foreach ( (array)$bases as $base ) {
1657 // If we have an access key, use that too (ProjectHoneypot, etc.)
1658 if ( is_array( $base ) ) {
1659 if ( count( $base ) >= 2 ) {
1660 // Access key is 1, base URL is 0
1661 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1663 $host = "$ipReversed.{$base[0]}";
1666 $host = "$ipReversed.$base";
1670 $ipList = gethostbynamel( $host );
1673 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1677 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1686 * Check if an IP address is in the local proxy list
1692 public static function isLocallyBlockedProxy( $ip ) {
1693 global $wgProxyList;
1695 if ( !$wgProxyList ) {
1699 if ( !is_array( $wgProxyList ) ) {
1700 // Load from the specified file
1701 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1704 if ( !is_array( $wgProxyList ) ) {
1706 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1708 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1709 // Old-style flipped proxy list
1718 * Is this user subject to rate limiting?
1720 * @return bool True if rate limited
1722 public function isPingLimitable() {
1723 global $wgRateLimitsExcludedIPs;
1724 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1725 // No other good way currently to disable rate limits
1726 // for specific IPs. :P
1727 // But this is a crappy hack and should die.
1730 return !$this->isAllowed( 'noratelimit' );
1734 * Primitive rate limits: enforce maximum actions per time period
1735 * to put a brake on flooding.
1737 * The method generates both a generic profiling point and a per action one
1738 * (suffix being "-$action".
1740 * @note When using a shared cache like memcached, IP-address
1741 * last-hit counters will be shared across wikis.
1743 * @param string $action Action to enforce; 'edit' if unspecified
1744 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1745 * @return bool True if a rate limiter was tripped
1747 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1748 // Call the 'PingLimiter' hook
1750 if ( !Hooks
::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1754 global $wgRateLimits;
1755 if ( !isset( $wgRateLimits[$action] ) ) {
1759 // Some groups shouldn't trigger the ping limiter, ever
1760 if ( !$this->isPingLimitable() ) {
1766 $limits = $wgRateLimits[$action];
1768 $id = $this->getId();
1771 if ( isset( $limits['anon'] ) && $id == 0 ) {
1772 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1775 if ( isset( $limits['user'] ) && $id != 0 ) {
1776 $userLimit = $limits['user'];
1778 if ( $this->isNewbie() ) {
1779 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1780 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1782 if ( isset( $limits['ip'] ) ) {
1783 $ip = $this->getRequest()->getIP();
1784 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1786 if ( isset( $limits['subnet'] ) ) {
1787 $ip = $this->getRequest()->getIP();
1790 if ( IP
::isIPv6( $ip ) ) {
1791 $parts = IP
::parseRange( "$ip/64" );
1792 $subnet = $parts[0];
1793 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1795 $subnet = $matches[1];
1797 if ( $subnet !== false ) {
1798 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1802 // Check for group-specific permissions
1803 // If more than one group applies, use the group with the highest limit
1804 foreach ( $this->getGroups() as $group ) {
1805 if ( isset( $limits[$group] ) ) {
1806 if ( $userLimit === false
1807 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1809 $userLimit = $limits[$group];
1813 // Set the user limit key
1814 if ( $userLimit !== false ) {
1815 list( $max, $period ) = $userLimit;
1816 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1817 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1821 foreach ( $keys as $key => $limit ) {
1822 list( $max, $period ) = $limit;
1823 $summary = "(limit $max in {$period}s)";
1824 $count = $wgMemc->get( $key );
1827 if ( $count >= $max ) {
1828 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1829 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1832 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1835 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1836 if ( $incrBy > 0 ) {
1837 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1840 if ( $incrBy > 0 ) {
1841 $wgMemc->incr( $key, $incrBy );
1849 * Check if user is blocked
1851 * @param bool $bFromSlave Whether to check the slave database instead of
1852 * the master. Hacked from false due to horrible probs on site.
1853 * @return bool True if blocked, false otherwise
1855 public function isBlocked( $bFromSlave = true ) {
1856 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1860 * Get the block affecting the user, or null if the user is not blocked
1862 * @param bool $bFromSlave Whether to check the slave database instead of the master
1863 * @return Block|null
1865 public function getBlock( $bFromSlave = true ) {
1866 $this->getBlockedStatus( $bFromSlave );
1867 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1871 * Check if user is blocked from editing a particular article
1873 * @param Title $title Title to check
1874 * @param bool $bFromSlave Whether to check the slave database instead of the master
1877 public function isBlockedFrom( $title, $bFromSlave = false ) {
1878 global $wgBlockAllowsUTEdit;
1880 $blocked = $this->isBlocked( $bFromSlave );
1881 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1882 // If a user's name is suppressed, they cannot make edits anywhere
1883 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1884 && $title->getNamespace() == NS_USER_TALK
) {
1886 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1889 Hooks
::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1895 * If user is blocked, return the name of the user who placed the block
1896 * @return string Name of blocker
1898 public function blockedBy() {
1899 $this->getBlockedStatus();
1900 return $this->mBlockedby
;
1904 * If user is blocked, return the specified reason for the block
1905 * @return string Blocking reason
1907 public function blockedFor() {
1908 $this->getBlockedStatus();
1909 return $this->mBlockreason
;
1913 * If user is blocked, return the ID for the block
1914 * @return int Block ID
1916 public function getBlockId() {
1917 $this->getBlockedStatus();
1918 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1922 * Check if user is blocked on all wikis.
1923 * Do not use for actual edit permission checks!
1924 * This is intended for quick UI checks.
1926 * @param string $ip IP address, uses current client if none given
1927 * @return bool True if blocked, false otherwise
1929 public function isBlockedGlobally( $ip = '' ) {
1930 if ( $this->mBlockedGlobally
!== null ) {
1931 return $this->mBlockedGlobally
;
1933 // User is already an IP?
1934 if ( IP
::isIPAddress( $this->getName() ) ) {
1935 $ip = $this->getName();
1937 $ip = $this->getRequest()->getIP();
1940 Hooks
::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1941 $this->mBlockedGlobally
= (bool)$blocked;
1942 return $this->mBlockedGlobally
;
1946 * Check if user account is locked
1948 * @return bool True if locked, false otherwise
1950 public function isLocked() {
1951 if ( $this->mLocked
!== null ) {
1952 return $this->mLocked
;
1955 $authUser = $wgAuth->getUserInstance( $this );
1956 $this->mLocked
= (bool)$authUser->isLocked();
1957 return $this->mLocked
;
1961 * Check if user account is hidden
1963 * @return bool True if hidden, false otherwise
1965 public function isHidden() {
1966 if ( $this->mHideName
!== null ) {
1967 return $this->mHideName
;
1969 $this->getBlockedStatus();
1970 if ( !$this->mHideName
) {
1972 $authUser = $wgAuth->getUserInstance( $this );
1973 $this->mHideName
= (bool)$authUser->isHidden();
1975 return $this->mHideName
;
1979 * Get the user's ID.
1980 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1982 public function getId() {
1983 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
1984 // Special case, we know the user is anonymous
1986 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1987 // Don't load if this was initialized from an ID
1994 * Set the user and reload all fields according to a given ID
1995 * @param int $v User ID to reload
1997 public function setId( $v ) {
1999 $this->clearInstanceCache( 'id' );
2003 * Get the user name, or the IP of an anonymous user
2004 * @return string User's name or IP address
2006 public function getName() {
2007 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2008 // Special case optimisation
2009 return $this->mName
;
2012 if ( $this->mName
=== false ) {
2014 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2016 return $this->mName
;
2021 * Set the user name.
2023 * This does not reload fields from the database according to the given
2024 * name. Rather, it is used to create a temporary "nonexistent user" for
2025 * later addition to the database. It can also be used to set the IP
2026 * address for an anonymous user to something other than the current
2029 * @note User::newFromName() has roughly the same function, when the named user
2031 * @param string $str New user name to set
2033 public function setName( $str ) {
2035 $this->mName
= $str;
2039 * Get the user's name escaped by underscores.
2040 * @return string Username escaped by underscores.
2042 public function getTitleKey() {
2043 return str_replace( ' ', '_', $this->getName() );
2047 * Check if the user has new messages.
2048 * @return bool True if the user has new messages
2050 public function getNewtalk() {
2053 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2054 if ( $this->mNewtalk
=== -1 ) {
2055 $this->mNewtalk
= false; # reset talk page status
2057 // Check memcached separately for anons, who have no
2058 // entire User object stored in there.
2059 if ( !$this->mId
) {
2060 global $wgDisableAnonTalk;
2061 if ( $wgDisableAnonTalk ) {
2062 // Anon newtalk disabled by configuration.
2063 $this->mNewtalk
= false;
2065 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2068 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2072 return (bool)$this->mNewtalk
;
2076 * Return the data needed to construct links for new talk page message
2077 * alerts. If there are new messages, this will return an associative array
2078 * with the following data:
2079 * wiki: The database name of the wiki
2080 * link: Root-relative link to the user's talk page
2081 * rev: The last talk page revision that the user has seen or null. This
2082 * is useful for building diff links.
2083 * If there are no new messages, it returns an empty array.
2084 * @note This function was designed to accomodate multiple talk pages, but
2085 * currently only returns a single link and revision.
2088 public function getNewMessageLinks() {
2090 if ( !Hooks
::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2092 } elseif ( !$this->getNewtalk() ) {
2095 $utp = $this->getTalkPage();
2096 $dbr = wfGetDB( DB_SLAVE
);
2097 // Get the "last viewed rev" timestamp from the oldest message notification
2098 $timestamp = $dbr->selectField( 'user_newtalk',
2099 'MIN(user_last_timestamp)',
2100 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2102 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2103 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2107 * Get the revision ID for the last talk page revision viewed by the talk
2109 * @return int|null Revision ID or null
2111 public function getNewMessageRevisionId() {
2112 $newMessageRevisionId = null;
2113 $newMessageLinks = $this->getNewMessageLinks();
2114 if ( $newMessageLinks ) {
2115 // Note: getNewMessageLinks() never returns more than a single link
2116 // and it is always for the same wiki, but we double-check here in
2117 // case that changes some time in the future.
2118 if ( count( $newMessageLinks ) === 1
2119 && $newMessageLinks[0]['wiki'] === wfWikiID()
2120 && $newMessageLinks[0]['rev']
2122 $newMessageRevision = $newMessageLinks[0]['rev'];
2123 $newMessageRevisionId = $newMessageRevision->getId();
2126 return $newMessageRevisionId;
2130 * Internal uncached check for new messages
2133 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2134 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2135 * @return bool True if the user has new messages
2137 protected function checkNewtalk( $field, $id ) {
2138 $dbr = wfGetDB( DB_SLAVE
);
2140 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__
);
2142 return $ok !== false;
2146 * Add or update the new messages flag
2147 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2148 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2149 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2150 * @return bool True if successful, false otherwise
2152 protected function updateNewtalk( $field, $id, $curRev = null ) {
2153 // Get timestamp of the talk page revision prior to the current one
2154 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2155 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2156 // Mark the user as having new messages since this revision
2157 $dbw = wfGetDB( DB_MASTER
);
2158 $dbw->insert( 'user_newtalk',
2159 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2162 if ( $dbw->affectedRows() ) {
2163 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2166 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2172 * Clear the new messages flag for the given user
2173 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2174 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2175 * @return bool True if successful, false otherwise
2177 protected function deleteNewtalk( $field, $id ) {
2178 $dbw = wfGetDB( DB_MASTER
);
2179 $dbw->delete( 'user_newtalk',
2180 array( $field => $id ),
2182 if ( $dbw->affectedRows() ) {
2183 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2186 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2192 * Update the 'You have new messages!' status.
2193 * @param bool $val Whether the user has new messages
2194 * @param Revision $curRev New, as yet unseen revision of the user talk
2195 * page. Ignored if null or !$val.
2197 public function setNewtalk( $val, $curRev = null ) {
2198 if ( wfReadOnly() ) {
2203 $this->mNewtalk
= $val;
2205 if ( $this->isAnon() ) {
2207 $id = $this->getName();
2210 $id = $this->getId();
2215 $changed = $this->updateNewtalk( $field, $id, $curRev );
2217 $changed = $this->deleteNewtalk( $field, $id );
2220 if ( $this->isAnon() ) {
2221 // Anons have a separate memcached space, since
2222 // user records aren't kept for them.
2223 $key = wfMemcKey( 'newtalk', 'ip', $id );
2224 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
2227 $this->invalidateCache();
2232 * Generate a current or new-future timestamp to be stored in the
2233 * user_touched field when we update things.
2234 * @return string Timestamp in TS_MW format
2236 private static function newTouchedTimestamp() {
2237 global $wgClockSkewFudge;
2238 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2242 * Clear user data from memcached.
2243 * Use after applying fun updates to the database; caller's
2244 * responsibility to update user_touched if appropriate.
2246 * Called implicitly from invalidateCache() and saveSettings().
2248 public function clearSharedCache() {
2253 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
2258 * Immediately touch the user data cache for this account.
2259 * Updates user_touched field, and removes account data from memcached
2260 * for reload on the next hit.
2262 public function invalidateCache() {
2263 if ( wfReadOnly() ) {
2268 $this->mTouched
= self
::newTouchedTimestamp();
2270 $dbw = wfGetDB( DB_MASTER
);
2271 $userid = $this->mId
;
2272 $touched = $this->mTouched
;
2273 $method = __METHOD__
;
2274 $dbw->onTransactionIdle( function () use ( $dbw, $userid, $touched, $method ) {
2275 // Prevent contention slams by checking user_touched first
2276 $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) );
2277 $needsPurge = $dbw->selectField( 'user', '1',
2278 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) );
2279 if ( $needsPurge ) {
2280 $dbw->update( 'user',
2281 array( 'user_touched' => $dbw->timestamp( $touched ) ),
2282 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ),
2287 $this->clearSharedCache();
2292 * Update the "touched" timestamp for the user
2294 * This is useful on various login/logout events when making sure that
2295 * a browser or proxy that has multiple tenants does not suffer cache
2296 * pollution where the new user sees the old users content. The value
2297 * of getTouched() is checked when determining 304 vs 200 responses.
2298 * Unlike invalidateCache(), this preserves the User object cache and
2299 * avoids database writes.
2303 public function touch() {
2309 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2310 $timestamp = self
::newTouchedTimestamp();
2311 $wgMemc->set( $key, $timestamp );
2312 $this->mQuickTouched
= $timestamp;
2317 * Validate the cache for this account.
2318 * @param string $timestamp A timestamp in TS_MW format
2321 public function validateCache( $timestamp ) {
2322 return ( $timestamp >= $this->getTouched() );
2326 * Get the user touched timestamp
2327 * @return string TS_MW Timestamp
2329 public function getTouched() {
2335 if ( $this->mQuickTouched
=== null ) {
2336 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2337 $timestamp = $wgMemc->get( $key );
2339 $this->mQuickTouched
= $timestamp;
2341 # Set the timestamp to get HTTP 304 cache hits
2346 return max( $this->mTouched
, $this->mQuickTouched
);
2349 return $this->mTouched
;
2356 public function getPassword() {
2357 $this->loadPasswords();
2359 return $this->mPassword
;
2366 public function getTemporaryPassword() {
2367 $this->loadPasswords();
2369 return $this->mNewpassword
;
2373 * Set the password and reset the random token.
2374 * Calls through to authentication plugin if necessary;
2375 * will have no effect if the auth plugin refuses to
2376 * pass the change through or if the legal password
2379 * As a special case, setting the password to null
2380 * wipes it, so the account cannot be logged in until
2381 * a new password is set, for instance via e-mail.
2383 * @param string $str New password to set
2384 * @throws PasswordError On failure
2388 public function setPassword( $str ) {
2391 $this->loadPasswords();
2393 if ( $str !== null ) {
2394 if ( !$wgAuth->allowPasswordChange() ) {
2395 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2398 $status = $this->checkPasswordValidity( $str );
2399 if ( !$status->isGood() ) {
2400 throw new PasswordError( $status->getMessage()->text() );
2404 if ( !$wgAuth->setPassword( $this, $str ) ) {
2405 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2408 $this->setInternalPassword( $str );
2414 * Set the password and reset the random token unconditionally.
2416 * @param string|null $str New password to set or null to set an invalid
2417 * password hash meaning that the user will not be able to log in
2418 * through the web interface.
2420 public function setInternalPassword( $str ) {
2423 $passwordFactory = self
::getPasswordFactory();
2424 $this->mPassword
= $passwordFactory->newFromPlaintext( $str );
2426 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
2427 $this->mNewpassTime
= null;
2431 * Get the user's current token.
2432 * @param bool $forceCreation Force the generation of a new token if the
2433 * user doesn't have one (default=true for backwards compatibility).
2434 * @return string Token
2436 public function getToken( $forceCreation = true ) {
2438 if ( !$this->mToken
&& $forceCreation ) {
2441 return $this->mToken
;
2445 * Set the random token (used for persistent authentication)
2446 * Called from loadDefaults() among other places.
2448 * @param string|bool $token If specified, set the token to this value
2450 public function setToken( $token = false ) {
2453 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2455 $this->mToken
= $token;
2460 * Set the password for a password reminder or new account email
2462 * @param string $str New password to set or null to set an invalid
2463 * password hash meaning that the user will not be able to use it
2464 * @param bool $throttle If true, reset the throttle timestamp to the present
2466 public function setNewpassword( $str, $throttle = true ) {
2467 $this->loadPasswords();
2469 $this->mNewpassword
= self
::getPasswordFactory()->newFromPlaintext( $str );
2470 if ( $str === null ) {
2471 $this->mNewpassTime
= null;
2472 } elseif ( $throttle ) {
2473 $this->mNewpassTime
= wfTimestampNow();
2478 * Has password reminder email been sent within the last
2479 * $wgPasswordReminderResendTime hours?
2482 public function isPasswordReminderThrottled() {
2483 global $wgPasswordReminderResendTime;
2485 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2488 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2489 return time() < $expiry;
2493 * Get the user's e-mail address
2494 * @return string User's email address
2496 public function getEmail() {
2498 Hooks
::run( 'UserGetEmail', array( $this, &$this->mEmail
) );
2499 return $this->mEmail
;
2503 * Get the timestamp of the user's e-mail authentication
2504 * @return string TS_MW timestamp
2506 public function getEmailAuthenticationTimestamp() {
2508 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2509 return $this->mEmailAuthenticated
;
2513 * Set the user's e-mail address
2514 * @param string $str New e-mail address
2516 public function setEmail( $str ) {
2518 if ( $str == $this->mEmail
) {
2521 $this->invalidateEmail();
2522 $this->mEmail
= $str;
2523 Hooks
::run( 'UserSetEmail', array( $this, &$this->mEmail
) );
2527 * Set the user's e-mail address and a confirmation mail if needed.
2530 * @param string $str New e-mail address
2533 public function setEmailWithConfirmation( $str ) {
2534 global $wgEnableEmail, $wgEmailAuthentication;
2536 if ( !$wgEnableEmail ) {
2537 return Status
::newFatal( 'emaildisabled' );
2540 $oldaddr = $this->getEmail();
2541 if ( $str === $oldaddr ) {
2542 return Status
::newGood( true );
2545 $this->setEmail( $str );
2547 if ( $str !== '' && $wgEmailAuthentication ) {
2548 // Send a confirmation request to the new address if needed
2549 $type = $oldaddr != '' ?
'changed' : 'set';
2550 $result = $this->sendConfirmationMail( $type );
2551 if ( $result->isGood() ) {
2552 // Say to the caller that a confirmation mail has been sent
2553 $result->value
= 'eauth';
2556 $result = Status
::newGood( true );
2563 * Get the user's real name
2564 * @return string User's real name
2566 public function getRealName() {
2567 if ( !$this->isItemLoaded( 'realname' ) ) {
2571 return $this->mRealName
;
2575 * Set the user's real name
2576 * @param string $str New real name
2578 public function setRealName( $str ) {
2580 $this->mRealName
= $str;
2584 * Get the user's current setting for a given option.
2586 * @param string $oname The option to check
2587 * @param string $defaultOverride A default value returned if the option does not exist
2588 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2589 * @return string User's current value for the option
2590 * @see getBoolOption()
2591 * @see getIntOption()
2593 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2594 global $wgHiddenPrefs;
2595 $this->loadOptions();
2597 # We want 'disabled' preferences to always behave as the default value for
2598 # users, even if they have set the option explicitly in their settings (ie they
2599 # set it, and then it was disabled removing their ability to change it). But
2600 # we don't want to erase the preferences in the database in case the preference
2601 # is re-enabled again. So don't touch $mOptions, just override the returned value
2602 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2603 return self
::getDefaultOption( $oname );
2606 if ( array_key_exists( $oname, $this->mOptions
) ) {
2607 return $this->mOptions
[$oname];
2609 return $defaultOverride;
2614 * Get all user's options
2616 * @param int $flags Bitwise combination of:
2617 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2618 * to the default value. (Since 1.25)
2621 public function getOptions( $flags = 0 ) {
2622 global $wgHiddenPrefs;
2623 $this->loadOptions();
2624 $options = $this->mOptions
;
2626 # We want 'disabled' preferences to always behave as the default value for
2627 # users, even if they have set the option explicitly in their settings (ie they
2628 # set it, and then it was disabled removing their ability to change it). But
2629 # we don't want to erase the preferences in the database in case the preference
2630 # is re-enabled again. So don't touch $mOptions, just override the returned value
2631 foreach ( $wgHiddenPrefs as $pref ) {
2632 $default = self
::getDefaultOption( $pref );
2633 if ( $default !== null ) {
2634 $options[$pref] = $default;
2638 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2639 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2646 * Get the user's current setting for a given option, as a boolean value.
2648 * @param string $oname The option to check
2649 * @return bool User's current value for the option
2652 public function getBoolOption( $oname ) {
2653 return (bool)$this->getOption( $oname );
2657 * Get the user's current setting for a given option, as an integer value.
2659 * @param string $oname The option to check
2660 * @param int $defaultOverride A default value returned if the option does not exist
2661 * @return int User's current value for the option
2664 public function getIntOption( $oname, $defaultOverride = 0 ) {
2665 $val = $this->getOption( $oname );
2667 $val = $defaultOverride;
2669 return intval( $val );
2673 * Set the given option for a user.
2675 * You need to call saveSettings() to actually write to the database.
2677 * @param string $oname The option to set
2678 * @param mixed $val New value to set
2680 public function setOption( $oname, $val ) {
2681 $this->loadOptions();
2683 // Explicitly NULL values should refer to defaults
2684 if ( is_null( $val ) ) {
2685 $val = self
::getDefaultOption( $oname );
2688 $this->mOptions
[$oname] = $val;
2692 * Get a token stored in the preferences (like the watchlist one),
2693 * resetting it if it's empty (and saving changes).
2695 * @param string $oname The option name to retrieve the token from
2696 * @return string|bool User's current value for the option, or false if this option is disabled.
2697 * @see resetTokenFromOption()
2700 public function getTokenFromOption( $oname ) {
2701 global $wgHiddenPrefs;
2702 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2706 $token = $this->getOption( $oname );
2708 $token = $this->resetTokenFromOption( $oname );
2709 $this->saveSettings();
2715 * Reset a token stored in the preferences (like the watchlist one).
2716 * *Does not* save user's preferences (similarly to setOption()).
2718 * @param string $oname The option name to reset the token in
2719 * @return string|bool New token value, or false if this option is disabled.
2720 * @see getTokenFromOption()
2723 public function resetTokenFromOption( $oname ) {
2724 global $wgHiddenPrefs;
2725 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2729 $token = MWCryptRand
::generateHex( 40 );
2730 $this->setOption( $oname, $token );
2735 * Return a list of the types of user options currently returned by
2736 * User::getOptionKinds().
2738 * Currently, the option kinds are:
2739 * - 'registered' - preferences which are registered in core MediaWiki or
2740 * by extensions using the UserGetDefaultOptions hook.
2741 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2742 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2743 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2744 * be used by user scripts.
2745 * - 'special' - "preferences" that are not accessible via User::getOptions
2746 * or User::setOptions.
2747 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2748 * These are usually legacy options, removed in newer versions.
2750 * The API (and possibly others) use this function to determine the possible
2751 * option types for validation purposes, so make sure to update this when a
2752 * new option kind is added.
2754 * @see User::getOptionKinds
2755 * @return array Option kinds
2757 public static function listOptionKinds() {
2760 'registered-multiselect',
2761 'registered-checkmatrix',
2769 * Return an associative array mapping preferences keys to the kind of a preference they're
2770 * used for. Different kinds are handled differently when setting or reading preferences.
2772 * See User::listOptionKinds for the list of valid option types that can be provided.
2774 * @see User::listOptionKinds
2775 * @param IContextSource $context
2776 * @param array $options Assoc. array with options keys to check as keys.
2777 * Defaults to $this->mOptions.
2778 * @return array The key => kind mapping data
2780 public function getOptionKinds( IContextSource
$context, $options = null ) {
2781 $this->loadOptions();
2782 if ( $options === null ) {
2783 $options = $this->mOptions
;
2786 $prefs = Preferences
::getPreferences( $this, $context );
2789 // Pull out the "special" options, so they don't get converted as
2790 // multiselect or checkmatrix.
2791 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2792 foreach ( $specialOptions as $name => $value ) {
2793 unset( $prefs[$name] );
2796 // Multiselect and checkmatrix options are stored in the database with
2797 // one key per option, each having a boolean value. Extract those keys.
2798 $multiselectOptions = array();
2799 foreach ( $prefs as $name => $info ) {
2800 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2801 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2802 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2803 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2805 foreach ( $opts as $value ) {
2806 $multiselectOptions["$prefix$value"] = true;
2809 unset( $prefs[$name] );
2812 $checkmatrixOptions = array();
2813 foreach ( $prefs as $name => $info ) {
2814 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2815 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2816 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2817 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2818 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2820 foreach ( $columns as $column ) {
2821 foreach ( $rows as $row ) {
2822 $checkmatrixOptions["$prefix$column-$row"] = true;
2826 unset( $prefs[$name] );
2830 // $value is ignored
2831 foreach ( $options as $key => $value ) {
2832 if ( isset( $prefs[$key] ) ) {
2833 $mapping[$key] = 'registered';
2834 } elseif ( isset( $multiselectOptions[$key] ) ) {
2835 $mapping[$key] = 'registered-multiselect';
2836 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2837 $mapping[$key] = 'registered-checkmatrix';
2838 } elseif ( isset( $specialOptions[$key] ) ) {
2839 $mapping[$key] = 'special';
2840 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2841 $mapping[$key] = 'userjs';
2843 $mapping[$key] = 'unused';
2851 * Reset certain (or all) options to the site defaults
2853 * The optional parameter determines which kinds of preferences will be reset.
2854 * Supported values are everything that can be reported by getOptionKinds()
2855 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2857 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2858 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2859 * for backwards-compatibility.
2860 * @param IContextSource|null $context Context source used when $resetKinds
2861 * does not contain 'all', passed to getOptionKinds().
2862 * Defaults to RequestContext::getMain() when null.
2864 public function resetOptions(
2865 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2866 IContextSource
$context = null
2869 $defaultOptions = self
::getDefaultOptions();
2871 if ( !is_array( $resetKinds ) ) {
2872 $resetKinds = array( $resetKinds );
2875 if ( in_array( 'all', $resetKinds ) ) {
2876 $newOptions = $defaultOptions;
2878 if ( $context === null ) {
2879 $context = RequestContext
::getMain();
2882 $optionKinds = $this->getOptionKinds( $context );
2883 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2884 $newOptions = array();
2886 // Use default values for the options that should be deleted, and
2887 // copy old values for the ones that shouldn't.
2888 foreach ( $this->mOptions
as $key => $value ) {
2889 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2890 if ( array_key_exists( $key, $defaultOptions ) ) {
2891 $newOptions[$key] = $defaultOptions[$key];
2894 $newOptions[$key] = $value;
2899 Hooks
::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2901 $this->mOptions
= $newOptions;
2902 $this->mOptionsLoaded
= true;
2906 * Get the user's preferred date format.
2907 * @return string User's preferred date format
2909 public function getDatePreference() {
2910 // Important migration for old data rows
2911 if ( is_null( $this->mDatePreference
) ) {
2913 $value = $this->getOption( 'date' );
2914 $map = $wgLang->getDatePreferenceMigrationMap();
2915 if ( isset( $map[$value] ) ) {
2916 $value = $map[$value];
2918 $this->mDatePreference
= $value;
2920 return $this->mDatePreference
;
2924 * Determine based on the wiki configuration and the user's options,
2925 * whether this user must be over HTTPS no matter what.
2929 public function requiresHTTPS() {
2930 global $wgSecureLogin;
2931 if ( !$wgSecureLogin ) {
2934 $https = $this->getBoolOption( 'prefershttps' );
2935 Hooks
::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2937 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2944 * Get the user preferred stub threshold
2948 public function getStubThreshold() {
2949 global $wgMaxArticleSize; # Maximum article size, in Kb
2950 $threshold = $this->getIntOption( 'stubthreshold' );
2951 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2952 // If they have set an impossible value, disable the preference
2953 // so we can use the parser cache again.
2960 * Get the permissions this user has.
2961 * @return array Array of String permission names
2963 public function getRights() {
2964 if ( is_null( $this->mRights
) ) {
2965 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2966 Hooks
::run( 'UserGetRights', array( $this, &$this->mRights
) );
2967 // Force reindexation of rights when a hook has unset one of them
2968 $this->mRights
= array_values( array_unique( $this->mRights
) );
2970 return $this->mRights
;
2974 * Get the list of explicit group memberships this user has.
2975 * The implicit * and user groups are not included.
2976 * @return array Array of String internal group names
2978 public function getGroups() {
2980 $this->loadGroups();
2981 return $this->mGroups
;
2985 * Get the list of implicit group memberships this user has.
2986 * This includes all explicit groups, plus 'user' if logged in,
2987 * '*' for all accounts, and autopromoted groups
2988 * @param bool $recache Whether to avoid the cache
2989 * @return array Array of String internal group names
2991 public function getEffectiveGroups( $recache = false ) {
2992 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2993 $this->mEffectiveGroups
= array_unique( array_merge(
2994 $this->getGroups(), // explicit groups
2995 $this->getAutomaticGroups( $recache ) // implicit groups
2997 // Hook for additional groups
2998 Hooks
::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2999 // Force reindexation of groups when a hook has unset one of them
3000 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3002 return $this->mEffectiveGroups
;
3006 * Get the list of implicit group memberships this user has.
3007 * This includes 'user' if logged in, '*' for all accounts,
3008 * and autopromoted groups
3009 * @param bool $recache Whether to avoid the cache
3010 * @return array Array of String internal group names
3012 public function getAutomaticGroups( $recache = false ) {
3013 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3014 $this->mImplicitGroups
= array( '*' );
3015 if ( $this->getId() ) {
3016 $this->mImplicitGroups
[] = 'user';
3018 $this->mImplicitGroups
= array_unique( array_merge(
3019 $this->mImplicitGroups
,
3020 Autopromote
::getAutopromoteGroups( $this )
3024 // Assure data consistency with rights/groups,
3025 // as getEffectiveGroups() depends on this function
3026 $this->mEffectiveGroups
= null;
3029 return $this->mImplicitGroups
;
3033 * Returns the groups the user has belonged to.
3035 * The user may still belong to the returned groups. Compare with getGroups().
3037 * The function will not return groups the user had belonged to before MW 1.17
3039 * @return array Names of the groups the user has belonged to.
3041 public function getFormerGroups() {
3044 if ( is_null( $this->mFormerGroups
) ) {
3045 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3046 ?
wfGetDB( DB_MASTER
)
3047 : wfGetDB( DB_SLAVE
);
3048 $res = $dbr->select( 'user_former_groups',
3049 array( 'ufg_group' ),
3050 array( 'ufg_user' => $this->mId
),
3052 $this->mFormerGroups
= array();
3053 foreach ( $res as $row ) {
3054 $this->mFormerGroups
[] = $row->ufg_group
;
3058 return $this->mFormerGroups
;
3062 * Get the user's edit count.
3063 * @return int|null Null for anonymous users
3065 public function getEditCount() {
3066 if ( !$this->getId() ) {
3070 if ( $this->mEditCount
=== null ) {
3071 /* Populate the count, if it has not been populated yet */
3072 $dbr = wfGetDB( DB_SLAVE
);
3073 // check if the user_editcount field has been initialized
3074 $count = $dbr->selectField(
3075 'user', 'user_editcount',
3076 array( 'user_id' => $this->mId
),
3080 if ( $count === null ) {
3081 // it has not been initialized. do so.
3082 $count = $this->initEditCount();
3084 $this->mEditCount
= $count;
3086 return (int)$this->mEditCount
;
3090 * Add the user to the given group.
3091 * This takes immediate effect.
3092 * @param string $group Name of the group to add
3095 public function addGroup( $group ) {
3098 if ( !Hooks
::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3102 $dbw = wfGetDB( DB_MASTER
);
3103 if ( $this->getId() ) {
3104 $dbw->insert( 'user_groups',
3106 'ug_user' => $this->getID(),
3107 'ug_group' => $group,
3110 array( 'IGNORE' ) );
3113 $this->loadGroups();
3114 $this->mGroups
[] = $group;
3115 // In case loadGroups was not called before, we now have the right twice.
3116 // Get rid of the duplicate.
3117 $this->mGroups
= array_unique( $this->mGroups
);
3119 // Refresh the groups caches, and clear the rights cache so it will be
3120 // refreshed on the next call to $this->getRights().
3121 $this->getEffectiveGroups( true );
3122 $this->mRights
= null;
3124 $this->invalidateCache();
3130 * Remove the user from the given group.
3131 * This takes immediate effect.
3132 * @param string $group Name of the group to remove
3135 public function removeGroup( $group ) {
3137 if ( !Hooks
::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3141 $dbw = wfGetDB( DB_MASTER
);
3142 $dbw->delete( 'user_groups',
3144 'ug_user' => $this->getID(),
3145 'ug_group' => $group,
3148 // Remember that the user was in this group
3149 $dbw->insert( 'user_former_groups',
3151 'ufg_user' => $this->getID(),
3152 'ufg_group' => $group,
3158 $this->loadGroups();
3159 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3161 // Refresh the groups caches, and clear the rights cache so it will be
3162 // refreshed on the next call to $this->getRights().
3163 $this->getEffectiveGroups( true );
3164 $this->mRights
= null;
3166 $this->invalidateCache();
3172 * Get whether the user is logged in
3175 public function isLoggedIn() {
3176 return $this->getID() != 0;
3180 * Get whether the user is anonymous
3183 public function isAnon() {
3184 return !$this->isLoggedIn();
3188 * Check if user is allowed to access a feature / make an action
3190 * @param string $permissions,... Permissions to test
3191 * @return bool True if user is allowed to perform *any* of the given actions
3193 public function isAllowedAny( /*...*/ ) {
3194 $permissions = func_get_args();
3195 foreach ( $permissions as $permission ) {
3196 if ( $this->isAllowed( $permission ) ) {
3205 * @param string $permissions,... Permissions to test
3206 * @return bool True if the user is allowed to perform *all* of the given actions
3208 public function isAllowedAll( /*...*/ ) {
3209 $permissions = func_get_args();
3210 foreach ( $permissions as $permission ) {
3211 if ( !$this->isAllowed( $permission ) ) {
3219 * Internal mechanics of testing a permission
3220 * @param string $action
3223 public function isAllowed( $action = '' ) {
3224 if ( $action === '' ) {
3225 return true; // In the spirit of DWIM
3227 // Patrolling may not be enabled
3228 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
3229 global $wgUseRCPatrol, $wgUseNPPatrol;
3230 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3234 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3235 // by misconfiguration: 0 == 'foo'
3236 return in_array( $action, $this->getRights(), true );
3240 * Check whether to enable recent changes patrol features for this user
3241 * @return bool True or false
3243 public function useRCPatrol() {
3244 global $wgUseRCPatrol;
3245 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3249 * Check whether to enable new pages patrol features for this user
3250 * @return bool True or false
3252 public function useNPPatrol() {
3253 global $wgUseRCPatrol, $wgUseNPPatrol;
3255 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3256 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3261 * Get the WebRequest object to use with this object
3263 * @return WebRequest
3265 public function getRequest() {
3266 if ( $this->mRequest
) {
3267 return $this->mRequest
;
3275 * Get the current skin, loading it if required
3276 * @return Skin The current skin
3277 * @todo FIXME: Need to check the old failback system [AV]
3278 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3280 public function getSkin() {
3281 wfDeprecated( __METHOD__
, '1.18' );
3282 return RequestContext
::getMain()->getSkin();
3286 * Get a WatchedItem for this user and $title.
3288 * @since 1.22 $checkRights parameter added
3289 * @param Title $title
3290 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3291 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3292 * @return WatchedItem
3294 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3295 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3297 if ( isset( $this->mWatchedItems
[$key] ) ) {
3298 return $this->mWatchedItems
[$key];
3301 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3302 $this->mWatchedItems
= array();
3305 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3306 return $this->mWatchedItems
[$key];
3310 * Check the watched status of an article.
3311 * @since 1.22 $checkRights parameter added
3312 * @param Title $title Title of the article to look at
3313 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3314 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3317 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3318 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3323 * @since 1.22 $checkRights parameter added
3324 * @param Title $title Title of the article to look at
3325 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3326 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3328 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3329 $this->getWatchedItem( $title, $checkRights )->addWatch();
3330 $this->invalidateCache();
3334 * Stop watching an article.
3335 * @since 1.22 $checkRights parameter added
3336 * @param Title $title Title of the article to look at
3337 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3338 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3340 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3341 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3342 $this->invalidateCache();
3346 * Clear the user's notification timestamp for the given title.
3347 * If e-notif e-mails are on, they will receive notification mails on
3348 * the next change of the page if it's watched etc.
3349 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3350 * @param Title $title Title of the article to look at
3351 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3353 public function clearNotification( &$title, $oldid = 0 ) {
3354 global $wgUseEnotif, $wgShowUpdatedMarker;
3356 // Do nothing if the database is locked to writes
3357 if ( wfReadOnly() ) {
3361 // Do nothing if not allowed to edit the watchlist
3362 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3366 // If we're working on user's talk page, we should update the talk page message indicator
3367 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3368 if ( !Hooks
::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3372 $nextid = $oldid ?
$title->getNextRevisionID( $oldid ) : null;
3374 if ( !$oldid ||
!$nextid ) {
3375 // If we're looking at the latest revision, we should definitely clear it
3376 $this->setNewtalk( false );
3378 // Otherwise we should update its revision, if it's present
3379 if ( $this->getNewtalk() ) {
3380 // Naturally the other one won't clear by itself
3381 $this->setNewtalk( false );
3382 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3387 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3391 if ( $this->isAnon() ) {
3392 // Nothing else to do...
3396 // Only update the timestamp if the page is being watched.
3397 // The query to find out if it is watched is cached both in memcached and per-invocation,
3398 // and when it does have to be executed, it can be on a slave
3399 // If this is the user's newtalk page, we always update the timestamp
3401 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3405 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force, $oldid );
3409 * Resets all of the given user's page-change notification timestamps.
3410 * If e-notif e-mails are on, they will receive notification mails on
3411 * the next change of any watched page.
3412 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3414 public function clearAllNotifications() {
3415 if ( wfReadOnly() ) {
3419 // Do nothing if not allowed to edit the watchlist
3420 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3424 global $wgUseEnotif, $wgShowUpdatedMarker;
3425 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3426 $this->setNewtalk( false );
3429 $id = $this->getId();
3431 $dbw = wfGetDB( DB_MASTER
);
3432 $dbw->update( 'watchlist',
3433 array( /* SET */ 'wl_notificationtimestamp' => null ),
3434 array( /* WHERE */ 'wl_user' => $id ),
3437 // We also need to clear here the "you have new message" notification for the own user_talk page;
3438 // it's cleared one page view later in WikiPage::doViewUpdates().
3443 * Set a cookie on the user's client. Wrapper for
3444 * WebResponse::setCookie
3445 * @param string $name Name of the cookie to set
3446 * @param string $value Value to set
3447 * @param int $exp Expiration time, as a UNIX time value;
3448 * if 0 or not specified, use the default $wgCookieExpiration
3449 * @param bool $secure
3450 * true: Force setting the secure attribute when setting the cookie
3451 * false: Force NOT setting the secure attribute when setting the cookie
3452 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3453 * @param array $params Array of options sent passed to WebResponse::setcookie()
3454 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3457 protected function setCookie(
3458 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3460 if ( $request === null ) {
3461 $request = $this->getRequest();
3463 $params['secure'] = $secure;
3464 $request->response()->setcookie( $name, $value, $exp, $params );
3468 * Clear a cookie on the user's client
3469 * @param string $name Name of the cookie to clear
3470 * @param bool $secure
3471 * true: Force setting the secure attribute when setting the cookie
3472 * false: Force NOT setting the secure attribute when setting the cookie
3473 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3474 * @param array $params Array of options sent passed to WebResponse::setcookie()
3476 protected function clearCookie( $name, $secure = null, $params = array() ) {
3477 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3481 * Set the default cookies for this session on the user's client.
3483 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3485 * @param bool $secure Whether to force secure/insecure cookies or use default
3486 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3488 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3489 if ( $request === null ) {
3490 $request = $this->getRequest();
3494 if ( 0 == $this->mId
) {
3497 if ( !$this->mToken
) {
3498 // When token is empty or NULL generate a new one and then save it to the database
3499 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3500 // Simply by setting every cell in the user_token column to NULL and letting them be
3501 // regenerated as users log back into the wiki.
3503 $this->saveSettings();
3506 'wsUserID' => $this->mId
,
3507 'wsToken' => $this->mToken
,
3508 'wsUserName' => $this->getName()
3511 'UserID' => $this->mId
,
3512 'UserName' => $this->getName(),
3514 if ( $rememberMe ) {
3515 $cookies['Token'] = $this->mToken
;
3517 $cookies['Token'] = false;
3520 Hooks
::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3522 foreach ( $session as $name => $value ) {
3523 $request->setSessionData( $name, $value );
3525 foreach ( $cookies as $name => $value ) {
3526 if ( $value === false ) {
3527 $this->clearCookie( $name );
3529 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3534 * If wpStickHTTPS was selected, also set an insecure cookie that
3535 * will cause the site to redirect the user to HTTPS, if they access
3536 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3537 * as the one set by centralauth (bug 53538). Also set it to session, or
3538 * standard time setting, based on if rememberme was set.
3540 if ( $request->getCheck( 'wpStickHTTPS' ) ||
$this->requiresHTTPS() ) {
3544 $rememberMe ?
0 : null,
3546 array( 'prefix' => '' ) // no prefix
3552 * Log this user out.
3554 public function logout() {
3555 if ( Hooks
::run( 'UserLogout', array( &$this ) ) ) {
3561 * Clear the user's cookies and session, and reset the instance cache.
3564 public function doLogout() {
3565 $this->clearInstanceCache( 'defaults' );
3567 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3569 $this->clearCookie( 'UserID' );
3570 $this->clearCookie( 'Token' );
3571 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3573 // Remember when user logged out, to prevent seeing cached pages
3574 $this->setCookie( 'LoggedOut', time(), time() +
86400 );
3578 * Save this user's settings into the database.
3579 * @todo Only rarely do all these fields need to be set!
3581 public function saveSettings() {
3585 $this->loadPasswords();
3586 if ( wfReadOnly() ) {
3587 return; // @TODO: caller should deal with this instead!
3589 if ( 0 == $this->mId
) {
3593 // This method is for updating existing users, so the user should
3594 // have been loaded from the master to begin with to avoid problems.
3595 if ( !( $this->queryFlagsUsed
& self
::READ_LATEST
) ) {
3596 wfWarn( "Attempting to save slave-loaded User object data." );
3599 $this->mTouched
= self
::newTouchedTimestamp();
3600 if ( !$wgAuth->allowSetLocalPassword() ) {
3601 $this->mPassword
= self
::getPasswordFactory()->newFromCiphertext( null );
3604 $dbw = wfGetDB( DB_MASTER
);
3605 $dbw->update( 'user',
3607 'user_name' => $this->mName
,
3608 'user_password' => $this->mPassword
->toString(),
3609 'user_newpassword' => $this->mNewpassword
->toString(),
3610 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3611 'user_real_name' => $this->mRealName
,
3612 'user_email' => $this->mEmail
,
3613 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3614 'user_touched' => $dbw->timestamp( $this->mTouched
),
3615 'user_token' => strval( $this->mToken
),
3616 'user_email_token' => $this->mEmailToken
,
3617 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3618 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires
),
3619 ), array( /* WHERE */
3620 'user_id' => $this->mId
3624 $this->saveOptions();
3626 Hooks
::run( 'UserSaveSettings', array( $this ) );
3627 $this->clearSharedCache();
3628 $this->getUserPage()->invalidateCache();
3632 * If only this user's username is known, and it exists, return the user ID.
3635 public function idForName() {
3636 $s = trim( $this->getName() );
3641 $dbr = wfGetDB( DB_SLAVE
);
3642 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3643 if ( $id === false ) {
3650 * Add a user to the database, return the user object
3652 * @param string $name Username to add
3653 * @param array $params Array of Strings Non-default parameters to save to
3654 * the database as user_* fields:
3655 * - password: The user's password hash. Password logins will be disabled
3656 * if this is omitted.
3657 * - newpassword: Hash for a temporary password that has been mailed to
3659 * - email: The user's email address.
3660 * - email_authenticated: The email authentication timestamp.
3661 * - real_name: The user's real name.
3662 * - options: An associative array of non-default options.
3663 * - token: Random authentication token. Do not set.
3664 * - registration: Registration timestamp. Do not set.
3666 * @return User|null User object, or null if the username already exists.
3668 public static function createNew( $name, $params = array() ) {
3671 $user->loadPasswords();
3672 $user->setToken(); // init token
3673 if ( isset( $params['options'] ) ) {
3674 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3675 unset( $params['options'] );
3677 $dbw = wfGetDB( DB_MASTER
);
3678 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3681 'user_id' => $seqVal,
3682 'user_name' => $name,
3683 'user_password' => $user->mPassword
->toString(),
3684 'user_newpassword' => $user->mNewpassword
->toString(),
3685 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3686 'user_email' => $user->mEmail
,
3687 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3688 'user_real_name' => $user->mRealName
,
3689 'user_token' => strval( $user->mToken
),
3690 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3691 'user_editcount' => 0,
3692 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3694 foreach ( $params as $name => $value ) {
3695 $fields["user_$name"] = $value;
3697 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3698 if ( $dbw->affectedRows() ) {
3699 $newUser = User
::newFromId( $dbw->insertId() );
3707 * Add this existing user object to the database. If the user already
3708 * exists, a fatal status object is returned, and the user object is
3709 * initialised with the data from the database.
3711 * Previously, this function generated a DB error due to a key conflict
3712 * if the user already existed. Many extension callers use this function
3713 * in code along the lines of:
3715 * $user = User::newFromName( $name );
3716 * if ( !$user->isLoggedIn() ) {
3717 * $user->addToDatabase();
3719 * // do something with $user...
3721 * However, this was vulnerable to a race condition (bug 16020). By
3722 * initialising the user object if the user exists, we aim to support this
3723 * calling sequence as far as possible.
3725 * Note that if the user exists, this function will acquire a write lock,
3726 * so it is still advisable to make the call conditional on isLoggedIn(),
3727 * and to commit the transaction after calling.
3729 * @throws MWException
3732 public function addToDatabase() {
3734 $this->loadPasswords();
3735 if ( !$this->mToken
) {
3736 $this->setToken(); // init token
3739 $this->mTouched
= self
::newTouchedTimestamp();
3741 $dbw = wfGetDB( DB_MASTER
);
3742 $inWrite = $dbw->writesOrCallbacksPending();
3743 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3744 $dbw->insert( 'user',
3746 'user_id' => $seqVal,
3747 'user_name' => $this->mName
,
3748 'user_password' => $this->mPassword
->toString(),
3749 'user_newpassword' => $this->mNewpassword
->toString(),
3750 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3751 'user_email' => $this->mEmail
,
3752 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3753 'user_real_name' => $this->mRealName
,
3754 'user_token' => strval( $this->mToken
),
3755 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3756 'user_editcount' => 0,
3757 'user_touched' => $dbw->timestamp( $this->mTouched
),
3761 if ( !$dbw->affectedRows() ) {
3762 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3763 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3765 // Can't commit due to pending writes that may need atomicity.
3766 // This may cause some lock contention unlike the case below.
3767 $options = array( 'LOCK IN SHARE MODE' );
3768 $flags = self
::READ_LOCKING
;
3770 // Often, this case happens early in views before any writes when
3771 // using CentralAuth. It's should be OK to commit and break the snapshot.
3772 $dbw->commit( __METHOD__
, 'flush' );
3774 $flags = self
::READ_LATEST
;
3776 $this->mId
= $dbw->selectField( 'user', 'user_id',
3777 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3780 if ( $this->loadFromDatabase( $flags ) ) {
3785 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3786 "to insert user '{$this->mName}' row, but it was not present in select!" );
3788 return Status
::newFatal( 'userexists' );
3790 $this->mId
= $dbw->insertId();
3792 // Clear instance cache other than user table data, which is already accurate
3793 $this->clearInstanceCache();
3795 $this->saveOptions();
3796 return Status
::newGood();
3800 * If this user is logged-in and blocked,
3801 * block any IP address they've successfully logged in from.
3802 * @return bool A block was spread
3804 public function spreadAnyEditBlock() {
3805 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3806 return $this->spreadBlock();
3812 * If this (non-anonymous) user is blocked,
3813 * block the IP address they've successfully logged in from.
3814 * @return bool A block was spread
3816 protected function spreadBlock() {
3817 wfDebug( __METHOD__
. "()\n" );
3819 if ( $this->mId
== 0 ) {
3823 $userblock = Block
::newFromTarget( $this->getName() );
3824 if ( !$userblock ) {
3828 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3832 * Get whether the user is explicitly blocked from account creation.
3833 * @return bool|Block
3835 public function isBlockedFromCreateAccount() {
3836 $this->getBlockedStatus();
3837 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3838 return $this->mBlock
;
3841 # bug 13611: if the IP address the user is trying to create an account from is
3842 # blocked with createaccount disabled, prevent new account creation there even
3843 # when the user is logged in
3844 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3845 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3847 return $this->mBlockedFromCreateAccount
instanceof Block
3848 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3849 ?
$this->mBlockedFromCreateAccount
3854 * Get whether the user is blocked from using Special:Emailuser.
3857 public function isBlockedFromEmailuser() {
3858 $this->getBlockedStatus();
3859 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3863 * Get whether the user is allowed to create an account.
3866 public function isAllowedToCreateAccount() {
3867 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3871 * Get this user's personal page title.
3873 * @return Title User's personal page title
3875 public function getUserPage() {
3876 return Title
::makeTitle( NS_USER
, $this->getName() );
3880 * Get this user's talk page title.
3882 * @return Title User's talk page title
3884 public function getTalkPage() {
3885 $title = $this->getUserPage();
3886 return $title->getTalkPage();
3890 * Determine whether the user is a newbie. Newbies are either
3891 * anonymous IPs, or the most recently created accounts.
3894 public function isNewbie() {
3895 return !$this->isAllowed( 'autoconfirmed' );
3899 * Check to see if the given clear-text password is one of the accepted passwords
3900 * @param string $password User password
3901 * @return bool True if the given password is correct, otherwise False
3903 public function checkPassword( $password ) {
3904 global $wgAuth, $wgLegacyEncoding;
3906 $this->loadPasswords();
3908 // Some passwords will give a fatal Status, which means there is
3909 // some sort of technical or security reason for this password to
3910 // be completely invalid and should never be checked (e.g., T64685)
3911 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
3915 // Certain authentication plugins do NOT want to save
3916 // domain passwords in a mysql database, so we should
3917 // check this (in case $wgAuth->strict() is false).
3918 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3920 } elseif ( $wgAuth->strict() ) {
3921 // Auth plugin doesn't allow local authentication
3923 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3924 // Auth plugin doesn't allow local authentication for this user name
3928 if ( !$this->mPassword
->equals( $password ) ) {
3929 if ( $wgLegacyEncoding ) {
3930 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3931 // Check for this with iconv
3932 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3933 if ( $cp1252Password === $password ||
!$this->mPassword
->equals( $cp1252Password ) ) {
3941 $passwordFactory = self
::getPasswordFactory();
3942 if ( $passwordFactory->needsUpdate( $this->mPassword
) ) {
3943 $this->mPassword
= $passwordFactory->newFromPlaintext( $password );
3944 $this->saveSettings();
3951 * Check if the given clear-text password matches the temporary password
3952 * sent by e-mail for password reset operations.
3954 * @param string $plaintext
3956 * @return bool True if matches, false otherwise
3958 public function checkTemporaryPassword( $plaintext ) {
3959 global $wgNewPasswordExpiry;
3962 $this->loadPasswords();
3963 if ( $this->mNewpassword
->equals( $plaintext ) ) {
3964 if ( is_null( $this->mNewpassTime
) ) {
3967 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3968 return ( time() < $expiry );
3975 * Alias for getEditToken.
3976 * @deprecated since 1.19, use getEditToken instead.
3978 * @param string|array $salt Array of Strings Optional function-specific data for hashing
3979 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
3980 * @return string The new edit token
3982 public function editToken( $salt = '', $request = null ) {
3983 wfDeprecated( __METHOD__
, '1.19' );
3984 return $this->getEditToken( $salt, $request );
3988 * Internal implementation for self::getEditToken() and
3989 * self::matchEditToken().
3991 * @param string|array $salt
3992 * @param WebRequest $request
3993 * @param string|int $timestamp
3996 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
3997 if ( $this->isAnon() ) {
3998 return self
::EDIT_TOKEN_SUFFIX
;
4000 $token = $request->getSessionData( 'wsEditToken' );
4001 if ( $token === null ) {
4002 $token = MWCryptRand
::generateHex( 32 );
4003 $request->setSessionData( 'wsEditToken', $token );
4005 if ( is_array( $salt ) ) {
4006 $salt = implode( '|', $salt );
4008 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
4009 dechex( $timestamp ) .
4010 self
::EDIT_TOKEN_SUFFIX
;
4015 * Initialize (if necessary) and return a session token value
4016 * which can be used in edit forms to show that the user's
4017 * login credentials aren't being hijacked with a foreign form
4022 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4023 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4024 * @return string The new edit token
4026 public function getEditToken( $salt = '', $request = null ) {
4027 return $this->getEditTokenAtTimestamp(
4028 $salt, $request ?
: $this->getRequest(), wfTimestamp()
4033 * Generate a looking random token for various uses.
4035 * @return string The new random token
4036 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4037 * wfRandomString for pseudo-randomness.
4039 public static function generateToken() {
4040 return MWCryptRand
::generateHex( 32 );
4044 * Get the embedded timestamp from a token.
4045 * @param string $val Input token
4048 public static function getEditTokenTimestamp( $val ) {
4049 $suffixLen = strlen( self
::EDIT_TOKEN_SUFFIX
);
4050 if ( strlen( $val ) <= 32 +
$suffixLen ) {
4054 return hexdec( substr( $val, 32, -$suffixLen ) );
4058 * Check given value against the token value stored in the session.
4059 * A match should confirm that the form was submitted from the
4060 * user's own login session, not a form submission from a third-party
4063 * @param string $val Input value to compare
4064 * @param string $salt Optional function-specific data for hashing
4065 * @param WebRequest|null $request Object to use or null to use $wgRequest
4066 * @param int $maxage Fail tokens older than this, in seconds
4067 * @return bool Whether the token matches
4069 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4070 if ( $this->isAnon() ) {
4071 return $val === self
::EDIT_TOKEN_SUFFIX
;
4074 $timestamp = self
::getEditTokenTimestamp( $val );
4075 if ( $timestamp === null ) {
4078 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4083 $sessionToken = $this->getEditTokenAtTimestamp(
4084 $salt, $request ?
: $this->getRequest(), $timestamp
4087 if ( $val != $sessionToken ) {
4088 wfDebug( "User::matchEditToken: broken session data\n" );
4091 return hash_equals( $sessionToken, $val );
4095 * Check given value against the token value stored in the session,
4096 * ignoring the suffix.
4098 * @param string $val Input value to compare
4099 * @param string $salt Optional function-specific data for hashing
4100 * @param WebRequest|null $request Object to use or null to use $wgRequest
4101 * @param int $maxage Fail tokens older than this, in seconds
4102 * @return bool Whether the token matches
4104 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4105 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self
::EDIT_TOKEN_SUFFIX
;
4106 return $this->matchEditToken( $val, $salt, $request, $maxage );
4110 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4111 * mail to the user's given address.
4113 * @param string $type Message to send, either "created", "changed" or "set"
4116 public function sendConfirmationMail( $type = 'created' ) {
4118 $expiration = null; // gets passed-by-ref and defined in next line.
4119 $token = $this->confirmationToken( $expiration );
4120 $url = $this->confirmationTokenUrl( $token );
4121 $invalidateURL = $this->invalidationTokenUrl( $token );
4122 $this->saveSettings();
4124 if ( $type == 'created' ||
$type === false ) {
4125 $message = 'confirmemail_body';
4126 } elseif ( $type === true ) {
4127 $message = 'confirmemail_body_changed';
4129 // Messages: confirmemail_body_changed, confirmemail_body_set
4130 $message = 'confirmemail_body_' . $type;
4133 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4134 wfMessage( $message,
4135 $this->getRequest()->getIP(),
4138 $wgLang->timeanddate( $expiration, false ),
4140 $wgLang->date( $expiration, false ),
4141 $wgLang->time( $expiration, false ) )->text() );
4145 * Send an e-mail to this user's account. Does not check for
4146 * confirmed status or validity.
4148 * @param string $subject Message subject
4149 * @param string $body Message body
4150 * @param string $from Optional From address; if unspecified, default
4151 * $wgPasswordSender will be used.
4152 * @param string $replyto Reply-To address
4155 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4156 if ( is_null( $from ) ) {
4157 global $wgPasswordSender;
4158 $sender = new MailAddress( $wgPasswordSender,
4159 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4161 $sender = MailAddress
::newFromUser( $from );
4164 $to = MailAddress
::newFromUser( $this );
4165 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
4169 * Generate, store, and return a new e-mail confirmation code.
4170 * A hash (unsalted, since it's used as a key) is stored.
4172 * @note Call saveSettings() after calling this function to commit
4173 * this change to the database.
4175 * @param string &$expiration Accepts the expiration time
4176 * @return string New token
4178 protected function confirmationToken( &$expiration ) {
4179 global $wgUserEmailConfirmationTokenExpiry;
4181 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4182 $expiration = wfTimestamp( TS_MW
, $expires );
4184 $token = MWCryptRand
::generateHex( 32 );
4185 $hash = md5( $token );
4186 $this->mEmailToken
= $hash;
4187 $this->mEmailTokenExpires
= $expiration;
4192 * Return a URL the user can use to confirm their email address.
4193 * @param string $token Accepts the email confirmation token
4194 * @return string New token URL
4196 protected function confirmationTokenUrl( $token ) {
4197 return $this->getTokenUrl( 'ConfirmEmail', $token );
4201 * Return a URL the user can use to invalidate their email address.
4202 * @param string $token Accepts the email confirmation token
4203 * @return string New token URL
4205 protected function invalidationTokenUrl( $token ) {
4206 return $this->getTokenUrl( 'InvalidateEmail', $token );
4210 * Internal function to format the e-mail validation/invalidation URLs.
4211 * This uses a quickie hack to use the
4212 * hardcoded English names of the Special: pages, for ASCII safety.
4214 * @note Since these URLs get dropped directly into emails, using the
4215 * short English names avoids insanely long URL-encoded links, which
4216 * also sometimes can get corrupted in some browsers/mailers
4217 * (bug 6957 with Gmail and Internet Explorer).
4219 * @param string $page Special page
4220 * @param string $token Token
4221 * @return string Formatted URL
4223 protected function getTokenUrl( $page, $token ) {
4224 // Hack to bypass localization of 'Special:'
4225 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4226 return $title->getCanonicalURL();
4230 * Mark the e-mail address confirmed.
4232 * @note Call saveSettings() after calling this function to commit the change.
4236 public function confirmEmail() {
4237 // Check if it's already confirmed, so we don't touch the database
4238 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4239 if ( !$this->isEmailConfirmed() ) {
4240 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4241 Hooks
::run( 'ConfirmEmailComplete', array( $this ) );
4247 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4248 * address if it was already confirmed.
4250 * @note Call saveSettings() after calling this function to commit the change.
4251 * @return bool Returns true
4253 public function invalidateEmail() {
4255 $this->mEmailToken
= null;
4256 $this->mEmailTokenExpires
= null;
4257 $this->setEmailAuthenticationTimestamp( null );
4259 Hooks
::run( 'InvalidateEmailComplete', array( $this ) );
4264 * Set the e-mail authentication timestamp.
4265 * @param string $timestamp TS_MW timestamp
4267 public function setEmailAuthenticationTimestamp( $timestamp ) {
4269 $this->mEmailAuthenticated
= $timestamp;
4270 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4274 * Is this user allowed to send e-mails within limits of current
4275 * site configuration?
4278 public function canSendEmail() {
4279 global $wgEnableEmail, $wgEnableUserEmail;
4280 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4283 $canSend = $this->isEmailConfirmed();
4284 Hooks
::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4289 * Is this user allowed to receive e-mails within limits of current
4290 * site configuration?
4293 public function canReceiveEmail() {
4294 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4298 * Is this user's e-mail address valid-looking and confirmed within
4299 * limits of the current site configuration?
4301 * @note If $wgEmailAuthentication is on, this may require the user to have
4302 * confirmed their address by returning a code or using a password
4303 * sent to the address from the wiki.
4307 public function isEmailConfirmed() {
4308 global $wgEmailAuthentication;
4311 if ( Hooks
::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4312 if ( $this->isAnon() ) {
4315 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4318 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4328 * Check whether there is an outstanding request for e-mail confirmation.
4331 public function isEmailConfirmationPending() {
4332 global $wgEmailAuthentication;
4333 return $wgEmailAuthentication &&
4334 !$this->isEmailConfirmed() &&
4335 $this->mEmailToken
&&
4336 $this->mEmailTokenExpires
> wfTimestamp();
4340 * Get the timestamp of account creation.
4342 * @return string|bool|null Timestamp of account creation, false for
4343 * non-existent/anonymous user accounts, or null if existing account
4344 * but information is not in database.
4346 public function getRegistration() {
4347 if ( $this->isAnon() ) {
4351 return $this->mRegistration
;
4355 * Get the timestamp of the first edit
4357 * @return string|bool Timestamp of first edit, or false for
4358 * non-existent/anonymous user accounts.
4360 public function getFirstEditTimestamp() {
4361 if ( $this->getId() == 0 ) {
4362 return false; // anons
4364 $dbr = wfGetDB( DB_SLAVE
);
4365 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4366 array( 'rev_user' => $this->getId() ),
4368 array( 'ORDER BY' => 'rev_timestamp ASC' )
4371 return false; // no edits
4373 return wfTimestamp( TS_MW
, $time );
4377 * Get the permissions associated with a given list of groups
4379 * @param array $groups Array of Strings List of internal group names
4380 * @return array Array of Strings List of permission key names for given groups combined
4382 public static function getGroupPermissions( $groups ) {
4383 global $wgGroupPermissions, $wgRevokePermissions;
4385 // grant every granted permission first
4386 foreach ( $groups as $group ) {
4387 if ( isset( $wgGroupPermissions[$group] ) ) {
4388 $rights = array_merge( $rights,
4389 // array_filter removes empty items
4390 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4393 // now revoke the revoked permissions
4394 foreach ( $groups as $group ) {
4395 if ( isset( $wgRevokePermissions[$group] ) ) {
4396 $rights = array_diff( $rights,
4397 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4400 return array_unique( $rights );
4404 * Get all the groups who have a given permission
4406 * @param string $role Role to check
4407 * @return array Array of Strings List of internal group names with the given permission
4409 public static function getGroupsWithPermission( $role ) {
4410 global $wgGroupPermissions;
4411 $allowedGroups = array();
4412 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4413 if ( self
::groupHasPermission( $group, $role ) ) {
4414 $allowedGroups[] = $group;
4417 return $allowedGroups;
4421 * Check, if the given group has the given permission
4423 * If you're wanting to check whether all users have a permission, use
4424 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4428 * @param string $group Group to check
4429 * @param string $role Role to check
4432 public static function groupHasPermission( $group, $role ) {
4433 global $wgGroupPermissions, $wgRevokePermissions;
4434 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4435 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4439 * Check if all users have the given permission
4442 * @param string $right Right to check
4445 public static function isEveryoneAllowed( $right ) {
4446 global $wgGroupPermissions, $wgRevokePermissions;
4447 static $cache = array();
4449 // Use the cached results, except in unit tests which rely on
4450 // being able change the permission mid-request
4451 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4452 return $cache[$right];
4455 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4456 $cache[$right] = false;
4460 // If it's revoked anywhere, then everyone doesn't have it
4461 foreach ( $wgRevokePermissions as $rights ) {
4462 if ( isset( $rights[$right] ) && $rights[$right] ) {
4463 $cache[$right] = false;
4468 // Allow extensions (e.g. OAuth) to say false
4469 if ( !Hooks
::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4470 $cache[$right] = false;
4474 $cache[$right] = true;
4479 * Get the localized descriptive name for a group, if it exists
4481 * @param string $group Internal group name
4482 * @return string Localized descriptive group name
4484 public static function getGroupName( $group ) {
4485 $msg = wfMessage( "group-$group" );
4486 return $msg->isBlank() ?
$group : $msg->text();
4490 * Get the localized descriptive name for a member of a group, if it exists
4492 * @param string $group Internal group name
4493 * @param string $username Username for gender (since 1.19)
4494 * @return string Localized name for group member
4496 public static function getGroupMember( $group, $username = '#' ) {
4497 $msg = wfMessage( "group-$group-member", $username );
4498 return $msg->isBlank() ?
$group : $msg->text();
4502 * Return the set of defined explicit groups.
4503 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4504 * are not included, as they are defined automatically, not in the database.
4505 * @return array Array of internal group names
4507 public static function getAllGroups() {
4508 global $wgGroupPermissions, $wgRevokePermissions;
4510 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4511 self
::getImplicitGroups()
4516 * Get a list of all available permissions.
4517 * @return string[] Array of permission names
4519 public static function getAllRights() {
4520 if ( self
::$mAllRights === false ) {
4521 global $wgAvailableRights;
4522 if ( count( $wgAvailableRights ) ) {
4523 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4525 self
::$mAllRights = self
::$mCoreRights;
4527 Hooks
::run( 'UserGetAllRights', array( &self
::$mAllRights ) );
4529 return self
::$mAllRights;
4533 * Get a list of implicit groups
4534 * @return array Array of Strings Array of internal group names
4536 public static function getImplicitGroups() {
4537 global $wgImplicitGroups;
4539 $groups = $wgImplicitGroups;
4540 # Deprecated, use $wgImplicitGroups instead
4541 Hooks
::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4547 * Get the title of a page describing a particular group
4549 * @param string $group Internal group name
4550 * @return Title|bool Title of the page if it exists, false otherwise
4552 public static function getGroupPage( $group ) {
4553 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4554 if ( $msg->exists() ) {
4555 $title = Title
::newFromText( $msg->text() );
4556 if ( is_object( $title ) ) {
4564 * Create a link to the group in HTML, if available;
4565 * else return the group name.
4567 * @param string $group Internal name of the group
4568 * @param string $text The text of the link
4569 * @return string HTML link to the group
4571 public static function makeGroupLinkHTML( $group, $text = '' ) {
4572 if ( $text == '' ) {
4573 $text = self
::getGroupName( $group );
4575 $title = self
::getGroupPage( $group );
4577 return Linker
::link( $title, htmlspecialchars( $text ) );
4579 return htmlspecialchars( $text );
4584 * Create a link to the group in Wikitext, if available;
4585 * else return the group name.
4587 * @param string $group Internal name of the group
4588 * @param string $text The text of the link
4589 * @return string Wikilink to the group
4591 public static function makeGroupLinkWiki( $group, $text = '' ) {
4592 if ( $text == '' ) {
4593 $text = self
::getGroupName( $group );
4595 $title = self
::getGroupPage( $group );
4597 $page = $title->getFullText();
4598 return "[[$page|$text]]";
4605 * Returns an array of the groups that a particular group can add/remove.
4607 * @param string $group The group to check for whether it can add/remove
4608 * @return array Array( 'add' => array( addablegroups ),
4609 * 'remove' => array( removablegroups ),
4610 * 'add-self' => array( addablegroups to self),
4611 * 'remove-self' => array( removable groups from self) )
4613 public static function changeableByGroup( $group ) {
4614 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4618 'remove' => array(),
4619 'add-self' => array(),
4620 'remove-self' => array()
4623 if ( empty( $wgAddGroups[$group] ) ) {
4624 // Don't add anything to $groups
4625 } elseif ( $wgAddGroups[$group] === true ) {
4626 // You get everything
4627 $groups['add'] = self
::getAllGroups();
4628 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4629 $groups['add'] = $wgAddGroups[$group];
4632 // Same thing for remove
4633 if ( empty( $wgRemoveGroups[$group] ) ) {
4635 } elseif ( $wgRemoveGroups[$group] === true ) {
4636 $groups['remove'] = self
::getAllGroups();
4637 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4638 $groups['remove'] = $wgRemoveGroups[$group];
4641 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4642 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4643 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4644 if ( is_int( $key ) ) {
4645 $wgGroupsAddToSelf['user'][] = $value;
4650 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4651 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4652 if ( is_int( $key ) ) {
4653 $wgGroupsRemoveFromSelf['user'][] = $value;
4658 // Now figure out what groups the user can add to him/herself
4659 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4661 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4662 // No idea WHY this would be used, but it's there
4663 $groups['add-self'] = User
::getAllGroups();
4664 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4665 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4668 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4670 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4671 $groups['remove-self'] = User
::getAllGroups();
4672 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4673 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4680 * Returns an array of groups that this user can add and remove
4681 * @return array Array( 'add' => array( addablegroups ),
4682 * 'remove' => array( removablegroups ),
4683 * 'add-self' => array( addablegroups to self),
4684 * 'remove-self' => array( removable groups from self) )
4686 public function changeableGroups() {
4687 if ( $this->isAllowed( 'userrights' ) ) {
4688 // This group gives the right to modify everything (reverse-
4689 // compatibility with old "userrights lets you change
4691 // Using array_merge to make the groups reindexed
4692 $all = array_merge( User
::getAllGroups() );
4696 'add-self' => array(),
4697 'remove-self' => array()
4701 // Okay, it's not so simple, we will have to go through the arrays
4704 'remove' => array(),
4705 'add-self' => array(),
4706 'remove-self' => array()
4708 $addergroups = $this->getEffectiveGroups();
4710 foreach ( $addergroups as $addergroup ) {
4711 $groups = array_merge_recursive(
4712 $groups, $this->changeableByGroup( $addergroup )
4714 $groups['add'] = array_unique( $groups['add'] );
4715 $groups['remove'] = array_unique( $groups['remove'] );
4716 $groups['add-self'] = array_unique( $groups['add-self'] );
4717 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4723 * Increment the user's edit-count field.
4724 * Will have no effect for anonymous users.
4726 public function incEditCount() {
4727 if ( !$this->isAnon() ) {
4728 $dbw = wfGetDB( DB_MASTER
);
4731 array( 'user_editcount=user_editcount+1' ),
4732 array( 'user_id' => $this->getId() ),
4736 // Lazy initialization check...
4737 if ( $dbw->affectedRows() == 0 ) {
4738 // Now here's a goddamn hack...
4739 $dbr = wfGetDB( DB_SLAVE
);
4740 if ( $dbr !== $dbw ) {
4741 // If we actually have a slave server, the count is
4742 // at least one behind because the current transaction
4743 // has not been committed and replicated.
4744 $this->initEditCount( 1 );
4746 // But if DB_SLAVE is selecting the master, then the
4747 // count we just read includes the revision that was
4748 // just added in the working transaction.
4749 $this->initEditCount();
4753 // edit count in user cache too
4754 $this->invalidateCache();
4758 * Initialize user_editcount from data out of the revision table
4760 * @param int $add Edits to add to the count from the revision table
4761 * @return int Number of edits
4763 protected function initEditCount( $add = 0 ) {
4764 // Pull from a slave to be less cruel to servers
4765 // Accuracy isn't the point anyway here
4766 $dbr = wfGetDB( DB_SLAVE
);
4767 $count = (int)$dbr->selectField(
4770 array( 'rev_user' => $this->getId() ),
4773 $count = $count +
$add;
4775 $dbw = wfGetDB( DB_MASTER
);
4778 array( 'user_editcount' => $count ),
4779 array( 'user_id' => $this->getId() ),
4787 * Get the description of a given right
4789 * @param string $right Right to query
4790 * @return string Localized description of the right
4792 public static function getRightDescription( $right ) {
4793 $key = "right-$right";
4794 $msg = wfMessage( $key );
4795 return $msg->isBlank() ?
$right : $msg->text();
4799 * Make a new-style password hash
4801 * @param string $password Plain-text password
4802 * @param bool|string $salt Optional salt, may be random or the user ID.
4803 * If unspecified or false, will generate one automatically
4804 * @return string Password hash
4805 * @deprecated since 1.24, use Password class
4807 public static function crypt( $password, $salt = false ) {
4808 wfDeprecated( __METHOD__
, '1.24' );
4809 $hash = self
::getPasswordFactory()->newFromPlaintext( $password );
4810 return $hash->toString();
4814 * Compare a password hash with a plain-text password. Requires the user
4815 * ID if there's a chance that the hash is an old-style hash.
4817 * @param string $hash Password hash
4818 * @param string $password Plain-text password to compare
4819 * @param string|bool $userId User ID for old-style password salt
4822 * @deprecated since 1.24, use Password class
4824 public static function comparePasswords( $hash, $password, $userId = false ) {
4825 wfDeprecated( __METHOD__
, '1.24' );
4827 // Check for *really* old password hashes that don't even have a type
4828 // The old hash format was just an md5 hex hash, with no type information
4829 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4830 global $wgPasswordSalt;
4831 if ( $wgPasswordSalt ) {
4832 $password = ":B:{$userId}:{$hash}";
4834 $password = ":A:{$hash}";
4838 $hash = self
::getPasswordFactory()->newFromCiphertext( $hash );
4839 return $hash->equals( $password );
4843 * Add a newuser log entry for this user.
4844 * Before 1.19 the return value was always true.
4846 * @param string|bool $action Account creation type.
4847 * - String, one of the following values:
4848 * - 'create' for an anonymous user creating an account for himself.
4849 * This will force the action's performer to be the created user itself,
4850 * no matter the value of $wgUser
4851 * - 'create2' for a logged in user creating an account for someone else
4852 * - 'byemail' when the created user will receive its password by e-mail
4853 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4854 * - Boolean means whether the account was created by e-mail (deprecated):
4855 * - true will be converted to 'byemail'
4856 * - false will be converted to 'create' if this object is the same as
4857 * $wgUser and to 'create2' otherwise
4859 * @param string $reason User supplied reason
4861 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4863 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4864 global $wgUser, $wgNewUserLog;
4865 if ( empty( $wgNewUserLog ) ) {
4866 return true; // disabled
4869 if ( $action === true ) {
4870 $action = 'byemail';
4871 } elseif ( $action === false ) {
4872 if ( $this->equals( $wgUser ) ) {
4875 $action = 'create2';
4879 if ( $action === 'create' ||
$action === 'autocreate' ) {
4882 $performer = $wgUser;
4885 $logEntry = new ManualLogEntry( 'newusers', $action );
4886 $logEntry->setPerformer( $performer );
4887 $logEntry->setTarget( $this->getUserPage() );
4888 $logEntry->setComment( $reason );
4889 $logEntry->setParameters( array(
4890 '4::userid' => $this->getId(),
4892 $logid = $logEntry->insert();
4894 if ( $action !== 'autocreate' ) {
4895 $logEntry->publish( $logid );
4902 * Add an autocreate newuser log entry for this user
4903 * Used by things like CentralAuth and perhaps other authplugins.
4904 * Consider calling addNewUserLogEntry() directly instead.
4908 public function addNewUserLogEntryAutoCreate() {
4909 $this->addNewUserLogEntry( 'autocreate' );
4915 * Load the user options either from cache, the database or an array
4917 * @param array $data Rows for the current user out of the user_properties table
4919 protected function loadOptions( $data = null ) {
4924 if ( $this->mOptionsLoaded
) {
4928 $this->mOptions
= self
::getDefaultOptions();
4930 if ( !$this->getId() ) {
4931 // For unlogged-in users, load language/variant options from request.
4932 // There's no need to do it for logged-in users: they can set preferences,
4933 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4934 // so don't override user's choice (especially when the user chooses site default).
4935 $variant = $wgContLang->getDefaultVariant();
4936 $this->mOptions
['variant'] = $variant;
4937 $this->mOptions
['language'] = $variant;
4938 $this->mOptionsLoaded
= true;
4942 // Maybe load from the object
4943 if ( !is_null( $this->mOptionOverrides
) ) {
4944 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4945 foreach ( $this->mOptionOverrides
as $key => $value ) {
4946 $this->mOptions
[$key] = $value;
4949 if ( !is_array( $data ) ) {
4950 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4951 // Load from database
4952 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
4953 ?
wfGetDB( DB_MASTER
)
4954 : wfGetDB( DB_SLAVE
);
4956 $res = $dbr->select(
4958 array( 'up_property', 'up_value' ),
4959 array( 'up_user' => $this->getId() ),
4963 $this->mOptionOverrides
= array();
4965 foreach ( $res as $row ) {
4966 $data[$row->up_property
] = $row->up_value
;
4969 foreach ( $data as $property => $value ) {
4970 $this->mOptionOverrides
[$property] = $value;
4971 $this->mOptions
[$property] = $value;
4975 $this->mOptionsLoaded
= true;
4977 Hooks
::run( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4981 * Saves the non-default options for this user, as previously set e.g. via
4982 * setOption(), in the database's "user_properties" (preferences) table.
4983 * Usually used via saveSettings().
4985 protected function saveOptions() {
4986 $this->loadOptions();
4988 // Not using getOptions(), to keep hidden preferences in database
4989 $saveOptions = $this->mOptions
;
4991 // Allow hooks to abort, for instance to save to a global profile.
4992 // Reset options to default state before saving.
4993 if ( !Hooks
::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4997 $userId = $this->getId();
4999 $insert_rows = array(); // all the new preference rows
5000 foreach ( $saveOptions as $key => $value ) {
5001 // Don't bother storing default values
5002 $defaultOption = self
::getDefaultOption( $key );
5003 if ( ( $defaultOption === null && $value !== false && $value !== null )
5004 ||
$value != $defaultOption
5006 $insert_rows[] = array(
5007 'up_user' => $userId,
5008 'up_property' => $key,
5009 'up_value' => $value,
5014 $dbw = wfGetDB( DB_MASTER
);
5016 $res = $dbw->select( 'user_properties',
5017 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
5019 // Find prior rows that need to be removed or updated. These rows will
5020 // all be deleted (the later so that INSERT IGNORE applies the new values).
5021 $keysDelete = array();
5022 foreach ( $res as $row ) {
5023 if ( !isset( $saveOptions[$row->up_property
] )
5024 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5026 $keysDelete[] = $row->up_property
;
5030 if ( count( $keysDelete ) ) {
5031 // Do the DELETE by PRIMARY KEY for prior rows.
5032 // In the past a very large portion of calls to this function are for setting
5033 // 'rememberpassword' for new accounts (a preference that has since been removed).
5034 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5035 // caused gap locks on [max user ID,+infinity) which caused high contention since
5036 // updates would pile up on each other as they are for higher (newer) user IDs.
5037 // It might not be necessary these days, but it shouldn't hurt either.
5038 $dbw->delete( 'user_properties',
5039 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
5041 // Insert the new preference rows
5042 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
5046 * Lazily instantiate and return a factory object for making passwords
5048 * @return PasswordFactory
5050 public static function getPasswordFactory() {
5051 if ( self
::$mPasswordFactory === null ) {
5052 self
::$mPasswordFactory = new PasswordFactory();
5053 self
::$mPasswordFactory->init( RequestContext
::getMain()->getConfig() );
5056 return self
::$mPasswordFactory;
5060 * Provide an array of HTML5 attributes to put on an input element
5061 * intended for the user to enter a new password. This may include
5062 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5064 * Do *not* use this when asking the user to enter his current password!
5065 * Regardless of configuration, users may have invalid passwords for whatever
5066 * reason (e.g., they were set before requirements were tightened up).
5067 * Only use it when asking for a new password, like on account creation or
5070 * Obviously, you still need to do server-side checking.
5072 * NOTE: A combination of bugs in various browsers means that this function
5073 * actually just returns array() unconditionally at the moment. May as
5074 * well keep it around for when the browser bugs get fixed, though.
5076 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5078 * @return array Array of HTML attributes suitable for feeding to
5079 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5080 * That will get confused by the boolean attribute syntax used.)
5082 public static function passwordChangeInputAttribs() {
5083 global $wgMinimalPasswordLength;
5085 if ( $wgMinimalPasswordLength == 0 ) {
5089 # Note that the pattern requirement will always be satisfied if the
5090 # input is empty, so we need required in all cases.
5092 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5093 # if e-mail confirmation is being used. Since HTML5 input validation
5094 # is b0rked anyway in some browsers, just return nothing. When it's
5095 # re-enabled, fix this code to not output required for e-mail
5097 #$ret = array( 'required' );
5100 # We can't actually do this right now, because Opera 9.6 will print out
5101 # the entered password visibly in its error message! When other
5102 # browsers add support for this attribute, or Opera fixes its support,
5103 # we can add support with a version check to avoid doing this on Opera
5104 # versions where it will be a problem. Reported to Opera as
5105 # DSK-262266, but they don't have a public bug tracker for us to follow.
5107 if ( $wgMinimalPasswordLength > 1 ) {
5108 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5109 $ret['title'] = wfMessage( 'passwordtooshort' )
5110 ->numParams( $wgMinimalPasswordLength )->text();
5118 * Return the list of user fields that should be selected to create
5119 * a new user object.
5122 public static function selectFields() {
5130 'user_email_authenticated',
5132 'user_email_token_expires',
5133 'user_registration',
5139 * Factory function for fatal permission-denied errors
5142 * @param string $permission User right required
5145 static function newFatalPermissionDeniedStatus( $permission ) {
5148 $groups = array_map(
5149 array( 'User', 'makeGroupLinkWiki' ),
5150 User
::getGroupsWithPermission( $permission )
5154 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5156 return Status
::newFatal( 'badaccess-group0' );
5161 * Checks if two user objects point to the same user.
5167 public function equals( User
$user ) {
5168 return $this->getName() === $user->getName();